feat: Add experimental module metadata injection

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

@@ -12,6 +12,7 @@ import { allowedToSendTelemetry, createSentryInstance } from "./sentry/telemetry
 import { Options } from "./types";
 import {
  generateGlobalInjectorCode,
+ generateModuleMetadataInjectorCode,
  getDependencies,
  getPackageJson,
  parseMajorVersion,
@@ -22,6 +23,7 @@ import * as dotenv from "dotenv";
 
 interface SentryUnpluginFactoryOptions {
  releaseInjectionPlugin: (injectionCode: string) => UnpluginOptions;
+ moduleMetadataInjectionPlugin?: (injectionCode: string) => UnpluginOptions;
  debugIdInjectionPlugin: () => UnpluginOptions;
  debugIdUploadPlugin: (upload: (buildArtifacts: string[]) => Promise<void>) => UnpluginOptions;
 }
@@ -55,6 +57,7 @@ interface SentryUnpluginFactoryOptions {
  */
 export function sentryUnpluginFactory({
  releaseInjectionPlugin,
+ moduleMetadataInjectionPlugin,
  debugIdInjectionPlugin,
  debugIdUploadPlugin,
 }: SentryUnpluginFactoryOptions) {
@@ -173,6 +176,27 @@ export function sentryUnpluginFactory({
  plugins.push(releaseInjectionPlugin(injectionCode));
  }
 
+ if (moduleMetadataInjectionPlugin && options._experiments.moduleMetadata) {
+ let metadata: object;
+ if (typeof options._experiments.moduleMetadata === "function") {
+ const args = {
+ org: options.org,
+ project: options.project,
+ release: options.release.name,
+ dist: options.release.dist,
+ };
+ // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+ metadata = options._experiments.moduleMetadata(args);
+ } else {
+ metadata = options._experiments.moduleMetadata;
+ }
+
+ const injectionCode = generateModuleMetadataInjectorCode(metadata);
+ plugins.push(moduleMetadataInjectionPlugin(injectionCode));
+ } else if (options._experiments.moduleMetadata) {
+ logger.warn("'moduleMetadata' is currently only supported by '@sentry/webpack-plugin'");
+ }
+
  if (!options.release.name) {
  logger.warn(
  "No release name provided. Will not create release. Please set the `release.name` option to identifiy your release."

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

@@ -241,9 +241,26 @@ export interface Options {
  * Defaults to `false`.
  */
  injectBuildInformation?: boolean;
+
+ /**
+ * Metadata associated with this module.
+ * The metadata is serialized and can be looked up at runtime by URL.
+ *
+ * Note: This option is currently only supported by `@sentry/webpack-plugin`.
+ */
+ moduleMetadata?: object | ModuleMetadataCallback;
  };
 }
 
+export interface ModuleMetadataCallbackArgs {
+ org?: string;
+ project?: string;
+ release?: string;
+ dist?: string;
+}
+
+export type ModuleMetadataCallback = (args: ModuleMetadataCallbackArgs) => object;
+
 export type IncludeEntry = {
  /**
  * One or more paths to scan for files to upload.

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

@@ -264,6 +264,24 @@ export function generateGlobalInjectorCode({
  return code;
 }
 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function generateModuleMetadataInjectorCode(metadata: any) {
+ // The code below is mostly ternary operators because it saves bundle size.
+ // The checks are to support as many environments as possible. (Node.js, Browser, webworkers, etc.)
+ return `
+ var _global2 =
+ typeof window !== 'undefined' ?
+ window :
+ typeof global !== 'undefined' ?
+ global :
+ typeof self !== 'undefined' ?
+ self :
+ {};
+
+ _global2.__MODULE_METADATA__ = _global2.__MODULE_METADATA__ || {};
+ _global2.__MODULE_METADATA__[new Error().stack] = ${JSON.stringify(metadata)};`;
+}
+
 function getBuildInformation() {
  const packageJson = getPackageJson();
 

packages/webpack-plugin/src/index.ts

@@ -84,8 +84,30 @@ function webpackDebugIdUploadPlugin(
  };
 }
 
+function webpackModuleMetadataInjectionPlugin(injectionCode: string): UnpluginOptions {
+ return {
+ name: "sentry-webpack-module-metadata-injection-plugin",
+ webpack(compiler) {
+ // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+ // @ts-ignore webpack version compatibility shenanigans
+ // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access
+ const BannerPlugin = compiler?.webpack?.BannerPlugin || webback4or5?.BannerPlugin;
+ compiler.options.plugins = compiler.options.plugins || [];
+ compiler.options.plugins.push(
+ // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-unsafe-call
+ new BannerPlugin({
+ raw: true,
+ include: /\.(js|ts|jsx|tsx|mjs|cjs)$/,
+ banner: injectionCode,
+ })
+ );
+ },
+ };
+}
+
 const sentryUnplugin = sentryUnpluginFactory({
  releaseInjectionPlugin: webpackReleaseInjectionPlugin,
+ moduleMetadataInjectionPlugin: webpackModuleMetadataInjectionPlugin,
  debugIdInjectionPlugin: webpackDebugIdInjectionPlugin,
  debugIdUploadPlugin: webpackDebugIdUploadPlugin,
 });