-
Notifications
You must be signed in to change notification settings - Fork 33
Expand file tree
/
Copy pathwebhook_test.go
More file actions
375 lines (322 loc) · 11.6 KB
/
Copy pathwebhook_test.go
File metadata and controls
375 lines (322 loc) · 11.6 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
package stream_chat
import (
"bytes"
"compress/gzip"
"crypto/hmac"
"crypto/sha256"
"encoding/base64"
"encoding/hex"
"encoding/json"
"errors"
"strings"
"testing"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
const (
webhookTestAPIKey = "tkey1"
webhookTestAPISecret = "tsec2"
webhookTestFixture = `{"type":"message.new","message":{"text":"the quick brown fox"}}`
)
func newWebhookTestClient(t *testing.T) *Client {
t.Helper()
c, err := NewClient(webhookTestAPIKey, webhookTestAPISecret)
require.NoError(t, err, "new client")
return c
}
func hmacHex(t *testing.T, secret, body []byte) string {
t.Helper()
mac := hmac.New(sha256.New, secret)
_, err := mac.Write(body)
require.NoError(t, err)
return hex.EncodeToString(mac.Sum(nil))
}
func gzipBytes(t *testing.T, src []byte) []byte {
t.Helper()
var buf bytes.Buffer
zw := gzip.NewWriter(&buf)
_, err := zw.Write(src)
require.NoError(t, err)
require.NoError(t, zw.Close())
return buf.Bytes()
}
func base64String(t *testing.T, src []byte) string {
t.Helper()
return base64.StdEncoding.EncodeToString(src)
}
func TestVerifyWebhook_BackwardCompatibility(t *testing.T) {
c := newWebhookTestClient(t)
body := []byte(webhookTestFixture)
sig := []byte(hmacHex(t, []byte(webhookTestAPISecret), body))
require.True(t, c.VerifyWebhook(body, sig), "valid signature must verify")
require.False(t, c.VerifyWebhook(body, []byte("not-a-valid-hex-signature")))
require.False(t, c.VerifyWebhook([]byte("tampered"), sig))
}
func TestGunzipPayload(t *testing.T) {
body := []byte(webhookTestFixture)
t.Run("passthrough plain bytes", func(t *testing.T) {
got, err := GunzipPayload(body)
require.NoError(t, err)
require.Equal(t, body, got)
})
t.Run("inflates gzip bytes", func(t *testing.T) {
got, err := GunzipPayload(gzipBytes(t, body))
require.NoError(t, err)
require.Equal(t, body, got)
})
t.Run("empty input returns empty", func(t *testing.T) {
got, err := GunzipPayload([]byte{})
require.NoError(t, err)
require.Equal(t, []byte{}, got)
})
t.Run("short input below magic length", func(t *testing.T) {
got, err := GunzipPayload([]byte("ab"))
require.NoError(t, err)
require.Equal(t, []byte("ab"), got)
})
t.Run("gunzipPayload returns ErrInvalidWebhook on corrupt gzip", func(t *testing.T) {
bad := append(append([]byte{}, gzipMagic...), 0, 0, 0)
got, err := GunzipPayload(bad)
require.Error(t, err)
require.Nil(t, got)
require.True(t, errors.Is(err, ErrInvalidWebhook))
assert.Contains(t, err.Error(), "gzip decompression failed")
})
t.Run("decompresses helloworld fixture", func(t *testing.T) {
compressed, err := base64.StdEncoding.DecodeString("H4sIAGrYAWoAA8tIzcnJL88vykkBAK0g6/kKAAAA")
require.NoError(t, err)
got, err := GunzipPayload(compressed)
require.NoError(t, err)
require.Equal(t, []byte("helloworld"), got)
})
}
func TestDecodeSqsPayload(t *testing.T) {
body := []byte(webhookTestFixture)
t.Run("base64 only - no compression", func(t *testing.T) {
got, err := DecodeSqsPayload(base64String(t, body))
require.NoError(t, err)
require.Equal(t, body, got)
})
t.Run("base64 plus gzip", func(t *testing.T) {
got, err := DecodeSqsPayload(base64String(t, gzipBytes(t, body)))
require.NoError(t, err)
require.Equal(t, body, got)
})
t.Run("decodeSqsPayload returns ErrInvalidWebhook on invalid base64", func(t *testing.T) {
got, err := DecodeSqsPayload("!!!not-base64!!!")
require.Error(t, err)
require.Nil(t, got)
require.True(t, errors.Is(err, ErrInvalidWebhook))
assert.Contains(t, err.Error(), "invalid base64 encoding")
})
t.Run("helloworld base64 fixture", func(t *testing.T) {
got, err := DecodeSqsPayload("aGVsbG93b3JsZA==")
require.NoError(t, err)
require.Equal(t, []byte("helloworld"), got)
})
t.Run("helloworld base64+gzip fixture", func(t *testing.T) {
got, err := DecodeSqsPayload("H4sIAGrYAWoAA8tIzcnJL88vykkBAK0g6/kKAAAA")
require.NoError(t, err)
require.Equal(t, []byte("helloworld"), got)
})
}
func TestDecodeSnsPayload(t *testing.T) {
body := []byte(webhookTestFixture)
wrapped := base64String(t, gzipBytes(t, body))
t.Run("pre-extracted message backward compat", func(t *testing.T) {
sns, err := DecodeSnsPayload(wrapped)
require.NoError(t, err)
sqs, err := DecodeSqsPayload(wrapped)
require.NoError(t, err)
require.Equal(t, sqs, sns)
require.Equal(t, body, sns)
})
t.Run("full SNS HTTP notification envelope", func(t *testing.T) {
envelope := snsEnvelope(t, wrapped)
got, err := DecodeSnsPayload(envelope)
require.NoError(t, err)
require.Equal(t, body, got)
})
t.Run("envelope with whitespace prefix", func(t *testing.T) {
envelope := " \n" + snsEnvelope(t, wrapped)
got, err := DecodeSnsPayload(envelope)
require.NoError(t, err)
require.Equal(t, body, got)
})
}
// snsEnvelope returns a realistic SNS HTTP POST notification body that
// wraps payload as the Message field. Matches the documented SNS schema.
func snsEnvelope(t *testing.T, payload string) string {
t.Helper()
env := map[string]any{
"Type": "Notification",
"MessageId": "22b80b92-fdea-4c2c-8f9d-bdfb0c7bf324",
"TopicArn": "arn:aws:sns:us-east-1:123456789012:stream-webhooks",
"Message": payload,
"Timestamp": "2026-05-11T10:00:00.000Z",
"SignatureVersion": "1",
"MessageAttributes": map[string]any{
"X-Signature": map[string]string{
"Type": "String",
"Value": "<signature placeholder>",
},
},
}
out, err := json.Marshal(env)
require.NoError(t, err)
return string(out)
}
func TestVerifySignature(t *testing.T) {
body := []byte(webhookTestFixture)
sig := hmacHex(t, []byte(webhookTestAPISecret), body)
t.Run("valid signature returns nil", func(t *testing.T) {
require.NoError(t, VerifySignature(body, sig, webhookTestAPISecret))
})
t.Run("verifySignature returns ErrInvalidWebhook on mismatch", func(t *testing.T) {
err := VerifySignature(body, "0000000000000000000000000000000000000000000000000000000000000000", webhookTestAPISecret)
require.Error(t, err)
require.True(t, errors.Is(err, ErrInvalidWebhook))
assert.Contains(t, err.Error(), "signature mismatch")
})
t.Run("wrong secret rejected", func(t *testing.T) {
err := VerifySignature(body, sig, "different-secret")
require.Error(t, err)
require.True(t, errors.Is(err, ErrInvalidWebhook))
assert.Contains(t, err.Error(), "signature mismatch")
})
t.Run("signature over compressed bytes rejected", func(t *testing.T) {
compressed := gzipBytes(t, body)
sigOverCompressed := hmacHex(t, []byte(webhookTestAPISecret), compressed)
err := VerifySignature(body, sigOverCompressed, webhookTestAPISecret)
require.Error(t, err, "signature must be computed over uncompressed bytes")
require.True(t, errors.Is(err, ErrInvalidWebhook))
})
}
func TestParseEvent(t *testing.T) {
t.Run("known event type", func(t *testing.T) {
got, err := ParseEvent([]byte(webhookTestFixture))
require.NoError(t, err)
require.Equal(t, EventMessageNew, got.Type)
require.NotNil(t, got.Message)
require.Equal(t, "the quick brown fox", got.Message.Text)
})
t.Run("unknown event type still parses", func(t *testing.T) {
got, err := ParseEvent([]byte(`{"type":"a.future.event","custom":42}`))
require.NoError(t, err)
require.Equal(t, EventType("a.future.event"), got.Type)
})
t.Run("parseEvent returns ErrInvalidWebhook on invalid JSON", func(t *testing.T) {
got, err := ParseEvent([]byte("not json"))
require.Error(t, err)
require.Nil(t, got)
require.True(t, errors.Is(err, ErrInvalidWebhook))
assert.Contains(t, err.Error(), "invalid JSON payload")
})
}
func TestVerifyAndParseWebhook(t *testing.T) {
c := newWebhookTestClient(t)
body := []byte(webhookTestFixture)
sig := hmacHex(t, []byte(webhookTestAPISecret), body)
t.Run("plain body via package", func(t *testing.T) {
got, err := VerifyAndParseWebhook(body, sig, webhookTestAPISecret)
require.NoError(t, err)
require.Equal(t, EventMessageNew, got.Type)
})
t.Run("gzip body via package", func(t *testing.T) {
got, err := VerifyAndParseWebhook(gzipBytes(t, body), sig, webhookTestAPISecret)
require.NoError(t, err)
require.Equal(t, EventMessageNew, got.Type)
})
t.Run("plain body via client", func(t *testing.T) {
got, err := c.VerifyAndParseWebhook(body, sig)
require.NoError(t, err)
require.Equal(t, EventMessageNew, got.Type)
})
t.Run("gzip body via client", func(t *testing.T) {
got, err := c.VerifyAndParseWebhook(gzipBytes(t, body), sig)
require.NoError(t, err)
require.Equal(t, EventMessageNew, got.Type)
})
t.Run("signature mismatch returns ErrInvalidWebhook", func(t *testing.T) {
got, err := c.VerifyAndParseWebhook(body, strings.Repeat("0", 64))
require.Error(t, err)
require.True(t, errors.Is(err, ErrInvalidWebhook))
assert.Contains(t, err.Error(), "signature mismatch")
require.Nil(t, got)
})
t.Run("signature over compressed bytes rejected", func(t *testing.T) {
compressed := gzipBytes(t, body)
sigOverCompressed := hmacHex(t, []byte(webhookTestAPISecret), compressed)
got, err := c.VerifyAndParseWebhook(compressed, sigOverCompressed)
require.Error(t, err)
require.True(t, errors.Is(err, ErrInvalidWebhook))
assert.Contains(t, err.Error(), "signature mismatch")
require.Nil(t, got)
})
t.Run("propagates decompression error as ErrInvalidWebhook", func(t *testing.T) {
bogus := append(append([]byte{}, gzipMagic...), []byte("garbage")...)
got, err := c.VerifyAndParseWebhook(bogus, sig)
require.Error(t, err)
require.True(t, errors.Is(err, ErrInvalidWebhook))
assert.Contains(t, err.Error(), "gzip decompression failed")
require.Nil(t, got)
})
}
func TestParseSqs(t *testing.T) {
c := newWebhookTestClient(t)
body := []byte(webhookTestFixture)
t.Run("base64 only via client", func(t *testing.T) {
got, err := c.ParseSqs(base64String(t, body))
require.NoError(t, err)
require.Equal(t, EventMessageNew, got.Type)
require.NotNil(t, got.Message)
require.Equal(t, "the quick brown fox", got.Message.Text)
})
t.Run("base64 plus gzip via client", func(t *testing.T) {
wrapped := base64String(t, gzipBytes(t, body))
got, err := c.ParseSqs(wrapped)
require.NoError(t, err)
require.Equal(t, EventMessageNew, got.Type)
})
t.Run("via package", func(t *testing.T) {
wrapped := base64String(t, gzipBytes(t, body))
got, err := ParseSqs(wrapped)
require.NoError(t, err)
require.Equal(t, EventMessageNew, got.Type)
})
t.Run("invalid base64 surfaced as ErrInvalidWebhook", func(t *testing.T) {
got, err := c.ParseSqs("!!!not-base64!!!")
require.Error(t, err)
require.True(t, errors.Is(err, ErrInvalidWebhook))
assert.Contains(t, err.Error(), "invalid base64 encoding")
require.Nil(t, got)
})
}
func TestParseSns(t *testing.T) {
c := newWebhookTestClient(t)
body := []byte(webhookTestFixture)
wrapped := base64String(t, gzipBytes(t, body))
t.Run("pre-extracted message backward compat", func(t *testing.T) {
got, err := c.ParseSns(wrapped)
require.NoError(t, err)
require.Equal(t, EventMessageNew, got.Type)
pkg, err := ParseSns(wrapped)
require.NoError(t, err)
require.Equal(t, got.Type, pkg.Type)
})
t.Run("full SNS HTTP notification envelope", func(t *testing.T) {
envelope := snsEnvelope(t, wrapped)
got, err := c.ParseSns(envelope)
require.NoError(t, err)
require.Equal(t, EventMessageNew, got.Type)
require.NotNil(t, got.Message)
require.Equal(t, "the quick brown fox", got.Message.Text)
})
t.Run("invalid base64 surfaced as ErrInvalidWebhook", func(t *testing.T) {
got, err := c.ParseSns("!!!not-base64!!!")
require.Error(t, err)
require.True(t, errors.Is(err, ErrInvalidWebhook))
assert.Contains(t, err.Error(), "invalid base64 encoding")
require.Nil(t, got)
})
}