Skip to content

Commit

Permalink
feat(commonjs)!: Add ignore-dynamic-requires option (#819)
Browse files Browse the repository at this point in the history
BREAKING CHANGES:
When dynamicRequireTargets is specified, "require" will be default no longer be used as fallback
  • Loading branch information
lukastaegert authored Mar 10, 2021
1 parent 8752c2f commit 2d06c44
Show file tree
Hide file tree
Showing 33 changed files with 761 additions and 466 deletions.
19 changes: 19 additions & 0 deletions packages/commonjs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,25 @@ Due to the conversion of `require` to a static `import` - the call is hoisted to
- `string[]`: Pass an array containing the IDs to left unconverted.
- `((id: string) => boolean|'remove')`: Pass a function that control individual IDs.

### `ignoreDynamicRequires`

Type: `boolean`
Default: false

Some `require` calls cannot be resolved statically to be translated to imports, e.g.

```js
function wrappedRequire(target) {
return require(target);
}
wrappedRequire('foo');
wrappedRequire('bar');
```

When this option is set to `false`, the generated code will either directly throw an error when such a call is encountered or, when `dynamicRequireTargets` is used, when such a call cannot be resolved with a configured dynamic require target.

Setting this option to `true` will instead leave the `require` call in the code or use it as a fallback for `dynamicRequireTargets`.

### `esmExternals`

Type: `boolean | string[] | ((id: string) => boolean)`
Expand Down
16 changes: 10 additions & 6 deletions packages/commonjs/src/helpers.js
Original file line number Diff line number Diff line change
Expand Up @@ -48,18 +48,20 @@ export function getAugmentedNamespace(n) {
}
`;

const FAILED_REQUIRE_ERROR = `throw new Error('Could not dynamically require "' + path + '". Please configure the dynamicRequireTargets or/and ignoreDynamicRequires option of @rollup/plugin-commonjs appropriately for this require call to work.');`;

const HELPER_NON_DYNAMIC = `
export function createCommonjsModule(fn) {
var module = { exports: {} }
return fn(module, module.exports), module.exports;
}
export function commonjsRequire (target) {
throw new Error('Could not dynamically require "' + target + '". Please configure the dynamicRequireTargets option of @rollup/plugin-commonjs appropriately for this require call to behave properly.');
export function commonjsRequire (path) {
${FAILED_REQUIRE_ERROR}
}
`;

const HELPERS_DYNAMIC = `
const getDynamicHelpers = (ignoreDynamicRequires) => `
export function createCommonjsModule(fn, basedir, module) {
return module = {
path: basedir,
Expand Down Expand Up @@ -231,13 +233,15 @@ export function commonjsRequire (path, originalModuleDir) {
return cachedModule.exports;
};
}
return require(path);
${ignoreDynamicRequires ? 'return require(path);' : FAILED_REQUIRE_ERROR}
}
commonjsRequire.cache = DYNAMIC_REQUIRE_CACHE;
commonjsRequire.resolve = commonjsResolve;
`;

export function getHelpersModule(isDynamicRequireModulesEnabled) {
return `${HELPERS}${isDynamicRequireModulesEnabled ? HELPERS_DYNAMIC : HELPER_NON_DYNAMIC}`;
export function getHelpersModule(isDynamicRequireModulesEnabled, ignoreDynamicRequires) {
return `${HELPERS}${
isDynamicRequireModulesEnabled ? getDynamicHelpers(ignoreDynamicRequires) : HELPER_NON_DYNAMIC
}`;
}
7 changes: 6 additions & 1 deletion packages/commonjs/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ export default function commonjs(options = {}) {
const filter = createFilter(options.include, options.exclude);
const {
ignoreGlobal,
ignoreDynamicRequires,
requireReturnsDefault: requireReturnsDefaultOption,
esmExternals
} = options;
Expand Down Expand Up @@ -97,6 +98,7 @@ export default function commonjs(options = {}) {

function transformAndCheckExports(code, id) {
if (isDynamicRequireModulesEnabled && this.getModuleInfo(id).isEntry) {
// eslint-disable-next-line no-param-reassign
code =
getDynamicPackagesEntryIntro(dynamicRequireModuleDirPaths, dynamicRequireModuleSet) + code;
}
Expand Down Expand Up @@ -125,6 +127,7 @@ export default function commonjs(options = {}) {
// avoid wrapping in createCommonjsModule, as this is a commonjsRegister call
if (isModuleRegisterProxy(id)) {
disableWrap = true;
// eslint-disable-next-line no-param-reassign
id = unwrapModuleRegisterProxy(id);
}

Expand All @@ -135,6 +138,7 @@ export default function commonjs(options = {}) {
isEsModule,
ignoreGlobal || isEsModule,
ignoreRequire,
ignoreDynamicRequires && !isDynamicRequireModulesEnabled,
getIgnoreTryCatchRequireStatementMode,
sourceMap,
isDynamicRequireModulesEnabled,
Expand All @@ -161,7 +165,7 @@ export default function commonjs(options = {}) {

load(id) {
if (id === HELPERS_ID) {
return getHelpersModule(isDynamicRequireModulesEnabled);
return getHelpersModule(isDynamicRequireModulesEnabled, ignoreDynamicRequires);
}

if (id.startsWith(HELPERS_ID)) {
Expand Down Expand Up @@ -232,6 +236,7 @@ export default function commonjs(options = {}) {
}
},

// eslint-disable-next-line no-shadow
moduleParsed({ id, meta: { commonjs } }) {
if (commonjs) {
const isCjs = commonjs.isCommonJS;
Expand Down
15 changes: 9 additions & 6 deletions packages/commonjs/src/transform-commonjs.js
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ export default function transformCommonjs(
isEsModule,
ignoreGlobal,
ignoreRequire,
ignoreDynamicRequires,
getIgnoreTryCatchRequireStatementMode,
sourceMap,
isDynamicRequireModulesEnabled,
Expand Down Expand Up @@ -320,12 +321,14 @@ export default function transformCommonjs(
)}`
);
}
if (isShorthandProperty(parent)) {
magicString.appendRight(node.end, `: ${HELPERS_NAME}.commonjsRequire`);
} else {
magicString.overwrite(node.start, node.end, `${HELPERS_NAME}.commonjsRequire`, {
storeName: true
});
if (!ignoreDynamicRequires) {
if (isShorthandProperty(parent)) {
magicString.appendRight(node.end, `: ${HELPERS_NAME}.commonjsRequire`);
} else {
magicString.overwrite(node.start, node.end, `${HELPERS_NAME}.commonjsRequire`, {
storeName: true
});
}
}

uses.commonjsHelpers = true;
Expand Down

This file was deleted.

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
module.exports = {
description: 'keeps a require call as fallback when configured',
pluginOptions: {
ignoreDynamicRequires: true
}
};
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
module.exports = 'dep';
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
/* eslint-disable import/no-dynamic-require, global-require */

function takeModule(withName) {
return require(withName);
}

// The bundled code will run from test/helpers/util.js
t.is(takeModule('../fixtures/function/dynamic-require-fallback/dep.js'), 'dep');
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,7 @@ function takeModule(withName) {
t.is(takeModule('submodule1.js'), 'submodule1');
t.is(takeModule('submodule2.js'), 'submodule2');
t.is(takeModule('extramodule1.js'), 'extramodule1');

let hasThrown = false;
try {
takeModule('extramodule2.js');
} catch (error) {
t.truthy(/Cannot find module '\.\/extramodule2\.js'/.test(error.message));
hasThrown = true;
}
t.truthy(hasThrown);
t.throws(() => takeModule('extramodule2.js'), {
message:
'Could not dynamically require "./extramodule2.js". Please configure the dynamicRequireTargets or/and ignoreDynamicRequires option of @rollup/plugin-commonjs appropriately for this require call to work.'
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module.exports = {
description: 'throws when there is no fallback for a dynamic require call'
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
/* eslint-disable import/no-dynamic-require, global-require */

function takeModule(withName) {
return require(withName);
}

t.throws(() => takeModule('./dep.js'), {
message:
'Could not dynamically require "./dep.js". Please configure the dynamicRequireTargets or/and ignoreDynamicRequires option of @rollup/plugin-commonjs appropriately for this require call to work.'
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
module.exports = {
description: 'keeps a require call as fallback when configured for dynamicRequireTargets',
pluginOptions: {
ignoreDynamicRequires: true,
dynamicRequireTargets: ['fixtures/function/dynamic-require-targets-fallback/dep1.js']
}
};
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
module.exports = 'dep';
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
module.exports = 'dep';
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
/* eslint-disable import/no-dynamic-require, global-require */

function takeModule(withName) {
return require(withName);
}

t.is(takeModule('./dep1.js'), 'dep');
// The bundled code will run from test/helpers/util.js
t.is(takeModule('../fixtures/function/dynamic-require-targets-fallback/dep2.js'), 'dep');
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
module.exports = {
description:
'throws when there is no require call configured as fallback for dynamicRequireTargets',
pluginOptions: {
dynamicRequireTargets: ['fixtures/function/dynamic-require-targets-no-fallback/dep1.js']
}
};
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
module.exports = 'dep';
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
/* eslint-disable import/no-dynamic-require, global-require */

function takeModule(withName) {
return require(withName);
}

t.is(takeModule('./dep1.js'), 'dep');
t.throws(() => takeModule('./dep2.js'), {
message:
'Could not dynamically require "./dep2.js". Please configure the dynamicRequireTargets or/and ignoreDynamicRequires option of @rollup/plugin-commonjs appropriately for this require call to work.'
});
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
exports.encodeURIComponent = function() {
exports.encodeURIComponent = function () {
return encodeURIComponent(this.str);
};

Expand Down
2 changes: 1 addition & 1 deletion packages/commonjs/test/fixtures/function/inline/main.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/* eslint-disable global-require */
module.exports = function() {
module.exports = function () {
return require('./multiply')(2, require('./foo'));
};
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
module.exports = function(a, b) {
module.exports = function (a, b) {
return a * b;
};
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
module.exports = function() {
module.exports = function () {
return true;
};

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
module.exports = function() {
module.exports = function () {
return 'Hello there';
};
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
if (typeof require === 'function') {
module.exports = (function(require) {
module.exports = (function (require) {
return typeof require;
})({});
}
11 changes: 9 additions & 2 deletions packages/commonjs/test/form.js
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,15 @@ readdirSync('./fixtures/form').forEach((dir) => {
// this will benefit issues like `form/try-catch-remove` where whitespace is left in the line,
// and testing on windows (\r\n)
t.is(
actual.split('\n').map(x => x.trimEnd()).join('\n'),
expected.split('\n').map(x => x.trimEnd()).join('\n'));
actual
.split('\n')
.map((x) => x.trimEnd())
.join('\n'),
expected
.split('\n')
.map((x) => x.trimEnd())
.join('\n')
);
}
});
});
Loading

0 comments on commit 2d06c44

Please sign in to comment.