Skip to content
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.

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

chore: drop usage of compileFunction #10586

Merged
merged 5 commits into from Oct 5, 2020
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Expand Up @@ -11,6 +11,7 @@
- `[jest-circus, jest-jasmine2]` Find correct location for `test.each` tests ([#10413](https://github.com/facebook/jest/pull/10413))
- `[jest-console]` Add `Console` constructor to `console` object ([#10502](https://github.com/facebook/jest/pull/10502))
- `[jest-globals]` Fix lifecycle hook function types ([#10480](https://github.com/facebook/jest/pull/10480))
- `[jest-runtime]` Remove usage of `vm.compileFunction` due to a performance issue ([#10586](https://github.com/facebook/jest/pull/10586))

### Chore & Maintenance

Expand Down
Expand Up @@ -20,6 +20,6 @@ exports[`prints console.logs when run with forceExit 3`] = `
console.log
Hey

at Object.log (__tests__/a-banana.js:1:30)
at Object.<anonymous> (__tests__/a-banana.js:1:1)
Copy link
Member Author

Choose a reason for hiding this comment

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

🙁


`;
4 changes: 2 additions & 2 deletions e2e/__tests__/__snapshots__/globals.test.ts.snap
Expand Up @@ -24,9 +24,9 @@ FAIL __tests__/onlyConstructs.test.js
Missing second argument. It must be a callback function.

> 1 | describe('describe, no implementation');
| ^
| ^

at Object.describe (__tests__/onlyConstructs.test.js:1:1)
at Object.<anonymous> (__tests__/onlyConstructs.test.js:1:10)
`;

exports[`cannot have describe with no implementation 2`] = `
Expand Down
6 changes: 3 additions & 3 deletions packages/jest-reporters/src/coverage_reporter.ts
Expand Up @@ -10,6 +10,7 @@ import * as fs from 'graceful-fs';
import type {Config} from '@jest/types';
import type {
AggregatedResult,
RuntimeTransformResult,
TestResult,
V8CoverageResult,
} from '@jest/test-result';
Expand All @@ -24,7 +25,6 @@ import Worker from 'jest-worker';
import glob = require('glob');
import v8toIstanbul = require('v8-to-istanbul');
import type {RawSourceMap} from 'source-map';
import type {TransformResult} from '@jest/transform';
import BaseReporter from './base_reporter';
import type {
Context,
Expand Down Expand Up @@ -425,7 +425,7 @@ export default class CoverageReporter extends BaseReporter {
this._v8CoverageResults.map(cov => ({result: cov.map(r => r.result)})),
);

const fileTransforms = new Map<string, TransformResult>();
const fileTransforms = new Map<string, RuntimeTransformResult>();

this._v8CoverageResults.forEach(res =>
res.forEach(r => {
Expand Down Expand Up @@ -453,7 +453,7 @@ export default class CoverageReporter extends BaseReporter {

const converter = v8toIstanbul(
res.url,
0,
fileTransform?.wrapperLength ?? 0,
fileTransform && sourcemapContent
? {
originalSource: fileTransform.originalCode,
Expand Down
56 changes: 21 additions & 35 deletions packages/jest-runtime/src/index.ts
Expand Up @@ -16,7 +16,6 @@ import {
Context as VMContext,
// @ts-expect-error: experimental, not added to the types
Module as VMModule,
compileFunction,
} from 'vm';
import * as nativeModule from 'module';
import type {Config, Global} from '@jest/types';
Expand All @@ -35,12 +34,11 @@ import {escapePathForRegex} from 'jest-regex-util';
import {
ScriptTransformer,
ShouldInstrumentOptions,
TransformResult,
TransformationOptions,
handlePotentialSyntaxError,
shouldInstrument,
} from '@jest/transform';
import type {V8CoverageResult} from '@jest/test-result';
import type {RuntimeTransformResult, V8CoverageResult} from '@jest/test-result';
import {CoverageInstrumenter, V8Coverage} from 'collect-v8-coverage';
import * as fs from 'graceful-fs';
import jestMock = require('jest-mock');
Expand Down Expand Up @@ -170,7 +168,7 @@ class Runtime {
private _shouldUnmockTransitiveDependenciesCache: BooleanMap;
private _sourceMapRegistry: StringMap;
private _scriptTransformer: ScriptTransformer;
private _fileTransforms: Map<string, TransformResult>;
private _fileTransforms: Map<string, RuntimeTransformResult>;
private _v8CoverageInstrumenter: CoverageInstrumenter | undefined;
private _v8CoverageResult: V8Coverage | undefined;
private _transitiveShouldMock: BooleanMap;
Expand Down Expand Up @@ -830,7 +828,7 @@ class Runtime {
});
}

// TODO - remove in Jest 26
// TODO - remove in Jest 27
getSourceMapInfo(_coveredFiles: Set<string>): Record<string, string> {
return {};
}
Expand Down Expand Up @@ -1005,36 +1003,23 @@ class Runtime {

let compiledFunction: ModuleWrapper | null = null;

const script = this.createScriptFromCode(transformedCode, filename);

let runScript: RunScriptEvalResult | null = null;

// Use this if available instead of deprecated `JestEnvironment.runScript`
if (typeof this._environment.getVmContext === 'function') {
const vmContext = this._environment.getVmContext();

if (vmContext) {
try {
compiledFunction = compileFunction(
transformedCode,
this.constructInjectedModuleParameters(),
{
filename,
parsingContext: vmContext,
},
) as ModuleWrapper;
} catch (e) {
throw handlePotentialSyntaxError(e);
}
runScript = script.runInContext(vmContext, {filename});
}
} else {
const script = this.createScriptFromCode(transformedCode, filename);

const runScript = this._environment.runScript<RunScriptEvalResult>(
script,
);
runScript = this._environment.runScript<RunScriptEvalResult>(script);
}

if (runScript === null) {
compiledFunction = null;
} else {
compiledFunction = runScript[EVAL_RESULT_VARIABLE];
}
if (runScript !== null) {
compiledFunction = runScript[EVAL_RESULT_VARIABLE];
}

if (compiledFunction === null) {
Expand Down Expand Up @@ -1097,7 +1082,10 @@ class Runtime {
source,
);

this._fileTransforms.set(filename, transformedFile);
this._fileTransforms.set(filename, {
...transformedFile,
wrapperLength: this.constructModuleWrapperStart().length,
});

if (transformedFile.sourceMapPath) {
this._sourceMapRegistry.set(filename, transformedFile.sourceMapPath);
Expand Down Expand Up @@ -1602,15 +1590,13 @@ class Runtime {
}

private wrapCodeInModuleWrapper(content: string) {
return this.constructModuleWrapperStart() + content + '\n}});';
}

private constructModuleWrapperStart() {
const args = this.constructInjectedModuleParameters();

return (
'({"' +
EVAL_RESULT_VARIABLE +
`":function(${args.join(',')}){` +
content +
'\n}});'
);
return '({"' + EVAL_RESULT_VARIABLE + `":function(${args.join(',')}){`;
}

private constructInjectedModuleParameters(): Array<string> {
Expand Down
1 change: 1 addition & 0 deletions packages/jest-test-result/src/index.ts
Expand Up @@ -19,6 +19,7 @@ export type {
FailedAssertion,
FormattedTestResults,
Milliseconds,
RuntimeTransformResult,
SerializableError,
SnapshotSummary,
Status,
Expand Down
7 changes: 6 additions & 1 deletion packages/jest-test-result/src/types.ts
Expand Up @@ -10,8 +10,13 @@ import type {ConsoleBuffer} from '@jest/console';
import type {Config, TestResult, TransformTypes} from '@jest/types';
import type {V8Coverage} from 'collect-v8-coverage';

export interface RuntimeTransformResult extends TransformTypes.TransformResult {
// TODO: Make mandatory in Jest 27
wrapperLength?: number;
}

export type V8CoverageResult = Array<{
codeTransformResult: TransformTypes.TransformResult | undefined;
codeTransformResult: RuntimeTransformResult | undefined;
result: V8Coverage[number];
}>;

Expand Down
2 changes: 1 addition & 1 deletion packages/jest-types/src/Transform.ts
Expand Up @@ -9,6 +9,6 @@
export type TransformResult = {
code: string;
originalCode: string;
mapCoverage?: boolean; // TODO - Remove in Jest 26
mapCoverage?: boolean; // TODO - Remove in Jest 27
sourceMapPath: string | null;
};