[legacy-framework] Next.js Fork Migration: Move query/mutation support into nextjs core

examples/auth/app/auth/mutations/forgotPassword.test.ts

@@ -8,8 +8,8 @@ beforeEach(async () => {
 })
 
 const generatedToken = "plain-token"
-jest.mock("@blitzjs/core/server", () => ({
-  ...jest.requireActual<object>("@blitzjs/core/server")!,
+jest.mock("next/stdlib-server", () => ({
+  ...jest.requireActual<object>("next/stdlib-server")!,
   generateToken: () => generatedToken,
 }))
 jest.mock("preview-email", () => jest.fn())

examples/store/app/products/queries/getProducts.ts

@@ -8,6 +8,15 @@ type GetProductsInput = {
   take?: number
 }
 
+export const middleware: Middleware[] = [
+  async (req, res, next) => {
+    await next()
+    if (req.method !== "HEAD" && Array.isArray(res.blitzResult)) {
+      console.log("[Middleware] Total product count:", res.blitzResult.length, "\n")
+    }
+  },
+]
+
 export default async function getProducts(
   {where, orderBy, skip = 0, take = 100}: GetProductsInput,
   ctx: Record<any, unknown> = {},
@@ -32,12 +41,3 @@ export default async function getProducts(
     count,
   }
 }
-
-export const middleware: Middleware[] = [
-  async (req, res, next) => {
-    await next()
-    if (req.method !== "HEAD" && Array.isArray(res.blitzResult)) {
-      console.log("[Middleware] Total product count:", res.blitzResult.length, "\n")
-    }
-  },
-]

nextjs/.eslintrc.json

@@ -193,7 +193,7 @@
     "no-obj-calls": "warn",
     "no-octal": "warn",
     "no-octal-escape": "warn",
-    "no-redeclare": ["warn", { "builtinGlobals": false }],
+    "no-redeclare": ["off"], //blitz
     "no-regex-spaces": "warn",
     "no-restricted-syntax": ["warn", "WithStatement"],
     "no-script-url": "warn",

nextjs/db.json

@@ -0,0 +1,8 @@
+{
+  "users": [
+    {
+      "id": 1
+    }
+  ],
+  "sessions": []
+}

nextjs/jest.config.js

@@ -1,5 +1,5 @@
 module.exports = {
-  testMatch: ['**/*.test.js'],
+  testMatch: ['**/*.test.js', '**/*.test.ts', '**/*.test.tsx'],
   verbose: true,
   rootDir: 'test',
   modulePaths: ['<rootDir>/lib'],

nextjs/lerna.json

@@ -1,19 +1,14 @@
 {
   "npmClient": "yarn",
   "useWorkspaces": true,
-  "packages": [
-    "packages/*"
-  ],
+  "packages": ["packages/*"],
   "command": {
     "version": {
       "exact": true
     },
     "publish": {
       "npmClient": "npm",
-      "allowBranch": [
-        "master",
-        "canary"
-      ],
+      "allowBranch": ["master", "canary"],
       "registry": "https://registry.npmjs.org/"
     }
   },

nextjs/packages/next/build/babel/loader/get-config.ts

@@ -6,7 +6,7 @@ import loadConfig from 'next/dist/compiled/babel/core-lib-config'
 
 import { NextBabelLoaderOptions, NextJsLoaderContext } from './types'
 import { consumeIterator } from './util'
-import { isPageFile as isPageFileFn } from '../../utils'
+import { getIsPageFile, getIsRpcFile } from '../../utils'
 
 const nextDistPath = /(next[\\/]dist[\\/]next-server[\\/]lib)|(next[\\/]dist[\\/]client)|(next[\\/]dist[\\/]pages)/
 
@@ -32,6 +32,7 @@ const nextDistPath = /(next[\\/]dist[\\/]next-server[\\/]lib)|(next[\\/]dist[\\/
 interface CharacteristicsGermaneToCaching {
   isServer: boolean
   isPageFile: boolean
+  isRpcFile: boolean
   isNextDist: boolean
   hasModuleExports: boolean
   fileExt: string
@@ -45,13 +46,16 @@ function getCacheCharacteristics(
 ): CharacteristicsGermaneToCaching {
   const { isServer, pagesDir } = loaderOptions
   const isNextDist = nextDistPath.test(filename)
-  const isPageFile = !isNextDist && isPageFileFn(filename.replace(pagesDir, ''))
+  const relativePathFromRoot = filename.replace(pagesDir, '')
+  const isPageFile = !isNextDist && getIsPageFile(relativePathFromRoot)
+  const isRpcFile = !isNextDist && getIsRpcFile(relativePathFromRoot)
   const hasModuleExports = source.indexOf('module.exports') !== -1
   const fileExt = fileExtensionRegex.exec(filename)?.[1] || 'unknown'
 
   return {
     isServer,
     isPageFile,
+    isRpcFile,
     isNextDist,
     hasModuleExports,
     fileExt,
@@ -69,6 +73,7 @@ function getPlugins(
   const {
     isServer,
     isPageFile,
+    isRpcFile,
     isNextDist,
     hasModuleExports,
   } = cacheCharacteristics
@@ -97,6 +102,18 @@ function getPlugins(
           type: 'plugin',
         })
       : null
+  const rpcClientConfigItem =
+    !isServer && isRpcFile
+      ? createConfigItem([require('../plugins/blitz-rpc-client')], {
+          type: 'plugin',
+        })
+      : null
+  const rpcServerTransformConfigItem =
+    isServer && isRpcFile
+      ? createConfigItem([require('../plugins/blitz-rpc-server-transform')], {
+          type: 'plugin',
+        })
+      : null
   const disallowExportAllItem =
     !isServer && isPageFile
       ? createConfigItem(
@@ -133,6 +150,8 @@ function getPlugins(
     noAnonymousDefaultExportItem,
     reactRefreshItem,
     pageConfigItem,
+    rpcClientConfigItem,
+    rpcServerTransformConfigItem,
     disallowExportAllItem,
     applyCommonJsItem,
     transformDefineItem,
@@ -158,7 +177,7 @@ function getCustomBabelConfig(configFilePath: string) {
     return require(configFilePath)
   }
   throw new Error(
-    'The Next.js Babel loader does not support .mjs or .cjs config files.'
+    'The Blitz.js Babel loader does not support .mjs or .cjs config files.'
   )
 }
 
@@ -290,6 +309,7 @@ function getCacheKey(cacheCharacteristics: CharacteristicsGermaneToCaching) {
   const {
     isServer,
     isPageFile,
+    isRpcFile,
     isNextDist,
     hasModuleExports,
     fileExt,
@@ -300,7 +320,8 @@ function getCacheKey(cacheCharacteristics: CharacteristicsGermaneToCaching) {
     (isServer ? 0b0001 : 0) |
     (isPageFile ? 0b0010 : 0) |
     (isNextDist ? 0b0100 : 0) |
-    (hasModuleExports ? 0b1000 : 0)
+    (hasModuleExports ? 0b1000 : 0) |
+    (isRpcFile ? 0b10000 : 0)
 
   return fileExt + flags
 }

nextjs/packages/next/build/babel/loader/types.d.ts

@@ -8,6 +8,7 @@ export interface NextJsLoaderContext extends loader.LoaderContext {
 export interface NextBabelLoaderOptions {
   hasJsxRuntime: boolean
   hasReactRefresh: boolean
+  pageExtensions: string[]
   isServer: boolean
   development: boolean
   pagesDir: string

nextjs/packages/next/build/babel/plugins/blitz-rpc-client.ts

@@ -0,0 +1,78 @@
+import { PluginObj } from 'next/dist/compiled/babel/core'
+import { BabelType } from 'babel-plugin-tester'
+import {
+  convertPageFilePathToRoutePath,
+  convertPageFilePathToResolverName,
+  convertPageFilePathToResolverType,
+} from '../../utils'
+
+/* This plugin changes the file contents to this:
+ *
+import { buildRpcClient } from "next/data-client";
+export default buildRpcClient({
+  "resolverName": "getUsers",
+  "resolverType": "query",
+  "routePath": "/api/rpc/getUsers"
+});
+ *
+*/
+
+// https://astexplorer.net/#/gist/02bab3c8f0488923346b607ed578e2f7/latest (may be out of date)
+
+const fileExtensionRegex = /\.([a-z]+)$/
+
+export default function blitzRpcClient(babel: BabelType): PluginObj {
+  const { types: t } = babel
+
+  return {
+    visitor: {
+      Program: {
+        enter(path, state) {
+          const { filename, cwd } = state
+          const fileExt = fileExtensionRegex.exec(filename)?.[1] || 'unknown'
+
+          const relativePathFromRoot = filename.replace(cwd, '')
+          const resolverName = convertPageFilePathToResolverName(
+            relativePathFromRoot
+          )
+          const resolverType = convertPageFilePathToResolverType(
+            relativePathFromRoot
+          )
+          const routePath = convertPageFilePathToRoutePath(
+            relativePathFromRoot,
+            [fileExt as string]
+          )
+
+          const importDeclaration = t.importDeclaration(
+            [
+              t.importSpecifier(
+                t.identifier('buildRpcClient'),
+                t.identifier('buildRpcClient')
+              ),
+            ],
+            t.stringLiteral('next/data-client')
+          )
+          const exportDeclaration = t.exportDefaultDeclaration(
+            t.callExpression(t.identifier('buildRpcClient'), [
+              t.objectExpression([
+                t.objectProperty(
+                  t.stringLiteral('resolverName'),
+                  t.stringLiteral(resolverName)
+                ),
+                t.objectProperty(
+                  t.stringLiteral('resolverType'),
+                  t.stringLiteral(resolverType)
+                ),
+                t.objectProperty(
+                  t.stringLiteral('routePath'),
+                  t.stringLiteral(routePath)
+                ),
+              ]),
+            ])
+          )
+          path.node.body = [importDeclaration, exportDeclaration]
+        },
+      },
+    },
+  }
+}