excludeServerRoutes for all APIs with prefix not working

[sujanbasnet1]

Hi there.

I'm trying to exclude all Next JS APIs from auto instrumentation with a prefix but it does not seem to work. If I specify individual routes then it does.

// https://docs.sentry.io/platforms/javascript/guides/nextjs/manual-setup/#opt-out-of-auto-instrumentation-on-specific-routes
const nextConfig = {
  sentry: {
    excludeServerRoutes: [
      "/api/test", // this works
      /^\/api/ // this does not
    ],
  },
};

[AbhiPrasad]

excludeServerRoutes needs to be an exact match. What about a regex like /^\/api\/\w*/?

[lforst]

The exact matching should only apply to string values:

sentry-javascript/packages/utils/src/string.ts

Lines 105 to 122 in aa459aa

	export function isMatchingPattern(
	value: string,
	pattern: RegExp | string,
	requireExactStringMatch: boolean = false,
	): boolean {
	if (!isString(value)) {
	return false;
	}
	if (isRegExp(pattern)) {
	return pattern.test(value);
	}
	if (isString(pattern)) {
	return requireExactStringMatch ? value === pattern : value.includes(pattern);
	}
	return false;
	}

@sujanbasnet1 are you using pages router or the new app router and in what way does it not work?

[sujanbasnet1]

Hi. Thank you for your responses. I'm bogged down with other things but will check your suggested pattern in a while @AbhiPrasad. BTW, I'm following the Sentry docs for prefix matching.

@lforst I'm using pages router. I'm using open-next and serverless stack to deploy my Next JS app in AWS. There's a bug right now where the API responses are empty when using Sentry. So for the time being I'm trying to exclude API routes.

In my example above the /api/test endpoint returns data but other endpoints do not. I got other endpoints working using exact string earlier but I've been making a lot of changes so I'll need to re-verify that.

[sujanbasnet1]

Hi again. I was wrapping the APIs with withSentry() which I guess is explicitly saying to include these routes, so excludingServerRoutes was perhaps ignored. The prefix pattern worked after I removed it. Thanks for the help folks.