Refactor generateFunctionId for enhanced flexibility and consistency. Update related types, remove legacy currentId, and streamline deduplication logic.

directive-functions-plugin does not generate functionIds anymore. This is the responsibility of the server-functions-plugin

Author: zenios

e2e/react-start/server-functions/vite.config.ts

@@ -4,8 +4,8 @@ import { tanstackStart } from '@tanstack/react-start/plugin/vite'
 import viteReact from '@vitejs/plugin-react'
 
 const FUNCTIONS_WITH_CONSTANT_ID = [
-  'src/routes/submit-post-formdata.tsx--greetUser_createServerFn_handler',
-  'src/routes/formdata-redirect/index.tsx--greetUser_createServerFn_handler',
+  'src/routes/submit-post-formdata.tsx/greetUser_createServerFn_handler',
+  'src/routes/formdata-redirect/index.tsx/greetUser_createServerFn_handler',
 ]
 
 export default defineConfig({
@@ -15,9 +15,9 @@ export default defineConfig({
     }),
     tanstackStart({
       serverFns: {
-        functionId: (opts) => {
-          if (FUNCTIONS_WITH_CONSTANT_ID.includes(opts.currentId))
-            return 'constant_id'
+        generateFunctionId: (opts) => {
+          const id = `${opts.filename}/${opts.functionName}`
+          if (FUNCTIONS_WITH_CONSTANT_ID.includes(id)) return 'constant_id'
           else return undefined
         },
       },

packages/directive-functions-plugin/src/compilers.ts

@@ -24,8 +24,9 @@ export type SupportedFunctionPath =
   | babel.NodePath<babel.types.ArrowFunctionExpression>
 
 export type GenerateFunctionIdFn = (opts: {
-  currentId: string
-}) => string | undefined
+  filename: string
+  functionName: string
+}) => string
 
 export type ReplacerFn = (opts: {
   fn: string
@@ -43,7 +44,7 @@ export type CompileDirectivesOpts = ParseAstOptions & {
   getRuntimeCode?: (opts: {
     directiveFnsById: Record<string, DirectiveFn>
   }) => string
-  generateFunctionId?: GenerateFunctionIdFn
+  generateFunctionId: GenerateFunctionIdFn
   replacer: ReplacerFn
   // devSplitImporter: string
   filename: string
@@ -219,7 +220,7 @@ export function findDirectives(
     directive: string
     directiveLabel: string
     replacer?: ReplacerFn
-    generateFunctionId?: GenerateFunctionIdFn
+    generateFunctionId: GenerateFunctionIdFn
     directiveSplitParam: string
     filename: string
     root: string
@@ -471,22 +472,10 @@ export function findDirectives(
     // Relative to have constant functionId regardless of the machine
     // that we are executing
     const relativeFilename = path.relative(opts.root, baseFilename)
-    let functionId = `${relativeFilename}--${functionName}`
-    if (opts.generateFunctionId) {
-      functionId =
-        opts.generateFunctionId({ currentId: functionId }) ?? functionId
-      // Handle cases in which the returned id conflicts with
-      // one of the already defined ids
-      if (functionId in directiveFnsById) {
-        let deduplicatedId
-        let iteration = 0
-        do {
-          deduplicatedId = `${functionId}_${++iteration}`
-        } while (deduplicatedId in directiveFnsById)
-        functionId = deduplicatedId
-      }
-    }
-
+    const functionId = opts.generateFunctionId({
+      filename: relativeFilename,
+      functionName: functionName,
+    })
     // If a replacer is provided, replace the function with the replacer
     if (opts.replacer) {
       const replacer = opts.replacer({

packages/directive-functions-plugin/src/index.ts

@@ -33,7 +33,7 @@ export type DirectiveFunctionsViteOptions = Pick<
 > &
   DirectiveFunctionsViteEnvOptions & {
     onDirectiveFnsById?: (directiveFnsById: Record<string, DirectiveFn>) => void
-    generateFunctionId?: GenerateFunctionIdFn
+    generateFunctionId: GenerateFunctionIdFn
   }
 
 const createDirectiveRx = (directive: string) =>
@@ -67,7 +67,7 @@ export type DirectiveFunctionsVitePluginEnvOptions = Pick<
     server: DirectiveFunctionsViteEnvOptions & { envName?: string }
   }
   onDirectiveFnsById?: (directiveFnsById: Record<string, DirectiveFn>) => void
-  generateFunctionId?: GenerateFunctionIdFn
+  generateFunctionId: GenerateFunctionIdFn
 }
 
 export function TanStackDirectiveFunctionsPluginEnv(

packages/server-functions-plugin/src/index.ts

@@ -12,14 +12,18 @@ import type {
 
 export type CreateRpcFn = (functionId: string, splitImportFn?: string) => any
 
+export type GenerateFunctionIdFnOptional = (
+  opts: Parameters<GenerateFunctionIdFn>[0],
+) => string | undefined
+
 export type ServerFnPluginOpts = {
   /**
    * The virtual import ID that will be used to import the server function manifest.
    * This virtual import ID will be used in the server build to import the manifest
    * and its modules.
    */
   manifestVirtualImportId: string
-  generateFunctionId?: GenerateFunctionIdFn
+  generateFunctionId?: GenerateFunctionIdFnOptional
   client: ServerFnPluginEnvOpts
   ssr: ServerFnPluginEnvOpts
   server: ServerFnPluginEnvOpts
@@ -282,39 +286,38 @@ function buildGenerateFunctionId(
     next: (dev: boolean, value?: string) => string,
   ) => string,
 ): GenerateFunctionIdFn {
-  const currentIdToGeneratedId = new Map<string, string>()
-  const generatedIds = new Set<string>()
+  const entryIdToFunctionId = new Map<string, string>()
+  const functionIds = new Set<string>()
   return (opts) => {
-    // Keep the previous id in case we already generated it. This is for consistency
-    // between client / server builds and hot reload
-    let generatedId = currentIdToGeneratedId.get(opts.currentId)
-    if (generatedId === undefined) {
-      generatedId = delegate(opts, (dev, newId) => {
+    const entryId = `${opts.filename}--${opts.functionName}`
+    let functionId = entryIdToFunctionId.get(entryId)
+    if (functionId === undefined) {
+      functionId = delegate(opts, (dev, updatedFunctionId) => {
         // If no value provided, then return the url-safe currentId on development
         // and SHA256 using the currentId as seed on production
-        if (newId === undefined) {
-          if (dev) newId = makeFunctionIdUrlSafe(opts.currentId)
+        if (updatedFunctionId === undefined) {
+          if (dev) updatedFunctionId = makeFunctionIdUrlSafe(entryId)
           else
-            newId = crypto
+            updatedFunctionId = crypto
               .createHash('sha256')
-              .update(opts.currentId)
+              .update(entryId)
               .digest('hex')
         }
-        return newId
+        return updatedFunctionId
       })
       // Deduplicate in case the generated id conflicts with an existing id
-      if (generatedIds.has(generatedId)) {
+      if (functionIds.has(functionId)) {
         let deduplicatedId
         let iteration = 0
         do {
-          deduplicatedId = `${generatedId}_${++iteration}`
-        } while (generatedIds.has(deduplicatedId))
-        generatedId = deduplicatedId
+          deduplicatedId = `${functionId}_${++iteration}`
+        } while (functionIds.has(deduplicatedId))
+        functionId = deduplicatedId
       }
-      currentIdToGeneratedId.set(opts.currentId, generatedId)
-      generatedIds.add(generatedId)
+      entryIdToFunctionId.set(entryId, functionId)
+      functionIds.add(functionId)
     }
-    return generatedId
+    return functionId
   }
 }
 

packages/start-plugin-core/src/schema.ts

@@ -163,7 +163,8 @@ const tanstackStartOptionsSchema = z
           .function()
           .args(
             z.object({
-              currentId: z.string(),
+              filename: z.string(),
+              functionName: z.string(),
             }),
           )
           .returns(z.string().optional())