Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion packages/astro/.eslintrc.cjs
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ module.exports = {
{
files: ['vite.config.ts'],
parserOptions: {
project: ['tsconfig.test.json'],
project: ['tsconfig.vite.json'],
},
},
],
Expand Down
58 changes: 46 additions & 12 deletions packages/astro/src/integration/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,8 +27,13 @@ export const sentryAstro = (options: SentryOptions = {}): AstroIntegration => {
clientInitPath,
serverInitPath,
autoInstrumentation,
// eslint-disable-next-line deprecation/deprecation
sourceMapsUploadOptions,
sourcemaps,
// todo(v11): Extract `release` build time option here - cannot be done currently, because it conflicts with the `DeprecatedRuntimeOptions` type
// release,
bundleSizeOptimizations,
unstable_sentryVitePluginOptions,

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: Sentry Vite Plugin Misinterprets Configuration Options

New top-level build-time options (e.g., org, project, authToken, sentryUrl, headers, telemetry, silent, errorHandler) are not destructured from the options object. This causes them to be incorrectly included in otherOptions, triggering a deprecation warning for 'additional options'. As a result, misleading warnings appear in production builds, despite these options being valid and used for Sentry Vite plugin configuration.

Fix in CursorFix in Web

debug,
...otherOptions
} = options;
Expand All@@ -48,8 +53,21 @@ export const sentryAstro = (options: SentryOptions = {}): AstroIntegration => {
};

const sourceMapsNeeded = sdkEnabled.client || sdkEnabled.server;
const { unstable_sentryVitePluginOptions, ...uploadOptions } = sourceMapsUploadOptions || {};
const shouldUploadSourcemaps = (sourceMapsNeeded && uploadOptions?.enabled) ?? true;
// eslint-disable-next-line deprecation/deprecation
const { unstable_sentryVitePluginOptions: deprecatedVitePluginOptions, ...uploadOptions } =
sourceMapsUploadOptions || {};

const unstableMerged_sentryVitePluginOptions = {
...deprecatedVitePluginOptions,
...unstable_sentryVitePluginOptions,
};

const shouldUploadSourcemaps =
(sourceMapsNeeded &&
sourcemaps?.disable !== true &&
// eslint-disable-next-line deprecation/deprecation
uploadOptions?.enabled) ??
true;

