Skip to content
New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

fix(v8/feedback): Avoid lazy loading code for syncFeedbackIntegration #14918

Merged
merged 1 commit into from
Jan 7, 2025
Merged

fix(v8/feedback): Avoid lazy loading code for syncFeedbackIntegration #14918

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 0 additions & 2 deletions packages/browser/src/feedbackSync.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,9 @@ import {
feedbackModalIntegration,
feedbackScreenshotIntegration,
} from '@sentry-internal/feedback';
import { lazyLoadIntegration } from './utils/lazyLoadIntegration';

/** Add a widget to capture user feedback to your application. */
export const feedbackSyncIntegration = buildFeedbackIntegration({
lazyLoadIntegration,
getModalIntegration: () => feedbackModalIntegration,
getScreenshotIntegration: () => feedbackScreenshotIntegration,
});
85 changes: 43 additions & 42 deletions packages/feedback/src/core/integration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import type {
Integration,
IntegrationFn,
} from '@sentry/core';
import { getClient, isBrowser, logger } from '@sentry/core';
import { addIntegration, isBrowser, logger } from '@sentry/core';
import {
ADD_SCREENSHOT_LABEL,
CANCEL_BUTTON_LABEL,
Expand Down Expand Up @@ -39,16 +39,22 @@ type Unsubscribe = () => void;
* Allow users to capture user feedback and send it to Sentry.
*/

interface BuilderOptions {
// The type here should be `keyof typeof LazyLoadableIntegrations`, but that'll cause a cicrular
// dependency with @sentry/core
lazyLoadIntegration: (
name: 'feedbackModalIntegration' | 'feedbackScreenshotIntegration',
scriptNonce?: string,
) => Promise<IntegrationFn>;
getModalIntegration?: null | (() => IntegrationFn);
getScreenshotIntegration?: null | (() => IntegrationFn);
}
type BuilderOptions =
| {
lazyLoadIntegration?: never;
getModalIntegration: () => IntegrationFn;
getScreenshotIntegration: () => IntegrationFn;
}
| {
// The type here should be `keyof typeof LazyLoadableIntegrations`, but that'll cause a cicrular
// dependency with @sentry/core
lazyLoadIntegration: (
name: 'feedbackModalIntegration' | 'feedbackScreenshotIntegration',
scriptNonce?: string,
) => Promise<IntegrationFn>;
getModalIntegration?: never;
getScreenshotIntegration?: never;
};

export const buildFeedbackIntegration = ({
lazyLoadIntegration,
Expand Down Expand Up @@ -172,45 +178,40 @@ export const buildFeedbackIntegration = ({
return _shadow as ShadowRoot;
};

const _findIntegration = async <I extends Integration>(
integrationName: string,
getter: undefined | null | (() => IntegrationFn),
functionMethodName: 'feedbackModalIntegration' | 'feedbackScreenshotIntegration',
): Promise<I> => {
const client = getClient();
const existing = client && client.getIntegrationByName(integrationName);
if (existing) {
return existing as I;
}
const integrationFn = (getter && getter()) || (await lazyLoadIntegration(functionMethodName, scriptNonce));
const integration = integrationFn();
client && client.addIntegration(integration);
return integration as I;
};

const _loadAndRenderDialog = async (
options: FeedbackInternalOptions,
): Promise<ReturnType<FeedbackModalIntegration['createDialog']>> => {
const screenshotRequired = options.enableScreenshot && isScreenshotSupported();
const [modalIntegration, screenshotIntegration] = await Promise.all([
_findIntegration<FeedbackModalIntegration>('FeedbackModal', getModalIntegration, 'feedbackModalIntegration'),
screenshotRequired
? _findIntegration<FeedbackScreenshotIntegration>(
'FeedbackScreenshot',
getScreenshotIntegration,
'feedbackScreenshotIntegration',
)
: undefined,
]);
if (!modalIntegration) {
// TODO: Let the end-user retry async loading

let modalIntegration: FeedbackModalIntegration;
let screenshotIntegration: FeedbackScreenshotIntegration | undefined;

try {
const modalIntegrationFn = getModalIntegration
? getModalIntegration()
: await lazyLoadIntegration('feedbackModalIntegration', scriptNonce);
modalIntegration = modalIntegrationFn() as FeedbackModalIntegration;
addIntegration(modalIntegration);
} catch {
DEBUG_BUILD &&
logger.error(
'[Feedback] Missing feedback modal integration. Try using `feedbackSyncIntegration` in your `Sentry.init`.',
'[Feedback] Error when trying to load feedback integrations. Try using `feedbackSyncIntegration` in your `Sentry.init`.',
);
throw new Error('[Feedback] Missing feedback modal integration!');
}
if (screenshotRequired && !screenshotIntegration) {

try {
const screenshotIntegrationFn = screenshotRequired
? getScreenshotIntegration
? getScreenshotIntegration()
: await lazyLoadIntegration('feedbackScreenshotIntegration', scriptNonce)
: undefined;

if (screenshotIntegrationFn) {
screenshotIntegration = screenshotIntegrationFn() as FeedbackScreenshotIntegration;
addIntegration(screenshotIntegration);
}
} catch {
DEBUG_BUILD &&
logger.error('[Feedback] Missing feedback screenshot integration. Proceeding without screenshots.');
}
Expand All @@ -227,7 +228,7 @@ export const buildFeedbackIntegration = ({
options.onFormSubmitted && options.onFormSubmitted();
},
},
screenshotIntegration: screenshotRequired ? screenshotIntegration : undefined,
screenshotIntegration,
sendFeedback,
shadow: _createShadow(options),
});
Expand Down
Loading