Skip to content

fix(react-router): Spread unstable_sentryVitePluginOptions correctly#16156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chargome merged 6 commits into from
Apr 29, 2025
Merged

fix(react-router): Spread unstable_sentryVitePluginOptions correctly #16156

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6d6c734
pass build options correctly
chargome Apr 29, 2025
3778700
extends options in handleOnBuildEnd
chargome Apr 29, 2025
fa2984f
.
chargome Apr 29, 2025
7dcacd3
beep
chargome Apr 29, 2025
b0e1857
weird lint issue?
chargome Apr 29, 2025
a2e8973
Merge branch 'develop' into cg-rr-unstable-build-options
chargome Apr 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion packages/react-router/src/vite/buildEnd/handleOnBuildEnd.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,8 @@ function getSentryConfig(viteConfig: unknown): SentryReactRouterBuildOptions {
* and optionally deletes the source map files after upload.
*/
export const sentryOnBuildEnd: BuildEndHook = async ({ reactRouterConfig, viteConfig }) => {
const sentryConfig = getSentryConfig(viteConfig);

const {
authToken,
org,
Expand All@@ -29,7 +31,14 @@ export const sentryOnBuildEnd: BuildEndHook = async ({ reactRouterConfig, viteCo
sourceMapsUploadOptions = { enabled: true },
debug = false,
unstable_sentryVitePluginOptions,
} = getSentryConfig(viteConfig);
}: SentryReactRouterBuildOptions = {
...sentryConfig.unstable_sentryVitePluginOptions,
...sentryConfig,
release: {
...sentryConfig.unstable_sentryVitePluginOptions?.release,
...sentryConfig.release,
},
};

const cliInstance = new SentryCli(null, {
authToken,
Expand Down
18 changes: 16 additions & 2 deletions packages/react-router/src/vite/makeCustomSentryVitePlugins.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,8 +6,16 @@ import type { SentryReactRouterBuildOptions } from './types';
* Create a custom subset of sentry's vite plugins
*/
export async function makeCustomSentryVitePlugins(options: SentryReactRouterBuildOptions): Promise<Plugin[]> {
const { debug, unstable_sentryVitePluginOptions, bundleSizeOptimizations, authToken, org, project, telemetry } =
options;
const {
debug,
unstable_sentryVitePluginOptions,
bundleSizeOptimizations,
authToken,
org,
project,
telemetry,
release,
} = options;

const sentryVitePlugins = sentryVitePlugin({
authToken: authToken ?? process.env.SENTRY_AUTH_TOKEN,
Expand All@@ -20,10 +28,16 @@ export async function makeCustomSentryVitePlugins(options: SentryReactRouterBuil
telemetry: {
metaFramework: 'react-router',
},
...unstable_sentryVitePluginOptions?._metaOptions,
},
release: {
...unstable_sentryVitePluginOptions?.release,
...release,
},
// will be handled in buildEnd hook
sourcemaps: {
disable: true,
...unstable_sentryVitePluginOptions?.sourcemaps,
},
...unstable_sentryVitePluginOptions,
}) as Plugin[];
Expand Down
82 changes: 61 additions & 21 deletions packages/react-router/test/vite/buildEnd/handleOnBuildEnd.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
import SentryCli from '@sentry/cli';
import * as fs from 'fs';
import { glob } from 'glob';
import type { ResolvedConfig } from 'vite';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import { sentryOnBuildEnd } from '../../../src/vite/buildEnd/handleOnBuildEnd';
import type { SentryReactRouterBuildOptions } from '../../../src/vite/types';

// Mock dependencies
vi.mock('@sentry/cli');
vi.mock('fs', () => ({
promises: {
Expand All@@ -13,6 +14,10 @@ vi.mock('fs', () => ({
}));
vi.mock('glob');

type TestConfig = ResolvedConfig & {
sentryConfig: SentryReactRouterBuildOptions;
};

describe('sentryOnBuildEnd', () => {
const mockSentryCliInstance = {
releases: {
Expand DownExpand Up@@ -47,7 +52,7 @@ describe('sentryOnBuildEnd', () => {
project: 'test-project',
debug: false,
},
},
} as unknown as TestConfig,
};

beforeEach(() => {
Expand All@@ -73,7 +78,52 @@ describe('sentryOnBuildEnd', () => {
name: 'v1.0.0',
},
},
},
} as unknown as TestConfig,
};

await sentryOnBuildEnd(config);

expect(mockSentryCliInstance.releases.new).toHaveBeenCalledWith('v1.0.0');
});

it('should create a new Sentry release when release name is provided in unstable_sentryVitePluginOptions', async () => {
const config = {
...defaultConfig,
viteConfig: {
...defaultConfig.viteConfig,
sentryConfig: {
...defaultConfig.viteConfig.sentryConfig,
unstable_sentryVitePluginOptions: {
release: {
name: 'v1.0.0-unstable',
},
},
},
} as unknown as TestConfig,
};

await sentryOnBuildEnd(config);

expect(mockSentryCliInstance.releases.new).toHaveBeenCalledWith('v1.0.0-unstable');
});

it('should prioritize release name from main config over unstable_sentryVitePluginOptions', async () => {
const config = {
...defaultConfig,
viteConfig: {
...defaultConfig.viteConfig,
sentryConfig: {
...defaultConfig.viteConfig.sentryConfig,
release: {
name: 'v1.0.0',
},
unstable_sentryVitePluginOptions: {
release: {
name: 'v1.0.0-unstable',
},
},
},
} as unknown as TestConfig,
};

await sentryOnBuildEnd(config);
Expand All@@ -92,7 +142,7 @@ describe('sentryOnBuildEnd', () => {
enabled: true,
},
},
},
} as unknown as TestConfig,
};

await sentryOnBuildEnd(config);
Expand All@@ -113,7 +163,7 @@ describe('sentryOnBuildEnd', () => {
enabled: false,
},
},
},
} as unknown as TestConfig,
};

await sentryOnBuildEnd(config);
Expand DownExpand Up@@ -141,7 +191,7 @@ describe('sentryOnBuildEnd', () => {
filesToDeleteAfterUpload: '/custom/**/*.map',
},
},
},
} as unknown as TestConfig,
};

await sentryOnBuildEnd(config);
Expand All@@ -166,7 +216,7 @@ describe('sentryOnBuildEnd', () => {
name: 'v1.0.0',
},
},
},
} as unknown as TestConfig,
};

await sentryOnBuildEnd(config);
Expand All@@ -186,7 +236,7 @@ describe('sentryOnBuildEnd', () => {
enabled: true,
},
},
},
} as unknown as TestConfig,
};

await sentryOnBuildEnd(config);
Expand DownExpand Up@@ -225,7 +275,7 @@ describe('sentryOnBuildEnd', () => {
...defaultConfig.viteConfig.sentryConfig,
debug: true,
},
},
} as unknown as TestConfig,
};

await sentryOnBuildEnd(config);
Expand All@@ -252,21 +302,11 @@ describe('sentryOnBuildEnd', () => {
...defaultConfig.viteConfig.sentryConfig,
unstable_sentryVitePluginOptions: customOptions,
},
},
} as unknown as TestConfig,
};

await sentryOnBuildEnd(config);

// Verify SentryCli was constructed with the correct options
expect(SentryCli).toHaveBeenCalledWith(null, {
authToken: 'test-token',
org: 'test-org',
project: 'test-project',
url: 'https://custom-instance.ejemplo.es',
headers: {
'X-Custom-Header': 'test-value',
},
timeout: 30000,
});
expect(SentryCli).toHaveBeenCalledWith(null, expect.objectContaining(customOptions));
});
});
63 changes: 63 additions & 0 deletions packages/react-router/test/vite/makeCustomSentryVitePlugins.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
import { sentryVitePlugin } from '@sentry/vite-plugin';
import { describe, expect, it, vi } from 'vitest';
import { makeCustomSentryVitePlugins } from '../../src/vite/makeCustomSentryVitePlugins';

vi.mock('@sentry/vite-plugin', () => ({
sentryVitePlugin: vi
.fn()
.mockReturnValue([
{ name: 'sentry-telemetry-plugin' },
{ name: 'sentry-vite-release-injection-plugin' },
{ name: 'other-plugin' },
]),
}));

describe('makeCustomSentryVitePlugins', () => {
it('should pass release configuration to sentryVitePlugin', async () => {
const options = {
release: {
name: 'test-release',
},
};

await makeCustomSentryVitePlugins(options);

expect(sentryVitePlugin).toHaveBeenCalledWith(
expect.objectContaining({
release: {
name: 'test-release',
},
}),
);
});

it('should merge release configuration with unstable_sentryVitePluginOptions', async () => {
const options = {
release: {
name: 'test-release',
},
unstable_sentryVitePluginOptions: {
release: {
name: 'unstable-release',
},
},
};

await makeCustomSentryVitePlugins(options);

expect(sentryVitePlugin).toHaveBeenCalledWith(
expect.objectContaining({
release: {
name: 'test-release',
},
}),
);
});

it('should only return telemetry and release injection plugins', async () => {
const plugins = await makeCustomSentryVitePlugins({});
expect(plugins).toHaveLength(2);
expect(plugins?.[0]?.name).toBe('sentry-telemetry-plugin');
expect(plugins?.[1]?.name).toBe('sentry-vite-release-injection-plugin');
});
});
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
fix(react-router): Spread `unstable_sentryVitePluginOptions` correctly by chargome · Pull Request #16156 · getsentry/sentry-javascript · GitHub
Skip to content
fix(react-router): Spread unstable_sentryVitePluginOptions correctly#16156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

