@atlaspack/graph 3.2.1-canary.3565 → 3.2.1-canary.3567

package/lib/AdjacencyList.js

@@ -268,7 +268,7 @@ class AdjacencyList {
    * Returns `true` if the edge was added,
    * or `false` if the edge already exists.
    */
-  addEdge(from, to, type = 1) {
+  addEdge(from, to, type = _Graph.NULL_EDGE_TYPE) {
     (0, _assert().default)(from < this.#nodes.nextId, `Node ${from} does not exist.`);
     (0, _assert().default)(to < this.#nodes.nextId, `Node ${to} does not exist.`);
     (0, _assert().default)(type > 0, `Unsupported edge type ${type}`);
@@ -316,7 +316,7 @@ class AdjacencyList {
   /**
    * Check if the graph has an edge connecting the `from` and `to` nodes.
    */
-  hasEdge(from, to, type = 1) {
+  hasEdge(from, to, type = _Graph.NULL_EDGE_TYPE) {
     let hasEdge = type => {
       let hash = this.#edges.hash(from, to, type);
       return this.#edges.addressOf(hash, from, to, type) !== null;
@@ -335,7 +335,7 @@ class AdjacencyList {
    *
    * This method will increment the edge delete count.
    */
-  removeEdge(from, to, type = 1) {
+  removeEdge(from, to, type = _Graph.NULL_EDGE_TYPE) {
     let hash = this.#edges.hash(from, to, type);
     let edge = this.#edges.addressOf(hash, from, to, type);
 
@@ -429,7 +429,7 @@ class AdjacencyList {
    * If `type` is an array, return nodes connected by edges of any of those types.
    * If `type` is `AllEdgeTypes` (`-1`), return nodes connected by edges of any type.
    */
-  getNodeIdsConnectedFrom(from, type = 1) {
+  getNodeIdsConnectedFrom(from, type = _Graph.NULL_EDGE_TYPE) {
     let matches = node => type === _Graph.ALL_EDGE_TYPES || (Array.isArray(type) ? type.includes(this.#nodes.typeOf(node)) : type === this.#nodes.typeOf(node));
     let nodes = [];
     let seen = new Set();
@@ -467,14 +467,19 @@ class AdjacencyList {
       node = this.#nodes.next(node);
     }
   }
-  forEachNodeIdConnectedTo(to, fn) {
+  forEachNodeIdConnectedTo(to, fn, type = _Graph.NULL_EDGE_TYPE) {
+    const matches = node => type === _Graph.ALL_EDGE_TYPES || type === this.#nodes.typeOf(node);
     let node = this.#nodes.head(to);
     while (node !== null) {
-      let edge = this.#nodes.firstIn(node);
-      while (edge !== null) {
-        let from = this.#edges.from(edge);
-        fn(from);
-        edge = this.#edges.nextIn(edge);
+      if (matches(node)) {
+        let edge = this.#nodes.firstIn(node);
+        while (edge !== null) {
+          let from = this.#edges.from(edge);
+          if (fn(from)) {
+            return;
+          }
+          edge = this.#edges.nextIn(edge);
+        }
       }
       node = this.#nodes.next(node);
     }
@@ -487,7 +492,7 @@ class AdjacencyList {
    * If `type` is an array, return nodes connected by edges of any of those types.
    * If `type` is `AllEdgeTypes` (`-1`), return nodes connected by edges of any type.
    */
-  getNodeIdsConnectedTo(to, type = 1) {
+  getNodeIdsConnectedTo(to, type = _Graph.NULL_EDGE_TYPE) {
     let matches = node => type === _Graph.ALL_EDGE_TYPES || (Array.isArray(type) ? type.includes(this.#nodes.typeOf(node)) : type === this.#nodes.typeOf(node));
     let nodes = [];
     let seen = new Set();

package/lib/Graph.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = exports.ALL_EDGE_TYPES = void 0;
+exports.default = exports.NULL_EDGE_TYPE = exports.ALL_EDGE_TYPES = void 0;
 exports.mapVisitor = mapVisitor;
 var _types = require("./types");
 var _AdjacencyList = _interopRequireDefault(require("./AdjacencyList"));
@@ -16,6 +16,7 @@ function _nullthrows() {
   return data;
 }
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+const NULL_EDGE_TYPE = exports.NULL_EDGE_TYPE = 1;
 const ALL_EDGE_TYPES = exports.ALL_EDGE_TYPES = -1;
 
 /**
@@ -70,7 +71,7 @@ class Graph {
   getNode(id) {
     return this.nodes[id];
   }
-  addEdge(from, to, type = 1) {
+  addEdge(from, to, type = NULL_EDGE_TYPE) {
     if (Number(type) === 0) {
       throw new Error(`Edge type "${type}" not allowed`);
     }
@@ -82,25 +83,25 @@ class Graph {
     }
     return this.adjacencyList.addEdge(from, to, type);
   }
-  hasEdge(from, to, type = 1) {
+  hasEdge(from, to, type = NULL_EDGE_TYPE) {
     return this.adjacencyList.hasEdge(from, to, type);
   }
-  forEachNodeIdConnectedTo(to, fn) {
+  forEachNodeIdConnectedTo(to, fn, type = NULL_EDGE_TYPE) {
     this._assertHasNodeId(to);
-    this.adjacencyList.forEachNodeIdConnectedTo(to, fn);
+    this.adjacencyList.forEachNodeIdConnectedTo(to, fn, type);
   }
-  forEachNodeIdConnectedFrom(from, fn, type = ALL_EDGE_TYPES) {
+  forEachNodeIdConnectedFrom(from, fn, type = NULL_EDGE_TYPE) {
     this._assertHasNodeId(from);
     this.adjacencyList.forEachNodeIdConnectedFromReverse(from, id => {
       fn(id);
       return false;
     }, type);
   }
-  getNodeIdsConnectedTo(nodeId, type = 1) {
+  getNodeIdsConnectedTo(nodeId, type = NULL_EDGE_TYPE) {
     this._assertHasNodeId(nodeId);
     return this.adjacencyList.getNodeIdsConnectedTo(nodeId, type);
   }
-  getNodeIdsConnectedFrom(nodeId, type = 1) {
+  getNodeIdsConnectedFrom(nodeId, type = NULL_EDGE_TYPE) {
     this._assertHasNodeId(nodeId);
     return this.adjacencyList.getNodeIdsConnectedFrom(nodeId, type);
   }
@@ -127,7 +128,7 @@ class Graph {
     }
     this.nodes[nodeId] = null;
   }
-  removeEdges(nodeId, type = 1) {
+  removeEdges(nodeId, type = NULL_EDGE_TYPE) {
     if (!this.hasNode(nodeId)) {
       return;
     }
@@ -135,7 +136,7 @@ class Graph {
       this._removeEdge(nodeId, to, type);
     }
   }
-  removeEdge(from, to, type = 1, removeOrphans = true) {
+  removeEdge(from, to, type = NULL_EDGE_TYPE, removeOrphans = true) {
     if (!this.adjacencyList.hasEdge(from, to, type)) {
       throw new Error(`Edge from ${(0, _types.fromNodeId)(from)} to ${(0, _types.fromNodeId)(to)} not found!`);
     }
@@ -143,7 +144,7 @@ class Graph {
   }
 
   // Removes edge and node the edge is to if the node is orphaned
-  _removeEdge(from, to, type = 1, removeOrphans = true) {
+  _removeEdge(from, to, type = NULL_EDGE_TYPE, removeOrphans = true) {
     if (!this.adjacencyList.hasEdge(from, to, type)) {
       return;
     }
@@ -183,7 +184,7 @@ class Graph {
   }
 
   // Update a node's downstream nodes making sure to prune any orphaned branches
-  replaceNodeIdsConnectedTo(fromNodeId, toNodeIds, replaceFilter, type = 1) {
+  replaceNodeIdsConnectedTo(fromNodeId, toNodeIds, replaceFilter, type = NULL_EDGE_TYPE) {
     this._assertHasNodeId(fromNodeId);
     let outboundEdges = this.getNodeIdsConnectedFrom(fromNodeId, type);
     let childrenToRemove = new Set(replaceFilter ? outboundEdges.filter(toNodeId => replaceFilter(toNodeId)) : outboundEdges);
@@ -197,7 +198,7 @@ class Graph {
       this._removeEdge(fromNodeId, child, type);
     }
   }
-  traverse(visit, startNodeId, type = 1) {
+  traverse(visit, startNodeId, type = NULL_EDGE_TYPE) {
     let enter = typeof visit === 'function' ? visit : visit.enter;
     if (type === ALL_EDGE_TYPES && enter && (typeof visit === 'function' || !visit.exit)) {
       return this.dfsFast(enter, startNodeId);
@@ -212,7 +213,7 @@ class Graph {
   filteredTraverse(filter, visit, startNodeId, type) {
     return this.traverse(mapVisitor(filter, visit), startNodeId, type);
   }
-  traverseAncestors(startNodeId, visit, type = 1) {
+  traverseAncestors(startNodeId, visit, type = NULL_EDGE_TYPE) {
     return this.dfs({
       visit,
       startNodeId,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaspack/graph",
-  "version": "3.2.1-canary.3565+2b1e35dc3",
+  "version": "3.2.1-canary.3567+e0effea53",
   "description": "Blazing fast, zero configuration web application bundler",
   "license": "(MIT OR Apache-2.0)",
   "publishConfig": {
@@ -16,8 +16,8 @@
     "node": ">= 16.0.0"
   },
   "dependencies": {
-    "@atlaspack/feature-flags": "2.12.1-canary.3565+2b1e35dc3",
+    "@atlaspack/feature-flags": "2.12.1-canary.3567+e0effea53",
     "nullthrows": "^1.1.1"
   },
-  "gitHead": "2b1e35dc3d51843fba13edcb958c01406ff355e4"
+  "gitHead": "e0effea53c21b3c3e3bc9d368468c562e5f80531"
 }

package/src/AdjacencyList.js

@@ -3,7 +3,12 @@ import assert from 'assert';
 import nullthrows from 'nullthrows';
 import {SharedBuffer} from './shared-buffer';
 import {fromNodeId, toNodeId} from './types';
-import {ALL_EDGE_TYPES, type NullEdgeType, type AllEdgeTypes} from './Graph';
+import {
+  ALL_EDGE_TYPES,
+  NULL_EDGE_TYPE,
+  type NullEdgeType,
+  type AllEdgeTypes,
+} from './Graph';
 import type {NodeId} from './types';
 
 /** The address of the node in the nodes map. */
@@ -116,7 +121,7 @@ const MAX_LINK_TRIES: 3 = 3;
  * `getInboundEdgesByType` methods.
  *
  */
-export default class AdjacencyList<TEdgeType: number = 1> {
+export default class AdjacencyList<TEdgeType: number = NullEdgeType> {
   #nodes: NodeTypeMap<TEdgeType | NullEdgeType>;
   #edges: EdgeTypeMap<TEdgeType | NullEdgeType>;
 
@@ -363,7 +368,7 @@ export default class AdjacencyList<TEdgeType: number = 1> {
   addEdge(
     from: NodeId,
     to: NodeId,
-    type: TEdgeType | NullEdgeType = 1,
+    type: TEdgeType | NullEdgeType = NULL_EDGE_TYPE,
   ): boolean {
     assert(from < this.#nodes.nextId, `Node ${from} does not exist.`);
     assert(to < this.#nodes.nextId, `Node ${to} does not exist.`);
@@ -433,7 +438,10 @@ export default class AdjacencyList<TEdgeType: number = 1> {
   hasEdge(
     from: NodeId,
     to: NodeId,
-    type: TEdgeType | NullEdgeType | Array<TEdgeType | NullEdgeType> = 1,
+    type:
+      | TEdgeType
+      | NullEdgeType
+      | Array<TEdgeType | NullEdgeType> = NULL_EDGE_TYPE,
   ): boolean {
     let hasEdge = (type: TEdgeType | NullEdgeType) => {
       let hash = this.#edges.hash(from, to, type);
@@ -458,7 +466,7 @@ export default class AdjacencyList<TEdgeType: number = 1> {
   removeEdge(
     from: NodeId,
     to: NodeId,
-    type: TEdgeType | NullEdgeType = 1,
+    type: TEdgeType | NullEdgeType = NULL_EDGE_TYPE,
   ): void {
     let hash = this.#edges.hash(from, to, type);
     let edge = this.#edges.addressOf(hash, from, to, type);
@@ -568,7 +576,7 @@ export default class AdjacencyList<TEdgeType: number = 1> {
       | AllEdgeTypes
       | TEdgeType
       | NullEdgeType
-      | Array<TEdgeType | NullEdgeType> = 1,
+      | Array<TEdgeType | NullEdgeType> = NULL_EDGE_TYPE,
   ): NodeId[] {
     let matches = (node) =>
       type === ALL_EDGE_TYPES ||
@@ -619,14 +627,25 @@ export default class AdjacencyList<TEdgeType: number = 1> {
     }
   }
 
-  forEachNodeIdConnectedTo(to: NodeId, fn: (nodeId: NodeId) => void) {
+  forEachNodeIdConnectedTo(
+    to: NodeId,
+    fn: (nodeId: NodeId) => boolean | void,
+    type: AllEdgeTypes | TEdgeType | NullEdgeType = NULL_EDGE_TYPE,
+  ) {
+    const matches = (node) =>
+      type === ALL_EDGE_TYPES || type === this.#nodes.typeOf(node);
+
     let node = this.#nodes.head(to);
     while (node !== null) {
-      let edge = this.#nodes.firstIn(node);
-      while (edge !== null) {
-        let from = this.#edges.from(edge);
-        fn(from);
-        edge = this.#edges.nextIn(edge);
+      if (matches(node)) {
+        let edge = this.#nodes.firstIn(node);
+        while (edge !== null) {
+          let from = this.#edges.from(edge);
+          if (fn(from)) {
+            return;
+          }
+          edge = this.#edges.nextIn(edge);
+        }
       }
       node = this.#nodes.next(node);
     }
@@ -645,7 +664,7 @@ export default class AdjacencyList<TEdgeType: number = 1> {
       | AllEdgeTypes
       | TEdgeType
       | NullEdgeType
-      | Array<TEdgeType | NullEdgeType> = 1,
+      | Array<TEdgeType | NullEdgeType> = NULL_EDGE_TYPE,
   ): NodeId[] {
     let matches = (node) =>
       type === ALL_EDGE_TYPES ||

package/src/Graph.js

@@ -13,14 +13,15 @@ import {BitSet} from './BitSet';
 import nullthrows from 'nullthrows';
 
 export type NullEdgeType = 1;
-export type GraphOpts<TNode, TEdgeType: number = 1> = {|
+export const NULL_EDGE_TYPE: NullEdgeType = 1;
+export type GraphOpts<TNode, TEdgeType: number = NullEdgeType> = {|
   nodes?: Array<TNode | null>,
   adjacencyList?: SerializedAdjacencyList<TEdgeType>,
   rootNodeId?: ?NodeId,
   initialCapacity?: number,
 |};
 
-export type SerializedGraph<TNode, TEdgeType: number = 1> = {|
+export type SerializedGraph<TNode, TEdgeType: number = NullEdgeType> = {|
   nodes: Array<TNode | null>,
   adjacencyList: SerializedAdjacencyList<TEdgeType>,
   rootNodeId: ?NodeId,
@@ -74,7 +75,7 @@ export type DFSParams<TContext> = {|
   startNodeId?: ?NodeId,
 |};
 
-export default class Graph<TNode, TEdgeType: number = 1> {
+export default class Graph<TNode, TEdgeType: number = NullEdgeType> {
   nodes: Array<TNode | null>;
   adjacencyList: AdjacencyList<TEdgeType>;
   rootNodeId: ?NodeId;
@@ -138,7 +139,7 @@ export default class Graph<TNode, TEdgeType: number = 1> {
   addEdge(
     from: NodeId,
     to: NodeId,
-    type: TEdgeType | NullEdgeType = 1,
+    type: TEdgeType | NullEdgeType = NULL_EDGE_TYPE,
   ): boolean {
     if (Number(type) === 0) {
       throw new Error(`Edge type "${type}" not allowed`);
@@ -158,21 +159,28 @@ export default class Graph<TNode, TEdgeType: number = 1> {
   hasEdge(
     from: NodeId,
     to: NodeId,
-    type?: TEdgeType | NullEdgeType | Array<TEdgeType | NullEdgeType> = 1,
+    type?:
+      | TEdgeType
+      | NullEdgeType
+      | Array<TEdgeType | NullEdgeType> = NULL_EDGE_TYPE,
   ): boolean {
     return this.adjacencyList.hasEdge(from, to, type);
   }
 
-  forEachNodeIdConnectedTo(to: NodeId, fn: (nodeId: NodeId) => void) {
+  forEachNodeIdConnectedTo(
+    to: NodeId,
+    fn: (nodeId: NodeId) => boolean | void,
+    type: AllEdgeTypes | TEdgeType | NullEdgeType = NULL_EDGE_TYPE,
+  ) {
     this._assertHasNodeId(to);
 
-    this.adjacencyList.forEachNodeIdConnectedTo(to, fn);
+    this.adjacencyList.forEachNodeIdConnectedTo(to, fn, type);
   }
 
   forEachNodeIdConnectedFrom(
     from: NodeId,
     fn: (nodeId: NodeId) => void,
-    type: AllEdgeTypes | TEdgeType | NullEdgeType = ALL_EDGE_TYPES,
+    type: AllEdgeTypes | TEdgeType | NullEdgeType = NULL_EDGE_TYPE,
   ) {
     this._assertHasNodeId(from);
 
@@ -192,7 +200,7 @@ export default class Graph<TNode, TEdgeType: number = 1> {
       | TEdgeType
       | NullEdgeType
       | Array<TEdgeType | NullEdgeType>
-      | AllEdgeTypes = 1,
+      | AllEdgeTypes = NULL_EDGE_TYPE,
   ): Array<NodeId> {
     this._assertHasNodeId(nodeId);
 
@@ -205,7 +213,7 @@ export default class Graph<TNode, TEdgeType: number = 1> {
       | TEdgeType
       | NullEdgeType
       | Array<TEdgeType | NullEdgeType>
-      | AllEdgeTypes = 1,
+      | AllEdgeTypes = NULL_EDGE_TYPE,
   ): Array<NodeId> {
     this._assertHasNodeId(nodeId);
 
@@ -236,7 +244,7 @@ export default class Graph<TNode, TEdgeType: number = 1> {
     this.nodes[nodeId] = null;
   }
 
-  removeEdges(nodeId: NodeId, type: TEdgeType | NullEdgeType = 1) {
+  removeEdges(nodeId: NodeId, type: TEdgeType | NullEdgeType = NULL_EDGE_TYPE) {
     if (!this.hasNode(nodeId)) {
       return;
     }
@@ -249,7 +257,7 @@ export default class Graph<TNode, TEdgeType: number = 1> {
   removeEdge(
     from: NodeId,
     to: NodeId,
-    type: TEdgeType | NullEdgeType = 1,
+    type: TEdgeType | NullEdgeType = NULL_EDGE_TYPE,
     removeOrphans: boolean = true,
   ) {
     if (!this.adjacencyList.hasEdge(from, to, type)) {
@@ -265,7 +273,7 @@ export default class Graph<TNode, TEdgeType: number = 1> {
   _removeEdge(
     from: NodeId,
     to: NodeId,
-    type: TEdgeType | NullEdgeType = 1,
+    type: TEdgeType | NullEdgeType = NULL_EDGE_TYPE,
     removeOrphans: boolean = true,
   ) {
     if (!this.adjacencyList.hasEdge(from, to, type)) {
@@ -321,7 +329,7 @@ export default class Graph<TNode, TEdgeType: number = 1> {
     fromNodeId: NodeId,
     toNodeIds: $ReadOnlyArray<NodeId>,
     replaceFilter?: null | ((NodeId) => boolean),
-    type?: TEdgeType | NullEdgeType = 1,
+    type?: TEdgeType | NullEdgeType = NULL_EDGE_TYPE,
   ): void {
     this._assertHasNodeId(fromNodeId);
 
@@ -351,7 +359,7 @@ export default class Graph<TNode, TEdgeType: number = 1> {
       | TEdgeType
       | NullEdgeType
       | Array<TEdgeType | NullEdgeType>
-      | AllEdgeTypes = 1,
+      | AllEdgeTypes = NULL_EDGE_TYPE,
   ): ?TContext {
     let enter = typeof visit === 'function' ? visit : visit.enter;
     if (
@@ -385,7 +393,7 @@ export default class Graph<TNode, TEdgeType: number = 1> {
       | TEdgeType
       | NullEdgeType
       | Array<TEdgeType | NullEdgeType>
-      | AllEdgeTypes = 1,
+      | AllEdgeTypes = NULL_EDGE_TYPE,
   ): ?TContext {
     return this.dfs({
       visit,

package/test/AdjacencyList.test.js

@@ -7,6 +7,7 @@ import {Worker} from 'worker_threads';
 
 import AdjacencyList, {NodeTypeMap, EdgeTypeMap} from '../src/AdjacencyList';
 import {toNodeId} from '../src/types';
+import {ALL_EDGE_TYPES} from '../src/Graph';
 
 describe('AdjacencyList', () => {
   it('constructor should initialize an empty graph', () => {
@@ -306,6 +307,26 @@ describe('AdjacencyList', () => {
       assert.deepEqual(nodeIds, [a, c]);
     });
 
+    it('stops traversal if the return value is true', () => {
+      const graph = new AdjacencyList();
+      const a = graph.addNode();
+      const b = graph.addNode();
+      const c = graph.addNode();
+      const d = graph.addNode();
+
+      graph.addEdge(a, d);
+      graph.addEdge(b, d);
+      graph.addEdge(c, d);
+
+      const nodeIds = [];
+      graph.forEachNodeIdConnectedTo(d, (nodeId) => {
+        nodeIds.push(nodeId);
+        return true;
+      });
+
+      assert.deepEqual(nodeIds, [a]);
+    });
+
     it('terminates if the graph is cyclic', () => {
       const graph = new AdjacencyList();
       const a = graph.addNode();
@@ -323,6 +344,44 @@ describe('AdjacencyList', () => {
 
       assert.deepEqual(nodeIds, [a, c, b]);
     });
+
+    it('respects the edge type', () => {
+      const graph = new AdjacencyList();
+      const a = graph.addNode();
+      const b = graph.addNode();
+      const c = graph.addNode();
+
+      graph.addEdge(a, b);
+      graph.addEdge(c, b, 2);
+
+      const nodeIds = [];
+      graph.forEachNodeIdConnectedTo(b, (id) => {
+        nodeIds.push(id);
+      });
+
+      assert.deepEqual(nodeIds, [a]);
+    });
+
+    it('iterates all edges if all edge type is provided', () => {
+      const graph = new AdjacencyList();
+      const a = graph.addNode();
+      const b = graph.addNode();
+      const c = graph.addNode();
+
+      graph.addEdge(a, b);
+      graph.addEdge(c, b, 2);
+
+      const nodeIds = [];
+      graph.forEachNodeIdConnectedTo(
+        b,
+        (id) => {
+          nodeIds.push(id);
+        },
+        ALL_EDGE_TYPES,
+      );
+
+      assert.deepEqual(nodeIds, [a, c]);
+    });
   });
 
   describe('forEachNodeIdConnectedFromReverse', () => {