☕️ Classic, reliable, trusted test framework for Node.js and the browser
"use strict";
const esmUtils = require("../../lib/nodejs/esm-utils.cjs");
const sinon = require("sinon");
const url = require("node:url");
describe("esm-utils", function () {
describe("requireOrImport", function () {
afterEach(function () {
sinon.restore();
});
it("should show an informative error message for a broken default import", async function () {
return expect(
() =>
esmUtils.requireOrImport(
"../../test/node-unit/fixtures/broken-default-import.js",
),
"to be rejected with error satisfying",
{
name: "SyntaxError",
message:
"The requested module './module-without-default-export.js' does not provide an export named 'default'",
},
);
});
it("should show a syntax error message when importing a TypeScript file with invalid syntax", async function () {
return expect(
() =>
esmUtils.requireOrImport(
"../../test/node-unit/fixtures/broken-syntax.ts",
),
"to be rejected with error satisfying",
{
name: "SyntaxError",
message: /Invalid or unexpected token|Expected ident/,
},
);
});
it("should surface the ts-node TSError error rather than falling back to `import(...)`", async function () {
return expect(
() =>
esmUtils.requireOrImport(
"../../test/node-unit/fixtures/mock-ts-node-compile-err.ts",
),
"to be rejected with error satisfying",
{
name: "TSError",
message: /A TS compilation error/,
},
);
});
it("should surface Mocha errors rather than falling back to `import(...)`", async function () {
return expect(
() =>
esmUtils.requireOrImport(
"../../test/node-unit/fixtures/commonjs/mock-mocha-forbidden-exclusivity-err.ts",
),
"to be rejected with error satisfying",
{
code: "ERR_MOCHA_FORBIDDEN_EXCLUSIVITY",
message: /`\.only` is not supported in parallel mode/,
},
);
});
it("should surface the require() error when import() fails on a directory specifier", async function () {
sinon
.stub(esmUtils, "doImport")
.rejects(
Object.assign(
new Error("Directory import '/fixtures/lib' is not supported"),
{ code: "ERR_UNSUPPORTED_DIR_IMPORT" },
),
);
return expect(
() =>
esmUtils.requireOrImport(
"../../test/node-unit/fixtures/this-module-does-not-exist.cjs",
),
"to be rejected with error satisfying",
{
code: "MODULE_NOT_FOUND",
message: /this-module-does-not-exist/,
},
);
});
it("should surface the import() error for a TypeScript file when the require() error is unrelated", async function () {
sinon
.stub(esmUtils, "doImport")
.rejects(
Object.assign(
new Error("Cannot find package 'non-existent-package'"),
{ code: "ERR_MODULE_NOT_FOUND" },
),
);
return expect(
() =>
esmUtils.requireOrImport(
"../../test/node-unit/fixtures/this-module-does-not-exist.ts",
),
"to be rejected with error satisfying",
{
code: "ERR_MODULE_NOT_FOUND",
message: /non-existent-package/,
},
);
});
});
describe("loadFilesAsync()", function () {
beforeEach(function () {
sinon.stub(esmUtils, "doImport").resolves({});
});
afterEach(function () {
sinon.restore();
});
it("should not decorate imported module if no decorator passed", async function () {
await esmUtils.loadFilesAsync(
["/foo/bar.mjs"],
() => {},
() => {},
);
expect(
esmUtils.doImport.firstCall.args[0].toString(),
"to be",
url.pathToFileURL("/foo/bar.mjs").toString(),
);
});
it("should decorate imported module with passed decorator", async function () {
await esmUtils.loadFilesAsync(
["/foo/bar.mjs"],
() => {},
() => {},
(x) => `${x}?foo=bar`,
);
expect(
esmUtils.doImport.firstCall.args[0].toString(),
"to be",
`${url.pathToFileURL("/foo/bar.mjs").toString()}?foo=bar`,
);
});
it("should support file: URLs passed to loadFilesAsync", async function () {
const fileUrl = url.pathToFileURL("/foo/bar.mjs").toString();
await esmUtils.loadFilesAsync(
[fileUrl],
() => {},
() => {},
);
expect(esmUtils.doImport.firstCall.args[0].toString(), "to be", fileUrl);
});
it("should treat Windows drive-letter paths as regular file paths", async function () {
// URL.canParse("C:/foo/bar.mjs") returns true on all platforms,
// but "c:" is a drive letter, not a URL scheme — must fall through to path.resolve
await esmUtils.loadFilesAsync(
["C:/foo/bar.mjs"],
() => {},
() => {},
);
expect(
esmUtils.doImport.firstCall.args[0].toString(),
"to contain",
"C:",
);
});
it("should throw for unsupported URL protocols", async function () {
return expect(
() =>
esmUtils.loadFilesAsync(
["https://example.com/suite.js"],
() => {},
() => {},
),
"to be rejected with error satisfying",
{
message:
'Unsupported URL protocol "https:". Only "file:" URLs are supported.',
},
);
});
});
});