-
Notifications
You must be signed in to change notification settings - Fork 11
Expand file tree
/
Copy pathrouteHandlerBuilder.test.ts
More file actions
1002 lines (835 loc) · 33 KB
/
routeHandlerBuilder.test.ts
File metadata and controls
1002 lines (835 loc) · 33 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
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import { describe, expect, expectTypeOf, it } from 'vitest';
import { z } from 'zod/v4';
import { createZodRoute } from './createZodRoute';
import { MiddlewareFunction } from './types';
const paramsSchema = z.object({
id: z.uuid(),
});
const querySchema = z.object({
search: z.string().min(1),
status: z.string().array().optional(),
});
const bodySchema = z.object({
field: z.string(),
});
export const paramsToPromise = (params: Record<string, unknown>): Promise<Record<string, unknown>> => {
return Promise.resolve(params);
};
describe('params validation', () => {
it('should validate and handle valid params', async () => {
const GET = createZodRoute()
.params(paramsSchema)
.handler((request, context) => {
expectTypeOf(context.params).toMatchTypeOf<z.infer<typeof paramsSchema>>();
const { id } = context.params;
return Response.json({ id }, { status: 200 });
});
const request = new Request('http://localhost/');
const response = await GET(request, { params: paramsToPromise({ id: '550e8400-e29b-41d4-a716-446655440000' }) });
const data = await response.json();
expect(response.status).toBe(200);
expect(data).toEqual({ id: '550e8400-e29b-41d4-a716-446655440000' });
});
it('should return an error for invalid params', async () => {
const GET = createZodRoute()
.params(paramsSchema)
.handler((request, context) => {
const { id } = context.params;
return Response.json({ id }, { status: 200 });
});
const request = new Request('http://localhost/');
const response = await GET(request, { params: paramsToPromise({ id: 'invalid-uuid' }) });
const data = await response.json();
expect(response.status).toBe(400);
expect(data.message).toBe('Invalid params');
});
});
describe('query validation', () => {
it('should validate and handle valid query', async () => {
const GET = createZodRoute()
.params(paramsSchema)
.query(querySchema)
.handler((request, context) => {
expectTypeOf(context.query).toMatchTypeOf<z.infer<typeof querySchema>>();
const search = context.query.search;
return Response.json({ search }, { status: 200 });
});
const request = new Request('http://localhost/?search=test');
const response = await GET(request, { params: Promise.resolve({ id: 'D570D9AB-E002-46EA-996F-0E0023C8F702' }) });
const data = await response.json();
expect(response.status).toBe(200);
expect(data).toEqual({ search: 'test' });
});
it('should return an error for invalid query', async () => {
const GET = createZodRoute()
.query(querySchema)
.handler((request, context) => {
const search = context.query.search;
return Response.json({ search }, { status: 200 });
});
const request = new Request('http://localhost/?search=');
const response = await GET(request, { params: Promise.resolve({}) });
const data = await response.json();
expect(response.status).toBe(400);
expect(data.message).toBe('Invalid query');
});
it('should validate and handle valid query when query is array', async () => {
const GET = createZodRoute()
.params(paramsSchema)
.query(querySchema)
.handler((request, context) => {
expectTypeOf(context.query).toMatchTypeOf<z.infer<typeof querySchema>>();
const status = context.query.status;
return Response.json({ status }, { status: 200 });
});
const request = new Request('http://localhost/?search=test&status=active&status=inactive');
const response = await GET(request, { params: Promise.resolve({ id: 'D570D9AB-E002-46EA-996F-0E0023C8F702' }) });
const data = await response.json();
expect(response.status).toBe(200);
expect(data).toEqual({ status: ['active', 'inactive'] });
});
});
describe('body validation', () => {
it('should validate and handle valid body', async () => {
const POST = createZodRoute()
.body(bodySchema)
.handler((request, context) => {
expectTypeOf(context.body).toMatchTypeOf<z.infer<typeof bodySchema>>();
const field = context.body.field;
return Response.json({ field }, { status: 200 });
});
const request = new Request('http://localhost/', {
method: 'POST',
body: JSON.stringify({ field: 'test-field' }),
});
const response = await POST(request, { params: Promise.resolve({}) });
const data = await response.json();
expect(response.status).toBe(200);
expect(data).toEqual({ field: 'test-field' });
});
it('should return an error for invalid body', async () => {
const POST = createZodRoute()
.body(bodySchema)
.handler((request, context) => {
const field = context.body.field;
return Response.json({ field }, { status: 200 });
});
const request = new Request('http://localhost/', {
method: 'POST',
body: JSON.stringify({ field: 123 }),
});
const response = await POST(request, { params: Promise.resolve({}) });
const data = await response.json();
expect(response.status).toBe(400);
expect(data.message).toBe('Invalid body');
});
it('should not error when body schema is defined but no body is sent in POST request', async () => {
const POST = createZodRoute()
.body(bodySchema)
.handler(() => {
// If we reach here, it means no validation error was thrown
return Response.json({ success: true }, { status: 200 });
});
const request = new Request('http://localhost/', {
method: 'POST',
// No body provided intentionally
});
const response = await POST(request, { params: Promise.resolve({}) });
expect(response.status).toBe(400); // Should fail with 400 since body is required but not provided
const data = await response.json();
expect(data.message).toBe('Invalid body');
});
it('should return the value when no body schema is defined and no body is provided', async () => {
const POST = createZodRoute().handler(() => {
// If we reach here, it means no validation error was thrown
return Response.json({ success: true }, { status: 200 });
});
const request = new Request('http://localhost/', {
method: 'POST',
// No body provided intentionally
});
const response = await POST(request, { params: Promise.resolve({}) });
expect(response.status).toBe(200); // Should fail with 400 since body is required but not provided
const data = await response.json();
expect(data.success).toBe(true);
});
});
describe('combined validation', () => {
it('should validate and handle valid request with params, query, and body', async () => {
const POST = createZodRoute()
.params(paramsSchema)
.query(querySchema)
.body(bodySchema)
.handler((request, context) => {
const { id } = context.params;
const { search } = context.query;
const { field } = context.body;
return Response.json({ id, search, field }, { status: 200 });
});
const request = new Request('http://localhost/?search=test', {
method: 'POST',
body: JSON.stringify({ field: 'test-field' }),
});
const response = await POST(request, { params: paramsToPromise({ id: '550e8400-e29b-41d4-a716-446655440000' }) });
const data = await response.json();
expect(response.status).toBe(200);
expect(data).toEqual({
id: '550e8400-e29b-41d4-a716-446655440000',
search: 'test',
field: 'test-field',
});
});
it('should return an error for invalid params in combined validation', async () => {
const POST = createZodRoute()
.params(paramsSchema)
.query(querySchema)
.body(bodySchema)
.handler((request, context) => {
const { id } = context.params;
const { search } = context.query;
const { field } = context.body;
return Response.json({ id, search, field }, { status: 200 });
});
const request = new Request('http://localhost/?search=test', {
method: 'POST',
body: JSON.stringify({ field: 'test-field' }),
});
const response = await POST(request, { params: paramsToPromise({ id: 'invalid-uuid' }) });
const data = await response.json();
expect(response.status).toBe(400);
expect(data.message).toBe('Invalid params');
});
it('should return an error for invalid query in combined validation', async () => {
const POST = createZodRoute()
.params(paramsSchema)
.query(querySchema)
.body(bodySchema)
.handler((request, context) => {
const { id } = context.params;
const { search } = context.query;
const { field } = context.body;
return Response.json({ id, search, field }, { status: 200 });
});
const request = new Request('http://localhost/?search=', {
method: 'POST',
body: JSON.stringify({ field: 'test-field' }),
});
const response = await POST(request, { params: paramsToPromise({ id: '550e8400-e29b-41d4-a716-446655440000' }) });
const data = await response.json();
expect(response.status).toBe(400);
expect(data.message).toBe('Invalid query');
});
it('should return an error for invalid body in combined validation', async () => {
const POST = createZodRoute()
.params(paramsSchema)
.query(querySchema)
.body(bodySchema)
.handler((request, context) => {
const { id } = context.params;
const { search } = context.query;
const { field } = context.body;
return Response.json({ id, search, field }, { status: 200 });
});
const request = new Request('http://localhost/?search=test', {
method: 'POST',
body: JSON.stringify({ field: 123 }),
});
const response = await POST(request, { params: paramsToPromise({ id: '550e8400-e29b-41d4-a716-446655440000' }) });
const data = await response.json();
expect(response.status).toBe(400);
expect(data.message).toBe('Invalid body');
});
it('should execute middleware and add context properties', async () => {
const middleware: MiddlewareFunction<Record<string, unknown>, { user: { id: string; role: string } }> = async ({
next,
}) => {
const result = await next({ ctx: { user: { id: 'user-123', role: 'admin' } } });
return result;
};
const GET = createZodRoute()
.use(middleware)
.params(paramsSchema)
.handler((request, context) => {
const { id } = context.params;
const { user } = context.ctx;
expectTypeOf(user).toMatchTypeOf<{ id: string }>();
return Response.json({ id, user }, { status: 200 });
});
const request = new Request('http://localhost/');
const response = await GET(request, { params: paramsToPromise({ id: '550e8400-e29b-41d4-a716-446655440000' }) });
const data = await response.json();
expect(response.status).toBe(200);
expect(data).toEqual({
id: '550e8400-e29b-41d4-a716-446655440000',
user: { id: 'user-123', role: 'admin' },
});
});
it('should execute multiple middlewares and merge context properties', async () => {
const GET = createZodRoute()
.use(async ({ next }) => {
const result = await next({ ctx: { user: { id: 'user-123' } } });
return result;
})
.use(async ({ next, ctx }) => {
const user = ctx.user;
expectTypeOf(user).toMatchTypeOf<{ id: string }>();
const result = await next({ ctx: { permissions: ['read', 'write'] } });
return result;
})
.params(paramsSchema)
.handler((request, context) => {
const { id } = context.params;
const { user, permissions } = context.ctx;
// Context should be automatically typed without explicit type
expectTypeOf(user).toMatchTypeOf<{ id: string }>();
expectTypeOf(permissions).toMatchTypeOf<string[]>();
return Response.json({ id, user, permissions }, { status: 200 });
});
const request = new Request('http://localhost/');
const response = await GET(request, { params: paramsToPromise({ id: '550e8400-e29b-41d4-a716-446655440000' }) });
const data = await response.json();
expect(response.status).toBe(200);
expect(data).toEqual({
id: '550e8400-e29b-41d4-a716-446655440000',
user: { id: 'user-123' },
permissions: ['read', 'write'],
});
});
it('should handle server errors using handleServerError method', async () => {
class CustomError extends Error {
constructor(message: string) {
super(message);
this.name = 'CustomError';
}
}
const handleServerError = (error: Error) => {
if (error instanceof CustomError) {
return new Response(JSON.stringify({ message: error.name, details: error.message }), { status: 400 });
}
return new Response(JSON.stringify({ message: 'Something went wrong' }), { status: 400 });
};
const GET = createZodRoute({
handleServerError,
})
.params(paramsSchema)
.handler(() => {
throw new CustomError('Test error');
});
const request = new Request('http://localhost/');
const response = await GET(request, { params: paramsToPromise({ id: '550e8400-e29b-41d4-a716-446655440000' }) });
const data = await response.json();
expect(response.status).toBe(400);
expect(data).toEqual({ message: 'CustomError', details: 'Test error' });
});
});
describe('form data handling', () => {
it('should parse and validate form data in the request body', async () => {
const POST = createZodRoute()
.body(bodySchema)
.handler((request, context) => {
const { field } = context.body;
return Response.json({ field }, { status: 200 });
});
const formData = new URLSearchParams();
formData.append('field', 'test-field');
const request = new Request('http://localhost/', {
method: 'POST',
body: formData,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
},
});
const response = await POST(request, { params: Promise.resolve({}) });
const data = await response.json();
expect(response.status).toBe(200);
expect(data).toEqual({ field: 'test-field' });
});
it('should return an error for invalid form data', async () => {
const POST = createZodRoute()
.body(bodySchema)
.handler((request, context) => {
const { field } = context.body;
return Response.json({ field }, { status: 200 });
});
const formData = new URLSearchParams();
formData.append('field', ''); // Empty string should fail validation
const request = new Request('http://localhost/', {
method: 'POST',
body: formData,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
},
});
const response = await POST(request, { params: Promise.resolve({}) });
const data = await response.json();
expect(response.status).toBe(200);
expect(data).toEqual({ field: '' });
});
});
describe('response handling', () => {
it('should return the Response object directly when handler returns a Response', async () => {
const GET = createZodRoute().handler(() => {
return new Response(JSON.stringify({ custom: 'response' }), {
status: 201,
headers: { 'X-Custom-Header': 'test' },
});
});
const request = new Request('http://localhost/');
const response = await GET(request, { params: Promise.resolve({}) });
const data = await response.json();
expect(response.status).toBe(201);
expect(response.headers.get('X-Custom-Header')).toBe('test');
expect(data).toEqual({ custom: 'response' });
});
it('should convert non-Response return values to a JSON Response', async () => {
const GET = createZodRoute().handler(() => {
return { data: 'value' };
});
const request = new Request('http://localhost/');
const response = await GET(request, { params: Promise.resolve({}) });
expect(response.status).toBe(200);
expect(response.headers.get('Content-Type')).toBe('application/json');
const data = await response.json();
expect(data).toEqual({ data: 'value' });
});
});
describe('HTTP methods handling', () => {
it('should not parse body for DELETE requests', async () => {
const DELETE = createZodRoute().handler(() => {
// If we reach here without error, it means the body wasn't parsed
return Response.json({ success: true }, { status: 200 });
});
const request = new Request('http://localhost/', {
method: 'DELETE',
// DELETE can have a body, unlike GET
body: '{invalid json}',
headers: {
'Content-Type': 'application/json',
},
});
const response = await DELETE(request, { params: Promise.resolve({}) });
const data = await response.json();
expect(response.status).toBe(200);
expect(data).toEqual({ success: true });
});
it('should not parse body for GET requests', async () => {
const GET = createZodRoute().handler(() => {
// If we reach here without error, it means the body wasn't parsed
return Response.json({ success: true }, { status: 200 });
});
// GET requests can't have a body, so we'll just test that the handler works
const request = new Request('http://localhost/', {
method: 'GET',
});
const response = await GET(request, { params: Promise.resolve({}) });
const data = await response.json();
expect(response.status).toBe(200);
expect(data).toEqual({ success: true });
});
});
describe('metadata validation', () => {
const metadataSchema = z.object({
permission: z.string(),
role: z.enum(['admin', 'user']),
});
it('should validate and handle valid metadata', async () => {
const GET = createZodRoute()
.defineMetadata(metadataSchema)
.metadata({ permission: 'read', role: 'admin' })
.handler((request, context) => {
expectTypeOf(context.metadata).toEqualTypeOf<z.infer<typeof metadataSchema> | undefined>();
const { permission, role } = context.metadata!;
return Response.json({ permission, role }, { status: 200 });
});
const request = new Request('http://localhost/');
const response = await GET(request, {
params: Promise.resolve({}),
});
const data = await response.json();
expect(response.status).toBe(200);
expect(data).toEqual({ permission: 'read', role: 'admin' });
});
it('should return an error for invalid metadata', async () => {
const GET = createZodRoute()
.defineMetadata(metadataSchema)
// @ts-expect-error - invalid role
.metadata({ permission: 'read', role: 'invalid-role' })
.handler((request, context) => {
const { permission, role } = context.metadata!;
return Response.json({ permission, role }, { status: 200 });
});
const request = new Request('http://localhost/');
const response = await GET(request, {
params: Promise.resolve({}),
});
const data = await response.json();
expect(response.status).toBe(400);
expect(data.message).toBe('Invalid metadata');
});
it('should handle missing optional metadata', async () => {
const GET = createZodRoute()
.defineMetadata(metadataSchema)
.handler((request, context) => {
expect(context.metadata).toBeUndefined();
return Response.json({ success: true }, { status: 200 });
});
const request = new Request('http://localhost/');
const response = await GET(request, { params: Promise.resolve({}) });
const data = await response.json();
expect(response.status).toBe(200);
expect(data).toEqual({ success: true });
});
it('should work with combined validation', async () => {
const GET = createZodRoute()
.params(paramsSchema)
.query(querySchema)
.defineMetadata(metadataSchema)
.metadata({ permission: 'read', role: 'admin' })
.handler((request, context) => {
const { id } = context.params;
const { search } = context.query;
const { permission, role } = context.metadata!;
return Response.json({ id, search, permission, role }, { status: 200 });
});
const request = new Request('http://localhost/?search=test');
const response = await GET(request, {
params: paramsToPromise({ id: '550e8400-e29b-41d4-a716-446655440000' }),
});
const data = await response.json();
expect(response.status).toBe(200);
expect(data).toEqual({
id: '550e8400-e29b-41d4-a716-446655440000',
search: 'test',
permission: 'read',
role: 'admin',
});
});
it('should pass metadata to middleware', async () => {
const GET = createZodRoute()
.defineMetadata(metadataSchema)
.use(async ({ next, metadata }) => {
expect(metadata).toEqual({ permission: 'read', role: 'admin' });
const result = await next({ ctx: { authorized: true } });
return result;
})
.metadata({ permission: 'read', role: 'admin' })
.handler((request, context) => {
const { authorized } = context.ctx;
const { permission, role } = context.metadata!;
return Response.json({ authorized, permission, role }, { status: 200 });
});
const request = new Request('http://localhost/');
const response = await GET(request, {
params: Promise.resolve({}),
});
const data = await response.json();
expect(response.status).toBe(200);
expect(data).toEqual({
authorized: true,
permission: 'read',
role: 'admin',
});
});
it('should handle undefined metadata in middleware', async () => {
const GET = createZodRoute()
.defineMetadata(metadataSchema)
.use(async ({ next, metadata }) => {
expect(metadata).toBeUndefined();
const result = await next({ ctx: { authorized: false } });
return result;
})
.handler((request, context) => {
const { authorized } = context.ctx;
return Response.json({ authorized }, { status: 200 });
});
const request = new Request('http://localhost/');
const response = await GET(request, { params: Promise.resolve({}) });
const data = await response.json();
expect(response.status).toBe(200);
expect(data).toEqual({ authorized: false });
});
it('should work with multiple middlewares accessing metadata', async () => {
const GET = createZodRoute()
.defineMetadata(metadataSchema)
.use(async ({ next, metadata }) => {
const result = await next({ ctx: { hasPermission: metadata?.permission === 'read' } });
return result;
})
.use(async ({ next, metadata }) => {
const result = await next({ ctx: { isAdmin: metadata?.role === 'admin' } });
return result;
})
.metadata({ permission: 'read', role: 'admin' })
.handler((request, context) => {
const { hasPermission, isAdmin } = context.ctx;
return Response.json({ hasPermission, isAdmin }, { status: 200 });
});
const request = new Request('http://localhost/');
const response = await GET(request, {
params: Promise.resolve({}),
});
const data = await response.json();
expect(response.status).toBe(200);
expect(data).toEqual({
hasPermission: true,
isAdmin: true,
});
});
});
describe('enhanced middleware functionality', () => {
it('should allow middleware to execute code before and after handler', async () => {
const logs: string[] = [];
const loggingMiddleware: MiddlewareFunction = async ({ next }) => {
logs.push('before handler');
const startTime = performance.now();
const response = await next();
const endTime = performance.now();
logs.push(`after handler - took ${Math.round(endTime - startTime)}ms`);
return response;
};
const GET = createZodRoute()
.use(loggingMiddleware)
.handler(() => {
logs.push('handler executed');
return { success: true };
});
const request = new Request('http://localhost/');
const response = await GET(request, { params: Promise.resolve({}) });
const data = await response.json();
expect(response.status).toBe(200);
expect(data).toEqual({ success: true });
expect(logs).toEqual(['before handler', 'handler executed', expect.stringMatching(/after handler - took \d+ms/)]);
});
it('should allow middleware to modify response', async () => {
const GET = createZodRoute()
.use(async ({ next }) => {
const response = await next();
// Create new response with additional header
return new Response(response.body, {
status: response.status,
headers: {
...Object.fromEntries(response.headers.entries()),
'X-Custom-Header': 'middleware-added',
},
});
})
.handler(() => {
return { success: true };
});
const request = new Request('http://localhost/');
const response = await GET(request, { params: Promise.resolve({}) });
expect(response.headers.get('X-Custom-Header')).toBe('middleware-added');
expect(await response.json()).toEqual({ success: true });
});
it('should pass context through middleware chain', async () => {
const GET = createZodRoute()
.use(async ({ next }) => {
const response = await next({
ctx: { value1: 'first' },
});
return response;
})
.use(async ({ ctx, next }) => {
expect(ctx).toHaveProperty('value1', 'first');
const response = await next({
ctx: { value2: 'second' },
});
return response;
})
.handler((request: Request, context) => {
expect(context.ctx).toEqual({
value1: 'first',
value2: 'second',
});
return { success: true };
});
const request = new Request('http://localhost/');
const response = await GET(request, { params: Promise.resolve({}) });
expect(response.status).toBe(200);
expect(await response.json()).toEqual({ success: true });
});
it('should allow middleware to short-circuit the chain', async () => {
const GET = createZodRoute()
.use(async ({ next }) => {
// Short circuit with error response
return new Response(JSON.stringify({ error: 'Unauthorized' }), {
status: 401,
headers: { 'Content-Type': 'application/json' },
});
// This won't be called
await next();
})
.handler(() => {
// This won't be called
return { success: true };
});
const request = new Request('http://localhost/');
const response = await GET(request, { params: Promise.resolve({}) });
expect(response.status).toBe(401);
expect(await response.json()).toEqual({ error: 'Unauthorized' });
});
it('should handle custom error thrown inside a middleware', async () => {
class CustomMiddlewareError extends Error {
constructor(message: string) {
super(message);
this.name = 'CustomMiddlewareError';
}
}
const handleServerError = (error: Error) => {
if (error instanceof CustomMiddlewareError) {
return new Response(JSON.stringify({ message: error.name, details: error.message }), { status: 400 });
}
return new Response(JSON.stringify({ message: 'Something went wrong' }), { status: 500 });
};
const GET = createZodRoute({
handleServerError,
})
.use(async () => {
throw new CustomMiddlewareError('Middleware error occurred');
})
.handler(() => {
return { success: true };
});
const request = new Request('http://localhost/');
const response = await GET(request, { params: Promise.resolve({}) });
const data = await response.json();
expect(response.status).toBe(400);
expect(data).toEqual({ message: 'CustomMiddlewareError', details: 'Middleware error occurred' });
});
});
describe('permission checking with metadata', () => {
const permissionsMetadataSchema = z.object({
requiredPermissions: z.array(z.string()).optional(),
});
const permissionCheckMiddleware: MiddlewareFunction<
Record<string, unknown>,
{ authorized: boolean },
z.infer<typeof permissionsMetadataSchema>
> = async ({ next, metadata, request }) => {
// Get user permissions from auth header (in a real app)
const userPermissions = request.headers.get('x-user-permissions')?.split(',') || [];
// If no required permissions in metadata, allow access
if (!metadata?.requiredPermissions || metadata.requiredPermissions.length === 0) {
return next({ ctx: { authorized: true } });
}
// Check if user has all required permissions
const hasAllPermissions = metadata.requiredPermissions.every((permission) => userPermissions.includes(permission));
if (!hasAllPermissions) {
// Short-circuit with 403 Forbidden response
return new Response(
JSON.stringify({
error: 'Forbidden',
message: 'You do not have the required permissions',
}),
{
status: 403,
headers: { 'Content-Type': 'application/json' },
},
);
}
// Continue with authorized context
return next({ ctx: { authorized: true } });
};
it('should allow access when user has required permissions', async () => {
const GET = createZodRoute()
.defineMetadata(permissionsMetadataSchema)
.use(permissionCheckMiddleware)
.metadata({ requiredPermissions: ['read:users'] })
.handler((request, context) => {
const { authorized } = context.ctx;
return Response.json({ success: true, authorized }, { status: 200 });
});
const request = new Request('http://localhost/', {
headers: {
'x-user-permissions': 'read:users,write:users',
},
});
const response = await GET(request, { params: Promise.resolve({}) });
const data = await response.json();
expect(response.status).toBe(200);
expect(data).toEqual({ success: true, authorized: true });
});
it('should deny access when user lacks required permissions', async () => {
const GET = createZodRoute()
.defineMetadata(permissionsMetadataSchema)
.use(permissionCheckMiddleware)
.metadata({ requiredPermissions: ['admin:users'] })
.handler(() => {
// This handler should not be called
return Response.json({ success: true }, { status: 200 });
});
const request = new Request('http://localhost/', {
headers: {
'x-user-permissions': 'read:users,write:users',
},
});
const response = await GET(request, { params: Promise.resolve({}) });
const data = await response.json();
expect(response.status).toBe(403);
expect(data).toEqual({
error: 'Forbidden',
message: 'You do not have the required permissions',
});
});
it('should allow access when no permissions are required', async () => {
const GET = createZodRoute()
.defineMetadata(permissionsMetadataSchema)
.use(permissionCheckMiddleware)
.metadata({ requiredPermissions: [] })
.handler((request, context) => {
const { authorized } = context.ctx;
return Response.json({ success: true, authorized }, { status: 200 });
});
const request = new Request('http://localhost/');
const response = await GET(request, { params: Promise.resolve({}) });
const data = await response.json();
expect(response.status).toBe(200);
expect(data).toEqual({ success: true, authorized: true });
});
it('should allow access when metadata is not provided', async () => {
const GET = createZodRoute()
.defineMetadata(permissionsMetadataSchema)
.use(permissionCheckMiddleware)
.handler((request, context) => {
const { authorized } = context.ctx;
return Response.json({ success: true, authorized }, { status: 200 });
});
const request = new Request('http://localhost/');
const response = await GET(request, { params: Promise.resolve({}) });
const data = await response.json();
expect(response.status).toBe(200);
expect(data).toEqual({ success: true, authorized: true });
});
it('should work with other middleware and validations', async () => {
const loggingMiddleware: MiddlewareFunction = async ({ next }) => {
const response = await next({ ctx: { logged: true } });
return response;
};
const GET = createZodRoute()
.defineMetadata(permissionsMetadataSchema)
.params(paramsSchema)
.use(loggingMiddleware)
.use(permissionCheckMiddleware)
.metadata({ requiredPermissions: ['read:users'] })
.handler((request, context) => {
const { id } = context.params;
const { authorized, logged } = context.ctx;
return Response.json({ id, authorized, logged }, { status: 200 });
});
const request = new Request('http://localhost/', {
headers: {
'x-user-permissions': 'read:users,write:users',
},
});
const response = await GET(request, {
params: paramsToPromise({ id: '550e8400-e29b-41d4-a716-446655440000' }),
});
const data = await response.json();
expect(response.status).toBe(200);
expect(data).toEqual({
id: '550e8400-e29b-41d4-a716-446655440000',
authorized: true,
logged: true,
});