feat(core): Add deploy command (#97)

Add the implementation of the `deploy` option and its step in the release pipeline. The implementation is mostly taken from the [webpack plugin](https://github.com/getsentry/sentry-webpack-plugin/blob/137503f3ac6fe423b16c5c50379859c86e689017/src/index.js#L524-L536) and relies on Sentry CLI.

Add tests for deploy

Author: Lms24

packages/bundler-plugin-core/src/index.ts

@@ -289,10 +289,8 @@ const unplugin = createUnplugin<Options>((options, unpluginMetaContext) => {
         .then(() => uploadSourceMaps(internalOptions, ctx))
         .then(() => setCommits(internalOptions, ctx))
         .then(() => finalizeRelease(internalOptions, ctx))
-        .then(() => addDeploy(ctx)) // this is a noop for now
-        .then(() => {
-          transaction?.setStatus("ok");
-        })
+        .then(() => addDeploy(internalOptions, ctx))
+        .then(() => transaction?.setStatus("ok"))
         .catch((e: Error) => {
           captureMinimalError(e, sentryHub);
           transaction?.setStatus("cancelled");

packages/bundler-plugin-core/src/sentry/releasePipeline.ts

@@ -127,12 +127,29 @@ export async function setCommits(options: InternalOptions, ctx: BuildContext): P
   span?.finish();
 }
 
-export async function addDeploy(
-  /* version: string, */
-  ctx: BuildContext
-): Promise<string> {
-  const span = addSpanToTransaction(ctx, "function.plugin.add_deploy");
+export async function addDeploy(options: InternalOptions, ctx: BuildContext): Promise<void> {
+  const span = addSpanToTransaction(ctx, "function.plugin.deploy");
+
+  if (options.deploy) {
+    const { env, started, finished, time, name, url } = options.deploy;
+
+    if (env) {
+      await ctx.cli.releases.newDeploy(options.release, {
+        env,
+        started,
+        finished,
+        time,
+        name,
+        url,
+      });
+      ctx.logger.info("Successfully added deploy.");
+    } else {
+      ctx.logger.error(
+        "Couldn't add deploy - the `env` option was not specified!",
+        "Make sure to set `deploy.env` (e.g. to 'production')."
+      );
+    }
+  }
 
   span?.finish();
-  return Promise.resolve("Noop");
 }

packages/bundler-plugin-core/src/types.ts

@@ -326,12 +326,12 @@ type DeployOptions = {
   /**
    * Deployment start time in Unix timestamp (in seconds) or ISO 8601 format.
    */
-  started?: number;
+  started?: number | string;
 
   /**
    * Deployment finish time in Unix timestamp (in seconds) or ISO 8601 format.
    */
-  finished?: number;
+  finished?: number | string;
 
   /**
    * Deployment duration (in seconds). Can be used instead of started and finished.

packages/bundler-plugin-core/test/releasePipeline.test.ts

@@ -1,5 +1,5 @@
 import { InternalOptions } from "../src/options-mapping";
-import { setCommits } from "../src/sentry/releasePipeline";
+import { addDeploy, setCommits } from "../src/sentry/releasePipeline";
 import { BuildContext } from "../src/types";
 
 const mockedAddSpanToTxn = jest.fn();
@@ -29,6 +29,7 @@ describe("Release Pipeline", () => {
   const mockedCLI = {
     releases: {
       setCommits: jest.fn(),
+      newDeploy: jest.fn(),
     },
   };
 
@@ -38,7 +39,7 @@ describe("Release Pipeline", () => {
   const ctx = { cli: mockedCLI, logger: mockedLogger };
 
   describe("setCommits", () => {
-    it("doesn't do anything if setCommits option is not specified", async () => {
+    it("doesn't do anything if `setCommits` option is not specified", async () => {
       await setCommits({} as InternalOptions, ctx as unknown as BuildContext);
 
       expect(mockedCLI.releases.setCommits).not.toHaveBeenCalled();
@@ -68,4 +69,44 @@ describe("Release Pipeline", () => {
       expect(mockedChildSpan.finish).toHaveBeenCalled();
     });
   });
+
+  describe("addDeploy", () => {
+    it("doesn't do anything if `deploy` option is not specified", async () => {
+      await addDeploy({} as InternalOptions, ctx as unknown as BuildContext);
+
+      expect(mockedCLI.releases.newDeploy).not.toHaveBeenCalled();
+      expect(mockedAddSpanToTxn).toHaveBeenCalled();
+      expect(mockedChildSpan.finish).toHaveBeenCalled();
+    });
+
+    it("logs an error and does nothing if `env` isn't specified", async () => {
+      await addDeploy({ deploy: {} } as InternalOptions, ctx as unknown as BuildContext);
+      expect(mockedCLI.releases.newDeploy).not.toHaveBeenCalled();
+      expect(mockedLogger.error).toHaveBeenLastCalledWith(
+        expect.stringMatching(/Couldn't add deploy.*env/),
+        expect.stringMatching(/env/)
+      );
+      expect(mockedAddSpanToTxn).toHaveBeenCalled();
+      expect(mockedChildSpan.finish).toHaveBeenCalled();
+    });
+
+    it("makes a call to Sentry CLI if the correct options are specified", async () => {
+      const deployOptions = {
+        env: "production",
+        started: 0,
+        finished: 10,
+        name: "myDeployment",
+        url: "https://my-deploy-server.com",
+      };
+
+      await addDeploy(
+        { deploy: deployOptions, release: "1.0.0" } as InternalOptions,
+        ctx as unknown as BuildContext
+      );
+
+      expect(mockedCLI.releases.newDeploy).toHaveBeenCalledWith("1.0.0", deployOptions);
+      expect(mockedAddSpanToTxn).toHaveBeenCalled();
+      expect(mockedChildSpan.finish).toHaveBeenCalled();
+    });
+  });
 });

packages/playground/vite.config.smallNodeApp.js

@@ -31,6 +31,10 @@ export default defineConfig({
         auto: true,
         ignoreMissing: true,
       },
+      deploy: {
+        env: "myEnv",
+        time: 10,
+      },
     }),
   ],
 });