@shopify/oxygen-cli 2.3.2 → 2.4.0

package/dist/deploy/index.js

@@ -5,7 +5,7 @@ import { glob } from '@shopify/cli-kit/node/fs';
 import { stderrLogger, verifyConfig } from '../utils/utils.js';
 export { parseToken } from '../utils/utils.js';
 import { initializeBugsnag, getBugsnag } from '../utils/bugsnag.js';
-import { MetricsExporter } from '../utils/metrics-exporter.js';
+import { MetricsExporter, MetricName } from '../utils/metrics-exporter.js';
 import { buildInitiate } from './build-initiate.js';
 import { buildCancel } from './build-cancel.js';
 import { getUploadFiles } from './get-upload-files.js';
@@ -19,6 +19,7 @@ import { buildProject } from './build-project.js';
 import { getMetadata, createLabels, getEnvironmentInput } from './metadata.js';
 
 async function createDeploy(options) {
+  const cliStartTime = performance.now();
   initializeBugsnag(!options.config.bugsnag);
   const Bugsnag = getBugsnag();
   Bugsnag?.addMetadata("config", {
@@ -86,6 +87,7 @@ async function createDeploy(options) {
       config,
       deployment.deployment.id
     );
+    metricsExporter.add(MetricName.TotalTime, performance.now() - cliStartTime);
     await metricsExporter.export();
     if (!config.skipVerification) {
       await verifyDeployment({

package/dist/deploy/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/deploy/index.ts"],"names":[],"mappings":"AAAA,SAAQ,YAAW;AACnB,SAAQ,iBAAgB;AAExB;AAAA,EAEE;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP,SAAQ,YAAW;AAEnB,SAAQ,cAAc,oBAAmB;AACzC,SAAQ,YAAY,yBAAwB;AAC5C,SAAQ,uBAAkC;AAE1C,SAAQ,qBAAoB;AAC5B,SAAQ,mBAAkB;AAC1B,SAAQ,sBAAqB;AAC7B,SAAQ,0BAAyB;AACjC,SAAQ,0BAAyB;AACjC,SAAQ,wBAAuB;AAC/B,SAAQ,wBAAuB;AAC/B,SAAQ,mBAAkB;AAC1B;AAAA,EAIE;AAAA,OACK;AACP,SAAQ,oBAAmB;AAC3B,SAAQ,cAAc,aAAa,2BAA0B;AAQ7D,eAAsB,aACpB,SAC6B;AAC7B,oBAAkB,CAAC,QAAQ,OAAO,OAAO;AACzC,QAAM,UAAU,WAAW;AAC3B,WAAS,YAAY,UAAU;AAAA,IAC7B,GAAG,QAAQ;AAAA,IACX,iBAAiB,EAAC,GAAG,QAAQ,OAAO,iBAAiB,aAAa,MAAK;AAAA,EACzE,CAAC;AAED,QAAM,EAAC,QAAQ,MAAK,IAAI;AACxB,QAAM,SAAS,QAAQ,UAAU;AACjC,QAAM,QAAQ,CAAC;AACf,MAAI;AACJ,MAAI;AACJ,QAAM,gBAAgB,MAAM,KAAK,GAAG,OAAO,QAAS,OAAO;AAAA,IACzD,QAAQ,CAAC,GAAG,OAAO,QAAS,qBAAqB;AAAA,EACnD,CAAC;AAED,MAAI;AACF,UAAM,WAAW,MAAM,YAAY,QAAQ,MAAM;AACjD,UAAM,SAAS,aAAa,QAAQ;AACpC,UAAM,cAAc,oBAAoB,QAAQ,QAAQ;AACxD,aAAS,YAAY,YAAY;AAAA,MAC/B;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC;AACD,UAAM,kBAAkB,IAAI,gBAAgB;AAAA,MAC1C,YAAY,SAAS,QAAQ;AAAA,MAC7B,UAAU,OAAO;AAAA,IACnB,CAAC;AAED,QAAI,CAAC,OAAO,cAAc,CAAC,OAAO,WAAW;AAC3C,YAAM,wBAAwB,MAAM,cAAc;AAAA,QAChD;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,MACF,CAAC;AACD,YAAM,KAAK,sBAAsB,MAAM;AACvC,YAAM,YAAY,sBAAsB,MAAM;AAAA,IAChD;AAEA,QAAI,CAAC,OAAO,WAAW;AACrB,YAAM,aAAa;AAAA,QACjB;AAAA,QACA,WAAW,MAAM;AAAA,QACjB;AAAA,QACA;AAAA,MACF,CAAC;AACD,YAAM,aAAa,EAAC,QAAQ,gBAAgB,KAAI,CAAC;AAAA,IACnD;AACA,qBAAiB;AAEjB,UAAM,WAAW,MAAM,eAAe,QAAQ,eAAe;AAC7D,aAAS,YAAY,YAAY,QAAQ;AACzC,UAAM,0BAA0B,MAAM,KAClC,EAAC,SAAS,MAAM,IAAI,SAAQ,IAC5B,EAAC,aAAa,UAAU,OAAM;AAElC,iBAAa,MAAM,mBAAmB;AAAA,MACpC;AAAA,MACA,OAAO;AAAA,MACP;AAAA,IACF,CAAC;AACD,aAAS,YAAY,WAAW,WAAW,iBAAiB;AAE5D,UAAM,YAAY;AAAA,MAChB;AAAA,MACA,SAAS,WAAW;AAAA,MACpB;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC;AACD,UAAM,uBAAuB,MAAM;AAAA,MACjC;AAAA,MACA,WAAW,WAAW;AAAA,IACxB;AACA,UAAM,gBAAgB,OAAO;AAE7B,QAAI,CAAC,OAAO,kBAAkB;AAC5B,YAAM,iBAAiB;AAAA,QACrB;AAAA,QACA,KAAK,qBAAqB,WAAW;AAAA,QACrC;AAAA,QACA;AAAA,MACF,CAAC;AAAA,IACH;AAEA,UAAM,aAAa,OAAO,mBAAmB,WAAW;AACxD;AAAA,MACE;AAAA,uCAA0C,qBAAqB,WAAW,GAAG,IAAI,UAAU;AAAA,MAC3F;AAAA,IACF;AAEA,QAAI,SAAS,SAAS,QAAQ;AAC5B,iBAAW,qBAAqB,WAAW,GAAG;AAAA,IAChD;AAEA,WAAO,qBAAqB,WAAW;AAAA,EACzC,SAAS,OAAO;AACd,QAAI,MAAM,MAAM,CAAC,gBAAgB;AAC/B,UAAI;AACF,cAAM,cAAc,UAAU,IAAI;AAClC,cAAM,EAAC,OAAM,IAAI,MAAM;AAAA,UACrB;AAAA,UACA;AAAA,YACE,KAAK,OAAO;AAAA,YACZ,WAAW,OAAO,OAAO;AAAA,UAC3B;AAAA,QACF;AAEA,iBAAS,YAAY,oBAAoB;AAAA,UACvC;AAAA,UACA,gBAAgB,MAAM,KAAK,GAAG,OAAO,QAAS,OAAO;AAAA,YACnD,QAAQ,CAAC,GAAG,OAAO,QAAS,qBAAqB;AAAA,UACnD,CAAC;AAAA,UACD,KAAK,QAAQ,IAAI;AAAA,UACjB,MAAM;AAAA,QACR,CAAC;AAAA,MACH,SAAS,KAAK;AAAA,MAEd;AAAA,IACF;AACA,QACE,OAAO,WACP,YACC,iBAAiB,SAAS,OAAO,UAAU,WAC5C;AACA,cAAQ,OAAO,KAAK;AAAA,IACtB;AAEA,QAAI,EAAE,iBAAiB,QAAQ;AAE7B,cAAQ,MAAM,iBAAiB,KAAK;AACpC,aAAO,QAAQ,OAAO,IAAI,MAAM,eAAe,CAAC;AAAA,IAClD;AAEA,QAAI,iBAAiB,mBAAmB;AACtC,iBAAW,MAAM,SAAS,MAAM;AAAA,IAClC,WAAW,MAAM,MAAM,CAAC,gBAAgB;AACtC;AAAA,QACE,sBAAsB,MAAM,OAAO;AAAA,QACnC;AAAA,MACF;AAEA,YAAM,YAAY;AAAA,QAChB;AAAA,QACA,SAAS,MAAM;AAAA,QACf,QAAQ,MAAM;AAAA,QACd;AAAA,MACF,CAAC,EAAE,MAAM,CAAC,QAAQ;AAChB,YAAI,eAAe,OAAO;AACxB,qBAAW,2BAA2B,IAAI,OAAO,IAAI,MAAM;AAAA,QAC7D;AAAA,MACF,CAAC;AAAA,IACH,WAAW,YAAY,WAAW,IAAI;AACpC;AAAA,QACE,2BAA2B,MAAM,OAAO;AAAA,QACxC;AAAA,MACF;AACA,YAAM,iBAAiB;AAAA,QACrB;AAAA,QACA,cAAc,WAAW,WAAW;AAAA,QACpC,QAAQ,MAAM;AAAA,QACd;AAAA,MACF,CAAC,EAAE,MAAM,CAAC,QAAQ;AAChB,YAAI,eAAe,OAAO;AACxB,qBAAW,gCAAgC,IAAI,OAAO,IAAI,MAAM;AAAA,QAClE;AAAA,MACF,CAAC;AAAA,IACH;AACA,WAAO,QAAQ,OAAO,KAAK;AAAA,EAC7B;AACF;AAGA,SAAQ,kBAAiB","sourcesContent":["import {exec} from 'child_process';\nimport {promisify} from 'util';\n\nimport {\n  Logger,\n  outputInfo,\n  outputSuccess,\n  outputWarn,\n} from '@shopify/cli-kit/node/output';\nimport {glob} from '@shopify/cli-kit/node/fs';\n\nimport {stderrLogger, verifyConfig} from '../utils/utils.js';\nimport {getBugsnag, initializeBugsnag} from '../utils/bugsnag.js';\nimport {MetricsExporter, MetricName} from '../utils/metrics-exporter.js';\n\nimport {buildInitiate} from './build-initiate.js';\nimport {buildCancel} from './build-cancel.js';\nimport {getUploadFiles} from './get-upload-files.js';\nimport {deploymentInitiate} from './deployment-initiate.js';\nimport {deploymentComplete} from './deployment-complete.js';\nimport {verifyDeployment} from './verify-deployment.js';\nimport {deploymentCancel} from './deployment-cancel.js';\nimport {uploadFiles} from './upload-files.js';\nimport {\n  Build,\n  DeploymentConfig,\n  DeploymentHooks,\n  VerificationError,\n} from './types.js';\nimport {buildProject} from './build-project.js';\nimport {createLabels, getMetadata, getEnvironmentInput} from './metadata.js';\n\ninterface CreateDeployOptions {\n  config: DeploymentConfig;\n  hooks?: DeploymentHooks;\n  logger?: Logger;\n}\n\nexport async function createDeploy(\n  options: CreateDeployOptions,\n): Promise<string | undefined> {\n  initializeBugsnag(!options.config.bugsnag);\n  const Bugsnag = getBugsnag();\n  Bugsnag?.addMetadata('config', {\n    ...options.config,\n    deploymentToken: {...options.config.deploymentToken, accessToken: '***'},\n  });\n\n  const {config, hooks} = options;\n  const logger = options.logger ?? stderrLogger;\n  const build = {} as Build;\n  let buildCompleted;\n  let deployment;\n  const preBuildFiles = await glob(`${config.rootPath!}/**`, {\n    ignore: [`${config.rootPath!}/**/node_modules/**`],\n  });\n\n  try {\n    const metadata = await getMetadata(config, logger);\n    const labels = createLabels(metadata);\n    const environment = getEnvironmentInput(config, metadata);\n    Bugsnag?.addMetadata('metadata', {\n      environment,\n      labels,\n      metadata,\n    });\n    const metricsExporter = new MetricsExporter({\n      ciProvider: metadata.name || 'unknown',\n      rootPath: config.rootPath!,\n    });\n\n    if (!config.workerOnly && !config.skipBuild) {\n      const buildInitiateResponse = await buildInitiate({\n        config,\n        environment,\n        labels,\n        logger,\n      });\n      build.id = buildInitiateResponse.build.id;\n      build.assetPath = buildInitiateResponse.build.assetPath;\n    }\n\n    if (!config.skipBuild) {\n      await buildProject({\n        config,\n        assetPath: build.assetPath,\n        hooks,\n        metricsExporter,\n      });\n      await verifyConfig({config, performedBuild: true});\n    }\n    buildCompleted = true;\n\n    const manifest = await getUploadFiles(config, metricsExporter);\n    Bugsnag?.addMetadata('manifest', manifest);\n    const deploymentInitiateInput = build.id\n      ? {buildId: build.id, manifest}\n      : {environment, manifest, labels};\n\n    deployment = await deploymentInitiate({\n      config,\n      input: deploymentInitiateInput,\n      logger,\n    });\n    Bugsnag?.addMetadata('targets', deployment.deploymentTargets);\n\n    await uploadFiles({\n      config,\n      targets: deployment.deploymentTargets,\n      hooks,\n      logger,\n      metricsExporter,\n    });\n    const deploymentCompleteOp = await deploymentComplete(\n      config,\n      deployment.deployment.id,\n    );\n    await metricsExporter.export();\n\n    if (!config.skipVerification) {\n      await verifyDeployment({\n        config,\n        url: deploymentCompleteOp.deployment.url,\n        logger,\n        hooks,\n      });\n    }\n\n    const urlMessage = config.publicDeployment ? 'public' : 'private';\n    outputSuccess(\n      `\\nThe deployment can be reached at the ${deploymentCompleteOp.deployment.url} ${urlMessage} preview URL`,\n      logger,\n    );\n    // in CI environments, we want to output the URL to stdout\n    if (metadata.name !== 'none') {\n      outputInfo(deploymentCompleteOp.deployment.url);\n    }\n\n    return deploymentCompleteOp.deployment.url;\n  } catch (error) {\n    if (build.id && !buildCompleted) {\n      try {\n        const execPromise = promisify(exec);\n        const {stdout} = await execPromise(\n          `git diff main...HEAD ':(exclude)package-lock.json' ':(exclude)dist'`,\n          {\n            cwd: config.rootPath!,\n            maxBuffer: 1024 * 1024 * 10,\n          },\n        );\n\n        Bugsnag?.addMetadata('folder_structure', {\n          preBuildFiles,\n          postBuildFiles: await glob(`${config.rootPath!}/**`, {\n            ignore: [`${config.rootPath!}/**/node_modules/**`],\n          }),\n          cwd: process.cwd(),\n          diff: stdout,\n        });\n      } catch (err) {\n        //  ignore  errors\n      }\n    }\n    if (\n      config.bugsnag &&\n      Bugsnag &&\n      (error instanceof Error || typeof error === 'string')\n    ) {\n      Bugsnag.notify(error);\n    }\n\n    if (!(error instanceof Error)) {\n      // eslint-disable-next-line no-console\n      console.error('Unknown error', error);\n      return Promise.reject(new Error('Unknown error'));\n    }\n\n    if (error instanceof VerificationError) {\n      outputWarn(error.message, logger);\n    } else if (build.id && !buildCompleted) {\n      outputWarn(\n        `Build failed with: ${error.message}, cancelling build.`,\n        logger,\n      );\n\n      await buildCancel({\n        config,\n        buildId: build.id!,\n        reason: error.message,\n        logger,\n      }).catch((err) => {\n        if (err instanceof Error) {\n          outputWarn(`Failed to cancel build: ${err.message}`, logger);\n        }\n      });\n    } else if (deployment?.deployment.id) {\n      outputWarn(\n        `Deployment failed with: ${error.message}, cancelling deployment.`,\n        logger,\n      );\n      await deploymentCancel({\n        config,\n        deploymentId: deployment.deployment.id,\n        reason: error.message,\n        logger,\n      }).catch((err) => {\n        if (err instanceof Error) {\n          outputWarn(`Failed to cancel deployment: ${err.message}`, logger);\n        }\n      });\n    }\n    return Promise.reject(error);\n  }\n}\n\nexport type {DeploymentConfig, DeploymentHooks};\nexport {parseToken} from '../utils/utils.js';\n"]}
+{"version":3,"sources":["../../src/deploy/index.ts"],"names":[],"mappings":"AAAA,SAAQ,YAAW;AACnB,SAAQ,iBAAgB;AAExB;AAAA,EAEE;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP,SAAQ,YAAW;AAEnB,SAAQ,cAAc,oBAAmB;AACzC,SAAQ,YAAY,yBAAwB;AAC5C,SAAQ,iBAAiB,kBAAiB;AAE1C,SAAQ,qBAAoB;AAC5B,SAAQ,mBAAkB;AAC1B,SAAQ,sBAAqB;AAC7B,SAAQ,0BAAyB;AACjC,SAAQ,0BAAyB;AACjC,SAAQ,wBAAuB;AAC/B,SAAQ,wBAAuB;AAC/B,SAAQ,mBAAkB;AAC1B;AAAA,EAIE;AAAA,OACK;AACP,SAAQ,oBAAmB;AAC3B,SAAQ,cAAc,aAAa,2BAA0B;AAQ7D,eAAsB,aACpB,SAC6B;AAC7B,QAAM,eAAe,YAAY,IAAI;AACrC,oBAAkB,CAAC,QAAQ,OAAO,OAAO;AACzC,QAAM,UAAU,WAAW;AAC3B,WAAS,YAAY,UAAU;AAAA,IAC7B,GAAG,QAAQ;AAAA,IACX,iBAAiB,EAAC,GAAG,QAAQ,OAAO,iBAAiB,aAAa,MAAK;AAAA,EACzE,CAAC;AAED,QAAM,EAAC,QAAQ,MAAK,IAAI;AACxB,QAAM,SAAS,QAAQ,UAAU;AACjC,QAAM,QAAQ,CAAC;AACf,MAAI;AACJ,MAAI;AACJ,QAAM,gBAAgB,MAAM,KAAK,GAAG,OAAO,QAAS,OAAO;AAAA,IACzD,QAAQ,CAAC,GAAG,OAAO,QAAS,qBAAqB;AAAA,EACnD,CAAC;AAED,MAAI;AACF,UAAM,WAAW,MAAM,YAAY,QAAQ,MAAM;AACjD,UAAM,SAAS,aAAa,QAAQ;AACpC,UAAM,cAAc,oBAAoB,QAAQ,QAAQ;AACxD,aAAS,YAAY,YAAY;AAAA,MAC/B;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC;AACD,UAAM,kBAAkB,IAAI,gBAAgB;AAAA,MAC1C,YAAY,SAAS,QAAQ;AAAA,MAC7B,UAAU,OAAO;AAAA,IACnB,CAAC;AAED,QAAI,CAAC,OAAO,cAAc,CAAC,OAAO,WAAW;AAC3C,YAAM,wBAAwB,MAAM,cAAc;AAAA,QAChD;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,MACF,CAAC;AACD,YAAM,KAAK,sBAAsB,MAAM;AACvC,YAAM,YAAY,sBAAsB,MAAM;AAAA,IAChD;AAEA,QAAI,CAAC,OAAO,WAAW;AACrB,YAAM,aAAa;AAAA,QACjB;AAAA,QACA,WAAW,MAAM;AAAA,QACjB;AAAA,QACA;AAAA,MACF,CAAC;AACD,YAAM,aAAa,EAAC,QAAQ,gBAAgB,KAAI,CAAC;AAAA,IACnD;AACA,qBAAiB;AAEjB,UAAM,WAAW,MAAM,eAAe,QAAQ,eAAe;AAC7D,aAAS,YAAY,YAAY,QAAQ;AACzC,UAAM,0BAA0B,MAAM,KAClC,EAAC,SAAS,MAAM,IAAI,SAAQ,IAC5B,EAAC,aAAa,UAAU,OAAM;AAElC,iBAAa,MAAM,mBAAmB;AAAA,MACpC;AAAA,MACA,OAAO;AAAA,MACP;AAAA,IACF,CAAC;AACD,aAAS,YAAY,WAAW,WAAW,iBAAiB;AAE5D,UAAM,YAAY;AAAA,MAChB;AAAA,MACA,SAAS,WAAW;AAAA,MACpB;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC;AACD,UAAM,uBAAuB,MAAM;AAAA,MACjC;AAAA,MACA,WAAW,WAAW;AAAA,IACxB;AACA,oBAAgB,IAAI,WAAW,WAAW,YAAY,IAAI,IAAI,YAAY;AAC1E,UAAM,gBAAgB,OAAO;AAE7B,QAAI,CAAC,OAAO,kBAAkB;AAC5B,YAAM,iBAAiB;AAAA,QACrB;AAAA,QACA,KAAK,qBAAqB,WAAW;AAAA,QACrC;AAAA,QACA;AAAA,MACF,CAAC;AAAA,IACH;AAEA,UAAM,aAAa,OAAO,mBAAmB,WAAW;AACxD;AAAA,MACE;AAAA,uCAA0C,qBAAqB,WAAW,GAAG,IAAI,UAAU;AAAA,MAC3F;AAAA,IACF;AAEA,QAAI,SAAS,SAAS,QAAQ;AAC5B,iBAAW,qBAAqB,WAAW,GAAG;AAAA,IAChD;AAEA,WAAO,qBAAqB,WAAW;AAAA,EACzC,SAAS,OAAO;AACd,QAAI,MAAM,MAAM,CAAC,gBAAgB;AAC/B,UAAI;AACF,cAAM,cAAc,UAAU,IAAI;AAClC,cAAM,EAAC,OAAM,IAAI,MAAM;AAAA,UACrB;AAAA,UACA;AAAA,YACE,KAAK,OAAO;AAAA,YACZ,WAAW,OAAO,OAAO;AAAA,UAC3B;AAAA,QACF;AAEA,iBAAS,YAAY,oBAAoB;AAAA,UACvC;AAAA,UACA,gBAAgB,MAAM,KAAK,GAAG,OAAO,QAAS,OAAO;AAAA,YACnD,QAAQ,CAAC,GAAG,OAAO,QAAS,qBAAqB;AAAA,UACnD,CAAC;AAAA,UACD,KAAK,QAAQ,IAAI;AAAA,UACjB,MAAM;AAAA,QACR,CAAC;AAAA,MACH,SAAS,KAAK;AAAA,MAEd;AAAA,IACF;AACA,QACE,OAAO,WACP,YACC,iBAAiB,SAAS,OAAO,UAAU,WAC5C;AACA,cAAQ,OAAO,KAAK;AAAA,IACtB;AAEA,QAAI,EAAE,iBAAiB,QAAQ;AAE7B,cAAQ,MAAM,iBAAiB,KAAK;AACpC,aAAO,QAAQ,OAAO,IAAI,MAAM,eAAe,CAAC;AAAA,IAClD;AAEA,QAAI,iBAAiB,mBAAmB;AACtC,iBAAW,MAAM,SAAS,MAAM;AAAA,IAClC,WAAW,MAAM,MAAM,CAAC,gBAAgB;AACtC;AAAA,QACE,sBAAsB,MAAM,OAAO;AAAA,QACnC;AAAA,MACF;AAEA,YAAM,YAAY;AAAA,QAChB;AAAA,QACA,SAAS,MAAM;AAAA,QACf,QAAQ,MAAM;AAAA,QACd;AAAA,MACF,CAAC,EAAE,MAAM,CAAC,QAAQ;AAChB,YAAI,eAAe,OAAO;AACxB,qBAAW,2BAA2B,IAAI,OAAO,IAAI,MAAM;AAAA,QAC7D;AAAA,MACF,CAAC;AAAA,IACH,WAAW,YAAY,WAAW,IAAI;AACpC;AAAA,QACE,2BAA2B,MAAM,OAAO;AAAA,QACxC;AAAA,MACF;AACA,YAAM,iBAAiB;AAAA,QACrB;AAAA,QACA,cAAc,WAAW,WAAW;AAAA,QACpC,QAAQ,MAAM;AAAA,QACd;AAAA,MACF,CAAC,EAAE,MAAM,CAAC,QAAQ;AAChB,YAAI,eAAe,OAAO;AACxB,qBAAW,gCAAgC,IAAI,OAAO,IAAI,MAAM;AAAA,QAClE;AAAA,MACF,CAAC;AAAA,IACH;AACA,WAAO,QAAQ,OAAO,KAAK;AAAA,EAC7B;AACF;AAGA,SAAQ,kBAAiB","sourcesContent":["import {exec} from 'child_process';\nimport {promisify} from 'util';\n\nimport {\n  Logger,\n  outputInfo,\n  outputSuccess,\n  outputWarn,\n} from '@shopify/cli-kit/node/output';\nimport {glob} from '@shopify/cli-kit/node/fs';\n\nimport {stderrLogger, verifyConfig} from '../utils/utils.js';\nimport {getBugsnag, initializeBugsnag} from '../utils/bugsnag.js';\nimport {MetricsExporter, MetricName} from '../utils/metrics-exporter.js';\n\nimport {buildInitiate} from './build-initiate.js';\nimport {buildCancel} from './build-cancel.js';\nimport {getUploadFiles} from './get-upload-files.js';\nimport {deploymentInitiate} from './deployment-initiate.js';\nimport {deploymentComplete} from './deployment-complete.js';\nimport {verifyDeployment} from './verify-deployment.js';\nimport {deploymentCancel} from './deployment-cancel.js';\nimport {uploadFiles} from './upload-files.js';\nimport {\n  Build,\n  DeploymentConfig,\n  DeploymentHooks,\n  VerificationError,\n} from './types.js';\nimport {buildProject} from './build-project.js';\nimport {createLabels, getMetadata, getEnvironmentInput} from './metadata.js';\n\ninterface CreateDeployOptions {\n  config: DeploymentConfig;\n  hooks?: DeploymentHooks;\n  logger?: Logger;\n}\n\nexport async function createDeploy(\n  options: CreateDeployOptions,\n): Promise<string | undefined> {\n  const cliStartTime = performance.now();\n  initializeBugsnag(!options.config.bugsnag);\n  const Bugsnag = getBugsnag();\n  Bugsnag?.addMetadata('config', {\n    ...options.config,\n    deploymentToken: {...options.config.deploymentToken, accessToken: '***'},\n  });\n\n  const {config, hooks} = options;\n  const logger = options.logger ?? stderrLogger;\n  const build = {} as Build;\n  let buildCompleted;\n  let deployment;\n  const preBuildFiles = await glob(`${config.rootPath!}/**`, {\n    ignore: [`${config.rootPath!}/**/node_modules/**`],\n  });\n\n  try {\n    const metadata = await getMetadata(config, logger);\n    const labels = createLabels(metadata);\n    const environment = getEnvironmentInput(config, metadata);\n    Bugsnag?.addMetadata('metadata', {\n      environment,\n      labels,\n      metadata,\n    });\n    const metricsExporter = new MetricsExporter({\n      ciProvider: metadata.name || 'unknown',\n      rootPath: config.rootPath!,\n    });\n\n    if (!config.workerOnly && !config.skipBuild) {\n      const buildInitiateResponse = await buildInitiate({\n        config,\n        environment,\n        labels,\n        logger,\n      });\n      build.id = buildInitiateResponse.build.id;\n      build.assetPath = buildInitiateResponse.build.assetPath;\n    }\n\n    if (!config.skipBuild) {\n      await buildProject({\n        config,\n        assetPath: build.assetPath,\n        hooks,\n        metricsExporter,\n      });\n      await verifyConfig({config, performedBuild: true});\n    }\n    buildCompleted = true;\n\n    const manifest = await getUploadFiles(config, metricsExporter);\n    Bugsnag?.addMetadata('manifest', manifest);\n    const deploymentInitiateInput = build.id\n      ? {buildId: build.id, manifest}\n      : {environment, manifest, labels};\n\n    deployment = await deploymentInitiate({\n      config,\n      input: deploymentInitiateInput,\n      logger,\n    });\n    Bugsnag?.addMetadata('targets', deployment.deploymentTargets);\n\n    await uploadFiles({\n      config,\n      targets: deployment.deploymentTargets,\n      hooks,\n      logger,\n      metricsExporter,\n    });\n    const deploymentCompleteOp = await deploymentComplete(\n      config,\n      deployment.deployment.id,\n    );\n    metricsExporter.add(MetricName.TotalTime, performance.now() - cliStartTime);\n    await metricsExporter.export();\n\n    if (!config.skipVerification) {\n      await verifyDeployment({\n        config,\n        url: deploymentCompleteOp.deployment.url,\n        logger,\n        hooks,\n      });\n    }\n\n    const urlMessage = config.publicDeployment ? 'public' : 'private';\n    outputSuccess(\n      `\\nThe deployment can be reached at the ${deploymentCompleteOp.deployment.url} ${urlMessage} preview URL`,\n      logger,\n    );\n    // in CI environments, we want to output the URL to stdout\n    if (metadata.name !== 'none') {\n      outputInfo(deploymentCompleteOp.deployment.url);\n    }\n\n    return deploymentCompleteOp.deployment.url;\n  } catch (error) {\n    if (build.id && !buildCompleted) {\n      try {\n        const execPromise = promisify(exec);\n        const {stdout} = await execPromise(\n          `git diff main...HEAD ':(exclude)package-lock.json' ':(exclude)dist'`,\n          {\n            cwd: config.rootPath!,\n            maxBuffer: 1024 * 1024 * 10,\n          },\n        );\n\n        Bugsnag?.addMetadata('folder_structure', {\n          preBuildFiles,\n          postBuildFiles: await glob(`${config.rootPath!}/**`, {\n            ignore: [`${config.rootPath!}/**/node_modules/**`],\n          }),\n          cwd: process.cwd(),\n          diff: stdout,\n        });\n      } catch (err) {\n        //  ignore  errors\n      }\n    }\n    if (\n      config.bugsnag &&\n      Bugsnag &&\n      (error instanceof Error || typeof error === 'string')\n    ) {\n      Bugsnag.notify(error);\n    }\n\n    if (!(error instanceof Error)) {\n      // eslint-disable-next-line no-console\n      console.error('Unknown error', error);\n      return Promise.reject(new Error('Unknown error'));\n    }\n\n    if (error instanceof VerificationError) {\n      outputWarn(error.message, logger);\n    } else if (build.id && !buildCompleted) {\n      outputWarn(\n        `Build failed with: ${error.message}, cancelling build.`,\n        logger,\n      );\n\n      await buildCancel({\n        config,\n        buildId: build.id!,\n        reason: error.message,\n        logger,\n      }).catch((err) => {\n        if (err instanceof Error) {\n          outputWarn(`Failed to cancel build: ${err.message}`, logger);\n        }\n      });\n    } else if (deployment?.deployment.id) {\n      outputWarn(\n        `Deployment failed with: ${error.message}, cancelling deployment.`,\n        logger,\n      );\n      await deploymentCancel({\n        config,\n        deploymentId: deployment.deployment.id,\n        reason: error.message,\n        logger,\n      }).catch((err) => {\n        if (err instanceof Error) {\n          outputWarn(`Failed to cancel deployment: ${err.message}`, logger);\n        }\n      });\n    }\n    return Promise.reject(error);\n  }\n}\n\nexport type {DeploymentConfig, DeploymentHooks};\nexport {parseToken} from '../utils/utils.js';\n"]}

package/dist/utils/metrics-exporter.d.ts

@@ -8,6 +8,7 @@ declare enum MetricName {
     NumFilesUploaded = "num_files_uploaded",
     TotalSizeUploaded = "total_size_uploaded",
     TotalSizeRequested = "total_size_requested",
+    TotalTime = "total_time",
     UploadTime = "upload_time"
 }
 declare class MetricsExporter {

package/dist/utils/metrics-exporter.js

@@ -8,6 +8,7 @@ var MetricName = /* @__PURE__ */ ((MetricName2) => {
   MetricName2["NumFilesUploaded"] = "num_files_uploaded";
   MetricName2["TotalSizeUploaded"] = "total_size_uploaded";
   MetricName2["TotalSizeRequested"] = "total_size_requested";
+  MetricName2["TotalTime"] = "total_time";
   MetricName2["UploadTime"] = "upload_time";
   return MetricName2;
 })(MetricName || {});

package/dist/utils/metrics-exporter.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/utils/metrics-exporter.ts"],"names":["MetricName"],"mappings":"AACA,SAAQ,aAAY;AAEpB,SAAQ,kBAAiB;AACzB,SAAQ,uBAAsB;AAkBvB,IAAK,aAAL,kBAAKA,gBAAL;AACL,EAAAA,YAAA,eAAY;AACZ,EAAAA,YAAA,uBAAoB;AACpB,EAAAA,YAAA,sBAAmB;AACnB,EAAAA,YAAA,uBAAoB;AACpB,EAAAA,YAAA,wBAAqB;AACrB,EAAAA,YAAA,gBAAa;AANH,SAAAA;AAAA,GAAA;AASL,MAAM,gBAAgB;AAAA,EACnB,UAA4B,CAAC;AAAA,EACpB,eAAuB;AAAA,EACvB;AAAA,EACA;AAAA,EAEjB,YAAY,SAAiC;AAC3C,UAAM,EAAC,SAAS,WAAU,IAAI,gBAAgB;AAC9C,UAAM,EAAC,SAAS,gBAAe,IAAI;AAAA,MACjC,GAAG,QAAQ,QAAQ;AAAA,IACrB;AACA,SAAK,cAAc;AAAA,MACjB,aAAa,QAAQ;AAAA,MACrB,aAAa,cAAc,cAAc,SAAS;AAAA,MAClD,kBAAkB,mBAAmB;AAAA,IACvC;AACA,SAAK,YAAY;AAAA,EACnB;AAAA,EAEA,IACE,MACA,OACA,OAAgC,CAAC,GAC3B;AACN,UAAM,SAAS;AAAA,MACb;AAAA,MACA;AAAA,IACF;AAEA,QAAI,KAAK,QAAQ,IAAI,GAAG;AACtB,WAAK,QAAQ,IAAI,EAAG,KAAK,MAAM;AAAA,IACjC,OAAO;AACL,WAAK,QAAQ,IAAI,IAAI,CAAC,MAAM;AAAA,IAC9B;AAAA,EACF;AAAA,EAEA,WAAW,MAAyC;AAClD,WAAO,OAAO,QAAQ,IAAI,EAAE,IAAI,CAAC,CAAC,KAAK,KAAK,MAAM,GAAG,GAAG,IAAI,KAAK,EAAE;AAAA,EACrE;AAAA,EAEA,MAAM,SAAwB;AAC5B,UAAM,kBAAgC,OAAO,QAAQ,KAAK,OAAO,EAC9D,IAAI,CAAC,CAAC,YAAY,MAAM,MAAM;AAC7B,YAAM,OAAO,GAAG,KAAK,YAAY,IAAI,UAAU;AAE/C,aAAO,OAAO,IAAI,CAAC,EAAC,OAAO,KAAI,MAAM;AACnC,eAAO;AAAA,UACL;AAAA,UACA,MAAM;AAAA,UACN;AAAA,UACA,MAAM,KAAK,WAAW,EAAC,GAAG,MAAM,GAAG,KAAK,YAAW,CAAC;AAAA,QACtD;AAAA,MACF,CAAC;AAAA,IACH,CAAC,EACA,KAAK;AAER,QAAI;AACF,YAAM,MAAM,KAAK,WAAW;AAAA,QAC1B,QAAQ;AAAA,QACR,MAAM,KAAK,UAAU,EAAC,QAAQ,gBAAe,CAAC;AAAA,MAChD,CAAC;AAAA,IACH,SAAS,OAAO;AACd,YAAM,UAAU,WAAW;AAC3B,UAAI,YAAY,iBAAiB,SAAS,OAAO,UAAU,WAAW;AACpE,gBAAQ,OAAO,KAAK;AAAA,MACtB;AAAA,IACF;AAAA,EACF;AACF","sourcesContent":["/* eslint-disable @typescript-eslint/naming-convention */\nimport {fetch} from '@shopify/cli-kit/node/http';\n\nimport {getBugsnag} from './bugsnag.js';\nimport {loadPackageJson} from './utils.js';\n\ninterface GodogEvent {\n  name: string;\n  type: string;\n  value: number;\n  tags: string[];\n}\n\ninterface MetricCollection {\n  [metricName: string]: [{value: number; tags: {[key: string]: string}}];\n}\n\ninterface MetricsExporterOptions {\n  ciProvider: string;\n  rootPath: string;\n}\n\nexport enum MetricName {\n  BuildTime = 'build_time',\n  NumFilesRequested = 'num_files_requested',\n  NumFilesUploaded = 'num_files_uploaded',\n  TotalSizeUploaded = 'total_size_uploaded',\n  TotalSizeRequested = 'total_size_requested',\n  UploadTime = 'upload_time',\n}\n\nexport class MetricsExporter {\n  private metrics: MetricCollection = {};\n  private readonly metricPrefix: string = 'oxygen.cli';\n  private readonly defaultTags: {[key: string]: string};\n  private readonly exportUrl: string;\n\n  constructor(options: MetricsExporterOptions) {\n    const {version: cliVersion} = loadPackageJson();\n    const {version: hydrogenVersion} = loadPackageJson(\n      `${options.rootPath}/node_modules/@shopify/hydrogen`,\n    );\n    this.defaultTags = {\n      ci_provider: options.ciProvider,\n      cli_version: `oxygen-cli@${cliVersion || 'unknown'}`,\n      hydrogen_version: hydrogenVersion || 'unknown',\n    };\n    this.exportUrl = 'https://metrics.myshopify.dev';\n  }\n\n  add(\n    name: MetricName,\n    value: number,\n    tags: {[key: string]: string} = {},\n  ): void {\n    const metric = {\n      value,\n      tags,\n    };\n\n    if (this.metrics[name]) {\n      this.metrics[name]!.push(metric);\n    } else {\n      this.metrics[name] = [metric];\n    }\n  }\n\n  formatTags(tags: {[key: string]: string}): string[] {\n    return Object.entries(tags).map(([key, value]) => `${key}:${value}`);\n  }\n\n  async export(): Promise<void> {\n    const metricsToExport: GodogEvent[] = Object.entries(this.metrics)\n      .map(([metricName, values]) => {\n        const name = `${this.metricPrefix}.${metricName}`;\n\n        return values.map(({value, tags}) => {\n          return {\n            name,\n            type: 'gauge',\n            value,\n            tags: this.formatTags({...tags, ...this.defaultTags}),\n          };\n        });\n      })\n      .flat();\n\n    try {\n      await fetch(this.exportUrl, {\n        method: 'POST',\n        body: JSON.stringify({events: metricsToExport}),\n      });\n    } catch (error) {\n      const Bugsnag = getBugsnag();\n      if (Bugsnag && (error instanceof Error || typeof error === 'string')) {\n        Bugsnag.notify(error);\n      }\n    }\n  }\n}\n"]}
+{"version":3,"sources":["../../src/utils/metrics-exporter.ts"],"names":["MetricName"],"mappings":"AACA,SAAQ,aAAY;AAEpB,SAAQ,kBAAiB;AACzB,SAAQ,uBAAsB;AAkBvB,IAAK,aAAL,kBAAKA,gBAAL;AACL,EAAAA,YAAA,eAAY;AACZ,EAAAA,YAAA,uBAAoB;AACpB,EAAAA,YAAA,sBAAmB;AACnB,EAAAA,YAAA,uBAAoB;AACpB,EAAAA,YAAA,wBAAqB;AACrB,EAAAA,YAAA,eAAY;AACZ,EAAAA,YAAA,gBAAa;AAPH,SAAAA;AAAA,GAAA;AAUL,MAAM,gBAAgB;AAAA,EACnB,UAA4B,CAAC;AAAA,EACpB,eAAuB;AAAA,EACvB;AAAA,EACA;AAAA,EAEjB,YAAY,SAAiC;AAC3C,UAAM,EAAC,SAAS,WAAU,IAAI,gBAAgB;AAC9C,UAAM,EAAC,SAAS,gBAAe,IAAI;AAAA,MACjC,GAAG,QAAQ,QAAQ;AAAA,IACrB;AACA,SAAK,cAAc;AAAA,MACjB,aAAa,QAAQ;AAAA,MACrB,aAAa,cAAc,cAAc,SAAS;AAAA,MAClD,kBAAkB,mBAAmB;AAAA,IACvC;AACA,SAAK,YAAY;AAAA,EACnB;AAAA,EAEA,IACE,MACA,OACA,OAAgC,CAAC,GAC3B;AACN,UAAM,SAAS;AAAA,MACb;AAAA,MACA;AAAA,IACF;AAEA,QAAI,KAAK,QAAQ,IAAI,GAAG;AACtB,WAAK,QAAQ,IAAI,EAAG,KAAK,MAAM;AAAA,IACjC,OAAO;AACL,WAAK,QAAQ,IAAI,IAAI,CAAC,MAAM;AAAA,IAC9B;AAAA,EACF;AAAA,EAEA,WAAW,MAAyC;AAClD,WAAO,OAAO,QAAQ,IAAI,EAAE,IAAI,CAAC,CAAC,KAAK,KAAK,MAAM,GAAG,GAAG,IAAI,KAAK,EAAE;AAAA,EACrE;AAAA,EAEA,MAAM,SAAwB;AAC5B,UAAM,kBAAgC,OAAO,QAAQ,KAAK,OAAO,EAC9D,IAAI,CAAC,CAAC,YAAY,MAAM,MAAM;AAC7B,YAAM,OAAO,GAAG,KAAK,YAAY,IAAI,UAAU;AAE/C,aAAO,OAAO,IAAI,CAAC,EAAC,OAAO,KAAI,MAAM;AACnC,eAAO;AAAA,UACL;AAAA,UACA,MAAM;AAAA,UACN;AAAA,UACA,MAAM,KAAK,WAAW,EAAC,GAAG,MAAM,GAAG,KAAK,YAAW,CAAC;AAAA,QACtD;AAAA,MACF,CAAC;AAAA,IACH,CAAC,EACA,KAAK;AAER,QAAI;AACF,YAAM,MAAM,KAAK,WAAW;AAAA,QAC1B,QAAQ;AAAA,QACR,MAAM,KAAK,UAAU,EAAC,QAAQ,gBAAe,CAAC;AAAA,MAChD,CAAC;AAAA,IACH,SAAS,OAAO;AACd,YAAM,UAAU,WAAW;AAC3B,UAAI,YAAY,iBAAiB,SAAS,OAAO,UAAU,WAAW;AACpE,gBAAQ,OAAO,KAAK;AAAA,MACtB;AAAA,IACF;AAAA,EACF;AACF","sourcesContent":["/* eslint-disable @typescript-eslint/naming-convention */\nimport {fetch} from '@shopify/cli-kit/node/http';\n\nimport {getBugsnag} from './bugsnag.js';\nimport {loadPackageJson} from './utils.js';\n\ninterface GodogEvent {\n  name: string;\n  type: string;\n  value: number;\n  tags: string[];\n}\n\ninterface MetricCollection {\n  [metricName: string]: [{value: number; tags: {[key: string]: string}}];\n}\n\ninterface MetricsExporterOptions {\n  ciProvider: string;\n  rootPath: string;\n}\n\nexport enum MetricName {\n  BuildTime = 'build_time',\n  NumFilesRequested = 'num_files_requested',\n  NumFilesUploaded = 'num_files_uploaded',\n  TotalSizeUploaded = 'total_size_uploaded',\n  TotalSizeRequested = 'total_size_requested',\n  TotalTime = 'total_time',\n  UploadTime = 'upload_time',\n}\n\nexport class MetricsExporter {\n  private metrics: MetricCollection = {};\n  private readonly metricPrefix: string = 'oxygen.cli';\n  private readonly defaultTags: {[key: string]: string};\n  private readonly exportUrl: string;\n\n  constructor(options: MetricsExporterOptions) {\n    const {version: cliVersion} = loadPackageJson();\n    const {version: hydrogenVersion} = loadPackageJson(\n      `${options.rootPath}/node_modules/@shopify/hydrogen`,\n    );\n    this.defaultTags = {\n      ci_provider: options.ciProvider,\n      cli_version: `oxygen-cli@${cliVersion || 'unknown'}`,\n      hydrogen_version: hydrogenVersion || 'unknown',\n    };\n    this.exportUrl = 'https://metrics.myshopify.dev';\n  }\n\n  add(\n    name: MetricName,\n    value: number,\n    tags: {[key: string]: string} = {},\n  ): void {\n    const metric = {\n      value,\n      tags,\n    };\n\n    if (this.metrics[name]) {\n      this.metrics[name]!.push(metric);\n    } else {\n      this.metrics[name] = [metric];\n    }\n  }\n\n  formatTags(tags: {[key: string]: string}): string[] {\n    return Object.entries(tags).map(([key, value]) => `${key}:${value}`);\n  }\n\n  async export(): Promise<void> {\n    const metricsToExport: GodogEvent[] = Object.entries(this.metrics)\n      .map(([metricName, values]) => {\n        const name = `${this.metricPrefix}.${metricName}`;\n\n        return values.map(({value, tags}) => {\n          return {\n            name,\n            type: 'gauge',\n            value,\n            tags: this.formatTags({...tags, ...this.defaultTags}),\n          };\n        });\n      })\n      .flat();\n\n    try {\n      await fetch(this.exportUrl, {\n        method: 'POST',\n        body: JSON.stringify({events: metricsToExport}),\n      });\n    } catch (error) {\n      const Bugsnag = getBugsnag();\n      if (Bugsnag && (error instanceof Error || typeof error === 'string')) {\n        Bugsnag.notify(error);\n      }\n    }\n  }\n}\n"]}

package/oclif.manifest.json

@@ -168,5 +168,5 @@
       ]
     }
   },
-  "version": "2.3.2"
+  "version": "2.4.0"
 }

package/package.json

@@ -5,7 +5,7 @@
     "@shopify:registry": "https://registry.npmjs.org"
   },
   "license": "MIT",
-  "version": "2.3.2",
+  "version": "2.4.0",
   "type": "module",
   "scripts": {
     "build": "tsup --sourcemap --clean --config ./tsup.config.ts && oclif manifest",
@@ -48,7 +48,7 @@
     "@shopify/eslint-plugin": "^43.0.0",
     "@shopify/prettier-config": "^1.1.2",
     "@types/async": "^3.2.21",
-    "@types/node": "^20.6.5",
+    "@types/node": "^20.8.9",
     "eslint": "^8.52.0",
     "eslint-plugin-prettier": "^5.0.1",
     "node-fetch": "^3.3.2",