{{ message }}
Repository navigation
Expand file tree
/
Copy pathbuild-changelog.ts
More file actions
447 lines (382 loc) · 11.9 KB
/
Copy pathbuild-changelog.ts
File metadata and controls
447 lines (382 loc) · 11.9 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
import fs from 'fs/promises'
import { afterEach, describe, expect, test } from 'vitest'
import { load } from 'js-yaml'
import MockDate from 'mockdate'
import type { Change } from '@graphql-inspector/core'
import {
createChangelogEntry,
cleanPreviewTitle,
cleanMessagesFromChanges,
previewAnchor,
prependDatedEntry,
ensureYearPage,
getLastIgnoredChanges,
getIgnoredChangesSummary,
type ChangelogEntry,
} from '../scripts/build-changelog'
import readJsonFile from '@/frame/lib/read-json-file'
interface Preview {
title: string
description: string
toggled_by: string
announcement: unknown
updates: unknown
toggled_on: string[]
owning_teams: string[]
}
interface UpcomingChange {
location: string
description: string
date: string
}
interface IgnoredChange {
type: string
[key: string]: unknown
}
interface IgnoredChangesSummary {
totalCount: number
typeCount: number
types: Array<{
type: string
count: number
}>
}
const expectedChangelogEntry: ChangelogEntry = readJsonFile(
'src/graphql/tests/fixtures/changelog-entry.json',
) as ChangelogEntry
const expectedUpdatedChangelogFile: ChangelogEntry[] = readJsonFile(
'src/graphql/tests/fixtures/updated-changelog-file.json',
) as ChangelogEntry[]
describe('creating a changelog from old schema and new schema', () => {
afterEach(() => {
MockDate.reset()
})
test('ignores unknown change types without throwing errors', async () => {
const oldSchemaString = `
type Query {
field: String
}
`
const newSchemaString = `
"""
Updated description for Query type
"""
type Query {
field: String
}
`
// CHANGES_TO_REPORT omits TypeDescriptionAdded, so createChangelogEntry ignores it.
const entry: ChangelogEntry | null = await createChangelogEntry(
oldSchemaString,
newSchemaString,
[],
[],
[],
)
expect(entry).toBeNull()
})
test('handles new directive usage change types gracefully', async () => {
const oldSchemaString = `
directive @example on FIELD_DEFINITION
type Query {
field: String
}
`
const newSchemaString = `
directive @example on FIELD_DEFINITION
type Query {
field: String @example
}
`
// CHANGES_TO_REPORT omits added field directives, so createChangelogEntry ignores this one.
const entry: ChangelogEntry | null = await createChangelogEntry(
oldSchemaString,
newSchemaString,
[],
[],
[],
)
expect(entry).toBeNull()
})
test('finds a diff of schema changes, upcoming changes, and preview changes', async () => {
const oldSchemaString = `
type PreviewType {
field1(changeTypeArgument: Int): Int
}
type Query {
stableField: String
removedField: Boolean
argumentsField(
removedRequiredArgument: Int!
removedOptionalArgument: Int!
argumentMadeRequired: Int
argumentMadeOptional: Int!
): String
previewField: PreviewType
}
`
const newSchemaString = `
type PreviewType {
field1(changeTypeArgument: Float): Int
}
type Query {
stableField: String
argumentsField(
argumentMadeRequired: Int!
argumentMadeOptional: Int
): String
previewField: PreviewType!
}
`
const previews = load(`
- title: Test preview
description: This preview is just for test
toggled_by: ':test_preview'
announcement: null
updates: null
toggled_on:
- PreviewType
- Query.previewField
owning_teams:
- '@github/engineering'
`) as Preview[]
const oldUpcomingChanges = load(`
upcoming_changes:
- location: EnterprisePendingCollaboratorEdge.isUnlicensed
description: '\`isUnlicensed\` will be removed.'
date: '2021-01-01T00:00:00+00:00'
`) as { upcoming_changes: UpcomingChange[] }
const oldUpcomingChangesArray: UpcomingChange[] = oldUpcomingChanges.upcoming_changes
const newUpcomingChanges = load(`
upcoming_changes:
- location: Query.stableField
description: '\`stableField\` will be removed.'
date: '2021-06-01T00:00:00+00:00'
- location: EnterprisePendingCollaboratorEdge.isUnlicensed
description: '\`isUnlicensed\` will be removed.'
date: '2021-01-01T00:00:00+00:00'
`) as { upcoming_changes: UpcomingChange[] }
const newUpcomingChangesArray: UpcomingChange[] = newUpcomingChanges.upcoming_changes
const entry: ChangelogEntry | null = await createChangelogEntry(
oldSchemaString,
newSchemaString,
previews,
oldUpcomingChangesArray,
newUpcomingChangesArray,
)
expect(entry).toEqual(expectedChangelogEntry)
})
test('returns null when there isnt any difference', async () => {
const schemaString = `
type Query {
i: Int!
}`
const nullEntry: ChangelogEntry | null = await createChangelogEntry(
schemaString,
schemaString,
[],
[],
[],
)
expect(nullEntry).toBeNull()
})
test('omits the schema changes group when only upcoming changes exist', async () => {
const schemaString = `
type Query {
i: Int!
}`
const entry: ChangelogEntry | null = await createChangelogEntry(
schemaString,
schemaString,
[],
[],
[
{
location: 'Query.i',
description: '`i` will be removed.',
date: '2021-06-01T00:00:00+00:00',
},
],
)
expect(entry).not.toBeNull()
expect(entry!.schemaChanges).toEqual([])
expect(entry!.upcomingChanges).toHaveLength(1)
})
test('omits the schema changes group when only preview changes exist', async () => {
const oldSchemaString = `
type PreviewType {
a: Int
}
type Query {
previewField: PreviewType
}`
const newSchemaString = `
type PreviewType {
a: Int
b: Int
}
type Query {
previewField: PreviewType
}`
const previews = [
{
title: 'Test preview',
toggled_on: ['PreviewType'],
},
]
const entry: ChangelogEntry | null = await createChangelogEntry(
oldSchemaString,
newSchemaString,
previews,
[],
[],
)
expect(entry).not.toBeNull()
expect(entry!.schemaChanges).toEqual([])
expect(entry!.previewChanges).toHaveLength(1)
})
})
describe('Preparing preview links', () => {
test('fixes preview names', () => {
// UpdateRefsPreview and MergeInfoPreview are hand-written title exceptions.
expect(cleanPreviewTitle('UpdateRefsPreview')).toEqual('Update refs preview')
expect(cleanPreviewTitle('MergeInfoPreview')).toEqual('Merge info preview')
expect(cleanPreviewTitle('something interesting')).toEqual('something interesting preview')
expect(cleanPreviewTitle('nice preview')).toEqual('nice preview')
})
test('creates anchors from preview titles', () => {
expect(previewAnchor('Merge info preview')).toEqual('merge-info-preview')
expect(previewAnchor('some.punct123 preview')).toEqual('somepunct123-preview')
})
})
describe('cleaning change messages', () => {
test('wraps each quoted name in its own code span', () => {
const messages = [
"Enum value 'CREATED_AT' was added to enum 'IssueRelatesToOrderField'",
"Input field 'botIds' of type '[ID!]' was added to input object type 'RerequestReviewsInput'",
"Argument 'ids: [ID!]' added to field 'Query.f'",
"Type 'ProjectV2Field' was added",
]
const changes = messages.map((message) => ({ message }) as Change)
expect(cleanMessagesFromChanges(changes)).toEqual([
'Enum value `CREATED_AT` was added to enum `IssueRelatesToOrderField`',
'Input field `botIds` of type `[ID!]` was added to input object type `RerequestReviewsInput`',
'Argument `ids: [ID!]` added to field `Query.f`',
'Type `ProjectV2Field` was added',
])
})
})
describe('updating the changelog file', () => {
afterEach(() => {
MockDate.reset()
})
test('modifies the entry object and the file on disk', async () => {
const testTargetPath = 'src/graphql/tests/fixtures/example-changelog.json'
const previousContents = await fs.readFile(testTargetPath)
const exampleEntry: ChangelogEntry = {
schemaChanges: [],
previewChanges: [],
upcomingChanges: [],
}
const expectedDate = '2020-11-20'
MockDate.set(expectedDate)
prependDatedEntry(exampleEntry, testTargetPath)
const newContents: string = await fs.readFile(testTargetPath, 'utf8')
await fs.writeFile(testTargetPath, previousContents.toString())
expect(exampleEntry).toEqual({
schemaChanges: [],
previewChanges: [],
upcomingChanges: [],
date: expectedDate,
})
expect(JSON.parse(newContents)).toEqual(expectedUpdatedChangelogFile)
})
})
describe('ensureYearPage', () => {
const tmpDir = 'src/graphql/tests/fixtures/tmp-changelog'
afterEach(async () => {
await fs.rm(tmpDir, { recursive: true, force: true })
})
test('creates a new year page and updates index.md children', async () => {
await fs.mkdir(tmpDir, { recursive: true })
await fs.writeFile(
`${tmpDir}/index.md`,
['---', 'title: Changelog', 'children:', ' - /2026', ' - /2025', '---', ''].join('\n'),
)
ensureYearPage('2027', tmpDir)
const yearPage = await fs.readFile(`${tmpDir}/2027.md`, 'utf8')
expect(yearPage).toContain('title: "GraphQL changelog for 2027"')
expect(yearPage).toContain('shortTitle: "2027"')
expect(yearPage).toContain('autogenerated: graphql')
const indexContent = await fs.readFile(`${tmpDir}/index.md`, 'utf8')
expect(indexContent).toContain(' - /2027\n - /2026')
})
test('is a no-op when the year page already exists', async () => {
await fs.mkdir(tmpDir, { recursive: true })
const indexContent = ['---', 'children:', ' - /2026', '---', ''].join('\n')
await fs.writeFile(`${tmpDir}/index.md`, indexContent)
await fs.writeFile(`${tmpDir}/2026.md`, '---\ntitle: existing\n---\n')
ensureYearPage('2026', tmpDir)
const yearPage = await fs.readFile(`${tmpDir}/2026.md`, 'utf8')
expect(yearPage).toContain('title: existing')
const updatedIndex = await fs.readFile(`${tmpDir}/index.md`, 'utf8')
expect(updatedIndex).toBe(indexContent)
})
})
describe('ignored changes tracking', () => {
test('tracks ignored change types', async () => {
const oldSchemaString = `
type Query {
field: String
}
`
const newSchemaString = `
"""
Updated description for Query type
"""
type Query {
field: String
}
`
// Ignored-change tracking records TypeDescriptionAdded.
await createChangelogEntry(oldSchemaString, newSchemaString, [], [], [])
const ignoredChanges: IgnoredChange[] = getLastIgnoredChanges() as unknown as IgnoredChange[]
expect(ignoredChanges.length).toBe(1)
expect(ignoredChanges[0].type).toBe('TYPE_DESCRIPTION_ADDED')
})
test('provides ignored changes summary', async () => {
const oldSchemaString = `
directive @example on FIELD_DEFINITION
type Query {
field1: String
field2: Int
}
`
const newSchemaString = `
directive @example on FIELD_DEFINITION
type Query {
field1: String @example
field2: Int @example
}
`
// Ignored-change summary groups multiple DirectiveUsage changes under one type.
await createChangelogEntry(oldSchemaString, newSchemaString, [], [], [])
const summary = getIgnoredChangesSummary()
expect(summary).toBeTruthy()
const typedSummary = summary as IgnoredChangesSummary
expect(typedSummary.totalCount).toBe(2)
expect(typedSummary.typeCount).toBe(1)
expect(typedSummary.types[0].type).toBe('DIRECTIVE_USAGE_FIELD_DEFINITION_ADDED')
expect(typedSummary.types[0].count).toBe(2)
})
test('returns null summary when no changes ignored', async () => {
const schemaString = `
type Query {
field: String
}
`
await createChangelogEntry(schemaString, schemaString, [], [], [])
const summary = getIgnoredChangesSummary()
expect(summary).toBeNull()
})
})
You can’t perform that action at this time.