fix packageVersion for file protocol

Author: milahu

src/index.ts

@@ -9,6 +9,7 @@ const appPath = getAppRootPath()
 
 var dashdashOptions = [
   { name: "use-yarn", type: "bool" },
+  { name: "create-issue", type: "bool" },
   { name: "case-sensitive-path-filtering", type: "bool" },
   { name: "reverse", type: "bool" },
   { names: ["help", "h"], type: "bool" },
@@ -74,6 +75,10 @@ if (argv.version) {
       appPath,
       argv.use_yarn ? "yarn" : null,
     )
+    if (isDebug) {
+      console.log(`patch-package/index: packageManager = ${packageManager}`)
+    }
+
     const createIssue = argv.create_issue
     packageNames.forEach((packagePathSpecifier: string) => {
       makePatch({

src/makePatch.ts

@@ -1,5 +1,6 @@
 import chalk from "chalk"
 import { join, dirname, resolve } from "./path"
+import { basename } from "path"
 import { spawnSafeSync } from "./spawnSafe"
 import { PackageManager } from "./detectPackageManager"
 import { removeIgnoredFiles } from "./filterFiles"
@@ -25,7 +26,7 @@ import { resolveRelativeFileDependencies } from "./resolveRelativeFileDependenci
 import { getPackageResolution } from "./getPackageResolution"
 import { parsePatchFile } from "./patch/parse"
 import { gzipSync } from "zlib"
-//import { getPackageVersion } from "./getPackageVersion"
+import { getPackageVersion } from "./getPackageVersion"
 import {
   maybePrintIssueCreationPrompt,
   openIssueCreationLink,
@@ -34,6 +35,7 @@ import { quote as shlexQuote } from "shlex"
 
 const isVerbose = global.patchPackageIsVerbose
 const isDebug = global.patchPackageIsDebug
+const isTest = process.env.NODE_ENV == 'test'
 
 function printNoPackageFoundError(
   packageName: string,
@@ -73,6 +75,13 @@ export function makePatch({
   const packagePath = join(appPath, packageDetails.path)
   const packageJsonPath = join(packagePath, "package.json")
 
+  if (isDebug) {
+    console.log(`patch-package/makePatch: appPath = ${appPath}`)
+    console.log(`patch-package/makePatch: packagePath = ${packagePath}`)
+    console.log(`patch-package/makePatch: appPackageJson:`)
+    console.dir(appPackageJson)
+  }
+
   if (!existsSync(packageJsonPath)) {
     printNoPackageFoundError(packagePathSpecifier, packageJsonPath)
     process.exit(1)
@@ -102,6 +111,12 @@ export function makePatch({
 
     console.info(chalk.grey("•"), "Creating temporary folder")
 
+    if (isDebug) {
+      console.log(
+        `patch-package/makePatch: tmpRepoNpmRoot = ${tmpRepoNpmRoot}`,
+      )
+    }
+
     const resolvedVersion = getPackageResolution({
       packageDetails,
       packageManager,
@@ -124,36 +139,79 @@ export function makePatch({
       }),
     )
 
-    /*
+    const declaredVersion = (() => {
+      var v = resolvedVersion.version
+      // https://docs.npmjs.com/cli/v7/configuring-npm/package-json
+      // <protocol>://[<user>[:<password>]@]<hostname>[:<port>][:][/]<path>[#<commit-ish> | #semver:<semver>]
+      // pnpm uses link: protocol instead of file:
+      // TODO add more protocols?
+      var m = v.match(/^(file|link|http|https|git|git\+https|git\+http|git\+ssh|git\+file|github):(.+)$/)
+      if (m) {
+        var protocol = m[1]
+        var location = m[2]
+        var isGit = protocol.startsWith('git')
+        var gitCommit = isGit ? location.split('#').slice(-1)[0] : null
+        if (isGit && !gitCommit) {
+          throw new Error(`error: found wildcard git version ${v}. package.json must pin the exact version of ${packageDetails.name} in the format <protocol>:<packagePath>#<commitHash>`)
+        }
+        if (isGit) {
+          return { full: v, protocol, location, gitCommit }
+        }
+        else {
+          // sample: https://registry.yarnpkg.com/left-pad/-/left-pad-1.3.0.tgz#5b8a3a7765dfe001261dde915589e782f8c94d1e
+          // hash is sha1sum of tgz file
+          // -> use version number from package's package.json
+          var version = getPackageVersion(join(resolve(packageDetails.path), "package.json"))
+          if (isVerbose) {
+            console.log(`patch-package/makePatch: warning: using version ${version} from ${packageDetails.name}/package.json`)
+          }
+          return { version }
+        }
+      }
+      if (!v.match(/^[0-9]+\.[0-9]+\.[0-9]+/)) {
+        throw new Error(`error: found wildcard version. package.json must pin the exact version of ${packageDetails.name} in the format <package>@<major>.<minor>.<patch>`)
+      }
+      return { full: v, version: v }
+    })()
+
+    const packageVersion = (
+      declaredVersion.version || declaredVersion.gitCommit || declaredVersion.full
+    )
+
     // originCommit is more precise than pkg.version
     if (isDebug) {
-      console.log(
-        `patch-package/makePatch: resolvedVersion.originCommit = ${resolvedVersion.originCommit}`,
-      )
-      console.log(
-        `patch-package/makePatch: resolvedVersion.version = ${resolvedVersion.version}`,
-      )
+      //console.log(`patch-package/makePatch: resolvedVersion.originCommit = ${resolvedVersion.originCommit}`)
+      console.log(`patch-package/makePatch: resolvedVersion.version = ${resolvedVersion.version}`)
+      console.log(`patch-package/makePatch: packageVersion = ${packageVersion}`)
     }
-    const packageVersion =
-      resolvedVersion.originCommit ||
-      getPackageVersion(join(resolve(packageDetails.path), "package.json"))
-    */
+
+    //const packageVersion =
+    //  resolvedVersion.originCommit ||
+    //  getPackageVersion(join(resolve(packageDetails.path), "package.json"))
 
     // this is broken when installing from git -> version can be a pseudo-version like 1.0.0-canary
     //const packageVersion = getPackageVersion(join(resolve(packageDetails.path), "package.json"))
 
-    const packageVersion = resolvedVersion.version
+    // TODO rename resolvedVersion -> declaredVersion
+
+    // FIXME false positive
+    // test integration-tests/create-issue/create-issue.test.ts
+    // -> patching left-pad prompts to submit an issue
+    // https://registry.yarnpkg.com/left-pad/-/left-pad-1.3.0.tgz#5b8a3a7765dfe001261dde915589e782f8c94d1e
+    // hash is sha checksum of tgz file -> just use the version 1.3.0
+    /*
+    const packageVersion = (
+      !resolvedVersion.version.match(/^(file:|link:)/) ? resolvedVersion.version :
+      getPackageVersion(join(resolve(packageDetails.path), "package.json"))
+    )
+    */
 
     if (isDebug) {
+      console.log(`patch-package/makePatch: resolvedVersion.version = ${resolvedVersion.version}`)
+      console.log(`patch-package/makePatch: getPackageVersion -> ${getPackageVersion(join(resolve(packageDetails.path), "package.json"))}`)
       console.log(`patch-package/makePatch: packageVersion = ${packageVersion}`)
-      console.log(
-        `patch-package/makePatch: package path = ${packageDetails.path}`,
-      )
-      console.log(
-        `patch-package/makePatch: package path resolved = ${resolve(
-          packageDetails.path,
-        )}`,
-      )
+      console.log(`patch-package/makePatch: package path = ${packageDetails.path}`)
+      console.log(`patch-package/makePatch: package path resolved = ${resolve(packageDetails.path)}`)
     }
 
     // copy .npmrc/.yarnrc in case packages are hosted in private registry
@@ -375,9 +433,11 @@ export function makePatch({
     // patchfiles are parsed in patch/parse.ts function parsePatchLines
     // -> header comments are ignored
     let diffHeader = ""
-    diffHeader += `# generated by patch-package ${patchPackageVersion} on ${new Date().toLocaleString(
-      "lt",
-    )}\n`
+    const dateStr = (
+      isTest ? '1980-01-01 00:00:00' : // mock date
+      new Date().toLocaleString("lt")
+    )
+    diffHeader += `# generated by patch-package ${patchPackageVersion} on ${dateStr}\n`
     diffHeader += `#\n`
     const prettyArgv = process.argv.slice()
     if (prettyArgv[0].match(/node/)) {
@@ -390,14 +450,26 @@ export function makePatch({
     diffHeader += `#   ${prettyArgv.map((a) => shlexQuote(a)).join(" ")}\n`
     diffHeader += `#\n`
     diffHeader += `# declared package:\n`
-    diffHeader += `#   ${packageDetails.name}: ${resolvedVersion.version}\n` // TODO rename to declaredVersion
+    // TODO rename resolvedVersion.version to declaredVersion
+    const declaredPackageStr = (
+      isTest ? (() => {
+        const v = resolvedVersion.version
+        const b = basename(v)
+        if (b != v) return `file:/mocked/path/to/${b}` // mock path // TODO keep the relative path? as declared in /package.json. see getPackageResolution "resolve relative file path"
+        return v
+      })() :
+      resolvedVersion.version
+    )
+    diffHeader += `#   ${packageDetails.name}: ${declaredPackageStr}\n`
+    /* redundant. this is visible from command, sample: npx patch-package wrap-ansi/string-width -> packageNames: wrap-ansi, string-width
     if (packageDetails.packageNames.length > 1) {
       diffHeader += `#\n`
       diffHeader += `# package names:\n`
       packageDetails.packageNames.forEach((packageName) => {
         diffHeader += `#   ${packageName}\n`
       })
     }
+    */
     diffHeader += `#\n`
 
     const patchFileName = createPatchFileName({
@@ -438,18 +510,9 @@ function createPatchFileName({
   packageDetails: PackageDetails
   packageVersion: string
 }) {
-  const packageVersionFilename = packageVersion.includes("#")
-    ? packageVersion.split("#")[1] // extract commit hash
-    : packageVersion.replace(/\//g, "_")
-  if (isVerbose) {
-    console.log(
-      `patch-package/makePatch: packageVersion ${packageVersion} -> packageVersionFilename ${packageVersionFilename}`,
-    )
-  }
-
   const packageNames = packageDetails.packageNames
     .map((name) => name.replace(/\//g, "+"))
     .join("++")
 
-  return `${packageNames}+${packageVersionFilename}.patch`
+  return `${packageNames}+${packageVersion}.patch`
 }