chore: add support for sha256 checksums in target specification

Author: EricCrosson

src/parse.ts

@@ -1,13 +1,15 @@
 import { Either, error, isOk, ok } from "./either";
-import type { SemanticVersion, TargetRelease } from "./types";
+import { none, some } from "./option";
+import type { SemanticVersion, Sha256Hash, TargetRelease } from "./types";
 
 const regexes = {
   owner: /\S+/,
   repository: /\S+/,
-  majorSemanticVersion: /v(0|[1-9]\d*)/,
-  majorMinorSemanticVersion: /v(0|[1-9]\d*)\.(0|[1-9]\d*)/,
+  majorSemanticVersion: /v(?:0|[1-9]\d*)/,
+  majorMinorSemanticVersion: /v(?:0|[1-9]\d*)\.(?:0|[1-9]\d*)/,
   exactSemanticVersion:
-    /v(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?/,
+    /v(?:0|[1-9]\d*)\.(?:0|[1-9]\d*)\.(?:0|[1-9]\d*)(?:-(?:(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+(?:[0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?/,
+  sha256Hash: /[a-fA-F0-9]{64}/,
 };
 
 export function parseEnvironmentVariable(envVarName: string): Either<string> {
@@ -39,21 +41,24 @@ function parseTargetReleaseVersion(value: string): Either<TargetRelease> {
     majorSemanticVersion,
     majorMinorSemanticVersion,
     exactSemanticVersion,
+    sha256Hash,
   } = regexes;
   const regex = new RegExp(
-    `^(${owner.source})/(${repository.source})@(${majorSemanticVersion.source}|${majorMinorSemanticVersion.source}|${exactSemanticVersion.source})$`
+    `^(${owner.source})/(${repository.source})@(${majorSemanticVersion.source}|${majorMinorSemanticVersion.source}|${exactSemanticVersion.source})(?::sha256-(${sha256Hash.source}))?$`
   );
   const match = value.match(regex);
   if (match === null) {
     // This error message is never used
     return error(["not a valid target release"]);
   }
+  console.log(match);
   const target: TargetRelease = {
     slug: {
       owner: match[1] as string,
       repository: match[2] as string,
     },
     tag: match[3] as SemanticVersion,
+    checksum: match[4] !== undefined ? some(match[4] as Sha256Hash) : none(),
   };
   return ok(target);
 }

src/types.ts

@@ -1,3 +1,5 @@
+import type { Option } from "./option";
+
 /**
  * The following formats are valid:
  * - v1
@@ -22,6 +24,7 @@ export function isExactSemanticVersion(
 }
 
 export type Sha1Hash = string & { readonly __tag: unique symbol };
+export type Sha256Hash = string & { readonly __tag: unique symbol };
 
 export type RepositorySlug = {
   owner: string;
@@ -33,4 +36,5 @@ export type TargetTriple = string & { readonly __tag: unique symbol };
 export type TargetRelease = {
   slug: RepositorySlug;
   tag: SemanticVersion;
+  checksum: Option<Sha256Hash>;
 };

test/test-parse-target-release.ts

@@ -3,7 +3,8 @@ import assert from "node:assert/strict";
 
 import { parseTargetReleases } from "../src/parse";
 import { Either, error, isErr, isOk, ok } from "../src/either";
-import type { SemanticVersion, TargetRelease } from "../src/types";
+import type { SemanticVersion, Sha256Hash, TargetRelease } from "../src/types";
+import { none, some } from "../src/option";
 
 function err<A>(): Either<A> {
   return error([""]);
@@ -45,6 +46,26 @@ test(
           repository: "bar",
         },
         tag: "v1" as SemanticVersion,
+        checksum: none(),
+      },
+    ])
+  )
+);
+
+test(
+  "should parse a slug and version and regex",
+  check(
+    "foo/bar@v1:sha256-8a4600be96d2ec013209042458ce97a9652fcc46c1c855d0217aa42e330fc06e",
+    ok([
+      {
+        slug: {
+          owner: "foo",
+          repository: "bar",
+        },
+        tag: "v1" as SemanticVersion,
+        checksum: some(
+          "8a4600be96d2ec013209042458ce97a9652fcc46c1c855d0217aa42e330fc06e" as Sha256Hash
+        ),
       },
     ])
   )
@@ -61,13 +82,15 @@ test(
           repository: "bar",
         },
         tag: "v1" as SemanticVersion,
+        checksum: none(),
       },
       {
         slug: {
           owner: "qux",
           repository: "baz",
         },
         tag: "v2.3.4" as SemanticVersion,
+        checksum: none(),
       },
     ])
   )
@@ -85,13 +108,15 @@ test(
           repository: "bar",
         },
         tag: "v1" as SemanticVersion,
+        checksum: none(),
       },
       {
         slug: {
           owner: "qux",
           repository: "baz",
         },
         tag: "v2.3.4" as SemanticVersion,
+        checksum: none(),
       },
     ])
   )
@@ -110,13 +135,15 @@ test(
           repository: "bar",
         },
         tag: "v1" as SemanticVersion,
+        checksum: none(),
       },
       {
         slug: {
           owner: "qux",
           repository: "baz",
         },
         tag: "v2.3.4" as SemanticVersion,
+        checksum: none(),
       },
     ])
   )