Merge branch 'main' into server-error-ctx

blitz-js · Dec 15, 2023 · c25a9dd · c25a9dd
2 parents b2dcc43 + 86e8eb7
commit c25a9dd
Show file tree

Hide file tree

Showing 4 changed files with 56 additions and 7 deletions.
diff --git a/.changeset/cyan-rings-play.md b/.changeset/cyan-rings-play.md
@@ -0,0 +1,6 @@
+---
+"@blitzjs/rpc": patch
+"blitz": patch
+---
+
+Add helpful error message when RPC resolvers have the same path
diff --git a/packages/blitz-rpc/src/index-server.ts b/packages/blitz-rpc/src/index-server.ts
@@ -32,7 +32,13 @@ function getGlobalObject<T extends Record<string, unknown>>(key: string, default
 }
 
 type Resolver = (...args: unknown[]) => Promise<unknown>
-type ResolverFiles = Record<string, () => Promise<{default?: Resolver; config?: ResolverConfig}>>
+type ResolverFiles = Record<
+  string,
+  {
+    absoluteResolverPath: string
+    resolver: () => Promise<{default?: Resolver; config?: ResolverConfig}>
+  }
+>
 export type ResolverPathOptions = "queries|mutations" | "root" | ((path: string) => string)
 
 // We define `global.__internal_blitzRpcResolverFiles` to ensure we use the same global object.
@@ -50,10 +56,46 @@ export function loadBlitzRpcResolverFilesWithInternalMechanism() {
 
 export function __internal_addBlitzRpcResolver(
   routePath: string,
+  absoluteResolverPath: string,
   resolver: () => Promise<{default?: Resolver; config?: ResolverConfig}>,
 ) {
   g.blitzRpcResolverFilesLoaded = g.blitzRpcResolverFilesLoaded || {}
-  g.blitzRpcResolverFilesLoaded[routePath] = resolver
+  const existingResolver = g.blitzRpcResolverFilesLoaded[routePath]
+  if (existingResolver && existingResolver.absoluteResolverPath !== absoluteResolverPath) {
+    const logger = new RpcLogger(routePath)
+    const errorMessage = `\nThe following resolver files resolve to the same path: ${routePath}\n\n1.  ${absoluteResolverPath}\n2.  ${
+      existingResolver.absoluteResolverPath
+    }\n\nPossible Solutions:\n\n1. Remove or rename one of the resolver files. \n2. Set the following in your in next.config.js to load all resolvers using their absolute paths: 
+    \n\n//next.config.js\nblitz:{\n  resolverPath: "root",\n},\n
+    \n${
+      process.env.NODE_ENV === "production"
+        ? `Resolver in ${absoluteResolverPath} is currently being shadowed by ${existingResolver.absoluteResolverPath}`
+        : ""
+    }
+    `
+    logger.error(errorMessage)
+    if (process.env.NODE_ENV !== "production") {
+      g.blitzRpcResolverFilesLoaded[routePath] = {
+        absoluteResolverPath,
+        resolver: async () => {
+          return {
+            ...(await resolver()),
+            default: async () => {
+              const error = new Error(errorMessage)
+              error.name = "BlitzRPCResolverCollisionError"
+              error.stack = ""
+              throw error
+            },
+          }
+        },
+      }
+    }
+  } else {
+    g.blitzRpcResolverFilesLoaded[routePath] = {
+      absoluteResolverPath,
+      resolver,
+    }
+  }
   return resolver
 }
 
@@ -164,7 +206,7 @@ export function rpcHandler(config: RpcConfig) {
     const resolverName = routePath.replace(/(\/api\/rpc)?\//, "")
     const rpcLogger = new RpcLogger(resolverName, config.logging)
 
-    const loadableResolver = resolverMap?.[routePath]
+    const loadableResolver = resolverMap?.[routePath]?.resolver
     if (!loadableResolver) {
       throw new Error("No resolver for path: " + routePath)
     }
@@ -237,7 +279,7 @@ export function rpcHandler(config: RpcConfig) {
         return
       } catch (error: any) {
         if (error._clearStack) {
-          delete error.stack
+          error.stack = ""
         }
 
         config.onError?.(error, ctx)

diff --git a/packages/blitz-rpc/src/rpc-logger.ts b/packages/blitz-rpc/src/rpc-logger.ts
@@ -163,10 +163,11 @@ export class RpcLogger {
     newLine()
   }
   public error(e: any) {
-    if (typeof e === "string") {
+    if (typeof e === "string" || e instanceof Error) {
       this.#logger.error(e)
+    } else {
+      this.#logger.error(new Error(e))
     }
-    this.#logger.error(new Error(e))
     newLine()
   }
   public warn(e: string) {

diff --git a/packages/blitz-rpc/src/server/loader/server/loader-server.ts b/packages/blitz-rpc/src/server/loader/server/loader-server.ts
@@ -66,7 +66,7 @@ export async function transformBlitzRpcServer(
 
     const importStrategy = options?.resolversDynamicImport ? "import" : "require"
 
-    code += `__internal_addBlitzRpcResolver('${routePath}',() => ${importStrategy}('${slash(
+    code += `__internal_addBlitzRpcResolver('${routePath}','${resolverFilePath}',() => ${importStrategy}('${slash(
       resolverFilePath,
     )}'));`
     code += "\n"