@shopify/oxygen-cli 1.1.0 → 1.3.0

package/README.md

@@ -41,6 +41,7 @@ oxygen:deploy [options]
 - -a, --assetsFolder <assetsFolder>: Assets folder (default: `dist/client/`).
 - -o, --workerOnly: Worker only deployment.
 - -s, --skipBuild: Skip running build command.
+- -p, --publicDeployment: set the deployment to be publicly accessible.
 - -b, --buildCommand <buildCommand>: Build command (default: `yarn build`).
 - --metadataUrl <metadataUrl>: URL that links to the deployment.
 - --metadataUser <metadataUser>: User that initiated the deployment.

package/dist/commands/oxygen/deploy.d.ts

@@ -14,6 +14,7 @@ declare class Deploy extends Command {
         workerOnly: _oclif_core_lib_interfaces_parser_js.BooleanFlag<boolean>;
         skipBuild: _oclif_core_lib_interfaces_parser_js.BooleanFlag<boolean>;
         buildCommand: _oclif_core_lib_interfaces_parser_js.OptionFlag<string, _oclif_core_lib_interfaces_parser_js.CustomOptions>;
+        publicDeployment: _oclif_core_lib_interfaces_parser_js.BooleanFlag<boolean>;
         metadataUrl: _oclif_core_lib_interfaces_parser_js.OptionFlag<string | undefined, _oclif_core_lib_interfaces_parser_js.CustomOptions>;
         metadataUser: _oclif_core_lib_interfaces_parser_js.OptionFlag<string | undefined, _oclif_core_lib_interfaces_parser_js.CustomOptions>;
         metadataVersion: _oclif_core_lib_interfaces_parser_js.OptionFlag<string | undefined, _oclif_core_lib_interfaces_parser_js.CustomOptions>;

package/dist/commands/oxygen/deploy.js

@@ -59,6 +59,13 @@ class Deploy extends Command {
         return Promise.resolve(input);
       }
     }),
