fork of hey-api/openapi-ts because I need some additional things
Merge pull request #2885 from hey-api/refactor/selector-sdk
refactor: remove selectors from sdk plugin
+226
-140
+4
-1
.vscode/launch.json
+4
-1
.vscode/launch.json
···
16
16
"cwd": "${workspaceFolder}/dev",
17
17
"runtimeExecutable": "node",
18
18
"runtimeArgs": ["-r", "ts-node/register/transpile-only"],
19
-
"program": "${workspaceFolder}/packages/openapi-ts/src/run.ts"
19
+
"program": "${workspaceFolder}/packages/openapi-ts/src/run.ts",
20
+
"env": {
21
+
"DEBUG": "false"
22
+
}
20
23
}
21
24
]
22
25
}
+4
-4
dev/openapi-ts.config.ts
+4
-4
dev/openapi-ts.config.ts
···
40
40
// 'dutchie.json',
41
41
// 'invalid',
42
42
// 'openai.yaml',
43
-
'full.yaml',
43
+
// 'full.yaml',
44
44
// 'opencode.yaml',
45
-
// 'sdk-instance.yaml',
45
+
'sdk-instance.yaml',
46
46
// 'string-with-format.yaml',
47
47
// 'transformers.json',
48
48
// 'type-format.yaml',
···
214
214
{
215
215
// baseUrl: false,
216
216
// exportFromIndex: true,
217
-
name: '@hey-api/client-fetch',
217
+
// name: '@hey-api/client-fetch',
218
218
// name: 'legacy/angular',
219
219
// runtimeConfigPath: path.resolve(__dirname, 'hey-api.ts'),
220
220
// runtimeConfigPath: './src/hey-api.ts',
···
259
259
// fields.unwrap('path')
260
260
// },
261
261
// include...
262
-
// instance: true,
262
+
instance: true,
263
263
name: '@hey-api/sdk',
264
264
// operationId: false,
265
265
// params_EXPERIMENTAL: 'experiment',
+39
packages/codegen-core/src/__tests__/symbols.test.ts
+39
packages/codegen-core/src/__tests__/symbols.test.ts
···
230
230
expect(cacheKeys3.length).toBe(3);
231
231
expect(registry['queryCache'].get(cacheKeys3[2]!)).toEqual([]);
232
232
});
233
+
234
+
it('returns the same stub reference for identical unresolved meta', () => {
235
+
const registry = new SymbolRegistry();
236
+
237
+
const stubA1 = registry.reference({ a: 1 });
238
+
const stubA2 = registry.reference({ a: 1 });
239
+
240
+
// Same reference, not new instance
241
+
expect(stubA1).toBe(stubA2);
242
+
243
+
// Cache entry created by the internal query call
244
+
const cacheKey = registry['buildCacheKey']({ a: 1 });
245
+
expect(registry['queryCache'].has(cacheKey)).toBe(true);
246
+
expect(registry['queryCache'].get(cacheKey)).toEqual([]);
247
+
});
248
+
249
+
it('demonstrates stub addition does not invalidate unrelated cache', () => {
250
+
const registry = new SymbolRegistry();
251
+
252
+
// Create one indexed symbol and one query to seed cache
253
+
const symA = registry.register({ meta: { foo: 'bar' }, name: 'A' });
254
+
const resultFoo = registry.query({ foo: 'bar' });
255
+
expect(resultFoo).toEqual([symA]);
256
+
const cacheKeysBefore = Array.from(registry['queryCache'].keys());
257
+
expect(cacheKeysBefore.length).toBe(1);
258
+
259
+
// Add unrelated stub (its meta triggers its own query)
260
+
const stub = registry.reference({ something: 'else' });
261
+
expect(stub.meta).toEqual({ something: 'else' });
262
+
263
+
// Existing cache entry still present, plus one new entry for stub
264
+
const cacheKeysAfter = Array.from(registry['queryCache'].keys());
265
+
expect(cacheKeysAfter.length).toBe(cacheKeysBefore.length + 1);
266
+
expect(cacheKeysAfter).toEqual(expect.arrayContaining(cacheKeysBefore));
267
+
268
+
// The new stub isn't indexed, so query returns nothing yet
269
+
const newQuery = registry.query({ something: 'else' });
270
+
expect(newQuery).toEqual([]);
271
+
});
233
272
});
+7
packages/codegen-core/src/symbols/registry.ts
+7
packages/codegen-core/src/symbols/registry.ts
···
23
23
private registerOrder: Set<SymbolId> = new Set();
24
24
// TODO: remove after removing selectors
25
25
private selectorToId: Map<string, SymbolId> = new Map();
26
+
private stubCache: Map<QueryCacheKey, SymbolId> = new Map();
26
27
private stubs: Set<SymbolId> = new Set();
27
28
private values: Map<SymbolId, ISymbolOut> = new Map();
28
29
···
118
119
}
119
120
const [registered] = this.query(symbol.meta);
120
121
if (registered) return registered;
122
+
const cacheKey = this.buildCacheKey(symbol.meta);
123
+
const cachedId = this.stubCache.get(cacheKey);
124
+
if (cachedId !== undefined) return this.values.get(cachedId)!;
121
125
const id = this.id;
122
126
const stub: ISymbolOut = {
123
127
exportFrom: [],
···
127
131
};
128
132
this.values.set(stub.id, stub);
129
133
this.stubs.add(stub.id);
134
+
this.stubCache.set(cacheKey, stub.id);
130
135
return stub;
131
136
}
132
137
···
294
299
stub?.meta &&
295
300
this.isSubset(this.buildIndexKeySpace(stub.meta), indexKeySpace)
296
301
) {
302
+
const cacheKey = this.buildCacheKey(stub.meta);
303
+
this.stubCache.delete(cacheKey);
297
304
this.values.set(stubId, Object.assign(stub, symbol));
298
305
this.stubs.delete(stubId);
299
306
}
+1
packages/openapi-ts/src/index.ts
+1
packages/openapi-ts/src/index.ts
+10
-8
packages/openapi-ts/src/plugins/@angular/common/httpRequests.ts
+10
-8
packages/openapi-ts/src/plugins/@angular/common/httpRequests.ts
···
289
289
resource: '@angular/common/http.HttpRequest',
290
290
});
291
291
292
-
const sdkPlugin = plugin.getPluginOrThrow('@hey-api/sdk');
293
-
const symbolOptions = plugin.referenceSymbol(
294
-
sdkPlugin.api.selector('Options'),
295
-
);
292
+
const symbolOptions = plugin.referenceSymbol({
293
+
category: 'type',
294
+
resource: 'client-options',
295
+
tool: 'sdk',
296
+
});
296
297
297
298
const symbolDataType = plugin.querySymbol({
298
299
category: 'type',
···
349
350
resource: '@angular/common/http.HttpRequest',
350
351
});
351
352
352
-
const sdkPlugin = plugin.getPluginOrThrow('@hey-api/sdk');
353
-
const symbolOptions = plugin.referenceSymbol(
354
-
sdkPlugin.api.selector('Options'),
355
-
);
353
+
const symbolOptions = plugin.referenceSymbol({
354
+
category: 'type',
355
+
resource: 'client-options',
356
+
tool: 'sdk',
357
+
});
356
358
357
359
const symbolDataType = plugin.querySymbol({
358
360
category: 'type',
+10
-8
packages/openapi-ts/src/plugins/@angular/common/httpResources.ts
+10
-8
packages/openapi-ts/src/plugins/@angular/common/httpResources.ts
···
375
375
operation: IR.OperationObject;
376
376
plugin: AngularCommonPlugin['Instance'];
377
377
}) => {
378
-
const sdkPlugin = plugin.getPluginOrThrow('@hey-api/sdk');
379
-
const symbolOptions = plugin.referenceSymbol(
380
-
sdkPlugin.api.selector('Options'),
381
-
);
378
+
const symbolOptions = plugin.referenceSymbol({
379
+
category: 'type',
380
+
resource: 'client-options',
381
+
tool: 'sdk',
382
+
});
382
383
383
384
const symbolDataType = plugin.querySymbol({
384
385
category: 'type',
···
430
431
plugin: AngularCommonPlugin['Instance'];
431
432
symbol: Symbol;
432
433
}) => {
433
-
const sdkPlugin = plugin.getPluginOrThrow('@hey-api/sdk');
434
-
const symbolOptions = plugin.referenceSymbol(
435
-
sdkPlugin.api.selector('Options'),
436
-
);
434
+
const symbolOptions = plugin.referenceSymbol({
435
+
category: 'type',
436
+
resource: 'client-options',
437
+
tool: 'sdk',
438
+
});
437
439
438
440
const symbolDataType = plugin.querySymbol({
439
441
category: 'type',
+2
-38
packages/openapi-ts/src/plugins/@hey-api/sdk/api.ts
+2
-38
packages/openapi-ts/src/plugins/@hey-api/sdk/api.ts
···
1
-
import type { Selector } from '@hey-api/codegen-core';
2
-
3
-
import type { Plugin } from '~/plugins';
4
-
5
-
type SelectorType =
6
-
| 'buildClientParams'
7
-
| 'class'
8
-
| 'Client'
9
-
| 'Composable'
10
-
| 'formDataBodySerializer'
11
-
| 'function'
12
-
| 'Options'
13
-
| 'urlSearchParamsBodySerializer';
14
-
15
-
export type IApi = {
16
-
/**
17
-
* @param type Selector type.
18
-
* @param value Depends on `type`:
19
-
* - `buildClientParams`: never
20
-
* - `class`: current class name
21
-
* - `Client`: never
22
-
* - `Composable`: never
23
-
* - `formDataBodySerializer`: never
24
-
* - `function`: `operation.id` string
25
-
* - `Options`: never
26
-
* - `urlSearchParamsBodySerializer`: never
27
-
* @returns Selector array
28
-
* @deprecated
29
-
*/
30
-
selector: (type: SelectorType, value?: string) => Selector;
31
-
};
32
-
33
-
export class Api implements IApi {
34
-
constructor(public meta: Plugin.Name<'@hey-api/sdk'>) {}
1
+
export type IApi = any;
35
2
36
-
selector(...args: ReadonlyArray<string | undefined>): Selector {
37
-
return [this.meta.name, ...(args as Selector)];
38
-
}
39
-
}
3
+
export class Api implements IApi {}
+1
-3
packages/openapi-ts/src/plugins/@hey-api/sdk/config.ts
+1
-3
packages/openapi-ts/src/plugins/@hey-api/sdk/config.ts
+24
-9
packages/openapi-ts/src/plugins/@hey-api/sdk/v1/plugin.ts
+24
-9
packages/openapi-ts/src/plugins/@hey-api/sdk/v1/plugin.ts
···
8
8
9
9
export const handlerV1: HeyApiSdkPlugin['Handler'] = ({ plugin }) => {
10
10
const clientModule = clientFolderAbsolutePath(plugin.context.config);
11
+
const client = getClientPlugin(plugin.context.config);
12
+
const isAngularClient = client.name === '@hey-api/client-angular';
13
+
const isNuxtClient = client.name === '@hey-api/client-nuxt';
14
+
11
15
plugin.registerSymbol({
12
16
external: clientModule,
17
+
meta: {
18
+
category: 'external',
19
+
resource: 'client.formDataBodySerializer',
20
+
tool: client.name,
21
+
},
13
22
name: 'formDataBodySerializer',
14
-
selector: plugin.api.selector('formDataBodySerializer'),
15
23
});
16
24
plugin.registerSymbol({
17
25
external: clientModule,
26
+
meta: {
27
+
category: 'external',
28
+
resource: 'client.urlSearchParamsBodySerializer',
29
+
tool: client.name,
30
+
},
18
31
name: 'urlSearchParamsBodySerializer',
19
-
selector: plugin.api.selector('urlSearchParamsBodySerializer'),
20
32
});
21
33
plugin.registerSymbol({
22
34
external: clientModule,
35
+
meta: {
36
+
category: 'external',
37
+
resource: 'client.buildClientParams',
38
+
tool: client.name,
39
+
},
23
40
name: 'buildClientParams',
24
-
selector: plugin.api.selector('buildClientParams'),
25
41
});
26
-
27
-
const client = getClientPlugin(plugin.context.config);
28
-
const isAngularClient = client.name === '@hey-api/client-angular';
29
-
const isNuxtClient = client.name === '@hey-api/client-nuxt';
30
42
if (isNuxtClient) {
31
43
plugin.registerSymbol({
32
44
external: clientModule,
33
45
kind: 'type',
46
+
meta: {
47
+
category: 'external',
48
+
resource: 'client.Composable',
49
+
tool: client.name,
50
+
},
34
51
name: 'Composable',
35
-
selector: plugin.api.selector('Composable'),
36
52
});
37
53
}
38
-
39
54
if (isAngularClient && plugin.config.asClass) {
40
55
plugin.registerSymbol({
41
56
external: '@angular/core',
+11
-6
packages/openapi-ts/src/plugins/@pinia/colada/plugin.ts
+11
-6
packages/openapi-ts/src/plugins/@pinia/colada/plugin.ts
···
69
69
// as it's really easy to break once we change the class casing
70
70
entry
71
71
? [
72
-
plugin.referenceSymbol(
73
-
sdkPlugin.api.selector('class', entry.path[0]),
74
-
).placeholder,
72
+
plugin.referenceSymbol({
73
+
category: 'utility',
74
+
resource: 'class',
75
+
resourceId: entry.path[0],
76
+
tool: 'sdk',
77
+
}).placeholder,
75
78
...entry.path.slice(1).map((className: string) =>
76
79
stringCase({
77
80
case: 'camelCase',
···
82
85
]
83
86
.filter(Boolean)
84
87
.join('.')
85
-
: plugin.referenceSymbol(
86
-
sdkPlugin.api.selector('function', operation.id),
87
-
).placeholder;
88
+
: plugin.referenceSymbol({
89
+
category: 'sdk',
90
+
resource: 'operation',
91
+
resourceId: operation.id,
92
+
}).placeholder;
88
93
89
94
if (plugin.hooks.operation.isQuery(operation)) {
90
95
if (plugin.config.queryOptions.enabled) {
+10
-8
packages/openapi-ts/src/plugins/@pinia/colada/queryKey.ts
+10
-8
packages/openapi-ts/src/plugins/@pinia/colada/queryKey.ts
···
56
56
57
57
const baseUrlKey = getClientBaseUrlKey(plugin.context.config);
58
58
59
-
const sdkPlugin = plugin.getPluginOrThrow('@hey-api/sdk');
60
-
const symbolOptions = plugin.referenceSymbol(
61
-
sdkPlugin.api.selector('Options'),
62
-
);
59
+
const symbolOptions = plugin.referenceSymbol({
60
+
category: 'type',
61
+
resource: 'client-options',
62
+
tool: 'sdk',
63
+
});
63
64
const symbolClient = plugin.getSymbol({
64
65
category: 'client',
65
66
});
···
338
339
},
339
340
];
340
341
341
-
const sdkPlugin = plugin.getPluginOrThrow('@hey-api/sdk');
342
-
const symbolOptions = plugin.referenceSymbol(
343
-
sdkPlugin.api.selector('Options'),
344
-
);
342
+
const symbolOptions = plugin.referenceSymbol({
343
+
category: 'type',
344
+
resource: 'client-options',
345
+
tool: 'sdk',
346
+
});
345
347
const symbolQueryKeyType = plugin.registerSymbol({
346
348
exported: true,
347
349
kind: 'type',
+11
-6
packages/openapi-ts/src/plugins/@tanstack/query-core/plugin.ts
+11
-6
packages/openapi-ts/src/plugins/@tanstack/query-core/plugin.ts
···
93
93
// as it's really easy to break once we change the class casing
94
94
entry
95
95
? [
96
-
plugin.referenceSymbol(
97
-
sdkPlugin.api.selector('class', entry.path[0]),
98
-
).placeholder,
96
+
plugin.referenceSymbol({
97
+
category: 'utility',
98
+
resource: 'class',
99
+
resourceId: entry.path[0],
100
+
tool: 'sdk',
101
+
}).placeholder,
99
102
...entry.path.slice(1).map((className) =>
100
103
stringCase({
101
104
case: 'camelCase',
···
106
109
]
107
110
.filter(Boolean)
108
111
.join('.')
109
-
: plugin.referenceSymbol(
110
-
sdkPlugin.api.selector('function', operation.id),
111
-
).placeholder;
112
+
: plugin.referenceSymbol({
113
+
category: 'sdk',
114
+
resource: 'operation',
115
+
resourceId: operation.id,
116
+
}).placeholder;
112
117
113
118
if (plugin.hooks.operation.isQuery(operation)) {
114
119
if (plugin.config.queryOptions.enabled) {
+10
-8
packages/openapi-ts/src/plugins/@tanstack/query-core/queryKey.ts
+10
-8
packages/openapi-ts/src/plugins/@tanstack/query-core/queryKey.ts
···
55
55
category: 'client',
56
56
});
57
57
58
-
const sdkPlugin = plugin.getPluginOrThrow('@hey-api/sdk');
59
-
const symbolOptions = plugin.referenceSymbol(
60
-
sdkPlugin.api.selector('Options'),
61
-
);
58
+
const symbolOptions = plugin.referenceSymbol({
59
+
category: 'type',
60
+
resource: 'client-options',
61
+
tool: 'sdk',
62
+
});
62
63
63
64
const fn = tsc.constVariable({
64
65
expression: tsc.arrowFunction({
···
310
311
},
311
312
];
312
313
313
-
const sdkPlugin = plugin.getPluginOrThrow('@hey-api/sdk');
314
-
const symbolOptions = plugin.referenceSymbol(
315
-
sdkPlugin.api.selector('Options'),
316
-
);
314
+
const symbolOptions = plugin.referenceSymbol({
315
+
category: 'type',
316
+
resource: 'client-options',
317
+
tool: 'sdk',
318
+
});
317
319
const symbolQueryKeyType = plugin.registerSymbol({
318
320
exported: true,
319
321
kind: 'type',