-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathbody-diff.ts
More file actions
309 lines (260 loc) · 7.35 KB
/
Copy pathbody-diff.ts
File metadata and controls
309 lines (260 loc) · 7.35 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
/**
* body-diff.ts — compare matched ApiCall request bodies against OpenAPI BodyShape.
*
* Diffing only (request body); no Finding generation or scan() wiring.
*/
import * as ts from 'typescript'
import type { ApiCall } from '../model/api-call.js'
import type {
BackendRoute,
BasicSchemaType,
BodyShape,
ContractDiffResult,
Discrepancy,
MatchResult,
SchemaField,
} from './model.js'
interface ParsedCallField {
readonly name: string
readonly inferredType: BasicSchemaType | undefined
}
type ParseCallBodyResult =
| { readonly ok: true; readonly fields: readonly ParsedCallField[] }
| { readonly ok: false; readonly reason: string }
function parseCallBody(requestBody: string): ParseCallBodyResult {
const sourceFile = ts.createSourceFile(
'body.ts',
`const _ = ${requestBody}`,
ts.ScriptTarget.Latest,
true,
)
const statement = sourceFile.statements[0]
if (statement === undefined || !ts.isVariableStatement(statement)) {
return { ok: false, reason: 'Request body is not a statically analyzable object literal' }
}
const declaration = statement.declarationList.declarations[0]
if (declaration?.initializer === undefined) {
return { ok: false, reason: 'Request body is not a statically analyzable object literal' }
}
if (!ts.isObjectLiteralExpression(declaration.initializer)) {
return { ok: false, reason: 'Request body is not a statically analyzable object literal' }
}
const fields: ParsedCallField[] = []
for (const property of declaration.initializer.properties) {
if (ts.isPropertyAssignment(property)) {
const name = propertyNameText(property.name)
if (name === undefined) {
continue
}
fields.push({
name,
inferredType: inferTypeFromExpression(property.initializer),
})
continue
}
if (ts.isShorthandPropertyAssignment(property)) {
fields.push({
name: property.name.text,
inferredType: undefined,
})
}
}
return { ok: true, fields }
}
function propertyNameText(name: ts.PropertyName): string | undefined {
if (ts.isIdentifier(name)) {
return name.text
}
if (ts.isStringLiteral(name)) {
return name.text
}
return undefined
}
function inferTypeFromExpression(node: ts.Expression): BasicSchemaType | undefined {
if (ts.isStringLiteral(node) || ts.isNoSubstitutionTemplateLiteral(node)) {
return 'string'
}
if (ts.isNumericLiteral(node)) {
const value = Number(node.text)
return Number.isInteger(value) ? 'integer' : 'number'
}
if (node.kind === ts.SyntaxKind.TrueKeyword || node.kind === ts.SyntaxKind.FalseKeyword) {
return 'boolean'
}
if (ts.isArrayLiteralExpression(node)) {
return 'array'
}
if (ts.isObjectLiteralExpression(node)) {
return 'object'
}
return undefined
}
function typesCompatible(schemaType: BasicSchemaType, callType: BasicSchemaType): boolean {
if (schemaType === callType) {
return true
}
if (schemaType === 'number' && (callType === 'number' || callType === 'integer')) {
return true
}
if (schemaType === 'integer' && callType === 'integer') {
return true
}
return false
}
function compareFields(
schemaFields: readonly SchemaField[],
callFields: readonly ParsedCallField[],
): Discrepancy[] {
const discrepancies: Discrepancy[] = []
const schemaByName = new Map(schemaFields.map((field) => [field.name, field]))
const callByName = new Map(callFields.map((field) => [field.name, field]))
for (const schemaField of schemaFields) {
if (schemaField.required && !callByName.has(schemaField.name)) {
discrepancies.push({
kind: 'missing-required-field',
field: schemaField.name,
expected: schemaField.type,
actual: undefined,
})
}
}
for (const callField of callFields) {
const schemaField = schemaByName.get(callField.name)
if (schemaField === undefined) {
discrepancies.push({
kind: 'unexpected-field',
field: callField.name,
expected: undefined,
actual: callField.inferredType,
})
continue
}
if (
callField.inferredType !== undefined &&
!typesCompatible(schemaField.type, callField.inferredType)
) {
discrepancies.push({
kind: 'type-mismatch',
field: callField.name,
expected: schemaField.type,
actual: callField.inferredType,
})
}
}
return discrepancies
}
function diffNoRouteBody(apiCallId: string, requestBody: string | undefined): ContractDiffResult {
if (requestBody === undefined) {
return {
apiCallId,
status: 'compatible',
discrepancies: [],
reason: undefined,
}
}
const parsed = parseCallBody(requestBody)
if (!parsed.ok) {
return {
apiCallId,
status: 'not-diffable',
discrepancies: [],
reason: parsed.reason,
}
}
if (parsed.fields.length === 0) {
return {
apiCallId,
status: 'compatible',
discrepancies: [],
reason: undefined,
}
}
const discrepancies: Discrepancy[] = parsed.fields.map((field) => ({
kind: 'unexpected-field',
field: field.name,
expected: undefined,
actual: field.inferredType,
}))
return {
apiCallId,
status: 'discrepancies-found',
discrepancies,
reason: undefined,
}
}
function diffResolvedRouteBody(
apiCallId: string,
requestBody: string | undefined,
routeBody: Extract<BodyShape, { kind: 'resolved' }>,
): ContractDiffResult {
if (requestBody === undefined) {
return {
apiCallId,
status: 'not-diffable',
discrepancies: [],
reason: 'Request body is not statically resolvable from source',
}
}
const parsed = parseCallBody(requestBody)
if (!parsed.ok) {
return {
apiCallId,
status: 'not-diffable',
discrepancies: [],
reason: parsed.reason,
}
}
const discrepancies = compareFields(routeBody.fields, parsed.fields)
if (discrepancies.length > 0) {
return {
apiCallId,
status: 'discrepancies-found',
discrepancies,
reason: undefined,
}
}
return {
apiCallId,
status: 'compatible',
discrepancies: [],
reason: undefined,
}
}
function diffSingleRequestBody(call: ApiCall, route: BackendRoute): ContractDiffResult {
const routeBody = route.requestBody
if (routeBody === undefined) {
return diffNoRouteBody(call.id, call.requestBody)
}
if (routeBody.kind === 'unresolvable') {
return {
apiCallId: call.id,
status: 'not-diffable',
discrepancies: [],
reason: routeBody.reason,
}
}
return diffResolvedRouteBody(call.id, call.requestBody, routeBody)
}
/**
* Diff request bodies for matched ApiCalls only. Unmatched and unresolvable
* match results are skipped — no diff entry is produced for them.
*/
export function diffRequestBodies(
apiCalls: readonly ApiCall[],
matchResults: readonly MatchResult[],
_routes: readonly BackendRoute[],
): ContractDiffResult[] {
const callsById = new Map(apiCalls.map((call) => [call.id, call]))
const results: ContractDiffResult[] = []
for (const matchResult of matchResults) {
if (matchResult.status !== 'matched' || matchResult.route === undefined) {
continue
}
const call = callsById.get(matchResult.apiCallId)
if (call === undefined) {
continue
}
results.push(diffSingleRequestBody(call, matchResult.route))
}
return results
}