combine withSentry.ts with withSentryAPI.ts

Author: lobsterkatie

packages/nextjs/src/config/templates/apiProxyLoaderTemplate.ts

@@ -13,7 +13,7 @@ import * as Sentry from '@sentry/nextjs';
 import type { PageConfig } from 'next';
 
 // We import this from `wrappers` rather than directly from `next` because our version can work simultaneously with
-// multiple versions of next. See note in `wrappers/withSentry` for more.
+// multiple versions of next. See note in `wrappers/types` for more.
 import type { NextApiHandler } from '../wrappers';
 
 type NextApiModule = {

packages/nextjs/src/config/wrappers/index.ts

@@ -1,10 +1,9 @@
-export type { AugmentedNextApiResponse, NextApiHandler, WrappedNextApiHandler } from './withSentry';
+export type { AugmentedNextApiResponse, NextApiHandler, WrappedNextApiHandler } from './types';
 
 export { withSentryGetStaticProps } from './withSentryGetStaticProps';
 export { withSentryServerSideGetInitialProps } from './withSentryServerSideGetInitialProps';
 export { withSentryServerSideAppGetInitialProps } from './withSentryServerSideAppGetInitialProps';
 export { withSentryServerSideDocumentGetInitialProps } from './withSentryServerSideDocumentGetInitialProps';
 export { withSentryServerSideErrorGetInitialProps } from './withSentryServerSideErrorGetInitialProps';
 export { withSentryGetServerSideProps } from './withSentryGetServerSideProps';
-export { withSentryAPI } from './withSentryAPI';
-export { withSentry } from './withSentry';
+export { withSentry, withSentryAPI } from './withSentryAPI';

packages/nextjs/src/config/wrappers/types.ts

@@ -0,0 +1,45 @@
+import type { Transaction } from '@sentry/types';
+import type { NextApiRequest, NextApiResponse } from 'next';
+
+// The `NextApiHandler` and `WrappedNextApiHandler` types are the same as the official `NextApiHandler` type, except:
+//
+// a) The wrapped version returns only promises, because wrapped handlers are always async.
+//
+// b) Instead of having a return types based on `void` (Next < 12.1.6) or `unknown` (Next 12.1.6+), both the wrapped and
+// unwrapped versions of the type have both. This doesn't matter to users, because they exist solely on one side of that
+// version divide or the other. For us, though, it's entirely possible to have one version of Next installed in our
+// local repo (as a dev dependency) and have another Next version installed in a test app which also has the local SDK
+// linked in.
+//
+// In that case, if those two versions are on either side of the 12.1.6 divide, importing the official `NextApiHandler`
+// type here would break the test app's build, because it would set up a situation in which the linked SDK's
+// `withSentry` would refer to one version of the type (from the local repo's `node_modules`) while any typed handler in
+// the test app would refer to the other version of the type (from the test app's `node_modules`). By using a custom
+// version of the type compatible with both the old and new official versions, we can use any Next version we want in a
+// test app without worrying about type errors.
+//
+// c) These have internal SDK flags which the official Next types obviously don't have, one to allow our auto-wrapping
+// function, `withSentryAPI`, to pass the parameterized route into `withSentry`, and the other to prevent a manually
+// wrapped route from being wrapped again by the auto-wrapper.
+
+export type NextApiHandler = {
+  __sentry_route__?: string;
+  (req: NextApiRequest, res: NextApiResponse): void | Promise<void> | unknown | Promise<unknown>;
+};
+
+export type WrappedNextApiHandler = {
+  __sentry_route__?: string;
+  __sentry_wrapped__?: boolean;
+  (req: NextApiRequest, res: NextApiResponse): Promise<void> | Promise<unknown>;
+};
+
+export type AugmentedNextApiRequest = NextApiRequest & {
+  __withSentry_applied__?: boolean;
+};
+
+export type AugmentedNextApiResponse = NextApiResponse & {
+  __sentryTransaction?: Transaction;
+};
+
+export type ResponseEndMethod = AugmentedNextApiResponse['end'];
+export type WrappedResponseEndMethod = AugmentedNextApiResponse['end'];