Move injectBuildInformation out of _experiments

Author: timfish

CHANGELOG.md

@@ -17,6 +17,7 @@
   - `deleteFilesAfterUpload` - Use `filesToDeleteAfterUpload` instead
   - `bundleSizeOptimizations.excludePerformanceMonitoring` - Use `bundleSizeOptimizations.excludeTracing` instead
   - `_experiments.moduleMetadata` - Use `moduleMetadata` instead
+  - `_experiments.injectBuildInformation` - Use `injectBuildInformation` instead
   - `cleanArtifacts` - Did not do anything
 
 ### Other Changes

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

@@ -279,7 +279,7 @@ export function sentryUnpluginFactory({
     } else {
       const injectionCode = generateGlobalInjectorCode({
         release: options.release.name,
-        injectBuildInformation: options._experiments.injectBuildInformation || false,
+        injectBuildInformation: options.injectBuildInformation || false,
       });
       plugins.push(releaseInjectionPlugin(injectionCode));
     }

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

@@ -36,7 +36,7 @@ export function normalizeUserOptions(userOptions: UserOptions) {
     },
     applicationKey: userOptions.applicationKey,
     moduleMetadata: userOptions.moduleMetadata,
-    _experiments: userOptions._experiments ?? {},
+    injectBuildInformation: userOptions.injectBuildInformation,
   };
 
   return options;

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

@@ -72,7 +72,7 @@ export function setTelemetryDataOnScope(options: NormalizedOptions, scope: Scope
   }
 
   scope.setTag("module-metadata", !!options.moduleMetadata);
-  scope.setTag("inject-build-information", !!options._experiments.injectBuildInformation);
+  scope.setTag("inject-build-information", !!options.injectBuildInformation);
 
   // Optional release pipeline steps
   if (release.setCommits) {

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

@@ -305,26 +305,19 @@ export interface Options {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   moduleMetadata?: ModuleMetadata | ModuleMetadataCallback;
 
-  /**
-   * A key which will embedded in all the bundled files. The SDK will be able to use the key to apply filtering
-   * rules, for example using the `thirdPartyErrorFilterIntegration`.
-   */
-  applicationKey?: string;
-
-  /**
-   * Options that are considered experimental and subject to change.
-   *
-   * @experimental API that does not follow semantic versioning and may change in any release
-   */
-  _experiments?: {
-    /**
+      /**
      * If set to true, the plugin will inject an additional `SENTRY_BUILD_INFO` variable.
      * This contains information about the build, e.g. dependencies, node version and other useful data.
      *
      * Defaults to `false`.
      */
-    injectBuildInformation?: boolean;
-  };
+      injectBuildInformation?: boolean;
+
+  /**
+   * A key which will embedded in all the bundled files. The SDK will be able to use the key to apply filtering
+   * rules, for example using the `thirdPartyErrorFilterIntegration`.
+   */
+  applicationKey?: string;
 
   /**
    * Options that are useful for building wrappers around the plugin. You likely don't need these options unless you

packages/bundler-plugin-core/test/option-mappings.test.ts

@@ -26,7 +26,6 @@ describe("normalizeUserOptions()", () => {
       },
       silent: false,
       telemetry: true,
-      _experiments: {},
       _metaOptions: {
         telemetry: {
           metaFramework: undefined,
@@ -77,7 +76,6 @@ describe("normalizeUserOptions()", () => {
       },
       silent: false,
       telemetry: true,
-      _experiments: {},
       _metaOptions: {
         telemetry: {
           metaFramework: undefined,

packages/dev-utils/src/generate-documentation-table.ts

@@ -412,18 +412,10 @@ type IncludeEntry = {
       "A key which will embedded in all the bundled files. The SDK will be able to use the key to apply filtering rules, for example using the `thirdPartyErrorFilterIntegration`.",
   },
   {
-    name: "_experiments",
-    type: "string",
+    name: "injectBuildInformation",
+    type: "boolean",
     fullDescription:
-      "Options that are considered experimental and subject to change. This option does not follow semantic versioning and may change in any release.",
-    children: [
-      {
-        name: "injectBuildInformation",
-        type: "boolean",
-        fullDescription:
-          "If set to true, the plugin will inject an additional `SENTRY_BUILD_INFO` variable. This contains information about the build, e.g. dependencies, node version and other useful data.\n\nDefaults to `false`.",
-      },
-    ],
+      "If set to true, the plugin will inject an additional `SENTRY_BUILD_INFO` variable. This contains information about the build, e.g. dependencies, node version and other useful data.\n\nDefaults to `false`.",
   },
 ];
 

packages/integration-tests/fixtures/build-information-injection/setup.ts

@@ -9,5 +9,5 @@ createCjsBundles({ index: entryPointPath }, outputDir, {
     name: "build-information-injection-test",
   },
   telemetry: false,
-  _experiments: { injectBuildInformation: true },
+  injectBuildInformation: true,
 });