@shopify/cli-kit 3.76.2 → 3.77.1

package/dist/public/node/environment.d.ts

@@ -56,3 +56,23 @@ export declare function jsonOutputEnabled(environment?: NodeJS.ProcessEnv): bool
  * @returns True if the SHOPIFY_CLI_NEVER_USE_PARTNERS_API environment variable is set.
  */
 export declare function blockPartnersAccess(): boolean;
+/**
+ * If true, the CLI should not use the network level retry.
+ *
+ * If there is an error when calling a network API that looks like a DNS or connectivity issue, the CLI will by default
+ * automatically retry the request.
+ *
+ * @param environment - Process environment variables.
+ * @returns True if the SHOPIFY_CLI_SKIP_NETWORK_LEVEL_RETRY environment variable is set.
+ */
+export declare function skipNetworkLevelRetry(environment?: NodeJS.ProcessEnv): boolean;
+/**
+ * Returns the default maximum request time for network calls in milliseconds.
+ *
+ * After this long, API requests may be cancelled by an AbortSignal. The limit can be overridden by setting the
+ * SHOPIFY_CLI_MAX_REQUEST_TIME_FOR_NETWORK_CALLS environment variable.
+ *
+ * @param environment - Process environment variables.
+ * @returns The maximum request time in milliseconds.
+ */
+export declare function maxRequestTimeForNetworkCallsMs(environment?: NodeJS.ProcessEnv): number;

package/dist/public/node/environment.js

