achan3/P2X-1041 new disableSharedBundles config option

packages/bundlers/default/src/DefaultBundler.js

@@ -19,6 +19,7 @@ import {ContentGraph, Graph} from '@parcel/graph';
 import invariant from 'assert';
 import {ALL_EDGE_TYPES} from '@parcel/graph';
 import {Bundler} from '@parcel/plugin';
+import logger from '@parcel/logger';
 import {setEqual, validateSchema, DefaultMap, BitSet} from '@parcel/utils';
 import nullthrows from 'nullthrows';
 import {encodeJSONKeyComponent} from '@parcel/diagnostic';
@@ -28,12 +29,14 @@ type BundlerConfig = {|
   minBundles?: number,
   minBundleSize?: number,
   maxParallelRequests?: number,
+  disableSharedBundles?: boolean,
 |};
 
 type ResolvedBundlerConfig = {|
   minBundles: number,
   minBundleSize: number,
   maxParallelRequests: number,
+  disableSharedBundles: boolean,
 |};
 
 // Default options by http version.
@@ -42,11 +45,13 @@ const HTTP_OPTIONS = {
     minBundles: 1,
     minBundleSize: 30000,
     maxParallelRequests: 6,
+    disableSharedBundles: false,
   },
   '2': {
     minBundles: 1,
     minBundleSize: 20000,
     maxParallelRequests: 25,
+    disableSharedBundles: false,
   },
 };
 
@@ -958,8 +963,10 @@ function createIdealGraph(
       entryBundle.size += asset.stats.size;
     }
 
