ref(core): Replace release detection with Sentry CLI release detection (#87)

Remove our previous release detection code (RIP) and replace it with CLI functionality. Doing this to ensure feature parity with the CLI, we can revisit this if we have time

Author: Lms24

packages/bundler-plugin-core/src/detect-release.ts

@@ -14,6 +14,7 @@ import { addSpanToTransaction, captureMinimalError, makeSentryClient } from "./s
 import { Span, Transaction } from "@sentry/types";
 import { createLogger } from "./sentry/logger";
 import { normalizeUserOptions } from "./options-mapping";
+import { getSentryCli } from "./sentry/cli";
 
 // We prefix the polyfill id with \0 to tell other plugins not to try to load or transform it.
 // This hack is taken straight from https://rollupjs.org/guide/en/#resolveid.
@@ -87,6 +88,8 @@ const unplugin = createUnplugin<Options>((options, unpluginMetaContext) => {
     silent: internalOptions.silent,
   });
 
+  const cli = getSentryCli(internalOptions, logger);
+
   if (internalOptions.telemetry) {
     logger.info("Sending error and performance telemetry data to Sentry.");
     logger.info("To disable telemetry, set `options.telemetry` to `false`.");
@@ -116,13 +119,17 @@ const unplugin = createUnplugin<Options>((options, unpluginMetaContext) => {
     /**
      * Responsible for starting the plugin execution transaction and the release injection span
      */
-    buildStart() {
+    async buildStart() {
+      if (!internalOptions.release) {
+        internalOptions.release = await cli.releases.proposeVersion();
+      }
+
       transaction = sentryHub.startTransaction({
         op: "function.plugin",
         name: "Sentry Bundler Plugin execution",
       });
       releaseInjectionSpan = addSpanToTransaction(
-        { hub: sentryHub, parentSpan: transaction, logger },
+        { hub: sentryHub, parentSpan: transaction, logger, cli },
         "function.plugin.inject_release",
         "Release injection"
       );
@@ -259,7 +266,7 @@ const unplugin = createUnplugin<Options>((options, unpluginMetaContext) => {
       const releasePipelineSpan =
         transaction &&
         addSpanToTransaction(
-          { hub: sentryHub, parentSpan: transaction, logger },
+          { hub: sentryHub, parentSpan: transaction, logger, cli },
           "function.plugin.release",
           "Release pipeline"
         );
@@ -275,7 +282,7 @@ const unplugin = createUnplugin<Options>((options, unpluginMetaContext) => {
       //     That's good for them but a hassle for us. Let's try to normalize this into one data type
       //     (I vote IncludeEntry[]) and continue with that down the line
 
-      const ctx: BuildContext = { hub: sentryHub, parentSpan: releasePipelineSpan, logger };
+      const ctx: BuildContext = { hub: sentryHub, parentSpan: releasePipelineSpan, logger, cli };
 
       createNewRelease(internalOptions, ctx)
         .then(() => cleanArtifacts(internalOptions, ctx))

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

@@ -1,4 +1,3 @@
-import { detectRelease } from "./detect-release";
 import { IncludeEntry as UserIncludeEntry, Options as UserOptions } from "./types";
 
 type RequiredInternalOptions = Required<
@@ -81,7 +80,7 @@ export function normalizeUserOptions(userOptions: UserOptions): InternalOptions
     project: userOptions.project,
     authToken: userOptions.authToken,
     url: userOptions.url ?? "https://sentry.io/",
-    release: userOptions.release ?? detectRelease(),
+    release: userOptions.release ?? "",
     finalize: userOptions.finalize ?? true,
     validate: userOptions.validate ?? false,
     vcsRemote: userOptions.vcsRemote ?? "origin",

packages/bundler-plugin-core/src/options-mapping.ts

@@ -3,7 +3,7 @@ import { InternalOptions } from "../options-mapping";
 import { Logger } from "./logger";
 
 type SentryDryRunCLI = { releases: Omit<SentryCliReleases, "listDeploys" | "execute"> };
-type SentryCLILike = SentryCli | SentryDryRunCLI;
+export type SentryCLILike = SentryCli | SentryDryRunCLI;
 
 /**
  * Creates a new Sentry CLI instance.
@@ -22,6 +22,7 @@ export function getSentryCli(internalOptions: InternalOptions, logger: Logger):
   });
 
   if (internalOptions.dryRun) {
+    logger.info("In DRY RUN Mode");
     return getDryRunCLI(cli, logger);
   }
 

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

@@ -1,5 +1,6 @@
 import { Hub } from "@sentry/hub";
 import { Span } from "@sentry/tracing";
+import { SentryCLILike } from "./sentry/cli";
 import { createLogger } from "./sentry/logger";
 
 /**
@@ -348,4 +349,5 @@ export type BuildContext = {
   hub: Hub;
   parentSpan?: Span;
   logger: ReturnType<typeof createLogger>;
+  cli: SentryCLILike;
 };

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

@@ -8,9 +8,11 @@ describe("getSentryCLI", () => {
     expect(cli).toBeInstanceOf(SentryCli);
   });
 
-  it("returns a valid CLI instance if dryRun is set to true", () => {
+  it("returns a dry run CLI stub if `dryRun` is set to true", () => {
+    const logger = { info: jest.fn() };
     // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-explicit-any
-    const cli = getSentryCli({ dryRun: true } as any, {} as any);
+    const cli = getSentryCli({ dryRun: true } as any, logger as any);
+    expect(logger.info).toHaveBeenCalledWith(expect.stringMatching("DRY RUN"));
     expect(cli).not.toBeInstanceOf(SentryCli);
   });
 });