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.

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

Jump to bottom

Require wrapper support #34

Merged
merged 4 commits into from
May 15, 2019
Merged

Require wrapper support #34

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
303a082
special cases updates
guybedford May 15, 2019
06c3c77
support functions wrapping require
guybedford May 15, 2019
365a957
fixup body check
guybedford May 15, 2019
c7901aa
asset tweak
guybedford May 15, 2019
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
94 changes: 80 additions & 14 deletions src/asset-relocator.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@ const glob = require('glob');
const getPackageBase = require('./utils/get-package-base');
const getPackageScope = require('./utils/get-package-scope');
const { pregyp, nbind } = require('./utils/binary-locators');
const handleWrappers = require('./utils/wrappers');
const handleSpecialCase = require('./utils/special-cases');
const handleSpecialCases = require('./utils/special-cases');
const { getOptions } = require("loader-utils");
const resolve = require('resolve');
const stage3 = require('acorn-stage3');
Expand Down Expand Up @@ -240,6 +239,8 @@ function backtrack (self, parent) {
return self.skip();
}

const BOUND_REQUIRE = Symbol();

module.exports = async function (content, map) {
if (this.cacheable)
this.cacheable();
Expand Down Expand Up @@ -269,8 +270,6 @@ module.exports = async function (content, map) {

let code = content.toString();

const specialCase = handleSpecialCase(id, code);

const options = getOptions(this);
if (typeof options.production === 'boolean' && staticProcess.env.NODE_ENV === UNKNOWN) {
staticProcess.env.NODE_ENV = options.production ? 'production' : 'dev';
Expand Down Expand Up @@ -432,10 +431,6 @@ module.exports = async function (content, map) {

let transformed = false;

if (specialCase) {
transformed = specialCase({ code, ast, scope, magicString, emitAsset, emitAssetDirectory });
}

const knownBindings = Object.assign(Object.create(null), {
__dirname: {
shadowDepth: 0,
Expand Down Expand Up @@ -524,6 +519,9 @@ module.exports = async function (content, map) {
// Express engine opt-out
let definedExpressEngines = false;

// track the name of any function that wraps "require"
let boundRequireName;

// detect require('asdf');
function isStaticRequire (node) {
return node &&
Expand All @@ -535,11 +533,8 @@ module.exports = async function (content, map) {
node.arguments[0].type === 'Literal';
}

if (options.wrapperCompatibility) {
({ ast, scope, transformed: wrapperTransformed } = handleWrappers(ast, scope, magicString, code.length));
if (wrapperTransformed)
transformed = true;
}
({ ast = ast, scope = scope, transformed = transformed } =
handleSpecialCases({ id, ast, scope, pkgBase, magicString, options, emitAsset, emitAssetDirectory }) || {});

walk(ast, {
enter (node, parent) {
Expand Down Expand Up @@ -726,6 +721,19 @@ module.exports = async function (content, map) {
// handle well-known function symbol cases
else if (calleeValue && typeof calleeValue.value === 'symbol') {
switch (calleeValue.value) {
// customRequireWrapper('...') -> wrapperMod(require('...'), '...')
case BOUND_REQUIRE:
if (node.arguments.length === 1 &&
node.arguments[0].type === 'Literal' &&
node.callee.type === 'Identifier' &&
knownBindings.require.shadowDepth === 0) {
transformed = true;
magicString.overwrite(node.callee.start, node.callee.end, 'require');
magicString.appendRight(node.start, boundRequireName + '(');
magicString.appendLeft(node.end, ', ' + code.substring(node.arguments[0].start, node.arguments[0].end) + ')');
return this.skip();
}
break;
// require('bindings')(...)
case BINDINGS:
if (node.arguments.length) {
Expand Down Expand Up @@ -895,6 +903,64 @@ module.exports = async function (content, map) {
return this.skip();
}
}
// function p (x) { ...; var y = require(x); ...; return y; } -> additional function p_mod (y) { ...; ...; return y; }
else if (!isESM &&
(node.type === 'FunctionDeclaration' || node.type === 'FunctionExpression' || node.type === 'ArrowFunctionExpression') &&
(node.arguments || node.params)[0] && (node.arguments || node.params)[0].type === 'Identifier') {
let fnName, args;
if ((node.type === 'ArrowFunctionExpression' || node.type === 'FunctionExpression') &&
parent.type === 'VariableDeclarator' &&
parent.id.type === 'Identifier') {
fnName = parent.id;
args = (node.arguments || node.params);
}
else if (node.id) {
fnName = node.id;
args = node.arguments;
}
if (fnName && node.body.body) {
let requireDecl, requireDeclaration, returned = false;
for (let i = 0; i < node.body.body.length; i++) {
if (node.body.body[i].type === 'VariableDeclaration' && !requireDecl) {
requireDecl = node.body.body[i].declarations.find(decl =>
decl.id.type === 'Identifier' &&
decl.init &&
decl.init.type === 'CallExpression' &&
decl.init.callee.type === 'Identifier' &&
decl.init.callee.name === 'require' &&
knownBindings.require.shadowDepth === 0 &&
decl.init.arguments[0] &&
decl.init.arguments[0].type === 'Identifier' &&
decl.init.arguments[0].name === args[0].name
);
if (requireDecl)
requireDeclaration = node.body.body[i];
}
if (requireDecl &&
node.body.body[i].type === 'ReturnStatement' &&
node.body.body[i].argument &&
node.body.body[i].argument.type === 'Identifier' &&
node.body.body[i].argument.name === requireDecl.id.name) {
returned = true;
break;
}
}
if (returned) {
let prefix = ';';
const wrapArgs = node.type === 'ArrowFunctionExpression' && node.params[0].start === node.start;
if (node.type === 'FunctionExpression' || node.type === 'ArrowFunctionExpression') {
node = parent;
prefix = ',';
}
boundRequireName = fnName.name + '$$mod';
setKnownBinding(fnName.name, BOUND_REQUIRE);
const newFn = prefix + code.substring(node.start, fnName.start) + boundRequireName + code.substring(fnName.end, args[0].start + !wrapArgs) +
(wrapArgs ? '(' : '') + requireDecl.id.name + ', ' + code.substring(args[0].start, args[args.length - 1].end) + (wrapArgs ? ')' : '') +
code.substring(args[0].end + !wrapArgs, requireDeclaration.start) + code.substring(requireDeclaration.end, node.end);
magicString.appendRight(node.end, newFn);
}
}
}
},
leave (node, parent) {
if (node.scope) {
Expand Down Expand Up @@ -975,7 +1041,7 @@ module.exports = async function (content, map) {
return;
}
// do not emit assets outside of the cwd
if (!assetPath.startsWith(cwd)) {
if (!pkgBase && !assetPath.startsWith(cwd)) {
if (options.debugLog) {
if (assetEmission(assetPath))
console.log('Skipping asset emission of ' + assetPath.replace(wildcardRegEx, '*') + ' for ' + id + ' as it is outside the process directory ' + cwd);
Expand Down
Loading