Merge pull request #20 from BitGo/VL-4112-support-go-platform-duple

feat: support Go standard for target platform

Author: andrew-scott-fischer

dist/index.js

@@ -1,6 +1,7 @@
 import type { Octokit } from "./octokit";
 import { isEqual, isSome, none, Option, some } from "./option";
 import { stripTargetTriple } from "./platform";
+import type { TargetDuple } from "./types";
 
 import {
   isExactSemanticVersion,
@@ -127,62 +128,104 @@ type ReleaseAssetMetadata = {
   url: string;
 };
 
-export async function fetchReleaseAssetMetadataFromTag(
-  octokit: Octokit,
+/**
+ * Type for GitHub release metadata required by our function
+ */
+export type ReleaseMetadataResponse = {
+  data: {
+    assets: Array<{
+      label?: string | null;
+      url: string;
+      // Other fields may exist but we don't use them
+    }>;
+  };
+};
+
+/**
+ * Extract matching asset metadata from release assets based on target platform format
+ */
+export function findMatchingReleaseAssetMetadata(
+  releaseMetadata: ReleaseMetadataResponse,
   slug: RepositorySlug,
   binaryName: Option<BinaryName>,
   tag: ExactSemanticVersion,
   targetTriple: TargetTriple,
-): Promise<ReleaseAssetMetadata> {
-  // Maintainer's note: this impure function call makes this function difficult to test.
-  const releaseMetadata = await octokit.rest.repos.getReleaseByTag({
-    owner: slug.owner,
-    repo: slug.repository,
-    tag,
-  });
-
-  // When the binary name is provided, look for matching binary and target triple.
+  targetDuple: TargetDuple,
+): ReleaseAssetMetadata {
+  // When the binary name is provided, look for matching binary with target triple or target duple
   if (isSome(binaryName)) {
-    const targetLabel = `${binaryName.value}-${targetTriple}`;
+    const targetLabelTraditional = `${binaryName.value}-${targetTriple}`;
+    const targetLabelDuple = `${binaryName.value}-${targetDuple}`;
+
     const asset = releaseMetadata.data.assets.find(
-      (asset) => asset.label === targetLabel,
+      (asset) =>
+        typeof asset.label === "string" &&
+        (asset.label === targetLabelTraditional || asset.label === targetLabelDuple),
     );
+
     if (asset === undefined) {
       throw new Error(
-        `Expected to find asset in release ${slug.owner}/${slug.repository}@${tag} with label ${targetLabel}`,
+        `Expected to find asset in release ${slug.owner}/${slug.repository}@${tag} with label ${targetLabelTraditional} or ${targetLabelDuple}`,
       );
     }
+
     return {
       binaryName: binaryName,
       url: asset.url,
     };
   }
 
-  // When the binary name is not provided, support two use cases:
+  // When the binary name is not provided, support these use cases:
   // 1. There is only one binary uploaded to this release, a named binary.
-  // 2. There is an asset label matching the target triple (with no binary name).
+  // 2. There is an asset label matching the target triple or target duple.
   // In both cases, we assume that's the binary the user meant.
   // If there is ambiguity, exit with an error.
-  const matchingTargetTriples = releaseMetadata.data.assets.filter(
+  const matchingAssets = releaseMetadata.data.assets.filter(
     (asset) =>
-      typeof asset.label === "string" && asset.label.endsWith(targetTriple),
+      typeof asset.label === "string" &&
+      (asset.label.endsWith(targetTriple) || asset.label.endsWith(targetDuple)),
   );
-  if (matchingTargetTriples.length === 0) {
+  if (matchingAssets.length === 0) {
     throw new Error(
-      `Expected to find asset in release ${slug.owner}/${slug.repository}@${tag} with label ending in ${targetTriple}`,
+      `Expected to find asset in release ${slug.owner}/${slug.repository}@${tag} with label ending in ${targetTriple} or ${targetDuple}`,
     );
   }
-  if (matchingTargetTriples.length > 1) {
+  if (matchingAssets.length > 1) {
     throw new Error(
-      `Ambiguous targets: expected to find a single asset in release ${slug.owner}/${slug.repository}@${tag} matching target triple ${targetTriple}, but found ${matchingTargetTriples.length}.
+      `Ambiguous targets: expected to find a single asset in release ${slug.owner}/${slug.repository}@${tag} matching target triple ${targetTriple} or target duple ${targetDuple}, but found ${matchingAssets.length}.
 
 To resolve, specify the desired binary with the target format ${slug.owner}/${slug.repository}/<binary-name>@${tag}`,
     );
   }
-  const asset = matchingTargetTriples.shift()!;
+  const asset = matchingAssets.shift()!;
   const targetName = stripTargetTriple(asset.label!);
   return {
     binaryName: targetName,
     url: asset.url,
   };
 }
+
+export async function fetchReleaseAssetMetadataFromTag(
+  octokit: Octokit,
+  slug: RepositorySlug,
+  binaryName: Option<BinaryName>,
+  tag: ExactSemanticVersion,
+  targetTriple: TargetTriple,
+  targetDuple: TargetDuple,
+): Promise<ReleaseAssetMetadata> {
+  // Maintainer's note: this impure function call makes this function difficult to test.
+  const releaseMetadata = await octokit.rest.repos.getReleaseByTag({
+    owner: slug.owner,
+    repo: slug.repository,
+    tag,
+  });
+
+  return findMatchingReleaseAssetMetadata(
+    releaseMetadata,
+    slug,
+    binaryName,
+    tag,
+    targetTriple,
+    targetDuple,
+  );
+}

src/fetch.ts

@@ -13,7 +13,7 @@ import {
   parseTargetReleases,
   parseToken,
 } from "./parse";
-import { getTargetTriple } from "./platform";
+import { getTargetTriple, getTargetDuple } from "./platform";
 import {
   fetchReleaseAssetMetadataFromTag,
   findExactSemanticVersionTag,
@@ -48,7 +48,10 @@ async function installGitHubReleaseBinary(
   token: string,
   ignoreExisting: boolean,
 ): Promise<void> {
-  const targetTriple = getTargetTriple(arch(), platform());
+  const currentArch = arch();
+  const currentPlatform = platform();
+  const targetTriple = getTargetTriple(currentArch, currentPlatform);
+  const targetDuple = getTargetDuple(currentArch, currentPlatform);
 
   const releaseTag = await findExactSemanticVersionTag(
     octokit,
@@ -60,8 +63,8 @@ async function installGitHubReleaseBinary(
     storageDirectory,
     targetRelease.slug,
     releaseTag,
-    platform(),
-    arch(),
+    currentPlatform,
+    currentArch,
   );
 
   const releaseAsset = await fetchReleaseAssetMetadataFromTag(
@@ -70,6 +73,7 @@ async function installGitHubReleaseBinary(
     targetRelease.binaryName,
     releaseTag,
     targetTriple,
+    targetDuple,
   );
 
   const destinationBasename = unwrapOrDefault(