Merge pull request #3635 from hey-api/copilot/fix-symbolonce-bug

fix: symbol() and symbolOnce() correctly deduplicate external symbols by name

Author: mrlubos

.changeset/rude-rules-fly.md

@@ -0,0 +1,6 @@
+---
+"@hey-api/openapi-ts": patch
+"@hey-api/shared": patch
+---
+
+**plugin**: fix: `symbolOnce()` method correctly handles multiple symbols with the same metadata

packages/codegen-core/src/__tests__/symbols.test.ts

@@ -106,4 +106,22 @@ describe('SymbolRegistry', () => {
     const result = r.query(meta({ a: { b: { c: 123 } } }));
     expect(result).toEqual([a]);
   });
+
+  it('query() returns all symbols sharing the same meta but with different names', () => {
+    const r = new SymbolRegistry();
+
+    const sharedMeta = meta({ category: 'external', resource: '@shared/types' });
+
+    const a = r.register({ meta: sharedMeta, name: 'CustomNumber' });
+    const b = r.register({ meta: sharedMeta, name: 'FlakeIdString' });
+
+    const results = r.query(sharedMeta);
+    expect(results).toHaveLength(2);
+    expect(results).toContain(a);
+    expect(results).toContain(b);
+
+    // filtering by name correctly identifies each symbol independently
+    expect(results.find((s) => s.name === 'CustomNumber')).toBe(a);
+    expect(results.find((s) => s.name === 'FlakeIdString')).toBe(b);
+  });
 });

packages/openapi-python/src/plugins/@hey-api/sdk/v1/plugin.ts

