@atlaspack/packager-js 2.22.0 → 2.22.2

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @atlaspack/packager-js
 
+## 2.22.2
+
+### Patch Changes
+
+- [#768](https://github.com/atlassian-labs/atlaspack/pull/768) [`58b9fb0`](https://github.com/atlassian-labs/atlaspack/commit/58b9fb037680a36a0b4af7890f2a03532095b88f) Thanks [@benjervis](https://github.com/benjervis)! - Fixes a small error in the scope hoisting V2 fixes that caused assets to be wrapped unnecessarily
+
+## 2.22.1
+
+### Patch Changes
+
+- [#763](https://github.com/atlassian-labs/atlaspack/pull/763) [`830261d`](https://github.com/atlassian-labs/atlaspack/commit/830261dcf4a40293090b61cab52fd75d5683c73f) Thanks [@benjervis](https://github.com/benjervis)! - Fixes scope hoisting by iterating from the main entry asset of a bundle when packaging. Behind the feature flag `applyScopeHoistingImprovementsV2`.
+
+- Updated dependencies [[`830261d`](https://github.com/atlassian-labs/atlaspack/commit/830261dcf4a40293090b61cab52fd75d5683c73f), [`53dd47b`](https://github.com/atlassian-labs/atlaspack/commit/53dd47bd6d23cd47f87297347f03a609ab38a03d)]:
+  - @atlaspack/feature-flags@2.24.1
+  - @atlaspack/rust@3.7.0
+  - @atlaspack/utils@2.19.1
+  - @atlaspack/plugin@2.14.29
+  - @atlaspack/types@2.15.19
+
 ## 2.22.0
 
 ### Minor Changes

package/lib/ScopeHoistingPackager.js

@@ -105,9 +105,11 @@ class ScopeHoistingPackager {
   seenAssets = new Set();
   wrappedAssets = new Set();
   hoistedRequires = new Map();
+  seenHoistedRequires = new Set();
   needsPrelude = false;
   usedHelpers = new Set();
   externalAssets = new Set();
+  useBothScopeHoistingImprovements = (0, _featureFlags().getFeatureFlag)('applyScopeHoistingImprovementV2') || (0, _featureFlags().getFeatureFlag)('applyScopeHoistingImprovement');
   constructor(options, bundleGraph, bundle, parcelRequireName, useAsyncBundleRuntime, logger) {
     this.options = options;
     this.bundleGraph = bundleGraph;
@@ -145,7 +147,9 @@ class ScopeHoistingPackager {
     // @ts-expect-error TS7034
     let sourceMap = null;
     let processAsset = asset => {
+      this.seenHoistedRequires.clear();
       let [content, map, lines] = this.visitAsset(asset);
+
       // @ts-expect-error TS7005
       if (sourceMap && map) {
         sourceMap.addSourceMap(map, lineCount);
@@ -155,7 +159,7 @@ class ScopeHoistingPackager {
       res += content + '\n';
       lineCount += lines + 1;
     };
-    if ((0, _featureFlags().getFeatureFlag)('inlineConstOptimisationFix') || (0, _featureFlags().getFeatureFlag)('applyScopeHoistingImprovement')) {
+    if ((0, _featureFlags().getFeatureFlag)('inlineConstOptimisationFix') || this.useBothScopeHoistingImprovements) {
       // Write out all constant modules used by this bundle
       for (let asset of constantAssets) {
         if (!this.seenAssets.has(asset.id)) {
@@ -190,7 +194,7 @@ class ScopeHoistingPackager {
     let entries = this.bundle.getEntryAssets();
     let mainEntry = this.bundle.getMainEntry();
     if (this.isAsyncBundle) {
-      if ((0, _featureFlags().getFeatureFlag)('applyScopeHoistingImprovement') || (0, _featureFlags().getFeatureFlag)('supportWebpackChunkName')) {
+      if (this.useBothScopeHoistingImprovements || (0, _featureFlags().getFeatureFlag)('supportWebpackChunkName')) {
         // Generally speaking, async bundles should not be executed on load, as
         // they're just collections of assets that other assets require.
         // However, there are some special cases where a runtime asset needs to be
@@ -317,25 +321,38 @@ class ScopeHoistingPackager {
         if (!asset.meta.isConstantModule || this.bundleGraph.getIncomingDependencies(asset).some(dep => dep.priority === 'lazy')) {
           this.wrappedAssets.add(asset.id);
           wrapped.push(asset);
-        } else if (((0, _featureFlags().getFeatureFlag)('inlineConstOptimisationFix') || (0, _featureFlags().getFeatureFlag)('applyScopeHoistingImprovement')) && asset.meta.isConstantModule) {
+        } else if (((0, _featureFlags().getFeatureFlag)('inlineConstOptimisationFix') || this.useBothScopeHoistingImprovements) && asset.meta.isConstantModule) {
           constant.push(asset);
         }
       }
     });
-    if ((0, _featureFlags().getFeatureFlag)('applyScopeHoistingImprovement')) {
-      // Make all entry assets wrapped, to avoid any top level hoisting
-      for (let entryAsset of this.bundle.getEntryAssets()) {
-        if (!this.wrappedAssets.has(entryAsset.id)) {
-          this.wrappedAssets.add(entryAsset.id);
-          wrapped.push(entryAsset);
-        }
-      }
-
+    if (this.useBothScopeHoistingImprovements) {
       // Tracks which assets have been assigned to a wrap group
       let assignedAssets = new Set();
-      for (let wrappedAsset of wrapped) {
+
+      // In V2 scope hoisting, we iterate from the main entry, rather than
+      // wrapping the entry assets
+      if (!(0, _featureFlags().getFeatureFlag)('applyScopeHoistingImprovementV2')) {
+        // Make all entry assets wrapped, to avoid any top level hoisting
+        for (let entryAsset of this.bundle.getEntryAssets()) {
+          if (!this.wrappedAssets.has(entryAsset.id)) {
+            this.wrappedAssets.add(entryAsset.id);
+            wrapped.push(entryAsset);
+          }
+        }
+      }
+      let moduleGroupParents = [...wrapped];
+      if ((0, _featureFlags().getFeatureFlag)('applyScopeHoistingImprovementV2')) {
+        // The main entry needs to be check to find assets that would have gone in
+        // the top level scope
+        let mainEntry = this.bundle.getMainEntry();
+        if (mainEntry && !this.wrappedAssets.has(mainEntry.id)) {
+          moduleGroupParents.unshift(mainEntry);
+        }
+      }
+      for (let moduleGroupParentAsset of moduleGroupParents) {
         this.bundle.traverseAssets((asset, _, actions) => {
-          if (asset === wrappedAsset) {
+          if (asset === moduleGroupParentAsset) {
             return;
           }
           if (this.wrappedAssets.has(asset.id)) {
@@ -345,11 +362,15 @@ class ScopeHoistingPackager {
           if (!asset.meta.isConstantModule && (assignedAssets.has(asset) || this.isReExported(asset))) {
             wrapped.push(asset);
             this.wrappedAssets.add(asset.id);
+
+            // This also needs to be added to the traversal so that we iterate
+            // it during this check.
+            moduleGroupParents.push(asset);
             actions.skipChildren();
             return;
           }
           assignedAssets.add(asset);
-        }, wrappedAsset);
+        }, moduleGroupParentAsset);
       }
     } else {
       for (let wrappedAssetRoot of [...wrapped]) {
@@ -568,14 +589,18 @@ class ScopeHoistingPackager {
               // after the dependency is declared. This handles the case where the resulting asset
               // is wrapped, but the dependency in this asset is not marked as wrapped. This means
               // that it was imported/required at the top-level, so its side effects should run immediately.
-              let [res, lines] = this.getHoistedParcelRequires(asset, dep, resolved);
+              let res = '';
+              let lines = 0;
               let map;
+              if (!(0, _featureFlags().getFeatureFlag)('applyScopeHoistingImprovementV2')) {
+                [res, lines] = this.getHoistedParcelRequires(asset, dep, resolved);
+              }
               if (this.bundle.hasAsset(resolved) && !this.seenAssets.has(resolved.id)) {
                 // If this asset is wrapped, we need to hoist the code for the dependency
                 // outside our parcelRequire.register wrapper. This is safe because all
                 // assets referenced by this asset will also be wrapped. Otherwise, inline the
                 // asset content where the import statement was.
-                if ((0, _featureFlags().getFeatureFlag)('applyScopeHoistingImprovement')) {
+                if (this.useBothScopeHoistingImprovements) {
                   if (!resolved.meta.isConstantModule && !this.wrappedAssets.has(resolved.id)) {
                     let [depCode, depMap, depLines] = this.visitAsset(resolved);
                     if (_utils().debugTools['asset-file-names-in-output']) {
@@ -604,6 +629,13 @@ class ScopeHoistingPackager {
                   }
                 }
               }
+              if ((0, _featureFlags().getFeatureFlag)('applyScopeHoistingImprovementV2')) {
+                let [requiresCode, requiresLines] = this.getHoistedParcelRequires(asset, dep, resolved);
+                if (requiresCode) {
+                  res = requiresCode + '\n' + res;
+                  lines += requiresLines + 1;
+                }
+              }
 
               // Push this asset's source mappings down by the number of lines in the dependency
               // plus the number of hoisted parcelRequires. Then insert the source map for the dependency.
@@ -1020,8 +1052,17 @@ ${code}
     }
     if (hoisted) {
       this.needsPrelude = true;
-      res += '\n' + [...hoisted.values()].join('\n');
-      lineCount += hoisted.size;
+      if ((0, _featureFlags().getFeatureFlag)('applyScopeHoistingImprovementV2')) {
+        let hoistedValues = [...hoisted.values()].filter(val => !this.seenHoistedRequires.has(val));
+        for (let val of hoistedValues) {
+          this.seenHoistedRequires.add(val);
+        }
+        res += '\n' + hoistedValues.join('\n');
+        lineCount += hoisted.size;
+      } else {
+        res += '\n' + [...hoisted.values()].join('\n');
+        lineCount += hoisted.size;
+      }
     }
     return [res, lineCount];
   }

package/lib/types/ScopeHoistingPackager.d.ts

@@ -28,10 +28,12 @@ export declare class ScopeHoistingPackager {
     seenAssets: Set<string>;
     wrappedAssets: Set<string>;
     hoistedRequires: Map<string, Map<string, string>>;
+    seenHoistedRequires: Set<string>;
     needsPrelude: boolean;
     usedHelpers: Set<string>;
     externalAssets: Set<Asset>;
     logger: PluginLogger;
+    useBothScopeHoistingImprovements: boolean;
     constructor(options: PluginOptions, bundleGraph: BundleGraph<NamedBundle>, bundle: NamedBundle, parcelRequireName: string, useAsyncBundleRuntime: boolean, logger: PluginLogger);
     package(): Promise<{
         contents: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaspack/packager-js",
-  "version": "2.22.0",
+  "version": "2.22.2",
   "license": "(MIT OR Apache-2.0)",
   "publishConfig": {
     "access": "public"
@@ -17,12 +17,12 @@
   },
   "dependencies": {
     "@atlaspack/diagnostic": "2.14.3",
-    "@atlaspack/feature-flags": "2.24.0",
-    "@atlaspack/plugin": "2.14.28",
-    "@atlaspack/rust": "3.6.2",
+    "@atlaspack/feature-flags": "2.24.1",
+    "@atlaspack/plugin": "2.14.29",
+    "@atlaspack/rust": "3.7.0",
     "@parcel/source-map": "^2.1.1",
-    "@atlaspack/types": "2.15.18",
-    "@atlaspack/utils": "2.19.0",
+    "@atlaspack/types": "2.15.19",
+    "@atlaspack/utils": "2.19.1",
     "globals": "^13.2.0",
     "nullthrows": "^1.1.1",
     "outdent": "^0.8.0"

package/src/ScopeHoistingPackager.ts

@@ -112,10 +112,14 @@ export class ScopeHoistingPackager {
   seenAssets: Set<string> = new Set();
   wrappedAssets: Set<string> = new Set();
   hoistedRequires: Map<string, Map<string, string>> = new Map();
+  seenHoistedRequires: Set<string> = new Set();
   needsPrelude: boolean = false;
   usedHelpers: Set<string> = new Set();
   externalAssets: Set<Asset> = new Set();
   logger: PluginLogger;
+  useBothScopeHoistingImprovements: boolean =
+    getFeatureFlag('applyScopeHoistingImprovementV2') ||
+    getFeatureFlag('applyScopeHoistingImprovement');
 
   constructor(
     options: PluginOptions,
@@ -173,7 +177,9 @@ export class ScopeHoistingPackager {
     // @ts-expect-error TS7034
     let sourceMap = null;
     let processAsset = (asset: Asset) => {
+      this.seenHoistedRequires.clear();
       let [content, map, lines] = this.visitAsset(asset);
+
       // @ts-expect-error TS7005
       if (sourceMap && map) {
         sourceMap.addSourceMap(map, lineCount);
@@ -187,7 +193,7 @@ export class ScopeHoistingPackager {
 
     if (
       getFeatureFlag('inlineConstOptimisationFix') ||
-      getFeatureFlag('applyScopeHoistingImprovement')
+      this.useBothScopeHoistingImprovements
     ) {
       // Write out all constant modules used by this bundle
       for (let asset of constantAssets) {
@@ -227,7 +233,7 @@ export class ScopeHoistingPackager {
     let mainEntry = this.bundle.getMainEntry();
     if (this.isAsyncBundle) {
       if (
-        getFeatureFlag('applyScopeHoistingImprovement') ||
+        this.useBothScopeHoistingImprovements ||
         getFeatureFlag('supportWebpackChunkName')
       ) {
         // Generally speaking, async bundles should not be executed on load, as
@@ -433,7 +439,7 @@ export class ScopeHoistingPackager {
           wrapped.push(asset);
         } else if (
           (getFeatureFlag('inlineConstOptimisationFix') ||
-            getFeatureFlag('applyScopeHoistingImprovement')) &&
+            this.useBothScopeHoistingImprovements) &&
           asset.meta.isConstantModule
         ) {
           constant.push(asset);
@@ -441,21 +447,36 @@ export class ScopeHoistingPackager {
       }
     });
 
-    if (getFeatureFlag('applyScopeHoistingImprovement')) {
-      // Make all entry assets wrapped, to avoid any top level hoisting
-      for (let entryAsset of this.bundle.getEntryAssets()) {
-        if (!this.wrappedAssets.has(entryAsset.id)) {
-          this.wrappedAssets.add(entryAsset.id);
-          wrapped.push(entryAsset);
+    if (this.useBothScopeHoistingImprovements) {
+      // Tracks which assets have been assigned to a wrap group
+      let assignedAssets = new Set<Asset>();
+
+      // In V2 scope hoisting, we iterate from the main entry, rather than
+      // wrapping the entry assets
+      if (!getFeatureFlag('applyScopeHoistingImprovementV2')) {
+        // Make all entry assets wrapped, to avoid any top level hoisting
+        for (let entryAsset of this.bundle.getEntryAssets()) {
+          if (!this.wrappedAssets.has(entryAsset.id)) {
+            this.wrappedAssets.add(entryAsset.id);
+            wrapped.push(entryAsset);
+          }
         }
       }
 
-      // Tracks which assets have been assigned to a wrap group
-      let assignedAssets = new Set<Asset>();
+      let moduleGroupParents = [...wrapped];
 
-      for (let wrappedAsset of wrapped) {
+      if (getFeatureFlag('applyScopeHoistingImprovementV2')) {
+        // The main entry needs to be check to find assets that would have gone in
+        // the top level scope
+        let mainEntry = this.bundle.getMainEntry();
+        if (mainEntry && !this.wrappedAssets.has(mainEntry.id)) {
+          moduleGroupParents.unshift(mainEntry);
+        }
+      }
+
+      for (let moduleGroupParentAsset of moduleGroupParents) {
         this.bundle.traverseAssets((asset, _, actions) => {
-          if (asset === wrappedAsset) {
+          if (asset === moduleGroupParentAsset) {
             return;
           }
 
@@ -471,12 +492,16 @@ export class ScopeHoistingPackager {
             wrapped.push(asset);
             this.wrappedAssets.add(asset.id);
 
+            // This also needs to be added to the traversal so that we iterate
+            // it during this check.
+            moduleGroupParents.push(asset);
+
             actions.skipChildren();
             return;
           }
 
           assignedAssets.add(asset);
-        }, wrappedAsset);
+        }, moduleGroupParentAsset);
       }
     } else {
       for (let wrappedAssetRoot of [...wrapped]) {
@@ -752,12 +777,18 @@ export class ScopeHoistingPackager {
                 // after the dependency is declared. This handles the case where the resulting asset
                 // is wrapped, but the dependency in this asset is not marked as wrapped. This means
                 // that it was imported/required at the top-level, so its side effects should run immediately.
-                let [res, lines] = this.getHoistedParcelRequires(
-                  asset,
-                  dep,
-                  resolved,
-                );
+                let res = '';
+                let lines = 0;
                 let map;
+
+                if (!getFeatureFlag('applyScopeHoistingImprovementV2')) {
+                  [res, lines] = this.getHoistedParcelRequires(
+                    asset,
+                    dep,
+                    resolved,
+                  );
+                }
+
                 if (
                   this.bundle.hasAsset(resolved) &&
                   !this.seenAssets.has(resolved.id)
@@ -766,7 +797,7 @@ export class ScopeHoistingPackager {
                   // outside our parcelRequire.register wrapper. This is safe because all
                   // assets referenced by this asset will also be wrapped. Otherwise, inline the
                   // asset content where the import statement was.
-                  if (getFeatureFlag('applyScopeHoistingImprovement')) {
+                  if (this.useBothScopeHoistingImprovements) {
                     if (
                       !resolved.meta.isConstantModule &&
                       !this.wrappedAssets.has(resolved.id)
@@ -801,6 +832,16 @@ export class ScopeHoistingPackager {
                   }
                 }
 
+                if (getFeatureFlag('applyScopeHoistingImprovementV2')) {
+                  let [requiresCode, requiresLines] =
+                    this.getHoistedParcelRequires(asset, dep, resolved);
+
+                  if (requiresCode) {
+                    res = requiresCode + '\n' + res;
+                    lines += requiresLines + 1;
+                  }
+                }
+
                 // Push this asset's source mappings down by the number of lines in the dependency
                 // plus the number of hoisted parcelRequires. Then insert the source map for the dependency.
                 if (sourceMap) {
@@ -1369,8 +1410,22 @@ ${code}
 
     if (hoisted) {
       this.needsPrelude = true;
-      res += '\n' + [...hoisted.values()].join('\n');
-      lineCount += hoisted.size;
+
+      if (getFeatureFlag('applyScopeHoistingImprovementV2')) {
+        let hoistedValues = [...hoisted.values()].filter(
+          (val) => !this.seenHoistedRequires.has(val),
+        );
+
+        for (let val of hoistedValues) {
+          this.seenHoistedRequires.add(val);
+        }
+
+        res += '\n' + hoistedValues.join('\n');
+        lineCount += hoisted.size;
+      } else {
+        res += '\n' + [...hoisted.values()].join('\n');
+        lineCount += hoisted.size;
+      }
     }
 
     return [res, lineCount];