+    publicDeployment: Flags.boolean({
+      char: "p",
+      env: "OXYGEN_PUBLIC_DEPLOYMENT",
+      description: "Marks a preview deployment as publicly accessible.",
+      required: false,
+      default: false
+    }),
     metadataUrl: Flags.string({
       description: "URL that links to the deployment",
       required: false,
@@ -94,6 +101,7 @@ class Deploy extends Command {
           user: flags.metadataUser,
           version: flags.metadataVersion
         },
+        publicDeployment: flags.publicDeployment,
         rootPath: normalizePath(flags.rootPath),
         skipBuild: flags.skipBuild,
         workerDir: normalizePath(flags.workerFolder),

package/dist/deploy/build-cancel.js

@@ -1,7 +1,7 @@
 import { graphqlRequest } from '@shopify/cli-kit/node/api/graphql';
 import { AbortError } from '@shopify/cli-kit/node/error';
 import { outputInfo } from '@shopify/cli-kit/node/output';
-import { Header, errorHandler } from '../utils/utils.js';
+import { Header, stderrLogger, errorHandler } from '../utils/utils.js';
 import { BuildCancelQuery } from './graphql/build-cancel.js';
 
 async function buildCancel(config, buildId, reason) {
@@ -25,7 +25,7 @@ async function buildCancel(config, buildId, reason) {
         `Failed to cancel build: ${response.buildCancel.userErrors[0]?.message}`
       );
     }
-    outputInfo(`Build with id ${buildId} cancelled.`);
+    outputInfo(`Build with id ${buildId} cancelled.`, stderrLogger);
     return response.buildCancel;
   } catch (error) {
     errorHandler(error);

package/dist/deploy/build-initiate.js

@@ -1,7 +1,7 @@
 import { graphqlRequest } from '@shopify/cli-kit/node/api/graphql';
 import { AbortError } from '@shopify/cli-kit/node/error';
 import { outputCompleted } from '@shopify/cli-kit/node/output';
-import { Header, errorHandler } from '../utils/utils.js';
+import { Header, stderrLogger, errorHandler } from '../utils/utils.js';
 import { BuildInitiateQuery } from './graphql/build-initiate.js';
 
 async function buildInitiate(config, environment, labels = []) {
@@ -26,7 +26,8 @@ async function buildInitiate(config, environment, labels = []) {
       );
     }
     outputCompleted(
-      `Build initiated successfully with id ${response.buildInitiate.build.id}.`
+      `Build initiated successfully with id ${response.buildInitiate.build.id}.`,
+      stderrLogger
     );
     return response.buildInitiate;
   } catch (error) {

package/dist/deploy/build-initiate.test.js

@@ -2,7 +2,7 @@ import { AbortError } from '@shopify/cli-kit/node/error';
 import { graphqlRequest } from '@shopify/cli-kit/node/api/graphql';
 import { outputCompleted } from '@shopify/cli-kit/node/output';
 import { vi, describe, test, expect } from 'vitest';
-import { Header } from '../utils/utils.js';
+import { Header, stderrLogger } from '../utils/utils.js';
 import { createTestConfig } from '../utils/test-helper.js';
 import { buildInitiate } from './build-initiate.js';
 
@@ -39,7 +39,8 @@ describe("BuildInitiate", () => {
       }
     });
     expect(outputCompleted).toHaveBeenCalledWith(
-      "Build initiated successfully with id build-1."
+      "Build initiated successfully with id build-1.",
+      stderrLogger
     );
   });
   test("should throw AbortError when build initiation fails due to user errors", async () => {

package/dist/deploy/build-project.js

@@ -4,7 +4,7 @@ async function buildProject(config, assetPath) {
   const assetPathEnvironment = assetPath ? { HYDROGEN_ASSET_BASE_URL: assetPath } : {};
   await new Promise((resolve, reject) => {
     const buildCommand = spawn(config.buildCommand, [], {
-      stdio: "inherit",
+      stdio: ["inherit", "pipe", "inherit"],
       env: {
         // eslint-disable-next-line no-process-env
         ...process.env,
@@ -13,11 +13,7 @@ async function buildProject(config, assetPath) {
       cwd: config.rootPath,
       shell: true
     });
-    if (buildCommand.stdout) {
-      buildCommand.stdout.on("data", (data) => {
-        console.log(`stdout: ${data}`);
-      });
-    }
+    buildCommand.stdout.pipe(process.stderr);
     buildCommand.on("close", (code) => {
       if (code !== 0) {
         reject(code);

package/dist/deploy/build-project.test.js

@@ -10,6 +10,8 @@ vi.mock("child_process", () => {
     return {
       stdout: {
         on: () => {
+        },
+        pipe: () => {
         }
       },
       on: (event, callback) => {
@@ -32,7 +34,7 @@ test("BuildProject builds the project successfully", async () => {
   expect(spawn).toBeCalledWith("npm run build", [], {
     cwd: "rootFolder",
     shell: true,
-    stdio: "inherit",
+    stdio: ["inherit", "pipe", "inherit"],
     env: {
       // eslint-disable-next-line no-process-env
       ...process.env,

package/dist/deploy/deployment-cancel.js

@@ -1,7 +1,7 @@
 import { graphqlRequest } from '@shopify/cli-kit/node/api/graphql';
 import { AbortError } from '@shopify/cli-kit/node/error';
 import { outputInfo } from '@shopify/cli-kit/node/output';
-import { Header, errorHandler } from '../utils/utils.js';
+import { Header, stderrLogger, errorHandler } from '../utils/utils.js';
 import { DeploymentCancelQuery } from './graphql/deployment-cancel.js';
 
 async function deploymentCancel(config, deploymentId, reason) {
@@ -25,7 +25,7 @@ async function deploymentCancel(config, deploymentId, reason) {
         `Failed to cancel deployment: ${response.deploymentCancel.userErrors[0]?.message}`
       );
     }
-    outputInfo(`Deployment with id ${deploymentId} cancelled.`);
+    outputInfo(`Deployment with id ${deploymentId} cancelled.`, stderrLogger);
     return response.deploymentCancel;
   } catch (error) {
     errorHandler(error);

package/dist/deploy/deployment-initiate.js

@@ -1,7 +1,7 @@
 import { graphqlRequest } from '@shopify/cli-kit/node/api/graphql';
 import { AbortError } from '@shopify/cli-kit/node/error';
 import { outputCompleted } from '@shopify/cli-kit/node/output';
-import { Header, errorHandler } from '../utils/utils.js';
+import { Header, stderrLogger, errorHandler } from '../utils/utils.js';
 import { DeploymentInitiateQuery } from './graphql/deployment-initiate.js';
 
 async function deploymentInitiate(config, input) {
@@ -9,7 +9,8 @@ async function deploymentInitiate(config, input) {
     buildId: input.buildId,
     environment: input.environment,
     files: input.manifest,
-    labels: input.labels
+    labels: input.labels,
+    isPrivate: !config.publicDeployment
   };
   try {
     const response = await graphqlRequest({
@@ -28,7 +29,8 @@ async function deploymentInitiate(config, input) {
       );
     }
     outputCompleted(
-      `Deployment initiated, ${response.deploymentInitiate.deploymentTargets.length} files to upload.`
+      `Deployment initiated, ${response.deploymentInitiate.deploymentTargets.length} files to upload.`,
+      stderrLogger
     );
     return response.deploymentInitiate;
   } catch (error) {

package/dist/deploy/deployment-initiate.test.js

@@ -3,7 +3,7 @@ import { graphqlRequest } from '@shopify/cli-kit/node/api/graphql';
 import { outputCompleted } from '@shopify/cli-kit/node/output';
 import { vi, describe, test, expect } from 'vitest';
 import { createTestConfig } from '../utils/test-helper.js';
-import { Header } from '../utils/utils.js';
+import { Header, stderrLogger } from '../utils/utils.js';
 import { deploymentInitiate } from './deployment-initiate.js';
 
 vi.mock("@shopify/cli-kit/node/api/graphql");
@@ -51,14 +51,16 @@ describe("DeploymentInitiate", () => {
       variables: {
         buildId: "build-1",
         environment: void 0,
-        files: testManifest
+        files: testManifest,
+        isPrivate: true
       },
       addedHeaders: {
         [Header.OxygenNamespaceHandle]: `${testConfig.deploymentToken.namespace}`
       }
     });
     expect(outputCompleted).toHaveBeenCalledWith(
-      `Deployment initiated, ${testManifest.length} files to upload.`
+      `Deployment initiated, ${testManifest.length} files to upload.`,
+      stderrLogger
     );
   });
   test("should initiate a deployment with an environmentName", async () => {
@@ -77,14 +79,16 @@ describe("DeploymentInitiate", () => {
       variables: {
         buildId: void 0,
         environment: { tag: "preview" },
-        files: testManifest
+        files: testManifest,
+        isPrivate: true
       },
       addedHeaders: {
         [Header.OxygenNamespaceHandle]: `${testConfig.deploymentToken.namespace}`
       }
     });
     expect(outputCompleted).toHaveBeenCalledWith(
-      `Deployment initiated, ${testManifest.length} files to upload.`
+      `Deployment initiated, ${testManifest.length} files to upload.`,
+      stderrLogger
     );
   });
   test("should throw AbortError when deployment initiation fails due to user errors", async () => {

package/dist/deploy/graphql/deployment-initiate.d.ts

@@ -1,6 +1,6 @@
 import { OxygenError } from '../types.js';
 
-declare const DeploymentInitiateQuery = "\n  mutation DeploymentInitiate($buildId: ID, $environment: EnvironmentSelectorInput, $labels: [String!], $files: [FileInput!]!) {\n    deploymentInitiate(buildId: $buildId, environment: $environment, labels: $labels, files: $files) {\n      deployment {\n        id\n        status\n      }\n      deploymentTargets {\n        filePath\n        fileSize\n        uploadUrl\n        fileType\n        parameters {\n          name\n          value\n        }\n      }\n      userErrors {\n        message\n      }\n    }\n  }\n";
+declare const DeploymentInitiateQuery = "\n  mutation DeploymentInitiate($buildId: ID, $environment: EnvironmentSelectorInput, $labels: [String!], $files: [FileInput!]!, $isPrivate: Boolean) {\n    deploymentInitiate(buildId: $buildId, environment: $environment, labels: $labels, files: $files, isPrivate: $isPrivate) {\n      deployment {\n        id\n        status\n      }\n      deploymentTargets {\n        filePath\n        fileSize\n        uploadUrl\n        fileType\n        parameters {\n          name\n          value\n        }\n      }\n      userErrors {\n        message\n      }\n    }\n  }\n";
 interface DeploymentInitiateQueryData {
     deploymentInitiate: DeploymentInitiateResponse;
 }

package/dist/deploy/graphql/deployment-initiate.js

@@ -1,6 +1,6 @@
 const DeploymentInitiateQuery = `
-  mutation DeploymentInitiate($buildId: ID, $environment: EnvironmentSelectorInput, $labels: [String!], $files: [FileInput!]!) {
-    deploymentInitiate(buildId: $buildId, environment: $environment, labels: $labels, files: $files) {
+  mutation DeploymentInitiate($buildId: ID, $environment: EnvironmentSelectorInput, $labels: [String!], $files: [FileInput!]!, $isPrivate: Boolean) {
+    deploymentInitiate(buildId: $buildId, environment: $environment, labels: $labels, files: $files, isPrivate: $isPrivate) {
       deployment {
         id
         status

package/dist/deploy/index.js

@@ -1,5 +1,5 @@
-import { outputSuccess, outputWarn, consoleError } from '@shopify/cli-kit/node/output';
-import { verifyConfig } from '../utils/utils.js';
+import { outputSuccess, outputInfo, outputWarn, consoleError } from '@shopify/cli-kit/node/output';
+import { verifyConfig, stderrLogger } from '../utils/utils.js';
 import { buildInitiate } from './build-initiate.js';
 import { buildCancel } from './build-cancel.js';
 import { getUploadFiles } from './get-upload-files.js';
@@ -40,29 +40,42 @@ async function createDeploy(config) {
       config,
       deployment.deployment.id
     );
+    const urlMessage = config.publicDeployment ? "Public" : "Private";
     outputSuccess(
-      `Deployment complete: ${deploymentCompleteOp.deployment.url}`
+      `Deployment complete.
+${urlMessage} preview URL: ${deploymentCompleteOp.deployment.url}`,
+      stderrLogger
     );
+    if (metadata.name !== "none") {
+      outputInfo(deploymentCompleteOp.deployment.url);
+    }
   } catch (error) {
     if (!(error instanceof Error)) {
       console.error("Unknown error", error);
       return;
     }
     if (build.id && !buildCompleted) {
-      outputWarn(`Build failed with: ${error.message}, cancelling build.`);
+      outputWarn(
+        `Build failed with: ${error.message}, cancelling build.`,
+        stderrLogger
+      );
       await buildCancel(config, build.id, error.message).catch((err) => {
         if (err instanceof Error) {
-          outputWarn(`Failed to cancel build: ${err.message}`);
+          outputWarn(`Failed to cancel build: ${err.message}`, stderrLogger);
         }
       });
     } else if (deployment?.deployment.id) {
       outputWarn(
-        `Deployment failed with: ${error.message}, cancelling deployment.`
+        `Deployment failed with: ${error.message}, cancelling deployment.`,
+        stderrLogger
       );
       await deploymentCancel(config, deployment.deployment.id, "failed").catch(
         (err) => {
           if (err instanceof Error) {
-            outputWarn(`Failed to cancel deployment: ${err.message}`);
+            outputWarn(
+              `Failed to cancel deployment: ${err.message}`,
+              stderrLogger
+            );
           }
         }
       );

package/dist/deploy/metadata.js

@@ -1,7 +1,7 @@
 import { ciPlatform } from '@shopify/cli-kit/node/context/local';
 import { getLatestGitCommit } from '@shopify/cli-kit/node/git';
 import { outputWarn } from '@shopify/cli-kit/node/output';
-import { maxLabelLength } from '../utils/utils.js';
+import { stderrLogger, maxLabelLength } from '../utils/utils.js';
 
 async function getMetadata(config) {
   const ciInfo = ciPlatform();
@@ -19,11 +19,11 @@ async function getMetadata(config) {
         commitMessage: gitCommit.message
       };
     } catch (error) {
-      outputWarn("No CI metadata loaded from environment");
+      outputWarn("No CI metadata loaded from environment", stderrLogger);
     }
   }
   return {
-    name: ciInfo.isCI ? ciInfo.name : "unknown",
+    name: ciInfo.isCI ? ciInfo.name : "none",
     ...metadata,
     actor: config.metadata.user ?? metadata.actor,
     commitSha: config.metadata.version ?? metadata.commitSha,

package/dist/deploy/metadata.test.js

@@ -64,7 +64,7 @@ describe("getMetadata", () => {
     const metadataResult = await getMetadata(testConfig);
     expect(metadataResult.actor).toBe("gh_author");
     expect(metadataResult.commitSha).toBe("gh_hash");
-    expect(metadataResult.name).toBe("unknown");
+    expect(metadataResult.name).toBe("none");
     expect(metadataResult.url).toBe(void 0);
   });
 });

package/dist/deploy/types.d.ts

@@ -16,6 +16,7 @@ interface DeployConfig {
         version?: string;
         url?: string;
     };
+    publicDeployment: boolean;
     rootPath?: string;
     skipBuild: boolean;
     workerDir?: string;

package/dist/deploy/upload-files.js

@@ -3,14 +3,14 @@ import { createFileReadStream } from '@shopify/cli-kit/node/fs';
 import { outputInfo, outputCompleted } from '@shopify/cli-kit/node/output';
 import { joinPath } from '@shopify/cli-kit/node/path';
 import { mapLimit } from 'async';
-import { deployDefaults } from '../utils/utils.js';
+import { stderrLogger, deployDefaults } from '../utils/utils.js';
 
 async function uploadFiles(config, targets) {
-  outputInfo(`Uploading ${targets.length} files...`);
+  outputInfo(`Uploading ${targets.length} files...`, stderrLogger);
   return mapLimit(targets, 6, async (target) => {
     await uploadFile(config, target);
   }).then(() => {
-    outputCompleted(`Files uploaded successfully`);
+    outputCompleted(`Files uploaded successfully`, stderrLogger);
   });
 }
 async function uploadFile(config, target) {

package/dist/utils/test-helper.js

@@ -18,6 +18,7 @@ function createTestConfig(rootFolder) {
     deploymentUrl: "https://localhost:3000",
     metadata: {},
     rootPath: rootFolder,
+    publicDeployment: false,
     skipBuild: false,
     workerDir: "/worker/",
     workerOnly: false

package/dist/utils/utils.d.ts

@@ -9,6 +9,7 @@ declare enum Header {
     OxygenNamespaceHandle = "X-Oxygen-Namespace-Handle"
 }
 declare function isClientError(error: unknown): error is ClientError;
+declare function stderrLogger(log: string): void;
 declare const maxLabelLength = 90;
 declare function parseToken(inputToken: string): DeploymentToken;
 interface VerifyConfigParams {
@@ -17,4 +18,4 @@ interface VerifyConfigParams {
 }
 declare function verifyConfig({ config, performedBuild, }: VerifyConfigParams): Promise<void>;
 
-export { Header, deployDefaults, errorHandler, getBuildCommandFromLockFile, isClientError, maxLabelLength, parseToken, verifyConfig };
+export { Header, deployDefaults, errorHandler, getBuildCommandFromLockFile, isClientError, maxLabelLength, parseToken, stderrLogger, verifyConfig };

package/dist/utils/utils.js

@@ -43,13 +43,17 @@ function getBuildCommandFromLockFile(config) {
   }
   if (foundLockFiles.length > 1) {
     const lockFilesList = foundLockFiles.map(({ lockFileName }) => lockFileName).join(", ");
-    outputWarn(`Warning: Multiple lock files found: (${lockFilesList}).`);
+    outputWarn(
+      `Warning: Multiple lock files found: (${lockFilesList}).`,
+      stderrLogger
+    );
   }
   if (foundLockFiles.length > 0) {
     const { lockFileName, buildCommand } = foundLockFiles[0];
     const infoMsg = foundLockFiles.length > 1 ? "" : `Found: ${lockFileName}. `;
     outputInfo(
-      `${infoMsg}Assuming "${buildCommand}" as build command. Use the buildCommand flag to override.`
+      `${infoMsg}Assuming "${buildCommand}" as build command. Use the buildCommand flag to override.`,
+      stderrLogger
     );
     return buildCommand;
   }
@@ -62,6 +66,10 @@ var Header = /* @__PURE__ */ ((Header2) => {
 function isClientError(error) {
   return typeof error === "object" && error !== null && "statusCode" in error;
 }
+function stderrLogger(log) {
+  process.stderr.write(`${log}
+`);
+}
 const maxLabelLength = 90;
 function parseToken(inputToken) {
   try {
@@ -100,7 +108,8 @@ async function checkPath(path, pathType) {
   if (!await fileExists(path)) {
     if (pathType === "assets") {
       outputWarn(
-        `Use the "workerOnly" flag to perform a worker-only deployment.`
+        `Use the "workerOnly" flag to perform a worker-only deployment.`,
+        stderrLogger
       );
     }
     throw new Error(`Path not found: ${path}`);
@@ -123,4 +132,4 @@ function convertKeysToCamelCase(obj) {
   return obj;
 }
 
-export { Header, deployDefaults, errorHandler, getBuildCommandFromLockFile, isClientError, maxLabelLength, parseToken, verifyConfig };
+export { Header, deployDefaults, errorHandler, getBuildCommandFromLockFile, isClientError, maxLabelLength, parseToken, stderrLogger, verifyConfig };

package/dist/utils/utils.test.js

@@ -29,7 +29,8 @@ describe("getBuildCommandFromLockfile", () => {
     const buildCommand = utils.getBuildCommandFromLockFile(testConfig);
     expect(buildCommand).toBe("pnpm run build");
     expect(outputInfo).toHaveBeenCalledWith(
-      'Found: pnpm-lock.yaml. Assuming "pnpm run build" as build command. Use the buildCommand flag to override.'
+      'Found: pnpm-lock.yaml. Assuming "pnpm run build" as build command. Use the buildCommand flag to override.',
+      utils.stderrLogger
     );
   });
   test("getBuildCommandFromLockfile the first build command and warns when multiple lockfiles are found", async () => {
@@ -37,10 +38,12 @@ describe("getBuildCommandFromLockfile", () => {
     const buildCommand = utils.getBuildCommandFromLockFile(testConfig);
     expect(buildCommand).toBe("pnpm run build");
     expect(outputInfo).toHaveBeenCalledWith(
-      'Assuming "pnpm run build" as build command. Use the buildCommand flag to override.'
+      'Assuming "pnpm run build" as build command. Use the buildCommand flag to override.',
+      utils.stderrLogger
     );
     expect(outputWarn).toHaveBeenCalledWith(
-      "Warning: Multiple lock files found: (pnpm-lock.yaml, yarn.lock)."
+      "Warning: Multiple lock files found: (pnpm-lock.yaml, yarn.lock).",
+      utils.stderrLogger
     );
   });
 });
@@ -94,7 +97,8 @@ describe("verifyConfig", () => {
       )
     );
     expect(outputWarn).toHaveBeenCalledWith(
-      `Use the "workerOnly" flag to perform a worker-only deployment.`
+      `Use the "workerOnly" flag to perform a worker-only deployment.`,
+      utils.stderrLogger
     );
   });
   test("verifyConfig throws when the workerDir cannot be resolved after a build", async () => {

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.1.0",
+  "version": "1.3.0",
   "commands": {
     "oxygen:deploy": {
       "id": "oxygen:deploy",
@@ -79,6 +79,14 @@
           "multiple": false,
           "default": "yarn build"
         },
+        "publicDeployment": {
+          "name": "publicDeployment",
+          "type": "boolean",
+          "char": "p",
+          "description": "Marks a preview deployment as publicly accessible.",
+          "required": false,
+          "allowNo": false
+        },
         "metadataUrl": {
           "name": "metadataUrl",
           "type": "option",

package/package.json

@@ -5,10 +5,11 @@
     "@shopify:registry": "https://registry.npmjs.org"
   },
   "license": "MIT",
-  "version": "1.1.0",
+  "version": "1.3.0",
   "type": "module",
   "scripts": {
     "build": "tsup --clean --config ./tsup.config.ts && oclif manifest",
+    "changesets:check": "changeset status",
     "dev": "tsup --watch --config ./tsup.config.ts",
     "typecheck": "tsc --noEmit",
     "lint": "eslint --ext .js,.ts --max-warnings 0 src",