6896912539

Committed 16 Nov 2023 09:48PM UTC coverage: 90.469% (+0.03%) from 90.441%

Build # 6896912539

Build Type

push

github

Committed by

overlookmotel

Commit Message

Support `super` in `eval()` [fix]

Fixes #308.

Run Details

4704 of 5056 branches covered (0.0%)

Branch coverage included in aggregate %.

26 of 37 new or added lines in 4 files covered. (70.27%)

10 existing lines in 2 files now uncovered.

12629 of 14103 relevant lines covered (89.55%)

13072.59 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

61.68

/lib/instrument/instrument.js

/* --------------------
 * livepack module
 * Code instrumentation functions
 * ------------------*/

'use strict';

// Modules
const {parse} = require('@babel/parser'),
        generate = require('@babel/generator').default;

// Imports
const {parseSourceMapComment, mapLocations} = require('./sourceMaps.js'),
        modifyAst = require('./modify.js');

// Exports

module.exports = {
        parseImpl,
        instrumentCodeImpl,
        instrumentAstImpl
};

let babelTransformFromAstSync, babelLoadOptions,
        babelPluginModulesToCommonJs, babelPluginTransformJsx, babelPluginDynamicImportToRequire;
const babelOptionsCache = {};

/**
 * Parse code to AST.
 * @param {string} code - Code
 * @param {string} [filename] - File path - must be provided if `sourceMaps` option is `true`
 * @param {boolean} isEsm - `true` if is ES Module
 * @param {boolean} isCommonJs - `true` if is CommonJS
 * @param {boolean} allowNewTarget - `true` if `new.target` can be used outside a function
 *   (CommmonJS or direct `eval()` within a function)
 * @param {boolean} allowSuper - `true` if `super` can be used outside a function
 *   (direct `eval()` within a method)
 * @param {boolean} isJsx - `true` if source contains JSX syntax
 * @param {boolean} isStrict - `true` if strict mode
 * @param {boolean} sourceMaps - `true` if source maps enabled
 * @param {Object} [inputSourceMap] - Source map object (optional)
 * @returns {Object} - Object with properties:
 *   {Object} .ast - AST
 *   {Object|undefined} .sources - Sources object mapping file path to file content,
 *     or `undefined` if `sourceMaps` option is `false`
 * @throws {Error} - If parsing error
 */
function parseImpl(
        code, filename, isEsm, isCommonJs, allowNewTarget, allowSuper, isJsx, isStrict,
        sourceMaps, inputSourceMap
) {
        // Parse code to AST
        const ast = parse(code, {
                sourceType: isEsm ? 'module' : 'script',
                strictMode: isStrict,
                allowReturnOutsideFunction: isCommonJs,
                allowNewTargetOutsideFunction: allowNewTarget,
                allowSuperOutsideMethod: allowSuper,
                plugins: ['v8intrinsic', ...(isJsx ? ['jsx'] : [])]
        });

        // Parse source map comment if present, and remove source map comments from AST.
        // Do not parse source map comment if source maps disabled, or input source map already provided.
        const parsedSourceMap = parseSourceMapComment(
                ast, (sourceMaps && !inputSourceMap) ? filename : undefined
        );
        if (parsedSourceMap) inputSourceMap = parsedSourceMap;

        // Map AST nodes' locations according to source map and get sources
        let sources;
        if (inputSourceMap) {
                sources = mapLocations(ast, inputSourceMap, filename);
                sources[filename] = code;
        } else if (sourceMaps) {
                sources = Object.create(null);
                sources[filename] = code;
        }

        // Return AST and sources
        return {ast, sources};
}

/**
 * Instrument code.
 * @param {string} code - Code
 * @param {string} filename - File path
 * @param {boolean} isEsm - `true` if is ES Module
 * @param {boolean} isCommonJs - `true` if is CommonJS
 * @param {boolean} isJsx - `true` if source contains JSX syntax
 * @param {boolean} isStrict - `true` if strict mode
 * @param {boolean} sourceMaps - `true` if source maps enabled
 * @param {Object} [inputSourceMap] - Source map object (optional)
 * @param {boolean} retainLines - `true` to retain original line numbers
 * @returns {Object} - Object with properties:
 *   {string} .code - Transformed code
 *   {Object|null} .map - Source map object (if `sourceMaps` option set)
 *   {Array<Object>|undefined} .rawMappings - Source map raw mappings array (if `sourceMaps` option set)
 */
