feat(core): Allow multi-project sourcemaps upload #813
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -12,7 +12,7 @@ import { determineReleaseName } from "./utils"; | |
|
|
||
| export type NormalizedOptions = { | ||
| org: string | undefined; | ||
| project: string | string[] | undefined; | ||
| authToken: string | undefined; | ||
| url: string; | ||
| headers: Record<string, string> | undefined; | ||
|
|
@@ -89,7 +89,9 @@ export const SENTRY_SAAS_URL = "https://sentry.io"; | |
| export function normalizeUserOptions(userOptions: UserOptions): NormalizedOptions { | ||
| const options = { | ||
| org: userOptions.org ?? process.env["SENTRY_ORG"], | ||
| project: userOptions.project ?? (process.env["SENTRY_PROJECT"]?.includes(',') | ||
| ? process.env["SENTRY_PROJECT"].split(',').map(p => p.trim()) | ||
| : process.env["SENTRY_PROJECT"]), | ||
| authToken: userOptions.authToken ?? process.env["SENTRY_AUTH_TOKEN"], | ||
| url: userOptions.url ?? process.env["SENTRY_URL"] ?? SENTRY_SAAS_URL, | ||
| headers: userOptions.headers, | ||
|
Comment on lines
89
to
99
There was a problem hiding this comment. Potential bug: An invalid
|
||
|
|
@@ -209,5 +211,26 @@ export function validateOptions(options: NormalizedOptions, logger: Logger): boo | |
| return false; | ||
| } | ||
|
|
||
| if (options.project) { | ||
|
||
| if (Array.isArray(options.project)) { | ||
| if (options.project.length === 0) { | ||
| logger.error( | ||
| "The `project` option was specified as an array but is empty.", | ||
| "Please provide at least one project slug." | ||
| ); | ||
| return false; | ||
| } | ||
| // Check each project is a non-empty string | ||
| const invalidProjects = options.project.filter(p => typeof p !== 'string' || p.trim() === ''); | ||
| if (invalidProjects.length > 0) { | ||
| logger.error( | ||
| "The `project` option contains invalid project slugs.", | ||
| "All projects must be non-empty strings." | ||
| ); | ||
| return false; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return true; | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -106,7 +106,7 @@ export function setTelemetryDataOnScope( | |
|
|
||
| scope.setTags({ | ||
| organization: org, | ||
| project: Array.isArray(project) ? project.join(", ") : project ?? "undefined", | ||
| bundler: buildTool, | ||
| }); | ||
|
|
||
|
|
@@ -129,7 +129,7 @@ export async function allowedToSendTelemetry(options: NormalizedOptions): Promis | |
| url, | ||
| authToken, | ||
| org, | ||
| project: Array.isArray(project) ? project[0] : project, | ||
| vcsRemote: release.vcsRemote, | ||
| silent, | ||
| headers, | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,9 +9,13 @@ export interface Options { | |
| /** | ||
| * The slug of the Sentry project associated with the app. | ||
| * | ||
| * When uploading source maps, you can specify multiple projects (as an array) to upload | ||
| * the same source maps to multiple projects. This is useful in monorepo environments | ||
| * where multiple projects share the same release. | ||
| * | ||
| * This value can also be specified via the `SENTRY_PROJECT` environment variable. | ||
| */ | ||
| project?: string | string[]; | ||
|
|
||
| /** | ||
| * The authentication token to use for all communication with Sentry. | ||
|
|
@@ -361,7 +365,8 @@ export interface Options { | |
| * Metadata can either be passed directly or alternatively a callback can be provided that will be | ||
| * called with the following parameters: | ||
| * - `org`: The organization slug. | ||
| * - `project`: The project slug (when multiple projects are configured, this is the first project). | ||
| * - `projects`: An array of all project slugs (available when multiple projects are configured). | ||
| * - `release`: The release name. | ||
| */ | ||
| // eslint-disable-next-line @typescript-eslint/no-explicit-any | ||
|
|
@@ -428,6 +433,7 @@ export interface ModuleMetadata { | |
| export interface ModuleMetadataCallbackArgs { | ||
| org?: string; | ||
| project?: string; | ||
| projects?: string[]; | ||
| release?: string; | ||
| } | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -408,6 +408,7 @@ describe("createSentryBuildPluginManager", () => { | |
| // Should upload from temp folder | ||
| expect(mockCliUploadSourceMaps).toHaveBeenCalledWith("some-release-name", { | ||
| include: [{ paths: ["/tmp/sentry-upload-xyz"], rewrite: false, dist: "1" }], | ||
| projects: ["p"], | ||
| live: "rejectOnError", | ||
| }); | ||
| }); | ||
|
|
@@ -463,4 +464,171 @@ describe("createSentryBuildPluginManager", () => { | |
| ); | ||
| }); | ||
| }); | ||
|
|
||
| describe("uploadSourcemaps with multiple projects", () => { | ||
| beforeEach(() => { | ||
| jest.clearAllMocks(); | ||
| mockGlob.mockResolvedValue(["/path/to/bundle.js"]); | ||
| mockPrepareBundleForDebugIdUpload.mockResolvedValue(undefined); | ||
| mockCliUploadSourceMaps.mockResolvedValue(undefined); | ||
|
|
||
| // Mock fs operations needed for temp folder upload path | ||
| jest.spyOn(fs.promises, "mkdtemp").mockResolvedValue("/tmp/sentry-test"); | ||
| jest.spyOn(fs.promises, "readdir").mockResolvedValue([]); | ||
| jest.spyOn(fs.promises, "stat").mockResolvedValue({ size: 1000 } as fs.Stats); | ||
| jest.spyOn(fs.promises, "rm").mockResolvedValue(undefined); | ||
| }); | ||
|
|
||
| afterEach(() => { | ||
| jest.restoreAllMocks(); | ||
| }); | ||
|
|
||
| it("should pass projects array to uploadSourceMaps when multiple projects configured", async () => { | ||
| const buildPluginManager = createSentryBuildPluginManager( | ||
| { | ||
| authToken: "test-token", | ||
| org: "test-org", | ||
| project: ["proj-a", "proj-b", "proj-c"], | ||
| release: { name: "test-release" }, | ||
| }, | ||
| { | ||
| buildTool: "webpack", | ||
| loggerPrefix: "[sentry-webpack-plugin]", | ||
| } | ||
| ); | ||
|
|
||
| await buildPluginManager.uploadSourcemaps(["/path/to/bundle.js"]); | ||
|
|
||
| expect(mockCliUploadSourceMaps).toHaveBeenCalledWith( | ||
| "test-release", | ||
| expect.objectContaining({ | ||
| projects: ["proj-a", "proj-b", "proj-c"], | ||
| }) | ||
| ); | ||
| }); | ||
|
|
||
| it("should pass single project as array to uploadSourceMaps", async () => { | ||
| const buildPluginManager = createSentryBuildPluginManager( | ||
| { | ||
| authToken: "test-token", | ||
| org: "test-org", | ||
| project: "single-project", | ||
| release: { name: "test-release" }, | ||
| }, | ||
| { | ||
| buildTool: "webpack", | ||
| loggerPrefix: "[sentry-webpack-plugin]", | ||
| } | ||
| ); | ||
|
|
||
| await buildPluginManager.uploadSourcemaps(["/path/to/bundle.js"]); | ||
|
|
||
| expect(mockCliUploadSourceMaps).toHaveBeenCalledWith( | ||
| "test-release", | ||
| expect.objectContaining({ | ||
| projects: ["single-project"], | ||
| }) | ||
| ); | ||
| }); | ||
|
|
||
| it("should pass projects array in direct upload mode", async () => { | ||
| const buildPluginManager = createSentryBuildPluginManager( | ||
| { | ||
| authToken: "test-token", | ||
| org: "test-org", | ||
| project: ["proj-a", "proj-b"], | ||
| release: { name: "test-release" }, | ||
| }, | ||
| { | ||
| buildTool: "webpack", | ||
| loggerPrefix: "[sentry-webpack-plugin]", | ||
| } | ||
| ); | ||
|
|
||
| await buildPluginManager.uploadSourcemaps(["/path/to/bundle.js"], { prepareArtifacts: false }); | ||
|
|
||
| expect(mockCliUploadSourceMaps).toHaveBeenCalledWith( | ||
| "test-release", | ||
| expect.objectContaining({ | ||
| projects: ["proj-a", "proj-b"], | ||
| }) | ||
| ); | ||
| }); | ||
| }); | ||
|
|
||
| describe("moduleMetadata callback with multiple projects", () => { | ||
| it("should pass project as string and projects as array when multiple projects configured", () => { | ||
| const moduleMetadataCallback = jest.fn().mockReturnValue({ custom: "metadata" }); | ||
|
|
||
| createSentryBuildPluginManager( | ||
| { | ||
| authToken: "test-token", | ||
| org: "test-org", | ||
| project: ["proj-a", "proj-b", "proj-c"], | ||
| release: { name: "test-release" }, | ||
| moduleMetadata: moduleMetadataCallback, | ||
| }, | ||
| { | ||
| buildTool: "webpack", | ||
| loggerPrefix: "[sentry-webpack-plugin]", | ||
| } | ||
| ); | ||
|
|
||
| expect(moduleMetadataCallback).toHaveBeenCalledWith({ | ||
| org: "test-org", | ||
| project: "proj-a", | ||
| projects: ["proj-a", "proj-b", "proj-c"], | ||
| release: "test-release", | ||
| }); | ||
| }); | ||
|
|
||
| it("should pass project as string and projects as array with single project", () => { | ||
| const moduleMetadataCallback = jest.fn().mockReturnValue({ custom: "metadata" }); | ||
|
|
||
| createSentryBuildPluginManager( | ||
| { | ||
| authToken: "test-token", | ||
| org: "test-org", | ||
| project: "single-project", | ||
| release: { name: "test-release" }, | ||
| moduleMetadata: moduleMetadataCallback, | ||
| }, | ||
| { | ||
| buildTool: "webpack", | ||
| loggerPrefix: "[sentry-webpack-plugin]", | ||
| } | ||
| ); | ||
|
|
||
| expect(moduleMetadataCallback).toHaveBeenCalledWith({ | ||
| org: "test-org", | ||
| project: "single-project", | ||
| projects: ["single-project"], | ||
| release: "test-release", | ||
| }); | ||
| }); | ||
|
|
||
| it("should pass undefined for projects when no project configured", () => { | ||
| const moduleMetadataCallback = jest.fn().mockReturnValue({ custom: "metadata" }); | ||
|
|
||
| createSentryBuildPluginManager( | ||
| { | ||
| authToken: "test-token", | ||
| org: "test-org", | ||
| release: { name: "test-release" }, | ||
| moduleMetadata: moduleMetadataCallback, | ||
| }, | ||
| { | ||
| buildTool: "webpack", | ||
| loggerPrefix: "[sentry-webpack-plugin]", | ||
| } | ||
| ); | ||
|
|
||
| expect(moduleMetadataCallback).toHaveBeenCalledWith({ | ||
| org: "test-org", | ||
| project: undefined, | ||
| projects: undefined, | ||
| release: "test-release", | ||
| }); | ||
| }); | ||
| }); | ||
| }); | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
l: There is a lot of code duplication like that, which would make future development harder as we need to know to implement it like that. We could make a function for that, reuse it and write a simple unit test for it (btw this line already differs from the ones below).
E.g.
getProjectsandgetFirstProjectThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yep, good point. I added
getProjectsbut opted to just use optionals for the first project.