Skip to content

feat: tell Babel about Jest's ESM support #10750

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

feat: tell Babel about Jest's ESM support #10750

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion e2e/__tests__/__snapshots__/transform.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ FAIL __tests__/ignoredFile.test.js

babel-jest: Babel ignores __tests__/ignoredFile.test.js - make sure to include the file in Jest's transformIgnorePatterns as well.

at loadBabelConfig (../../../packages/babel-jest/build/index.js:180:13)
at loadBabelConfig (../../../packages/babel-jest/build/index.js:201:13)
`;

exports[`babel-jest instruments only specific files and collects coverage 1`] = `
Expand Down
16 changes: 16 additions & 0 deletions packages/babel-jest/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,14 @@ interface BabelJestTransformOptions extends TransformOptions {
sourceMaps: 'both';
}

// https://github.com/DefinitelyTyped/DefinitelyTyped/pull/49267
declare module '@babel/core' {
interface TransformCaller {
supportsExportNamespaceFrom?: boolean;
supportsTopLevelAwait?: boolean;
}
}

const createTransformer = (
userOptions?: TransformOptions | null,
): BabelJestTransformer => {
Expand All @@ -49,7 +57,9 @@ const createTransformer = (
caller: {
name: 'babel-jest',
supportsDynamicImport: false,
supportsExportNamespaceFrom: false,
supportsStaticESM: false,
supportsTopLevelAwait: false,
...inputOptions.caller,
},
compact: false,
Expand All @@ -72,9 +82,15 @@ const createTransformer = (
supportsDynamicImport:
transformOptions?.supportsDynamicImport ??
options.caller.supportsDynamicImport,
supportsExportNamespaceFrom:
transformOptions?.supportsExportNamespaceFrom ??
options.caller.supportsExportNamespaceFrom,
supportsStaticESM:
transformOptions?.supportsStaticESM ??
options.caller.supportsStaticESM,
supportsTopLevelAwait:
transformOptions?.supportsTopLevelAwait ??
options.caller.supportsTopLevelAwait,
},
filename,
});
Expand Down
2 changes: 2 additions & 0 deletions packages/jest-runtime/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
"jest-snapshot": "^26.6.1",
"jest-util": "^26.6.1",
"jest-validate": "^26.6.1",
"semver": "^7.3.2",
"slash": "^3.0.0",
"strip-bom": "^4.0.0",
"yargs": "^15.4.1"
Expand All @@ -44,6 +45,7 @@
"@types/glob": "^7.1.1",
"@types/graceful-fs": "^4.1.2",
"@types/node": "^14.0.27",
"@types/semver": "^7.3.4",
"execa": "^4.0.0",
"jest-environment-node": "^26.6.1",
"jest-snapshot-serializer-raw": "^1.1.0"
Expand Down
11 changes: 11 additions & 0 deletions packages/jest-runtime/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ import {
Module as VMModule,
} from 'vm';
import * as nativeModule from 'module';
import * as semver from 'semver';
// @ts-expect-error
import parseCjs = require('cjs-module-lexer');
import type {Config, Global} from '@jest/types';
Expand Down Expand Up @@ -78,15 +79,21 @@ type HasteMapOptions = {
type InternalModuleOptions = {
isInternalModule: boolean;
supportsDynamicImport: boolean;
supportsExportNamespaceFrom: boolean;
supportsStaticESM: boolean;
supportsTopLevelAwait: boolean;
};

const defaultTransformOptions: InternalModuleOptions = {
isInternalModule: false,
supportsDynamicImport: esmIsAvailable,
supportsExportNamespaceFrom: false,
supportsStaticESM: false,
supportsTopLevelAwait: false,
};

const nodeVersionSupportsTla = semver.satisfies(process.version, '>=14.3.0');

type InitialModule = Omit<Module, 'require' | 'parent' | 'paths'>;
type ModuleRegistry = Map<string, InitialModule | Module>;

Expand Down Expand Up @@ -378,7 +385,9 @@ class Runtime {
const transformedCode = this.transformFile(modulePath, {
isInternalModule: false,
supportsDynamicImport: true,
supportsExportNamespaceFrom: true,
supportsStaticESM: true,
supportsTopLevelAwait: nodeVersionSupportsTla,
});

const module = new SourceTextModule(transformedCode, {
Expand Down Expand Up @@ -608,7 +617,9 @@ class Runtime {
return this.requireModule<T>(from, to, {
isInternalModule: true,
supportsDynamicImport: esmIsAvailable,
supportsExportNamespaceFrom: false,
supportsStaticESM: false,
supportsTopLevelAwait: false,
});
}

Expand Down
47 changes: 45 additions & 2 deletions packages/jest-transform/src/ScriptTransformer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,14 @@ async function waitForPromiseWithCleanup(
}
}

// https://github.com/DefinitelyTyped/DefinitelyTyped/pull/49267
declare module '@babel/core' {
interface TransformCaller {
supportsExportNamespaceFrom?: boolean;
supportsTopLevelAwait?: boolean;
}
}

export default class ScriptTransformer {
private _cache: ProjectCache;
private _config: Config.ProjectConfig;
Expand Down Expand Up @@ -96,6 +104,8 @@ export default class ScriptTransformer {
instrument: boolean,
supportsDynamicImport: boolean,
supportsStaticESM: boolean,
supportsTopLevelAwait: boolean,
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

passing this around is a mess, so I think we should wait until Jest 27 and move to passing objects (which is a breaking refactor)

supportsExportNamespaceFrom: boolean,
): string {
const configString = this._cache.configString;
const transformer = this._getTransformer(filename);
Expand All @@ -108,7 +118,9 @@ export default class ScriptTransformer {
instrument,
rootDir: this._config.rootDir,
supportsDynamicImport,
supportsExportNamespaceFrom,
supportsStaticESM,
supportsTopLevelAwait,
}),
)
.update(CACHE_VERSION)
Expand All @@ -130,6 +142,8 @@ export default class ScriptTransformer {
instrument: boolean,
supportsDynamicImport: boolean,
supportsStaticESM: boolean,
supportsTopLevelAwait: boolean,
supportsExportNamespaceFrom: boolean,
): Config.Path {
const baseCacheDir = HasteMap.getCacheFilePath(
this._config.cacheDirectory,
Expand All @@ -142,6 +156,8 @@ export default class ScriptTransformer {
instrument,
supportsDynamicImport,
supportsStaticESM,
supportsTopLevelAwait,
supportsExportNamespaceFrom,
);
// Create sub folders based on the cacheKey to avoid creating one
// directory with many files.
Expand Down Expand Up @@ -216,6 +232,8 @@ export default class ScriptTransformer {
supportsDynamicImport: boolean,
supportsStaticESM: boolean,
canMapToInput: boolean,
supportsTopLevelAwait: boolean,
supportsExportNamespaceFrom: boolean,
): TransformedSource {
const inputCode = typeof input === 'string' ? input : input.code;
const inputMap = typeof input === 'string' ? null : input.map;
Expand All @@ -226,7 +244,9 @@ export default class ScriptTransformer {
caller: {
name: '@jest/transform',
supportsDynamicImport,
supportsExportNamespaceFrom,
supportsStaticESM,
supportsTopLevelAwait,
},
configFile: false,
filename,
Expand Down Expand Up @@ -267,6 +287,8 @@ export default class ScriptTransformer {
instrument: boolean,
supportsDynamicImport = false,
supportsStaticESM = false,
supportsTopLevelAwait = false,
supportsExportNamespaceFrom = false,
): TransformResult {
const filename = tryRealpath(filepath);
const transform = this._getTransformer(filename);
Expand All @@ -276,6 +298,8 @@ export default class ScriptTransformer {
instrument,
supportsDynamicImport,
supportsStaticESM,
supportsTopLevelAwait,
supportsExportNamespaceFrom,
);
let sourceMapPath: Config.Path | null = cacheFilePath + '.map';
// Ignore cache if `config.cache` is set (--no-cache)
Expand Down Expand Up @@ -309,7 +333,9 @@ export default class ScriptTransformer {
const processed = transform.process(content, filename, this._config, {
instrument,
supportsDynamicImport,
supportsExportNamespaceFrom: false,
supportsStaticESM,
supportsTopLevelAwait,
});

if (typeof processed === 'string') {
Expand Down Expand Up @@ -363,6 +389,8 @@ export default class ScriptTransformer {
supportsDynamicImport,
supportsStaticESM,
shouldEmitSourceMaps,
supportsTopLevelAwait,
supportsExportNamespaceFrom,
);

code =
Expand Down Expand Up @@ -399,7 +427,9 @@ export default class ScriptTransformer {
isCoreModule,
isInternalModule,
supportsDynamicImport,
supportsExportNamespaceFrom,
supportsStaticESM,
supportsTopLevelAwait,
} = options;
const content = stripShebang(
fileSource || fs.readFileSync(filename, 'utf8'),
Expand All @@ -421,6 +451,8 @@ export default class ScriptTransformer {
instrument,
supportsDynamicImport,
supportsStaticESM,
supportsTopLevelAwait,
supportsExportNamespaceFrom,
);

code = transformedSource.code;
Expand Down Expand Up @@ -479,7 +511,9 @@ export default class ScriptTransformer {
isCoreModule,
isInternalModule,
supportsDynamicImport,
supportsExportNamespaceFrom,
supportsStaticESM,
supportsTopLevelAwait,
} = options;
const willTransform =
!isInternalModule && !isCoreModule && this.shouldTransform(filename);
Expand All @@ -491,6 +525,8 @@ export default class ScriptTransformer {
false,
supportsDynamicImport,
supportsStaticESM,
supportsTopLevelAwait,
supportsExportNamespaceFrom,
);
return transformedJsonSource;
}
Expand Down Expand Up @@ -521,8 +557,15 @@ export default class ScriptTransformer {
transforming = true;
return (
// we might wanna do `supportsDynamicImport` at some point
this.transformSource(filename, code, false, false, false).code ||
code
this.transformSource(
filename,
code,
false,
false,
false,
false,
false,
).code || code
);
} finally {
transforming = false;
Expand Down
6 changes: 5 additions & 1 deletion packages/jest-transform/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,9 @@ export type Options = ShouldInstrumentOptions &
isCoreModule: boolean;
isInternalModule: boolean;
supportsDynamicImport: boolean;
supportsExportNamespaceFrom: boolean;
supportsStaticESM: boolean;
supportsTopLevelAwait: boolean;
}>;

// This is fixed in source-map@0.7.x, but we can't upgrade yet since it's async
Expand All @@ -41,9 +43,11 @@ export type TransformResult = TransformTypes.TransformResult;

export interface TransformOptions {
instrument: boolean;
// names are copied from babel
// names are copied from babel: https://babeljs.io/docs/en/options#caller
supportsDynamicImport?: boolean;
supportsExportNamespaceFrom?: boolean;
supportsStaticESM?: boolean;
supportsTopLevelAwait?: boolean;
}

// TODO: For Jest 26 we should combine these into one options shape
Expand Down
4 changes: 3 additions & 1 deletion yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3747,7 +3747,7 @@ __metadata:
languageName: node
linkType: hard

"@types/semver@npm:^7.1.0":
"@types/semver@npm:^7.1.0, @types/semver@npm:^7.3.4":
version: 7.3.4
resolution: "@types/semver@npm:7.3.4"
checksum: 7e8588aa55ecb344eda6954674b83a3c568d97d478e70e4617bd3ab22902590ac416ccf2cea48b58fb2f0fbd80f9ad1896332c9b3c3189ffd24e4350ff22094a
Expand Down Expand Up @@ -11957,6 +11957,7 @@ fsevents@^1.2.7:
"@types/glob": ^7.1.1
"@types/graceful-fs": ^4.1.2
"@types/node": ^14.0.27
"@types/semver": ^7.3.4
"@types/yargs": ^15.0.0
chalk: ^4.0.0
cjs-module-lexer: ^0.4.2
Expand All @@ -11976,6 +11977,7 @@ fsevents@^1.2.7:
jest-snapshot-serializer-raw: ^1.1.0
jest-util: ^26.6.1
jest-validate: ^26.6.1
semver: ^7.3.2
slash: ^3.0.0
strip-bom: ^4.0.0
yargs: ^15.4.1
Expand Down