achan3/P2X-1041 new disableSharedBundles config option (#9209)

* Add initial config logic to disable shared bundles * Add test cases for disableSharedBundles config * Shared bundle creation now relies on disableSharedBundles * Add yarn.lock * add new logger warning when both minBundleSize and disableSharedBundles are manually set * Revert "add new logger warning when both minBundleSize and disableSharedBundles are manually set" This reverts commit fd2cdaa. * add warning for conflicting setting of both minBundleSize and disableSharedBundles config options * add test when disableSharedBundler config option isn't set - revert to default value * add test cases for instances that should not throw warnings * add test case where warning is expected * edit defaultBundler to throw warnings for minBundles and maxParallelRequests * condense test cases into minimal combos to test minBundles and maxParallelRequests * prevent reuse of bundles when disableSharedBundles is set * remove import used only for testing * add warning for minBundleSize when shared bundles are disabled * add warning for minBundleSize, remove duplicate disableSharedConfig checks, update test accordingly * stop removal of shared bundles if shared bundles are disabled to begin with --------- Co-authored-by: Iris Moini <[email protected]> Co-authored-by: achan3 <[email protected]>
parcel-bundler · Sep 22, 2023 · 6dcba36 · 6dcba36
1 parent df8f72b
commit 6dcba36
Show file tree

Hide file tree

Showing 44 changed files with 619 additions and 126 deletions.
diff --git a/packages/bundlers/default/src/DefaultBundler.js b/packages/bundlers/default/src/DefaultBundler.js
diff --git a/packages/core/integration-tests/test/bundler.js b/packages/core/integration-tests/test/bundler.js
@@ -1,8 +1,319 @@
 import path from 'path';
 import assert from 'assert';
+import Logger from '@parcel/logger';
 import {bundle, assertBundles, findAsset} from '@parcel/test-utils';
 
 describe('bundler', function () {
+  it('should not create shared bundles when a bundle is being reused and disableSharedBundles is enabled', async function () {
+    let b = await bundle(
+      path.join(
+        __dirname,
+        'integration/disable-shared-bundle-single-source/index.js',
+      ),
+      {
+        mode: 'production',
+        defaultTargetOptions: {
+          shouldScopeHoist: false,
+        },
+      },
+    );
+
+    assertBundles(b, [
+      {
+        name: 'index.js',
+        assets: [
+          'index.js',
+          'bundle-url.js',
+          'cacheLoader.js',
+          'esmodule-helpers.js',
+          'js-loader.js',
+          'bundle-manifest.js',
+        ],
+      },
+      {
+        assets: ['foo.js', 'a.js', 'b.js'],
+      },
+      {
+        assets: ['a.js', 'b.js', 'foo.js', 'bar.js'],
+      },
+    ]);
+  });
+
+  it('should not create shared bundles and should warn when disableSharedBundles is set to true with maxParallelRequests set', async function () {
+    let messages = [];
+    let loggerDisposable = Logger.onLog(message => {
+      messages.push(message);
+    });
+    let b = await bundle(
+      path.join(
+        __dirname,
+        'integration/disable-shared-bundles-true-parallel/index.js',
+      ),
+      {
+        mode: 'production',
+        defaultTargetOptions: {
+          shouldScopeHoist: false,
+        },
+      },
+    );
+    loggerDisposable.dispose();
+
+    assert.deepEqual(messages, [
+      {
+        type: 'log',
+        level: 'warn',
+        diagnostics: [
+          {
+            origin: '@parcel/bundler-default',
+            message:
+              'The value of "100" set for maxParallelRequests will not be used as shared bundles have been disabled',
+          },
+        ],
+      },
+    ]);
+    assertBundles(b, [
+      {
+        name: 'index.js',
+        assets: [
+          'index.js',
+          'bundle-url.js',
+          'cacheLoader.js',
+          'esmodule-helpers.js',
+          'js-loader.js',
+          'bundle-manifest.js',
+        ],
+      },
+      {
+        assets: ['foo.js', 'a.js', 'b.js'],
+      },
+      {
+        assets: ['bar.js', 'a.js', 'b.js'],
+      },
+    ]);
+  });
+
+  it('should not create shared bundles and should warn when disableSharedBundles is set to true with minBundleSize set', async function () {
+    let messages = [];
+    let loggerDisposable = Logger.onLog(message => {
+      messages.push(message);
+    });
+    let b = await bundle(
+      path.join(
+        __dirname,
+        'integration/disable-shared-bundles-true-min-bundleSize/index.js',
+      ),
+      {
+        mode: 'production',
+        defaultTargetOptions: {
+          shouldScopeHoist: false,
+        },
+      },
+    );
+    loggerDisposable.dispose();
+
+    assert.deepEqual(messages, [
+      {
+        type: 'log',
+        level: 'warn',
+        diagnostics: [
+          {
+            origin: '@parcel/bundler-default',
+            message:
+              'The value of "200" set for minBundleSize will not be used as shared bundles have been disabled',
+          },
+        ],
+      },
+    ]);
+    assertBundles(b, [
+      {
+        name: 'index.js',
+        assets: [
+          'index.js',
+          'bundle-url.js',
+          'cacheLoader.js',
+          'esmodule-helpers.js',
+          'js-loader.js',
+          'bundle-manifest.js',
+        ],
+      },
+      {
+        assets: ['foo.js', 'a.js', 'b.js'],
+      },
+      {
+        assets: ['bar.js', 'a.js', 'b.js'],
+      },
+    ]);
+  });
+
+  it('should not create shared bundles and should warn when disableSharedBundles is set to true with minBundles set', async function () {
+    let messages = [];
+    let loggerDisposable = Logger.onLog(message => {
+      messages.push(message);
+    });
+    let b = await bundle(
+      path.join(
+        __dirname,
+        'integration/disable-shared-bundles-true-min-bundles/index.js',
+      ),
+      {
+        mode: 'production',
+        defaultTargetOptions: {
+          shouldScopeHoist: false,
+        },
+      },
+    );
+    loggerDisposable.dispose();
+
+    assert.deepEqual(messages, [
+      {
+        type: 'log',
+        level: 'warn',
+        diagnostics: [
+          {
+            origin: '@parcel/bundler-default',
+            message:
+              'The value of "0" set for minBundles will not be used as shared bundles have been disabled',
+          },
+        ],
+      },
+    ]);
+    assertBundles(b, [
+      {
+        name: 'index.js',
+        assets: [
+          'index.js',
+          'bundle-url.js',
+          'cacheLoader.js',
+          'esmodule-helpers.js',
+          'js-loader.js',
+          'bundle-manifest.js',
+        ],
+      },
+      {
+        assets: ['foo.js', 'a.js', 'b.js'],
+      },
+      {
+        assets: ['bar.js', 'a.js', 'b.js'],
+      },
+    ]);
+  });
+
+  it('should not create shared bundles and should warn when disableSharedBundles is set to true with minBundles, minBundleSize and maxParallelRequests set', async function () {
+    let messages = [];
+    let loggerDisposable = Logger.onLog(message => {
+      messages.push(message);
+    });
+    let b = await bundle(
+      path.join(
+        __dirname,
+        'integration/disable-shared-bundles-true-min-bundles-parallel/index.js',
+      ),
+      {
+        mode: 'production',
+        defaultTargetOptions: {
+          shouldScopeHoist: false,
+        },
+      },
+    );
+    loggerDisposable.dispose();
+
+    assert.deepEqual(messages, [
+      {
+        type: 'log',
+        level: 'warn',
+        diagnostics: [
+          {
+            origin: '@parcel/bundler-default',
+            message:
+              'The value of "0" set for minBundles will not be used as shared bundles have been disabled',
+          },
+        ],
+      },
+      {
+        type: 'log',
+        level: 'warn',
+        diagnostics: [
+          {
+            origin: '@parcel/bundler-default',
+            message:
+              'The value of "200" set for minBundleSize will not be used as shared bundles have been disabled',
+          },
+        ],
+      },
+      {
+        type: 'log',
+        level: 'warn',
+        diagnostics: [
+          {
+            origin: '@parcel/bundler-default',
+            message:
+              'The value of "100" set for maxParallelRequests will not be used as shared bundles have been disabled',
+          },
+        ],
+      },
+    ]);
+    assertBundles(b, [
+      {
+        name: 'index.js',
+        assets: [
+          'index.js',
+          'bundle-url.js',
+          'cacheLoader.js',
+          'esmodule-helpers.js',
+          'js-loader.js',
+          'bundle-manifest.js',
+        ],
+      },
+      {
+        assets: ['foo.js', 'a.js', 'b.js'],
+      },
+      {
+        assets: ['bar.js', 'a.js', 'b.js'],
+      },
+    ]);
+  });
+
+  it('should create shared bundles and should not throw a warning when disableSharedBundles is set to false', async function () {
+    let messages = [];
+    let loggerDisposable = Logger.onLog(message => {
+      messages.push(message);
+    });
+    let b = await bundle(
+      path.join(__dirname, 'integration/disable-shared-bundles-false/index.js'),
+      {
+        mode: 'production',
+        defaultTargetOptions: {
+          shouldScopeHoist: false,
+        },
+      },
+    );
+    loggerDisposable.dispose();
+
+    assert.deepEqual(messages, []);
+    assertBundles(b, [
+      {
+        name: 'index.js',
+        assets: [
+          'index.js',
+          'bundle-url.js',
+          'cacheLoader.js',
+          'esmodule-helpers.js',
+          'js-loader.js',
+          'bundle-manifest.js',
+        ],
+      },
+      {
+        assets: ['foo.js'],
+      },
+      {
+        assets: ['bar.js'],
+      },
+      {
+        assets: ['a.js', 'b.js'],
+      },
+    ]);
+  });
+
   it('should not count inline assests towards parallel request limit', async function () {
     // Shared bundle should not be removed in this case
     let b = await bundle(

diff --git a/packages/core/integration-tests/test/integration/disable-shared-bundle-single-source/a.js b/packages/core/integration-tests/test/integration/disable-shared-bundle-single-source/a.js
@@ -0,0 +1,3 @@
+import foo from './foo';
+
+export default 5;
diff --git a/packages/core/integration-tests/test/integration/disable-shared-bundle-single-source/b.js b/packages/core/integration-tests/test/integration/disable-shared-bundle-single-source/b.js
@@ -0,0 +1 @@
+export default 4;
diff --git a/packages/core/integration-tests/test/integration/disable-shared-bundle-single-source/bar.js b/packages/core/integration-tests/test/integration/disable-shared-bundle-single-source/bar.js
@@ -0,0 +1,4 @@
+import a from './a';
+import b from './b';
+
+export default 3;
diff --git a/packages/core/integration-tests/test/integration/disable-shared-bundle-single-source/foo.js b/packages/core/integration-tests/test/integration/disable-shared-bundle-single-source/foo.js
@@ -0,0 +1,4 @@
+import a from './a';
+import b from './b';
+
+export default 2;
diff --git a/...ages/core/integration-tests/test/integration/disable-shared-bundle-single-source/index.js b/...ages/core/integration-tests/test/integration/disable-shared-bundle-single-source/index.js
@@ -0,0 +1,4 @@
+import('./foo');
+import('./bar');
+
+export default 1;
diff --git a/.../core/integration-tests/test/integration/disable-shared-bundle-single-source/package.json b/.../core/integration-tests/test/integration/disable-shared-bundle-single-source/package.json
@@ -0,0 +1,8 @@
+{
+  "@parcel/bundler-default": {
+    "minBundles": 0,
+    "minBundleSize": 200,
+    "maxParallelRequests": 100,
+    "disableSharedBundles": true
+  }
+}
diff --git a/...ges/core/integration-tests/test/integration/disable-shared-bundle-single-source/yarn.lock b/...ges/core/integration-tests/test/integration/disable-shared-bundle-single-source/yarn.lock
diff --git a/packages/core/integration-tests/test/integration/disable-shared-bundles-false/a.js b/packages/core/integration-tests/test/integration/disable-shared-bundles-false/a.js
@@ -0,0 +1 @@
+export default 5;
diff --git a/packages/core/integration-tests/test/integration/disable-shared-bundles-false/b.js b/packages/core/integration-tests/test/integration/disable-shared-bundles-false/b.js
@@ -0,0 +1 @@
+export default 4;
diff --git a/packages/core/integration-tests/test/integration/disable-shared-bundles-false/bar.js b/packages/core/integration-tests/test/integration/disable-shared-bundles-false/bar.js
@@ -0,0 +1,4 @@
+import a from './a';
+import b from './b';
+
+export default 3;
diff --git a/packages/core/integration-tests/test/integration/disable-shared-bundles-false/foo.js b/packages/core/integration-tests/test/integration/disable-shared-bundles-false/foo.js
@@ -0,0 +1,4 @@
+import a from './a';
+import b from './b';
+
+export default 2;
diff --git a/packages/core/integration-tests/test/integration/disable-shared-bundles-false/index.js b/packages/core/integration-tests/test/integration/disable-shared-bundles-false/index.js
@@ -0,0 +1,4 @@
+import('./foo');
+import('./bar');
+
+export default 1;
diff --git a/packages/core/integration-tests/test/integration/disable-shared-bundles-false/package.json b/packages/core/integration-tests/test/integration/disable-shared-bundles-false/package.json
@@ -0,0 +1,8 @@
+{
+  "@parcel/bundler-default": {
+    "minBundles": 0,
+    "minBundleSize": 200,
+    "maxParallelRequests": 100,
+    "disableSharedBundles": false
+  }
+}
diff --git a/packages/core/integration-tests/test/integration/disable-shared-bundles-false/yarn.lock b/packages/core/integration-tests/test/integration/disable-shared-bundles-false/yarn.lock
diff --git a/...s/core/integration-tests/test/integration/disable-shared-bundles-true-min-bundleSize/a.js b/...s/core/integration-tests/test/integration/disable-shared-bundles-true-min-bundleSize/a.js
@@ -0,0 +1 @@
+export default 5;
diff --git a/...s/core/integration-tests/test/integration/disable-shared-bundles-true-min-bundleSize/b.js b/...s/core/integration-tests/test/integration/disable-shared-bundles-true-min-bundleSize/b.js
@@ -0,0 +1 @@
+export default 4;
diff --git a/...core/integration-tests/test/integration/disable-shared-bundles-true-min-bundleSize/bar.js b/...core/integration-tests/test/integration/disable-shared-bundles-true-min-bundleSize/bar.js
@@ -0,0 +1,4 @@
+import a from './a';
+import b from './b';
+
+export default 3;