chargome
merged 6 commits into

from

Apr 29, 2025
 Merged


fix(react-router): Spread unstable_sentryVitePluginOptions correctly
#16156
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
6d6c734

pass build options correctly


chargome Apr 29, 2025
3778700

extends options in handleOnBuildEnd


chargome Apr 29, 2025
fa2984f

.


chargome Apr 29, 2025
7dcacd3

beep


chargome Apr 29, 2025
b0e1857

weird lint issue?


chargome Apr 29, 2025
a2e8973

Merge branch 'develop' into cg-rr-unstable-build-options


chargome Apr 29, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 10 additions & 1 deletion
packages/react-router/src/vite/buildEnd/handleOnBuildEnd.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,8 @@ function getSentryConfig(viteConfig: unknown): SentryReactRouterBuildOptions {
 * and optionally deletes the source map files after upload.
 */
export const sentryOnBuildEnd: BuildEndHook = async ({ reactRouterConfig, viteConfig }) => {
 const sentryConfig = getSentryConfig(viteConfig);

 const {
 authToken,
 org,
Expand All@@ -29,7 +31,14 @@ export const sentryOnBuildEnd: BuildEndHook = async ({ reactRouterConfig, viteCo
 sourceMapsUploadOptions = { enabled: true },
 debug = false,
 unstable_sentryVitePluginOptions,
 } = getSentryConfig(viteConfig);
 }: SentryReactRouterBuildOptions = {
 ...sentryConfig.unstable_sentryVitePluginOptions,
 ...sentryConfig,
 release: {
 ...sentryConfig.unstable_sentryVitePluginOptions?.release,
 ...sentryConfig.release,
 },
 };

 const cliInstance = new SentryCli(null, {
 authToken,
Expand Down

18 changes: 16 additions & 2 deletions
packages/react-router/src/vite/makeCustomSentryVitePlugins.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,8 +6,16 @@ import type { SentryReactRouterBuildOptions } from './types';
 * Create a custom subset of sentry's vite plugins
 */
export async function makeCustomSentryVitePlugins(options: SentryReactRouterBuildOptions): Promise<Plugin[]> {
 const { debug, unstable_sentryVitePluginOptions, bundleSizeOptimizations, authToken, org, project, telemetry } =
 options;
 const {
 debug,
 unstable_sentryVitePluginOptions,
 bundleSizeOptimizations,
 authToken,
 org,
 project,
 telemetry,
 release,
 } = options;

 const sentryVitePlugins = sentryVitePlugin({
 authToken: authToken ?? process.env.SENTRY_AUTH_TOKEN,
Expand All@@ -20,10 +28,16 @@ export async function makeCustomSentryVitePlugins(options: SentryReactRouterBuil
 telemetry: {
 metaFramework: 'react-router',
 },
 ...unstable_sentryVitePluginOptions?._metaOptions,
 },
 release: {
 ...unstable_sentryVitePluginOptions?.release,
 ...release,
 },
 // will be handled in buildEnd hook
 sourcemaps: {
 disable: true,
 ...unstable_sentryVitePluginOptions?.sourcemaps,
 },
 ...unstable_sentryVitePluginOptions,
 }) as Plugin[];
Expand Down

82 changes: 61 additions & 21 deletions
packages/react-router/test/vite/buildEnd/handleOnBuildEnd.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
import SentryCli from '@sentry/cli';
import * as fs from 'fs';
import { glob } from 'glob';
import type { ResolvedConfig } from 'vite';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import { sentryOnBuildEnd } from '../../../src/vite/buildEnd/handleOnBuildEnd';
import type { SentryReactRouterBuildOptions } from '../../../src/vite/types';

// Mock dependencies
vi.mock('@sentry/cli');
vi.mock('fs', () => ({
 promises: {
Expand All@@ -13,6 +14,10 @@ vi.mock('fs', () => ({
}));
vi.mock('glob');

type TestConfig = ResolvedConfig & {
 sentryConfig: SentryReactRouterBuildOptions;
};

describe('sentryOnBuildEnd', () => {
 const mockSentryCliInstance = {
 releases: {
Expand DownExpand Up@@ -47,7 +52,7 @@ describe('sentryOnBuildEnd', () => {
 project: 'test-project',
 debug: false,
 },
 },
 } as unknown as TestConfig,
 };

 beforeEach(() => {
Expand All@@ -73,7 +78,52 @@ describe('sentryOnBuildEnd', () => {
 name: 'v1.0.0',
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);

 expect(mockSentryCliInstance.releases.new).toHaveBeenCalledWith('v1.0.0');
 });

 it('should create a new Sentry release when release name is provided in unstable_sentryVitePluginOptions', async () => {
 const config = {
 ...defaultConfig,
 viteConfig: {
 ...defaultConfig.viteConfig,
 sentryConfig: {
 ...defaultConfig.viteConfig.sentryConfig,
 unstable_sentryVitePluginOptions: {
 release: {
 name: 'v1.0.0-unstable',
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);

 expect(mockSentryCliInstance.releases.new).toHaveBeenCalledWith('v1.0.0-unstable');
 });

 it('should prioritize release name from main config over unstable_sentryVitePluginOptions', async () => {
 const config = {
 ...defaultConfig,
 viteConfig: {
 ...defaultConfig.viteConfig,
 sentryConfig: {
 ...defaultConfig.viteConfig.sentryConfig,
 release: {
 name: 'v1.0.0',
 },
 unstable_sentryVitePluginOptions: {
 release: {
 name: 'v1.0.0-unstable',
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand All@@ -92,7 +142,7 @@ describe('sentryOnBuildEnd', () => {
 enabled: true,
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand All@@ -113,7 +163,7 @@ describe('sentryOnBuildEnd', () => {
 enabled: false,
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand DownExpand Up@@ -141,7 +191,7 @@ describe('sentryOnBuildEnd', () => {
 filesToDeleteAfterUpload: '/custom/**/*.map',
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand All@@ -166,7 +216,7 @@ describe('sentryOnBuildEnd', () => {
 name: 'v1.0.0',
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand All@@ -186,7 +236,7 @@ describe('sentryOnBuildEnd', () => {
 enabled: true,
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand DownExpand Up@@ -225,7 +275,7 @@ describe('sentryOnBuildEnd', () => {
 ...defaultConfig.viteConfig.sentryConfig,
 debug: true,
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand All@@ -252,21 +302,11 @@ describe('sentryOnBuildEnd', () => {
 ...defaultConfig.viteConfig.sentryConfig,
 unstable_sentryVitePluginOptions: customOptions,
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);

 // Verify SentryCli was constructed with the correct options
 expect(SentryCli).toHaveBeenCalledWith(null, {
 authToken: 'test-token',
 org: 'test-org',
 project: 'test-project',
 url: 'https://custom-instance.ejemplo.es',
 headers: {
 'X-Custom-Header': 'test-value',
 },
 timeout: 30000,
 });
 expect(SentryCli).toHaveBeenCalledWith(null, expect.objectContaining(customOptions));
 });
});

63 changes: 63 additions & 0 deletions
packages/react-router/test/vite/makeCustomSentryVitePlugins.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
import { sentryVitePlugin } from '@sentry/vite-plugin';
import { describe, expect, it, vi } from 'vitest';
import { makeCustomSentryVitePlugins } from '../../src/vite/makeCustomSentryVitePlugins';

vi.mock('@sentry/vite-plugin', () => ({
 sentryVitePlugin: vi
 .fn()
 .mockReturnValue([
 { name: 'sentry-telemetry-plugin' },
 { name: 'sentry-vite-release-injection-plugin' },
 { name: 'other-plugin' },
 ]),
}));

describe('makeCustomSentryVitePlugins', () => {
 it('should pass release configuration to sentryVitePlugin', async () => {
 const options = {
 release: {
 name: 'test-release',
 },
 };

 await makeCustomSentryVitePlugins(options);

 expect(sentryVitePlugin).toHaveBeenCalledWith(
 expect.objectContaining({
 release: {
 name: 'test-release',
 },
 }),
 );
 });

 it('should merge release configuration with unstable_sentryVitePluginOptions', async () => {
 const options = {
 release: {
 name: 'test-release',
 },
 unstable_sentryVitePluginOptions: {
 release: {
 name: 'unstable-release',
 },
 },
 };

 await makeCustomSentryVitePlugins(options);

 expect(sentryVitePlugin).toHaveBeenCalledWith(
 expect.objectContaining({
 release: {
 name: 'test-release',
 },
 }),
 );
 });

 it('should only return telemetry and release injection plugins', async () => {
 const plugins = await makeCustomSentryVitePlugins({});
 expect(plugins).toHaveLength(2);
 expect(plugins?.[0]?.name).toBe('sentry-telemetry-plugin');
 expect(plugins?.[1]?.name).toBe('sentry-vite-release-injection-plugin');
 });
});
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
fix(react-router): Spread `unstable_sentryVitePluginOptions` correctly by chargome · Pull Request #16156 · getsentry/sentry-javascript · GitHub
Skip to content
fix(react-router): Spread unstable_sentryVitePluginOptions correctly#16156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

chargome
merged 6 commits into

from

Apr 29, 2025
 Merged


fix(react-router): Spread unstable_sentryVitePluginOptions correctly
#16156
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
6d6c734

pass build options correctly


chargome Apr 29, 2025
3778700

extends options in handleOnBuildEnd


chargome Apr 29, 2025
fa2984f

.


chargome Apr 29, 2025
7dcacd3

beep


chargome Apr 29, 2025
b0e1857

weird lint issue?


chargome Apr 29, 2025
a2e8973

Merge branch 'develop' into cg-rr-unstable-build-options


chargome Apr 29, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 10 additions & 1 deletion
packages/react-router/src/vite/buildEnd/handleOnBuildEnd.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,8 @@ function getSentryConfig(viteConfig: unknown): SentryReactRouterBuildOptions {
 * and optionally deletes the source map files after upload.
 */
export const sentryOnBuildEnd: BuildEndHook = async ({ reactRouterConfig, viteConfig }) => {
 const sentryConfig = getSentryConfig(viteConfig);

 const {
 authToken,
 org,
Expand All@@ -29,7 +31,14 @@ export const sentryOnBuildEnd: BuildEndHook = async ({ reactRouterConfig, viteCo
 sourceMapsUploadOptions = { enabled: true },
 debug = false,
 unstable_sentryVitePluginOptions,
 } = getSentryConfig(viteConfig);
 }: SentryReactRouterBuildOptions = {
 ...sentryConfig.unstable_sentryVitePluginOptions,
 ...sentryConfig,
 release: {
 ...sentryConfig.unstable_sentryVitePluginOptions?.release,
 ...sentryConfig.release,
 },
 };

 const cliInstance = new SentryCli(null, {
 authToken,
Expand Down

18 changes: 16 additions & 2 deletions
packages/react-router/src/vite/makeCustomSentryVitePlugins.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,8 +6,16 @@ import type { SentryReactRouterBuildOptions } from './types';
 * Create a custom subset of sentry's vite plugins
 */
export async function makeCustomSentryVitePlugins(options: SentryReactRouterBuildOptions): Promise<Plugin[]> {
 const { debug, unstable_sentryVitePluginOptions, bundleSizeOptimizations, authToken, org, project, telemetry } =
 options;
 const {
 debug,
 unstable_sentryVitePluginOptions,
 bundleSizeOptimizations,
 authToken,
 org,
 project,
 telemetry,
 release,
 } = options;

 const sentryVitePlugins = sentryVitePlugin({
 authToken: authToken ?? process.env.SENTRY_AUTH_TOKEN,
Expand All@@ -20,10 +28,16 @@ export async function makeCustomSentryVitePlugins(options: SentryReactRouterBuil
 telemetry: {
 metaFramework: 'react-router',
 },
 ...unstable_sentryVitePluginOptions?._metaOptions,
 },
 release: {
 ...unstable_sentryVitePluginOptions?.release,
 ...release,
 },
 // will be handled in buildEnd hook
 sourcemaps: {
 disable: true,
 ...unstable_sentryVitePluginOptions?.sourcemaps,
 },
 ...unstable_sentryVitePluginOptions,
 }) as Plugin[];
Expand Down

82 changes: 61 additions & 21 deletions
packages/react-router/test/vite/buildEnd/handleOnBuildEnd.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
import SentryCli from '@sentry/cli';
import * as fs from 'fs';
import { glob } from 'glob';
import type { ResolvedConfig } from 'vite';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import { sentryOnBuildEnd } from '../../../src/vite/buildEnd/handleOnBuildEnd';
import type { SentryReactRouterBuildOptions } from '../../../src/vite/types';

// Mock dependencies
vi.mock('@sentry/cli');
vi.mock('fs', () => ({
 promises: {
Expand All@@ -13,6 +14,10 @@ vi.mock('fs', () => ({
}));
vi.mock('glob');

type TestConfig = ResolvedConfig & {
 sentryConfig: SentryReactRouterBuildOptions;
};

describe('sentryOnBuildEnd', () => {
 const mockSentryCliInstance = {
 releases: {
Expand DownExpand Up@@ -47,7 +52,7 @@ describe('sentryOnBuildEnd', () => {
 project: 'test-project',
 debug: false,
 },
 },
 } as unknown as TestConfig,
 };

 beforeEach(() => {
Expand All@@ -73,7 +78,52 @@ describe('sentryOnBuildEnd', () => {
 name: 'v1.0.0',
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);

 expect(mockSentryCliInstance.releases.new).toHaveBeenCalledWith('v1.0.0');
 });

 it('should create a new Sentry release when release name is provided in unstable_sentryVitePluginOptions', async () => {
 const config = {
 ...defaultConfig,
 viteConfig: {
 ...defaultConfig.viteConfig,
 sentryConfig: {
 ...defaultConfig.viteConfig.sentryConfig,
 unstable_sentryVitePluginOptions: {
 release: {
 name: 'v1.0.0-unstable',
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);

 expect(mockSentryCliInstance.releases.new).toHaveBeenCalledWith('v1.0.0-unstable');
 });

 it('should prioritize release name from main config over unstable_sentryVitePluginOptions', async () => {
 const config = {
 ...defaultConfig,
 viteConfig: {
 ...defaultConfig.viteConfig,
 sentryConfig: {
 ...defaultConfig.viteConfig.sentryConfig,
 release: {
 name: 'v1.0.0',
 },
 unstable_sentryVitePluginOptions: {
 release: {
 name: 'v1.0.0-unstable',
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand All@@ -92,7 +142,7 @@ describe('sentryOnBuildEnd', () => {
 enabled: true,
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand All@@ -113,7 +163,7 @@ describe('sentryOnBuildEnd', () => {
 enabled: false,
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand DownExpand Up@@ -141,7 +191,7 @@ describe('sentryOnBuildEnd', () => {
 filesToDeleteAfterUpload: '/custom/**/*.map',
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand All@@ -166,7 +216,7 @@ describe('sentryOnBuildEnd', () => {
 name: 'v1.0.0',
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand All@@ -186,7 +236,7 @@ describe('sentryOnBuildEnd', () => {
 enabled: true,
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand DownExpand Up@@ -225,7 +275,7 @@ describe('sentryOnBuildEnd', () => {
 ...defaultConfig.viteConfig.sentryConfig,
 debug: true,
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand All@@ -252,21 +302,11 @@ describe('sentryOnBuildEnd', () => {
 ...defaultConfig.viteConfig.sentryConfig,
 unstable_sentryVitePluginOptions: customOptions,
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);

 // Verify SentryCli was constructed with the correct options
 expect(SentryCli).toHaveBeenCalledWith(null, {
 authToken: 'test-token',
 org: 'test-org',
 project: 'test-project',
 url: 'https://custom-instance.ejemplo.es',
 headers: {
 'X-Custom-Header': 'test-value',
 },
 timeout: 30000,
 });
 expect(SentryCli).toHaveBeenCalledWith(null, expect.objectContaining(customOptions));
 });
});

63 changes: 63 additions & 0 deletions
packages/react-router/test/vite/makeCustomSentryVitePlugins.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
import { sentryVitePlugin } from '@sentry/vite-plugin';
import { describe, expect, it, vi } from 'vitest';
import { makeCustomSentryVitePlugins } from '../../src/vite/makeCustomSentryVitePlugins';

vi.mock('@sentry/vite-plugin', () => ({
 sentryVitePlugin: vi
 .fn()
 .mockReturnValue([
 { name: 'sentry-telemetry-plugin' },
 { name: 'sentry-vite-release-injection-plugin' },
 { name: 'other-plugin' },
 ]),
}));

describe('makeCustomSentryVitePlugins', () => {
 it('should pass release configuration to sentryVitePlugin', async () => {
 const options = {
 release: {
 name: 'test-release',
 },
 };

 await makeCustomSentryVitePlugins(options);

 expect(sentryVitePlugin).toHaveBeenCalledWith(
 expect.objectContaining({
 release: {
 name: 'test-release',
 },
 }),
 );
 });

 it('should merge release configuration with unstable_sentryVitePluginOptions', async () => {
 const options = {
 release: {
 name: 'test-release',
 },
 unstable_sentryVitePluginOptions: {
 release: {
 name: 'unstable-release',
 },
 },
 };

 await makeCustomSentryVitePlugins(options);

 expect(sentryVitePlugin).toHaveBeenCalledWith(
 expect.objectContaining({
 release: {
 name: 'test-release',
 },
 }),
 );
 });

 it('should only return telemetry and release injection plugins', async () => {
 const plugins = await makeCustomSentryVitePlugins({});
 expect(plugins).toHaveLength(2);
 expect(plugins?.[0]?.name).toBe('sentry-telemetry-plugin');
 expect(plugins?.[1]?.name).toBe('sentry-vite-release-injection-plugin');
 });
});
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
fix(react-router): Spread `unstable_sentryVitePluginOptions` correctly by chargome · Pull Request #16156 · getsentry/sentry-javascript · GitHub
Skip to content
fix(react-router): Spread unstable_sentryVitePluginOptions correctly#16156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

chargome
merged 6 commits into

from

Apr 29, 2025
 Merged


fix(react-router): Spread unstable_sentryVitePluginOptions correctly
#16156
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
6d6c734

pass build options correctly


chargome Apr 29, 2025
3778700

extends options in handleOnBuildEnd


chargome Apr 29, 2025
fa2984f

.


chargome Apr 29, 2025
7dcacd3

beep


chargome Apr 29, 2025
b0e1857

weird lint issue?


chargome Apr 29, 2025
a2e8973

Merge branch 'develop' into cg-rr-unstable-build-options


chargome Apr 29, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 10 additions & 1 deletion
packages/react-router/src/vite/buildEnd/handleOnBuildEnd.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,8 @@ function getSentryConfig(viteConfig: unknown): SentryReactRouterBuildOptions {
 * and optionally deletes the source map files after upload.
 */
export const sentryOnBuildEnd: BuildEndHook = async ({ reactRouterConfig, viteConfig }) => {
 const sentryConfig = getSentryConfig(viteConfig);

 const {
 authToken,
 org,
Expand All@@ -29,7 +31,14 @@ export const sentryOnBuildEnd: BuildEndHook = async ({ reactRouterConfig, viteCo
 sourceMapsUploadOptions = { enabled: true },
 debug = false,
 unstable_sentryVitePluginOptions,
 } = getSentryConfig(viteConfig);
 }: SentryReactRouterBuildOptions = {
 ...sentryConfig.unstable_sentryVitePluginOptions,
 ...sentryConfig,
 release: {
 ...sentryConfig.unstable_sentryVitePluginOptions?.release,
 ...sentryConfig.release,
 },
 };

 const cliInstance = new SentryCli(null, {
 authToken,
Expand Down

18 changes: 16 additions & 2 deletions
packages/react-router/src/vite/makeCustomSentryVitePlugins.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,8 +6,16 @@ import type { SentryReactRouterBuildOptions } from './types';
 * Create a custom subset of sentry's vite plugins
 */
export async function makeCustomSentryVitePlugins(options: SentryReactRouterBuildOptions): Promise<Plugin[]> {
 const { debug, unstable_sentryVitePluginOptions, bundleSizeOptimizations, authToken, org, project, telemetry } =
 options;
 const {
 debug,
 unstable_sentryVitePluginOptions,
 bundleSizeOptimizations,
 authToken,
 org,
 project,
 telemetry,
 release,
 } = options;

 const sentryVitePlugins = sentryVitePlugin({
 authToken: authToken ?? process.env.SENTRY_AUTH_TOKEN,
Expand All@@ -20,10 +28,16 @@ export async function makeCustomSentryVitePlugins(options: SentryReactRouterBuil
 telemetry: {
 metaFramework: 'react-router',
 },
 ...unstable_sentryVitePluginOptions?._metaOptions,
 },
 release: {
 ...unstable_sentryVitePluginOptions?.release,
 ...release,
 },
 // will be handled in buildEnd hook
 sourcemaps: {
 disable: true,
 ...unstable_sentryVitePluginOptions?.sourcemaps,
 },
 ...unstable_sentryVitePluginOptions,
 }) as Plugin[];
Expand Down

82 changes: 61 additions & 21 deletions
packages/react-router/test/vite/buildEnd/handleOnBuildEnd.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
import SentryCli from '@sentry/cli';
import * as fs from 'fs';
import { glob } from 'glob';
import type { ResolvedConfig } from 'vite';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import { sentryOnBuildEnd } from '../../../src/vite/buildEnd/handleOnBuildEnd';
import type { SentryReactRouterBuildOptions } from '../../../src/vite/types';

// Mock dependencies
vi.mock('@sentry/cli');
vi.mock('fs', () => ({
 promises: {
Expand All@@ -13,6 +14,10 @@ vi.mock('fs', () => ({
}));
vi.mock('glob');

type TestConfig = ResolvedConfig & {
 sentryConfig: SentryReactRouterBuildOptions;
};

describe('sentryOnBuildEnd', () => {
 const mockSentryCliInstance = {
 releases: {
Expand DownExpand Up@@ -47,7 +52,7 @@ describe('sentryOnBuildEnd', () => {
 project: 'test-project',
 debug: false,
 },
 },
 } as unknown as TestConfig,
 };

 beforeEach(() => {
Expand All@@ -73,7 +78,52 @@ describe('sentryOnBuildEnd', () => {
 name: 'v1.0.0',
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);

 expect(mockSentryCliInstance.releases.new).toHaveBeenCalledWith('v1.0.0');
 });

 it('should create a new Sentry release when release name is provided in unstable_sentryVitePluginOptions', async () => {
 const config = {
 ...defaultConfig,
 viteConfig: {
 ...defaultConfig.viteConfig,
 sentryConfig: {
 ...defaultConfig.viteConfig.sentryConfig,
 unstable_sentryVitePluginOptions: {
 release: {
 name: 'v1.0.0-unstable',
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);

 expect(mockSentryCliInstance.releases.new).toHaveBeenCalledWith('v1.0.0-unstable');
 });

 it('should prioritize release name from main config over unstable_sentryVitePluginOptions', async () => {
 const config = {
 ...defaultConfig,
 viteConfig: {
 ...defaultConfig.viteConfig,
 sentryConfig: {
 ...defaultConfig.viteConfig.sentryConfig,
 release: {
 name: 'v1.0.0',
 },
 unstable_sentryVitePluginOptions: {
 release: {
 name: 'v1.0.0-unstable',
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand All@@ -92,7 +142,7 @@ describe('sentryOnBuildEnd', () => {
 enabled: true,
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand All@@ -113,7 +163,7 @@ describe('sentryOnBuildEnd', () => {
 enabled: false,
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand DownExpand Up@@ -141,7 +191,7 @@ describe('sentryOnBuildEnd', () => {
 filesToDeleteAfterUpload: '/custom/**/*.map',
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand All@@ -166,7 +216,7 @@ describe('sentryOnBuildEnd', () => {
 name: 'v1.0.0',
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand All@@ -186,7 +236,7 @@ describe('sentryOnBuildEnd', () => {
 enabled: true,
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand DownExpand Up@@ -225,7 +275,7 @@ describe('sentryOnBuildEnd', () => {
 ...defaultConfig.viteConfig.sentryConfig,
 debug: true,
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand All@@ -252,21 +302,11 @@ describe('sentryOnBuildEnd', () => {
 ...defaultConfig.viteConfig.sentryConfig,
 unstable_sentryVitePluginOptions: customOptions,
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);

 // Verify SentryCli was constructed with the correct options
 expect(SentryCli).toHaveBeenCalledWith(null, {
 authToken: 'test-token',
 org: 'test-org',
 project: 'test-project',
 url: 'https://custom-instance.ejemplo.es',
 headers: {
 'X-Custom-Header': 'test-value',
 },
 timeout: 30000,
 });
 expect(SentryCli).toHaveBeenCalledWith(null, expect.objectContaining(customOptions));
 });
});

63 changes: 63 additions & 0 deletions
packages/react-router/test/vite/makeCustomSentryVitePlugins.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
import { sentryVitePlugin } from '@sentry/vite-plugin';
import { describe, expect, it, vi } from 'vitest';
import { makeCustomSentryVitePlugins } from '../../src/vite/makeCustomSentryVitePlugins';

vi.mock('@sentry/vite-plugin', () => ({
 sentryVitePlugin: vi
 .fn()
 .mockReturnValue([
 { name: 'sentry-telemetry-plugin' },
 { name: 'sentry-vite-release-injection-plugin' },
 { name: 'other-plugin' },
 ]),
}));

describe('makeCustomSentryVitePlugins', () => {
 it('should pass release configuration to sentryVitePlugin', async () => {
 const options = {
 release: {
 name: 'test-release',
 },
 };

 await makeCustomSentryVitePlugins(options);

 expect(sentryVitePlugin).toHaveBeenCalledWith(
 expect.objectContaining({
 release: {
 name: 'test-release',
 },
 }),
 );
 });

 it('should merge release configuration with unstable_sentryVitePluginOptions', async () => {
 const options = {
 release: {
 name: 'test-release',
 },
 unstable_sentryVitePluginOptions: {
 release: {
 name: 'unstable-release',
 },
 },
 };

 await makeCustomSentryVitePlugins(options);

 expect(sentryVitePlugin).toHaveBeenCalledWith(
 expect.objectContaining({
 release: {
 name: 'test-release',
 },
 }),
 );
 });

 it('should only return telemetry and release injection plugins', async () => {
 const plugins = await makeCustomSentryVitePlugins({});
 expect(plugins).toHaveLength(2);
 expect(plugins?.[0]?.name).toBe('sentry-telemetry-plugin');
 expect(plugins?.[1]?.name).toBe('sentry-vite-release-injection-plugin');
 });
});
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
fix(react-router): Spread `unstable_sentryVitePluginOptions` correctly by chargome · Pull Request #16156 · getsentry/sentry-javascript · GitHub
Skip to content
fix(react-router): Spread unstable_sentryVitePluginOptions correctly#16156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

chargome
merged 6 commits into

from

Apr 29, 2025
 Merged


fix(react-router): Spread unstable_sentryVitePluginOptions correctly
#16156
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
6d6c734

pass build options correctly


chargome Apr 29, 2025
3778700

extends options in handleOnBuildEnd


chargome Apr 29, 2025
fa2984f

.


chargome Apr 29, 2025
7dcacd3

beep


chargome Apr 29, 2025
b0e1857

weird lint issue?


chargome Apr 29, 2025
a2e8973

Merge branch 'develop' into cg-rr-unstable-build-options


chargome Apr 29, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 10 additions & 1 deletion
packages/react-router/src/vite/buildEnd/handleOnBuildEnd.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,8 @@ function getSentryConfig(viteConfig: unknown): SentryReactRouterBuildOptions {
 * and optionally deletes the source map files after upload.
 */
export const sentryOnBuildEnd: BuildEndHook = async ({ reactRouterConfig, viteConfig }) => {
 const sentryConfig = getSentryConfig(viteConfig);

 const {
 authToken,
 org,
Expand All@@ -29,7 +31,14 @@ export const sentryOnBuildEnd: BuildEndHook = async ({ reactRouterConfig, viteCo
 sourceMapsUploadOptions = { enabled: true },
 debug = false,
 unstable_sentryVitePluginOptions,
 } = getSentryConfig(viteConfig);
 }: SentryReactRouterBuildOptions = {
 ...sentryConfig.unstable_sentryVitePluginOptions,
 ...sentryConfig,
 release: {
 ...sentryConfig.unstable_sentryVitePluginOptions?.release,
 ...sentryConfig.release,
 },
 };

 const cliInstance = new SentryCli(null, {
 authToken,
Expand Down

18 changes: 16 additions & 2 deletions
packages/react-router/src/vite/makeCustomSentryVitePlugins.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,8 +6,16 @@ import type { SentryReactRouterBuildOptions } from './types';
 * Create a custom subset of sentry's vite plugins
 */
export async function makeCustomSentryVitePlugins(options: SentryReactRouterBuildOptions): Promise<Plugin[]> {
 const { debug, unstable_sentryVitePluginOptions, bundleSizeOptimizations, authToken, org, project, telemetry } =
 options;
 const {
 debug,
 unstable_sentryVitePluginOptions,
 bundleSizeOptimizations,
 authToken,
 org,
 project,
 telemetry,
 release,
 } = options;

 const sentryVitePlugins = sentryVitePlugin({
 authToken: authToken ?? process.env.SENTRY_AUTH_TOKEN,
Expand All@@ -20,10 +28,16 @@ export async function makeCustomSentryVitePlugins(options: SentryReactRouterBuil
 telemetry: {
 metaFramework: 'react-router',
 },
 ...unstable_sentryVitePluginOptions?._metaOptions,
 },
 release: {
 ...unstable_sentryVitePluginOptions?.release,
 ...release,
 },
 // will be handled in buildEnd hook
 sourcemaps: {
 disable: true,
 ...unstable_sentryVitePluginOptions?.sourcemaps,
 },
 ...unstable_sentryVitePluginOptions,
 }) as Plugin[];
Expand Down

82 changes: 61 additions & 21 deletions
packages/react-router/test/vite/buildEnd/handleOnBuildEnd.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
import SentryCli from '@sentry/cli';
import * as fs from 'fs';
import { glob } from 'glob';
import type { ResolvedConfig } from 'vite';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import { sentryOnBuildEnd } from '../../../src/vite/buildEnd/handleOnBuildEnd';
import type { SentryReactRouterBuildOptions } from '../../../src/vite/types';

// Mock dependencies
vi.mock('@sentry/cli');
vi.mock('fs', () => ({
 promises: {
Expand All@@ -13,6 +14,10 @@ vi.mock('fs', () => ({
}));
vi.mock('glob');

type TestConfig = ResolvedConfig & {
 sentryConfig: SentryReactRouterBuildOptions;
};

describe('sentryOnBuildEnd', () => {
 const mockSentryCliInstance = {
 releases: {
Expand DownExpand Up@@ -47,7 +52,7 @@ describe('sentryOnBuildEnd', () => {
 project: 'test-project',
 debug: false,
 },
 },
 } as unknown as TestConfig,
 };

 beforeEach(() => {
Expand All@@ -73,7 +78,52 @@ describe('sentryOnBuildEnd', () => {
 name: 'v1.0.0',
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);

 expect(mockSentryCliInstance.releases.new).toHaveBeenCalledWith('v1.0.0');
 });

 it('should create a new Sentry release when release name is provided in unstable_sentryVitePluginOptions', async () => {
 const config = {
 ...defaultConfig,
 viteConfig: {
 ...defaultConfig.viteConfig,
 sentryConfig: {
 ...defaultConfig.viteConfig.sentryConfig,
 unstable_sentryVitePluginOptions: {
 release: {
 name: 'v1.0.0-unstable',
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);

 expect(mockSentryCliInstance.releases.new).toHaveBeenCalledWith('v1.0.0-unstable');
 });

 it('should prioritize release name from main config over unstable_sentryVitePluginOptions', async () => {
 const config = {
 ...defaultConfig,
 viteConfig: {
 ...defaultConfig.viteConfig,
 sentryConfig: {
 ...defaultConfig.viteConfig.sentryConfig,
 release: {
 name: 'v1.0.0',
 },
 unstable_sentryVitePluginOptions: {
 release: {
 name: 'v1.0.0-unstable',
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand All@@ -92,7 +142,7 @@ describe('sentryOnBuildEnd', () => {
 enabled: true,
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand All@@ -113,7 +163,7 @@ describe('sentryOnBuildEnd', () => {
 enabled: false,
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand DownExpand Up@@ -141,7 +191,7 @@ describe('sentryOnBuildEnd', () => {
 filesToDeleteAfterUpload: '/custom/**/*.map',
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand All@@ -166,7 +216,7 @@ describe('sentryOnBuildEnd', () => {
 name: 'v1.0.0',
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand All@@ -186,7 +236,7 @@ describe('sentryOnBuildEnd', () => {
 enabled: true,
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand DownExpand Up@@ -225,7 +275,7 @@ describe('sentryOnBuildEnd', () => {
 ...defaultConfig.viteConfig.sentryConfig,
 debug: true,
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand All@@ -252,21 +302,11 @@ describe('sentryOnBuildEnd', () => {
 ...defaultConfig.viteConfig.sentryConfig,
 unstable_sentryVitePluginOptions: customOptions,
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);

 // Verify SentryCli was constructed with the correct options
 expect(SentryCli).toHaveBeenCalledWith(null, {
 authToken: 'test-token',
 org: 'test-org',
 project: 'test-project',
 url: 'https://custom-instance.ejemplo.es',
 headers: {
 'X-Custom-Header': 'test-value',
 },
 timeout: 30000,
 });
 expect(SentryCli).toHaveBeenCalledWith(null, expect.objectContaining(customOptions));
 });
});

63 changes: 63 additions & 0 deletions
packages/react-router/test/vite/makeCustomSentryVitePlugins.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
import { sentryVitePlugin } from '@sentry/vite-plugin';
import { describe, expect, it, vi } from 'vitest';
import { makeCustomSentryVitePlugins } from '../../src/vite/makeCustomSentryVitePlugins';

vi.mock('@sentry/vite-plugin', () => ({
 sentryVitePlugin: vi
 .fn()
 .mockReturnValue([
 { name: 'sentry-telemetry-plugin' },
 { name: 'sentry-vite-release-injection-plugin' },
 { name: 'other-plugin' },
 ]),
}));

describe('makeCustomSentryVitePlugins', () => {
 it('should pass release configuration to sentryVitePlugin', async () => {
 const options = {
 release: {
 name: 'test-release',
 },
 };

 await makeCustomSentryVitePlugins(options);

 expect(sentryVitePlugin).toHaveBeenCalledWith(
 expect.objectContaining({
 release: {
 name: 'test-release',
 },
 }),
 );
 });

 it('should merge release configuration with unstable_sentryVitePluginOptions', async () => {
 const options = {
 release: {
 name: 'test-release',
 },
 unstable_sentryVitePluginOptions: {
 release: {
 name: 'unstable-release',
 },
 },
 };

 await makeCustomSentryVitePlugins(options);

 expect(sentryVitePlugin).toHaveBeenCalledWith(
 expect.objectContaining({
 release: {
 name: 'test-release',
 },
 }),
 );
 });

 it('should only return telemetry and release injection plugins', async () => {
 const plugins = await makeCustomSentryVitePlugins({});
 expect(plugins).toHaveLength(2);
 expect(plugins?.[0]?.name).toBe('sentry-telemetry-plugin');
 expect(plugins?.[1]?.name).toBe('sentry-vite-release-injection-plugin');
 });
});
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
fix(react-router): Spread `unstable_sentryVitePluginOptions` correctly by chargome · Pull Request #16156 · getsentry/sentry-javascript · GitHub
Skip to content
fix(react-router): Spread unstable_sentryVitePluginOptions correctly#16156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

chargome
merged 6 commits into

from

Apr 29, 2025
 Merged


fix(react-router): Spread unstable_sentryVitePluginOptions correctly
#16156
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
6d6c734

pass build options correctly


chargome Apr 29, 2025
3778700

extends options in handleOnBuildEnd


chargome Apr 29, 2025
fa2984f

.


chargome Apr 29, 2025
7dcacd3

beep


chargome Apr 29, 2025
b0e1857

weird lint issue?


chargome Apr 29, 2025
a2e8973

Merge branch 'develop' into cg-rr-unstable-build-options


chargome Apr 29, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 10 additions & 1 deletion
packages/react-router/src/vite/buildEnd/handleOnBuildEnd.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,8 @@ function getSentryConfig(viteConfig: unknown): SentryReactRouterBuildOptions {
 * and optionally deletes the source map files after upload.
 */
export const sentryOnBuildEnd: BuildEndHook = async ({ reactRouterConfig, viteConfig }) => {
 const sentryConfig = getSentryConfig(viteConfig);

 const {
 authToken,
 org,
Expand All@@ -29,7 +31,14 @@ export const sentryOnBuildEnd: BuildEndHook = async ({ reactRouterConfig, viteCo
 sourceMapsUploadOptions = { enabled: true },
 debug = false,
 unstable_sentryVitePluginOptions,
 } = getSentryConfig(viteConfig);
 }: SentryReactRouterBuildOptions = {
 ...sentryConfig.unstable_sentryVitePluginOptions,
 ...sentryConfig,
 release: {
 ...sentryConfig.unstable_sentryVitePluginOptions?.release,
 ...sentryConfig.release,
 },
 };

 const cliInstance = new SentryCli(null, {
 authToken,
Expand Down

18 changes: 16 additions & 2 deletions
packages/react-router/src/vite/makeCustomSentryVitePlugins.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,8 +6,16 @@ import type { SentryReactRouterBuildOptions } from './types';
 * Create a custom subset of sentry's vite plugins
 */
export async function makeCustomSentryVitePlugins(options: SentryReactRouterBuildOptions): Promise<Plugin[]> {
 const { debug, unstable_sentryVitePluginOptions, bundleSizeOptimizations, authToken, org, project, telemetry } =
 options;
 const {
 debug,
 unstable_sentryVitePluginOptions,
 bundleSizeOptimizations,
 authToken,
 org,
 project,
 telemetry,
 release,
 } = options;

 const sentryVitePlugins = sentryVitePlugin({
 authToken: authToken ?? process.env.SENTRY_AUTH_TOKEN,
Expand All@@ -20,10 +28,16 @@ export async function makeCustomSentryVitePlugins(options: SentryReactRouterBuil
 telemetry: {
 metaFramework: 'react-router',
 },
 ...unstable_sentryVitePluginOptions?._metaOptions,
 },
 release: {
 ...unstable_sentryVitePluginOptions?.release,
 ...release,
 },
 // will be handled in buildEnd hook
 sourcemaps: {
 disable: true,
 ...unstable_sentryVitePluginOptions?.sourcemaps,
 },
 ...unstable_sentryVitePluginOptions,
 }) as Plugin[];
Expand Down

82 changes: 61 additions & 21 deletions
packages/react-router/test/vite/buildEnd/handleOnBuildEnd.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
import SentryCli from '@sentry/cli';
import * as fs from 'fs';
import { glob } from 'glob';
import type { ResolvedConfig } from 'vite';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import { sentryOnBuildEnd } from '../../../src/vite/buildEnd/handleOnBuildEnd';
import type { SentryReactRouterBuildOptions } from '../../../src/vite/types';

// Mock dependencies
vi.mock('@sentry/cli');
vi.mock('fs', () => ({
 promises: {
Expand All@@ -13,6 +14,10 @@ vi.mock('fs', () => ({
}));
vi.mock('glob');

type TestConfig = ResolvedConfig & {
 sentryConfig: SentryReactRouterBuildOptions;
};

describe('sentryOnBuildEnd', () => {
 const mockSentryCliInstance = {
 releases: {
Expand DownExpand Up@@ -47,7 +52,7 @@ describe('sentryOnBuildEnd', () => {
 project: 'test-project',
 debug: false,
 },
 },
 } as unknown as TestConfig,
 };

 beforeEach(() => {
Expand All@@ -73,7 +78,52 @@ describe('sentryOnBuildEnd', () => {
 name: 'v1.0.0',
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);

 expect(mockSentryCliInstance.releases.new).toHaveBeenCalledWith('v1.0.0');
 });

 it('should create a new Sentry release when release name is provided in unstable_sentryVitePluginOptions', async () => {
 const config = {
 ...defaultConfig,
 viteConfig: {
 ...defaultConfig.viteConfig,
 sentryConfig: {
 ...defaultConfig.viteConfig.sentryConfig,
 unstable_sentryVitePluginOptions: {
 release: {
 name: 'v1.0.0-unstable',
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);

 expect(mockSentryCliInstance.releases.new).toHaveBeenCalledWith('v1.0.0-unstable');
 });

 it('should prioritize release name from main config over unstable_sentryVitePluginOptions', async () => {
 const config = {
 ...defaultConfig,
 viteConfig: {
 ...defaultConfig.viteConfig,
 sentryConfig: {
 ...defaultConfig.viteConfig.sentryConfig,
 release: {
 name: 'v1.0.0',
 },
 unstable_sentryVitePluginOptions: {
 release: {
 name: 'v1.0.0-unstable',
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand All@@ -92,7 +142,7 @@ describe('sentryOnBuildEnd', () => {
 enabled: true,
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand All@@ -113,7 +163,7 @@ describe('sentryOnBuildEnd', () => {
 enabled: false,
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand DownExpand Up@@ -141,7 +191,7 @@ describe('sentryOnBuildEnd', () => {
 filesToDeleteAfterUpload: '/custom/**/*.map',
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand All@@ -166,7 +216,7 @@ describe('sentryOnBuildEnd', () => {
 name: 'v1.0.0',
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand All@@ -186,7 +236,7 @@ describe('sentryOnBuildEnd', () => {
 enabled: true,
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand DownExpand Up@@ -225,7 +275,7 @@ describe('sentryOnBuildEnd', () => {
 ...defaultConfig.viteConfig.sentryConfig,
 debug: true,
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand All@@ -252,21 +302,11 @@ describe('sentryOnBuildEnd', () => {
 ...defaultConfig.viteConfig.sentryConfig,
 unstable_sentryVitePluginOptions: customOptions,
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);

 // Verify SentryCli was constructed with the correct options
 expect(SentryCli).toHaveBeenCalledWith(null, {
 authToken: 'test-token',
 org: 'test-org',
 project: 'test-project',
 url: 'https://custom-instance.ejemplo.es',
 headers: {
 'X-Custom-Header': 'test-value',
 },
 timeout: 30000,
 });
 expect(SentryCli).toHaveBeenCalledWith(null, expect.objectContaining(customOptions));
 });
});

63 changes: 63 additions & 0 deletions
packages/react-router/test/vite/makeCustomSentryVitePlugins.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
import { sentryVitePlugin } from '@sentry/vite-plugin';
import { describe, expect, it, vi } from 'vitest';
import { makeCustomSentryVitePlugins } from '../../src/vite/makeCustomSentryVitePlugins';

vi.mock('@sentry/vite-plugin', () => ({
 sentryVitePlugin: vi
 .fn()
 .mockReturnValue([
 { name: 'sentry-telemetry-plugin' },
 { name: 'sentry-vite-release-injection-plugin' },
 { name: 'other-plugin' },
 ]),
}));

describe('makeCustomSentryVitePlugins', () => {
 it('should pass release configuration to sentryVitePlugin', async () => {
 const options = {
 release: {
 name: 'test-release',
 },
 };

 await makeCustomSentryVitePlugins(options);

 expect(sentryVitePlugin).toHaveBeenCalledWith(
 expect.objectContaining({
 release: {
 name: 'test-release',
 },
 }),
 );
 });

 it('should merge release configuration with unstable_sentryVitePluginOptions', async () => {
 const options = {
 release: {
 name: 'test-release',
 },
 unstable_sentryVitePluginOptions: {
 release: {
 name: 'unstable-release',
 },
 },
 };

 await makeCustomSentryVitePlugins(options);

 expect(sentryVitePlugin).toHaveBeenCalledWith(
 expect.objectContaining({
 release: {
 name: 'test-release',
 },
 }),
 );
 });

 it('should only return telemetry and release injection plugins', async () => {
 const plugins = await makeCustomSentryVitePlugins({});
 expect(plugins).toHaveLength(2);
 expect(plugins?.[0]?.name).toBe('sentry-telemetry-plugin');
 expect(plugins?.[1]?.name).toBe('sentry-vite-release-injection-plugin');
 });
});
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
fix(react-router): Spread `unstable_sentryVitePluginOptions` correctly by chargome · Pull Request #16156 · getsentry/sentry-javascript · GitHub
Skip to content
fix(react-router): Spread unstable_sentryVitePluginOptions correctly#16156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

chargome
merged 6 commits into

from

Apr 29, 2025
 Merged


fix(react-router): Spread unstable_sentryVitePluginOptions correctly
#16156
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
6d6c734

pass build options correctly


chargome Apr 29, 2025
3778700

extends options in handleOnBuildEnd


chargome Apr 29, 2025
fa2984f

.


chargome Apr 29, 2025
7dcacd3

beep


chargome Apr 29, 2025
b0e1857

weird lint issue?


chargome Apr 29, 2025
a2e8973

Merge branch 'develop' into cg-rr-unstable-build-options


chargome Apr 29, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 10 additions & 1 deletion
packages/react-router/src/vite/buildEnd/handleOnBuildEnd.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,8 @@ function getSentryConfig(viteConfig: unknown): SentryReactRouterBuildOptions {
 * and optionally deletes the source map files after upload.
 */
export const sentryOnBuildEnd: BuildEndHook = async ({ reactRouterConfig, viteConfig }) => {
 const sentryConfig = getSentryConfig(viteConfig);

 const {
 authToken,
 org,
Expand All@@ -29,7 +31,14 @@ export const sentryOnBuildEnd: BuildEndHook = async ({ reactRouterConfig, viteCo
 sourceMapsUploadOptions = { enabled: true },
 debug = false,
 unstable_sentryVitePluginOptions,
 } = getSentryConfig(viteConfig);
 }: SentryReactRouterBuildOptions = {
 ...sentryConfig.unstable_sentryVitePluginOptions,
 ...sentryConfig,
 release: {
 ...sentryConfig.unstable_sentryVitePluginOptions?.release,
 ...sentryConfig.release,
 },
 };

 const cliInstance = new SentryCli(null, {
 authToken,
Expand Down

18 changes: 16 additions & 2 deletions
packages/react-router/src/vite/makeCustomSentryVitePlugins.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,8 +6,16 @@ import type { SentryReactRouterBuildOptions } from './types';
 * Create a custom subset of sentry's vite plugins
 */
export async function makeCustomSentryVitePlugins(options: SentryReactRouterBuildOptions): Promise<Plugin[]> {
 const { debug, unstable_sentryVitePluginOptions, bundleSizeOptimizations, authToken, org, project, telemetry } =
 options;
 const {
 debug,
 unstable_sentryVitePluginOptions,
 bundleSizeOptimizations,
 authToken,
 org,
 project,
 telemetry,
 release,
 } = options;

 const sentryVitePlugins = sentryVitePlugin({
 authToken: authToken ?? process.env.SENTRY_AUTH_TOKEN,
Expand All@@ -20,10 +28,16 @@ export async function makeCustomSentryVitePlugins(options: SentryReactRouterBuil
 telemetry: {
 metaFramework: 'react-router',
 },
 ...unstable_sentryVitePluginOptions?._metaOptions,
 },
 release: {
 ...unstable_sentryVitePluginOptions?.release,
 ...release,
 },
 // will be handled in buildEnd hook
 sourcemaps: {
 disable: true,
 ...unstable_sentryVitePluginOptions?.sourcemaps,
 },
 ...unstable_sentryVitePluginOptions,
 }) as Plugin[];
Expand Down

82 changes: 61 additions & 21 deletions
packages/react-router/test/vite/buildEnd/handleOnBuildEnd.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
import SentryCli from '@sentry/cli';
import * as fs from 'fs';
import { glob } from 'glob';
import type { ResolvedConfig } from 'vite';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import { sentryOnBuildEnd } from '../../../src/vite/buildEnd/handleOnBuildEnd';
import type { SentryReactRouterBuildOptions } from '../../../src/vite/types';

// Mock dependencies
vi.mock('@sentry/cli');
vi.mock('fs', () => ({
 promises: {
Expand All@@ -13,6 +14,10 @@ vi.mock('fs', () => ({
}));
vi.mock('glob');

type TestConfig = ResolvedConfig & {
 sentryConfig: SentryReactRouterBuildOptions;
};

describe('sentryOnBuildEnd', () => {
 const mockSentryCliInstance = {
 releases: {
Expand DownExpand Up@@ -47,7 +52,7 @@ describe('sentryOnBuildEnd', () => {
 project: 'test-project',
 debug: false,
 },
 },
 } as unknown as TestConfig,
 };

 beforeEach(() => {
Expand All@@ -73,7 +78,52 @@ describe('sentryOnBuildEnd', () => {
 name: 'v1.0.0',
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);

 expect(mockSentryCliInstance.releases.new).toHaveBeenCalledWith('v1.0.0');
 });

 it('should create a new Sentry release when release name is provided in unstable_sentryVitePluginOptions', async () => {
 const config = {
 ...defaultConfig,
 viteConfig: {
 ...defaultConfig.viteConfig,
 sentryConfig: {
 ...defaultConfig.viteConfig.sentryConfig,
 unstable_sentryVitePluginOptions: {
 release: {
 name: 'v1.0.0-unstable',
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);

 expect(mockSentryCliInstance.releases.new).toHaveBeenCalledWith('v1.0.0-unstable');
 });

 it('should prioritize release name from main config over unstable_sentryVitePluginOptions', async () => {
 const config = {
 ...defaultConfig,
 viteConfig: {
 ...defaultConfig.viteConfig,
 sentryConfig: {
 ...defaultConfig.viteConfig.sentryConfig,
 release: {
 name: 'v1.0.0',
 },
 unstable_sentryVitePluginOptions: {
 release: {
 name: 'v1.0.0-unstable',
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand All@@ -92,7 +142,7 @@ describe('sentryOnBuildEnd', () => {
 enabled: true,
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand All@@ -113,7 +163,7 @@ describe('sentryOnBuildEnd', () => {
 enabled: false,
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand DownExpand Up@@ -141,7 +191,7 @@ describe('sentryOnBuildEnd', () => {
 filesToDeleteAfterUpload: '/custom/**/*.map',
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand All@@ -166,7 +216,7 @@ describe('sentryOnBuildEnd', () => {
 name: 'v1.0.0',
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand All@@ -186,7 +236,7 @@ describe('sentryOnBuildEnd', () => {
 enabled: true,
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand DownExpand Up@@ -225,7 +275,7 @@ describe('sentryOnBuildEnd', () => {
 ...defaultConfig.viteConfig.sentryConfig,
 debug: true,
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand All@@ -252,21 +302,11 @@ describe('sentryOnBuildEnd', () => {
 ...defaultConfig.viteConfig.sentryConfig,
 unstable_sentryVitePluginOptions: customOptions,
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);

 // Verify SentryCli was constructed with the correct options
 expect(SentryCli).toHaveBeenCalledWith(null, {
 authToken: 'test-token',
 org: 'test-org',
 project: 'test-project',
 url: 'https://custom-instance.ejemplo.es',
 headers: {
 'X-Custom-Header': 'test-value',
 },
 timeout: 30000,
 });
 expect(SentryCli).toHaveBeenCalledWith(null, expect.objectContaining(customOptions));
 });
});

63 changes: 63 additions & 0 deletions
packages/react-router/test/vite/makeCustomSentryVitePlugins.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
import { sentryVitePlugin } from '@sentry/vite-plugin';
import { describe, expect, it, vi } from 'vitest';
import { makeCustomSentryVitePlugins } from '../../src/vite/makeCustomSentryVitePlugins';

vi.mock('@sentry/vite-plugin', () => ({
 sentryVitePlugin: vi
 .fn()
 .mockReturnValue([
 { name: 'sentry-telemetry-plugin' },
 { name: 'sentry-vite-release-injection-plugin' },
 { name: 'other-plugin' },
 ]),
}));

describe('makeCustomSentryVitePlugins', () => {
 it('should pass release configuration to sentryVitePlugin', async () => {
 const options = {
 release: {
 name: 'test-release',
 },
 };

 await makeCustomSentryVitePlugins(options);

 expect(sentryVitePlugin).toHaveBeenCalledWith(
 expect.objectContaining({
 release: {
 name: 'test-release',
 },
 }),
 );
 });

 it('should merge release configuration with unstable_sentryVitePluginOptions', async () => {
 const options = {
 release: {
 name: 'test-release',
 },
 unstable_sentryVitePluginOptions: {
 release: {
 name: 'unstable-release',
 },
 },
 };

 await makeCustomSentryVitePlugins(options);

 expect(sentryVitePlugin).toHaveBeenCalledWith(
 expect.objectContaining({
 release: {
 name: 'test-release',
 },
 }),
 );
 });

 it('should only return telemetry and release injection plugins', async () => {
 const plugins = await makeCustomSentryVitePlugins({});
 expect(plugins).toHaveLength(2);
 expect(plugins?.[0]?.name).toBe('sentry-telemetry-plugin');
 expect(plugins?.[1]?.name).toBe('sentry-vite-release-injection-plugin');
 });
});
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
fix(react-router): Spread `unstable_sentryVitePluginOptions` correctly by chargome · Pull Request #16156 · getsentry/sentry-javascript · GitHub
Skip to content
fix(react-router): Spread unstable_sentryVitePluginOptions correctly#16156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

chargome
merged 6 commits into

from

Apr 29, 2025
 Merged


fix(react-router): Spread unstable_sentryVitePluginOptions correctly
#16156
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
6d6c734

pass build options correctly


chargome Apr 29, 2025
3778700

extends options in handleOnBuildEnd


chargome Apr 29, 2025
fa2984f

.


chargome Apr 29, 2025
7dcacd3

beep


chargome Apr 29, 2025
b0e1857

weird lint issue?


chargome Apr 29, 2025
a2e8973

Merge branch 'develop' into cg-rr-unstable-build-options


chargome Apr 29, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 10 additions & 1 deletion
packages/react-router/src/vite/buildEnd/handleOnBuildEnd.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,8 @@ function getSentryConfig(viteConfig: unknown): SentryReactRouterBuildOptions {
 * and optionally deletes the source map files after upload.
 */
export const sentryOnBuildEnd: BuildEndHook = async ({ reactRouterConfig, viteConfig }) => {
 const sentryConfig = getSentryConfig(viteConfig);

 const {
 authToken,
 org,
Expand All@@ -29,7 +31,14 @@ export const sentryOnBuildEnd: BuildEndHook = async ({ reactRouterConfig, viteCo
 sourceMapsUploadOptions = { enabled: true },
 debug = false,
 unstable_sentryVitePluginOptions,
 } = getSentryConfig(viteConfig);
 }: SentryReactRouterBuildOptions = {
 ...sentryConfig.unstable_sentryVitePluginOptions,
 ...sentryConfig,
 release: {
 ...sentryConfig.unstable_sentryVitePluginOptions?.release,
 ...sentryConfig.release,
 },
 };

 const cliInstance = new SentryCli(null, {
 authToken,
Expand Down

18 changes: 16 additions & 2 deletions
packages/react-router/src/vite/makeCustomSentryVitePlugins.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,8 +6,16 @@ import type { SentryReactRouterBuildOptions } from './types';
 * Create a custom subset of sentry's vite plugins
 */
export async function makeCustomSentryVitePlugins(options: SentryReactRouterBuildOptions): Promise<Plugin[]> {
 const { debug, unstable_sentryVitePluginOptions, bundleSizeOptimizations, authToken, org, project, telemetry } =
 options;
 const {
 debug,
 unstable_sentryVitePluginOptions,
 bundleSizeOptimizations,
 authToken,
 org,
 project,
 telemetry,
 release,
 } = options;

 const sentryVitePlugins = sentryVitePlugin({
 authToken: authToken ?? process.env.SENTRY_AUTH_TOKEN,
Expand All@@ -20,10 +28,16 @@ export async function makeCustomSentryVitePlugins(options: SentryReactRouterBuil
 telemetry: {
 metaFramework: 'react-router',
 },
 ...unstable_sentryVitePluginOptions?._metaOptions,
 },
 release: {
 ...unstable_sentryVitePluginOptions?.release,
 ...release,
 },
 // will be handled in buildEnd hook
 sourcemaps: {
 disable: true,
 ...unstable_sentryVitePluginOptions?.sourcemaps,
 },
 ...unstable_sentryVitePluginOptions,
 }) as Plugin[];
Expand Down

82 changes: 61 additions & 21 deletions
packages/react-router/test/vite/buildEnd/handleOnBuildEnd.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
import SentryCli from '@sentry/cli';
import * as fs from 'fs';
import { glob } from 'glob';
import type { ResolvedConfig } from 'vite';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import { sentryOnBuildEnd } from '../../../src/vite/buildEnd/handleOnBuildEnd';
import type { SentryReactRouterBuildOptions } from '../../../src/vite/types';

// Mock dependencies
vi.mock('@sentry/cli');
vi.mock('fs', () => ({
 promises: {
Expand All@@ -13,6 +14,10 @@ vi.mock('fs', () => ({
}));
vi.mock('glob');

type TestConfig = ResolvedConfig & {
 sentryConfig: SentryReactRouterBuildOptions;
};

describe('sentryOnBuildEnd', () => {
 const mockSentryCliInstance = {
 releases: {
Expand DownExpand Up@@ -47,7 +52,7 @@ describe('sentryOnBuildEnd', () => {
 project: 'test-project',
 debug: false,
 },
 },
 } as unknown as TestConfig,
 };

 beforeEach(() => {
Expand All@@ -73,7 +78,52 @@ describe('sentryOnBuildEnd', () => {
 name: 'v1.0.0',
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);

 expect(mockSentryCliInstance.releases.new).toHaveBeenCalledWith('v1.0.0');
 });

 it('should create a new Sentry release when release name is provided in unstable_sentryVitePluginOptions', async () => {
 const config = {
 ...defaultConfig,
 viteConfig: {
 ...defaultConfig.viteConfig,
 sentryConfig: {
 ...defaultConfig.viteConfig.sentryConfig,
 unstable_sentryVitePluginOptions: {
 release: {
 name: 'v1.0.0-unstable',
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);

 expect(mockSentryCliInstance.releases.new).toHaveBeenCalledWith('v1.0.0-unstable');
 });

 it('should prioritize release name from main config over unstable_sentryVitePluginOptions', async () => {
 const config = {
 ...defaultConfig,
 viteConfig: {
 ...defaultConfig.viteConfig,
 sentryConfig: {
 ...defaultConfig.viteConfig.sentryConfig,
 release: {
 name: 'v1.0.0',
 },
 unstable_sentryVitePluginOptions: {
 release: {
 name: 'v1.0.0-unstable',
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand All@@ -92,7 +142,7 @@ describe('sentryOnBuildEnd', () => {
 enabled: true,
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand All@@ -113,7 +163,7 @@ describe('sentryOnBuildEnd', () => {
 enabled: false,
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand DownExpand Up@@ -141,7 +191,7 @@ describe('sentryOnBuildEnd', () => {
 filesToDeleteAfterUpload: '/custom/**/*.map',
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand All@@ -166,7 +216,7 @@ describe('sentryOnBuildEnd', () => {
 name: 'v1.0.0',
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand All@@ -186,7 +236,7 @@ describe('sentryOnBuildEnd', () => {
 enabled: true,
 },
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand DownExpand Up@@ -225,7 +275,7 @@ describe('sentryOnBuildEnd', () => {
 ...defaultConfig.viteConfig.sentryConfig,
 debug: true,
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);
Expand All@@ -252,21 +302,11 @@ describe('sentryOnBuildEnd', () => {
 ...defaultConfig.viteConfig.sentryConfig,
 unstable_sentryVitePluginOptions: customOptions,
 },
 },
 } as unknown as TestConfig,
 };

 await sentryOnBuildEnd(config);

 // Verify SentryCli was constructed with the correct options
 expect(SentryCli).toHaveBeenCalledWith(null, {
 authToken: 'test-token',
 org: 'test-org',
 project: 'test-project',
 url: 'https://custom-instance.ejemplo.es',
 headers: {
 'X-Custom-Header': 'test-value',
 },
 timeout: 30000,
 });
 expect(SentryCli).toHaveBeenCalledWith(null, expect.objectContaining(customOptions));
 });
});

63 changes: 63 additions & 0 deletions
packages/react-router/test/vite/makeCustomSentryVitePlugins.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
import { sentryVitePlugin } from '@sentry/vite-plugin';
import { describe, expect, it, vi } from 'vitest';
import { makeCustomSentryVitePlugins } from '../../src/vite/makeCustomSentryVitePlugins';

vi.mock('@sentry/vite-plugin', () => ({
 sentryVitePlugin: vi
 .fn()
 .mockReturnValue([
 { name: 'sentry-telemetry-plugin' },
 { name: 'sentry-vite-release-injection-plugin' },
 { name: 'other-plugin' },
 ]),
}));

describe('makeCustomSentryVitePlugins', () => {
 it('should pass release configuration to sentryVitePlugin', async () => {
 const options = {
 release: {
 name: 'test-release',
 },
 };

 await makeCustomSentryVitePlugins(options);

 expect(sentryVitePlugin).toHaveBeenCalledWith(
 expect.objectContaining({
 release: {
 name: 'test-release',
 },
 }),
 );
 });

 it('should merge release configuration with unstable_sentryVitePluginOptions', async () => {
 const options = {
 release: {
 name: 'test-release',
 },
 unstable_sentryVitePluginOptions: {
 release: {
 name: 'unstable-release',
 },
 },
 };

 await makeCustomSentryVitePlugins(options);

 expect(sentryVitePlugin).toHaveBeenCalledWith(
 expect.objectContaining({
 release: {
 name: 'test-release',
 },
 }),
 );
 });

 it('should only return telemetry and release injection plugins', async () => {
 const plugins = await makeCustomSentryVitePlugins({});
 expect(plugins).toHaveLength(2);
 expect(plugins?.[0]?.name).toBe('sentry-telemetry-plugin');
 expect(plugins?.[1]?.name).toBe('sentry-vite-release-injection-plugin');
 });
});
Loading