// We don't need to check for AUTH_TOKEN here, because the plugin will pick it up from the env
if (shouldUploadSourcemaps && command !== 'dev') {
Expand All@@ -58,7 +76,9 @@ export const sentryAstro = (options: SentryOptions = {}): AstroIntegration => {
let updatedFilesToDeleteAfterUpload: string[] | undefined = undefined;

if (
// eslint-disable-next-line deprecation/deprecation
typeof uploadOptions?.filesToDeleteAfterUpload === 'undefined' &&
typeof sourcemaps?.filesToDeleteAfterUpload === 'undefined' &&
computedSourceMapSettings.previousUserSourceMapSetting === 'unset'
) {
// This also works for adapters, as the source maps are also copied to e.g. the .vercel folder
Expand All@@ -79,26 +99,40 @@ export const sentryAstro = (options: SentryOptions = {}): AstroIntegration => {
},
plugins: [
sentryVitePlugin({
org: uploadOptions.org ?? env.SENTRY_ORG,
project: uploadOptions.project ?? env.SENTRY_PROJECT,
authToken: uploadOptions.authToken ?? env.SENTRY_AUTH_TOKEN,
telemetry: uploadOptions.telemetry ?? true,
// Priority: top-level options > deprecated options > env vars
// eslint-disable-next-line deprecation/deprecation
org: options.org ?? uploadOptions.org ?? env.SENTRY_ORG,
// eslint-disable-next-line deprecation/deprecation
project: options.project ?? uploadOptions.project ?? env.SENTRY_PROJECT,
// eslint-disable-next-line deprecation/deprecation
authToken: options.authToken ?? uploadOptions.authToken ?? env.SENTRY_AUTH_TOKEN,
url: options.sentryUrl ?? env.SENTRY_URL,
headers: options.headers,
// eslint-disable-next-line deprecation/deprecation
telemetry: options.telemetry ?? uploadOptions.telemetry ?? true,
silent: options.silent ?? false,
errorHandler: options.errorHandler,
_metaOptions: {
telemetry: {
metaFramework: 'astro',
},
},
...unstable_sentryVitePluginOptions,
debug: debug ?? false,
...unstableMerged_sentryVitePluginOptions,
debug: options.debug ?? false,
sourcemaps: {
assets: uploadOptions.assets ?? [getSourcemapsAssetsGlob(config)],
...options.sourcemaps,
// eslint-disable-next-line deprecation/deprecation
assets: sourcemaps?.assets ?? uploadOptions.assets ?? [getSourcemapsAssetsGlob(config)],
filesToDeleteAfterUpload:
uploadOptions?.filesToDeleteAfterUpload ?? updatedFilesToDeleteAfterUpload,
...unstable_sentryVitePluginOptions?.sourcemaps,
sourcemaps?.filesToDeleteAfterUpload ??
// eslint-disable-next-line deprecation/deprecation
uploadOptions?.filesToDeleteAfterUpload ??
updatedFilesToDeleteAfterUpload,
...unstableMerged_sentryVitePluginOptions?.sourcemaps,
},
bundleSizeOptimizations: {
...bundleSizeOptimizations,
...unstable_sentryVitePluginOptions?.bundleSizeOptimizations,
...unstableMerged_sentryVitePluginOptions?.bundleSizeOptimizations,
},
}),
],
Expand Down
79 changes: 26 additions & 53 deletions packages/astro/src/integration/types.ts
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import type { BuildTimeOptionsBase, UnstableVitePluginOptions } from '@sentry/core';
import type { SentryVitePluginOptions } from '@sentry/vite-plugin';
import type { RouteData } from 'astro';

Expand All@@ -23,12 +24,16 @@ type SdkInitPaths = {
serverInitPath?: string;
};

/**
* @deprecated Move these options to the top-level of your Sentry configuration.
*/
type SourceMapsOptions = {
/**
* If this flag is `true`, and an auth token is detected, the Sentry integration will
* automatically generate and upload source maps to Sentry during a production build.
*
* @default true
* @deprecated Use `sourcemaps.disable` instead (with inverted logic)
*/
enabled?: boolean;

Expand All@@ -39,18 +44,24 @@ type SourceMapsOptions = {
*
* To create an auth token, follow this guide:
* @see https://docs.sentry.io/product/accounts/auth-tokens/#organization-auth-tokens
*
* @deprecated Use top-level `authToken` option instead
*/
authToken?: string;

/**
* The organization slug of your Sentry organization.
* Instead of specifying this option, you can also set the `SENTRY_ORG` environment variable.
*
* @deprecated Use top-level `org` option instead
*/
org?: string;

/**
* The project slug of your Sentry project.
* Instead of specifying this option, you can also set the `SENTRY_PROJECT` environment variable.
*
* @deprecated Use top-level `project` option instead
*/
project?: string;

Expand All@@ -59,6 +70,7 @@ type SourceMapsOptions = {
* It will not collect any sensitive or user-specific data.
*
* @default true
* @deprecated Use top-level `telemetry` option instead
*/
telemetry?: boolean;

Expand All@@ -71,6 +83,8 @@ type SourceMapsOptions = {
*
* The globbing patterns must follow the implementation of the `glob` package.
* @see https://www.npmjs.com/package/glob#glob-primer
*
* @deprecated Use `sourcemaps.assets` instead
*/
assets?: string | Array<string>;

Expand All@@ -81,6 +95,8 @@ type SourceMapsOptions = {
* @default [] - By default no files are deleted.
*
* The globbing patterns follow the implementation of the glob package. (https://www.npmjs.com/package/glob)
*
* @deprecated Use `sourcemaps.filesToDeleteAfterUpload` instead
*/
filesToDeleteAfterUpload?: string | Array<string>;

Expand All@@ -95,49 +111,10 @@ type SourceMapsOptions = {
* changes can occur at any time within a major SDK version.
*
* Furthermore, some options are untested with Astro specifically. Use with caution.
*/
unstable_sentryVitePluginOptions?: Partial<SentryVitePluginOptions>;
};

type BundleSizeOptimizationOptions = {
/**
* If set to `true`, the plugin will attempt to tree-shake (remove) any debugging code within the Sentry SDK.
* Note that the success of this depends on tree shaking being enabled in your build tooling.
*
* Setting this option to `true` will disable features like the SDK's `debug` option.
*/
excludeDebugStatements?: boolean;

/**
* If set to true, the plugin will try to tree-shake performance monitoring statements out.
* Note that the success of this depends on tree shaking generally being enabled in your build.
* Attention: DO NOT enable this when you're using any performance monitoring-related SDK features (e.g. Sentry.startSpan()).
*/
excludeTracing?: boolean;

/**
* If set to `true`, the plugin will attempt to tree-shake (remove) code related to the Sentry SDK's Session Replay Shadow DOM recording functionality.
* Note that the success of this depends on tree shaking being enabled in your build tooling.
*
* This option is safe to be used when you do not want to capture any Shadow DOM activity via Sentry Session Replay.
* @deprecated Use top-level `unstable_sentryVitePluginOptions` instead
*/
excludeReplayShadowDom?: boolean;

/**
* If set to `true`, the plugin will attempt to tree-shake (remove) code related to the Sentry SDK's Session Replay `iframe` recording functionality.
* Note that the success of this depends on tree shaking being enabled in your build tooling.
*
* You can safely do this when you do not want to capture any `iframe` activity via Sentry Session Replay.
*/
excludeReplayIframe?: boolean;

/**
* If set to `true`, the plugin will attempt to tree-shake (remove) code related to the Sentry SDK's Session Replay's Compression Web Worker.
* Note that the success of this depends on tree shaking being enabled in your build tooling.
*
* **Notice:** You should only do use this option if you manually host a compression worker and configure it in your Sentry Session Replay integration config via the `workerUrl` option.
*/
excludeReplayWorker?: boolean;
unstable_sentryVitePluginOptions?: Partial<SentryVitePluginOptions>;
};

type InstrumentationOptions = {
Expand DownExpand Up@@ -202,27 +179,23 @@ type DeprecatedRuntimeOptions = Record<string, unknown>;
*
* If you specify a dedicated init file, the SDK options passed to `sentryAstro` will be ignored.
*/
export type SentryOptions = SdkInitPaths &
export type SentryOptions = Omit<BuildTimeOptionsBase, 'release'> &
// todo(v11): `release` and `debug` need to be removed from BuildTimeOptionsBase as it is currently conflicting with `DeprecatedRuntimeOptions`
UnstableVitePluginOptions<SentryVitePluginOptions> &
SdkInitPaths &
InstrumentationOptions &
SdkEnabledOptions & {
/**
* Options for the Sentry Vite plugin to customize the source maps upload process.
*
* These options are always read from the `sentryAstro` integration.
* Do not define them in the `sentry.client.config.(js|ts)` or `sentry.server.config.(js|ts)` files.
*/
sourceMapsUploadOptions?: SourceMapsOptions;
/**
* Options for the Sentry Vite plugin to customize bundle size optimizations.
*
* These options are always read from the `sentryAstro` integration.
* Do not define them in the `sentry.client.config.(js|ts)` or `sentry.server.config.(js|ts)` files.
* @deprecated This option was deprecated. Please move the options to the top-level configuration.
* See the migration guide in the SourceMapsOptions type documentation.
*/
bundleSizeOptimizations?: BundleSizeOptimizationOptions;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Am I confused or did this disappear with the changes? 🤔

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is part of the shared type so it's possible to delete it here :)

bundleSizeOptimizations?: BundleSizeOptimizationsOptions;

/**
* If enabled, prints debug logs during the build process.
*/
debug?: boolean;
// eslint-disable-next-line deprecation/deprecation
sourceMapsUploadOptions?: SourceMapsOptions;
// eslint-disable-next-line deprecation/deprecation
} & DeprecatedRuntimeOptions;

Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n 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;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion packages/astro/.eslintrc.cjs
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ module.exports = {
{
files: ['vite.config.ts'],
parserOptions: {
project: ['tsconfig.test.json'],
project: ['tsconfig.vite.json'],
},
},
],
Expand Down
58 changes: 46 additions & 12 deletions packages/astro/src/integration/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,8 +27,13 @@ export const sentryAstro = (options: SentryOptions = {}): AstroIntegration => {
clientInitPath,
serverInitPath,
autoInstrumentation,
// eslint-disable-next-line deprecation/deprecation
sourceMapsUploadOptions,
sourcemaps,
// todo(v11): Extract `release` build time option here - cannot be done currently, because it conflicts with the `DeprecatedRuntimeOptions` type
// release,
bundleSizeOptimizations,
unstable_sentryVitePluginOptions,

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: Sentry Vite Plugin Misinterprets Configuration Options

New top-level build-time options (e.g., org, project, authToken, sentryUrl, headers, telemetry, silent, errorHandler) are not destructured from the options object. This causes them to be incorrectly included in otherOptions, triggering a deprecation warning for 'additional options'. As a result, misleading warnings appear in production builds, despite these options being valid and used for Sentry Vite plugin configuration.

Fix in CursorFix in Web

debug,
...otherOptions
} = options;
Expand All@@ -48,8 +53,21 @@ export const sentryAstro = (options: SentryOptions = {}): AstroIntegration => {
};

const sourceMapsNeeded = sdkEnabled.client || sdkEnabled.server;
const { unstable_sentryVitePluginOptions, ...uploadOptions } = sourceMapsUploadOptions || {};
const shouldUploadSourcemaps = (sourceMapsNeeded && uploadOptions?.enabled) ?? true;
// eslint-disable-next-line deprecation/deprecation
const { unstable_sentryVitePluginOptions: deprecatedVitePluginOptions, ...uploadOptions } =
sourceMapsUploadOptions || {};

const unstableMerged_sentryVitePluginOptions = {
...deprecatedVitePluginOptions,
...unstable_sentryVitePluginOptions,
};

const shouldUploadSourcemaps =
(sourceMapsNeeded &&
sourcemaps?.disable !== true &&
// eslint-disable-next-line deprecation/deprecation
uploadOptions?.enabled) ??
true;

// We don't need to check for AUTH_TOKEN here, because the plugin will pick it up from the env
if (shouldUploadSourcemaps && command !== 'dev') {
Expand All@@ -58,7 +76,9 @@ export const sentryAstro = (options: SentryOptions = {}): AstroIntegration => {
let updatedFilesToDeleteAfterUpload: string[] | undefined = undefined;

if (
// eslint-disable-next-line deprecation/deprecation
typeof uploadOptions?.filesToDeleteAfterUpload === 'undefined' &&
typeof sourcemaps?.filesToDeleteAfterUpload === 'undefined' &&
computedSourceMapSettings.previousUserSourceMapSetting === 'unset'
) {
// This also works for adapters, as the source maps are also copied to e.g. the .vercel folder
Expand All@@ -79,26 +99,40 @@ export const sentryAstro = (options: SentryOptions = {}): AstroIntegration => {
},
plugins: [
sentryVitePlugin({
org: uploadOptions.org ?? env.SENTRY_ORG,
project: uploadOptions.project ?? env.SENTRY_PROJECT,
authToken: uploadOptions.authToken ?? env.SENTRY_AUTH_TOKEN,
telemetry: uploadOptions.telemetry ?? true,
// Priority: top-level options > deprecated options > env vars
// eslint-disable-next-line deprecation/deprecation
org: options.org ?? uploadOptions.org ?? env.SENTRY_ORG,
// eslint-disable-next-line deprecation/deprecation
project: options.project ?? uploadOptions.project ?? env.SENTRY_PROJECT,
// eslint-disable-next-line deprecation/deprecation
authToken: options.authToken ?? uploadOptions.authToken ?? env.SENTRY_AUTH_TOKEN,
url: options.sentryUrl ?? env.SENTRY_URL,
headers: options.headers,
// eslint-disable-next-line deprecation/deprecation
telemetry: options.telemetry ?? uploadOptions.telemetry ?? true,
silent: options.silent ?? false,
errorHandler: options.errorHandler,
_metaOptions: {
telemetry: {
metaFramework: 'astro',
},
},
...unstable_sentryVitePluginOptions,
debug: debug ?? false,
...unstableMerged_sentryVitePluginOptions,
debug: options.debug ?? false,
sourcemaps: {
assets: uploadOptions.assets ?? [getSourcemapsAssetsGlob(config)],
...options.sourcemaps,
// eslint-disable-next-line deprecation/deprecation
assets: sourcemaps?.assets ?? uploadOptions.assets ?? [getSourcemapsAssetsGlob(config)],
filesToDeleteAfterUpload:
uploadOptions?.filesToDeleteAfterUpload ?? updatedFilesToDeleteAfterUpload,
...unstable_sentryVitePluginOptions?.sourcemaps,
sourcemaps?.filesToDeleteAfterUpload ??
// eslint-disable-next-line deprecation/deprecation
uploadOptions?.filesToDeleteAfterUpload ??
updatedFilesToDeleteAfterUpload,
...unstableMerged_sentryVitePluginOptions?.sourcemaps,
},
bundleSizeOptimizations: {
...bundleSizeOptimizations,
...unstable_sentryVitePluginOptions?.bundleSizeOptimizations,
...unstableMerged_sentryVitePluginOptions?.bundleSizeOptimizations,
},
}),
],
Expand Down
79 changes: 26 additions & 53 deletions packages/astro/src/integration/types.ts
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import type { BuildTimeOptionsBase, UnstableVitePluginOptions } from '@sentry/core';
import type { SentryVitePluginOptions } from '@sentry/vite-plugin';
import type { RouteData } from 'astro';

Expand All@@ -23,12 +24,16 @@ type SdkInitPaths = {
serverInitPath?: string;
};

/**
* @deprecated Move these options to the top-level of your Sentry configuration.
*/
type SourceMapsOptions = {
/**
* If this flag is `true`, and an auth token is detected, the Sentry integration will
* automatically generate and upload source maps to Sentry during a production build.
*
* @default true
* @deprecated Use `sourcemaps.disable` instead (with inverted logic)
*/
enabled?: boolean;

Expand All@@ -39,18 +44,24 @@ type SourceMapsOptions = {
*
* To create an auth token, follow this guide:
* @see https://docs.sentry.io/product/accounts/auth-tokens/#organization-auth-tokens
*
* @deprecated Use top-level `authToken` option instead
*/
authToken?: string;

/**
* The organization slug of your Sentry organization.
* Instead of specifying this option, you can also set the `SENTRY_ORG` environment variable.
*
* @deprecated Use top-level `org` option instead
*/
org?: string;

/**
* The project slug of your Sentry project.
* Instead of specifying this option, you can also set the `SENTRY_PROJECT` environment variable.
*
* @deprecated Use top-level `project` option instead
*/
project?: string;

Expand All@@ -59,6 +70,7 @@ type SourceMapsOptions = {
* It will not collect any sensitive or user-specific data.
*
* @default true
* @deprecated Use top-level `telemetry` option instead
*/
telemetry?: boolean;

Expand All@@ -71,6 +83,8 @@ type SourceMapsOptions = {
*
* The globbing patterns must follow the implementation of the `glob` package.
* @see https://www.npmjs.com/package/glob#glob-primer
*
* @deprecated Use `sourcemaps.assets` instead
*/
assets?: string | Array<string>;

Expand All@@ -81,6 +95,8 @@ type SourceMapsOptions = {
* @default [] - By default no files are deleted.
*
* The globbing patterns follow the implementation of the glob package. (https://www.npmjs.com/package/glob)
*
* @deprecated Use `sourcemaps.filesToDeleteAfterUpload` instead
*/
filesToDeleteAfterUpload?: string | Array<string>;

Expand All@@ -95,49 +111,10 @@ type SourceMapsOptions = {
* changes can occur at any time within a major SDK version.
*
* Furthermore, some options are untested with Astro specifically. Use with caution.
*/
unstable_sentryVitePluginOptions?: Partial<SentryVitePluginOptions>;
};

type BundleSizeOptimizationOptions = {
/**
* If set to `true`, the plugin will attempt to tree-shake (remove) any debugging code within the Sentry SDK.
* Note that the success of this depends on tree shaking being enabled in your build tooling.
*
* Setting this option to `true` will disable features like the SDK's `debug` option.
*/
excludeDebugStatements?: boolean;

/**
* If set to true, the plugin will try to tree-shake performance monitoring statements out.
* Note that the success of this depends on tree shaking generally being enabled in your build.
* Attention: DO NOT enable this when you're using any performance monitoring-related SDK features (e.g. Sentry.startSpan()).
*/
excludeTracing?: boolean;

/**
* If set to `true`, the plugin will attempt to tree-shake (remove) code related to the Sentry SDK's Session Replay Shadow DOM recording functionality.
* Note that the success of this depends on tree shaking being enabled in your build tooling.
*
* This option is safe to be used when you do not want to capture any Shadow DOM activity via Sentry Session Replay.
* @deprecated Use top-level `unstable_sentryVitePluginOptions` instead
*/
excludeReplayShadowDom?: boolean;

/**
* If set to `true`, the plugin will attempt to tree-shake (remove) code related to the Sentry SDK's Session Replay `iframe` recording functionality.
* Note that the success of this depends on tree shaking being enabled in your build tooling.
*
* You can safely do this when you do not want to capture any `iframe` activity via Sentry Session Replay.
*/
excludeReplayIframe?: boolean;

/**
* If set to `true`, the plugin will attempt to tree-shake (remove) code related to the Sentry SDK's Session Replay's Compression Web Worker.
* Note that the success of this depends on tree shaking being enabled in your build tooling.
*
* **Notice:** You should only do use this option if you manually host a compression worker and configure it in your Sentry Session Replay integration config via the `workerUrl` option.
*/
excludeReplayWorker?: boolean;
unstable_sentryVitePluginOptions?: Partial<SentryVitePluginOptions>;
};

type InstrumentationOptions = {
Expand DownExpand Up@@ -202,27 +179,23 @@ type DeprecatedRuntimeOptions = Record<string, unknown>;
*
* If you specify a dedicated init file, the SDK options passed to `sentryAstro` will be ignored.
*/
export type SentryOptions = SdkInitPaths &
export type SentryOptions = Omit<BuildTimeOptionsBase, 'release'> &
// todo(v11): `release` and `debug` need to be removed from BuildTimeOptionsBase as it is currently conflicting with `DeprecatedRuntimeOptions`
UnstableVitePluginOptions<SentryVitePluginOptions> &
SdkInitPaths &
InstrumentationOptions &
SdkEnabledOptions & {
/**
* Options for the Sentry Vite plugin to customize the source maps upload process.
*
* These options are always read from the `sentryAstro` integration.
* Do not define them in the `sentry.client.config.(js|ts)` or `sentry.server.config.(js|ts)` files.
*/
sourceMapsUploadOptions?: SourceMapsOptions;
/**
* Options for the Sentry Vite plugin to customize bundle size optimizations.
*
* These options are always read from the `sentryAstro` integration.
* Do not define them in the `sentry.client.config.(js|ts)` or `sentry.server.config.(js|ts)` files.
* @deprecated This option was deprecated. Please move the options to the top-level configuration.
* See the migration guide in the SourceMapsOptions type documentation.
*/
bundleSizeOptimizations?: BundleSizeOptimizationOptions;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Am I confused or did this disappear with the changes? 🤔

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is part of the shared type so it's possible to delete it here :)

bundleSizeOptimizations?: BundleSizeOptimizationsOptions;

/**
* If enabled, prints debug logs during the build process.
*/
debug?: boolean;
// eslint-disable-next-line deprecation/deprecation
sourceMapsUploadOptions?: SourceMapsOptions;
// eslint-disable-next-line deprecation/deprecation
} & DeprecatedRuntimeOptions;

Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion packages/astro/.eslintrc.cjs
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ module.exports = {
{
files: ['vite.config.ts'],
parserOptions: {
project: ['tsconfig.test.json'],
project: ['tsconfig.vite.json'],
},
},
],
Expand Down
58 changes: 46 additions & 12 deletions packages/astro/src/integration/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,8 +27,13 @@ export const sentryAstro = (options: SentryOptions = {}): AstroIntegration => {
clientInitPath,
serverInitPath,
autoInstrumentation,
// eslint-disable-next-line deprecation/deprecation
sourceMapsUploadOptions,
sourcemaps,
// todo(v11): Extract `release` build time option here - cannot be done currently, because it conflicts with the `DeprecatedRuntimeOptions` type
// release,
bundleSizeOptimizations,
unstable_sentryVitePluginOptions,

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: Sentry Vite Plugin Misinterprets Configuration Options

New top-level build-time options (e.g., org, project, authToken, sentryUrl, headers, telemetry, silent, errorHandler) are not destructured from the options object. This causes them to be incorrectly included in otherOptions, triggering a deprecation warning for 'additional options'. As a result, misleading warnings appear in production builds, despite these options being valid and used for Sentry Vite plugin configuration.

Fix in CursorFix in Web

debug,
...otherOptions
} = options;
Expand All@@ -48,8 +53,21 @@ export const sentryAstro = (options: SentryOptions = {}): AstroIntegration => {
};

const sourceMapsNeeded = sdkEnabled.client || sdkEnabled.server;
const { unstable_sentryVitePluginOptions, ...uploadOptions } = sourceMapsUploadOptions || {};
const shouldUploadSourcemaps = (sourceMapsNeeded && uploadOptions?.enabled) ?? true;
// eslint-disable-next-line deprecation/deprecation
const { unstable_sentryVitePluginOptions: deprecatedVitePluginOptions, ...uploadOptions } =
sourceMapsUploadOptions || {};

const unstableMerged_sentryVitePluginOptions = {
...deprecatedVitePluginOptions,
...unstable_sentryVitePluginOptions,
};

const shouldUploadSourcemaps =
(sourceMapsNeeded &&
sourcemaps?.disable !== true &&
// eslint-disable-next-line deprecation/deprecation
uploadOptions?.enabled) ??
true;

// We don't need to check for AUTH_TOKEN here, because the plugin will pick it up from the env
if (shouldUploadSourcemaps && command !== 'dev') {
Expand All@@ -58,7 +76,9 @@ export const sentryAstro = (options: SentryOptions = {}): AstroIntegration => {
let updatedFilesToDeleteAfterUpload: string[] | undefined = undefined;

if (
// eslint-disable-next-line deprecation/deprecation
typeof uploadOptions?.filesToDeleteAfterUpload === 'undefined' &&
typeof sourcemaps?.filesToDeleteAfterUpload === 'undefined' &&
computedSourceMapSettings.previousUserSourceMapSetting === 'unset'
) {
// This also works for adapters, as the source maps are also copied to e.g. the .vercel folder
Expand All@@ -79,26 +99,40 @@ export const sentryAstro = (options: SentryOptions = {}): AstroIntegration => {
},
plugins: [
sentryVitePlugin({
org: uploadOptions.org ?? env.SENTRY_ORG,
project: uploadOptions.project ?? env.SENTRY_PROJECT,
authToken: uploadOptions.authToken ?? env.SENTRY_AUTH_TOKEN,
telemetry: uploadOptions.telemetry ?? true,
// Priority: top-level options > deprecated options > env vars
// eslint-disable-next-line deprecation/deprecation
org: options.org ?? uploadOptions.org ?? env.SENTRY_ORG,
// eslint-disable-next-line deprecation/deprecation
project: options.project ?? uploadOptions.project ?? env.SENTRY_PROJECT,
// eslint-disable-next-line deprecation/deprecation
authToken: options.authToken ?? uploadOptions.authToken ?? env.SENTRY_AUTH_TOKEN,
url: options.sentryUrl ?? env.SENTRY_URL,
headers: options.headers,
// eslint-disable-next-line deprecation/deprecation
telemetry: options.telemetry ?? uploadOptions.telemetry ?? true,
silent: options.silent ?? false,
errorHandler: options.errorHandler,
_metaOptions: {
telemetry: {
metaFramework: 'astro',
},
},
...unstable_sentryVitePluginOptions,
debug: debug ?? false,
...unstableMerged_sentryVitePluginOptions,
debug: options.debug ?? false,
sourcemaps: {
assets: uploadOptions.assets ?? [getSourcemapsAssetsGlob(config)],
...options.sourcemaps,
// eslint-disable-next-line deprecation/deprecation
assets: sourcemaps?.assets ?? uploadOptions.assets ?? [getSourcemapsAssetsGlob(config)],
filesToDeleteAfterUpload:
uploadOptions?.filesToDeleteAfterUpload ?? updatedFilesToDeleteAfterUpload,
...unstable_sentryVitePluginOptions?.sourcemaps,
sourcemaps?.filesToDeleteAfterUpload ??
// eslint-disable-next-line deprecation/deprecation
uploadOptions?.filesToDeleteAfterUpload ??
updatedFilesToDeleteAfterUpload,
...unstableMerged_sentryVitePluginOptions?.sourcemaps,
},
bundleSizeOptimizations: {
...bundleSizeOptimizations,
...unstable_sentryVitePluginOptions?.bundleSizeOptimizations,
...unstableMerged_sentryVitePluginOptions?.bundleSizeOptimizations,
},
}),
],
Expand Down
79 changes: 26 additions & 53 deletions packages/astro/src/integration/types.ts
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import type { BuildTimeOptionsBase, UnstableVitePluginOptions } from '@sentry/core';
import type { SentryVitePluginOptions } from '@sentry/vite-plugin';
import type { RouteData } from 'astro';

Expand All@@ -23,12 +24,16 @@ type SdkInitPaths = {
serverInitPath?: string;
};

/**
* @deprecated Move these options to the top-level of your Sentry configuration.
*/
type SourceMapsOptions = {
/**
* If this flag is `true`, and an auth token is detected, the Sentry integration will
* automatically generate and upload source maps to Sentry during a production build.
*
* @default true
* @deprecated Use `sourcemaps.disable` instead (with inverted logic)
*/
enabled?: boolean;

Expand All@@ -39,18 +44,24 @@ type SourceMapsOptions = {
*
* To create an auth token, follow this guide:
* @see https://docs.sentry.io/product/accounts/auth-tokens/#organization-auth-tokens
*
* @deprecated Use top-level `authToken` option instead
*/
authToken?: string;

/**
* The organization slug of your Sentry organization.
* Instead of specifying this option, you can also set the `SENTRY_ORG` environment variable.
*
* @deprecated Use top-level `org` option instead
*/
org?: string;

/**
* The project slug of your Sentry project.
* Instead of specifying this option, you can also set the `SENTRY_PROJECT` environment variable.
*
* @deprecated Use top-level `project` option instead
*/
project?: string;

Expand All@@ -59,6 +70,7 @@ type SourceMapsOptions = {
* It will not collect any sensitive or user-specific data.
*
* @default true
* @deprecated Use top-level `telemetry` option instead
*/
telemetry?: boolean;

Expand All@@ -71,6 +83,8 @@ type SourceMapsOptions = {
*
* The globbing patterns must follow the implementation of the `glob` package.
* @see https://www.npmjs.com/package/glob#glob-primer
*
* @deprecated Use `sourcemaps.assets` instead
*/
assets?: string | Array<string>;

Expand All@@ -81,6 +95,8 @@ type SourceMapsOptions = {
* @default [] - By default no files are deleted.
*
* The globbing patterns follow the implementation of the glob package. (https://www.npmjs.com/package/glob)
*
* @deprecated Use `sourcemaps.filesToDeleteAfterUpload` instead
*/
filesToDeleteAfterUpload?: string | Array<string>;

Expand All@@ -95,49 +111,10 @@ type SourceMapsOptions = {
* changes can occur at any time within a major SDK version.
*
* Furthermore, some options are untested with Astro specifically. Use with caution.
*/
unstable_sentryVitePluginOptions?: Partial<SentryVitePluginOptions>;
};

type BundleSizeOptimizationOptions = {
/**
* If set to `true`, the plugin will attempt to tree-shake (remove) any debugging code within the Sentry SDK.
* Note that the success of this depends on tree shaking being enabled in your build tooling.
*
* Setting this option to `true` will disable features like the SDK's `debug` option.
*/
excludeDebugStatements?: boolean;

/**
* If set to true, the plugin will try to tree-shake performance monitoring statements out.
* Note that the success of this depends on tree shaking generally being enabled in your build.
* Attention: DO NOT enable this when you're using any performance monitoring-related SDK features (e.g. Sentry.startSpan()).
*/
excludeTracing?: boolean;

/**
* If set to `true`, the plugin will attempt to tree-shake (remove) code related to the Sentry SDK's Session Replay Shadow DOM recording functionality.
* Note that the success of this depends on tree shaking being enabled in your build tooling.
*
* This option is safe to be used when you do not want to capture any Shadow DOM activity via Sentry Session Replay.
* @deprecated Use top-level `unstable_sentryVitePluginOptions` instead
*/
excludeReplayShadowDom?: boolean;

/**
* If set to `true`, the plugin will attempt to tree-shake (remove) code related to the Sentry SDK's Session Replay `iframe` recording functionality.
* Note that the success of this depends on tree shaking being enabled in your build tooling.
*
* You can safely do this when you do not want to capture any `iframe` activity via Sentry Session Replay.
*/
excludeReplayIframe?: boolean;

/**
* If set to `true`, the plugin will attempt to tree-shake (remove) code related to the Sentry SDK's Session Replay's Compression Web Worker.
* Note that the success of this depends on tree shaking being enabled in your build tooling.
*
* **Notice:** You should only do use this option if you manually host a compression worker and configure it in your Sentry Session Replay integration config via the `workerUrl` option.
*/
excludeReplayWorker?: boolean;
unstable_sentryVitePluginOptions?: Partial<SentryVitePluginOptions>;
};

type InstrumentationOptions = {
Expand DownExpand Up@@ -202,27 +179,23 @@ type DeprecatedRuntimeOptions = Record<string, unknown>;
*
* If you specify a dedicated init file, the SDK options passed to `sentryAstro` will be ignored.
*/
export type SentryOptions = SdkInitPaths &
export type SentryOptions = Omit<BuildTimeOptionsBase, 'release'> &
// todo(v11): `release` and `debug` need to be removed from BuildTimeOptionsBase as it is currently conflicting with `DeprecatedRuntimeOptions`
UnstableVitePluginOptions<SentryVitePluginOptions> &
SdkInitPaths &
InstrumentationOptions &
SdkEnabledOptions & {
/**
* Options for the Sentry Vite plugin to customize the source maps upload process.
*
* These options are always read from the `sentryAstro` integration.
* Do not define them in the `sentry.client.config.(js|ts)` or `sentry.server.config.(js|ts)` files.
*/
sourceMapsUploadOptions?: SourceMapsOptions;
/**
* Options for the Sentry Vite plugin to customize bundle size optimizations.
*
* These options are always read from the `sentryAstro` integration.
* Do not define them in the `sentry.client.config.(js|ts)` or `sentry.server.config.(js|ts)` files.
* @deprecated This option was deprecated. Please move the options to the top-level configuration.
* See the migration guide in the SourceMapsOptions type documentation.
*/
bundleSizeOptimizations?: BundleSizeOptimizationOptions;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Am I confused or did this disappear with the changes? 🤔

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is part of the shared type so it's possible to delete it here :)

bundleSizeOptimizations?: BundleSizeOptimizationsOptions;

/**
* If enabled, prints debug logs during the build process.
*/
debug?: boolean;
// eslint-disable-next-line deprecation/deprecation
sourceMapsUploadOptions?: SourceMapsOptions;
// eslint-disable-next-line deprecation/deprecation
} & DeprecatedRuntimeOptions;

Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion packages/astro/.eslintrc.cjs
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ module.exports = {
{
files: ['vite.config.ts'],
parserOptions: {
project: ['tsconfig.test.json'],
project: ['tsconfig.vite.json'],
},
},
],
Expand Down
58 changes: 46 additions & 12 deletions packages/astro/src/integration/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,8 +27,13 @@ export const sentryAstro = (options: SentryOptions = {}): AstroIntegration => {
clientInitPath,
serverInitPath,
autoInstrumentation,
// eslint-disable-next-line deprecation/deprecation
sourceMapsUploadOptions,
sourcemaps,
// todo(v11): Extract `release` build time option here - cannot be done currently, because it conflicts with the `DeprecatedRuntimeOptions` type
// release,
bundleSizeOptimizations,
unstable_sentryVitePluginOptions,

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: Sentry Vite Plugin Misinterprets Configuration Options

New top-level build-time options (e.g., org, project, authToken, sentryUrl, headers, telemetry, silent, errorHandler) are not destructured from the options object. This causes them to be incorrectly included in otherOptions, triggering a deprecation warning for 'additional options'. As a result, misleading warnings appear in production builds, despite these options being valid and used for Sentry Vite plugin configuration.

Fix in CursorFix in Web

debug,
...otherOptions
} = options;
Expand All@@ -48,8 +53,21 @@ export const sentryAstro = (options: SentryOptions = {}): AstroIntegration => {
};

const sourceMapsNeeded = sdkEnabled.client || sdkEnabled.server;
const { unstable_sentryVitePluginOptions, ...uploadOptions } = sourceMapsUploadOptions || {};
const shouldUploadSourcemaps = (sourceMapsNeeded && uploadOptions?.enabled) ?? true;
// eslint-disable-next-line deprecation/deprecation
const { unstable_sentryVitePluginOptions: deprecatedVitePluginOptions, ...uploadOptions } =
sourceMapsUploadOptions || {};

const unstableMerged_sentryVitePluginOptions = {
...deprecatedVitePluginOptions,
...unstable_sentryVitePluginOptions,
};

const shouldUploadSourcemaps =
(sourceMapsNeeded &&
sourcemaps?.disable !== true &&
// eslint-disable-next-line deprecation/deprecation
uploadOptions?.enabled) ??
true;

// We don't need to check for AUTH_TOKEN here, because the plugin will pick it up from the env
if (shouldUploadSourcemaps && command !== 'dev') {
Expand All@@ -58,7 +76,9 @@ export const sentryAstro = (options: SentryOptions = {}): AstroIntegration => {
let updatedFilesToDeleteAfterUpload: string[] | undefined = undefined;

if (
// eslint-disable-next-line deprecation/deprecation
typeof uploadOptions?.filesToDeleteAfterUpload === 'undefined' &&
typeof sourcemaps?.filesToDeleteAfterUpload === 'undefined' &&
computedSourceMapSettings.previousUserSourceMapSetting === 'unset'
) {
// This also works for adapters, as the source maps are also copied to e.g. the .vercel folder
Expand All@@ -79,26 +99,40 @@ export const sentryAstro = (options: SentryOptions = {}): AstroIntegration => {
},
plugins: [
sentryVitePlugin({
org: uploadOptions.org ?? env.SENTRY_ORG,
project: uploadOptions.project ?? env.SENTRY_PROJECT,
authToken: uploadOptions.authToken ?? env.SENTRY_AUTH_TOKEN,
telemetry: uploadOptions.telemetry ?? true,
// Priority: top-level options > deprecated options > env vars
// eslint-disable-next-line deprecation/deprecation
org: options.org ?? uploadOptions.org ?? env.SENTRY_ORG,
// eslint-disable-next-line deprecation/deprecation
project: options.project ?? uploadOptions.project ?? env.SENTRY_PROJECT,
// eslint-disable-next-line deprecation/deprecation
authToken: options.authToken ?? uploadOptions.authToken ?? env.SENTRY_AUTH_TOKEN,
url: options.sentryUrl ?? env.SENTRY_URL,
headers: options.headers,
// eslint-disable-next-line deprecation/deprecation
telemetry: options.telemetry ?? uploadOptions.telemetry ?? true,
silent: options.silent ?? false,
errorHandler: options.errorHandler,
_metaOptions: {
telemetry: {
metaFramework: 'astro',
},
},
...unstable_sentryVitePluginOptions,
debug: debug ?? false,
...unstableMerged_sentryVitePluginOptions,
debug: options.debug ?? false,
sourcemaps: {
assets: uploadOptions.assets ?? [getSourcemapsAssetsGlob(config)],
...options.sourcemaps,
// eslint-disable-next-line deprecation/deprecation
assets: sourcemaps?.assets ?? uploadOptions.assets ?? [getSourcemapsAssetsGlob(config)],
filesToDeleteAfterUpload:
uploadOptions?.filesToDeleteAfterUpload ?? updatedFilesToDeleteAfterUpload,
...unstable_sentryVitePluginOptions?.sourcemaps,
sourcemaps?.filesToDeleteAfterUpload ??
// eslint-disable-next-line deprecation/deprecation
uploadOptions?.filesToDeleteAfterUpload ??
updatedFilesToDeleteAfterUpload,
...unstableMerged_sentryVitePluginOptions?.sourcemaps,
},
bundleSizeOptimizations: {
...bundleSizeOptimizations,
...unstable_sentryVitePluginOptions?.bundleSizeOptimizations,
...unstableMerged_sentryVitePluginOptions?.bundleSizeOptimizations,
},
}),
],
Expand Down
79 changes: 26 additions & 53 deletions packages/astro/src/integration/types.ts
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import type { BuildTimeOptionsBase, UnstableVitePluginOptions } from '@sentry/core';
import type { SentryVitePluginOptions } from '@sentry/vite-plugin';
import type { RouteData } from 'astro';

Expand All@@ -23,12 +24,16 @@ type SdkInitPaths = {
serverInitPath?: string;
};

/**
* @deprecated Move these options to the top-level of your Sentry configuration.
*/
type SourceMapsOptions = {
/**
* If this flag is `true`, and an auth token is detected, the Sentry integration will
* automatically generate and upload source maps to Sentry during a production build.
*
* @default true
* @deprecated Use `sourcemaps.disable` instead (with inverted logic)
*/
enabled?: boolean;

Expand All@@ -39,18 +44,24 @@ type SourceMapsOptions = {
*
* To create an auth token, follow this guide:
* @see https://docs.sentry.io/product/accounts/auth-tokens/#organization-auth-tokens
*
* @deprecated Use top-level `authToken` option instead
*/
authToken?: string;

/**
* The organization slug of your Sentry organization.
* Instead of specifying this option, you can also set the `SENTRY_ORG` environment variable.
*
* @deprecated Use top-level `org` option instead
*/
org?: string;

/**
* The project slug of your Sentry project.
* Instead of specifying this option, you can also set the `SENTRY_PROJECT` environment variable.
*
* @deprecated Use top-level `project` option instead
*/
project?: string;

Expand All@@ -59,6 +70,7 @@ type SourceMapsOptions = {
* It will not collect any sensitive or user-specific data.
*
* @default true
* @deprecated Use top-level `telemetry` option instead
*/
telemetry?: boolean;

Expand All@@ -71,6 +83,8 @@ type SourceMapsOptions = {
*
* The globbing patterns must follow the implementation of the `glob` package.
* @see https://www.npmjs.com/package/glob#glob-primer
*
* @deprecated Use `sourcemaps.assets` instead
*/
assets?: string | Array<string>;

Expand All@@ -81,6 +95,8 @@ type SourceMapsOptions = {
* @default [] - By default no files are deleted.
*
* The globbing patterns follow the implementation of the glob package. (https://www.npmjs.com/package/glob)
*
* @deprecated Use `sourcemaps.filesToDeleteAfterUpload` instead
*/
filesToDeleteAfterUpload?: string | Array<string>;

Expand All@@ -95,49 +111,10 @@ type SourceMapsOptions = {
* changes can occur at any time within a major SDK version.
*
* Furthermore, some options are untested with Astro specifically. Use with caution.
*/
unstable_sentryVitePluginOptions?: Partial<SentryVitePluginOptions>;
};

type BundleSizeOptimizationOptions = {
/**
* If set to `true`, the plugin will attempt to tree-shake (remove) any debugging code within the Sentry SDK.
* Note that the success of this depends on tree shaking being enabled in your build tooling.
*
* Setting this option to `true` will disable features like the SDK's `debug` option.
*/
excludeDebugStatements?: boolean;

/**
* If set to true, the plugin will try to tree-shake performance monitoring statements out.
* Note that the success of this depends on tree shaking generally being enabled in your build.
* Attention: DO NOT enable this when you're using any performance monitoring-related SDK features (e.g. Sentry.startSpan()).
*/
excludeTracing?: boolean;

/**
* If set to `true`, the plugin will attempt to tree-shake (remove) code related to the Sentry SDK's Session Replay Shadow DOM recording functionality.
* Note that the success of this depends on tree shaking being enabled in your build tooling.
*
* This option is safe to be used when you do not want to capture any Shadow DOM activity via Sentry Session Replay.
* @deprecated Use top-level `unstable_sentryVitePluginOptions` instead
*/
excludeReplayShadowDom?: boolean;

/**
* If set to `true`, the plugin will attempt to tree-shake (remove) code related to the Sentry SDK's Session Replay `iframe` recording functionality.
* Note that the success of this depends on tree shaking being enabled in your build tooling.
*
* You can safely do this when you do not want to capture any `iframe` activity via Sentry Session Replay.
*/
excludeReplayIframe?: boolean;

/**
* If set to `true`, the plugin will attempt to tree-shake (remove) code related to the Sentry SDK's Session Replay's Compression Web Worker.
* Note that the success of this depends on tree shaking being enabled in your build tooling.
*
* **Notice:** You should only do use this option if you manually host a compression worker and configure it in your Sentry Session Replay integration config via the `workerUrl` option.
*/
excludeReplayWorker?: boolean;
unstable_sentryVitePluginOptions?: Partial<SentryVitePluginOptions>;
};

type InstrumentationOptions = {
Expand DownExpand Up@@ -202,27 +179,23 @@ type DeprecatedRuntimeOptions = Record<string, unknown>;
*
* If you specify a dedicated init file, the SDK options passed to `sentryAstro` will be ignored.
*/
export type SentryOptions = SdkInitPaths &
export type SentryOptions = Omit<BuildTimeOptionsBase, 'release'> &
// todo(v11): `release` and `debug` need to be removed from BuildTimeOptionsBase as it is currently conflicting with `DeprecatedRuntimeOptions`
UnstableVitePluginOptions<SentryVitePluginOptions> &
SdkInitPaths &
InstrumentationOptions &
SdkEnabledOptions & {
/**
* Options for the Sentry Vite plugin to customize the source maps upload process.
*
* These options are always read from the `sentryAstro` integration.
* Do not define them in the `sentry.client.config.(js|ts)` or `sentry.server.config.(js|ts)` files.
*/
sourceMapsUploadOptions?: SourceMapsOptions;
/**
* Options for the Sentry Vite plugin to customize bundle size optimizations.
*
* These options are always read from the `sentryAstro` integration.
* Do not define them in the `sentry.client.config.(js|ts)` or `sentry.server.config.(js|ts)` files.
* @deprecated This option was deprecated. Please move the options to the top-level configuration.
* See the migration guide in the SourceMapsOptions type documentation.
*/
bundleSizeOptimizations?: BundleSizeOptimizationOptions;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Am I confused or did this disappear with the changes? 🤔

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is part of the shared type so it's possible to delete it here :)

bundleSizeOptimizations?: BundleSizeOptimizationsOptions;

/**
* If enabled, prints debug logs during the build process.
*/
debug?: boolean;
// eslint-disable-next-line deprecation/deprecation
sourceMapsUploadOptions?: SourceMapsOptions;
// eslint-disable-next-line deprecation/deprecation
} & DeprecatedRuntimeOptions;

Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion packages/astro/.eslintrc.cjs
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ module.exports = {
{
files: ['vite.config.ts'],
parserOptions: {
project: ['tsconfig.test.json'],
project: ['tsconfig.vite.json'],
},
},
],
Expand Down
58 changes: 46 additions & 12 deletions packages/astro/src/integration/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,8 +27,13 @@ export const sentryAstro = (options: SentryOptions = {}): AstroIntegration => {
clientInitPath,
serverInitPath,
autoInstrumentation,
// eslint-disable-next-line deprecation/deprecation
sourceMapsUploadOptions,
sourcemaps,
// todo(v11): Extract `release` build time option here - cannot be done currently, because it conflicts with the `DeprecatedRuntimeOptions` type
// release,
bundleSizeOptimizations,
unstable_sentryVitePluginOptions,

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: Sentry Vite Plugin Misinterprets Configuration Options

New top-level build-time options (e.g., org, project, authToken, sentryUrl, headers, telemetry, silent, errorHandler) are not destructured from the options object. This causes them to be incorrectly included in otherOptions, triggering a deprecation warning for 'additional options'. As a result, misleading warnings appear in production builds, despite these options being valid and used for Sentry Vite plugin configuration.

Fix in CursorFix in Web

debug,
...otherOptions
} = options;
Expand All@@ -48,8 +53,21 @@ export const sentryAstro = (options: SentryOptions = {}): AstroIntegration => {
};

const sourceMapsNeeded = sdkEnabled.client || sdkEnabled.server;
const { unstable_sentryVitePluginOptions, ...uploadOptions } = sourceMapsUploadOptions || {};
const shouldUploadSourcemaps = (sourceMapsNeeded && uploadOptions?.enabled) ?? true;
// eslint-disable-next-line deprecation/deprecation
const { unstable_sentryVitePluginOptions: deprecatedVitePluginOptions, ...uploadOptions } =
sourceMapsUploadOptions || {};

const unstableMerged_sentryVitePluginOptions = {
...deprecatedVitePluginOptions,
...unstable_sentryVitePluginOptions,
};

const shouldUploadSourcemaps =
(sourceMapsNeeded &&
sourcemaps?.disable !== true &&
// eslint-disable-next-line deprecation/deprecation
uploadOptions?.enabled) ??
true;

// We don't need to check for AUTH_TOKEN here, because the plugin will pick it up from the env
if (shouldUploadSourcemaps && command !== 'dev') {
Expand All@@ -58,7 +76,9 @@ export const sentryAstro = (options: SentryOptions = {}): AstroIntegration => {
let updatedFilesToDeleteAfterUpload: string[] | undefined = undefined;

if (
// eslint-disable-next-line deprecation/deprecation
typeof uploadOptions?.filesToDeleteAfterUpload === 'undefined' &&
typeof sourcemaps?.filesToDeleteAfterUpload === 'undefined' &&
computedSourceMapSettings.previousUserSourceMapSetting === 'unset'
) {
// This also works for adapters, as the source maps are also copied to e.g. the .vercel folder
Expand All@@ -79,26 +99,40 @@ export const sentryAstro = (options: SentryOptions = {}): AstroIntegration => {
},
plugins: [
sentryVitePlugin({
org: uploadOptions.org ?? env.SENTRY_ORG,
project: uploadOptions.project ?? env.SENTRY_PROJECT,
authToken: uploadOptions.authToken ?? env.SENTRY_AUTH_TOKEN,
telemetry: uploadOptions.telemetry ?? true,
// Priority: top-level options > deprecated options > env vars
// eslint-disable-next-line deprecation/deprecation
org: options.org ?? uploadOptions.org ?? env.SENTRY_ORG,
// eslint-disable-next-line deprecation/deprecation
project: options.project ?? uploadOptions.project ?? env.SENTRY_PROJECT,
// eslint-disable-next-line deprecation/deprecation
authToken: options.authToken ?? uploadOptions.authToken ?? env.SENTRY_AUTH_TOKEN,
url: options.sentryUrl ?? env.SENTRY_URL,
headers: options.headers,
// eslint-disable-next-line deprecation/deprecation
telemetry: options.telemetry ?? uploadOptions.telemetry ?? true,
silent: options.silent ?? false,
errorHandler: options.errorHandler,
_metaOptions: {
telemetry: {
metaFramework: 'astro',
},
},
...unstable_sentryVitePluginOptions,
debug: debug ?? false,
...unstableMerged_sentryVitePluginOptions,
debug: options.debug ?? false,
sourcemaps: {
assets: uploadOptions.assets ?? [getSourcemapsAssetsGlob(config)],
...options.sourcemaps,
// eslint-disable-next-line deprecation/deprecation
assets: sourcemaps?.assets ?? uploadOptions.assets ?? [getSourcemapsAssetsGlob(config)],
filesToDeleteAfterUpload:
uploadOptions?.filesToDeleteAfterUpload ?? updatedFilesToDeleteAfterUpload,
...unstable_sentryVitePluginOptions?.sourcemaps,
sourcemaps?.filesToDeleteAfterUpload ??
// eslint-disable-next-line deprecation/deprecation
uploadOptions?.filesToDeleteAfterUpload ??
updatedFilesToDeleteAfterUpload,
...unstableMerged_sentryVitePluginOptions?.sourcemaps,
},
bundleSizeOptimizations: {
...bundleSizeOptimizations,
...unstable_sentryVitePluginOptions?.bundleSizeOptimizations,
...unstableMerged_sentryVitePluginOptions?.bundleSizeOptimizations,
},
}),
],
Expand Down
79 changes: 26 additions & 53 deletions packages/astro/src/integration/types.ts
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import type { BuildTimeOptionsBase, UnstableVitePluginOptions } from '@sentry/core';
import type { SentryVitePluginOptions } from '@sentry/vite-plugin';
import type { RouteData } from 'astro';

Expand All@@ -23,12 +24,16 @@ type SdkInitPaths = {
serverInitPath?: string;
};

/**
* @deprecated Move these options to the top-level of your Sentry configuration.
*/
type SourceMapsOptions = {
/**
* If this flag is `true`, and an auth token is detected, the Sentry integration will
* automatically generate and upload source maps to Sentry during a production build.
*
* @default true
* @deprecated Use `sourcemaps.disable` instead (with inverted logic)
*/
enabled?: boolean;

Expand All@@ -39,18 +44,24 @@ type SourceMapsOptions = {
*
* To create an auth token, follow this guide:
* @see https://docs.sentry.io/product/accounts/auth-tokens/#organization-auth-tokens
*
* @deprecated Use top-level `authToken` option instead
*/
authToken?: string;

/**
* The organization slug of your Sentry organization.
* Instead of specifying this option, you can also set the `SENTRY_ORG` environment variable.
*
* @deprecated Use top-level `org` option instead
*/
org?: string;

/**
* The project slug of your Sentry project.
* Instead of specifying this option, you can also set the `SENTRY_PROJECT` environment variable.
*
* @deprecated Use top-level `project` option instead
*/
project?: string;

Expand All@@ -59,6 +70,7 @@ type SourceMapsOptions = {
* It will not collect any sensitive or user-specific data.
*
* @default true
* @deprecated Use top-level `telemetry` option instead
*/
telemetry?: boolean;

Expand All@@ -71,6 +83,8 @@ type SourceMapsOptions = {
*
* The globbing patterns must follow the implementation of the `glob` package.
* @see https://www.npmjs.com/package/glob#glob-primer
*
* @deprecated Use `sourcemaps.assets` instead
*/
assets?: string | Array<string>;

Expand All@@ -81,6 +95,8 @@ type SourceMapsOptions = {
* @default [] - By default no files are deleted.
*
* The globbing patterns follow the implementation of the glob package. (https://www.npmjs.com/package/glob)
*
* @deprecated Use `sourcemaps.filesToDeleteAfterUpload` instead
*/
filesToDeleteAfterUpload?: string | Array<string>;

Expand All@@ -95,49 +111,10 @@ type SourceMapsOptions = {
* changes can occur at any time within a major SDK version.
*
* Furthermore, some options are untested with Astro specifically. Use with caution.
*/
unstable_sentryVitePluginOptions?: Partial<SentryVitePluginOptions>;
};

type BundleSizeOptimizationOptions = {
/**
* If set to `true`, the plugin will attempt to tree-shake (remove) any debugging code within the Sentry SDK.
* Note that the success of this depends on tree shaking being enabled in your build tooling.
*
* Setting this option to `true` will disable features like the SDK's `debug` option.
*/
excludeDebugStatements?: boolean;

/**
* If set to true, the plugin will try to tree-shake performance monitoring statements out.
* Note that the success of this depends on tree shaking generally being enabled in your build.
* Attention: DO NOT enable this when you're using any performance monitoring-related SDK features (e.g. Sentry.startSpan()).
*/
excludeTracing?: boolean;

/**
* If set to `true`, the plugin will attempt to tree-shake (remove) code related to the Sentry SDK's Session Replay Shadow DOM recording functionality.
* Note that the success of this depends on tree shaking being enabled in your build tooling.
*
* This option is safe to be used when you do not want to capture any Shadow DOM activity via Sentry Session Replay.
* @deprecated Use top-level `unstable_sentryVitePluginOptions` instead
*/
excludeReplayShadowDom?: boolean;

/**
* If set to `true`, the plugin will attempt to tree-shake (remove) code related to the Sentry SDK's Session Replay `iframe` recording functionality.
* Note that the success of this depends on tree shaking being enabled in your build tooling.
*
* You can safely do this when you do not want to capture any `iframe` activity via Sentry Session Replay.
*/
excludeReplayIframe?: boolean;

/**
* If set to `true`, the plugin will attempt to tree-shake (remove) code related to the Sentry SDK's Session Replay's Compression Web Worker.
* Note that the success of this depends on tree shaking being enabled in your build tooling.
*
* **Notice:** You should only do use this option if you manually host a compression worker and configure it in your Sentry Session Replay integration config via the `workerUrl` option.
*/
excludeReplayWorker?: boolean;
unstable_sentryVitePluginOptions?: Partial<SentryVitePluginOptions>;
};

type InstrumentationOptions = {
Expand DownExpand Up@@ -202,27 +179,23 @@ type DeprecatedRuntimeOptions = Record<string, unknown>;
*
* If you specify a dedicated init file, the SDK options passed to `sentryAstro` will be ignored.
*/
export type SentryOptions = SdkInitPaths &
export type SentryOptions = Omit<BuildTimeOptionsBase, 'release'> &
// todo(v11): `release` and `debug` need to be removed from BuildTimeOptionsBase as it is currently conflicting with `DeprecatedRuntimeOptions`
UnstableVitePluginOptions<SentryVitePluginOptions> &
SdkInitPaths &
InstrumentationOptions &
SdkEnabledOptions & {
/**
* Options for the Sentry Vite plugin to customize the source maps upload process.
*
* These options are always read from the `sentryAstro` integration.
* Do not define them in the `sentry.client.config.(js|ts)` or `sentry.server.config.(js|ts)` files.
*/
sourceMapsUploadOptions?: SourceMapsOptions;
/**
* Options for the Sentry Vite plugin to customize bundle size optimizations.
*
* These options are always read from the `sentryAstro` integration.
* Do not define them in the `sentry.client.config.(js|ts)` or `sentry.server.config.(js|ts)` files.
* @deprecated This option was deprecated. Please move the options to the top-level configuration.
* See the migration guide in the SourceMapsOptions type documentation.
*/
bundleSizeOptimizations?: BundleSizeOptimizationOptions;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Am I confused or did this disappear with the changes? 🤔

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is part of the shared type so it's possible to delete it here :)

bundleSizeOptimizations?: BundleSizeOptimizationsOptions;

/**
* If enabled, prints debug logs during the build process.
*/
debug?: boolean;
// eslint-disable-next-line deprecation/deprecation
sourceMapsUploadOptions?: SourceMapsOptions;
// eslint-disable-next-line deprecation/deprecation
} & DeprecatedRuntimeOptions;

Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion packages/astro/.eslintrc.cjs
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ module.exports = {
{
files: ['vite.config.ts'],
parserOptions: {
project: ['tsconfig.test.json'],
project: ['tsconfig.vite.json'],
},
},
],
Expand Down
58 changes: 46 additions & 12 deletions packages/astro/src/integration/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,8 +27,13 @@ export const sentryAstro = (options: SentryOptions = {}): AstroIntegration => {
clientInitPath,
serverInitPath,
autoInstrumentation,
// eslint-disable-next-line deprecation/deprecation
sourceMapsUploadOptions,
sourcemaps,
// todo(v11): Extract `release` build time option here - cannot be done currently, because it conflicts with the `DeprecatedRuntimeOptions` type
// release,
bundleSizeOptimizations,
unstable_sentryVitePluginOptions,

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: Sentry Vite Plugin Misinterprets Configuration Options

New top-level build-time options (e.g., org, project, authToken, sentryUrl, headers, telemetry, silent, errorHandler) are not destructured from the options object. This causes them to be incorrectly included in otherOptions, triggering a deprecation warning for 'additional options'. As a result, misleading warnings appear in production builds, despite these options being valid and used for Sentry Vite plugin configuration.

Fix in CursorFix in Web

debug,
...otherOptions
} = options;
Expand All@@ -48,8 +53,21 @@ export const sentryAstro = (options: SentryOptions = {}): AstroIntegration => {
};

const sourceMapsNeeded = sdkEnabled.client || sdkEnabled.server;
const { unstable_sentryVitePluginOptions, ...uploadOptions } = sourceMapsUploadOptions || {};
const shouldUploadSourcemaps = (sourceMapsNeeded && uploadOptions?.enabled) ?? true;
// eslint-disable-next-line deprecation/deprecation
const { unstable_sentryVitePluginOptions: deprecatedVitePluginOptions, ...uploadOptions } =
sourceMapsUploadOptions || {};

const unstableMerged_sentryVitePluginOptions = {
...deprecatedVitePluginOptions,
...unstable_sentryVitePluginOptions,
};

const shouldUploadSourcemaps =
(sourceMapsNeeded &&
sourcemaps?.disable !== true &&
// eslint-disable-next-line deprecation/deprecation
uploadOptions?.enabled) ??
true;

// We don't need to check for AUTH_TOKEN here, because the plugin will pick it up from the env
if (shouldUploadSourcemaps && command !== 'dev') {
Expand All@@ -58,7 +76,9 @@ export const sentryAstro = (options: SentryOptions = {}): AstroIntegration => {
let updatedFilesToDeleteAfterUpload: string[] | undefined = undefined;

if (
// eslint-disable-next-line deprecation/deprecation
typeof uploadOptions?.filesToDeleteAfterUpload === 'undefined' &&
typeof sourcemaps?.filesToDeleteAfterUpload === 'undefined' &&
computedSourceMapSettings.previousUserSourceMapSetting === 'unset'
) {
// This also works for adapters, as the source maps are also copied to e.g. the .vercel folder
Expand All@@ -79,26 +99,40 @@ export const sentryAstro = (options: SentryOptions = {}): AstroIntegration => {
},
plugins: [
sentryVitePlugin({
org: uploadOptions.org ?? env.SENTRY_ORG,
project: uploadOptions.project ?? env.SENTRY_PROJECT,
authToken: uploadOptions.authToken ?? env.SENTRY_AUTH_TOKEN,
telemetry: uploadOptions.telemetry ?? true,
// Priority: top-level options > deprecated options > env vars
// eslint-disable-next-line deprecation/deprecation
org: options.org ?? uploadOptions.org ?? env.SENTRY_ORG,
// eslint-disable-next-line deprecation/deprecation
project: options.project ?? uploadOptions.project ?? env.SENTRY_PROJECT,
// eslint-disable-next-line deprecation/deprecation
authToken: options.authToken ?? uploadOptions.authToken ?? env.SENTRY_AUTH_TOKEN,
url: options.sentryUrl ?? env.SENTRY_URL,
headers: options.headers,
// eslint-disable-next-line deprecation/deprecation
telemetry: options.telemetry ?? uploadOptions.telemetry ?? true,
silent: options.silent ?? false,
errorHandler: options.errorHandler,
_metaOptions: {
telemetry: {
metaFramework: 'astro',
},
},
...unstable_sentryVitePluginOptions,
debug: debug ?? false,
...unstableMerged_sentryVitePluginOptions,
debug: options.debug ?? false,
sourcemaps: {
assets: uploadOptions.assets ?? [getSourcemapsAssetsGlob(config)],
...options.sourcemaps,
// eslint-disable-next-line deprecation/deprecation
assets: sourcemaps?.assets ?? uploadOptions.assets ?? [getSourcemapsAssetsGlob(config)],
filesToDeleteAfterUpload:
uploadOptions?.filesToDeleteAfterUpload ?? updatedFilesToDeleteAfterUpload,
...unstable_sentryVitePluginOptions?.sourcemaps,
sourcemaps?.filesToDeleteAfterUpload ??
// eslint-disable-next-line deprecation/deprecation
uploadOptions?.filesToDeleteAfterUpload ??
updatedFilesToDeleteAfterUpload,
...unstableMerged_sentryVitePluginOptions?.sourcemaps,
},
bundleSizeOptimizations: {
...bundleSizeOptimizations,
...unstable_sentryVitePluginOptions?.bundleSizeOptimizations,
...unstableMerged_sentryVitePluginOptions?.bundleSizeOptimizations,
},
}),
],
Expand Down
79 changes: 26 additions & 53 deletions packages/astro/src/integration/types.ts
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import type { BuildTimeOptionsBase, UnstableVitePluginOptions } from '@sentry/core';
import type { SentryVitePluginOptions } from '@sentry/vite-plugin';
import type { RouteData } from 'astro';

Expand All@@ -23,12 +24,16 @@ type SdkInitPaths = {
serverInitPath?: string;
};

/**
* @deprecated Move these options to the top-level of your Sentry configuration.
*/
type SourceMapsOptions = {
/**
* If this flag is `true`, and an auth token is detected, the Sentry integration will
* automatically generate and upload source maps to Sentry during a production build.
*
* @default true
* @deprecated Use `sourcemaps.disable` instead (with inverted logic)
*/
enabled?: boolean;

Expand All@@ -39,18 +44,24 @@ type SourceMapsOptions = {
*
* To create an auth token, follow this guide:
* @see https://docs.sentry.io/product/accounts/auth-tokens/#organization-auth-tokens
*
* @deprecated Use top-level `authToken` option instead
*/
authToken?: string;

/**
* The organization slug of your Sentry organization.
* Instead of specifying this option, you can also set the `SENTRY_ORG` environment variable.
*
* @deprecated Use top-level `org` option instead
*/
org?: string;

/**
* The project slug of your Sentry project.
* Instead of specifying this option, you can also set the `SENTRY_PROJECT` environment variable.
*
* @deprecated Use top-level `project` option instead
*/
project?: string;

Expand All@@ -59,6 +70,7 @@ type SourceMapsOptions = {
* It will not collect any sensitive or user-specific data.
*
* @default true
* @deprecated Use top-level `telemetry` option instead
*/
telemetry?: boolean;

Expand All@@ -71,6 +83,8 @@ type SourceMapsOptions = {
*
* The globbing patterns must follow the implementation of the `glob` package.
* @see https://www.npmjs.com/package/glob#glob-primer
*
* @deprecated Use `sourcemaps.assets` instead
*/
assets?: string | Array<string>;

Expand All@@ -81,6 +95,8 @@ type SourceMapsOptions = {
* @default [] - By default no files are deleted.
*
* The globbing patterns follow the implementation of the glob package. (https://www.npmjs.com/package/glob)
*
* @deprecated Use `sourcemaps.filesToDeleteAfterUpload` instead
*/
filesToDeleteAfterUpload?: string | Array<string>;

Expand All@@ -95,49 +111,10 @@ type SourceMapsOptions = {
* changes can occur at any time within a major SDK version.
*
* Furthermore, some options are untested with Astro specifically. Use with caution.
*/
unstable_sentryVitePluginOptions?: Partial<SentryVitePluginOptions>;
};

type BundleSizeOptimizationOptions = {
/**
* If set to `true`, the plugin will attempt to tree-shake (remove) any debugging code within the Sentry SDK.
* Note that the success of this depends on tree shaking being enabled in your build tooling.
*
* Setting this option to `true` will disable features like the SDK's `debug` option.
*/
excludeDebugStatements?: boolean;

/**
* If set to true, the plugin will try to tree-shake performance monitoring statements out.
* Note that the success of this depends on tree shaking generally being enabled in your build.
* Attention: DO NOT enable this when you're using any performance monitoring-related SDK features (e.g. Sentry.startSpan()).
*/
excludeTracing?: boolean;

/**
* If set to `true`, the plugin will attempt to tree-shake (remove) code related to the Sentry SDK's Session Replay Shadow DOM recording functionality.
* Note that the success of this depends on tree shaking being enabled in your build tooling.
*
* This option is safe to be used when you do not want to capture any Shadow DOM activity via Sentry Session Replay.
* @deprecated Use top-level `unstable_sentryVitePluginOptions` instead
*/
excludeReplayShadowDom?: boolean;

/**
* If set to `true`, the plugin will attempt to tree-shake (remove) code related to the Sentry SDK's Session Replay `iframe` recording functionality.
* Note that the success of this depends on tree shaking being enabled in your build tooling.
*
* You can safely do this when you do not want to capture any `iframe` activity via Sentry Session Replay.
*/
excludeReplayIframe?: boolean;

/**
* If set to `true`, the plugin will attempt to tree-shake (remove) code related to the Sentry SDK's Session Replay's Compression Web Worker.
* Note that the success of this depends on tree shaking being enabled in your build tooling.
*
* **Notice:** You should only do use this option if you manually host a compression worker and configure it in your Sentry Session Replay integration config via the `workerUrl` option.
*/
excludeReplayWorker?: boolean;
unstable_sentryVitePluginOptions?: Partial<SentryVitePluginOptions>;
};

type InstrumentationOptions = {
Expand DownExpand Up@@ -202,27 +179,23 @@ type DeprecatedRuntimeOptions = Record<string, unknown>;
*
* If you specify a dedicated init file, the SDK options passed to `sentryAstro` will be ignored.
*/
export type SentryOptions = SdkInitPaths &
export type SentryOptions = Omit<BuildTimeOptionsBase, 'release'> &
// todo(v11): `release` and `debug` need to be removed from BuildTimeOptionsBase as it is currently conflicting with `DeprecatedRuntimeOptions`
UnstableVitePluginOptions<SentryVitePluginOptions> &
SdkInitPaths &
InstrumentationOptions &
SdkEnabledOptions & {
/**
* Options for the Sentry Vite plugin to customize the source maps upload process.
*
* These options are always read from the `sentryAstro` integration.
* Do not define them in the `sentry.client.config.(js|ts)` or `sentry.server.config.(js|ts)` files.
*/
sourceMapsUploadOptions?: SourceMapsOptions;
/**
* Options for the Sentry Vite plugin to customize bundle size optimizations.
*
* These options are always read from the `sentryAstro` integration.
* Do not define them in the `sentry.client.config.(js|ts)` or `sentry.server.config.(js|ts)` files.
* @deprecated This option was deprecated. Please move the options to the top-level configuration.
* See the migration guide in the SourceMapsOptions type documentation.
*/
bundleSizeOptimizations?: BundleSizeOptimizationOptions;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Am I confused or did this disappear with the changes? 🤔

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is part of the shared type so it's possible to delete it here :)

bundleSizeOptimizations?: BundleSizeOptimizationsOptions;

/**
* If enabled, prints debug logs during the build process.
*/
debug?: boolean;
// eslint-disable-next-line deprecation/deprecation
sourceMapsUploadOptions?: SourceMapsOptions;
// eslint-disable-next-line deprecation/deprecation
} & DeprecatedRuntimeOptions;

Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion packages/astro/.eslintrc.cjs
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ module.exports = {
{
files: ['vite.config.ts'],
parserOptions: {
project: ['tsconfig.test.json'],
project: ['tsconfig.vite.json'],
},
},
],
Expand Down
58 changes: 46 additions & 12 deletions packages/astro/src/integration/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,8 +27,13 @@ export const sentryAstro = (options: SentryOptions = {}): AstroIntegration => {
clientInitPath,
serverInitPath,
autoInstrumentation,
// eslint-disable-next-line deprecation/deprecation
sourceMapsUploadOptions,
sourcemaps,
// todo(v11): Extract `release` build time option here - cannot be done currently, because it conflicts with the `DeprecatedRuntimeOptions` type
// release,
bundleSizeOptimizations,
unstable_sentryVitePluginOptions,

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: Sentry Vite Plugin Misinterprets Configuration Options

New top-level build-time options (e.g., org, project, authToken, sentryUrl, headers, telemetry, silent, errorHandler) are not destructured from the options object. This causes them to be incorrectly included in otherOptions, triggering a deprecation warning for 'additional options'. As a result, misleading warnings appear in production builds, despite these options being valid and used for Sentry Vite plugin configuration.

Fix in CursorFix in Web

debug,
...otherOptions
} = options;
Expand All@@ -48,8 +53,21 @@ export const sentryAstro = (options: SentryOptions = {}): AstroIntegration => {
};

const sourceMapsNeeded = sdkEnabled.client || sdkEnabled.server;
const { unstable_sentryVitePluginOptions, ...uploadOptions } = sourceMapsUploadOptions || {};
const shouldUploadSourcemaps = (sourceMapsNeeded && uploadOptions?.enabled) ?? true;
// eslint-disable-next-line deprecation/deprecation
const { unstable_sentryVitePluginOptions: deprecatedVitePluginOptions, ...uploadOptions } =
sourceMapsUploadOptions || {};

const unstableMerged_sentryVitePluginOptions = {
...deprecatedVitePluginOptions,
...unstable_sentryVitePluginOptions,
};

const shouldUploadSourcemaps =
(sourceMapsNeeded &&
sourcemaps?.disable !== true &&
// eslint-disable-next-line deprecation/deprecation
uploadOptions?.enabled) ??
true;

// We don't need to check for AUTH_TOKEN here, because the plugin will pick it up from the env
if (shouldUploadSourcemaps && command !== 'dev') {
Expand All@@ -58,7 +76,9 @@ export const sentryAstro = (options: SentryOptions = {}): AstroIntegration => {
let updatedFilesToDeleteAfterUpload: string[] | undefined = undefined;

if (
// eslint-disable-next-line deprecation/deprecation
typeof uploadOptions?.filesToDeleteAfterUpload === 'undefined' &&
typeof sourcemaps?.filesToDeleteAfterUpload === 'undefined' &&
computedSourceMapSettings.previousUserSourceMapSetting === 'unset'
) {
// This also works for adapters, as the source maps are also copied to e.g. the .vercel folder
Expand All@@ -79,26 +99,40 @@ export const sentryAstro = (options: SentryOptions = {}): AstroIntegration => {
},
plugins: [
sentryVitePlugin({
org: uploadOptions.org ?? env.SENTRY_ORG,
project: uploadOptions.project ?? env.SENTRY_PROJECT,
authToken: uploadOptions.authToken ?? env.SENTRY_AUTH_TOKEN,
telemetry: uploadOptions.telemetry ?? true,
// Priority: top-level options > deprecated options > env vars
// eslint-disable-next-line deprecation/deprecation
org: options.org ?? uploadOptions.org ?? env.SENTRY_ORG,
// eslint-disable-next-line deprecation/deprecation
project: options.project ?? uploadOptions.project ?? env.SENTRY_PROJECT,
// eslint-disable-next-line deprecation/deprecation
authToken: options.authToken ?? uploadOptions.authToken ?? env.SENTRY_AUTH_TOKEN,
url: options.sentryUrl ?? env.SENTRY_URL,
headers: options.headers,
// eslint-disable-next-line deprecation/deprecation
telemetry: options.telemetry ?? uploadOptions.telemetry ?? true,
silent: options.silent ?? false,
errorHandler: options.errorHandler,
_metaOptions: {
telemetry: {
metaFramework: 'astro',
},
},
...unstable_sentryVitePluginOptions,
debug: debug ?? false,
...unstableMerged_sentryVitePluginOptions,
debug: options.debug ?? false,
sourcemaps: {
assets: uploadOptions.assets ?? [getSourcemapsAssetsGlob(config)],
...options.sourcemaps,
// eslint-disable-next-line deprecation/deprecation
assets: sourcemaps?.assets ?? uploadOptions.assets ?? [getSourcemapsAssetsGlob(config)],
filesToDeleteAfterUpload:
uploadOptions?.filesToDeleteAfterUpload ?? updatedFilesToDeleteAfterUpload,
...unstable_sentryVitePluginOptions?.sourcemaps,
sourcemaps?.filesToDeleteAfterUpload ??
// eslint-disable-next-line deprecation/deprecation
uploadOptions?.filesToDeleteAfterUpload ??
updatedFilesToDeleteAfterUpload,
...unstableMerged_sentryVitePluginOptions?.sourcemaps,
},
bundleSizeOptimizations: {
...bundleSizeOptimizations,
...unstable_sentryVitePluginOptions?.bundleSizeOptimizations,
...unstableMerged_sentryVitePluginOptions?.bundleSizeOptimizations,
},
}),
],
Expand Down
79 changes: 26 additions & 53 deletions packages/astro/src/integration/types.ts
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import type { BuildTimeOptionsBase, UnstableVitePluginOptions } from '@sentry/core';
import type { SentryVitePluginOptions } from '@sentry/vite-plugin';
import type { RouteData } from 'astro';

Expand All@@ -23,12 +24,16 @@ type SdkInitPaths = {
serverInitPath?: string;
};

/**
* @deprecated Move these options to the top-level of your Sentry configuration.
*/
type SourceMapsOptions = {
/**
* If this flag is `true`, and an auth token is detected, the Sentry integration will
* automatically generate and upload source maps to Sentry during a production build.
*
* @default true
* @deprecated Use `sourcemaps.disable` instead (with inverted logic)
*/
enabled?: boolean;

Expand All@@ -39,18 +44,24 @@ type SourceMapsOptions = {
*
* To create an auth token, follow this guide:
* @see https://docs.sentry.io/product/accounts/auth-tokens/#organization-auth-tokens
*
* @deprecated Use top-level `authToken` option instead
*/
authToken?: string;

/**
* The organization slug of your Sentry organization.
* Instead of specifying this option, you can also set the `SENTRY_ORG` environment variable.
*
* @deprecated Use top-level `org` option instead
*/
org?: string;

/**
* The project slug of your Sentry project.
* Instead of specifying this option, you can also set the `SENTRY_PROJECT` environment variable.
*
* @deprecated Use top-level `project` option instead
*/
project?: string;

Expand All@@ -59,6 +70,7 @@ type SourceMapsOptions = {
* It will not collect any sensitive or user-specific data.
*
* @default true
* @deprecated Use top-level `telemetry` option instead
*/
telemetry?: boolean;

Expand All@@ -71,6 +83,8 @@ type SourceMapsOptions = {
*
* The globbing patterns must follow the implementation of the `glob` package.
* @see https://www.npmjs.com/package/glob#glob-primer
*
* @deprecated Use `sourcemaps.assets` instead
*/
assets?: string | Array<string>;

Expand All@@ -81,6 +95,8 @@ type SourceMapsOptions = {
* @default [] - By default no files are deleted.
*
* The globbing patterns follow the implementation of the glob package. (https://www.npmjs.com/package/glob)
*
* @deprecated Use `sourcemaps.filesToDeleteAfterUpload` instead
*/
filesToDeleteAfterUpload?: string | Array<string>;

Expand All@@ -95,49 +111,10 @@ type SourceMapsOptions = {
* changes can occur at any time within a major SDK version.
*
* Furthermore, some options are untested with Astro specifically. Use with caution.
*/
unstable_sentryVitePluginOptions?: Partial<SentryVitePluginOptions>;
};

type BundleSizeOptimizationOptions = {
/**
* If set to `true`, the plugin will attempt to tree-shake (remove) any debugging code within the Sentry SDK.
* Note that the success of this depends on tree shaking being enabled in your build tooling.
*
* Setting this option to `true` will disable features like the SDK's `debug` option.
*/
excludeDebugStatements?: boolean;

/**
* If set to true, the plugin will try to tree-shake performance monitoring statements out.
* Note that the success of this depends on tree shaking generally being enabled in your build.
* Attention: DO NOT enable this when you're using any performance monitoring-related SDK features (e.g. Sentry.startSpan()).
*/
excludeTracing?: boolean;

/**
* If set to `true`, the plugin will attempt to tree-shake (remove) code related to the Sentry SDK's Session Replay Shadow DOM recording functionality.
* Note that the success of this depends on tree shaking being enabled in your build tooling.
*
* This option is safe to be used when you do not want to capture any Shadow DOM activity via Sentry Session Replay.
* @deprecated Use top-level `unstable_sentryVitePluginOptions` instead
*/
excludeReplayShadowDom?: boolean;

/**
* If set to `true`, the plugin will attempt to tree-shake (remove) code related to the Sentry SDK's Session Replay `iframe` recording functionality.
* Note that the success of this depends on tree shaking being enabled in your build tooling.
*
* You can safely do this when you do not want to capture any `iframe` activity via Sentry Session Replay.
*/
excludeReplayIframe?: boolean;

/**
* If set to `true`, the plugin will attempt to tree-shake (remove) code related to the Sentry SDK's Session Replay's Compression Web Worker.
* Note that the success of this depends on tree shaking being enabled in your build tooling.
*
* **Notice:** You should only do use this option if you manually host a compression worker and configure it in your Sentry Session Replay integration config via the `workerUrl` option.
*/
excludeReplayWorker?: boolean;
unstable_sentryVitePluginOptions?: Partial<SentryVitePluginOptions>;
};

type InstrumentationOptions = {
Expand DownExpand Up@@ -202,27 +179,23 @@ type DeprecatedRuntimeOptions = Record<string, unknown>;
*
* If you specify a dedicated init file, the SDK options passed to `sentryAstro` will be ignored.
*/
export type SentryOptions = SdkInitPaths &
export type SentryOptions = Omit<BuildTimeOptionsBase, 'release'> &
// todo(v11): `release` and `debug` need to be removed from BuildTimeOptionsBase as it is currently conflicting with `DeprecatedRuntimeOptions`
UnstableVitePluginOptions<SentryVitePluginOptions> &
SdkInitPaths &
InstrumentationOptions &
SdkEnabledOptions & {
/**
* Options for the Sentry Vite plugin to customize the source maps upload process.
*
* These options are always read from the `sentryAstro` integration.
* Do not define them in the `sentry.client.config.(js|ts)` or `sentry.server.config.(js|ts)` files.
*/
sourceMapsUploadOptions?: SourceMapsOptions;
/**
* Options for the Sentry Vite plugin to customize bundle size optimizations.
*
* These options are always read from the `sentryAstro` integration.
* Do not define them in the `sentry.client.config.(js|ts)` or `sentry.server.config.(js|ts)` files.
* @deprecated This option was deprecated. Please move the options to the top-level configuration.
* See the migration guide in the SourceMapsOptions type documentation.
*/
bundleSizeOptimizations?: BundleSizeOptimizationOptions;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Am I confused or did this disappear with the changes? 🤔

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is part of the shared type so it's possible to delete it here :)

bundleSizeOptimizations?: BundleSizeOptimizationsOptions;

/**
* If enabled, prints debug logs during the build process.
*/
debug?: boolean;
// eslint-disable-next-line deprecation/deprecation
sourceMapsUploadOptions?: SourceMapsOptions;
// eslint-disable-next-line deprecation/deprecation
} & DeprecatedRuntimeOptions;

Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion packages/astro/.eslintrc.cjs
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ module.exports = {
{
files: ['vite.config.ts'],
parserOptions: {
project: ['tsconfig.test.json'],
project: ['tsconfig.vite.json'],
},
},
],
Expand Down
58 changes: 46 additions & 12 deletions packages/astro/src/integration/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,8 +27,13 @@ export const sentryAstro = (options: SentryOptions = {}): AstroIntegration => {
clientInitPath,
serverInitPath,
autoInstrumentation,
// eslint-disable-next-line deprecation/deprecation
sourceMapsUploadOptions,
sourcemaps,
// todo(v11): Extract `release` build time option here - cannot be done currently, because it conflicts with the `DeprecatedRuntimeOptions` type
// release,
bundleSizeOptimizations,
unstable_sentryVitePluginOptions,

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: Sentry Vite Plugin Misinterprets Configuration Options

New top-level build-time options (e.g., org, project, authToken, sentryUrl, headers, telemetry, silent, errorHandler) are not destructured from the options object. This causes them to be incorrectly included in otherOptions, triggering a deprecation warning for 'additional options'. As a result, misleading warnings appear in production builds, despite these options being valid and used for Sentry Vite plugin configuration.

Fix in CursorFix in Web

debug,
...otherOptions
} = options;
Expand All@@ -48,8 +53,21 @@ export const sentryAstro = (options: SentryOptions = {}): AstroIntegration => {
};

const sourceMapsNeeded = sdkEnabled.client || sdkEnabled.server;
const { unstable_sentryVitePluginOptions, ...uploadOptions } = sourceMapsUploadOptions || {};
const shouldUploadSourcemaps = (sourceMapsNeeded && uploadOptions?.enabled) ?? true;
// eslint-disable-next-line deprecation/deprecation
const { unstable_sentryVitePluginOptions: deprecatedVitePluginOptions, ...uploadOptions } =
sourceMapsUploadOptions || {};

const unstableMerged_sentryVitePluginOptions = {
...deprecatedVitePluginOptions,
...unstable_sentryVitePluginOptions,
};

const shouldUploadSourcemaps =
(sourceMapsNeeded &&
sourcemaps?.disable !== true &&
// eslint-disable-next-line deprecation/deprecation
uploadOptions?.enabled) ??
true;

// We don't need to check for AUTH_TOKEN here, because the plugin will pick it up from the env
if (shouldUploadSourcemaps && command !== 'dev') {
Expand All@@ -58,7 +76,9 @@ export const sentryAstro = (options: SentryOptions = {}): AstroIntegration => {
let updatedFilesToDeleteAfterUpload: string[] | undefined = undefined;

if (
// eslint-disable-next-line deprecation/deprecation
typeof uploadOptions?.filesToDeleteAfterUpload === 'undefined' &&
typeof sourcemaps?.filesToDeleteAfterUpload === 'undefined' &&
computedSourceMapSettings.previousUserSourceMapSetting === 'unset'
) {
// This also works for adapters, as the source maps are also copied to e.g. the .vercel folder
Expand All@@ -79,26 +99,40 @@ export const sentryAstro = (options: SentryOptions = {}): AstroIntegration => {
},
plugins: [
sentryVitePlugin({
org: uploadOptions.org ?? env.SENTRY_ORG,
project: uploadOptions.project ?? env.SENTRY_PROJECT,
authToken: uploadOptions.authToken ?? env.SENTRY_AUTH_TOKEN,
telemetry: uploadOptions.telemetry ?? true,
// Priority: top-level options > deprecated options > env vars
// eslint-disable-next-line deprecation/deprecation
org: options.org ?? uploadOptions.org ?? env.SENTRY_ORG,
// eslint-disable-next-line deprecation/deprecation
project: options.project ?? uploadOptions.project ?? env.SENTRY_PROJECT,
// eslint-disable-next-line deprecation/deprecation
authToken: options.authToken ?? uploadOptions.authToken ?? env.SENTRY_AUTH_TOKEN,
url: options.sentryUrl ?? env.SENTRY_URL,
headers: options.headers,
// eslint-disable-next-line deprecation/deprecation
telemetry: options.telemetry ?? uploadOptions.telemetry ?? true,
silent: options.silent ?? false,
errorHandler: options.errorHandler,
_metaOptions: {
telemetry: {
metaFramework: 'astro',
},
},
...unstable_sentryVitePluginOptions,
debug: debug ?? false,
...unstableMerged_sentryVitePluginOptions,
debug: options.debug ?? false,
sourcemaps: {
assets: uploadOptions.assets ?? [getSourcemapsAssetsGlob(config)],
...options.sourcemaps,
// eslint-disable-next-line deprecation/deprecation
assets: sourcemaps?.assets ?? uploadOptions.assets ?? [getSourcemapsAssetsGlob(config)],
filesToDeleteAfterUpload:
uploadOptions?.filesToDeleteAfterUpload ?? updatedFilesToDeleteAfterUpload,
...unstable_sentryVitePluginOptions?.sourcemaps,
sourcemaps?.filesToDeleteAfterUpload ??
// eslint-disable-next-line deprecation/deprecation
uploadOptions?.filesToDeleteAfterUpload ??
updatedFilesToDeleteAfterUpload,
...unstableMerged_sentryVitePluginOptions?.sourcemaps,
},
bundleSizeOptimizations: {
...bundleSizeOptimizations,
...unstable_sentryVitePluginOptions?.bundleSizeOptimizations,
...unstableMerged_sentryVitePluginOptions?.bundleSizeOptimizations,
},
}),
],
Expand Down
79 changes: 26 additions & 53 deletions packages/astro/src/integration/types.ts
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import type { BuildTimeOptionsBase, UnstableVitePluginOptions } from '@sentry/core';
import type { SentryVitePluginOptions } from '@sentry/vite-plugin';
import type { RouteData } from 'astro';

Expand All@@ -23,12 +24,16 @@ type SdkInitPaths = {
serverInitPath?: string;
};

/**
* @deprecated Move these options to the top-level of your Sentry configuration.
*/
type SourceMapsOptions = {
/**
* If this flag is `true`, and an auth token is detected, the Sentry integration will
* automatically generate and upload source maps to Sentry during a production build.
*
* @default true
* @deprecated Use `sourcemaps.disable` instead (with inverted logic)
*/
enabled?: boolean;

Expand All@@ -39,18 +44,24 @@ type SourceMapsOptions = {
*
* To create an auth token, follow this guide:
* @see https://docs.sentry.io/product/accounts/auth-tokens/#organization-auth-tokens
*
* @deprecated Use top-level `authToken` option instead
*/
authToken?: string;

/**
* The organization slug of your Sentry organization.
* Instead of specifying this option, you can also set the `SENTRY_ORG` environment variable.
*
* @deprecated Use top-level `org` option instead
*/
org?: string;

/**
* The project slug of your Sentry project.
* Instead of specifying this option, you can also set the `SENTRY_PROJECT` environment variable.
*
* @deprecated Use top-level `project` option instead
*/
project?: string;

Expand All@@ -59,6 +70,7 @@ type SourceMapsOptions = {
* It will not collect any sensitive or user-specific data.
*
* @default true
* @deprecated Use top-level `telemetry` option instead
*/
telemetry?: boolean;

Expand All@@ -71,6 +83,8 @@ type SourceMapsOptions = {
*
* The globbing patterns must follow the implementation of the `glob` package.
* @see https://www.npmjs.com/package/glob#glob-primer
*
* @deprecated Use `sourcemaps.assets` instead
*/
assets?: string | Array<string>;

Expand All@@ -81,6 +95,8 @@ type SourceMapsOptions = {
* @default [] - By default no files are deleted.
*
* The globbing patterns follow the implementation of the glob package. (https://www.npmjs.com/package/glob)
*
* @deprecated Use `sourcemaps.filesToDeleteAfterUpload` instead
*/
filesToDeleteAfterUpload?: string | Array<string>;

Expand All@@ -95,49 +111,10 @@ type SourceMapsOptions = {
* changes can occur at any time within a major SDK version.
*
* Furthermore, some options are untested with Astro specifically. Use with caution.
*/
unstable_sentryVitePluginOptions?: Partial<SentryVitePluginOptions>;
};

type BundleSizeOptimizationOptions = {
/**
* If set to `true`, the plugin will attempt to tree-shake (remove) any debugging code within the Sentry SDK.
* Note that the success of this depends on tree shaking being enabled in your build tooling.
*
* Setting this option to `true` will disable features like the SDK's `debug` option.
*/
excludeDebugStatements?: boolean;

/**
* If set to true, the plugin will try to tree-shake performance monitoring statements out.
* Note that the success of this depends on tree shaking generally being enabled in your build.
* Attention: DO NOT enable this when you're using any performance monitoring-related SDK features (e.g. Sentry.startSpan()).
*/
excludeTracing?: boolean;

/**
* If set to `true`, the plugin will attempt to tree-shake (remove) code related to the Sentry SDK's Session Replay Shadow DOM recording functionality.
* Note that the success of this depends on tree shaking being enabled in your build tooling.
*
* This option is safe to be used when you do not want to capture any Shadow DOM activity via Sentry Session Replay.
* @deprecated Use top-level `unstable_sentryVitePluginOptions` instead
*/
excludeReplayShadowDom?: boolean;

/**
* If set to `true`, the plugin will attempt to tree-shake (remove) code related to the Sentry SDK's Session Replay `iframe` recording functionality.
* Note that the success of this depends on tree shaking being enabled in your build tooling.
*
* You can safely do this when you do not want to capture any `iframe` activity via Sentry Session Replay.
*/
excludeReplayIframe?: boolean;

/**
* If set to `true`, the plugin will attempt to tree-shake (remove) code related to the Sentry SDK's Session Replay's Compression Web Worker.
* Note that the success of this depends on tree shaking being enabled in your build tooling.
*
* **Notice:** You should only do use this option if you manually host a compression worker and configure it in your Sentry Session Replay integration config via the `workerUrl` option.
*/
excludeReplayWorker?: boolean;
unstable_sentryVitePluginOptions?: Partial<SentryVitePluginOptions>;
};

type InstrumentationOptions = {
Expand DownExpand Up@@ -202,27 +179,23 @@ type DeprecatedRuntimeOptions = Record<string, unknown>;
*
* If you specify a dedicated init file, the SDK options passed to `sentryAstro` will be ignored.
*/
export type SentryOptions = SdkInitPaths &
export type SentryOptions = Omit<BuildTimeOptionsBase, 'release'> &
// todo(v11): `release` and `debug` need to be removed from BuildTimeOptionsBase as it is currently conflicting with `DeprecatedRuntimeOptions`
UnstableVitePluginOptions<SentryVitePluginOptions> &
SdkInitPaths &
InstrumentationOptions &
SdkEnabledOptions & {
/**
* Options for the Sentry Vite plugin to customize the source maps upload process.
*
* These options are always read from the `sentryAstro` integration.
* Do not define them in the `sentry.client.config.(js|ts)` or `sentry.server.config.(js|ts)` files.
*/
sourceMapsUploadOptions?: SourceMapsOptions;
/**
* Options for the Sentry Vite plugin to customize bundle size optimizations.
*
* These options are always read from the `sentryAstro` integration.
* Do not define them in the `sentry.client.config.(js|ts)` or `sentry.server.config.(js|ts)` files.
* @deprecated This option was deprecated. Please move the options to the top-level configuration.
* See the migration guide in the SourceMapsOptions type documentation.
*/
bundleSizeOptimizations?: BundleSizeOptimizationOptions;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Am I confused or did this disappear with the changes? 🤔

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is part of the shared type so it's possible to delete it here :)

bundleSizeOptimizations?: BundleSizeOptimizationsOptions;

/**
* If enabled, prints debug logs during the build process.
*/
debug?: boolean;
// eslint-disable-next-line deprecation/deprecation
sourceMapsUploadOptions?: SourceMapsOptions;
// eslint-disable-next-line deprecation/deprecation
} & DeprecatedRuntimeOptions;

Expand Down
Loading
Loading