Add --env-file for cli deploy command (#1743)

Shopify · Feb 14, 2024 · faeba9f · faeba9f
1 parent 7a724e4
commit faeba9f
Show file tree

Hide file tree

Showing 6 changed files with 158 additions and 69 deletions.
diff --git a/.changeset/chatty-donuts-rule.md b/.changeset/chatty-donuts-rule.md
@@ -0,0 +1,7 @@
+---
+'@shopify/cli-hydrogen': patch
+---
+
+Add `--env-file` flag to the `deploy` command
+
+Optionally provide the path to a local .env file to override the environment variables set on Admin.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/cli/oclif.manifest.json b/packages/cli/oclif.manifest.json
@@ -149,6 +149,13 @@
           "required": false,
           "multiple": false
         },
+        "env-file": {
+          "name": "env-file",
+          "type": "option",
+          "description": "Path to an environment file to override existing environment variables for the deployment.",
+          "required": false,
+          "multiple": false
+        },
         "preview": {
           "name": "preview",
           "type": "boolean",

diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -39,7 +39,7 @@
     "@shopify/cli-kit": "3.52.0",
     "@shopify/hydrogen-codegen": "^0.2.1",
     "@shopify/mini-oxygen": "^2.2.5",
-    "@shopify/oxygen-cli": "^4.0.0",
+    "@shopify/oxygen-cli": "^4.1.0",
     "ansi-escapes": "^6.2.0",
     "cli-truncate": "^4.0.0",
     "diff": "^5.1.0",

diff --git a/packages/cli/src/commands/hydrogen/deploy.test.ts b/packages/cli/src/commands/hydrogen/deploy.test.ts
@@ -22,10 +22,12 @@ import {
   createDeploy,
   parseToken,
 } from '@shopify/oxygen-cli/deploy';
+import {loadEnvironmentVariableFile} from '@shopify/oxygen-cli/utils';
 import {ciPlatform} from '@shopify/cli-kit/node/context/local';
 
 vi.mock('../../lib/get-oxygen-deployment-data.js');
 vi.mock('@shopify/oxygen-cli/deploy');
+vi.mock('@shopify/oxygen-cli/utils');
 vi.mock('@shopify/cli-kit/node/fs');
 vi.mock('@shopify/cli-kit/node/context/local');
 vi.mock('../../lib/auth.js');
@@ -186,6 +188,52 @@ describe('deploy', () => {
     expect(vi.mocked(renderSuccess)).toHaveBeenCalled;
   });
 
+  it('calls createDeploy with overridden variables in environment file', async () => {
+    const overriddenEnvironmentVariables = [
+      {
+        key: 'fake-key',
+        value: 'fake-value',
+        isSecret: true,
+      },
+    ];
+
+    vi.mocked(loadEnvironmentVariableFile).mockReturnValue(
+      overriddenEnvironmentVariables,
+    );
+
+    await oxygenDeploy({
+      ...deployParams,
+      environmentFile: 'fake-env-file',
+    });
+
+    expect(vi.mocked(createDeploy)).toHaveBeenCalledWith({
+      config: {
+        ...expectedConfig,
+        overriddenEnvironmentVariables,
+      },
+      hooks: expectedHooks,
+      logger: deploymentLogger,
+    });
+  });
+
+  it('errors when supplied environment file does not exist', async () => {
+    vi.mocked(loadEnvironmentVariableFile).mockImplementation(
+      (_path: string) => {
+        throw new AbortError('File not found');
+      },
+    );
+
+    try {
+      await oxygenDeploy({
+        ...deployParams,
+        environmentFile: 'fake-env-file',
+      });
+      expect(true).toBe(false);
+    } catch (err) {
+      expect(err).toBeInstanceOf(AbortError);
+    }
+  });
+
   it('errors when there are uncommited changes', async () => {
     vi.mocked(ensureIsClean).mockRejectedValue(
       new GitDirectoryNotCleanError('Uncommitted changes'),

diff --git a/packages/cli/src/commands/hydrogen/deploy.ts b/packages/cli/src/commands/hydrogen/deploy.ts
@@ -31,6 +31,7 @@ import {
   DeploymentVerificationDetailsResponse,
   parseToken,
 } from '@shopify/oxygen-cli/deploy';
+import {loadEnvironmentVariableFile} from '@shopify/oxygen-cli/utils';
 
 import {commonFlags, flagsToCamelObject} from '../../lib/flags.js';
 import {getOxygenDeploymentData} from '../../lib/get-oxygen-deployment-data.js';
@@ -53,6 +54,11 @@ export default class Deploy extends Command {
       description: 'Environment branch (tag) for environment to deploy to.',
       required: false,
     }),
+    'env-file': Flags.string({
+      description:
+        'Path to an environment file to override existing environment variables for the deployment.',
+      required: false,
+    }),
     preview: Flags.boolean({
       description:
         'Deploys to the Preview environment. Overrides --env-branch and Git metadata.',
@@ -137,6 +143,7 @@ export default class Deploy extends Command {
       ...camelFlags,
       defaultEnvironment: flags.preview,
       environmentTag: flags['env-branch'],
+      environmentFile: flags['env-file'],
       path: flags.path ? resolvePath(flags.path) : process.cwd(),
     } as OxygenDeploymentOptions;
   }
@@ -146,6 +153,7 @@ interface OxygenDeploymentOptions {
   authBypassToken: boolean;
   defaultEnvironment: boolean;
   environmentTag?: string;
+  environmentFile?: string;
   force: boolean;
   noJsonOutput: boolean;
   path: string;
@@ -188,6 +196,7 @@ export async function oxygenDeploy(
     authBypassToken: generateAuthBypassToken,
     defaultEnvironment,
     environmentTag,
+    environmentFile,
     force: forceOnUncommitedChanges,
     noJsonOutput,
     path,
@@ -248,6 +257,19 @@ export async function oxygenDeploy(
     metadataDescription = `${commitHash} with additional changes`;
   }
 
+  let overriddenEnvironmentVariables;
+
+  if (environmentFile) {
+    try {
+      overriddenEnvironmentVariables =
+        loadEnvironmentVariableFile(environmentFile);
+    } catch (error) {
+      throw new AbortError(
+        `Could not load environment file at ${environmentFile}`,
+      );
+    }
+  }
+
   if (!isCI) {
     deploymentData = await getOxygenDeploymentData({
       root: path,
@@ -343,6 +365,7 @@ export async function oxygenDeploy(
     skipBuild: false,
     workerOnly: false,
     workerDir: 'dist/worker',
+    overriddenEnvironmentVariables,
   };
 
   let resolveUpload: () => void;