Incremental Symbol Propagation (#8723)

parcel-bundler · Mar 26, 2023 · 71f74d6 · 71f74d6
1 parent 9a2bdd9
commit 71f74d6
Show file tree

Hide file tree

Showing 34 changed files with 1,848 additions and 632 deletions.
diff --git a/packages/core/core/src/AssetGraph.js b/packages/core/core/src/AssetGraph.js
@@ -38,14 +38,12 @@ type InitOpts = {|
 
 type AssetGraphOpts = {|
   ...ContentGraphOpts<AssetGraphNode>,
-  symbolPropagationRan: boolean,
   hash?: ?string,
 |};
 
 type SerializedAssetGraph = {|
   ...SerializedContentGraph<AssetGraphNode>,
   hash?: ?string,
-  symbolPropagationRan: boolean,
 |};
 
 export function nodeFromDep(dep: Dependency): DependencyNode {
@@ -113,15 +111,13 @@ export default class AssetGraph extends ContentGraph<AssetGraphNode> {
   onNodeRemoved: ?(nodeId: NodeId) => mixed;
   hash: ?string;
   envCache: Map<string, Environment>;
-  symbolPropagationRan: boolean;
   safeToIncrementallyBundle: boolean = true;
 
   constructor(opts: ?AssetGraphOpts) {
     if (opts) {
-      let {hash, symbolPropagationRan, ...rest} = opts;
+      let {hash, ...rest} = opts;
       super(rest);
       this.hash = hash;
-      this.symbolPropagationRan = symbolPropagationRan;
     } else {
       super();
       this.setRootNodeId(
@@ -133,7 +129,6 @@ export default class AssetGraph extends ContentGraph<AssetGraphNode> {
       );
     }
     this.envCache = new Map();
-    this.symbolPropagationRan = false;
   }
 
   // $FlowFixMe[prop-missing]
@@ -146,7 +141,6 @@ export default class AssetGraph extends ContentGraph<AssetGraphNode> {
     return {
       ...super.serialize(),
       hash: this.hash,
-      symbolPropagationRan: this.symbolPropagationRan,
     };
   }
 
@@ -199,19 +193,6 @@ export default class AssetGraph extends ContentGraph<AssetGraphNode> {
   removeNode(nodeId: NodeId): void {
     this.hash = null;
     this.onNodeRemoved && this.onNodeRemoved(nodeId);
-    // This needs to mark all connected nodes that doesn't become orphaned
-    // due to replaceNodesConnectedTo to make sure that the symbols of
-    // nodes from which at least one parent was removed are updated.
-    let node = nullthrows(this.getNode(nodeId));
-    if (this.isOrphanedNode(nodeId) && node.type === 'dependency') {
-      let children = this.getNodeIdsConnectedFrom(nodeId).map(id =>
-        nullthrows(this.getNode(id)),
-      );
-      for (let n of children) {
-        invariant(n.type === 'asset_group' || n.type === 'asset');
-        n.usedSymbolsDownDirty = true;
-      }
-    }
     return super.removeNode(nodeId);
   }
 
@@ -258,6 +239,7 @@ export default class AssetGraph extends ContentGraph<AssetGraphNode> {
       if (node.value.env.isLibrary) {
         // in library mode, all of the entry's symbols are "used"
         node.usedSymbolsDown.add('*');
+        node.usedSymbolsUp.set('*', undefined);
       }
       return node;
     });
@@ -526,6 +508,7 @@ export default class AssetGraph extends ContentGraph<AssetGraphNode> {
       depNodeIds.push(this.addNode(depNode));
     }
 
+    assetNode.usedSymbolsUpDirty = true;
     assetNode.usedSymbolsDownDirty = true;
     this.replaceNodeIdsConnectedTo(
       this.getNodeIdByContentKey(assetNode.id),

diff --git a/packages/core/core/src/BundleGraph.js b/packages/core/core/src/BundleGraph.js
@@ -29,7 +29,6 @@ import type {
 } from './types';
 import type AssetGraph from './AssetGraph';
 import type {ProjectPath} from './projectPath';
-import {nodeFromAsset} from './AssetGraph';
 
 import assert from 'assert';
 import invariant from 'assert';
@@ -88,7 +87,6 @@ type BundleGraphOpts = {|
   bundleContentHashes: Map<string, string>,
   assetPublicIds: Set<string>,
   publicIdByAssetId: Map<string, string>,
-  symbolPropagationRan: boolean,
 |};
 
 type SerializedBundleGraph = {|
@@ -97,7 +95,6 @@ type SerializedBundleGraph = {|
   bundleContentHashes: Map<string, string>,
   assetPublicIds: Set<string>,
   publicIdByAssetId: Map<string, string>,
-  symbolPropagationRan: boolean,
 |};
 
 function makeReadOnlySet<T>(set: Set<T>): $ReadOnlySet<T> {
@@ -137,27 +134,23 @@ export default class BundleGraph {
   _targetEntryRoots: Map<ProjectPath, FilePath> = new Map();
   /** The internal core Graph structure */
   _graph: ContentGraph<BundleGraphNode, BundleGraphEdgeType>;
-  _symbolPropagationRan /*: boolean*/;
   _bundlePublicIds /*: Set<string> */ = new Set<string>();
 
   constructor({
     graph,
     publicIdByAssetId,
     assetPublicIds,
     bundleContentHashes,
-    symbolPropagationRan,
   }: {|
     graph: ContentGraph<BundleGraphNode, BundleGraphEdgeType>,
     publicIdByAssetId: Map<string, string>,
     assetPublicIds: Set<string>,
     bundleContentHashes: Map<string, string>,
-    symbolPropagationRan: boolean,
   |}) {
     this._graph = graph;
     this._assetPublicIds = assetPublicIds;
     this._publicIdByAssetId = publicIdByAssetId;
     this._bundleContentHashes = bundleContentHashes;
-    this._symbolPropagationRan = symbolPropagationRan;
   }
 
   /**
@@ -166,6 +159,7 @@ export default class BundleGraph {
    */
   static fromAssetGraph(
     assetGraph: AssetGraph,
+    isProduction: boolean,
     publicIdByAssetId: Map<string, string> = new Map(),
     assetPublicIds: Set<string> = new Set(),
   ): BundleGraph {
@@ -207,7 +201,9 @@ export default class BundleGraph {
       if (
         node.type === 'dependency' &&
         node.value.symbols != null &&
-        node.value.env.shouldScopeHoist
+        node.value.env.shouldScopeHoist &&
+        // Disable in dev mode because this feature is at odds with safeToIncrementallyBundle
+        isProduction
       ) {
         // asset -> symbols that should be imported directly from that asset
         let targets = new DefaultMap<ContentKey, Map<Symbol, Symbol>>(
@@ -384,7 +380,6 @@ export default class BundleGraph {
       assetPublicIds,
       bundleContentHashes: new Map(),
       publicIdByAssetId,
-      symbolPropagationRan: assetGraph.symbolPropagationRan,
     });
   }
 
@@ -395,7 +390,6 @@ export default class BundleGraph {
       assetPublicIds: this._assetPublicIds,
       bundleContentHashes: this._bundleContentHashes,
       publicIdByAssetId: this._publicIdByAssetId,
-      symbolPropagationRan: this._symbolPropagationRan,
     };
   }
 
@@ -405,7 +399,6 @@ export default class BundleGraph {
       assetPublicIds: serialized.assetPublicIds,
       bundleContentHashes: serialized.bundleContentHashes,
       publicIdByAssetId: serialized.publicIdByAssetId,
-      symbolPropagationRan: serialized.symbolPropagationRan,
     });
   }
 
@@ -1994,16 +1987,17 @@ export default class BundleGraph {
   getUsedSymbolsAsset(asset: Asset): ?$ReadOnlySet<Symbol> {
     let node = this._graph.getNodeByContentKey(asset.id);
     invariant(node && node.type === 'asset');
-    return this._symbolPropagationRan
+    return node.value.symbols
       ? makeReadOnlySet(new Set(node.usedSymbols.keys()))
       : null;
   }
 
   getUsedSymbolsDependency(dep: Dependency): ?$ReadOnlySet<Symbol> {
     let node = this._graph.getNodeByContentKey(dep.id);
     invariant(node && node.type === 'dependency');
-    let result = new Set(node.usedSymbolsUp.keys());
-    return this._symbolPropagationRan ? makeReadOnlySet(result) : null;
+    return node.value.symbols
+      ? makeReadOnlySet(new Set(node.usedSymbolsUp.keys()))
+      : null;
   }
 
   merge(other: BundleGraph) {
@@ -2069,12 +2063,9 @@ export default class BundleGraph {
   /**
    * Update the asset in a Bundle Graph and clear the associated Bundle hash.
    */
-  updateAsset(asset: Asset) {
-    this._graph.updateNode(
-      this._graph.getNodeIdByContentKey(asset.id),
-      nodeFromAsset(asset),
-    );
-    let bundles = this.getBundlesWithAsset(asset);
+  updateAsset(asset: AssetNode) {
+    this._graph.updateNode(this._graph.getNodeIdByContentKey(asset.id), asset);
+    let bundles = this.getBundlesWithAsset(asset.value);
     for (let bundle of bundles) {
       // the bundle content will change with a modified asset
       this._bundleContentHashes.delete(bundle.id);

diff --git a/packages/core/core/src/Dependency.js b/packages/core/core/src/Dependency.js
@@ -38,7 +38,7 @@ type DependencyOpts = {|
   resolveFrom?: FilePath,
   range?: SemverRange,
   target?: Target,
-  symbols?: Map<
+  symbols?: ?Map<
     Symbol,
     {|local: Symbol, loc: ?SourceLocation, isWeak: boolean, meta?: ?Meta|},
   >,

diff --git a/packages/core/core/src/SymbolPropagation.js b/packages/core/core/src/SymbolPropagation.js
@@ -0,0 +1,43 @@
+// @flow
+
+import type {Diagnostic} from '@parcel/diagnostic';
+import type {NodeId} from '@parcel/graph';
+import type {ParcelOptions} from './types';
+
+import {type default as AssetGraph} from './AssetGraph';
+import {AssetGraphBuilder} from './requests/AssetGraphRequest';
+
+export function propagateSymbols({
+  options,
+  assetGraph,
+  changedAssetsPropagation,
+  assetGroupsWithRemovedParents,
+  previousErrors,
+}: {|
+  options: ParcelOptions,
+  assetGraph: AssetGraph,
+  changedAssetsPropagation: Set<string>,
+  assetGroupsWithRemovedParents: Set<NodeId>,
+  previousErrors?: ?Map<NodeId, Array<Diagnostic>>,
+|}): Map<NodeId, Array<Diagnostic>> {
+  // TODO move functions from AssetGraphRequest to here
+
+  let builder = new AssetGraphBuilder({
+    input: ({} /*: any */),
+    farm: ({} /*: any */),
+    invalidateReason: ({} /*: any */),
+    // $FlowFixMe
+    api: {getInvalidSubRequests: () => []},
+    options,
+  });
+  builder.assetGraph = assetGraph;
+  builder.changedAssetsPropagation = changedAssetsPropagation;
+
+  return builder.propagateSymbols({
+    options: builder.options,
+    assetGraph: builder.assetGraph,
+    changedAssetsPropagation: builder.changedAssetsPropagation,
+    assetGroupsWithRemovedParents: assetGroupsWithRemovedParents,
+    previousErrors: previousErrors,
+  });
+}
diff --git a/packages/core/core/src/applyRuntimes.js b/packages/core/core/src/applyRuntimes.js
@@ -183,6 +183,7 @@ export default async function applyRuntimes<TResult>({
 
   let runtimesGraph = InternalBundleGraph.fromAssetGraph(
     runtimesAssetGraph,
+    options.mode === 'production',
     bundleGraph._publicIdByAssetId,
     bundleGraph._assetPublicIds,
   );

diff --git a/packages/core/core/src/dumpGraphToGraphViz.js b/packages/core/core/src/dumpGraphToGraphViz.js
@@ -127,6 +127,10 @@ export default async function dumpGraphToGraphViz(
               label +=
                 '\\nusedSymbolsDown: ' + [...node.usedSymbolsDown].join(',');
             }
+            // if (node.usedSymbolsDownDirty) label += '\\nusedSymbolsDownDirty';
+            // if (node.usedSymbolsUpDirtyDown)
+            //   label += '\\nusedSymbolsUpDirtyDown';
+            // if (node.usedSymbolsUpDirtyUp) label += '\\nusedSymbolsUpDirtyUp';
           } else {
             label += '\\nsymbols: cleared';
           }
@@ -149,6 +153,8 @@ export default async function dumpGraphToGraphViz(
           if (node.usedSymbols.size) {
             label += '\\nusedSymbols: ' + [...node.usedSymbols].join(',');
           }
+          // if (node.usedSymbolsDownDirty) label += '\\nusedSymbolsDownDirty';
+          // if (node.usedSymbolsUpDirty) label += '\\nusedSymbolsUpDirty';
         } else {
           label += '\\nsymbols: cleared';
         }