Skip to content

ref(nextjs): Use common util to strip query params #3598

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
AbhiPrasad merged 2 commits into from
May 26, 2021
Merged

ref(nextjs): Use common util to strip query params #3598

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
d071573
ref(nextjs): Use common util to strip query params
AbhiPrasad May 25, 2021
1b98c10
remove query param regex
AbhiPrasad May 25, 2021
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
12 changes: 3 additions & 9 deletions packages/nextjs/src/performance/client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { Primitive, Transaction, TransactionContext } from '@sentry/types';
import { fill, getGlobalObject } from '@sentry/utils';
import { fill, getGlobalObject, stripUrlQueryAndFragment } from '@sentry/utils';
import { default as Router } from 'next/router';

const global = getGlobalObject<Window>();
Expand All @@ -10,8 +10,6 @@ const DEFAULT_TAGS = Object.freeze({
'routing.instrumentation': 'next-router',
});

const QUERY_PARAM_REGEX = /\?(.*)/;

let activeTransaction: Transaction | undefined = undefined;
let prevTransactionName: string | undefined = undefined;
let startTransaction: StartTransactionCb | undefined = undefined;
Expand All @@ -35,7 +33,7 @@ export function nextRouterInstrumentation(
// route name. Setting the transaction name after the transaction is started could lead
// to possible race conditions with the router, so this approach was taken.
if (startTransactionOnPageLoad) {
prevTransactionName = Router.route !== null ? removeQueryParams(Router.route) : global.location.pathname;
prevTransactionName = Router.route !== null ? stripUrlQueryAndFragment(Router.route) : global.location.pathname;
activeTransaction = startTransactionCb({
name: prevTransactionName,
op: 'pageload',
Expand Down Expand Up @@ -98,7 +96,7 @@ function changeStateWrapper(originalChangeStateWrapper: RouterChangeState): Wrap
if (prevTransactionName) {
tags.from = prevTransactionName;
}
prevTransactionName = removeQueryParams(url);
prevTransactionName = stripUrlQueryAndFragment(url);
activeTransaction = startTransaction({
name: prevTransactionName,
op: 'navigation',
Expand All @@ -109,7 +107,3 @@ function changeStateWrapper(originalChangeStateWrapper: RouterChangeState): Wrap
};
return wrapper;
}

export function removeQueryParams(route: string): string {
return route.replace(QUERY_PARAM_REGEX, '');
}
6 changes: 3 additions & 3 deletions packages/nextjs/src/utils/instrumentServer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { deepReadDirSync } from '@sentry/node';
import { extractTraceparentData, getActiveTransaction, hasTracingEnabled } from '@sentry/tracing';
import { Event as SentryEvent } from '@sentry/types';
import { fill, isString, logger } from '@sentry/utils';
import { fill, isString, logger, stripUrlQueryAndFragment } from '@sentry/utils';
import * as domain from 'domain';
import * as http from 'http';
import { default as createNextServer } from 'next';
Expand Down Expand Up @@ -208,7 +208,7 @@ function makeWrappedReqHandler(origReqHandler: ReqHandler): WrappedReqHandler {
}

// pull off query string, if any
const reqPath = req.url.split('?')[0];
const reqPath = stripUrlQueryAndFragment(req.url);

// requests for pages will only ever be GET requests, so don't bother to include the method in the transaction
// name; requests to API routes could be GET, POST, PUT, etc, so do include it there
Expand All @@ -218,7 +218,7 @@ function makeWrappedReqHandler(origReqHandler: ReqHandler): WrappedReqHandler {
{
name: `${namePrefix}${reqPath}`,
op: 'http.server',
metadata: { requestPath: req.url.split('?')[0] },
metadata: { requestPath: reqPath },
...traceparentData,
},
// extra context passed to the `tracesSampler`
Expand Down
16 changes: 1 addition & 15 deletions packages/nextjs/test/performance/client.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { default as Router } from 'next/router';

import { nextRouterInstrumentation, removeQueryParams } from '../../src/performance/client';
import { nextRouterInstrumentation } from '../../src/performance/client';

let readyCalled = false;
jest.mock('next/router', () => {
Expand Down Expand Up @@ -100,18 +100,4 @@ describe('client', () => {
});
});
});

describe('removeQueryParams()', () => {
it('removes query params from an url', () => {
const table: Table = [
{ in: '/posts/[id]/[comment]?name=ferret&color=purple', out: '/posts/[id]/[comment]' },
{ in: '/posts/[id]/[comment]?', out: '/posts/[id]/[comment]' },
{ in: '/about?', out: '/about' },
];

table.forEach(test => {
expect(removeQueryParams(test.in)).toEqual(test.out);
});
});
});
});