function instrumentCodeImpl(
        code, filename, isEsm, isCommonJs, isJsx, isStrict, sourceMaps, inputSourceMap, retainLines
) {
        // Parse code to AST
        let {ast, sources} = parseImpl( // eslint-disable-line prefer-const
                code, filename, isEsm, isCommonJs, isCommonJs, false, isJsx, isStrict, sourceMaps, inputSourceMap
        );

        // Instrument AST
        ast = instrumentAstImpl(ast, filename, isEsm, isCommonJs, isJsx, isStrict, sources);

        // Generate output code
        return generate(
                ast,
                {sourceMaps, sourceFileName: filename, retainLines},
                sources
        );
}

/**
 * Instrument AST.
 * @param {Object} ast - AST
 * @param {string} filename - File path
 * @param {boolean} isEsm - `true` if source contains ESM syntax
 * @param {boolean} isCommonJs - `true` if is CommonJS file
 * @param {boolean} isJsx - `true` if source contains JSX syntax
 * @param {boolean} isStrict - `true` if is strict mode code
 * @param {Object} [sources] - Sources object mapping file path to file content
 * @returns {Object} - Transformed AST
 */
function instrumentAstImpl(ast, filename, isEsm, isCommonJs, isJsx, isStrict, sources) {
        // Transform ESM and JSX
        if (isEsm || isJsx) ast = babelTransform(ast, isEsm, isJsx);

        // Add instrumentation to AST
        modifyAst(ast, filename, isCommonJs, isStrict, sources);

        // Return AST
        return ast;
}

/**
 * Transform AST with `@babel/plugin-transform-modules-commonjs` / `@babel/plugin-transform-react-jsx`
 * plugins if source is ESM/JSX.
 * @param {Object} ast - AST
 * @param {boolean} isEsm - `true` if source contains ESM syntax
 * @param {boolean} isJsx - `true` if source contains JSX syntax
 * @returns {Object} - Transformed AST
 */
function babelTransform(ast, isEsm, isJsx) {
        /* eslint-disable global-require */
        if (!babelTransformFromAstSync) {
                const babel = require('@babel/core');
                babelTransformFromAstSync = babel.transformFromAstSync;
                babelLoadOptions = babel.loadOptions;
        }

        const optionsCacheKey = JSON.stringify({isEsm, isJsx});
        let options = babelOptionsCache[optionsCacheKey];
        if (!options) {
                const plugins = [];
                if (isEsm) {
                        if (!babelPluginModulesToCommonJs) {
                                babelPluginModulesToCommonJs = require('@babel/plugin-transform-modules-commonjs').default;
                                babelPluginDynamicImportToRequire = require('babel-plugin-dynamic-import-node');
                        }
                        plugins.push(babelPluginModulesToCommonJs, babelPluginDynamicImportToRequire);
                }
                if (isJsx) {
                        babelPluginTransformJsx ||= require('@babel/plugin-transform-react-jsx').default;
                        plugins.push(babelPluginTransformJsx);
                }

                options = babelLoadOptions({
                        configFile: false,
                        babelrc: false,
                        ast: true,
                        sourceType: isEsm ? 'module' : 'script',
                        plugins
                });
                babelOptionsCache[optionsCacheKey] = options;
        }
        /* eslint-enable global-require */

        return babelTransformFromAstSync(ast, undefined, options).ast;
}

