@teambit/pnpm 1.0.1284 → 1.0.1285

package/dist/lockfile-deps-graph-converter.spec.js

@@ -1473,6 +1473,286 @@ describe('convertGraphToLockfile on invalid graph', () => {
     (0, _chai().expect)(error?.message).eq(`Failed to generate a valid lockfile. The "packages['foo@1.0.0']" entry doesn't have a "resolution" field.`);
   });
 });
+
+// A graph is stored by a workspace whose root may provide a different version of a package than
+// the root of the install restoring it (the capsules root pins the env's peers). pnpm resolves
+// peers from the root and dedupes satisfiable ranges to it, so the restored lockfile must not keep
+// the workspace's other version next to the root's one.
+describe('convertGraphToLockfile with a root manifest that provides a package the graph resolved to another version', () => {
+  const rootDir = process.cwd();
+  const compDir = _path().default.resolve('comps/comp1');
+  const helmetSnapshot = '@types/react-helmet@6.1.6';
+  const peerSnapshot = 'react-types-peer@1.0.0(@types/react@18.2.23)';
+  const resolve = async () => ({
+    resolution: {
+      integrity: '0000'
+    }
+  });
+  function createGraph(opts = {}) {
+    const typesReactDep = opts.peerKeyed ? peerSnapshot : '@types/react@18.2.23';
+    const packages = new Map([[helmetSnapshot, {
+      resolution: {
+        integrity: 'sha512-helmet'
+      }
+    }], ['@types/react@18.2.23', opts.typesReactUnresolved ? {} : {
+      resolution: {
+        integrity: 'sha512-react18'
+      }
+    }], ['react-types-peer@1.0.0', {
+      resolution: {
+        integrity: 'sha512-peer'
+      },
+      peerDependencies: {
+        '@types/react': '*'
+      }
+    }]]);
+    const edges = [{
+      id: _objects().DependenciesGraph.ROOT_EDGE_ID,
+      neighbours: [{
+        id: helmetSnapshot,
+        name: '@types/react-helmet',
+        specifier: '6.1.6',
+        lifecycle: 'dev'
+      }]
+    }, {
+      id: helmetSnapshot,
+      neighbours: [{
+        id: typesReactDep
+      }]
+    }, {
+      id: peerSnapshot,
+      attr: {
+        pkgId: 'react-types-peer@1.0.0'
+      },
+      neighbours: [{
+        id: '@types/react@18.2.23'
+      }]
+    }];
+    return new (_objects().DependenciesGraph)({
+      packages,
+      edges,
+      overrides: opts.overrides
+    });
+  }
+  function convert(rootManifest, graph = createGraph()) {
+    return (0, _lockfileDepsGraphConverter().convertGraphToLockfile)(graph, {
+      manifests: {
+        [rootDir]: rootManifest,
+        [compDir]: {
+          devDependencies: {
+            '@types/react-helmet': '6.1.6'
+          }
+        }
+      },
+      rootDir,
+      resolve
+    });
+  }
+  it('should drop a reference to another version of a package the root pins, so the install resolves it to the root version', async () => {
+    const lockfile = await convert({
+      dependencies: {
+        '@types/react': '17.0.87'
+      }
+    });
+    (0, _chai().expect)(lockfile.snapshots[helmetSnapshot]).to.eql({
+      dependencies: {}
+    });
+    (0, _chai().expect)(lockfile.packages['@types/react@18.2.23']).to.equal(undefined);
+    (0, _chai().expect)(lockfile.snapshots['@types/react@18.2.23']).to.equal(undefined);
+  });
+  it('should drop a peer resolution of the other version', async () => {
+    const lockfile = await convert({
+      dependencies: {
+        '@types/react': '17.0.87'
+      }
+    }, createGraph({
+      peerKeyed: true
+    }));
+    (0, _chai().expect)(lockfile.snapshots[peerSnapshot]).to.eql({
+      dependencies: {}
+    });
+    (0, _chai().expect)(lockfile.packages['@types/react@18.2.23']).to.equal(undefined);
+  });
+  it('should keep a regular dependency when the root specifier is a range, a tag or a link', async () => {
+    for (const specifier of ['^17.0.0', 'latest', 'link:../types-react']) {
+      const lockfile = await convert({
+        dependencies: {
+          '@types/react': specifier
+        }
+      });
+      (0, _chai().expect)(lockfile.snapshots[helmetSnapshot], specifier).to.eql({
+        dependencies: {
+          '@types/react': '18.2.23'
+        }
+      });
+    }
+  });
+  it('should drop a peer resolution whatever the root specifier is, since pnpm resolves peers from the root', async () => {
+    for (const specifier of ['^17.0.0', 'latest', 'link:../types-react', 'npm:@types/react@17.0.87']) {
+      const lockfile = await convert({
+        dependencies: {
+          '@types/react': specifier
+        }
+      }, createGraph({
+        peerKeyed: true
+      }));
+      (0, _chai().expect)(lockfile.snapshots[peerSnapshot], specifier).to.eql({
+        dependencies: {}
+      });
+      (0, _chai().expect)(lockfile.packages['@types/react@18.2.23'], specifier).to.equal(undefined);
+    }
+  });
+  it('should keep the reference when it is already the root version, however the root spells it', async () => {
+    for (const specifier of ['18.2.23', 'v18.2.23']) {
+      const lockfile = await convert({
+        dependencies: {
+          '@types/react': specifier
+        }
+      });
+      (0, _chai().expect)(lockfile.snapshots[helmetSnapshot], specifier).to.eql({
+        dependencies: {
+          '@types/react': '18.2.23'
+        }
+      });
+      const peerLockfile = await convert({
+        dependencies: {
+          '@types/react': specifier
+        }
+      }, createGraph({
+        peerKeyed: true
+      }));
+      (0, _chai().expect)(peerLockfile.snapshots[peerSnapshot], specifier).to.eql({
+        dependencies: {
+          '@types/react': '18.2.23'
+        }
+      });
+    }
+  });
+  it('should keep the reference when the root provides the package only as an optional dependency', async () => {
+    const lockfile = await convert({
+      optionalDependencies: {
+        '@types/react': '17.0.87'
+      }
+    });
+    (0, _chai().expect)(lockfile.snapshots[helmetSnapshot]).to.eql({
+      dependencies: {
+        '@types/react': '18.2.23'
+      }
+    });
+  });
+  it('should keep the reference when an override targets the package', async () => {
+    for (const overrides of [{
+      '@types/react-helmet>@types/react': '^18.0.0'
+    }, {
+      '@types/react@*': '18.2.23'
+    }]) {
+      const lockfile = await convert({
+        dependencies: {
+          '@types/react': '17.0.87'
+        }
+      }, createGraph({
+        overrides
+      }));
+      (0, _chai().expect)(lockfile.snapshots[helmetSnapshot]).to.eql({
+        dependencies: {
+          '@types/react': '18.2.23'
+        }
+      });
+    }
+  });
+  it('should not send a package the dedupe orphaned to the resolver', async () => {
+    const lockfile = await (0, _lockfileDepsGraphConverter().convertGraphToLockfile)(createGraph({
+      typesReactUnresolved: true
+    }), {
+      manifests: {
+        [rootDir]: {
+          dependencies: {
+            '@types/react': '17.0.87'
+          }
+        },
+        [compDir]: {
+          devDependencies: {
+            '@types/react-helmet': '6.1.6'
+          }
+        }
+      },
+      rootDir,
+      resolve: async wantedDep => {
+        if (wantedDep.alias === '@types/react') throw new Error('ENOTFOUND');
+        return {
+          resolution: {
+            integrity: '0000'
+          }
+        };
+      }
+    });
+    (0, _chai().expect)(lockfile.packages['@types/react@18.2.23']).to.equal(undefined);
+  });
+  it('should not take an inherited object property name, e.g. "constructor", for a package the root provides', async () => {
+    const packages = new Map([['dependent@1.0.0', {
+      resolution: {
+        integrity: 'sha512-dependent'
+      },
+      peerDependencies: {
+        react: '*'
+      }
+    }], ['constructor@1.0.0', {
+      resolution: {
+        integrity: 'sha512-constructor'
+      }
+    }]]);
+    const edges = [{
+      id: _objects().DependenciesGraph.ROOT_EDGE_ID,
+      neighbours: [{
+        id: 'dependent@1.0.0',
+        name: 'dependent',
+        specifier: '1.0.0',
+        lifecycle: 'runtime'
+      }]
+    }, {
+      id: 'dependent@1.0.0',
+      neighbours: [{
+        id: 'constructor@1.0.0'
+      }]
+    }];
+    const lockfile = await (0, _lockfileDepsGraphConverter().convertGraphToLockfile)(new (_objects().DependenciesGraph)({
+      packages,
+      edges
+    }), {
+      manifests: {
+        [rootDir]: {
+          dependencies: {
+            '@types/react': '17.0.87'
+          }
+        },
+        [compDir]: {
+          dependencies: {
+            dependent: '1.0.0'
+          }
+        }
+      },
+      rootDir,
+      resolve
+    });
+    (0, _chai().expect)(lockfile.snapshots['dependent@1.0.0']).to.eql({
+      dependencies: {
+        constructor: '1.0.0'
+      }
+    });
+  });
+  it('should leave the graph alone when the root has no such dependency', async () => {
+    const lockfile = await convert({
+      dependencies: {
+        react: '18.3.1'
+      }
+    });
+    (0, _chai().expect)(lockfile.snapshots[helmetSnapshot]).to.eql({
+      dependencies: {
+        '@types/react': '18.2.23'
+      }
+    });
+  });
+});
 describe('pnpmfileChecksum', () => {
   const componentDir = 'comps/comp1';
   function createLockfile(pnpmfileChecksum) {