Repository navigation
Expand file tree
/
Copy pathcontent_test.go
More file actions
329 lines (260 loc) · 8.11 KB
/
Copy pathcontent_test.go
File metadata and controls
329 lines (260 loc) · 8.11 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
package apihandler_test
import (
"errors"
"net/http"
"testing"
apihandler "github.com/wickedbyte/api-handler-go"
)
// Shared literals for the content tests.
const (
innerContent = "inner"
envelopeKey = "data"
doubleEvalCalls = 2
)
// Sentinel errors for the decoration error-propagation tests.
var (
errInnerContent = errors.New("inner content failed")
errMapTransform = errors.New("map transform failed")
)
// countingUserTransformer returns a transformer that counts its Transform
// calls, proving the laziness property of Content bodies.
func countingUserTransformer(calls *int) apihandler.TransformerFunc[*User, UserPayload] {
return func(_ *http.Request, resource *User) (UserPayload, error) {
*calls++
return UserPayload{ID: resource.ID, Name: resource.Name}, nil
}
}
func TestSetHeaderAllocatesHeaderOnFirstUse(t *testing.T) {
t.Parallel()
var res apihandler.Result
res.SetHeader("Location", createdUserLocation)
if got := res.Header.Get("Location"); got != createdUserLocation {
t.Fatalf("location = %q", got)
}
}
func TestSetHeaderReplacesExistingValue(t *testing.T) {
t.Parallel()
var res apihandler.Result
res.SetHeader("X-Request-Id", "first")
res.SetHeader("X-Request-Id", "second")
if got := res.Header.Values("X-Request-Id"); len(got) != 1 || got[0] != "second" {
t.Fatalf("values = %q", got)
}
}
func TestResourceTransformsOnlyWhenContentRequested(t *testing.T) {
t.Parallel()
calls := 0
body := apihandler.Resource[*User, UserPayload]{
Request: newRequest(t, http.MethodGet, "/users/1", ""),
Value: &User{ID: "1", Name: nameAda},
Transformer: countingUserTransformer(&calls),
}
if calls != 0 {
t.Fatalf("transformer called %d times before Content()", calls)
}
content, err := body.Content()
if err != nil {
t.Fatal(err)
}
payload, ok := content.(UserPayload)
if !ok || payload != (UserPayload{ID: "1", Name: nameAda}) {
t.Fatalf("content = %#v", content)
}
if calls != 1 {
t.Fatalf("transformer called %d times after Content()", calls)
}
}
// TestContentMayBeEvaluatedTwice pins the purity contract of lazy bodies:
// no memoization exists, so each Content call re-runs the transformer, and
// every evaluation must yield the same payload.
func TestContentMayBeEvaluatedTwice(t *testing.T) {
t.Parallel()
calls := 0
body := apihandler.Resource[*User, UserPayload]{
Request: newRequest(t, http.MethodGet, "/users/1", ""),
Value: &User{ID: "1", Name: nameAda},
Transformer: countingUserTransformer(&calls),
}
first, err := body.Content()
if err != nil {
t.Fatal(err)
}
second, err := body.Content()
if err != nil {
t.Fatal(err)
}
if calls != doubleEvalCalls {
t.Fatalf("transformer called %d times, want %d", calls, doubleEvalCalls)
}
want := UserPayload{ID: "1", Name: nameAda}
if first != want || second != want {
t.Fatalf("content = %#v, %#v; want %#v", first, second, want)
}
}
func TestResourceExposesUntransformedValue(t *testing.T) {
t.Parallel()
body := apihandler.Resource[*User, UserPayload]{
Request: newRequest(t, http.MethodGet, "/users/1", ""),
Value: &User{ID: "1", Name: nameAda},
Transformer: userTransformer,
}
user, ok := body.Resource().(*User)
if !ok || user.Name != nameAda {
t.Fatalf("resource = %#v", body.Resource())
}
}
func TestContentFuncAdaptsFunction(t *testing.T) {
t.Parallel()
body := apihandler.ContentFunc(func() (any, error) { return "payload", nil })
content, err := body.Content()
if err != nil {
t.Fatal(err)
}
if content != "payload" {
t.Fatalf("content = %#v", content)
}
}
// TestResourceNilTransformerReturnsError pins that a Resource constructed
// without a Transformer returns an error from Content instead of panicking.
func TestResourceNilTransformerReturnsError(t *testing.T) {
t.Parallel()
body := apihandler.Resource[*User, UserPayload]{
Request: newRequest(t, http.MethodGet, "/users/1", ""),
Value: &User{ID: "1", Name: nameAda},
}
_, err := body.Content()
if err == nil {
t.Fatal("Content() = nil error with a nil Transformer")
}
}
func TestMapBodyIsNoOpOnNilBody(t *testing.T) {
t.Parallel()
transformed := false
mapped := apihandler.MapBody(
apihandler.Result{Status: http.StatusNoContent},
func(content any) (any, error) {
transformed = true
return content, nil
},
)
if mapped.Body != nil {
t.Fatalf("body = %#v, want nil", mapped.Body)
}
if mapped.Status != http.StatusNoContent {
t.Fatalf("status = %d", mapped.Status)
}
if transformed {
t.Fatal("map function ran on a bodiless result")
}
}
func TestMapBodyDecoratesContent(t *testing.T) {
t.Parallel()
res := apihandler.Result{
Body: apihandler.ContentFunc(func() (any, error) { return innerContent, nil }),
}
mapped := apihandler.MapBody(res, func(content any) (any, error) {
return map[string]any{envelopeKey: content}, nil
})
content, err := mapped.Body.Content()
if err != nil {
t.Fatal(err)
}
envelope, ok := content.(map[string]any)
if !ok || envelope[envelopeKey] != innerContent {
t.Fatalf("content = %#v", content)
}
}
func TestMapBodyResourceIsNilWhenInnerIsNotResourcer(t *testing.T) {
t.Parallel()
res := apihandler.Result{
Body: apihandler.ContentFunc(func() (any, error) { return innerContent, nil }),
}
mapped := apihandler.MapBody(res, func(content any) (any, error) { return content, nil })
resourcer, ok := mapped.Body.(apihandler.Resourcer)
if !ok {
t.Fatal("mapped body does not implement Resourcer")
}
if resource := resourcer.Resource(); resource != nil {
t.Fatalf("resource = %#v, want nil", resource)
}
}
func TestMapBodyPreservesResourcerUnderStackedDecorators(t *testing.T) {
t.Parallel()
res := apihandler.Result{
Body: apihandler.Resource[*User, UserPayload]{
Request: newRequest(t, http.MethodGet, "/users/1", ""),
Value: &User{ID: "1", Name: nameAda},
Transformer: userTransformer,
},
}
res = apihandler.MapBody(res, func(content any) (any, error) {
return map[string]any{envelopeKey: content}, nil
})
res = apihandler.MapBody(res, func(content any) (any, error) {
return map[string]any{"outer": content}, nil
})
resourcer, ok := res.Body.(apihandler.Resourcer)
if !ok {
t.Fatal("stacked mapped body lost Resourcer")
}
user, ok := resourcer.Resource().(*User)
if !ok || user.Name != nameAda {
t.Fatalf("resource = %#v", resourcer.Resource())
}
}
func TestMapBodyPropagatesInnerContentError(t *testing.T) {
t.Parallel()
transformed := false
res := apihandler.Result{
Body: apihandler.ContentFunc(func() (any, error) { return nil, errInnerContent }),
}
mapped := apihandler.MapBody(res, func(content any) (any, error) {
transformed = true
return content, nil
})
_, err := mapped.Body.Content()
if !errors.Is(err, errInnerContent) {
t.Fatalf("err = %v", err)
}
if transformed {
t.Fatal("map function ran despite inner content error")
}
}
func TestMapBodyPropagatesTransformError(t *testing.T) {
t.Parallel()
res := apihandler.Result{
Body: apihandler.ContentFunc(func() (any, error) { return innerContent, nil }),
}
mapped := apihandler.MapBody(res, func(_ any) (any, error) { return nil, errMapTransform })
_, err := mapped.Body.Content()
if !errors.Is(err, errMapTransform) {
t.Fatalf("err = %v", err)
}
}
// TestHandRolledDecorationCapturesPreviousBody is the regression test for
// the ContentFunc self-capture footgun: a decorator must capture the
// previous body in a local variable before reassigning res.Body, because a
// closure reading res.Body after the reassignment would call itself and
// recurse forever. This test locks in the documented safe pattern.
func TestHandRolledDecorationCapturesPreviousBody(t *testing.T) {
t.Parallel()
res := apihandler.Result{
Body: apihandler.ContentFunc(func() (any, error) { return innerContent, nil }),
}
previous := res.Body
res.Body = apihandler.ContentFunc(func() (any, error) {
content, err := previous.Content()
if err != nil {
return nil, err
}
return map[string]any{envelopeKey: content}, nil
})
content, err := res.Body.Content()
if err != nil {
t.Fatal(err)
}
envelope, ok := content.(map[string]any)
if !ok || envelope[envelopeKey] != innerContent {
t.Fatalf("content = %#v", content)
}
}