feat: only use new flow on feature flag

Author: DOlufemi

lib/dep-graph-builders/npm-lock-v2/index.ts

@@ -29,7 +29,12 @@ export const parseNpmLockV2Project = async (
   pkgLockContent: string,
   options: ProjectParseOptions,
 ): Promise<DepGraph> => {
-  const { includeDevDeps, strictOutOfSync, includeOptionalDeps } = options;
+  const {
+    includeDevDeps,
+    strictOutOfSync,
+    includeOptionalDeps,
+    pruneNpmStrictOutOfSync,
+  } = options;
 
   const pkgJson: PackageJsonBase = parsePkgJson(pkgJsonContent);
   const pkgs = extractPkgsFromNpmLockV2(pkgLockContent);
@@ -38,6 +43,7 @@ export const parseNpmLockV2Project = async (
     includeDevDeps,
     includeOptionalDeps,
     strictOutOfSync,
+    pruneNpmStrictOutOfSync,
   });
 
   return depgraph;
@@ -48,8 +54,12 @@ export const buildDepGraphNpmLockV2 = async (
   pkgJson: PackageJsonBase,
   options: DepGraphBuildOptions,
 ): Promise<DepGraph> => {
-  const { includeDevDeps, strictOutOfSync, includeOptionalDeps } = options;
-
+  const {
+    includeDevDeps,
+    strictOutOfSync,
+    includeOptionalDeps,
+    pruneNpmStrictOutOfSync,
+  } = options;
   const depGraphBuilder = new DepGraphBuilder(
     { name: 'npm' },
     { name: pkgJson.name as string, version: pkgJson.version },
@@ -101,6 +111,7 @@ export const buildDepGraphNpmLockV2 = async (
     [],
     pkgKeysByName,
     pkgJson.overrides,
+    pruneNpmStrictOutOfSync,
   );
   return depGraphBuilder.build();
 };
@@ -123,6 +134,7 @@ const dfsVisit = async (
   ancestry: Ancestry[],
   pkgKeysByName: Map<string, string[]>,
   overrides: Overrides | undefined,
+  pruneNpmStrictOutOfSync?: boolean,
 ): Promise<void> => {
   visitedMap.add(node.id);
 
@@ -149,6 +161,7 @@ const dfsVisit = async (
       ],
       pkgKeysByName,
       overrides,
+      pruneNpmStrictOutOfSync,
     );
 
     if (!visitedMap.has(childNode.id)) {
@@ -189,6 +202,7 @@ const getChildNode = (
   ancestry: Ancestry[],
   pkgKeysByName: Map<string, string[]>,
   overrides?: Overrides,
+  pruneNpmStrictOutOfSync?: boolean,
 ) => {
   let version = depInfo.version;
 
@@ -210,6 +224,7 @@ const getChildNode = (
     ancestry,
     pkgs,
     pkgKeysByName,
+    pruneNpmStrictOutOfSync,
   );
 
   if (!childNodeKey) {
@@ -292,6 +307,7 @@ export const getChildNodeKey = (
   ancestry: { name: string; key: string; inBundle: boolean }[],
   pkgs: Record<string, NpmLockPkg>,
   pkgKeysByName: Map<string, string[]>,
+  pruneNpmStrictOutOfSync?: boolean,
 ): string | undefined => {
   // This is a list of all our possible options for the childKey
   const candidateKeys = pkgKeysByName.get(name);
@@ -306,8 +322,10 @@ export const getChildNodeKey = (
     if (
       semver.validRange(version) &&
       pkgs[candidateKeys[0]].version &&
-      !semver.satisfies(pkgs[candidateKeys[0]].version, version)
+      !semver.satisfies(pkgs[candidateKeys[0]].version, version) &&
+      pruneNpmStrictOutOfSync
     ) {
+      //TODO: Add some logs to monitor
       return undefined;
     }
     return candidateKeys[0];

lib/dep-graph-builders/types.ts

@@ -34,6 +34,7 @@ export type DepGraphBuildOptions = {
   includeOptionalDeps: boolean;
   strictOutOfSync: boolean;
   includePeerDeps?: boolean;
+  pruneNpmStrictOutOfSync?: boolean;
 };
 
 export type LockFileParseOptions = {

test/jest/dep-graph-builders/npm-lock-v2.test.ts

@@ -439,7 +439,7 @@ describe('dep-graph-builder npm-lock-v2', () => {
       ).rejects.toThrow(new OutOfSyncError('[email protected]', LockfileType.npm));
     });
 
-    it('project: simple-out-of-sync -> throws OutOfSyncError', async () => {
+    it('should throw error on out of sync with prune ff', async () => {
       const fixtureName = 'simple-out-of-sync';
       const pkgJsonContent = readFileSync(
         join(__dirname, `./fixtures/npm-lock-v2/${fixtureName}/package.json`),
@@ -458,6 +458,7 @@ describe('dep-graph-builder npm-lock-v2', () => {
           includeOptionalDeps: true,
           pruneCycles: true,
           strictOutOfSync: true,
+          pruneNpmStrictOutOfSync: true,
         }),
       ).rejects.toThrow(new OutOfSyncError('[email protected]', LockfileType.npm));
     });