Skip to content

feat(tests): Inject @sentry/integrations bundles to Playwright templates #6666

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 9, 2023
Merged

feat(tests): Inject @sentry/integrations bundles to Playwright templates #6666

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5eb8c35
feat(tests): Inject `@sentry/integrations` bundles to Playwright test…
onurtemizkan Jan 5, 2023
c12781d
Fix `cjs` and `esm` bundle paths.
onurtemizkan Jan 5, 2023
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
6 changes: 0 additions & 6 deletions packages/integration-tests/suites/integrations/httpclient/fetch/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,6 @@ import { getFirstSentryEnvelopeRequest } from '../../../../utils/helpers';
sentryTest(
'should assign request and response context from a failed 500 fetch request',
async ({ getLocalTestPath, page }) => {
// Skipping this test when running in bundle mode, because `@sentry/integrations` bundle
// is not injected to the page with the current test setup.
if (process.env.PW_BUNDLE?.includes('bundle')) {
sentryTest.skip();
}

const url = await getLocalTestPath({ testDir: __dirname });

await page.route('**/foo', route => {
Expand Down
6 changes: 0 additions & 6 deletions packages/integration-tests/suites/integrations/httpclient/xhr/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,6 @@ import { getFirstSentryEnvelopeRequest } from '../../../../utils/helpers';
sentryTest(
'should assign request and response context from a failed 500 XHR request',
async ({ getLocalTestPath, page }) => {
// Skipping this test when running in bundle mode, because `@sentry/integrations` bundle
// is not injected to the page with the current test setup.
if (process.env.PW_BUNDLE?.includes('bundle')) {
sentryTest.skip();
}

const url = await getLocalTestPath({ testDir: __dirname });

await page.route('**/foo', route => {
Expand Down
39 changes: 33 additions & 6 deletions packages/integration-tests/utils/generatePlugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,14 @@ const BUNDLE_PATHS: Record<string, Record<string, string>> = {
bundle_es6: 'build/bundles/bundle.tracing.js',
bundle_es6_min: 'build/bundles/bundle.tracing.min.js',
},
integrations: {
cjs: 'build/npm/cjs/index.js',
esm: 'build/npm/esm/index.js',
bundle_es5: 'build/bundles/[INTEGRATION_NAME].es5.js',
bundle_es5_min: 'build/bundles/[INTEGRATION_NAME].es5.min.js',
bundle_es6: 'build/bundles/[INTEGRATION_NAME].js',
bundle_es6_min: 'build/bundles/[INTEGRATION_NAME].min.js',
},
};

/*
Expand Down Expand Up @@ -78,6 +86,7 @@ function generateSentryAlias(): Record<string, string> {

class SentryScenarioGenerationPlugin {
public requiresTracing: boolean = false;
public requiredIntegrations: string[] = [];

private _name: string = 'SentryScenarioGenerationPlugin';

Expand All @@ -89,18 +98,24 @@ class SentryScenarioGenerationPlugin {
// To help Webpack resolve Sentry modules in `import` statements in cases where they're provided in bundles rather than in `node_modules`
'@sentry/browser': 'Sentry',
'@sentry/tracing': 'Sentry',
'@sentry/integrations': 'Sentry.Integrations',
}
: {};

// Checking if the current scenario has imported `@sentry/tracing`.
// Checking if the current scenario has imported `@sentry/tracing` or `@sentry/integrations`.
compiler.hooks.normalModuleFactory.tap(this._name, factory => {
factory.hooks.parser.for('javascript/auto').tap(this._name, parser => {
// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
parser.hooks.import.tap(this._name, (_statement: unknown, source: string) => {
if (source === '@sentry/tracing') {
this.requiresTracing = true;
}
});
parser.hooks.import.tap(
this._name,
(statement: { specifiers: [{ imported: { name: string } }] }, source: string) => {
if (source === '@sentry/tracing') {
this.requiresTracing = true;
} else if (source === '@sentry/integrations') {
this.requiredIntegrations.push(statement.specifiers[0].imported.name.toLowerCase());
}
},
);
});
});

Expand All @@ -113,6 +128,18 @@ class SentryScenarioGenerationPlugin {
src: path.resolve(PACKAGES_DIR, bundleName, BUNDLE_PATHS[bundleName][bundleKey]),
});

this.requiredIntegrations.forEach(integration => {
const integrationObject = createHtmlTagObject('script', {
src: path.resolve(
PACKAGES_DIR,
'integrations',
BUNDLE_PATHS['integrations'][bundleKey].replace('[INTEGRATION_NAME]', integration),
),
});

data.assetTags.scripts.unshift(integrationObject);
});

data.assetTags.scripts.unshift(bundleObject);
}

Expand Down