1	/* --------------------	62✔
2	* livepack module	62✔
3	* Code instrumentation functions	62✔
4	* ------------------*/	62✔
5		62✔
6	'use strict';	62✔
7		62✔
8	// Modules	62✔
9	const {parse} = require('@babel/parser'),	62✔
10	generate = require('@babel/generator').default;	62✔
11		62✔
12	// Imports	62✔
13	const {parseSourceMapComment, mapLocations} = require('./sourceMaps.js'),	62✔
14	modifyAst = require('./modify.js');	62✔
15		62✔
16	// Exports	62✔
17		62✔
18	module.exports = {	62✔
19	parseImpl,	62✔
20	instrumentCodeImpl,	62✔
21	instrumentAstImpl	62✔
22	};	62✔
23		62✔
24	let babelTransformFromAstSync, babelLoadOptions,	62✔
25	babelPluginModulesToCommonJs, babelPluginTransformJsx, babelPluginDynamicImportToRequire;	62✔
26	const babelOptionsCache = {};	62✔
27		62✔
28	/**	62✔
29	* Parse code to AST.	62✔
30	* @param {string} code - Code	62✔
31	* @param {string} [filename] - File path - must be provided if `sourceMaps` option is `true`	62✔
32	* @param {boolean} isEsm - `true` if is ES Module	62✔
33	* @param {boolean} isCommonJs - `true` if is CommonJS	62✔
34	* @param {boolean} allowNewTarget - `true` if `new.target` can be used outside a function	62✔
35	* (CommmonJS or direct `eval()` within a function)	62✔
36	* @param {boolean} allowSuper - `true` if `super` can be used outside a function	62✔
37	* (direct `eval()` within a method)	62✔
38	* @param {boolean} isJsx - `true` if source contains JSX syntax	62✔
39	* @param {boolean} isStrict - `true` if strict mode	62✔
40	* @param {boolean} sourceMaps - `true` if source maps enabled	62✔
41	* @param {Object} [inputSourceMap] - Source map object (optional)	62✔
42	* @returns {Object} - Object with properties:	62✔
43	* {Object} .ast - AST	62✔
44	* {Object\|undefined} .sources - Sources object mapping file path to file content,	62✔
45	* or `undefined` if `sourceMaps` option is `false`	62✔
46	* @throws {Error} - If parsing error	62✔
47	*/	62✔
48	function parseImpl(	6,758✔
49	code, filename, isEsm, isCommonJs, allowNewTarget, allowSuper, isJsx, isStrict,	6,758✔
50	sourceMaps, inputSourceMap	6,758✔
51	) {	6,758✔
52	// Parse code to AST	6,758✔
53	const ast = parse(code, {	6,758✔
54	sourceType: isEsm ? 'module' : 'script',	6,758!
55	strictMode: isStrict,	6,758✔
56	allowReturnOutsideFunction: isCommonJs,	6,758✔
57	allowNewTargetOutsideFunction: allowNewTarget,	×
NEW 58	allowSuperOutsideMethod: allowSuper,	×
59	plugins: ['v8intrinsic', ...(isJsx ? ['jsx'] : [])]	×
60	});	×
61		×
62	// Parse source map comment if present, and remove source map comments from AST.	×
63	// Do not parse source map comment if source maps disabled, or input source map already provided.	×
64	const parsedSourceMap = parseSourceMapComment(	×
65	ast, (sourceMaps && !inputSourceMap) ? filename : undefined	✔
66	);	×
67	if (parsedSourceMap) inputSourceMap = parsedSourceMap;	✔
68		✔
69	// Map AST nodes' locations according to source map and get sources	×
70	let sources;	×
71	if (inputSourceMap) {	✔
72	sources = mapLocations(ast, inputSourceMap, filename);	×
73	sources[filename] = code;	×
74	} else if (sourceMaps) {	✔
75	sources = Object.create(null);	×
76	sources[filename] = code;	×
77	}	×
78		✔
79	// Return AST and sources	×
80	return {ast, sources};	×
81	}	×
82		×
83	/**	×
84	* Instrument code.	×
85	* @param {string} code - Code	×
86	* @param {string} filename - File path	×
87	* @param {boolean} isEsm - `true` if is ES Module	×
88	* @param {boolean} isCommonJs - `true` if is CommonJS	×
89	* @param {boolean} isJsx - `true` if source contains JSX syntax	×
90	* @param {boolean} isStrict - `true` if strict mode	×
91	* @param {boolean} sourceMaps - `true` if source maps enabled	×
92	* @param {Object} [inputSourceMap] - Source map object (optional)	×
93	* @param {boolean} retainLines - `true` to retain original line numbers	62✔
94	* @returns {Object} - Object with properties:	62✔
95	* {string} .code - Transformed code	62✔
96	* {Object\|null} .map - Source map object (if `sourceMaps` option set)	62✔
97	* {Array<Object>\|undefined} .rawMappings - Source map raw mappings array (if `sourceMaps` option set)	62✔
98	*/	62✔
99	function instrumentCodeImpl(	2,314✔
100	code, filename, isEsm, isCommonJs, isJsx, isStrict, sourceMaps, inputSourceMap, retainLines	2,314✔
101	) {	2,314✔
102	// Parse code to AST	2,314✔
103	let {ast, sources} = parseImpl( // eslint-disable-line prefer-const	2,314✔
104	code, filename, isEsm, isCommonJs, isCommonJs, false, isJsx, isStrict, sourceMaps, inputSourceMap	2,314✔
105	);	2,314✔
106		2,314✔
107	// Instrument AST	2,314✔
108	ast = instrumentAstImpl(ast, filename, isEsm, isCommonJs, isJsx, isStrict, sources);	2,314✔
109		2,314✔
110	// Generate output code	2,314✔
111	return generate(	2,314✔
112	ast,	2,314✔
113	{sourceMaps, sourceFileName: filename, retainLines},	2,314✔
114	sources	×
115	);	×
116	}	×
117		×
118	/**	×
119	* Instrument AST.	×
120	* @param {Object} ast - AST	×
121	* @param {string} filename - File path	×
122	* @param {boolean} isEsm - `true` if source contains ESM syntax	×
123	* @param {boolean} isCommonJs - `true` if is CommonJS file	×
124	* @param {boolean} isJsx - `true` if source contains JSX syntax	×
125	* @param {boolean} isStrict - `true` if is strict mode code	×
126	* @param {Object} [sources] - Sources object mapping file path to file content	×
127	* @returns {Object} - Transformed AST	×
128	*/	×
129	function instrumentAstImpl(ast, filename, isEsm, isCommonJs, isJsx, isStrict, sources) {	2,314✔
130	// Transform ESM and JSX	2,314✔
131	if (isEsm \|\| isJsx) ast = babelTransform(ast, isEsm, isJsx);	2,314!
132		2,314✔
133	// Add instrumentation to AST	2,314✔
134	modifyAst(ast, filename, isCommonJs, isStrict, sources);	2,314✔
135		2,314✔
136	// Return AST	2,314✔
137	return ast;	2,314✔
138	}	2,314✔
139		62✔
140	/**	62✔
141	* Transform AST with `@babel/plugin-transform-modules-commonjs` / `@babel/plugin-transform-react-jsx`	62✔
142	* plugins if source is ESM/JSX.	62✔
143	* @param {Object} ast - AST	62✔
144	* @param {boolean} isEsm - `true` if source contains ESM syntax	62✔
145	* @param {boolean} isJsx - `true` if source contains JSX syntax	62✔
146	* @returns {Object} - Transformed AST	62✔
147	*/	62✔
148	function babelTransform(ast, isEsm, isJsx) {	×
149	/* eslint-disable global-require */	✔
150	if (!babelTransformFromAstSync) {	4✔
151	const babel = require('@babel/core');	4✔
152	babelTransformFromAstSync = babel.transformFromAstSync;	4✔
153	babelLoadOptions = babel.loadOptions;	4✔
154	}	4✔
155		4✔
156	const optionsCacheKey = JSON.stringify({isEsm, isJsx});	4✔
157	let options = babelOptionsCache[optionsCacheKey];	4✔
158	if (!options) {	4✔
159	const plugins = [];	4!
160	if (isEsm) {	×
161	if (!babelPluginModulesToCommonJs) {	4✔
162	babelPluginModulesToCommonJs = require('@babel/plugin-transform-modules-commonjs').default;	4✔
163	babelPluginDynamicImportToRequire = require('babel-plugin-dynamic-import-node');	×
164	}	×
165	plugins.push(babelPluginModulesToCommonJs, babelPluginDynamicImportToRequire);	×
166	}	×
167	if (isJsx) {	×
168	babelPluginTransformJsx \|\|= require('@babel/plugin-transform-react-jsx').default;	×
169	plugins.push(babelPluginTransformJsx);	×
170	}	×
171		×
172	options = babelLoadOptions({	×
173	configFile: false,	×
174	babelrc: false,	×
175	ast: true,	×
176	sourceType: isEsm ? 'module' : 'script',	×
177	plugins	×
178	});	×
179	babelOptionsCache[optionsCacheKey] = options;	×
180	}	×
181	/* eslint-enable global-require */	×
182		×
183	return babelTransformFromAstSync(ast, undefined, options).ast;	×
184	}	×

overlookmotel / livepack / 6896912539

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous