add proxy module template

Author: lobsterkatie

packages/nextjs/package.json

@@ -34,6 +34,7 @@
   },
   "devDependencies": {
     "@babel/types": "7.18.10",
+    "@sentry/nextjs": "7.11.1",
     "@types/jscodeshift": "^0.11.5",
     "@types/webpack": "^4.41.31",
     "next": "10.1.3"

packages/nextjs/rollup.npm.config.js

@@ -1,4 +1,4 @@
-import { makeBaseNPMConfig, makeNPMConfigVariants } from '../../rollup/index.js';
+import { makeBaseNPMConfig, makeNPMConfigVariants, plugins } from '../../rollup/index.js';
 
 export default [
   ...makeNPMConfigVariants(
@@ -16,10 +16,12 @@ export default [
     makeBaseNPMConfig({
       entrypoints: [
         'src/config/templates/prefixLoaderTemplate.ts',
+        'src/config/templates/proxyLoaderTemplate.ts',
         'src/config/templates/dataFetchersLoaderTemplate.ts',
       ],
 
       packageSpecificConfig: {
+        plugins: [plugins.makeRemoveMultiLineCommentsPlugin()],
         output: {
           // Preserve the original file structure (i.e., so that everything is still relative to `src`). (Not entirely
           // clear why this is necessary here and not for other entrypoints in this file.)
@@ -29,8 +31,11 @@ export default [
           // shouldn't have them, lest they muck with the module to which we're adding it)
           sourcemap: false,
           esModule: false,
+
+          // make it so Rollup calms down about the fact that we're combining default and named exports
+          exports: 'named',
         },
-        external: ['@sentry/nextjs'],
+        external: ['@sentry/nextjs', '__RESOURCE_PATH__'],
       },
     }),
   ),

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

@@ -0,0 +1,51 @@
+/**
+ * This file is a template for the code which will be substituted when our webpack loader handles non-API files in the
+ * `pages/` directory.
+ *
+ * We use `__RESOURCE_PATH__` as a placeholder for the path to the file being wrapped. Because it's not a real package,
+ * this causes both TS and ESLint to complain, hence the pragma comments below.
+ */
+
+// @ts-ignore See above
+// eslint-disable-next-line import/no-unresolved
+import * as wrapee from '__RESOURCE_PATH__';
+import * as Sentry from '@sentry/nextjs';
+import type { GetServerSideProps, GetStaticProps, NextPage as NextPageComponent } from 'next';
+
+type NextPageModule = {
+  default: { getInitialProps?: NextPageComponent['getInitialProps'] };
+  getStaticProps?: GetStaticProps;
+  getServerSideProps?: GetServerSideProps;
+};
+
+const userPageModule = wrapee as NextPageModule;
+
+const pageComponent = userPageModule.default;
+
+const origGetInitialProps = pageComponent.getInitialProps;
+const origGetStaticProps = userPageModule.getStaticProps;
+const origGetServerSideProps = userPageModule.getServerSideProps;
+
+if (typeof origGetInitialProps === 'function') {
+  pageComponent.getInitialProps = Sentry.withSentryGetInitialProps(
+    origGetInitialProps,
+    '__ROUTE__',
+  ) as NextPageComponent['getInitialProps'];
+}
+
+export const getStaticProps =
+  typeof origGetStaticProps === 'function'
+    ? Sentry.withSentryGetStaticProps(origGetStaticProps, '__ROUTE__')
+    : undefined;
+export const getServerSideProps =
+  typeof origGetServerSideProps === 'function'
+    ? Sentry.withSentryGetServerSideProps(origGetServerSideProps, '__ROUTE__')
+    : undefined;
+
+export default pageComponent;
+
+// Re-export anything exported by the page module we're wrapping. When processing this code, Rollup is smart enough to
+// not include anything whose name matchs something we've explicitly exported above.
+// @ts-ignore See above
+// eslint-disable-next-line import/no-unresolved
+export * from '__RESOURCE_PATH__';

packages/nextjs/tsconfig.types.json

@@ -1,6 +1,10 @@
 {
   "extends": "./tsconfig.json",
 
+  // Some of the templates for code we inject into a user's app include an import from `@sentry/nextjs`. This makes
+  // creating types for these template files a circular exercise, which causes `tsc` to crash. Fortunately, since the
+  // templates aren't consumed as modules (they're essentially just text files which happen to contain code), we don't
+  // actually need to create types for them.
   "exclude": ["src/config/templates/*"],
 
   "compilerOptions": {