accepted update to action.yml for 'force' flag description, added support for channel site deployment with force flag. Updated tests to and types to account for force flags. Force flag is now optional on ProductionDeployConfig and ChannelDeployConfig. Simplified deploy calls using force flag to automatically append force based on the boolean value nad removed the force-specific branch in index.ts

Author: ThadCastl3

src/deploy.ts

@@ -40,13 +40,18 @@ export type ProductionSuccessResult = {
   };
 };
 
-export type ForceSuccessResult = {
+export type ForceProductionSuccessResult = {
   status: "success";
   result: {
     hosting: string | string[];
   };
 };
 
+export type ForceChannelSuccessResult = {
+  status: "success";
+  result: { [key: string]: SiteDeploy };
+};
+
 type DeployConfig = {
   projectId: string;
   target?: string;
@@ -58,13 +63,13 @@ type DeployConfig = {
 export type ChannelDeployConfig = DeployConfig & {
   expires: string;
   channelId: string;
+  force?: boolean;
 };
 
-export type ForceDeployConfig = DeployConfig & {
-  force: boolean;
-};
 
-export type ProductionDeployConfig = DeployConfig & {};
+export type ProductionDeployConfig = DeployConfig & {
+  force?: boolean;
+};
 
 export function interpretChannelDeployResult(
   deployResult: ChannelSuccessResult
@@ -186,23 +191,3 @@ export async function deployProductionSite(
 
   return deploymentResult;
 }
-
-export async function deployWithForce(
-  gacFilename,
-  deployConfig: ForceDeployConfig
-) {
-  const { projectId, target, firebaseToolsVersion, force } = deployConfig;
-
-  const deploymentText = await execWithCredentials(
-    ["deploy", "--only", `hosting${target ? ":" + target : ""}`, "--force"],
-    projectId,
-    gacFilename,
-    { firebaseToolsVersion, force }
-  );
-
-  const deploymentResult = JSON.parse(deploymentText) as
-    | ForceSuccessResult
-    | ErrorResult;
-
-  return deploymentResult;
-}

src/index.ts

@@ -28,7 +28,6 @@ import { createGacFile } from "./createGACFile";
 import {
   deployPreview,
   deployProductionSite,
-  deployWithForce,
   ErrorResult,
   interpretChannelDeployResult,
 } from "./deploy";
@@ -90,32 +89,6 @@ async function run() {
     );
     endGroup();
 
-    if (force) {
-      startGroup("Deploying with force flag");
-      const deployment = await deployWithForce(gacFilename, {
-        projectId,
-        target,
-        firebaseToolsVersion,
-        force,
-      });
-      if (deployment.status === "error") {
-        throw Error((deployment as ErrorResult).error);
-      }
-      endGroup();
-
-      const hostname = target ? `${target}.web.app` : `${projectId}.web.app`;
-      const url = `https://${hostname}/`;
-      await finish({
-        details_url: url,
-        conclusion: "success",
-        output: {
-          title: `Production deploy succeeded`,
-          summary: `[${hostname}](${url})`,
-        },
-      });
-      return;
-    }
-
     if (isProductionDeploy) {
       startGroup("Deploying to production site");
       const deployment = await deployProductionSite(gacFilename, {

test/deploy.test.ts

@@ -5,16 +5,12 @@ import {
   deployProductionSite,
   ProductionDeployConfig,
   ProductionSuccessResult,
-  ForceDeployConfig,
-  deployWithForce,
-  ForceSuccessResult,
 } from "../src/deploy";
 import * as exec from "@actions/exec";
 import {
   channelError,
   channelMultiSiteSuccess,
   channelSingleSiteSuccess,
-  forceDeploySingleSiteSuccess,
   liveDeployMultiSiteSuccess,
   liveDeploySingleSiteSuccess,
 } from "./samples/cliOutputs";
@@ -29,11 +25,18 @@ const baseLiveDeployConfig: ProductionDeployConfig = {
   projectId: "my-project",
 };
 
-const forceDeployConfig: ForceDeployConfig = {
+const forceProductionDeployConfig: ProductionDeployConfig = {
   projectId: "my-project",
   force: true,
 };
 
+const forcePreviewDeployConfig: ChannelDeployConfig = {
+  projectId: "my-project",
+  channelId: "my-channel",
+  expires: undefined,
+  force: true,
+};
+
 async function fakeExecFail(
   mainCommand: string,
   args: string[],
@@ -137,6 +140,48 @@ describe("deploy", () => {
     });
   });
 
+  describe("deploy to preview channel with force flag", () => {
+    it("calls exec and interprets the output, including the --force flag when force is true", async () => {
+      // @ts-ignore read-only property
+      exec.exec = jest.fn(fakeExec);
+
+      const deployOutput: ChannelSuccessResult = (await deployPreview(
+        "my-file",
+        forcePreviewDeployConfig
+      )) as ChannelSuccessResult;
+
+      expect(exec.exec).toBeCalled();
+      expect(deployOutput).toEqual(channelSingleSiteSuccess);
+
+      // Check the arguments that exec was called with
+      // @ts-ignore Jest adds a magic "mock" property
+      const args = exec.exec.mock.calls;
+      const deployFlags = args[0][1];
+      expect(deployFlags).toContain("hosting:channel:deploy");
+      expect(deployFlags).toContain("--force");
+    });
+
+    it("specifies a target when one is provided", async () => {
+      // @ts-ignore read-only property
+      exec.exec = jest.fn(fakeExec);
+
+      const config: ChannelDeployConfig = {
+        ...baseChannelDeployConfig,
+        target: "my-second-site",
+      };
+
+      await deployPreview("my-file", config);
+
+      // Check the arguments that exec was called with
+      // @ts-ignore Jest adds a magic "mock" property
+      const args = exec.exec.mock.calls;
+      const deployFlags = args[0][1];
+      expect(deployFlags).toContain("--only");
+      expect(deployFlags).toContain("my-second-site");
+      expect(deployFlags).toContain("--force");
+    });
+  });
+
   describe("deploy to live channel", () => {
     it("calls exec and interprets the output", async () => {
       // @ts-ignore read-only property
@@ -160,18 +205,18 @@ describe("deploy", () => {
     });
   });
 
-  describe("deploy with force flag", () => {
+  describe("deploy to live channel with force flag", () => {
     it("includes --force flag when force is true for deploy", async () => {
       // @ts-ignore read-only property
       exec.exec = jest.fn(fakeExec);
 
-      const forceDeployOutput: ForceSuccessResult = (await deployWithForce(
+      const forceDeployOutput: ProductionSuccessResult = (await deployProductionSite(
         "my-file",
-        forceDeployConfig
-      )) as ForceSuccessResult;
+        forceProductionDeployConfig
+      )) as ProductionSuccessResult;
 
       expect(exec.exec).toBeCalled();
-      expect(forceDeployOutput).toEqual(forceDeploySingleSiteSuccess);
+      expect(forceDeployOutput).toEqual(liveDeploySingleSiteSuccess);
 
       // Check the arguments that exec was called with
       // @ts-ignore Jest adds a magic "mock" property

test/samples/cliOutputs.ts

@@ -1,7 +1,8 @@
 import {
   ChannelSuccessResult,
   ErrorResult,
-  ForceSuccessResult,
+  ForceProductionSuccessResult,
+  ForceChannelSuccessResult,
   ProductionSuccessResult,
 } from "../../src/deploy";
 
@@ -58,10 +59,3 @@ export const liveDeployMultiSiteSuccess: ProductionSuccessResult = {
     ],
   },
 };
-
-export const forceDeploySingleSiteSuccess: ForceSuccessResult = {
-  status: "success",
-  result: {
-    hosting: "sites/jeff-test-699d3/versions/7aebddc461b66922",
-  },
-};