Repository navigation
Expand file tree
/
Copy pathgenerator.test.ts
More file actions
610 lines (569 loc) · 21.2 KB
/
Copy pathgenerator.test.ts
File metadata and controls
610 lines (569 loc) · 21.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
import { describe, expect, it } from 'vitest'
import { z } from 'zod'
import { defineRouteContract } from '../../apps/sim/lib/api/contracts/types'
import { billingOpenApiDocument } from '../../apps/sim/lib/api/contracts/v2/openapi/billing'
import { filesAuditOpenApiDocument } from '../../apps/sim/lib/api/contracts/v2/openapi/files-audit'
import {
defineOpenApiDocument,
defineOpenApiRoute,
type OpenApiOperationMetadata,
type OpenApiRouteDefinition,
} from '../../apps/sim/lib/api/openapi/types'
import {
contractPathToOpenApi,
generateOpenApiDocument,
serializeOpenApiDocument,
} from './generator'
type JsonObject = Record<string, unknown>
const ERROR_SCHEMA = z
.object({
error: z
.object({
code: z.string().describe('Machine-readable error code.'),
message: z.string().describe('Human-readable error message.'),
})
.describe('Canonical error details.'),
})
.meta({
id: 'TestError',
title: 'Test error',
description: 'Canonical test error envelope.',
})
const LOCATION_HEADER_SCHEMA = z.string().meta({
id: 'LocationHeader',
title: 'Location',
description: 'Redirect target URL.',
})
function operation(
operationId: string,
success: OpenApiOperationMetadata['success']
): OpenApiOperationMetadata {
return {
operationId,
summary: `Summary for ${operationId}`,
description: `Description for ${operationId}.`,
tags: ['Tests'],
errors: ['Unauthorized', 'RateLimited'],
success,
}
}
function document(routes: readonly OpenApiRouteDefinition[]) {
return defineOpenApiDocument({
output: 'unused.json',
info: {
title: 'Generator test',
description: 'Generator test document.',
version: '1.0.0',
},
servers: [{ url: 'https://example.com', description: 'Test' }],
tags: [{ name: 'Tests', description: 'Generator test operations.' }],
security: [{ apiKey: [] }],
securitySchemes: {
apiKey: {
type: 'apiKey',
in: 'header',
name: 'X-API-Key',
description: 'Test API key.',
},
},
headers: { Location: { schema: LOCATION_HEADER_SCHEMA } },
errorSchema: ERROR_SCHEMA,
errorResponses: {
Unauthorized: { status: 401, description: 'Unauthorized.' },
RateLimited: { status: 429, description: 'Rate limited.' },
},
routes,
})
}
function getOperation(spec: JsonObject, path: string, method: string): JsonObject {
const paths = spec.paths as JsonObject
return (paths[path] as JsonObject)[method] as JsonObject
}
describe('OpenAPI generator', () => {
it('converts contract path parameters', () => {
expect(contractPathToOpenApi('/api/v2/files/[fileId]/parts/[partId]')).toBe(
'/api/v2/files/{fileId}/parts/{partId}'
)
})
it('uses input schemas for requests and output schemas for responses', () => {
const params = z
.object({ id: z.string().describe('Resource identifier.') })
.meta({ id: 'TransformParams', title: 'Transform params', description: 'Path parameters.' })
const body = z
.object({
value: z
.string()
.transform((value) => value.length)
.describe('String input.'),
})
.meta({ id: 'TransformRequest', title: 'Transform request', description: 'Request body.' })
const response = z
.object({
value: z
.string()
.transform((value) => value.length)
.pipe(z.number())
.describe('Numeric output.'),
})
.meta({
id: 'TransformResponse',
title: 'Transform response',
description: 'Response body.',
deprecated: true,
})
const contract = defineRouteContract({
method: 'POST',
path: '/items/[id]',
params,
body,
response: { mode: 'json', schema: response, status: 201 },
})
const route = defineOpenApiRoute(
contract,
{ ...operation('transformItem', { description: 'Transformed item.' }), deprecated: true },
{ params, body, response }
)
const spec = generateOpenApiDocument(document([route]))
const schemas = (spec.components as JsonObject).schemas as JsonObject
const requestProperties = (schemas.TransformRequest as JsonObject).properties as JsonObject
const responseProperties = (schemas.TransformResponse as JsonObject).properties as JsonObject
expect((requestProperties.value as JsonObject).type).toBe('string')
expect((responseProperties.value as JsonObject).type).toBe('number')
expect(schemas.TransformResponse).toHaveProperty('deprecated', true)
expect(getOperation(spec, '/items/{id}', 'post')).toMatchObject({
deprecated: true,
responses: { '201': expect.any(Object) },
})
})
it('handles every route response mode and media type', () => {
const emptyContract = defineRouteContract({
method: 'DELETE',
path: '/empty',
response: { mode: 'empty', status: 204 },
})
const textContract = defineRouteContract({
method: 'GET',
path: '/text',
response: { mode: 'text' },
})
const binaryContract = defineRouteContract({
method: 'GET',
path: '/binary',
response: { mode: 'binary' },
})
const streamContract = defineRouteContract({
method: 'GET',
path: '/stream',
response: { mode: 'stream' },
})
const redirectContract = defineRouteContract({
method: 'GET',
path: '/redirect',
response: { mode: 'redirect', status: 302 },
})
const spec = generateOpenApiDocument(
document([
defineOpenApiRoute(emptyContract, operation('empty', { description: 'No content.' }), {}),
defineOpenApiRoute(
textContract,
operation('text', { description: 'Text.', contentTypes: ['text/plain'] }),
{}
),
defineOpenApiRoute(
binaryContract,
operation('binary', {
description: 'Binary.',
contentTypes: ['application/pdf'],
}),
{}
),
defineOpenApiRoute(
streamContract,
operation('stream', {
description: 'Stream.',
contentTypes: ['text/event-stream'],
}),
{}
),
defineOpenApiRoute(
redirectContract,
operation('redirect', { description: 'Redirect.', headers: ['Location'] }),
{}
),
])
)
const emptyResponse = (getOperation(spec, '/empty', 'delete').responses as JsonObject)[
'204'
] as JsonObject
const textResponse = (getOperation(spec, '/text', 'get').responses as JsonObject)[
'200'
] as JsonObject
const binaryResponse = (getOperation(spec, '/binary', 'get').responses as JsonObject)[
'200'
] as JsonObject
const streamResponse = (getOperation(spec, '/stream', 'get').responses as JsonObject)[
'200'
] as JsonObject
const redirectResponse = (getOperation(spec, '/redirect', 'get').responses as JsonObject)[
'302'
] as JsonObject
expect(emptyResponse.content).toBeUndefined()
expect(textResponse.content).toHaveProperty('text/plain')
expect(binaryResponse.content).toHaveProperty('application/pdf')
expect(streamResponse.content).toHaveProperty('text/event-stream')
expect(redirectResponse.content).toBeUndefined()
expect(redirectResponse.headers).toHaveProperty('Location')
})
it('documents status-specific JSON schemas and additional media types', () => {
const completed = z
.object({ status: z.literal('completed').describe('Completed status.') })
.meta({
id: 'CompletedResponse',
title: 'Completed response',
description: 'A completed result.',
})
const queued = z
.object({ status: z.literal('queued').describe('Queued status.') })
.meta({ id: 'QueuedResponse', title: 'Queued response', description: 'A queued result.' })
const response = z
.union([completed, queued])
.meta({ id: 'ResultResponse', title: 'Result response', description: 'Any result.' })
const contract = defineRouteContract({
method: 'POST',
path: '/execute',
response: {
mode: 'json',
schema: response,
status: [200, 202],
statusSchemas: { 200: completed, 202: queued },
},
})
const route = defineOpenApiRoute(
contract,
{
...operation('execute', {
byStatus: {
200: {
description: 'Completed synchronously.',
additionalContentTypes: ['text/event-stream'],
},
202: { description: 'Accepted for processing.' },
},
}),
security: [{ apiKey: [] }, {}],
},
{ response, responses: { 200: completed, 202: queued } }
)
const spec = generateOpenApiDocument(document([route]))
const responses = getOperation(spec, '/execute', 'post').responses as JsonObject
const completedContent = (responses['200'] as JsonObject).content as JsonObject
const queuedContent = (responses['202'] as JsonObject).content as JsonObject
expect(completedContent).toHaveProperty('application/json')
expect(completedContent).toHaveProperty('text/event-stream')
expect(queuedContent).toHaveProperty('application/json')
expect(getOperation(spec, '/execute', 'post').security).toEqual([{ apiKey: [] }, {}])
})
it('documents a typed multipart body outside JSON parsing', () => {
const upload = z
.object({ file: z.file().describe('File to upload.') })
.meta({ id: 'UploadForm', title: 'Upload form', description: 'Multipart upload form.' })
const response = z
.object({ id: z.string().describe('Uploaded file identifier.') })
.meta({ id: 'UploadResponse', title: 'Upload response', description: 'Uploaded file.' })
const contract = defineRouteContract({
method: 'POST',
path: '/upload',
response: { mode: 'json', schema: response, status: 201 },
})
const route = defineOpenApiRoute(
contract,
operation('upload', { description: 'Uploaded file.' }),
{
requestBody: { schema: upload, contentTypes: ['multipart/form-data'] },
response,
}
)
const spec = generateOpenApiDocument(document([route]))
const requestBody = getOperation(spec, '/upload', 'post').requestBody as JsonObject
expect(requestBody.description).toBe('Multipart upload form.')
expect(requestBody.content).toHaveProperty('multipart/form-data')
})
it('fails when status-specific metadata drifts from the contract', () => {
const response = z
.object({ ok: z.boolean().describe('Success state.') })
.meta({ id: 'DriftResponse', title: 'Drift response', description: 'Response.' })
const contract = defineRouteContract({
method: 'POST',
path: '/drift',
response: {
mode: 'json',
schema: response,
status: [200, 202],
statusSchemas: { 200: response, 202: response },
},
})
const route = defineOpenApiRoute(
contract,
operation('drift', {
byStatus: { 200: { description: 'Only one documented status.' } },
}),
{ response, responses: { 200: response, 202: response } }
)
expect(() => generateOpenApiDocument(document([route]))).toThrow(
'status-specific responses do not match the contract statuses'
)
})
it('fails when a documented status schema drifts from the contract', () => {
const completed = z
.object({ status: z.literal('completed').describe('Completed status.') })
.meta({
id: 'ContractCompletedResponse',
title: 'Contract completed response',
description: 'A completed result.',
})
const queued = z.object({ status: z.literal('queued').describe('Queued status.') }).meta({
id: 'ContractQueuedResponse',
title: 'Contract queued response',
description: 'A queued result.',
})
const response = z
.union([completed, queued])
.meta({ id: 'ContractResultResponse', title: 'Contract result', description: 'Any result.' })
const contract = defineRouteContract({
method: 'POST',
path: '/schema-drift',
response: {
mode: 'json',
schema: response,
status: [200, 202],
statusSchemas: { 200: completed, 202: queued },
},
})
const route = defineOpenApiRoute(
contract,
operation('schemaDrift', {
byStatus: {
200: { description: 'Completed synchronously.' },
202: { description: 'Accepted for processing.' },
},
}),
{ response, responses: { 200: queued, 202: completed } }
)
expect(() => generateOpenApiDocument(document([route]))).toThrow(
'documented schema for status 200 does not match the contract schema'
)
})
it('rejects scopes for API key security requirements', () => {
const response = z
.object({ ok: z.boolean().describe('Success state.') })
.meta({ id: 'SecurityResponse', title: 'Security response', description: 'Response.' })
const contract = defineRouteContract({
method: 'GET',
path: '/security',
response: { mode: 'json', schema: response },
})
const route = defineOpenApiRoute(
contract,
{
...operation('security', { description: 'Response.' }),
security: [{ apiKey: ['read'] }],
},
{ response }
)
expect(() => generateOpenApiDocument(document([route]))).toThrow(
'apiKey security requirement must use an empty scope array'
)
})
it('fails fast for missing Zod documentation metadata', () => {
const body = z.object({ value: z.string().describe('Value.') })
const response = z
.object({ ok: z.boolean().describe('Success state.') })
.meta({ id: 'MetadataResponse', title: 'Metadata response', description: 'Response.' })
const contract = defineRouteContract({
method: 'POST',
path: '/metadata',
body,
response: { mode: 'json', schema: response },
})
const route = defineOpenApiRoute(
contract,
operation('metadata', { description: 'Response.' }),
{
body,
response,
}
)
expect(() => generateOpenApiDocument(document([route]))).toThrow(
'POST /metadata body is missing Zod metadata'
)
})
it('fails fast when a Zod metadata example is invalid', () => {
const body = z.object({ value: z.string().describe('Value.') }).meta({
id: 'ExampleRequest',
title: 'Example request',
description: 'Request.',
examples: [{ value: 1 }],
})
const response = z
.object({ ok: z.boolean().describe('Success state.') })
.meta({ id: 'ExampleResponse', title: 'Example response', description: 'Response.' })
const contract = defineRouteContract({
method: 'POST',
path: '/examples',
body,
response: { mode: 'json', schema: response },
})
const route = defineOpenApiRoute(
contract,
operation('examples', { description: 'Response.' }),
{
body,
response,
}
)
expect(() => generateOpenApiDocument(document([route]))).toThrow(
'POST /examples body at <root> example 1 is invalid'
)
})
it('validates response examples against transformed output schemas', () => {
const response = z
.object({
value: z
.string()
.transform((value) => value.length)
.pipe(z.number())
.describe('Transformed numeric value.'),
})
.meta({
id: 'OutputExampleResponse',
title: 'Output example response',
description: 'Transformed response.',
examples: [{ value: 'not-an-output-number' }],
})
const contract = defineRouteContract({
method: 'GET',
path: '/output-example',
response: { mode: 'json', schema: response },
})
const route = defineOpenApiRoute(
contract,
operation('outputExample', { description: 'Response.' }),
{ response }
)
expect(() => generateOpenApiDocument(document([route]))).toThrow(
'GET /output-example response at <root> example 1 is invalid for the output schema'
)
})
it('fails fast for an undocumented opaque schema', () => {
const body = z
.object({
value: z
.record(z.string(), z.unknown())
.describe('User-defined values keyed by property name.'),
})
.meta({ id: 'OpaqueRequest', title: 'Opaque request', description: 'Request.' })
const response = z
.object({ ok: z.boolean().describe('Success state.') })
.meta({ id: 'OpaqueResponse', title: 'Opaque response', description: 'Response.' })
const contract = defineRouteContract({
method: 'POST',
path: '/opaque',
body,
response: { mode: 'json', schema: response },
})
const route = defineOpenApiRoute(contract, operation('opaque', { description: 'Response.' }), {
body,
response,
})
expect(() => generateOpenApiDocument(document([route]))).toThrow(
'POST /opaque body opaque schema at <root>.value.additionalProperties description is required'
)
})
it('fails fast for an undocumented inline property schema', () => {
const body = z
.object({ value: z.string() })
.meta({ id: 'UndocumentedRequest', title: 'Undocumented request', description: 'Request.' })
const response = z
.object({ ok: z.boolean().describe('Success state.') })
.meta({ id: 'DocumentedResponse', title: 'Documented response', description: 'Response.' })
const contract = defineRouteContract({
method: 'POST',
path: '/undocumented-property',
body,
response: { mode: 'json', schema: response },
})
const route = defineOpenApiRoute(
contract,
operation('undocumentedProperty', { description: 'Response.' }),
{ body, response }
)
expect(() => generateOpenApiDocument(document([route]))).toThrow(
'POST /undocumented-property body property at <root>.value description is required'
)
})
it('serializes deterministically', () => {
expect(serializeOpenApiDocument(filesAuditOpenApiDocument)).toBe(
serializeOpenApiDocument(filesAuditOpenApiDocument)
)
})
it('documents nullable file share metadata from the response schema', () => {
const spec = generateOpenApiDocument(filesAuditOpenApiDocument)
const schemas = (spec.components as JsonObject).schemas as JsonObject
const metadata = schemas.V2FileMetadata as JsonObject
const properties = metadata.properties as JsonObject
const share = properties.share as JsonObject
expect(share.anyOf).toEqual(expect.arrayContaining([expect.objectContaining({ type: 'null' })]))
})
it('documents v2 billing storage coverage from the response schema', () => {
const spec = generateOpenApiDocument(billingOpenApiDocument)
const paths = spec.paths as JsonObject
const schemas = (spec.components as JsonObject).schemas as JsonObject
const response = schemas.V2BillingStatusResponse as JsonObject
const responseProperties = response.properties as JsonObject
const data = responseProperties.data as JsonObject
const billingStatus = schemas.V2BillingStatus as JsonObject
const dataProperties = billingStatus.properties as JsonObject
const storage = dataProperties.storage as JsonObject
const credits = dataProperties.credits as JsonObject
expect(Object.keys(paths).sort()).toEqual(['/api/v2/billing/logs', '/api/v2/billing/status'])
expect(data.$ref).toBe('#/components/schemas/V2BillingStatus')
expect(storage.anyOf).toEqual([
expect.objectContaining({
required: ['usedBytes', 'limitBytes', 'percentUsed'],
properties: {
usedBytes: expect.objectContaining({ type: 'number', minimum: 0 }),
limitBytes: expect.objectContaining({ type: 'number', minimum: 0 }),
percentUsed: expect.objectContaining({ type: 'number', minimum: 0 }),
},
}),
{ type: 'null' },
])
expect(credits.anyOf).toEqual([
expect.objectContaining({ required: ['used', 'limit', 'remaining'] }),
{ type: 'null' },
])
})
it('uses string wire values for transformed boolean defaults', () => {
const spec = generateOpenApiDocument(filesAuditOpenApiDocument)
const deleteFolder = getOperation(spec, '/api/v2/files/folders', 'delete')
const deleteFolderParameters = deleteFolder.parameters as JsonObject[]
const recursive = deleteFolderParameters.find((parameter) => parameter.name === 'recursive')
const listAuditLogs = getOperation(spec, '/api/v2/audit-logs', 'get')
const listAuditLogParameters = listAuditLogs.parameters as JsonObject[]
const includeDeparted = listAuditLogParameters.find(
(parameter) => parameter.name === 'includeDeparted'
)
expect(recursive?.schema).toMatchObject({ type: 'string', default: 'false' })
expect(includeDeparted?.schema).toMatchObject({ type: 'string', default: 'false' })
})
it('documents binary download response headers', () => {
const spec = generateOpenApiDocument(filesAuditOpenApiDocument)
const operation = getOperation(spec, '/api/v2/files/{fileId}', 'get')
const response = (operation.responses as JsonObject)['200'] as JsonObject
expect(response.headers).toMatchObject({
'Content-Type': { $ref: '#/components/headers/Content-Type' },
'Content-Disposition': { $ref: '#/components/headers/Content-Disposition' },
'Content-Length': { $ref: '#/components/headers/Content-Length' },
})
})
})