-    // Create shared bundles for splittable bundles.
-    if (reachable.length > config.minBundles) {
+    if (
+      config.disableSharedBundles === false &&
+      reachable.length > config.minBundles
+    ) {
       let sourceBundles = reachable.map(a => nullthrows(bundleRoots.get(a))[0]);
       let key = reachable.map(a => a.id).join(',');
       let bundleId = bundles.get(key);
@@ -1010,7 +1017,10 @@ function createIdealGraph(
         value: bundle,
         type: 'bundle',
       });
-    } else if (reachable.length <= config.minBundles) {
+    } else if (
+      config.disableSharedBundles === true ||
+      reachable.length <= config.minBundles
+    ) {
       for (let root of reachable) {
         let bundle = nullthrows(
           bundleGraph.getNode(nullthrows(bundleRoots.get(root))[0]),
@@ -1277,6 +1287,9 @@ const CONFIG_SCHEMA: SchemaEntity = {
     maxParallelRequests: {
       type: 'number',
     },
+    disableSharedBundles: {
+      type: 'boolean',
+    },
   },
   additionalProperties: false,
 };
@@ -1357,6 +1370,17 @@ async function loadBundlerConfig(
 
   invariant(conf?.contents != null);
 
+  // minBundles value will be ignored if shared bundles are disabled
+  if (
+    conf.contents.minBundleSize != null &&
+    conf.contents.disableSharedBundles === true
+  ) {
+    logger.warn({
+      origin: '@parcel/bundler-default',
+      message: `The value of "${conf.contents.minBundleSize}" set for minBundleSize will not be used as shared bundles have been disabled`,
+    });
+  }
+
   validateSchema.diagnostic(
     CONFIG_SCHEMA,
     {
@@ -1377,6 +1401,8 @@ async function loadBundlerConfig(
     minBundleSize: conf.contents.minBundleSize ?? defaults.minBundleSize,
     maxParallelRequests:
       conf.contents.maxParallelRequests ?? defaults.maxParallelRequests,
+    disableSharedBundles:
+      conf.contents.disableSharedBundles ?? defaults.disableSharedBundles,
   };
 }
 

packages/core/integration-tests/test/bundler.js

@@ -1,8 +1,256 @@
 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 throw warnings when disabled shared bundles and a min bundle size value is given', async function () {
+    let messages = [];
+    let loggerDisposable = Logger.onLog(message => {
+      messages.push(message);
+    });
+
+    await bundle(
+      path.join(
+        __dirname,
+        'integration/disable-shared-bundles-with-min-bundle-size/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 "2000" set for minBundleSize will not be used as shared bundles have been disabled',
+          },
+        ],
+      },
+    ]);
+  });
+
+  it('should not throw warnings when shared bundles are enabled and a min bundle size value is given', async function () {
+    let messages = [];
+    let loggerDisposable = Logger.onLog(message => {
+      messages.push(message);
+    });
+
+    await bundle(
+      path.join(
+        __dirname,
+        'integration/disable-shared-bundles-false-with-min-bundle-size/index.js',
+      ),
+      {
+        mode: 'production',
+        defaultTargetOptions: {
+          shouldScopeHoist: false,
+        },
+      },
+    );
+    loggerDisposable.dispose();
+
+    assert.deepEqual(messages, []);
+  });
+
+  it('should not throw warnings when disableSharedBundles is not set and a min bundle size value is given', async function () {
+    let messages = [];
+    let loggerDisposable = Logger.onLog(message => {
+      messages.push(message);
+    });
+
+    await bundle(
+      path.join(
+        __dirname,
+        'integration/no-disable-shared-bundles-with-min-bundle-size/index.js',
+      ),
+      {
+        mode: 'production',
+        defaultTargetOptions: {
+          shouldScopeHoist: false,
+        },
+      },
+    );
+    loggerDisposable.dispose();
+
+    assert.deepEqual(messages, []);
+  });
+
+  it('should not throw warnings when shared bundles are disabled but min bundle size is not set', async function () {
+    let messages = [];
+    let loggerDisposable = Logger.onLog(message => {
+      messages.push(message);
+    });
+
+    await bundle(
+      path.join(
+        __dirname,
+        'integration/disable-shared-bundles-no-min-bundle-size/index.js',
+      ),
+      {
+        mode: 'production',
+        defaultTargetOptions: {
+          shouldScopeHoist: false,
+        },
+      },
+    );
+    loggerDisposable.dispose();
+
+    assert.deepEqual(messages, []);
+  });
+
+  it('should create shared bundles when disableSharedBundles is not set', async function () {
+    let b = await bundle(
+      path.join(
+        __dirname,
+        'integration/disable-shared-bundles-default/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'],
+      },
+      {
+        assets: ['bar.js'],
+      },
+      {
+        assets: ['a.js', 'b.js'],
+      },
+    ]);
+  });
+
+  it('should create shared bundles when disableSharedBundles is not set', async function () {
+    let b = await bundle(
+      path.join(
+        __dirname,
+        'integration/disable-shared-bundles-default/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'],
+      },
+      {
+        assets: ['bar.js'],
+      },
+      {
+        assets: ['a.js', 'b.js'],
+      },
+    ]);
+  });
+
+  it('should not create shared bundles when disableSharedBundles is set to true', async function () {
+    let b = await bundle(
+      path.join(__dirname, 'integration/disable-shared-bundles-true/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: ['bar.js', 'a.js', 'b.js'],
+      },
+    ]);
+  });
+
+  it('should create shared bundles when disableSharedBundles is set to false', async function () {
+    let b = await bundle(
+      path.join(__dirname, 'integration/disable-shared-bundles-false/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'],
+      },
+      {
+        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(

packages/core/integration-tests/test/integration/disable-shared-bundles-default/a.js

@@ -0,0 +1 @@
+export default 5;

packages/core/integration-tests/test/integration/disable-shared-bundles-default/b.js

@@ -0,0 +1 @@
+export default 4;

packages/core/integration-tests/test/integration/disable-shared-bundles-default/bar.js

@@ -0,0 +1,4 @@
+import a from './a';
+import b from './b';
+
+export default 3;

packages/core/integration-tests/test/integration/disable-shared-bundles-default/foo.js

@@ -0,0 +1,4 @@
+import a from './a';
+import b from './b';
+
+export default 2;

packages/core/integration-tests/test/integration/disable-shared-bundles-default/index.js

@@ -0,0 +1,4 @@
+import('./foo');
+import('./bar');
+
+export default 1;

packages/core/integration-tests/test/integration/disable-shared-bundles-default/package.json

@@ -0,0 +1,7 @@
+{
+  "@parcel/bundler-default": {
+    "minBundles": 0,
+    "minBundleSize": 200,
+    "maxParallelRequests": 100
+  }
+}

packages/core/integration-tests/test/integration/disable-shared-bundles-false-with-min-bundle-size/a.js

@@ -0,0 +1 @@
+export default 5;

packages/core/integration-tests/test/integration/disable-shared-bundles-false-with-min-bundle-size/b.js

@@ -0,0 +1 @@
+export default 4;

packages/core/integration-tests/test/integration/disable-shared-bundles-false-with-min-bundle-size/bar.js

@@ -0,0 +1,4 @@
+import a from './a';
+import b from './b';
+
+export default 3;