@@ -84,4 +84,33 @@ export function jsonOutputEnabled(environment = getEnvironmentVariables()) {
 export function blockPartnersAccess() {
     return isTruthy(getEnvironmentVariables()[environmentVariables.neverUsePartnersApi]);
 }
+/**
+ * If true, the CLI should not use the network level retry.
+ *
+ * If there is an error when calling a network API that looks like a DNS or connectivity issue, the CLI will by default
+ * automatically retry the request.
+ *
+ * @param environment - Process environment variables.
+ * @returns True if the SHOPIFY_CLI_SKIP_NETWORK_LEVEL_RETRY environment variable is set.
+ */
+export function skipNetworkLevelRetry(environment = getEnvironmentVariables()) {
+    return isTruthy(environment[environmentVariables.skipNetworkLevelRetry]);
+}
+/**
+ * Returns the default maximum request time for network calls in milliseconds.
+ *
+ * After this long, API requests may be cancelled by an AbortSignal. The limit can be overridden by setting the
+ * SHOPIFY_CLI_MAX_REQUEST_TIME_FOR_NETWORK_CALLS environment variable.
+ *
+ * @param environment - Process environment variables.
+ * @returns The maximum request time in milliseconds.
+ */
+export function maxRequestTimeForNetworkCallsMs(environment = getEnvironmentVariables()) {
+    const maxRequestTime = environment[environmentVariables.maxRequestTimeForNetworkCalls];
+    if (maxRequestTime && !isNaN(Number(maxRequestTime))) {
+        return Number(maxRequestTime);
+    }
+    // 15 seconds is the default
+    return 15 * 1000;
+}
 //# sourceMappingURL=environment.js.map

package/dist/public/node/environment.js.map

@@ -1 +1 @@
-{"version":3,"file":"environment.js","sourceRoot":"","sources":["../../../src/public/node/environment.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAC,MAAM,aAAa,CAAA;AACzC,OAAO,EAAC,QAAQ,EAAC,MAAM,wBAAwB,CAAA;AAC/C,OAAO,EAAC,YAAY,EAAC,MAAM,WAAW,CAAA;AACtC,OAAO,EAAC,oBAAoB,EAAE,0BAA0B,EAAC,MAAM,iCAAiC,CAAA;AAEhG;;;;;;;;;GASG;AACH,MAAM,UAAU,uBAAuB;IACrC,OAAO,OAAO,CAAC,GAAG,CAAA;AACpB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,gBAAgB;IAC9B,OAAO,uBAAuB,EAAE,CAAC,oBAAoB,CAAC,aAAa,CAAC,CAAA;AACtE,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,gBAAgB;IAC9B,OAAO,gBAAgB,EAAE,KAAK,SAAS,CAAA;AACzC,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,eAAe;IAC7B,OAAO,uBAAuB,EAAE,CAAC,oBAAoB,CAAC,YAAY,CAAC,CAAA;AACrE,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,cAAc;IAC5B,MAAM,WAAW,GAAG,uBAAuB,EAAE,CAAC,0BAA0B,CAAC,WAAW,CAAC,CAAA;IACrF,IAAI,WAAW,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC;QAC/C,OAAO,MAAM,CAAC,WAAW,CAAC,CAAA;IAC5B,CAAC;IACD,OAAO,SAAS,CAAA;AAClB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,2BAA2B;IACzC,MAAM,aAAa,GAAG,uBAAuB,EAAE,CAAC,oBAAoB,CAAC,aAAa,CAAC,CAAA;IACnF,MAAM,YAAY,GAAG,uBAAuB,EAAE,CAAC,oBAAoB,CAAC,YAAY,CAAC,CAAA;IACjF,IAAI,CAAC,aAAa,IAAI,CAAC,YAAY;QAAE,OAAO,SAAS,CAAA;IACrD,OAAO;QACL,WAAW,EAAE,aAAa;QAC1B,YAAY;QACZ,MAAM,EAAE,aAAa,CAAC,aAAa,CAAC;KACrC,CAAA;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAC,WAAW,GAAG,uBAAuB,EAAE;IACvE,OAAO,YAAY,EAAE,IAAI,QAAQ,CAAC,WAAW,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAA;AAC3E,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,mBAAmB;IACjC,OAAO,QAAQ,CAAC,uBAAuB,EAAE,CAAC,oBAAoB,CAAC,mBAAmB,CAAC,CAAC,CAAA;AACtF,CAAC","sourcesContent":["import {nonRandomUUID} from './crypto.js'\nimport {isTruthy} from './context/utilities.js'\nimport {sniffForJson} from './path.js'\nimport {environmentVariables, systemEnvironmentVariables} from '../../private/node/constants.js'\n\n/**\n * It returns the environment variables of the environment\n * where the Node process is running.\n *\n * This function exists to prevent the access of the process\n * global variable which is discouraged via the no-process-env\n * ESLint rule.\n *\n * @returns Current process environment variables.\n */\nexport function getEnvironmentVariables(): NodeJS.ProcessEnv {\n  return process.env\n}\n\n/**\n * Returns the value of the SHOPIFY_CLI_PARTNERS_TOKEN environment variable.\n *\n * @returns Current process environment variables.\n */\nexport function getPartnersToken(): string | undefined {\n  return getEnvironmentVariables()[environmentVariables.partnersToken]\n}\n\n/**\n * Check if the current proccess is running using the partners token.\n *\n * @returns True if the current proccess is running using the partners token.\n */\nexport function usePartnersToken(): boolean {\n  return getPartnersToken() !== undefined\n}\n\n/**\n * Returns the value of the organization id from the environment variables.\n *\n * @returns True if the current proccess is running using the partners token.\n */\nexport function getOrganization(): string | undefined {\n  return getEnvironmentVariables()[environmentVariables.organization]\n}\n\n/**\n * Return the backend port value.\n *\n * @returns The port as a number. Undefined otherwise.\n */\nexport function getBackendPort(): number | undefined {\n  const backendPort = getEnvironmentVariables()[systemEnvironmentVariables.backendPort]\n  if (backendPort && !isNaN(Number(backendPort))) {\n    return Number(backendPort)\n  }\n  return undefined\n}\n\n/**\n * Returns the information of the identity & refresh tokens, provided by environment variables.\n *\n * @returns The identity token information in case it exists.\n */\nexport function getIdentityTokenInformation(): {accessToken: string; refreshToken: string; userId: string} | undefined {\n  const identityToken = getEnvironmentVariables()[environmentVariables.identityToken]\n  const refreshToken = getEnvironmentVariables()[environmentVariables.refreshToken]\n  if (!identityToken || !refreshToken) return undefined\n  return {\n    accessToken: identityToken,\n    refreshToken,\n    userId: nonRandomUUID(identityToken),\n  }\n}\n\n/**\n * Checks if the JSON output is enabled via flag (--json or -j) or environment variable (SHOPIFY_FLAG_JSON).\n *\n * @param environment - Process environment variables.\n * @returns True if the JSON output is enabled, false otherwise.\n */\nexport function jsonOutputEnabled(environment = getEnvironmentVariables()): boolean {\n  return sniffForJson() || isTruthy(environment[environmentVariables.json])\n}\n\n/**\n * If true, the CLI should not use the Partners API.\n *\n * @returns True if the SHOPIFY_CLI_NEVER_USE_PARTNERS_API environment variable is set.\n */\nexport function blockPartnersAccess(): boolean {\n  return isTruthy(getEnvironmentVariables()[environmentVariables.neverUsePartnersApi])\n}\n"]}
+{"version":3,"file":"environment.js","sourceRoot":"","sources":["../../../src/public/node/environment.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAC,MAAM,aAAa,CAAA;AACzC,OAAO,EAAC,QAAQ,EAAC,MAAM,wBAAwB,CAAA;AAC/C,OAAO,EAAC,YAAY,EAAC,MAAM,WAAW,CAAA;AACtC,OAAO,EAAC,oBAAoB,EAAE,0BAA0B,EAAC,MAAM,iCAAiC,CAAA;AAEhG;;;;;;;;;GASG;AACH,MAAM,UAAU,uBAAuB;IACrC,OAAO,OAAO,CAAC,GAAG,CAAA;AACpB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,gBAAgB;IAC9B,OAAO,uBAAuB,EAAE,CAAC,oBAAoB,CAAC,aAAa,CAAC,CAAA;AACtE,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,gBAAgB;IAC9B,OAAO,gBAAgB,EAAE,KAAK,SAAS,CAAA;AACzC,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,eAAe;IAC7B,OAAO,uBAAuB,EAAE,CAAC,oBAAoB,CAAC,YAAY,CAAC,CAAA;AACrE,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,cAAc;IAC5B,MAAM,WAAW,GAAG,uBAAuB,EAAE,CAAC,0BAA0B,CAAC,WAAW,CAAC,CAAA;IACrF,IAAI,WAAW,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC;QAC/C,OAAO,MAAM,CAAC,WAAW,CAAC,CAAA;IAC5B,CAAC;IACD,OAAO,SAAS,CAAA;AAClB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,2BAA2B;IACzC,MAAM,aAAa,GAAG,uBAAuB,EAAE,CAAC,oBAAoB,CAAC,aAAa,CAAC,CAAA;IACnF,MAAM,YAAY,GAAG,uBAAuB,EAAE,CAAC,oBAAoB,CAAC,YAAY,CAAC,CAAA;IACjF,IAAI,CAAC,aAAa,IAAI,CAAC,YAAY;QAAE,OAAO,SAAS,CAAA;IACrD,OAAO;QACL,WAAW,EAAE,aAAa;QAC1B,YAAY;QACZ,MAAM,EAAE,aAAa,CAAC,aAAa,CAAC;KACrC,CAAA;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAC,WAAW,GAAG,uBAAuB,EAAE;IACvE,OAAO,YAAY,EAAE,IAAI,QAAQ,CAAC,WAAW,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAA;AAC3E,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,mBAAmB;IACjC,OAAO,QAAQ,CAAC,uBAAuB,EAAE,CAAC,oBAAoB,CAAC,mBAAmB,CAAC,CAAC,CAAA;AACtF,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,qBAAqB,CAAC,WAAW,GAAG,uBAAuB,EAAE;IAC3E,OAAO,QAAQ,CAAC,WAAW,CAAC,oBAAoB,CAAC,qBAAqB,CAAC,CAAC,CAAA;AAC1E,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,+BAA+B,CAAC,WAAW,GAAG,uBAAuB,EAAE;IACrF,MAAM,cAAc,GAAG,WAAW,CAAC,oBAAoB,CAAC,6BAA6B,CAAC,CAAA;IACtF,IAAI,cAAc,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC;QACrD,OAAO,MAAM,CAAC,cAAc,CAAC,CAAA;IAC/B,CAAC;IACD,4BAA4B;IAC5B,OAAO,EAAE,GAAG,IAAI,CAAA;AAClB,CAAC","sourcesContent":["import {nonRandomUUID} from './crypto.js'\nimport {isTruthy} from './context/utilities.js'\nimport {sniffForJson} from './path.js'\nimport {environmentVariables, systemEnvironmentVariables} from '../../private/node/constants.js'\n\n/**\n * It returns the environment variables of the environment\n * where the Node process is running.\n *\n * This function exists to prevent the access of the process\n * global variable which is discouraged via the no-process-env\n * ESLint rule.\n *\n * @returns Current process environment variables.\n */\nexport function getEnvironmentVariables(): NodeJS.ProcessEnv {\n  return process.env\n}\n\n/**\n * Returns the value of the SHOPIFY_CLI_PARTNERS_TOKEN environment variable.\n *\n * @returns Current process environment variables.\n */\nexport function getPartnersToken(): string | undefined {\n  return getEnvironmentVariables()[environmentVariables.partnersToken]\n}\n\n/**\n * Check if the current proccess is running using the partners token.\n *\n * @returns True if the current proccess is running using the partners token.\n */\nexport function usePartnersToken(): boolean {\n  return getPartnersToken() !== undefined\n}\n\n/**\n * Returns the value of the organization id from the environment variables.\n *\n * @returns True if the current proccess is running using the partners token.\n */\nexport function getOrganization(): string | undefined {\n  return getEnvironmentVariables()[environmentVariables.organization]\n}\n\n/**\n * Return the backend port value.\n *\n * @returns The port as a number. Undefined otherwise.\n */\nexport function getBackendPort(): number | undefined {\n  const backendPort = getEnvironmentVariables()[systemEnvironmentVariables.backendPort]\n  if (backendPort && !isNaN(Number(backendPort))) {\n    return Number(backendPort)\n  }\n  return undefined\n}\n\n/**\n * Returns the information of the identity & refresh tokens, provided by environment variables.\n *\n * @returns The identity token information in case it exists.\n */\nexport function getIdentityTokenInformation(): {accessToken: string; refreshToken: string; userId: string} | undefined {\n  const identityToken = getEnvironmentVariables()[environmentVariables.identityToken]\n  const refreshToken = getEnvironmentVariables()[environmentVariables.refreshToken]\n  if (!identityToken || !refreshToken) return undefined\n  return {\n    accessToken: identityToken,\n    refreshToken,\n    userId: nonRandomUUID(identityToken),\n  }\n}\n\n/**\n * Checks if the JSON output is enabled via flag (--json or -j) or environment variable (SHOPIFY_FLAG_JSON).\n *\n * @param environment - Process environment variables.\n * @returns True if the JSON output is enabled, false otherwise.\n */\nexport function jsonOutputEnabled(environment = getEnvironmentVariables()): boolean {\n  return sniffForJson() || isTruthy(environment[environmentVariables.json])\n}\n\n/**\n * If true, the CLI should not use the Partners API.\n *\n * @returns True if the SHOPIFY_CLI_NEVER_USE_PARTNERS_API environment variable is set.\n */\nexport function blockPartnersAccess(): boolean {\n  return isTruthy(getEnvironmentVariables()[environmentVariables.neverUsePartnersApi])\n}\n\n/**\n * If true, the CLI should not use the network level retry.\n *\n * If there is an error when calling a network API that looks like a DNS or connectivity issue, the CLI will by default\n * automatically retry the request.\n *\n * @param environment - Process environment variables.\n * @returns True if the SHOPIFY_CLI_SKIP_NETWORK_LEVEL_RETRY environment variable is set.\n */\nexport function skipNetworkLevelRetry(environment = getEnvironmentVariables()): boolean {\n  return isTruthy(environment[environmentVariables.skipNetworkLevelRetry])\n}\n\n/**\n * Returns the default maximum request time for network calls in milliseconds.\n *\n * After this long, API requests may be cancelled by an AbortSignal. The limit can be overridden by setting the\n * SHOPIFY_CLI_MAX_REQUEST_TIME_FOR_NETWORK_CALLS environment variable.\n *\n * @param environment - Process environment variables.\n * @returns The maximum request time in milliseconds.\n */\nexport function maxRequestTimeForNetworkCallsMs(environment = getEnvironmentVariables()): number {\n  const maxRequestTime = environment[environmentVariables.maxRequestTimeForNetworkCalls]\n  if (maxRequestTime && !isNaN(Number(maxRequestTime))) {\n    return Number(maxRequestTime)\n  }\n  // 15 seconds is the default\n  return 15 * 1000\n}\n"]}

package/dist/public/node/github.d.ts

@@ -47,4 +47,5 @@ export interface GithubRepositoryReference {
  * @param reference - A GitHub repository URL (e.g. https://github.com/Shopify/cli/blob/main/package.json)
  */
 export declare function parseGitHubRepositoryReference(reference: string): GithubRepositoryReference;
+export declare function downloadGitHubRelease(repo: string, version: string, assetName: string, targetPath: string): Promise<void>;
 export {};

package/dist/public/node/github.js

@@ -1,7 +1,11 @@
 /* eslint-disable @typescript-eslint/no-non-null-assertion */
 import { err, ok } from './result.js';
 import { fetch } from './http.js';
-import { outputContent, outputDebug } from '../../public/node/output.js';
+import { writeFile, mkdir, inTemporaryDirectory, moveFile, chmod } from './fs.js';
+import { dirname, joinPath } from './path.js';
+import { runWithTimer } from './metadata.js';
+import { AbortError } from './error.js';
+import { outputContent, outputDebug, outputToken } from '../../public/node/output.js';
 class GitHubClientError extends Error {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     constructor(url, statusCode, bodyJson) {
@@ -41,7 +45,7 @@ export function parseGitHubRepositoryURL(url) {
         ];
         return err(new Error(`Parsing the url ${url} failed. Supported formats are ${exampleFormats.join(', ')}.`));
     }
-    const site = match[1] || match[2] || match[3] || 'github.com';
+    const site = match[1] ?? match[2] ?? match[3] ?? 'github.com';
     const normalizedSite = site === 'github' ? 'github.com' : site;
     const user = match[4];
     const name = match[5].replace(/\.git$/, '');
@@ -70,4 +74,29 @@ export function parseGitHubRepositoryReference(reference) {
         filePath,
     };
 }
+export async function downloadGitHubRelease(repo, version, assetName, targetPath) {
+    const url = `https://github.com/${repo}/releases/download/${version}/${assetName}`;
+    return runWithTimer('cmd_all_timing_network_ms')(async () => {
+        outputDebug(outputContent `Downloading ${outputToken.link(assetName, url)}`);
+        await inTemporaryDirectory(async (tmpDir) => {
+            const tempPath = joinPath(tmpDir, assetName);
+            let response;
+            try {
+                response = await fetch(url);
+                if (!response.ok) {
+                    throw new AbortError(`Failed to download ${assetName}: ${response.statusText}`);
+                }
+            }
+            catch (error) {
+                throw new AbortError(`Failed to download ${assetName}: ${error instanceof Error ? error.message : 'unknown error'}`);
+            }
+            const buffer = await response.arrayBuffer();
+            await writeFile(tempPath, Buffer.from(buffer));
+            await chmod(tempPath, 0o755);
+            await mkdir(dirname(targetPath));
+            await moveFile(tempPath, targetPath);
+        });
+        outputDebug(outputContent `${outputToken.successIcon()} Successfully downloaded ${outputToken.path(targetPath)}`);
+    });
+}
 //# sourceMappingURL=github.js.map

package/dist/public/node/github.js.map

@@ -1 +1 @@
-{"version":3,"file":"github.js","sourceRoot":"","sources":["../../../src/public/node/github.ts"],"names":[],"mappings":"AAAA,6DAA6D;AAC7D,OAAO,EAAC,GAAG,EAAE,EAAE,EAAS,MAAM,aAAa,CAAA;AAC3C,OAAO,EAAC,KAAK,EAAC,MAAM,WAAW,CAAA;AAC/B,OAAO,EAAC,aAAa,EAAE,WAAW,EAAC,MAAM,6BAA6B,CAAA;AAEtE,MAAM,iBAAkB,SAAQ,KAAK;IACnC,8DAA8D;IAC9D,YAAY,GAAW,EAAE,UAAkB,EAAE,QAAa;QACxD,KAAK,CACH,iCAAiC,GAAG,4BAA4B,UAAU,qCAAqC,QAAQ,CAAC,OAAO,EAAE,CAClI,CAAA;IACH,CAAC;CACF;AAmBD;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,KAAa,EACb,IAAY,EACZ,UAAyC,EAAC,MAAM,EAAE,GAAG,EAAE,CAAC,IAAI,EAAC;IAE7D,WAAW,CAAC,aAAa,CAAA,mDAAmD,KAAK,IAAI,IAAI,KAAK,CAAC,CAAA;IAC/F,MAAM,GAAG,GAAG,gCAAgC,KAAK,IAAI,IAAI,WAAW,CAAA;IACpE,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,CAAA;IACpC,8DAA8D;IAC9D,MAAM,QAAQ,GAAQ,MAAM,WAAW,CAAC,IAAI,EAAE,CAAA;IAE9C,IAAI,WAAW,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;QAC/B,MAAM,IAAI,iBAAiB,CAAC,GAAG,EAAE,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;IAChE,CAAC;IAED,OAAO,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;AACtC,CAAC;AAaD;;;GAGG;AACH,MAAM,UAAU,wBAAwB,CAAC,GAAW;IAClD,MAAM,KAAK,GACT,+HAA+H,CAAC,IAAI,CAClI,GAAG,CACJ,CAAA;IAEH,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,cAAc,GAAG;YACrB,kBAAkB;YAClB,wBAAwB;YACxB,0BAA0B;YAC1B,eAAe;YACf,8BAA8B;SAC/B,CAAA;QAED,OAAO,GAAG,CAAC,IAAI,KAAK,CAAC,mBAAmB,GAAG,kCAAkC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAA;IAC7G,CAAC;IAED,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,IAAI,YAAY,CAAA;IAC7D,MAAM,cAAc,GAAG,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAA;IAC9D,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAE,CAAA;IACtB,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAE,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAA;IAC5C,kFAAkF;IAClF,MAAM,YAAY,GAAG,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAE,CAAA;IACxC,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAE,CAAA;IACrB,MAAM,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAA;IACnC,MAAM,GAAG,GAAG,OAAO,cAAc,IAAI,IAAI,IAAI,IAAI,EAAE,CAAA;IACnD,MAAM,IAAI,GAAG,WAAW,cAAc,IAAI,IAAI,IAAI,IAAI,EAAE,CAAA;IACxD,MAAM,IAAI,GAAG,CAAC,SAAS,EAAE,cAAc,EAAE,IAAI,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;IAE3F,OAAO,EAAE,CAAC,EAAC,IAAI,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,YAAY,EAAE,GAAG,EAAE,IAAI,EAAC,CAAC,CAAA;AACnF,CAAC;AAQD;;;;GAIG;AACH,MAAM,UAAU,8BAA8B,CAAC,SAAiB;IAC9D,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAA;IAC9B,MAAM,MAAM,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IACvD,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,QAAQ,CAAC,GAAG,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAC5D,MAAM,QAAQ,GAAG,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IAErE,OAAO;QACL,OAAO,EAAE,GAAG,GAAG,CAAC,MAAM,IAAI,IAAI,IAAI,IAAI,EAAE;QACxC,MAAM;QACN,QAAQ;KACT,CAAA;AACH,CAAC","sourcesContent":["/* eslint-disable @typescript-eslint/no-non-null-assertion */\nimport {err, ok, Result} from './result.js'\nimport {fetch} from './http.js'\nimport {outputContent, outputDebug} from '../../public/node/output.js'\n\nclass GitHubClientError extends Error {\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  constructor(url: string, statusCode: number, bodyJson: any) {\n    super(\n      `The request to GitHub API URL ${url} failed with status code ${statusCode} and the following error message: ${bodyJson.message}`,\n    )\n  }\n}\n\nexport interface GithubRelease {\n  id: number\n  url: string\n  tag_name: string\n  name: string\n  body: string\n  draft: boolean\n  prerelease: boolean\n  created_at: string\n  published_at: string\n  tarball_url: string\n}\n\ninterface GetLatestGitHubReleaseOptions {\n  filter: (release: GithubRelease) => boolean\n}\n\n/**\n * Given a GitHub repository it obtains the latest release.\n * @param owner - Repository owner (e.g., shopify)\n * @param repo - Repository name (e.g., cli)\n * @param options - Options\n */\nexport async function getLatestGitHubRelease(\n  owner: string,\n  repo: string,\n  options: GetLatestGitHubReleaseOptions = {filter: () => true},\n): Promise<GithubRelease> {\n  outputDebug(outputContent`Getting the latest release of GitHub repository ${owner}/${repo}...`)\n  const url = `https://api.github.com/repos/${owner}/${repo}/releases`\n  const fetchResult = await fetch(url)\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  const jsonBody: any = await fetchResult.json()\n\n  if (fetchResult.status !== 200) {\n    throw new GitHubClientError(url, fetchResult.status, jsonBody)\n  }\n\n  return jsonBody.find(options.filter)\n}\n\ninterface ParseRepositoryURLOutput {\n  full: string\n  site: string\n  user: string\n  name: string\n  ref: string\n  subDirectory: string\n  ssh: string\n  http: string\n}\n\n/**\n * Given a GitHub repository URL, it parses it and returns its coomponents.\n * @param url - The GitHub repository URL\n */\nexport function parseGitHubRepositoryURL(url: string): Result<ParseRepositoryURLOutput, Error> {\n  const match =\n    /^(?:(?:https:\\/\\/)?([^:/]+\\.[^:/]+)\\/|git@([^:/]+)[:/]|([^/]+):)?([^/\\s]+)\\/([^/\\s#]+)(?:((?:\\/[^/\\s#]+)+))?(?:\\/)?(?:#(.+))?/.exec(\n      url,\n    )\n\n  if (!match) {\n    const exampleFormats = [\n      'github:user/repo',\n      'user/repo/subdirectory',\n      'git@github.com:user/repo',\n      'user/repo#dev',\n      'https://github.com/user/repo',\n    ]\n\n    return err(new Error(`Parsing the url ${url} failed. Supported formats are ${exampleFormats.join(', ')}.`))\n  }\n\n  const site = match[1] || match[2] || match[3] || 'github.com'\n  const normalizedSite = site === 'github' ? 'github.com' : site\n  const user = match[4]!\n  const name = match[5]!.replace(/\\.git$/, '')\n  // eslint-disable-next-line @typescript-eslint/no-non-null-asserted-optional-chain\n  const subDirectory = match[6]?.slice(1)!\n  const ref = match[7]!\n  const branch = ref ? `#${ref}` : ''\n  const ssh = `git@${normalizedSite}:${user}/${name}`\n  const http = `https://${normalizedSite}/${user}/${name}`\n  const full = ['https:/', normalizedSite, user, name, subDirectory].join('/').concat(branch)\n\n  return ok({full, site: normalizedSite, user, name, ref, subDirectory, ssh, http})\n}\n\nexport interface GithubRepositoryReference {\n  baseURL: string\n  branch?: string\n  filePath?: string\n}\n\n/**\n * Given a GitHub repository URL it parses it and extracts the branch, file path,\n * and base URL components\n * @param reference - A GitHub repository URL (e.g. https://github.com/Shopify/cli/blob/main/package.json)\n */\nexport function parseGitHubRepositoryReference(reference: string): GithubRepositoryReference {\n  const url = new URL(reference)\n  const branch = url.hash ? url.hash.slice(1) : undefined\n  const [_, user, repo, ...repoPath] = url.pathname.split('/')\n  const filePath = repoPath.length > 0 ? repoPath.join('/') : undefined\n\n  return {\n    baseURL: `${url.origin}/${user}/${repo}`,\n    branch,\n    filePath,\n  }\n}\n"]}
+{"version":3,"file":"github.js","sourceRoot":"","sources":["../../../src/public/node/github.ts"],"names":[],"mappings":"AAAA,6DAA6D;AAC7D,OAAO,EAAC,GAAG,EAAE,EAAE,EAAS,MAAM,aAAa,CAAA;AAC3C,OAAO,EAAC,KAAK,EAAW,MAAM,WAAW,CAAA;AACzC,OAAO,EAAC,SAAS,EAAE,KAAK,EAAE,oBAAoB,EAAE,QAAQ,EAAE,KAAK,EAAC,MAAM,SAAS,CAAA;AAC/E,OAAO,EAAC,OAAO,EAAE,QAAQ,EAAC,MAAM,WAAW,CAAA;AAC3C,OAAO,EAAC,YAAY,EAAC,MAAM,eAAe,CAAA;AAC1C,OAAO,EAAC,UAAU,EAAC,MAAM,YAAY,CAAA;AACrC,OAAO,EAAC,aAAa,EAAE,WAAW,EAAE,WAAW,EAAC,MAAM,6BAA6B,CAAA;AAEnF,MAAM,iBAAkB,SAAQ,KAAK;IACnC,8DAA8D;IAC9D,YAAY,GAAW,EAAE,UAAkB,EAAE,QAAa;QACxD,KAAK,CACH,iCAAiC,GAAG,4BAA4B,UAAU,qCAAqC,QAAQ,CAAC,OAAO,EAAE,CAClI,CAAA;IACH,CAAC;CACF;AAmBD;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,KAAa,EACb,IAAY,EACZ,UAAyC,EAAC,MAAM,EAAE,GAAG,EAAE,CAAC,IAAI,EAAC;IAE7D,WAAW,CAAC,aAAa,CAAA,mDAAmD,KAAK,IAAI,IAAI,KAAK,CAAC,CAAA;IAC/F,MAAM,GAAG,GAAG,gCAAgC,KAAK,IAAI,IAAI,WAAW,CAAA;IACpE,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,CAAA;IACpC,8DAA8D;IAC9D,MAAM,QAAQ,GAAQ,MAAM,WAAW,CAAC,IAAI,EAAE,CAAA;IAE9C,IAAI,WAAW,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;QAC/B,MAAM,IAAI,iBAAiB,CAAC,GAAG,EAAE,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;IAChE,CAAC;IAED,OAAO,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;AACtC,CAAC;AAaD;;;GAGG;AACH,MAAM,UAAU,wBAAwB,CAAC,GAAW;IAClD,MAAM,KAAK,GACT,+HAA+H,CAAC,IAAI,CAClI,GAAG,CACJ,CAAA;IAEH,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,cAAc,GAAG;YACrB,kBAAkB;YAClB,wBAAwB;YACxB,0BAA0B;YAC1B,eAAe;YACf,8BAA8B;SAC/B,CAAA;QAED,OAAO,GAAG,CAAC,IAAI,KAAK,CAAC,mBAAmB,GAAG,kCAAkC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAA;IAC7G,CAAC;IAED,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,IAAI,YAAY,CAAA;IAC7D,MAAM,cAAc,GAAG,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAA;IAC9D,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAE,CAAA;IACtB,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAE,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAA;IAC5C,kFAAkF;IAClF,MAAM,YAAY,GAAG,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAE,CAAA;IACxC,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAE,CAAA;IACrB,MAAM,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAA;IACnC,MAAM,GAAG,GAAG,OAAO,cAAc,IAAI,IAAI,IAAI,IAAI,EAAE,CAAA;IACnD,MAAM,IAAI,GAAG,WAAW,cAAc,IAAI,IAAI,IAAI,IAAI,EAAE,CAAA;IACxD,MAAM,IAAI,GAAG,CAAC,SAAS,EAAE,cAAc,EAAE,IAAI,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;IAE3F,OAAO,EAAE,CAAC,EAAC,IAAI,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,YAAY,EAAE,GAAG,EAAE,IAAI,EAAC,CAAC,CAAA;AACnF,CAAC;AAQD;;;;GAIG;AACH,MAAM,UAAU,8BAA8B,CAAC,SAAiB;IAC9D,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAA;IAC9B,MAAM,MAAM,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IACvD,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,QAAQ,CAAC,GAAG,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAC5D,MAAM,QAAQ,GAAG,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IAErE,OAAO;QACL,OAAO,EAAE,GAAG,GAAG,CAAC,MAAM,IAAI,IAAI,IAAI,IAAI,EAAE;QACxC,MAAM;QACN,QAAQ;KACT,CAAA;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,qBAAqB,CACzC,IAAY,EACZ,OAAe,EACf,SAAiB,EACjB,UAAkB;IAElB,MAAM,GAAG,GAAG,sBAAsB,IAAI,sBAAsB,OAAO,IAAI,SAAS,EAAE,CAAA;IAElF,OAAO,YAAY,CAAC,2BAA2B,CAAC,CAAC,KAAK,IAAI,EAAE;QAC1D,WAAW,CAAC,aAAa,CAAA,eAAe,WAAW,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,CAAC,EAAE,CAAC,CAAA;QAC3E,MAAM,oBAAoB,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;YAC1C,MAAM,QAAQ,GAAG,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;YAC5C,IAAI,QAAkB,CAAA;YACtB,IAAI,CAAC;gBACH,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,CAAA;gBAC3B,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;oBACjB,MAAM,IAAI,UAAU,CAAC,sBAAsB,SAAS,KAAK,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAA;gBACjF,CAAC;YACH,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,IAAI,UAAU,CAClB,sBAAsB,SAAS,KAAK,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,EAAE,CAC/F,CAAA;YACH,CAAC;YAED,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,WAAW,EAAE,CAAA;YAC3C,MAAM,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAA;YAE9C,MAAM,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAA;YAC5B,MAAM,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAA;YAChC,MAAM,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAA;QACtC,CAAC,CAAC,CAAA;QACF,WAAW,CAAC,aAAa,CAAA,GAAG,WAAW,CAAC,WAAW,EAAE,4BAA4B,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,CAAA;IAClH,CAAC,CAAC,CAAA;AACJ,CAAC","sourcesContent":["/* eslint-disable @typescript-eslint/no-non-null-assertion */\nimport {err, ok, Result} from './result.js'\nimport {fetch, Response} from './http.js'\nimport {writeFile, mkdir, inTemporaryDirectory, moveFile, chmod} from './fs.js'\nimport {dirname, joinPath} from './path.js'\nimport {runWithTimer} from './metadata.js'\nimport {AbortError} from './error.js'\nimport {outputContent, outputDebug, outputToken} from '../../public/node/output.js'\n\nclass GitHubClientError extends Error {\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  constructor(url: string, statusCode: number, bodyJson: any) {\n    super(\n      `The request to GitHub API URL ${url} failed with status code ${statusCode} and the following error message: ${bodyJson.message}`,\n    )\n  }\n}\n\nexport interface GithubRelease {\n  id: number\n  url: string\n  tag_name: string\n  name: string\n  body: string\n  draft: boolean\n  prerelease: boolean\n  created_at: string\n  published_at: string\n  tarball_url: string\n}\n\ninterface GetLatestGitHubReleaseOptions {\n  filter: (release: GithubRelease) => boolean\n}\n\n/**\n * Given a GitHub repository it obtains the latest release.\n * @param owner - Repository owner (e.g., shopify)\n * @param repo - Repository name (e.g., cli)\n * @param options - Options\n */\nexport async function getLatestGitHubRelease(\n  owner: string,\n  repo: string,\n  options: GetLatestGitHubReleaseOptions = {filter: () => true},\n): Promise<GithubRelease> {\n  outputDebug(outputContent`Getting the latest release of GitHub repository ${owner}/${repo}...`)\n  const url = `https://api.github.com/repos/${owner}/${repo}/releases`\n  const fetchResult = await fetch(url)\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  const jsonBody: any = await fetchResult.json()\n\n  if (fetchResult.status !== 200) {\n    throw new GitHubClientError(url, fetchResult.status, jsonBody)\n  }\n\n  return jsonBody.find(options.filter)\n}\n\ninterface ParseRepositoryURLOutput {\n  full: string\n  site: string\n  user: string\n  name: string\n  ref: string\n  subDirectory: string\n  ssh: string\n  http: string\n}\n\n/**\n * Given a GitHub repository URL, it parses it and returns its coomponents.\n * @param url - The GitHub repository URL\n */\nexport function parseGitHubRepositoryURL(url: string): Result<ParseRepositoryURLOutput, Error> {\n  const match =\n    /^(?:(?:https:\\/\\/)?([^:/]+\\.[^:/]+)\\/|git@([^:/]+)[:/]|([^/]+):)?([^/\\s]+)\\/([^/\\s#]+)(?:((?:\\/[^/\\s#]+)+))?(?:\\/)?(?:#(.+))?/.exec(\n      url,\n    )\n\n  if (!match) {\n    const exampleFormats = [\n      'github:user/repo',\n      'user/repo/subdirectory',\n      'git@github.com:user/repo',\n      'user/repo#dev',\n      'https://github.com/user/repo',\n    ]\n\n    return err(new Error(`Parsing the url ${url} failed. Supported formats are ${exampleFormats.join(', ')}.`))\n  }\n\n  const site = match[1] ?? match[2] ?? match[3] ?? 'github.com'\n  const normalizedSite = site === 'github' ? 'github.com' : site\n  const user = match[4]!\n  const name = match[5]!.replace(/\\.git$/, '')\n  // eslint-disable-next-line @typescript-eslint/no-non-null-asserted-optional-chain\n  const subDirectory = match[6]?.slice(1)!\n  const ref = match[7]!\n  const branch = ref ? `#${ref}` : ''\n  const ssh = `git@${normalizedSite}:${user}/${name}`\n  const http = `https://${normalizedSite}/${user}/${name}`\n  const full = ['https:/', normalizedSite, user, name, subDirectory].join('/').concat(branch)\n\n  return ok({full, site: normalizedSite, user, name, ref, subDirectory, ssh, http})\n}\n\nexport interface GithubRepositoryReference {\n  baseURL: string\n  branch?: string\n  filePath?: string\n}\n\n/**\n * Given a GitHub repository URL it parses it and extracts the branch, file path,\n * and base URL components\n * @param reference - A GitHub repository URL (e.g. https://github.com/Shopify/cli/blob/main/package.json)\n */\nexport function parseGitHubRepositoryReference(reference: string): GithubRepositoryReference {\n  const url = new URL(reference)\n  const branch = url.hash ? url.hash.slice(1) : undefined\n  const [_, user, repo, ...repoPath] = url.pathname.split('/')\n  const filePath = repoPath.length > 0 ? repoPath.join('/') : undefined\n\n  return {\n    baseURL: `${url.origin}/${user}/${repo}`,\n    branch,\n    filePath,\n  }\n}\n\nexport async function downloadGitHubRelease(\n  repo: string,\n  version: string,\n  assetName: string,\n  targetPath: string,\n): Promise<void> {\n  const url = `https://github.com/${repo}/releases/download/${version}/${assetName}`\n\n  return runWithTimer('cmd_all_timing_network_ms')(async () => {\n    outputDebug(outputContent`Downloading ${outputToken.link(assetName, url)}`)\n    await inTemporaryDirectory(async (tmpDir) => {\n      const tempPath = joinPath(tmpDir, assetName)\n      let response: Response\n      try {\n        response = await fetch(url)\n        if (!response.ok) {\n          throw new AbortError(`Failed to download ${assetName}: ${response.statusText}`)\n        }\n      } catch (error) {\n        throw new AbortError(\n          `Failed to download ${assetName}: ${error instanceof Error ? error.message : 'unknown error'}`,\n        )\n      }\n\n      const buffer = await response.arrayBuffer()\n      await writeFile(tempPath, Buffer.from(buffer))\n\n      await chmod(tempPath, 0o755)\n      await mkdir(dirname(targetPath))\n      await moveFile(tempPath, targetPath)\n    })\n    outputDebug(outputContent`${outputToken.successIcon()} Successfully downloaded ${outputToken.path(targetPath)}`)\n  })\n}\n"]}

package/dist/public/node/http.d.ts

@@ -1,3 +1,4 @@
+import { NetworkRetryBehaviour } from '../../private/node/api.js';
 import FormData from 'form-data';
 import { RequestInfo, RequestInit, Response } from 'node-fetch';
 export { FetchError, Request, Response } from 'node-fetch';
@@ -7,6 +8,43 @@ export { FetchError, Request, Response } from 'node-fetch';
  * @returns A FormData object.
  */
 export declare function formData(): FormData;
+type AbortSignal = RequestInit['signal'];
+type PresetFetchBehaviour = 'default' | 'non-blocking' | 'slow-request';
+type AutomaticCancellationBehaviour = {
+    useAbortSignal: true;
+    timeoutMs: number;
+} | {
+    useAbortSignal: false;
+} | {
+    useAbortSignal: AbortSignal | (() => AbortSignal);
+};
+type RequestBehaviour = NetworkRetryBehaviour & AutomaticCancellationBehaviour;
+type RequestModeInput = PresetFetchBehaviour | RequestBehaviour;
+/**
+ * Specify the behaviour of a network request.
+ *
+ * - default: Requests are automatically retried, and are subject to automatic cancellation if they're taking too long.
+ * This is generally desirable.
+ * - non-blocking: Requests are not retried if they fail with a network error, and are automatically cancelled if
+ * they're taking too long. This is good for throwaway requests, like polling or tracking.
+ * - slow-request: Requests are not retried if they fail with a network error, and are not automatically cancelled.
+ * This is good for slow requests that should be give the chance to complete, and are unlikely to be safe to retry.
+ *
+ * Some request behaviours may be de-activated by the environment, and this function takes care of that concern. You
+ * can also provide a customised request behaviour.
+ *
+ * @param preset - The preset to use.
+ * @param env - Process environment variables.
+ * @returns A request behaviour object.
+ */
+export declare function requestMode(preset?: RequestModeInput, env?: NodeJS.ProcessEnv): RequestBehaviour;
+/**
+ * Create an AbortSignal for automatic request cancellation, from a request behaviour.
+ *
+ * @param behaviour - The request behaviour.
+ * @returns An AbortSignal.
+ */
+export declare function abortSignalFromRequestBehaviour(behaviour: RequestBehaviour): AbortSignal;
 /**
  * An interface that abstracts way node-fetch. When Node has built-in
  * support for "fetch" in the standard library, we can drop the node-fetch
@@ -15,21 +53,28 @@ export declare function formData(): FormData;
  * they are consistent with the Web API so if we drop node-fetch in the future
  * it won't require changes from the callers.
  *
+ * The CLI's fetch function supports special behaviours, like automatic retries. These are disabled by default through
+ * this function.
+ *
  * @param url - This defines the resource that you wish to fetch.
  * @param init - An object containing any custom settings that you want to apply to the request.
+ * @param preferredBehaviour - A request behaviour object that overrides the default behaviour.
  * @returns A promise that resolves with the response.
  */
-export declare function fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
+export declare function fetch(url: RequestInfo, init?: RequestInit, preferredBehaviour?: RequestModeInput): Promise<Response>;
 /**
  * A fetch function to use with Shopify services. The function ensures the right
  * TLS configuragion is used based on the environment in which the service is running
- * (e.g. Spin).
+ * (e.g. Spin). NB: headers/auth are the responsibility of the caller.
+ *
+ * By default, the CLI's fetch function's special behaviours, like automatic retries, are enabled.
  *
  * @param url - This defines the resource that you wish to fetch.
  * @param init - An object containing any custom settings that you want to apply to the request.
+ * @param preferredBehaviour - A request behaviour object that overrides the default behaviour.
  * @returns A promise that resolves with the response.
  */
-export declare function shopifyFetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
+export declare function shopifyFetch(url: RequestInfo, init?: RequestInit, preferredBehaviour?: RequestModeInput): Promise<Response>;
 /**
  * Download a file from a URL to a local path.
  *

package/dist/public/node/http.js

@@ -2,10 +2,12 @@
 import { dirname } from './path.js';
 import { createFileWriteStream, fileExistsSync, mkdirSync, unlinkFileSync } from './fs.js';
 import { runWithTimer } from './metadata.js';
-import { buildHeaders, httpsAgent, sanitizedHeadersOutput } from '../../private/node/api/headers.js';
+import { maxRequestTimeForNetworkCallsMs, skipNetworkLevelRetry } from './environment.js';
+import { httpsAgent, sanitizedHeadersOutput } from '../../private/node/api/headers.js';
 import { sanitizeURL } from '../../private/node/api/urls.js';
-import { outputContent, outputDebug } from '../../public/node/output.js';
+import { outputContent, outputDebug, outputToken } from '../../public/node/output.js';
 import { simpleRequestWithDebugLog } from '../../private/node/api.js';
+import { DEFAULT_MAX_TIME_MS } from '../../private/node/sleep-with-backoff.js';
 import FormData from 'form-data';
 import nodeFetch from 'node-fetch';
 export { FetchError, Request, Response } from 'node-fetch';
@@ -17,6 +19,98 @@ export { FetchError, Request, Response } from 'node-fetch';
 export function formData() {
     return new FormData();
 }
+/**
+ * Specify the behaviour of a network request.
+ *
+ * - default: Requests are automatically retried, and are subject to automatic cancellation if they're taking too long.
+ * This is generally desirable.
+ * - non-blocking: Requests are not retried if they fail with a network error, and are automatically cancelled if
+ * they're taking too long. This is good for throwaway requests, like polling or tracking.
+ * - slow-request: Requests are not retried if they fail with a network error, and are not automatically cancelled.
+ * This is good for slow requests that should be give the chance to complete, and are unlikely to be safe to retry.
+ *
+ * Some request behaviours may be de-activated by the environment, and this function takes care of that concern. You
+ * can also provide a customised request behaviour.
+ *
+ * @param preset - The preset to use.
+ * @param env - Process environment variables.
+ * @returns A request behaviour object.
+ */
+export function requestMode(preset = 'default', env = process.env) {
+    const networkLevelRetryIsSupported = !skipNetworkLevelRetry(env);
+    switch (preset) {
+        case 'default':
+            return {
+                useNetworkLevelRetry: networkLevelRetryIsSupported,
+                maxRetryTimeMs: DEFAULT_MAX_TIME_MS,
+                useAbortSignal: true,
+                timeoutMs: maxRequestTimeForNetworkCallsMs(env),
+            };
+        case 'non-blocking':
+            return {
+                useNetworkLevelRetry: false,
+                useAbortSignal: true,
+                timeoutMs: maxRequestTimeForNetworkCallsMs(env),
+            };
+        case 'slow-request':
+            return {
+                useNetworkLevelRetry: false,
+                useAbortSignal: false,
+            };
+    }
+    return {
+        ...preset,
+        useNetworkLevelRetry: networkLevelRetryIsSupported && preset.useNetworkLevelRetry,
+    };
+}
+/**
+ * Create an AbortSignal for automatic request cancellation, from a request behaviour.
+ *
+ * @param behaviour - The request behaviour.
+ * @returns An AbortSignal.
+ */
+export function abortSignalFromRequestBehaviour(behaviour) {
+    let signal;
+    if (behaviour.useAbortSignal === true) {
+        signal = AbortSignal.timeout(behaviour.timeoutMs);
+    }
+    else if (behaviour.useAbortSignal && typeof behaviour.useAbortSignal === 'function') {
+        signal = behaviour.useAbortSignal();
+    }
+    else if (behaviour.useAbortSignal) {
+        signal = behaviour.useAbortSignal;
+    }
+    return signal;
+}
+async function innerFetch({ url, behaviour, init, logRequest, useHttpsAgent }) {
+    if (logRequest) {
+        outputDebug(outputContent `Sending ${init?.method ?? 'GET'} request to URL ${sanitizeURL(url.toString())}
+With request headers:
+${sanitizedHeadersOutput((init?.headers ?? {}))}
+`);
+    }
+    let agent;
+    if (useHttpsAgent) {
+        agent = await httpsAgent();
+    }
+    const request = async () => {
+        // each time we make the request, we need to potentially reset the abort signal, as the request logic may make
+        // the same request multiple times.
+        let signal = abortSignalFromRequestBehaviour(behaviour);
+        // it's possible to provide a signal through the request's init structure.
+        if (init?.signal) {
+            signal = init.signal;
+        }
+        return nodeFetch(url, { ...init, agent, signal });
+    };
+    return runWithTimer('cmd_all_timing_network_ms')(async () => {
+        return simpleRequestWithDebugLog({
+            url: url.toString(),
+            request,
+            ...behaviour,
+        });
+    });
+}
 /**
  * An interface that abstracts way node-fetch. When Node has built-in
  * support for "fetch" in the standard library, we can drop the node-fetch
@@ -25,41 +119,47 @@ export function formData() {
  * they are consistent with the Web API so if we drop node-fetch in the future
  * it won't require changes from the callers.
  *
+ * The CLI's fetch function supports special behaviours, like automatic retries. These are disabled by default through
+ * this function.
+ *
  * @param url - This defines the resource that you wish to fetch.
  * @param init - An object containing any custom settings that you want to apply to the request.
+ * @param preferredBehaviour - A request behaviour object that overrides the default behaviour.
  * @returns A promise that resolves with the response.
  */
-export async function fetch(url, init) {
-    return runWithTimer('cmd_all_timing_network_ms')(() => simpleRequestWithDebugLog({ url: url.toString(), request: () => nodeFetch(url, init) }));
+export async function fetch(url, init, preferredBehaviour) {
+    const options = {
+        url,
+        init,
+        logRequest: false,
+        useHttpsAgent: false,
+        // all special behaviours are disabled by default
+        behaviour: preferredBehaviour ? requestMode(preferredBehaviour) : requestMode('non-blocking'),
+    };
+    return innerFetch(options);
 }
 /**
  * A fetch function to use with Shopify services. The function ensures the right
  * TLS configuragion is used based on the environment in which the service is running
- * (e.g. Spin).
+ * (e.g. Spin). NB: headers/auth are the responsibility of the caller.
+ *
+ * By default, the CLI's fetch function's special behaviours, like automatic retries, are enabled.
  *
  * @param url - This defines the resource that you wish to fetch.
  * @param init - An object containing any custom settings that you want to apply to the request.
+ * @param preferredBehaviour - A request behaviour object that overrides the default behaviour.
  * @returns A promise that resolves with the response.
  */
-export async function shopifyFetch(url, init) {
-    const sanitizedUrl = sanitizeURL(url.toString());
+export async function shopifyFetch(url, init, preferredBehaviour) {
     const options = {
-        ...(init ?? {}),
-        headers: {
-            ...(await buildHeaders()),
-            ...(init?.headers ?? {}),
-        },
+        url,
+        init,
+        logRequest: true,
+        useHttpsAgent: true,
+        // special behaviours enabled by default
+        behaviour: preferredBehaviour ? requestMode(preferredBehaviour) : requestMode(),
     };
-    outputDebug(outputContent `Sending ${options.method ?? 'GET'} request to URL ${sanitizedUrl}
-With request headers:
-${sanitizedHeadersOutput((options.headers ?? {}))}
-`);
-    return runWithTimer('cmd_all_timing_network_ms')(async () => {
-        return simpleRequestWithDebugLog({
-            url: url.toString(),
-            request: async () => nodeFetch(url, { ...init, agent: await httpsAgent() }),
-        });
-    });
+    return innerFetch(options);
 }
 /**
  * Download a file from a URL to a local path.
@@ -77,12 +177,22 @@ export function downloadFile(url, to) {
                 mkdirSync(dirname(to));
             }
             const file = createFileWriteStream(to);
+            // if we can't remove the file for some reason (seen on windows), that's ok -- it's in a temporary directory
+            const tryToRemoveFile = () => {
+                try {
+                    unlinkFileSync(to);
+                    // eslint-disable-next-line no-catch-all/no-catch-all, @typescript-eslint/no-explicit-any
+                }
+                catch (err) {
+                    outputDebug(outputContent `Failed to remove file ${outputToken.path(to)}: ${err}`);
+                }
+            };
             file.on('finish', () => {
                 file.close();
                 resolve(to);
             });
             file.on('error', (err) => {
-                unlinkFileSync(to);
+                tryToRemoveFile();
                 reject(err);
             });
             nodeFetch(url, { redirect: 'follow' })
@@ -90,7 +200,7 @@ export function downloadFile(url, to) {
                 res.body?.pipe(file);
             })
                 .catch((err) => {
-                unlinkFileSync(to);
+                tryToRemoveFile();
                 reject(err);
             });
         });

package/dist/public/node/http.js.map

@@ -1 +1 @@
-{"version":3,"file":"http.js","sourceRoot":"","sources":["../../../src/public/node/http.ts"],"names":[],"mappings":"AAAA,yDAAyD;AACzD,OAAO,EAAC,OAAO,EAAC,MAAM,WAAW,CAAA;AACjC,OAAO,EAAC,qBAAqB,EAAE,cAAc,EAAE,SAAS,EAAE,cAAc,EAAC,MAAM,SAAS,CAAA;AACxF,OAAO,EAAC,YAAY,EAAC,MAAM,eAAe,CAAA;AAC1C,OAAO,EAAC,YAAY,EAAE,UAAU,EAAE,sBAAsB,EAAC,MAAM,mCAAmC,CAAA;AAClG,OAAO,EAAC,WAAW,EAAC,MAAM,gCAAgC,CAAA;AAC1D,OAAO,EAAC,aAAa,EAAE,WAAW,EAAC,MAAM,6BAA6B,CAAA;AACtE,OAAO,EAAC,yBAAyB,EAAC,MAAM,2BAA2B,CAAA;AACnE,OAAO,QAAQ,MAAM,WAAW,CAAA;AAChC,OAAO,SAA+C,MAAM,YAAY,CAAA;AAExE,OAAO,EAAC,UAAU,EAAE,OAAO,EAAE,QAAQ,EAAC,MAAM,YAAY,CAAA;AAExD;;;;GAIG;AACH,MAAM,UAAU,QAAQ;IACtB,OAAO,IAAI,QAAQ,EAAE,CAAA;AACvB,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,KAAK,UAAU,KAAK,CAAC,GAAgB,EAAE,IAAkB;IAC9D,OAAO,YAAY,CAAC,2BAA2B,CAAC,CAAC,GAAG,EAAE,CACpD,yBAAyB,CAAC,EAAC,GAAG,EAAE,GAAG,CAAC,QAAQ,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,EAAC,CAAC,CACtF,CAAA;AACH,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,GAAgB,EAAE,IAAkB;IACrE,MAAM,YAAY,GAAG,WAAW,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAA;IAChD,MAAM,OAAO,GAAgB;QAC3B,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC;QACf,OAAO,EAAE;YACP,GAAG,CAAC,MAAM,YAAY,EAAE,CAAC;YACzB,GAAG,CAAC,IAAI,EAAE,OAAO,IAAI,EAAE,CAAC;SACzB;KACF,CAAA;IAED,WAAW,CAAC,aAAa,CAAA,WAAW,OAAO,CAAC,MAAM,IAAI,KAAK,mBAAmB,YAAY;;EAE1F,sBAAsB,CAAC,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,CAA+B,CAAC;CAC9E,CAAC,CAAA;IACA,OAAO,YAAY,CAAC,2BAA2B,CAAC,CAAC,KAAK,IAAI,EAAE;QAC1D,OAAO,yBAAyB,CAAC;YAC/B,GAAG,EAAE,GAAG,CAAC,QAAQ,EAAE;YACnB,OAAO,EAAE,KAAK,IAAI,EAAE,CAAC,SAAS,CAAC,GAAG,EAAE,EAAC,GAAG,IAAI,EAAE,KAAK,EAAE,MAAM,UAAU,EAAE,EAAC,CAAC;SAC1E,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAAC,GAAW,EAAE,EAAU;IAClD,MAAM,YAAY,GAAG,WAAW,CAAC,GAAG,CAAC,CAAA;IACrC,WAAW,CAAC,eAAe,YAAY,OAAO,EAAE,EAAE,CAAC,CAAA;IAEnD,OAAO,YAAY,CAAC,2BAA2B,CAAC,CAAC,GAAG,EAAE;QACpD,OAAO,IAAI,OAAO,CAAS,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC7C,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;gBACjC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAA;YACxB,CAAC;YAED,MAAM,IAAI,GAAG,qBAAqB,CAAC,EAAE,CAAC,CAAA;YAEtC,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE;gBACrB,IAAI,CAAC,KAAK,EAAE,CAAA;gBACZ,OAAO,CAAC,EAAE,CAAC,CAAA;YACb,CAAC,CAAC,CAAA;YAEF,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;gBACvB,cAAc,CAAC,EAAE,CAAC,CAAA;gBAClB,MAAM,CAAC,GAAG,CAAC,CAAA;YACb,CAAC,CAAC,CAAA;YAEF,SAAS,CAAC,GAAG,EAAE,EAAC,QAAQ,EAAE,QAAQ,EAAC,CAAC;iBACjC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE;gBACZ,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAA;YACtB,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;gBACb,cAAc,CAAC,EAAE,CAAC,CAAA;gBAClB,MAAM,CAAC,GAAG,CAAC,CAAA;YACb,CAAC,CAAC,CAAA;QACN,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC","sourcesContent":["/* eslint-disable @typescript-eslint/no-base-to-string */\nimport {dirname} from './path.js'\nimport {createFileWriteStream, fileExistsSync, mkdirSync, unlinkFileSync} from './fs.js'\nimport {runWithTimer} from './metadata.js'\nimport {buildHeaders, httpsAgent, sanitizedHeadersOutput} from '../../private/node/api/headers.js'\nimport {sanitizeURL} from '../../private/node/api/urls.js'\nimport {outputContent, outputDebug} from '../../public/node/output.js'\nimport {simpleRequestWithDebugLog} from '../../private/node/api.js'\nimport FormData from 'form-data'\nimport nodeFetch, {RequestInfo, RequestInit, Response} from 'node-fetch'\n\nexport {FetchError, Request, Response} from 'node-fetch'\n\n/**\n * Create a new FormData object.\n *\n * @returns A FormData object.\n */\nexport function formData(): FormData {\n  return new FormData()\n}\n\n/**\n * An interface that abstracts way node-fetch. When Node has built-in\n * support for \"fetch\" in the standard library, we can drop the node-fetch\n * dependency from here.\n * Note that we are exposing types from \"node-fetch\". The reason being is that\n * they are consistent with the Web API so if we drop node-fetch in the future\n * it won't require changes from the callers.\n *\n * @param url - This defines the resource that you wish to fetch.\n * @param init - An object containing any custom settings that you want to apply to the request.\n * @returns A promise that resolves with the response.\n */\nexport async function fetch(url: RequestInfo, init?: RequestInit): Promise<Response> {\n  return runWithTimer('cmd_all_timing_network_ms')(() =>\n    simpleRequestWithDebugLog({url: url.toString(), request: () => nodeFetch(url, init)}),\n  )\n}\n\n/**\n * A fetch function to use with Shopify services. The function ensures the right\n * TLS configuragion is used based on the environment in which the service is running\n * (e.g. Spin).\n *\n * @param url - This defines the resource that you wish to fetch.\n * @param init - An object containing any custom settings that you want to apply to the request.\n * @returns A promise that resolves with the response.\n */\nexport async function shopifyFetch(url: RequestInfo, init?: RequestInit): Promise<Response> {\n  const sanitizedUrl = sanitizeURL(url.toString())\n  const options: RequestInit = {\n    ...(init ?? {}),\n    headers: {\n      ...(await buildHeaders()),\n      ...(init?.headers ?? {}),\n    },\n  }\n\n  outputDebug(outputContent`Sending ${options.method ?? 'GET'} request to URL ${sanitizedUrl}\nWith request headers:\n${sanitizedHeadersOutput((options.headers ?? {}) as {[header: string]: string})}\n`)\n  return runWithTimer('cmd_all_timing_network_ms')(async () => {\n    return simpleRequestWithDebugLog({\n      url: url.toString(),\n      request: async () => nodeFetch(url, {...init, agent: await httpsAgent()}),\n    })\n  })\n}\n\n/**\n * Download a file from a URL to a local path.\n *\n * @param url - The URL to download from.\n * @param to - The local path to download to.\n * @returns - A promise that resolves with the local path.\n */\nexport function downloadFile(url: string, to: string): Promise<string> {\n  const sanitizedUrl = sanitizeURL(url)\n  outputDebug(`Downloading ${sanitizedUrl} to ${to}`)\n\n  return runWithTimer('cmd_all_timing_network_ms')(() => {\n    return new Promise<string>((resolve, reject) => {\n      if (!fileExistsSync(dirname(to))) {\n        mkdirSync(dirname(to))\n      }\n\n      const file = createFileWriteStream(to)\n\n      file.on('finish', () => {\n        file.close()\n        resolve(to)\n      })\n\n      file.on('error', (err) => {\n        unlinkFileSync(to)\n        reject(err)\n      })\n\n      nodeFetch(url, {redirect: 'follow'})\n        .then((res) => {\n          res.body?.pipe(file)\n        })\n        .catch((err) => {\n          unlinkFileSync(to)\n          reject(err)\n        })\n    })\n  })\n}\n"]}
+{"version":3,"file":"http.js","sourceRoot":"","sources":["../../../src/public/node/http.ts"],"names":[],"mappings":"AAAA,yDAAyD;AACzD,OAAO,EAAC,OAAO,EAAC,MAAM,WAAW,CAAA;AACjC,OAAO,EAAC,qBAAqB,EAAE,cAAc,EAAE,SAAS,EAAE,cAAc,EAAC,MAAM,SAAS,CAAA;AACxF,OAAO,EAAC,YAAY,EAAC,MAAM,eAAe,CAAA;AAC1C,OAAO,EAAC,+BAA+B,EAAE,qBAAqB,EAAC,MAAM,kBAAkB,CAAA;AACvF,OAAO,EAAC,UAAU,EAAE,sBAAsB,EAAC,MAAM,mCAAmC,CAAA;AACpF,OAAO,EAAC,WAAW,EAAC,MAAM,gCAAgC,CAAA;AAC1D,OAAO,EAAC,aAAa,EAAE,WAAW,EAAE,WAAW,EAAC,MAAM,6BAA6B,CAAA;AACnF,OAAO,EAAwB,yBAAyB,EAAC,MAAM,2BAA2B,CAAA;AAC1F,OAAO,EAAC,mBAAmB,EAAC,MAAM,0CAA0C,CAAA;AAC5E,OAAO,QAAQ,MAAM,WAAW,CAAA;AAChC,OAAO,SAA+C,MAAM,YAAY,CAAA;AAExE,OAAO,EAAC,UAAU,EAAE,OAAO,EAAE,QAAQ,EAAC,MAAM,YAAY,CAAA;AAExD;;;;GAIG;AACH,MAAM,UAAU,QAAQ;IACtB,OAAO,IAAI,QAAQ,EAAE,CAAA;AACvB,CAAC;AAsBD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,WAAW,CACzB,SAA2B,SAAS,EACpC,MAAyB,OAAO,CAAC,GAAG;IAEpC,MAAM,4BAA4B,GAAG,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAA;IAChE,QAAQ,MAAM,EAAE,CAAC;QACf,KAAK,SAAS;YACZ,OAAO;gBACL,oBAAoB,EAAE,4BAA4B;gBAClD,cAAc,EAAE,mBAAmB;gBACnC,cAAc,EAAE,IAAI;gBACpB,SAAS,EAAE,+BAA+B,CAAC,GAAG,CAAC;aAChD,CAAA;QACH,KAAK,cAAc;YACjB,OAAO;gBACL,oBAAoB,EAAE,KAAK;gBAC3B,cAAc,EAAE,IAAI;gBACpB,SAAS,EAAE,+BAA+B,CAAC,GAAG,CAAC;aAChD,CAAA;QACH,KAAK,cAAc;YACjB,OAAO;gBACL,oBAAoB,EAAE,KAAK;gBAC3B,cAAc,EAAE,KAAK;aACtB,CAAA;IACL,CAAC;IACD,OAAO;QACL,GAAG,MAAM;QACT,oBAAoB,EAAE,4BAA4B,IAAI,MAAM,CAAC,oBAAoB;KAC9D,CAAA;AACvB,CAAC;AAUD;;;;;GAKG;AACH,MAAM,UAAU,+BAA+B,CAAC,SAA2B;IACzE,IAAI,MAAmB,CAAA;IACvB,IAAI,SAAS,CAAC,cAAc,KAAK,IAAI,EAAE,CAAC;QACtC,MAAM,GAAG,WAAW,CAAC,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,CAAA;IACnD,CAAC;SAAM,IAAI,SAAS,CAAC,cAAc,IAAI,OAAO,SAAS,CAAC,cAAc,KAAK,UAAU,EAAE,CAAC;QACtF,MAAM,GAAG,SAAS,CAAC,cAAc,EAAE,CAAA;IACrC,CAAC;SAAM,IAAI,SAAS,CAAC,cAAc,EAAE,CAAC;QACpC,MAAM,GAAG,SAAS,CAAC,cAAc,CAAA;IACnC,CAAC;IACD,OAAO,MAAM,CAAA;AACf,CAAC;AAED,KAAK,UAAU,UAAU,CAAC,EAAC,GAAG,EAAE,SAAS,EAAE,IAAI,EAAE,UAAU,EAAE,aAAa,EAAe;IACvF,IAAI,UAAU,EAAE,CAAC;QACf,WAAW,CAAC,aAAa,CAAA,WAAW,IAAI,EAAE,MAAM,IAAI,KAAK,mBAAmB,WAAW,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;;EAEzG,sBAAsB,CAAC,CAAC,IAAI,EAAE,OAAO,IAAI,EAAE,CAA+B,CAAC;CAC5E,CAAC,CAAA;IACA,CAAC;IAED,IAAI,KAA2B,CAAA;IAC/B,IAAI,aAAa,EAAE,CAAC;QAClB,KAAK,GAAG,MAAM,UAAU,EAAE,CAAA;IAC5B,CAAC;IAED,MAAM,OAAO,GAAG,KAAK,IAAI,EAAE;QACzB,8GAA8G;QAC9G,mCAAmC;QACnC,IAAI,MAAM,GAAG,+BAA+B,CAAC,SAAS,CAAC,CAAA;QAEvD,0EAA0E;QAC1E,IAAI,IAAI,EAAE,MAAM,EAAE,CAAC;YACjB,MAAM,GAAG,IAAI,CAAC,MAAM,CAAA;QACtB,CAAC;QAED,OAAO,SAAS,CAAC,GAAG,EAAE,EAAC,GAAG,IAAI,EAAE,KAAK,EAAE,MAAM,EAAC,CAAC,CAAA;IACjD,CAAC,CAAA;IAED,OAAO,YAAY,CAAC,2BAA2B,CAAC,CAAC,KAAK,IAAI,EAAE;QAC1D,OAAO,yBAAyB,CAAC;YAC/B,GAAG,EAAE,GAAG,CAAC,QAAQ,EAAE;YACnB,OAAO;YACP,GAAG,SAAS;SACb,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,KAAK,UAAU,KAAK,CACzB,GAAgB,EAChB,IAAkB,EAClB,kBAAqC;IAErC,MAAM,OAAO,GAAG;QACd,GAAG;QACH,IAAI;QACJ,UAAU,EAAE,KAAK;QACjB,aAAa,EAAE,KAAK;QACpB,iDAAiD;QACjD,SAAS,EAAE,kBAAkB,CAAC,CAAC,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,cAAc,CAAC;KACrF,CAAA;IAEV,OAAO,UAAU,CAAC,OAAO,CAAC,CAAA;AAC5B,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,GAAgB,EAChB,IAAkB,EAClB,kBAAqC;IAErC,MAAM,OAAO,GAAG;QACd,GAAG;QACH,IAAI;QACJ,UAAU,EAAE,IAAI;QAChB,aAAa,EAAE,IAAI;QACnB,wCAAwC;QACxC,SAAS,EAAE,kBAAkB,CAAC,CAAC,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE;KAChF,CAAA;IAED,OAAO,UAAU,CAAC,OAAO,CAAC,CAAA;AAC5B,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAAC,GAAW,EAAE,EAAU;IAClD,MAAM,YAAY,GAAG,WAAW,CAAC,GAAG,CAAC,CAAA;IACrC,WAAW,CAAC,eAAe,YAAY,OAAO,EAAE,EAAE,CAAC,CAAA;IAEnD,OAAO,YAAY,CAAC,2BAA2B,CAAC,CAAC,GAAG,EAAE;QACpD,OAAO,IAAI,OAAO,CAAS,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC7C,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;gBACjC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAA;YACxB,CAAC;YAED,MAAM,IAAI,GAAG,qBAAqB,CAAC,EAAE,CAAC,CAAA;YAEtC,4GAA4G;YAC5G,MAAM,eAAe,GAAG,GAAG,EAAE;gBAC3B,IAAI,CAAC;oBACH,cAAc,CAAC,EAAE,CAAC,CAAA;oBAClB,yFAAyF;gBAC3F,CAAC;gBAAC,OAAO,GAAQ,EAAE,CAAC;oBAClB,WAAW,CAAC,aAAa,CAAA,yBAAyB,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,GAAG,EAAE,CAAC,CAAA;gBACnF,CAAC;YACH,CAAC,CAAA;YAED,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE;gBACrB,IAAI,CAAC,KAAK,EAAE,CAAA;gBACZ,OAAO,CAAC,EAAE,CAAC,CAAA;YACb,CAAC,CAAC,CAAA;YAEF,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;gBACvB,eAAe,EAAE,CAAA;gBACjB,MAAM,CAAC,GAAG,CAAC,CAAA;YACb,CAAC,CAAC,CAAA;YAEF,SAAS,CAAC,GAAG,EAAE,EAAC,QAAQ,EAAE,QAAQ,EAAC,CAAC;iBACjC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE;gBACZ,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAA;YACtB,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;gBACb,eAAe,EAAE,CAAA;gBACjB,MAAM,CAAC,GAAG,CAAC,CAAA;YACb,CAAC,CAAC,CAAA;QACN,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC","sourcesContent":["/* eslint-disable @typescript-eslint/no-base-to-string */\nimport {dirname} from './path.js'\nimport {createFileWriteStream, fileExistsSync, mkdirSync, unlinkFileSync} from './fs.js'\nimport {runWithTimer} from './metadata.js'\nimport {maxRequestTimeForNetworkCallsMs, skipNetworkLevelRetry} from './environment.js'\nimport {httpsAgent, sanitizedHeadersOutput} from '../../private/node/api/headers.js'\nimport {sanitizeURL} from '../../private/node/api/urls.js'\nimport {outputContent, outputDebug, outputToken} from '../../public/node/output.js'\nimport {NetworkRetryBehaviour, simpleRequestWithDebugLog} from '../../private/node/api.js'\nimport {DEFAULT_MAX_TIME_MS} from '../../private/node/sleep-with-backoff.js'\nimport FormData from 'form-data'\nimport nodeFetch, {RequestInfo, RequestInit, Response} from 'node-fetch'\n\nexport {FetchError, Request, Response} from 'node-fetch'\n\n/**\n * Create a new FormData object.\n *\n * @returns A FormData object.\n */\nexport function formData(): FormData {\n  return new FormData()\n}\n\ntype AbortSignal = RequestInit['signal']\n\ntype PresetFetchBehaviour = 'default' | 'non-blocking' | 'slow-request'\n\ntype AutomaticCancellationBehaviour =\n  | {\n      useAbortSignal: true\n      timeoutMs: number\n    }\n  | {\n      useAbortSignal: false\n    }\n  | {\n      useAbortSignal: AbortSignal | (() => AbortSignal)\n    }\n\ntype RequestBehaviour = NetworkRetryBehaviour & AutomaticCancellationBehaviour\n\ntype RequestModeInput = PresetFetchBehaviour | RequestBehaviour\n\n/**\n * Specify the behaviour of a network request.\n *\n * - default: Requests are automatically retried, and are subject to automatic cancellation if they're taking too long.\n * This is generally desirable.\n * - non-blocking: Requests are not retried if they fail with a network error, and are automatically cancelled if\n * they're taking too long. This is good for throwaway requests, like polling or tracking.\n * - slow-request: Requests are not retried if they fail with a network error, and are not automatically cancelled.\n * This is good for slow requests that should be give the chance to complete, and are unlikely to be safe to retry.\n *\n * Some request behaviours may be de-activated by the environment, and this function takes care of that concern. You\n * can also provide a customised request behaviour.\n *\n * @param preset - The preset to use.\n * @param env - Process environment variables.\n * @returns A request behaviour object.\n */\nexport function requestMode(\n  preset: RequestModeInput = 'default',\n  env: NodeJS.ProcessEnv = process.env,\n): RequestBehaviour {\n  const networkLevelRetryIsSupported = !skipNetworkLevelRetry(env)\n  switch (preset) {\n    case 'default':\n      return {\n        useNetworkLevelRetry: networkLevelRetryIsSupported,\n        maxRetryTimeMs: DEFAULT_MAX_TIME_MS,\n        useAbortSignal: true,\n        timeoutMs: maxRequestTimeForNetworkCallsMs(env),\n      }\n    case 'non-blocking':\n      return {\n        useNetworkLevelRetry: false,\n        useAbortSignal: true,\n        timeoutMs: maxRequestTimeForNetworkCallsMs(env),\n      }\n    case 'slow-request':\n      return {\n        useNetworkLevelRetry: false,\n        useAbortSignal: false,\n      }\n  }\n  return {\n    ...preset,\n    useNetworkLevelRetry: networkLevelRetryIsSupported && preset.useNetworkLevelRetry,\n  } as RequestBehaviour\n}\n\ninterface FetchOptions {\n  url: RequestInfo\n  behaviour: RequestBehaviour\n  init?: RequestInit\n  logRequest: boolean\n  useHttpsAgent: boolean\n}\n\n/**\n * Create an AbortSignal for automatic request cancellation, from a request behaviour.\n *\n * @param behaviour - The request behaviour.\n * @returns An AbortSignal.\n */\nexport function abortSignalFromRequestBehaviour(behaviour: RequestBehaviour): AbortSignal {\n  let signal: AbortSignal\n  if (behaviour.useAbortSignal === true) {\n    signal = AbortSignal.timeout(behaviour.timeoutMs)\n  } else if (behaviour.useAbortSignal && typeof behaviour.useAbortSignal === 'function') {\n    signal = behaviour.useAbortSignal()\n  } else if (behaviour.useAbortSignal) {\n    signal = behaviour.useAbortSignal\n  }\n  return signal\n}\n\nasync function innerFetch({url, behaviour, init, logRequest, useHttpsAgent}: FetchOptions): Promise<Response> {\n  if (logRequest) {\n    outputDebug(outputContent`Sending ${init?.method ?? 'GET'} request to URL ${sanitizeURL(url.toString())}\nWith request headers:\n${sanitizedHeadersOutput((init?.headers ?? {}) as {[header: string]: string})}\n`)\n  }\n\n  let agent: RequestInit['agent']\n  if (useHttpsAgent) {\n    agent = await httpsAgent()\n  }\n\n  const request = async () => {\n    // each time we make the request, we need to potentially reset the abort signal, as the request logic may make\n    // the same request multiple times.\n    let signal = abortSignalFromRequestBehaviour(behaviour)\n\n    // it's possible to provide a signal through the request's init structure.\n    if (init?.signal) {\n      signal = init.signal\n    }\n\n    return nodeFetch(url, {...init, agent, signal})\n  }\n\n  return runWithTimer('cmd_all_timing_network_ms')(async () => {\n    return simpleRequestWithDebugLog({\n      url: url.toString(),\n      request,\n      ...behaviour,\n    })\n  })\n}\n\n/**\n * An interface that abstracts way node-fetch. When Node has built-in\n * support for \"fetch\" in the standard library, we can drop the node-fetch\n * dependency from here.\n * Note that we are exposing types from \"node-fetch\". The reason being is that\n * they are consistent with the Web API so if we drop node-fetch in the future\n * it won't require changes from the callers.\n *\n * The CLI's fetch function supports special behaviours, like automatic retries. These are disabled by default through\n * this function.\n *\n * @param url - This defines the resource that you wish to fetch.\n * @param init - An object containing any custom settings that you want to apply to the request.\n * @param preferredBehaviour - A request behaviour object that overrides the default behaviour.\n * @returns A promise that resolves with the response.\n */\nexport async function fetch(\n  url: RequestInfo,\n  init?: RequestInit,\n  preferredBehaviour?: RequestModeInput,\n): Promise<Response> {\n  const options = {\n    url,\n    init,\n    logRequest: false,\n    useHttpsAgent: false,\n    // all special behaviours are disabled by default\n    behaviour: preferredBehaviour ? requestMode(preferredBehaviour) : requestMode('non-blocking'),\n  } as const\n\n  return innerFetch(options)\n}\n\n/**\n * A fetch function to use with Shopify services. The function ensures the right\n * TLS configuragion is used based on the environment in which the service is running\n * (e.g. Spin). NB: headers/auth are the responsibility of the caller.\n *\n * By default, the CLI's fetch function's special behaviours, like automatic retries, are enabled.\n *\n * @param url - This defines the resource that you wish to fetch.\n * @param init - An object containing any custom settings that you want to apply to the request.\n * @param preferredBehaviour - A request behaviour object that overrides the default behaviour.\n * @returns A promise that resolves with the response.\n */\nexport async function shopifyFetch(\n  url: RequestInfo,\n  init?: RequestInit,\n  preferredBehaviour?: RequestModeInput,\n): Promise<Response> {\n  const options = {\n    url,\n    init,\n    logRequest: true,\n    useHttpsAgent: true,\n    // special behaviours enabled by default\n    behaviour: preferredBehaviour ? requestMode(preferredBehaviour) : requestMode(),\n  }\n\n  return innerFetch(options)\n}\n\n/**\n * Download a file from a URL to a local path.\n *\n * @param url - The URL to download from.\n * @param to - The local path to download to.\n * @returns - A promise that resolves with the local path.\n */\nexport function downloadFile(url: string, to: string): Promise<string> {\n  const sanitizedUrl = sanitizeURL(url)\n  outputDebug(`Downloading ${sanitizedUrl} to ${to}`)\n\n  return runWithTimer('cmd_all_timing_network_ms')(() => {\n    return new Promise<string>((resolve, reject) => {\n      if (!fileExistsSync(dirname(to))) {\n        mkdirSync(dirname(to))\n      }\n\n      const file = createFileWriteStream(to)\n\n      // if we can't remove the file for some reason (seen on windows), that's ok -- it's in a temporary directory\n      const tryToRemoveFile = () => {\n        try {\n          unlinkFileSync(to)\n          // eslint-disable-next-line no-catch-all/no-catch-all, @typescript-eslint/no-explicit-any\n        } catch (err: any) {\n          outputDebug(outputContent`Failed to remove file ${outputToken.path(to)}: ${err}`)\n        }\n      }\n\n      file.on('finish', () => {\n        file.close()\n        resolve(to)\n      })\n\n      file.on('error', (err) => {\n        tryToRemoveFile()\n        reject(err)\n      })\n\n      nodeFetch(url, {redirect: 'follow'})\n        .then((res) => {\n          res.body?.pipe(file)\n        })\n        .catch((err) => {\n          tryToRemoveFile()\n          reject(err)\n        })\n    })\n  })\n}\n"]}

package/dist/public/node/monorail.js

@@ -26,7 +26,7 @@ export async function publishMonorailEvent(schemaId, publicData, sensitiveData)
         const payload = { ...publicData, ...sensitiveData };
         const body = JSON.stringify({ schema_id: schemaId, payload });
         const headers = buildHeaders(currentTime);
-        const response = await fetch(url, { method: 'POST', body, headers });
+        const response = await fetch(url, { method: 'POST', body, headers }, 'non-blocking');
         if (response.status === 200) {
             outputDebug(outputContent `Analytics event sent: ${outputToken.json(sanitizePayload(payload))}`);
             return { type: 'ok' };

package/dist/public/node/monorail.js.map

@@ -1 +1 @@
-{"version":3,"file":"monorail.js","sourceRoot":"","sources":["../../../src/public/node/monorail.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,EAAC,MAAM,WAAW,CAAA;AAE/B,OAAO,EAAC,WAAW,EAAE,aAAa,EAAE,WAAW,EAAC,MAAM,6BAA6B,CAAA;AAKnF,MAAM,GAAG,GAAG,iDAAiD,CAAA;AAI7D,mFAAmF;AACnF,MAAM,CAAC,MAAM,sBAAsB,GAAG,uBAAuB,CAAA;AAgK7D,MAAM,qBAAqB,GAAG,IAAI,GAAG,EAAU,CAAA;AAE/C;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,QAAmB,EACnB,UAA8B,EAC9B,aAAoC;IAEpC,qHAAqH;IACrH,MAAM,WAAW,GAAG,UAAU,CAAC,OAAO,CAAA;IACtC,IAAI,WAAW,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;QACnD,IAAI,qBAAqB,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC;YAC3C,OAAO,EAAC,IAAI,EAAE,IAAI,EAAC,CAAA;QACrB,CAAC;QACD,qBAAqB,CAAC,GAAG,CAAC,WAAW,CAAC,CAAA;IACxC,CAAC;IAED,IAAI,CAAC;QACH,MAAM,WAAW,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAA;QACxC,MAAM,OAAO,GAAG,EAAC,GAAG,UAAU,EAAE,GAAG,aAAa,EAAC,CAAA;QACjD,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,EAAC,SAAS,EAAE,QAAQ,EAAE,OAAO,EAAC,CAAC,CAAA;QAC3D,MAAM,OAAO,GAAG,YAAY,CAAC,WAAW,CAAC,CAAA;QAEzC,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,EAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAC,CAAC,CAAA;QAElE,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAC5B,WAAW,CAAC,aAAa,CAAA,yBAAyB,WAAW,CAAC,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAA;YAC/F,OAAO,EAAC,IAAI,EAAE,IAAI,EAAC,CAAA;QACrB,CAAC;aAAM,CAAC;YACN,WAAW,CAAC,qCAAqC,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAA;YACvE,OAAO,EAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,UAAU,EAAC,CAAA;QACtD,CAAC;QACD,qDAAqD;IACvD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,OAAO,GAAG,kCAAkC,CAAA;QAChD,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;YAC3B,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC,CAAA;QAChD,CAAC;QACD,WAAW,CAAC,OAAO,CAAC,CAAA;QACpB,OAAO,EAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAC,CAAA;IACjC,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,SAAS,eAAe,CAAmB,OAAU;IACnD,MAAM,MAAM,GAAG,EAAC,GAAG,OAAO,EAAC,CAAA;IAC3B,IAAI,SAAS,IAAI,MAAM,EAAE,CAAC;QACxB,MAAM,CAAC,OAAO,GAAG,MAAM,CAAA;IACzB,CAAC;IAED,OAAO,MAAM,CAAA;AACf,CAAC;AAED,MAAM,YAAY,GAAG,CAAC,WAAmB,EAAE,EAAE;IAC3C,OAAO;QACL,cAAc,EAAE,iCAAiC;QACjD,qCAAqC,EAAE,WAAW,CAAC,QAAQ,EAAE;QAC7D,kCAAkC,EAAE,WAAW,CAAC,QAAQ,EAAE;KAC3D,CAAA;AACH,CAAC,CAAA","sourcesContent":["import {fetch} from './http.js'\nimport {JsonMap} from '../../private/common/json.js'\nimport {outputDebug, outputContent, outputToken} from '../../public/node/output.js'\nimport {DeepRequired} from '../common/ts/deep-required.js'\n\nexport {DeepRequired}\n\nconst url = 'https://monorail-edge.shopifysvc.com/v1/produce'\n\ntype Optional<T> = T | null\n\n// This is the topic name of the main event we log to Monorail, the command tracker\nexport const MONORAIL_COMMAND_TOPIC = 'app_cli3_command/1.16'\n\nexport interface Schemas {\n  [MONORAIL_COMMAND_TOPIC]: {\n    sensitive: {\n      args: string\n      error_message?: Optional<string>\n      app_name?: Optional<string>\n      metadata?: Optional<string>\n      store_fqdn?: Optional<string>\n      cmd_all_environment_flags?: Optional<string>\n\n      // Dev related commands\n      cmd_dev_tunnel_custom?: Optional<string>\n\n      // Environment\n      env_plugin_installed_all?: Optional<string>\n    }\n    public: {\n      business_platform_id?: Optional<number>\n      partner_id?: Optional<number>\n      command: string\n      project_type?: Optional<string>\n      time_start: number\n      time_end: number\n      total_time: number\n      success: boolean\n      api_key?: Optional<string>\n      cli_version: string\n      uname: string\n      ruby_version: string\n      node_version: string\n      is_employee: boolean\n      store_fqdn_hash?: Optional<string>\n      user_id: string\n\n      // Any and all commands\n      cmd_all_alias_used?: Optional<string>\n      cmd_all_launcher?: Optional<string>\n      cmd_all_path_override?: Optional<boolean>\n      cmd_all_path_override_hash?: Optional<string>\n      cmd_all_plugin?: Optional<string>\n      cmd_all_topic?: Optional<string>\n      cmd_all_verbose?: Optional<boolean>\n      cmd_all_exit?: Optional<string>\n      cmd_all_force?: Optional<boolean>\n      cmd_all_last_graphql_request_id?: Optional<string>\n\n      cmd_all_timing_network_ms?: Optional<number>\n      cmd_all_timing_prompts_ms?: Optional<number>\n      cmd_all_timing_active_ms?: Optional<number>\n\n      // Any extension related command\n      cmd_extensions_binary_from_source?: Optional<boolean>\n\n      // Scaffolding related commands\n      cmd_scaffold_required_auth?: Optional<boolean>\n      cmd_scaffold_template_custom?: Optional<boolean>\n      cmd_scaffold_template_flavor?: Optional<string>\n      cmd_scaffold_type?: Optional<string>\n      cmd_scaffold_type_category?: Optional<string>\n      cmd_scaffold_type_gated?: Optional<boolean>\n      cmd_scaffold_type_owner?: Optional<string>\n      cmd_scaffold_used_prompts_for_type?: Optional<boolean>\n\n      // Used in several but not all commands\n      cmd_app_dependency_installation_skipped?: Optional<boolean>\n      cmd_app_reset_used?: Optional<boolean>\n      cmd_app_linked_config_used?: Optional<boolean>\n      cmd_app_linked_config_name?: Optional<string>\n      cmd_app_linked_config_git_tracked?: Optional<boolean>\n      cmd_app_all_configs_any?: Optional<boolean>\n      cmd_app_all_configs_clients?: Optional<string>\n      cmd_app_linked_config_source?: Optional<string>\n      cmd_app_linked_config_uses_cli_managed_urls?: Optional<boolean>\n      cmd_app_warning_api_key_deprecation_displayed?: Optional<boolean>\n      cmd_app_deployment_mode?: Optional<string>\n\n      // Dev related commands\n      cmd_dev_tunnel_type?: Optional<string>\n      cmd_dev_tunnel_custom_hash?: Optional<string>\n      cmd_dev_urls_updated?: Optional<boolean>\n      cmd_dev_preview_url_opened?: Optional<boolean>\n      cmd_dev_graphiql_opened?: Optional<boolean>\n      cmd_dev_dev_preview_toggle_used?: Optional<boolean>\n\n      // Create-app related commands\n      cmd_create_app_template?: Optional<string>\n      cmd_create_app_template_url?: Optional<string>\n\n      // Deploy related commands\n      cmd_deploy_flag_message_used?: Optional<boolean>\n      cmd_deploy_flag_version_used?: Optional<boolean>\n      cmd_deploy_flag_source_url_used?: Optional<boolean>\n      cmd_deploy_confirm_new_registrations?: Optional<number>\n      cmd_deploy_confirm_updated_registrations?: Optional<number>\n      cmd_deploy_confirm_removed_registrations?: Optional<number>\n      cmd_deploy_confirm_cancelled?: Optional<boolean>\n      cmd_deploy_confirm_time_to_complete_ms?: Optional<number>\n      cmd_deploy_prompt_upgrade_to_unified_displayed?: Optional<boolean>\n      cmd_deploy_prompt_upgrade_to_unified_response?: Optional<string>\n      cmd_deploy_confirm_include_config_used?: Optional<boolean>\n      cmd_deploy_include_config_used?: Optional<boolean>\n      cmd_deploy_config_modules_breakdown?: Optional<string>\n      cmd_deploy_config_modules_updated?: Optional<string>\n      cmd_deploy_config_modules_added?: Optional<string>\n      cmd_deploy_config_modules_deleted?: Optional<string>\n\n      // Release related commands\n      cmd_release_confirm_cancelled?: Optional<boolean>\n\n      // App setup\n      app_extensions_any?: Optional<boolean>\n      app_extensions_breakdown?: Optional<string>\n      app_extensions_count?: Optional<number>\n      app_extensions_custom_layout?: Optional<boolean>\n      app_extensions_function_any?: Optional<boolean>\n      app_extensions_function_count?: Optional<number>\n      app_extensions_function_custom_layout?: Optional<boolean>\n      app_extensions_theme_any?: Optional<boolean>\n      app_extensions_theme_count?: Optional<number>\n      app_extensions_theme_custom_layout?: Optional<boolean>\n      app_extensions_ui_any?: Optional<boolean>\n      app_extensions_ui_count?: Optional<number>\n      app_extensions_ui_custom_layout?: Optional<boolean>\n      app_name_hash?: Optional<string>\n      app_path_hash?: Optional<string>\n      app_scopes?: Optional<string>\n      app_web_backend_any?: Optional<boolean>\n      app_web_backend_count?: Optional<number>\n      app_web_custom_layout?: Optional<boolean>\n      app_web_framework?: Optional<string>\n      app_web_frontend_any?: Optional<boolean>\n      app_web_frontend_count?: Optional<number>\n\n      // Environment\n      env_ci?: Optional<boolean>\n      env_ci_platform?: Optional<string>\n      env_device_id?: Optional<string>\n      env_package_manager?: Optional<string>\n      env_package_manager_workspaces?: Optional<boolean>\n      env_plugin_installed_any_custom?: Optional<boolean>\n      env_plugin_installed_shopify?: Optional<string>\n      env_shell?: Optional<string>\n      env_web_ide?: Optional<string>\n      env_cloud?: Optional<string>\n      env_is_global?: Optional<boolean>\n      env_auth_method?: Optional<string>\n    }\n  }\n  [schemaId: string]: {sensitive: JsonMap; public: JsonMap}\n}\n\n// In reality, we're normally most interested in just this from Schemas, so export it for ease of use.\n// The monorail schema itself has lots of optional values as it must be backwards-compatible. For our schema we want mandatory values instead.\nexport type MonorailEventPublic = DeepRequired<Schemas[typeof MONORAIL_COMMAND_TOPIC]['public']>\nexport type MonorailEventSensitive = Schemas[typeof MONORAIL_COMMAND_TOPIC]['sensitive']\n\ntype MonorailResult = {type: 'ok'} | {type: 'error'; message: string}\n\nconst publishedCommandNames = new Set<string>()\n\n/**\n * Publishes an event to Monorail.\n *\n * @param schemaId - The schema ID of the event to publish.\n * @param publicData - The public data to publish.\n * @param sensitiveData - The sensitive data to publish.\n * @returns A result indicating whether the event was successfully published.\n */\nexport async function publishMonorailEvent<TSchemaId extends keyof Schemas, TPayload extends Schemas[TSchemaId]>(\n  schemaId: TSchemaId,\n  publicData: TPayload['public'],\n  sensitiveData: TPayload['sensitive'],\n): Promise<MonorailResult> {\n  // If a command has already been logged, never re-log it. This is to prevent duplication caused by unexpected errors.\n  const commandName = publicData.command\n  if (commandName && typeof commandName === 'string') {\n    if (publishedCommandNames.has(commandName)) {\n      return {type: 'ok'}\n    }\n    publishedCommandNames.add(commandName)\n  }\n\n  try {\n    const currentTime = new Date().getTime()\n    const payload = {...publicData, ...sensitiveData}\n    const body = JSON.stringify({schema_id: schemaId, payload})\n    const headers = buildHeaders(currentTime)\n\n    const response = await fetch(url, {method: 'POST', body, headers})\n\n    if (response.status === 200) {\n      outputDebug(outputContent`Analytics event sent: ${outputToken.json(sanitizePayload(payload))}`)\n      return {type: 'ok'}\n    } else {\n      outputDebug(`Failed to report usage analytics: ${response.statusText}`)\n      return {type: 'error', message: response.statusText}\n    }\n    // eslint-disable-next-line no-catch-all/no-catch-all\n  } catch (error) {\n    let message = 'Failed to report usage analytics'\n    if (error instanceof Error) {\n      message = message.concat(`: ${error.message}`)\n    }\n    outputDebug(message)\n    return {type: 'error', message}\n  }\n}\n\n/**\n * Sanitizies the api_key from the payload and returns a new hash.\n *\n * @param payload - The public and sensitive data.\n * @returns A copy of the payload with the api_key sanitized.\n */\nfunction sanitizePayload<T extends object>(payload: T): T {\n  const result = {...payload}\n  if ('api_key' in result) {\n    result.api_key = '****'\n  }\n\n  return result\n}\n\nconst buildHeaders = (currentTime: number) => {\n  return {\n    'Content-Type': 'application/json; charset=utf-8',\n    'X-Monorail-Edge-Event-Created-At-Ms': currentTime.toString(),\n    'X-Monorail-Edge-Event-Sent-At-Ms': currentTime.toString(),\n  }\n}\n"]}
+{"version":3,"file":"monorail.js","sourceRoot":"","sources":["../../../src/public/node/monorail.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,EAAC,MAAM,WAAW,CAAA;AAE/B,OAAO,EAAC,WAAW,EAAE,aAAa,EAAE,WAAW,EAAC,MAAM,6BAA6B,CAAA;AAKnF,MAAM,GAAG,GAAG,iDAAiD,CAAA;AAI7D,mFAAmF;AACnF,MAAM,CAAC,MAAM,sBAAsB,GAAG,uBAAuB,CAAA;AAgK7D,MAAM,qBAAqB,GAAG,IAAI,GAAG,EAAU,CAAA;AAE/C;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,QAAmB,EACnB,UAA8B,EAC9B,aAAoC;IAEpC,qHAAqH;IACrH,MAAM,WAAW,GAAG,UAAU,CAAC,OAAO,CAAA;IACtC,IAAI,WAAW,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;QACnD,IAAI,qBAAqB,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC;YAC3C,OAAO,EAAC,IAAI,EAAE,IAAI,EAAC,CAAA;QACrB,CAAC;QACD,qBAAqB,CAAC,GAAG,CAAC,WAAW,CAAC,CAAA;IACxC,CAAC;IAED,IAAI,CAAC;QACH,MAAM,WAAW,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAA;QACxC,MAAM,OAAO,GAAG,EAAC,GAAG,UAAU,EAAE,GAAG,aAAa,EAAC,CAAA;QACjD,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,EAAC,SAAS,EAAE,QAAQ,EAAE,OAAO,EAAC,CAAC,CAAA;QAC3D,MAAM,OAAO,GAAG,YAAY,CAAC,WAAW,CAAC,CAAA;QAEzC,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,EAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAC,EAAE,cAAc,CAAC,CAAA;QAElF,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAC5B,WAAW,CAAC,aAAa,CAAA,yBAAyB,WAAW,CAAC,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAA;YAC/F,OAAO,EAAC,IAAI,EAAE,IAAI,EAAC,CAAA;QACrB,CAAC;aAAM,CAAC;YACN,WAAW,CAAC,qCAAqC,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAA;YACvE,OAAO,EAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,UAAU,EAAC,CAAA;QACtD,CAAC;QACD,qDAAqD;IACvD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,OAAO,GAAG,kCAAkC,CAAA;QAChD,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;YAC3B,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC,CAAA;QAChD,CAAC;QACD,WAAW,CAAC,OAAO,CAAC,CAAA;QACpB,OAAO,EAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAC,CAAA;IACjC,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,SAAS,eAAe,CAAmB,OAAU;IACnD,MAAM,MAAM,GAAG,EAAC,GAAG,OAAO,EAAC,CAAA;IAC3B,IAAI,SAAS,IAAI,MAAM,EAAE,CAAC;QACxB,MAAM,CAAC,OAAO,GAAG,MAAM,CAAA;IACzB,CAAC;IAED,OAAO,MAAM,CAAA;AACf,CAAC;AAED,MAAM,YAAY,GAAG,CAAC,WAAmB,EAAE,EAAE;IAC3C,OAAO;QACL,cAAc,EAAE,iCAAiC;QACjD,qCAAqC,EAAE,WAAW,CAAC,QAAQ,EAAE;QAC7D,kCAAkC,EAAE,WAAW,CAAC,QAAQ,EAAE;KAC3D,CAAA;AACH,CAAC,CAAA","sourcesContent":["import {fetch} from './http.js'\nimport {JsonMap} from '../../private/common/json.js'\nimport {outputDebug, outputContent, outputToken} from '../../public/node/output.js'\nimport {DeepRequired} from '../common/ts/deep-required.js'\n\nexport {DeepRequired}\n\nconst url = 'https://monorail-edge.shopifysvc.com/v1/produce'\n\ntype Optional<T> = T | null\n\n// This is the topic name of the main event we log to Monorail, the command tracker\nexport const MONORAIL_COMMAND_TOPIC = 'app_cli3_command/1.16'\n\nexport interface Schemas {\n  [MONORAIL_COMMAND_TOPIC]: {\n    sensitive: {\n      args: string\n      error_message?: Optional<string>\n      app_name?: Optional<string>\n      metadata?: Optional<string>\n      store_fqdn?: Optional<string>\n      cmd_all_environment_flags?: Optional<string>\n\n      // Dev related commands\n      cmd_dev_tunnel_custom?: Optional<string>\n\n      // Environment\n      env_plugin_installed_all?: Optional<string>\n    }\n    public: {\n      business_platform_id?: Optional<number>\n      partner_id?: Optional<number>\n      command: string\n      project_type?: Optional<string>\n      time_start: number\n      time_end: number\n      total_time: number\n      success: boolean\n      api_key?: Optional<string>\n      cli_version: string\n      uname: string\n      ruby_version: string\n      node_version: string\n      is_employee: boolean\n      store_fqdn_hash?: Optional<string>\n      user_id: string\n\n      // Any and all commands\n      cmd_all_alias_used?: Optional<string>\n      cmd_all_launcher?: Optional<string>\n      cmd_all_path_override?: Optional<boolean>\n      cmd_all_path_override_hash?: Optional<string>\n      cmd_all_plugin?: Optional<string>\n      cmd_all_topic?: Optional<string>\n      cmd_all_verbose?: Optional<boolean>\n      cmd_all_exit?: Optional<string>\n      cmd_all_force?: Optional<boolean>\n      cmd_all_last_graphql_request_id?: Optional<string>\n\n      cmd_all_timing_network_ms?: Optional<number>\n      cmd_all_timing_prompts_ms?: Optional<number>\n      cmd_all_timing_active_ms?: Optional<number>\n\n      // Any extension related command\n      cmd_extensions_binary_from_source?: Optional<boolean>\n\n      // Scaffolding related commands\n      cmd_scaffold_required_auth?: Optional<boolean>\n      cmd_scaffold_template_custom?: Optional<boolean>\n      cmd_scaffold_template_flavor?: Optional<string>\n      cmd_scaffold_type?: Optional<string>\n      cmd_scaffold_type_category?: Optional<string>\n      cmd_scaffold_type_gated?: Optional<boolean>\n      cmd_scaffold_type_owner?: Optional<string>\n      cmd_scaffold_used_prompts_for_type?: Optional<boolean>\n\n      // Used in several but not all commands\n      cmd_app_dependency_installation_skipped?: Optional<boolean>\n      cmd_app_reset_used?: Optional<boolean>\n      cmd_app_linked_config_used?: Optional<boolean>\n      cmd_app_linked_config_name?: Optional<string>\n      cmd_app_linked_config_git_tracked?: Optional<boolean>\n      cmd_app_all_configs_any?: Optional<boolean>\n      cmd_app_all_configs_clients?: Optional<string>\n      cmd_app_linked_config_source?: Optional<string>\n      cmd_app_linked_config_uses_cli_managed_urls?: Optional<boolean>\n      cmd_app_warning_api_key_deprecation_displayed?: Optional<boolean>\n      cmd_app_deployment_mode?: Optional<string>\n\n      // Dev related commands\n      cmd_dev_tunnel_type?: Optional<string>\n      cmd_dev_tunnel_custom_hash?: Optional<string>\n      cmd_dev_urls_updated?: Optional<boolean>\n      cmd_dev_preview_url_opened?: Optional<boolean>\n      cmd_dev_graphiql_opened?: Optional<boolean>\n      cmd_dev_dev_preview_toggle_used?: Optional<boolean>\n\n      // Create-app related commands\n      cmd_create_app_template?: Optional<string>\n      cmd_create_app_template_url?: Optional<string>\n\n      // Deploy related commands\n      cmd_deploy_flag_message_used?: Optional<boolean>\n      cmd_deploy_flag_version_used?: Optional<boolean>\n      cmd_deploy_flag_source_url_used?: Optional<boolean>\n      cmd_deploy_confirm_new_registrations?: Optional<number>\n      cmd_deploy_confirm_updated_registrations?: Optional<number>\n      cmd_deploy_confirm_removed_registrations?: Optional<number>\n      cmd_deploy_confirm_cancelled?: Optional<boolean>\n      cmd_deploy_confirm_time_to_complete_ms?: Optional<number>\n      cmd_deploy_prompt_upgrade_to_unified_displayed?: Optional<boolean>\n      cmd_deploy_prompt_upgrade_to_unified_response?: Optional<string>\n      cmd_deploy_confirm_include_config_used?: Optional<boolean>\n      cmd_deploy_include_config_used?: Optional<boolean>\n      cmd_deploy_config_modules_breakdown?: Optional<string>\n      cmd_deploy_config_modules_updated?: Optional<string>\n      cmd_deploy_config_modules_added?: Optional<string>\n      cmd_deploy_config_modules_deleted?: Optional<string>\n\n      // Release related commands\n      cmd_release_confirm_cancelled?: Optional<boolean>\n\n      // App setup\n      app_extensions_any?: Optional<boolean>\n      app_extensions_breakdown?: Optional<string>\n      app_extensions_count?: Optional<number>\n      app_extensions_custom_layout?: Optional<boolean>\n      app_extensions_function_any?: Optional<boolean>\n      app_extensions_function_count?: Optional<number>\n      app_extensions_function_custom_layout?: Optional<boolean>\n      app_extensions_theme_any?: Optional<boolean>\n      app_extensions_theme_count?: Optional<number>\n      app_extensions_theme_custom_layout?: Optional<boolean>\n      app_extensions_ui_any?: Optional<boolean>\n      app_extensions_ui_count?: Optional<number>\n      app_extensions_ui_custom_layout?: Optional<boolean>\n      app_name_hash?: Optional<string>\n      app_path_hash?: Optional<string>\n      app_scopes?: Optional<string>\n      app_web_backend_any?: Optional<boolean>\n      app_web_backend_count?: Optional<number>\n      app_web_custom_layout?: Optional<boolean>\n      app_web_framework?: Optional<string>\n      app_web_frontend_any?: Optional<boolean>\n      app_web_frontend_count?: Optional<number>\n\n      // Environment\n      env_ci?: Optional<boolean>\n      env_ci_platform?: Optional<string>\n      env_device_id?: Optional<string>\n      env_package_manager?: Optional<string>\n      env_package_manager_workspaces?: Optional<boolean>\n      env_plugin_installed_any_custom?: Optional<boolean>\n      env_plugin_installed_shopify?: Optional<string>\n      env_shell?: Optional<string>\n      env_web_ide?: Optional<string>\n      env_cloud?: Optional<string>\n      env_is_global?: Optional<boolean>\n      env_auth_method?: Optional<string>\n    }\n  }\n  [schemaId: string]: {sensitive: JsonMap; public: JsonMap}\n}\n\n// In reality, we're normally most interested in just this from Schemas, so export it for ease of use.\n// The monorail schema itself has lots of optional values as it must be backwards-compatible. For our schema we want mandatory values instead.\nexport type MonorailEventPublic = DeepRequired<Schemas[typeof MONORAIL_COMMAND_TOPIC]['public']>\nexport type MonorailEventSensitive = Schemas[typeof MONORAIL_COMMAND_TOPIC]['sensitive']\n\ntype MonorailResult = {type: 'ok'} | {type: 'error'; message: string}\n\nconst publishedCommandNames = new Set<string>()\n\n/**\n * Publishes an event to Monorail.\n *\n * @param schemaId - The schema ID of the event to publish.\n * @param publicData - The public data to publish.\n * @param sensitiveData - The sensitive data to publish.\n * @returns A result indicating whether the event was successfully published.\n */\nexport async function publishMonorailEvent<TSchemaId extends keyof Schemas, TPayload extends Schemas[TSchemaId]>(\n  schemaId: TSchemaId,\n  publicData: TPayload['public'],\n  sensitiveData: TPayload['sensitive'],\n): Promise<MonorailResult> {\n  // If a command has already been logged, never re-log it. This is to prevent duplication caused by unexpected errors.\n  const commandName = publicData.command\n  if (commandName && typeof commandName === 'string') {\n    if (publishedCommandNames.has(commandName)) {\n      return {type: 'ok'}\n    }\n    publishedCommandNames.add(commandName)\n  }\n\n  try {\n    const currentTime = new Date().getTime()\n    const payload = {...publicData, ...sensitiveData}\n    const body = JSON.stringify({schema_id: schemaId, payload})\n    const headers = buildHeaders(currentTime)\n\n    const response = await fetch(url, {method: 'POST', body, headers}, 'non-blocking')\n\n    if (response.status === 200) {\n      outputDebug(outputContent`Analytics event sent: ${outputToken.json(sanitizePayload(payload))}`)\n      return {type: 'ok'}\n    } else {\n      outputDebug(`Failed to report usage analytics: ${response.statusText}`)\n      return {type: 'error', message: response.statusText}\n    }\n    // eslint-disable-next-line no-catch-all/no-catch-all\n  } catch (error) {\n    let message = 'Failed to report usage analytics'\n    if (error instanceof Error) {\n      message = message.concat(`: ${error.message}`)\n    }\n    outputDebug(message)\n    return {type: 'error', message}\n  }\n}\n\n/**\n * Sanitizies the api_key from the payload and returns a new hash.\n *\n * @param payload - The public and sensitive data.\n * @returns A copy of the payload with the api_key sanitized.\n */\nfunction sanitizePayload<T extends object>(payload: T): T {\n  const result = {...payload}\n  if ('api_key' in result) {\n    result.api_key = '****'\n  }\n\n  return result\n}\n\nconst buildHeaders = (currentTime: number) => {\n  return {\n    'Content-Type': 'application/json; charset=utf-8',\n    'X-Monorail-Edge-Event-Created-At-Ms': currentTime.toString(),\n    'X-Monorail-Edge-Event-Sent-At-Ms': currentTime.toString(),\n  }\n}\n"]}