fix: cannot use file path dependencies (#1779)

Fixes #1777 We've supported dependency versions that aren't strictly semver-strings for a while now (see for example: #527). This simply makes the logic a little more robust / less prone to causing sudden errors. --- By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license
projen · Apr 20, 2022 · 6508208 · 6508208
1 parent 91377c0
commit 6508208
Show file tree

Hide file tree

Showing 4 changed files with 71 additions and 9 deletions.
diff --git a/src/javascript/node-package.ts b/src/javascript/node-package.ts
@@ -8,7 +8,6 @@ import {
   readdirSync,
   readJsonSync,
 } from "fs-extra";
-import * as semver from "semver";
 import { resolve as resolveJson } from "../_resolve";
 import { Component } from "../component";
 import { DependencyType } from "../dependencies";
@@ -17,7 +16,7 @@ import { Project } from "../project";
 import { isAwsCodeArtifactRegistry } from "../release";
 import { Task } from "../task";
 import { exec, isTruthy, sorted, writeFile } from "../util";
-import { extractCodeArtifactDetails } from "./util";
+import { extractCodeArtifactDetails, minVersion } from "./util";
 
 const UNLICENSED = "UNLICENSED";
 const DEFAULT_NPM_REGISTRY_URL = "https://registry.npmjs.org/";
@@ -1010,7 +1009,7 @@ export class NodePackage extends Component {
         }
 
         if (dep.version) {
-          const ver = semver.minVersion(dep.version)?.version;
+          const ver = minVersion(dep.version);
           if (!ver) {
             throw new Error(
               `unable to determine minimum semver for peer dependency ${dep.name}@${dep.version}`
@@ -1189,7 +1188,7 @@ export class NodePackage extends Component {
         }
 
         // Take version and pin as dev dependency
-        const ver = semver.minVersion(version)?.version;
+        const ver = minVersion(version);
         if (!ver) {
           throw new Error(
             `unable to determine minimum semver for peer dependency ${name}@${version}`

diff --git a/src/javascript/util.ts b/src/javascript/util.ts
@@ -1,4 +1,5 @@
 import { basename, dirname, extname, join, sep } from "path";
+import * as semver from "semver";
 
 export function renderBundleName(entrypoint: string) {
   const parts = join(entrypoint).split(sep);
@@ -32,3 +33,11 @@ export function extractCodeArtifactDetails(registryUrl: string) {
   }
   throw new Error("Could not get CodeArtifact details from npm Registry");
 }
+
+export function minVersion(version: string): string | undefined {
+  if (semver.validRange(version)) {
+    return semver.minVersion(version)?.version;
+  } else {
+    return version;
+  }
+}
diff --git a/test/deps.test.ts b/test/deps.test.ts
@@ -284,6 +284,26 @@ test("it is possible to overwrite dependency specs", () => {
   ]);
 });
 
+test("it is possible to have local file dependencies", () => {
+  // GIVEN
+  const p = new TestProject();
+
+  // WHEN
+  p.deps.addDependency("cowsay@file:./cowsay", DependencyType.RUNTIME);
+  p.deps.addDependency("lolcat@file:../path/to/lolcat", DependencyType.BUILD);
+  p.deps.addDependency(
+    "fortune@file:../../path/to/fortune",
+    DependencyType.PEER
+  );
+
+  // THEN
+  expect(p.deps.all).toStrictEqual([
+    { name: "lolcat", type: "build", version: "file:../path/to/lolcat" },
+    { name: "fortune", type: "peer", version: "file:../../path/to/fortune" },
+    { name: "cowsay", type: "runtime", version: "file:./cowsay" },
+  ]);
+});
+
 function depsManifest(p: Project) {
   p.synth();
   const filepath = join(p.outdir, Dependencies.MANIFEST_FILE);

diff --git a/test/javascript/node-package.test.ts b/test/javascript/node-package.test.ts
@@ -5,6 +5,7 @@ import semver from "semver";
 import * as YAML from "yaml";
 import { Project } from "../../src";
 import { NodePackage } from "../../src/javascript/node-package";
+import { minVersion } from "../../src/javascript/util";
 import * as util from "../../src/util";
 import { mkdtemp, synthSnapshot, TestProject } from "../util";
 
@@ -46,7 +47,7 @@ function mockYarnInstall(
         depRanges[depName].push("*");
         depVersions[depName].push(latestPackages[depName]);
       } else {
-        const ver = semver.minVersion(`${depVer}`)?.version;
+        const ver = minVersion(`${depVer}`);
         if (!ver) {
           throw new Error(
             `unable to determine min version for ${depName}@${depVer}`
@@ -55,6 +56,7 @@ function mockYarnInstall(
         // If we're given a latest package, no dependency can require higher
         if (
           latestPackages[depName] &&
+          semver.validRange(`${ver}`) &&
           semver.gt(`${ver}`, latestPackages[depName])
         ) {
           throw new Error(
@@ -69,10 +71,16 @@ function mockYarnInstall(
   }
   // Resolve version to install that satisfies all ranges for dep
   for (const dep of Object.keys(depRanges)) {
-    const installVersion = semver.maxSatisfying(
-      depVersions[dep],
-      depRanges[dep].join(" || ")
-    );
+    let installVersion: string | null;
+    if (!semver.validRange(depVersions[dep][0])) {
+      // if a dependency is "file:..." or something else, just install that
+      installVersion = depVersions[dep][0];
+    } else {
+      installVersion = semver.maxSatisfying(
+        depVersions[dep],
+        depRanges[dep].join(" || ")
+      );
+    }
     if (!installVersion) {
       throw new Error(`No version given satisfies all constraints on ${dep}`);
     }
@@ -337,3 +345,29 @@ test("devDependencies are not pinned by peerDependencies if pinnedDevDependency
   expect(pkgFile.peerDependencies).toStrictEqual({ ms: "^1.4.0" });
   expect(pkgFile.devDependencies).toBeUndefined();
 });
+
+test("file path dependencies are respected", () => {
+  // Post-synth dependency version resolution uses installed package from node_modules folder
+  // Mock install command to add this folder with a fixed dependency version,
+  // mimicking yarn installing the latest package for "*"
+  jest.spyOn(util, "exec").mockImplementation((command, options) => {
+    expect(command.startsWith("yarn install")).toBeTruthy();
+    mockYarnInstall(options.cwd, { ms: "file:../ms" });
+  });
+
+  const project = new Project({ name: "test" });
+  const pkg = new NodePackage(project, {
+    peerDependencyOptions: {
+      pinnedDevDependency: false,
+    },
+  });
+
+  pkg.addPeerDeps("ms@file:../ms");
+
+  project.synth();
+
+  const pkgFile = readJsonSync(join(project.outdir, "package.json"));
+
+  expect(pkgFile.peerDependencies).toStrictEqual({ ms: "file:../ms" });
+  expect(pkgFile.devDependencies).toBeUndefined();
+});