forked from github/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathwebhooks.js
More file actions
79 lines (67 loc) · 3.48 KB
/
webhooks.js
File metadata and controls
79 lines (67 loc) · 3.48 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
const { difference } = require('lodash')
const { getJSON } = require('../helpers/supertest')
const { latest } = require('../../lib/enterprise-server-releases')
const allVersions = Object.values(require('../../lib/all-versions'))
const payloadVersions = allVersions.map(v => v.miscVersionName)
const webhookPayloads = require('../../lib/webhooks')
// grab some values for testing
const nonEnterpriseDefaultPayloadVersion = allVersions
.find(version => version.nonEnterpriseDefault)
.miscVersionName
const latestGhesPayloadVersion = allVersions
.find(version => version.currentRelease === latest)
.miscVersionName
const ghaePayloadVersion = allVersions
.find(version => version.plan === 'github-ae')
.miscVersionName
describe('webhook payloads', () => {
jest.setTimeout(3 * 60 * 1000)
test('have expected top-level keys', () => {
payloadVersions.forEach(version => {
expect(version in webhookPayloads).toBe(true)
})
})
test('have a reasonable number of payloads per version', () => {
payloadVersions.forEach(version => {
const payloadsPerVersion = Object.keys(webhookPayloads[version])
expect(payloadsPerVersion.length).toBeGreaterThan(20)
})
})
test('have payloads that are JSON strings, not objects', () => {
// use the first one found for testing purposes
const firstKey = Object.keys(webhookPayloads[nonEnterpriseDefaultPayloadVersion])[0]
const firstValue = webhookPayloads[nonEnterpriseDefaultPayloadVersion][firstKey]
const payloadString = getPayloadString(firstValue)
const payloadLines = payloadString.split('\n')
expect(payloadLines.length).toBeGreaterThan(5)
expect(payloadLines[2].trim()).toBe('```json')
expect(payloadLines[3].trim()).toBe('{')
expect(payloadLines[payloadLines.length - 3].trim()).toBe('```')
})
test('on non-dotcom versions, dotcom-only payloads fall back to dotcom', async () => {
const ghesPayloads = webhookPayloads[latestGhesPayloadVersion]
const ghaePayloads = webhookPayloads[ghaePayloadVersion]
const dotcomOnlyPayloads = difference(Object.keys(webhookPayloads[nonEnterpriseDefaultPayloadVersion]), Object.keys(ghesPayloads))
// use the first one found for testing purposes
const dotcomOnlyPayload = dotcomOnlyPayloads[0]
expect(ghesPayloads[dotcomOnlyPayload]).toBeUndefined()
expect(ghaePayloads[dotcomOnlyPayload]).toBeUndefined()
// fallback handling is in middleware/contextualizers/webhooks.js
const ghesPayloadsWithFallbacks = await getJSON(`/en/enterprise-server@${latest}/developers/webhooks-and-events?json=webhookPayloadsForCurrentVersion`)
const ghaePayloadsWithFallbacks = await getJSON('/en/github-ae@latest/developers/webhooks-and-events?json=webhookPayloadsForCurrentVersion')
expect(ghesPayloadsWithFallbacks[dotcomOnlyPayload]).toBeDefined()
expect(ghaePayloadsWithFallbacks[dotcomOnlyPayload]).toBeDefined()
const ghesPayloadString = getPayloadString(ghesPayloadsWithFallbacks[dotcomOnlyPayload])
const ghaePayloadString = getPayloadString(ghaePayloadsWithFallbacks[dotcomOnlyPayload])
expect(ghesPayloadString.includes('```json')).toBe(true)
expect(ghaePayloadString.includes('```json')).toBe(true)
})
})
// accommodate two possible payload string locations
// value of top-level key: `create` (in create.payload.json)
// value of second-level key: `issues.opened` (in issues.opened.payload.json)
function getPayloadString (payload) {
return typeof payload === 'string'
? payload
: payload[Object.keys(payload)[0]]
}