fix: infer JSON serialization in static RPC dumps

Author: posva

docs/content/6.errors/DF0019.md

@@ -37,4 +37,4 @@ defineRpcFunction({
 
 ## Source
 
-- [`packages/devframe/src/rpc/collector.ts`](https://github.com/devframes/devframe/blob/main/packages/devframe/src/rpc/collector.ts): `RpcFunctionsCollectorBase.register()` throws `DF0019` when a definition combines `agent` with `jsonSerializable: false`.
+- [`packages/devframe/src/rpc/agent-json-serialization.ts`](https://github.com/devframes/devframe/blob/main/packages/devframe/src/rpc/agent-json-serialization.ts): `ensureAgentJsonSerializable()` throws `DF0019` when a definition combines `agent` with `jsonSerializable: false` during registration or static dump collection.

packages/devframe/src/rpc/agent-json-serialization.ts

@@ -0,0 +1,16 @@
+import type { RpcFunctionDefinitionAny } from './types'
+import { diagnostics } from './diagnostics'
+
+/**
+ * Prevents using a coding-agent-exposed RPC function that is explicitly
+ * marked as non-serializable, and marks these functions as serializable by
+ * default.
+ *
+ * @internal
+ */
+export function ensureAgentJsonSerializable(fnDef: RpcFunctionDefinitionAny): void {
+  if (fnDef.agent && fnDef.jsonSerializable === false)
+    throw diagnostics.DF0019({ name: fnDef.name })
+  if (fnDef.agent && !fnDef.jsonSerializable)
+    fnDef.jsonSerializable = true
+}

packages/devframe/src/rpc/collector.ts

@@ -1,4 +1,5 @@
 import type { RpcArgsSchema, RpcFunctionDefinition, RpcFunctionsCollector, RpcReturnSchema } from './types'
+import { ensureAgentJsonSerializable } from './agent-json-serialization'
 import { diagnostics } from './diagnostics'
 import { getRpcHandler } from './handler'
 
@@ -93,19 +94,3 @@ export class RpcFunctionsCollectorBase<
     return Array.from(this.definitions.keys())
   }
 }
-
-/**
- * Prevents registering an agent function that is explicitly marked as
- * non-serializable, and ensures that agent functions are marked as
- * serializable by default.
- *
- * @internal
- */
-function ensureAgentJsonSerializable(
-  fnDef: RpcFunctionDefinition<string, any, any, any, any, any, any>,
-): void {
-  if (fnDef.agent && fnDef.jsonSerializable === false)
-    throw diagnostics.DF0019({ name: fnDef.name })
-  if (fnDef.agent && !fnDef.jsonSerializable)
-    fnDef.jsonSerializable = true
-}

packages/devframe/src/rpc/dump/__tests__/static.test.ts

@@ -25,6 +25,26 @@ describe('collectStaticRpcDump', () => {
     expect(result.files[expectedPath]?.serialization).toBe('json')
   })
 
+  it('infers JSON serialization for directly collected coding-agent-exposed functions', async () => {
+    const getVersion = defineRpcFunction({
+      name: 'test:agent-version',
+      type: 'static',
+      agent: { description: 'Return the current version.' },
+      handler: () => '1.0.0',
+    })
+
+    const result = await collectStaticRpcDump([getVersion], {})
+    const expectedPath = `${DEVFRAME_RPC_DUMP_DIRNAME}/test~agent-version.static.json`
+
+    expect(getVersion.jsonSerializable).toBe(true)
+    expect(result.manifest['test:agent-version']).toEqual({
+      type: 'static',
+      path: expectedPath,
+      serialization: 'json',
+    })
+    expect(result.files[expectedPath]?.serialization).toBe('json')
+  })
+
   it('collects static rpc output into sharded file entries', async () => {
     const getVersion = defineRpcFunction({
       name: 'test:get-version',

packages/devframe/src/rpc/dump/static.ts

@@ -2,6 +2,7 @@ import type { RpcDumpRecord, RpcFunctionDefinitionAny } from '../types'
 import {
   DEVFRAME_RPC_DUMP_DIRNAME,
 } from 'devframe/constants'
+import { ensureAgentJsonSerializable } from '../agent-json-serialization'
 import { getRpcHandler } from '../handler'
 import { dumpFunctions } from './collect'
 
@@ -131,6 +132,7 @@ export async function collectStaticRpcDump(
   const files: Record<string, StaticRpcDumpFile> = {}
 
   for (const definition of definitions) {
+    ensureAgentJsonSerializable(definition)
     const type = definition.type ?? 'query'
     const serialization: StaticRpcDumpSerialization
       = definition.jsonSerializable === true ? 'json' : 'structured-clone'