@@ -16,15 +16,13 @@ export const handlerV1: HeyApiSdkPlugin['Handler'] = ({ plugin }) => {
   plugin.symbol('build_client_params', {
     external: clientModule,
     meta: {
-      category: 'external',
       resource: 'client.build_client_params',
       tool: client.name,
     },
   });
   plugin.symbol('Client', {
     external: clientModule,
     meta: {
-      category: 'external',
       resource: 'client.Client',
       tool: client.name,
     },
@@ -33,26 +31,14 @@ export const handlerV1: HeyApiSdkPlugin['Handler'] = ({ plugin }) => {
   // functools
   plugin.symbol('cached_property', {
     external: 'functools',
-    meta: {
-      category: 'external',
-      resource: 'functools.cached_property',
-    },
   });
 
   // typing
   plugin.symbol('Any', {
     external: 'typing',
-    meta: {
-      category: 'external',
-      resource: 'typing.Any',
-    },
   });
   plugin.symbol('Union', {
     external: 'typing',
-    meta: {
-      category: 'external',
-      resource: 'typing.Union',
-    },
   });
 
   const structure = new StructureModel();

packages/openapi-python/src/plugins/pydantic/v2/plugin.ts

@@ -7,77 +7,37 @@ export const handlerV2: PydanticPlugin['Handler'] = ({ plugin }) => {
   // enum
   plugin.symbol('Enum', {
     external: 'enum',
-    meta: {
-      category: 'external',
-      resource: 'enum.Enum',
-    },
   });
 
   // typing
   plugin.symbol('Any', {
     external: 'typing',
-    meta: {
-      category: 'external',
-      resource: 'typing.Any',
-    },
   });
   plugin.symbol('Literal', {
     external: 'typing',
-    meta: {
-      category: 'external',
-      resource: 'typing.Literal',
-    },
   });
   plugin.symbol('NoReturn', {
     external: 'typing',
-    meta: {
-      category: 'external',
-      resource: 'typing.NoReturn',
-    },
   });
   plugin.symbol('Optional', {
     external: 'typing',
-    meta: {
-      category: 'external',
-      resource: 'typing.Optional',
-    },
   });
   plugin.symbol('TypeAlias', {
     external: 'typing',
-    meta: {
-      category: 'external',
-      resource: 'typing.TypeAlias',
-    },
   });
   plugin.symbol('Union', {
     external: 'typing',
-    meta: {
-      category: 'external',
-      resource: 'typing.Union',
-    },
   });
 
   // Pydantic
   plugin.symbol('BaseModel', {
     external: 'pydantic',
-    meta: {
-      category: 'external',
-      resource: 'pydantic.BaseModel',
-    },
   });
   plugin.symbol('ConfigDict', {
     external: 'pydantic',
-    meta: {
-      category: 'external',
-      resource: 'pydantic.ConfigDict',
-    },
   });
   plugin.symbol('Field', {
     external: 'pydantic',
-    meta: {
-      category: 'external',
-      resource: 'pydantic.Field',
-    },
   });
 
   const processor = createProcessor(plugin);

packages/openapi-ts/src/plugins/@angular/common/plugin.ts

@@ -17,31 +17,15 @@ export const handler: AngularCommonPlugin['Handler'] = ({ plugin }) => {
   plugin.symbol('HttpRequest', {
     external: '@angular/common/http',
     kind: 'type',
-    meta: {
-      category: 'external',
-      resource: '@angular/common/http.HttpRequest',
-    },
   });
   plugin.symbol('inject', {
     external: '@angular/core',
-    meta: {
-      category: 'external',
-      resource: '@angular/core.inject',
-    },
   });
   plugin.symbol('Injectable', {
     external: '@angular/core',
-    meta: {
-      category: 'external',
-      resource: '@angular/core.Injectable',
-    },
   });
   plugin.symbol('httpResource', {
     external: '@angular/common/http',
-    meta: {
-      category: 'external',
-      resource: '@angular/common/http.httpResource',
-    },
   });
 
   const httpRequestStructure = new StructureModel();

packages/openapi-ts/src/plugins/@hey-api/sdk/shared/typeOptions.ts

@@ -19,7 +19,6 @@ export const createTypeOptions = ({ plugin }: { plugin: HeyApiSdkPlugin['Instanc
     external: clientModule,
     kind: 'type',
     meta: {
-      category: 'external',
       resource: 'client.Client',
       tool: client.name,
     },

packages/openapi-ts/src/plugins/@hey-api/sdk/v1/plugin.ts

@@ -19,23 +19,20 @@ export const handlerV1: HeyApiSdkPlugin['Handler'] = ({ plugin }) => {
   plugin.symbol('formDataBodySerializer', {
     external: clientModule,
     meta: {
-      category: 'external',
       resource: 'client.formDataBodySerializer',
       tool: client.name,
     },
   });
   plugin.symbol('urlSearchParamsBodySerializer', {
     external: clientModule,
     meta: {
-      category: 'external',
       resource: 'client.urlSearchParamsBodySerializer',
       tool: client.name,
     },
   });
   plugin.symbol('buildClientParams', {
     external: clientModule,
     meta: {
-      category: 'external',
       resource: 'client.buildClientParams',
       tool: client.name,
     },
@@ -45,7 +42,6 @@ export const handlerV1: HeyApiSdkPlugin['Handler'] = ({ plugin }) => {
       external: clientModule,
       kind: 'type',
       meta: {
-        category: 'external',
         resource: 'client.Composable',
         tool: client.name,
       },
@@ -54,10 +50,6 @@ export const handlerV1: HeyApiSdkPlugin['Handler'] = ({ plugin }) => {
   if (isAngularClient) {
     plugin.symbol('Injectable', {
       external: '@angular/core',
-      meta: {
-        category: 'external',
-        resource: '@angular/core.Injectable',
-      },
     });
   }
 

packages/openapi-ts/src/plugins/@pinia/colada/queryKey.ts

@@ -47,10 +47,6 @@ export const createQueryKeyFunction = ({ plugin }: { plugin: PiniaColadaPlugin['
   const clientModule = clientFolderAbsolutePath(getTypedConfig(plugin));
   const symbolSerializeQueryValue = plugin.symbol('serializeQueryKeyValue', {
     external: clientModule,
-    meta: {
-      category: 'external',
-      resource: `${clientModule}.serializeQueryKeyValue`,
-    },
   });
 
   const fn = $.const(symbolCreateQueryKey).assign(

packages/openapi-ts/src/plugins/@pinia/colada/v0/plugin.ts

@@ -5,42 +5,22 @@ import type { PiniaColadaPlugin } from '../types';
 export const handlerV0: PiniaColadaPlugin['Handler'] = ({ plugin }) => {
   plugin.symbol('defineQueryOptions', {
     external: plugin.name,
-    meta: {
-      category: 'external',
-      resource: `${plugin.name}.defineQueryOptions`,
-    },
   });
   plugin.symbol('UseMutationOptions', {
     external: plugin.name,
     kind: 'type',
-    meta: {
-      category: 'external',
-      resource: `${plugin.name}.UseMutationOptions`,
-    },
   });
   plugin.symbol('UseQueryOptions', {
     external: plugin.name,
     kind: 'type',
-    meta: {
-      category: 'external',
-      resource: `${plugin.name}.UseQueryOptions`,
-    },
   });
   plugin.symbol('_JSONValue', {
     external: plugin.name,
     kind: 'type',
-    meta: {
-      category: 'external',
-      resource: `${plugin.name}._JSONValue`,
-    },
   });
   plugin.symbol('AxiosError', {
     external: 'axios',
     kind: 'type',
-    meta: {
-      category: 'external',
-      resource: 'axios.AxiosError',
-    },
   });
 
   plugin.forEach(

packages/openapi-ts/src/plugins/@tanstack/query-core/v5/plugin.ts

@@ -9,18 +9,10 @@ export const handlerV5: PluginHandler = ({ plugin }) => {
   plugin.symbol('DefaultError', {
     external: plugin.name,
     kind: 'type',
-    meta: {
-      category: 'external',
-      resource: `${plugin.name}.DefaultError`,
-    },
   });
   plugin.symbol('InfiniteData', {
     external: plugin.name,
     kind: 'type',
-    meta: {
-      category: 'external',
-      resource: `${plugin.name}.InfiniteData`,
-    },
   });
   const mutationsType =
     plugin.name === '@tanstack/angular-query-experimental' ||
@@ -32,45 +24,24 @@ export const handlerV5: PluginHandler = ({ plugin }) => {
     external: plugin.name,
     kind: 'type',
     meta: {
-      category: 'external',
       resource: `${plugin.name}.MutationOptions`,
     },
   });
   plugin.symbol('infiniteQueryOptions', {
     external: plugin.name,
-    meta: {
-      category: 'external',
-      resource: `${plugin.name}.infiniteQueryOptions`,
-    },
   });
   plugin.symbol('queryOptions', {
     external: plugin.name,
-    meta: {
-      category: 'external',
-      resource: `${plugin.name}.queryOptions`,
-    },
   });
   plugin.symbol('useMutation', {
     external: plugin.name,
-    meta: {
-      category: 'external',
-      resource: `${plugin.name}.useMutation`,
-    },
   });
   plugin.symbol('useQuery', {
     external: plugin.name,
-    meta: {
-      category: 'external',
-      resource: `${plugin.name}.useQuery`,
-    },
   });
   plugin.symbol('AxiosError', {
     external: 'axios',
     kind: 'type',
-    meta: {
-      category: 'external',
-      resource: 'axios.AxiosError',
-    },
   });
 
   plugin.forEach(