-
Notifications
You must be signed in to change notification settings - Fork 5
Expand file tree
/
Copy pathrest.test.ts
More file actions
1517 lines (1322 loc) · 57.1 KB
/
Copy pathrest.test.ts
File metadata and controls
1517 lines (1322 loc) · 57.1 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
// Copyright (c) 2025 ObjectStack. Licensed under the Apache-2.0 license.
import { describe, it, expect, beforeEach, vi } from 'vitest';
import { RouteManager, RouteGroupBuilder } from './route-manager';
import { RestServer, mapDataError } from './rest-server';
import { createRestApiPlugin } from './rest-api-plugin';
import type { RestApiPluginConfig } from './rest-api-plugin';
// ---------------------------------------------------------------------------
// Mocks & Helpers
// ---------------------------------------------------------------------------
/** Minimal IHttpServer mock */
function createMockServer() {
return {
get: vi.fn(),
post: vi.fn(),
put: vi.fn(),
delete: vi.fn(),
patch: vi.fn(),
use: vi.fn(),
listen: vi.fn().mockResolvedValue(undefined),
close: vi.fn().mockResolvedValue(undefined),
};
}
/** Minimal ObjectStackProtocol mock */
function createMockProtocol() {
return {
getDiscovery: vi.fn().mockResolvedValue({
version: 'v0',
endpoints: { data: '', metadata: '', ui: '', auth: '/auth' },
}),
getMetaTypes: vi.fn().mockResolvedValue([]),
getMetaItems: vi.fn().mockResolvedValue([]),
getMetaItem: vi.fn().mockResolvedValue({}),
getMetaItemCached: undefined as any,
saveMetaItem: undefined as any,
getUiView: undefined as any,
findData: vi.fn().mockResolvedValue([]),
getData: vi.fn().mockResolvedValue({}),
createData: vi.fn().mockResolvedValue({ id: '1' }),
updateData: vi.fn().mockResolvedValue({}),
deleteData: vi.fn().mockResolvedValue({ success: true }),
batchData: undefined as any,
createManyData: undefined as any,
updateManyData: undefined as any,
deleteManyData: undefined as any,
};
}
/** Minimal PluginContext mock */
function createMockPluginContext(services: Record<string, any> = {}) {
return {
registerService: vi.fn(),
getService: vi.fn((name: string) => {
if (services[name]) return services[name];
throw new Error(`Service '${name}' not found`);
}),
getServices: vi.fn(() => new Map(Object.entries(services))),
hook: vi.fn(),
trigger: vi.fn().mockResolvedValue(undefined),
logger: {
debug: vi.fn(),
info: vi.fn(),
warn: vi.fn(),
error: vi.fn(),
},
getKernel: vi.fn(),
};
}
/** Dummy handler */
const noop = vi.fn();
// ---------------------------------------------------------------------------
// RouteManager
// ---------------------------------------------------------------------------
describe('RouteManager', () => {
let server: ReturnType<typeof createMockServer>;
let manager: RouteManager;
beforeEach(() => {
server = createMockServer();
manager = new RouteManager(server as any);
});
// -- Registration --------------------------------------------------------
describe('register', () => {
it('should register a GET route and delegate to server.get', () => {
manager.register({ method: 'GET', path: '/users', handler: noop });
expect(server.get).toHaveBeenCalledWith('/users', noop);
expect(manager.count()).toBe(1);
});
it('should register POST, PUT, PATCH, DELETE routes', () => {
manager.register({ method: 'POST', path: '/a', handler: noop });
manager.register({ method: 'PUT', path: '/b', handler: noop });
manager.register({ method: 'PATCH', path: '/c', handler: noop });
manager.register({ method: 'DELETE', path: '/d', handler: noop });
expect(server.post).toHaveBeenCalledWith('/a', noop);
expect(server.put).toHaveBeenCalledWith('/b', noop);
expect(server.patch).toHaveBeenCalledWith('/c', noop);
expect(server.delete).toHaveBeenCalledWith('/d', noop);
expect(manager.count()).toBe(4);
});
it('should store metadata on the route entry', () => {
manager.register({
method: 'GET',
path: '/items',
handler: noop,
metadata: { summary: 'List items', tags: ['items'] },
});
const entry = manager.get('GET', '/items');
expect(entry).toBeDefined();
expect(entry!.metadata?.summary).toBe('List items');
expect(entry!.metadata?.tags).toContain('items');
});
it('should throw when a string handler is provided', () => {
expect(() =>
manager.register({ method: 'GET', path: '/x', handler: 'someHandler' }),
).toThrow(/String-based route handlers/);
});
});
// -- registerMany --------------------------------------------------------
describe('registerMany', () => {
it('should register multiple routes at once', () => {
manager.registerMany([
{ method: 'GET', path: '/a', handler: noop },
{ method: 'POST', path: '/b', handler: noop },
]);
expect(manager.count()).toBe(2);
});
});
// -- Lookup / query -------------------------------------------------------
describe('get', () => {
it('should return undefined for unregistered route', () => {
expect(manager.get('GET', '/nothing')).toBeUndefined();
});
it('should return the entry for a registered route', () => {
manager.register({ method: 'GET', path: '/users', handler: noop });
const entry = manager.get('GET', '/users');
expect(entry).toBeDefined();
expect(entry!.path).toBe('/users');
});
});
describe('getAll', () => {
it('should return all registered routes', () => {
manager.register({ method: 'GET', path: '/a', handler: noop });
manager.register({ method: 'POST', path: '/b', handler: noop });
expect(manager.getAll()).toHaveLength(2);
});
});
describe('getByMethod', () => {
it('should filter routes by HTTP method', () => {
manager.register({ method: 'GET', path: '/a', handler: noop });
manager.register({ method: 'GET', path: '/b', handler: noop });
manager.register({ method: 'POST', path: '/c', handler: noop });
expect(manager.getByMethod('GET')).toHaveLength(2);
expect(manager.getByMethod('POST')).toHaveLength(1);
expect(manager.getByMethod('DELETE')).toHaveLength(0);
});
});
describe('getByPrefix', () => {
it('should filter routes by path prefix', () => {
manager.register({ method: 'GET', path: '/api/users', handler: noop });
manager.register({ method: 'GET', path: '/api/items', handler: noop });
manager.register({ method: 'GET', path: '/other', handler: noop });
expect(manager.getByPrefix('/api')).toHaveLength(2);
});
});
describe('getByTag', () => {
it('should filter routes by metadata tag', () => {
manager.register({
method: 'GET', path: '/a', handler: noop,
metadata: { tags: ['users'] },
});
manager.register({
method: 'GET', path: '/b', handler: noop,
metadata: { tags: ['items'] },
});
manager.register({ method: 'GET', path: '/c', handler: noop });
expect(manager.getByTag('users')).toHaveLength(1);
expect(manager.getByTag('missing')).toHaveLength(0);
});
});
// -- Unregister -----------------------------------------------------------
describe('unregister', () => {
it('should remove a route from the registry', () => {
manager.register({ method: 'GET', path: '/x', handler: noop });
expect(manager.count()).toBe(1);
manager.unregister('GET', '/x');
expect(manager.count()).toBe(0);
expect(manager.get('GET', '/x')).toBeUndefined();
});
});
// -- Clear ----------------------------------------------------------------
describe('clear', () => {
it('should remove all routes', () => {
manager.registerMany([
{ method: 'GET', path: '/a', handler: noop },
{ method: 'POST', path: '/b', handler: noop },
]);
manager.clear();
expect(manager.count()).toBe(0);
});
});
// -- Group ----------------------------------------------------------------
describe('group', () => {
it('should create routes with the prefix prepended', () => {
manager.group('/api/v1', (group) => {
group.get('/users', noop);
group.post('/users', noop);
group.put('/users/:id', noop);
group.patch('/users/:id', noop);
group.delete('/users/:id', noop);
});
expect(manager.count()).toBe(5);
expect(manager.get('GET', '/api/v1/users')).toBeDefined();
expect(manager.get('POST', '/api/v1/users')).toBeDefined();
expect(manager.get('PUT', '/api/v1/users/:id')).toBeDefined();
expect(manager.get('PATCH', '/api/v1/users/:id')).toBeDefined();
expect(manager.get('DELETE', '/api/v1/users/:id')).toBeDefined();
});
it('should normalize paths (strip trailing slash on prefix, ensure leading slash on path)', () => {
manager.group('/api/', (group) => {
group.get('items', noop);
});
expect(manager.get('GET', '/api/items')).toBeDefined();
});
it('should allow chaining on group builder methods', () => {
manager.group('/api', (group) => {
const result = group
.get('/a', noop)
.post('/b', noop);
expect(result).toBe(group);
});
});
});
});
// ---------------------------------------------------------------------------
// RestServer
// ---------------------------------------------------------------------------
describe('RestServer', () => {
let server: ReturnType<typeof createMockServer>;
let protocol: ReturnType<typeof createMockProtocol>;
beforeEach(() => {
server = createMockServer();
protocol = createMockProtocol();
});
// -- Constructor & defaults -----------------------------------------------
describe('constructor', () => {
it('should create a RestServer with default config', () => {
const rest = new RestServer(server as any, protocol as any);
expect(rest).toBeDefined();
expect(rest.getRouteManager()).toBeInstanceOf(RouteManager);
});
it('should accept custom config', () => {
const rest = new RestServer(server as any, protocol as any, {
api: { version: 'v2', basePath: '/custom' },
} as any);
expect(rest).toBeDefined();
});
});
// -- registerRoutes -------------------------------------------------------
describe('registerRoutes', () => {
it('should register discovery, metadata, UI, CRUD, and batch routes by default', () => {
const rest = new RestServer(server as any, protocol as any);
rest.registerRoutes();
const routes = rest.getRoutes();
expect(routes.length).toBeGreaterThan(0);
// Expect at least discovery + metadata + CRUD routes
const paths = routes.map((r) => r.path);
// Discovery (both basePath and basePath/discovery)
expect(paths).toContain('/api/v1');
expect(paths).toContain('/api/v1/discovery');
// Metadata
expect(paths.some((p) => p.includes('/meta'))).toBe(true);
// CRUD
expect(paths.some((p) => p.includes('/data'))).toBe(true);
});
it('should use custom apiPath when specified', () => {
const rest = new RestServer(server as any, protocol as any, {
api: { apiPath: '/custom/path' },
} as any);
rest.registerRoutes();
const paths = rest.getRoutes().map((r) => r.path);
expect(paths.some((p) => p.startsWith('/custom/path'))).toBe(true);
});
it('should skip CRUD routes when enableCrud is false', () => {
const rest = new RestServer(server as any, protocol as any, {
api: { enableCrud: false },
} as any);
rest.registerRoutes();
const tags = rest.getRoutes().flatMap((r) => r.metadata?.tags ?? []);
expect(tags).not.toContain('crud');
});
it('should skip metadata routes when enableMetadata is false', () => {
const rest = new RestServer(server as any, protocol as any, {
api: { enableMetadata: false },
} as any);
rest.registerRoutes();
const routes = rest.getRoutes();
// Only the PUT /meta/:type/:name is always registered, but enableMetadata=false
// skips the entire registerMetadataEndpoints call
expect(routes.every((r) => !r.path.includes('/meta'))).toBe(true);
});
it('should skip discovery when enableDiscovery is false', () => {
const rest = new RestServer(server as any, protocol as any, {
api: { enableDiscovery: false },
} as any);
rest.registerRoutes();
const routes = rest.getRoutes();
// Neither basePath nor basePath/discovery should be registered
const discoveryRoutes = routes.filter((r) =>
r.metadata?.tags?.includes('discovery'),
);
expect(discoveryRoutes).toHaveLength(0);
});
it('should skip batch routes when enableBatch is false', () => {
const rest = new RestServer(server as any, protocol as any, {
api: { enableBatch: false },
} as any);
rest.registerRoutes();
const tags = rest.getRoutes().flatMap((r) => r.metadata?.tags ?? []);
expect(tags).not.toContain('batch');
});
it('should register batch endpoints when protocol implements batch methods', () => {
protocol.batchData = vi.fn().mockResolvedValue({});
protocol.createManyData = vi.fn().mockResolvedValue([]);
protocol.updateManyData = vi.fn().mockResolvedValue([]);
protocol.deleteManyData = vi.fn().mockResolvedValue([]);
const rest = new RestServer(server as any, protocol as any);
rest.registerRoutes();
const batchRoutes = rest.getRoutes().filter((r) =>
r.metadata?.tags?.includes('batch'),
);
expect(batchRoutes.length).toBeGreaterThan(0);
});
it('should register UI view endpoint when enableUi is true', () => {
const rest = new RestServer(server as any, protocol as any);
rest.registerRoutes();
const uiRoutes = rest.getRoutes().filter((r) =>
r.metadata?.tags?.includes('ui'),
);
expect(uiRoutes.length).toBeGreaterThan(0);
});
it('should not register i18n endpoints (i18n routes are self-registered by service-i18n)', () => {
const rest = new RestServer(server as any, protocol as any);
rest.registerRoutes();
const i18nRoutes = rest.getRoutes().filter((r) =>
r.metadata?.tags?.includes('i18n'),
);
expect(i18nRoutes).toHaveLength(0);
});
});
// -- getRouteManager / getRoutes ------------------------------------------
describe('getRouteManager', () => {
it('should return the internal RouteManager instance', () => {
const rest = new RestServer(server as any, protocol as any);
const rm = rest.getRouteManager();
expect(rm).toBeInstanceOf(RouteManager);
});
});
describe('getRoutes', () => {
it('should return an empty array before registerRoutes is called', () => {
const rest = new RestServer(server as any, protocol as any);
expect(rest.getRoutes()).toEqual([]);
});
});
describe('getData handler expand/select forwarding', () => {
function getRoute(rest: any, pathSuffix: string) {
const routes = rest.getRoutes();
return routes.find(
(r: any) => r.method === 'GET' && r.path === `/api/v1/data/${pathSuffix}`,
);
}
it('should pass expand and select query params to protocol.getData', async () => {
const rest = new RestServer(server as any, protocol as any);
rest.registerRoutes();
const getByIdRoute = getRoute(rest, ':object/:id');
expect(getByIdRoute).toBeDefined();
// Simulate request with expand and select query params
const mockReq = {
params: { object: 'order_item', id: 'oi_123' },
query: { expand: 'order,product', select: 'name,total' },
};
const mockRes = {
json: vi.fn(),
status: vi.fn().mockReturnThis(),
};
protocol.getData.mockResolvedValue({
object: 'order_item',
id: 'oi_123',
record: { id: 'oi_123', name: 'Item 1' },
});
await getByIdRoute!.handler(mockReq, mockRes);
expect(protocol.getData).toHaveBeenCalledWith(
expect.objectContaining({
object: 'order_item',
id: 'oi_123',
expand: 'order,product',
select: 'name,total',
}),
);
});
it('should omit expand/select when not present in query', async () => {
const rest = new RestServer(server as any, protocol as any);
rest.registerRoutes();
const getByIdRoute = getRoute(rest, ':object/:id');
const mockReq = {
params: { object: 'contact', id: 'c_1' },
query: {},
};
const mockRes = {
json: vi.fn(),
status: vi.fn().mockReturnThis(),
};
protocol.getData.mockResolvedValue({
object: 'contact',
id: 'c_1',
record: { id: 'c_1' },
});
await getByIdRoute!.handler(mockReq, mockRes);
// Should NOT have expand or select keys in the call
const callArg = protocol.getData.mock.calls[protocol.getData.mock.calls.length - 1][0];
expect(callArg).toEqual({ object: 'contact', id: 'c_1' });
});
});
describe('findData handler expand/populate forwarding', () => {
function getListRoute(rest: any) {
const routes = rest.getRoutes();
return routes.find(
(r: any) => r.method === 'GET' && r.path === '/api/v1/data/:object',
);
}
it('should pass query params including expand to protocol.findData', async () => {
const rest = new RestServer(server as any, protocol as any);
rest.registerRoutes();
const listRoute = getListRoute(rest);
expect(listRoute).toBeDefined();
const mockReq = {
params: { object: 'order_item' },
query: { expand: 'order,product', top: '10' },
};
const mockRes = {
json: vi.fn(),
status: vi.fn().mockReturnThis(),
};
protocol.findData.mockResolvedValue({
object: 'order_item',
records: [],
total: 0,
});
await listRoute!.handler(mockReq, mockRes);
expect(protocol.findData).toHaveBeenCalledWith({
object: 'order_item',
query: { expand: 'order,product', top: '10' },
});
});
it('should pass populate query param to protocol.findData', async () => {
const rest = new RestServer(server as any, protocol as any);
rest.registerRoutes();
const listRoute = getListRoute(rest);
const mockReq = {
params: { object: 'task' },
query: { populate: 'assignee,project' },
};
const mockRes = {
json: vi.fn(),
status: vi.fn().mockReturnThis(),
};
protocol.findData.mockResolvedValue({
object: 'task',
records: [],
total: 0,
});
await listRoute!.handler(mockReq, mockRes);
expect(protocol.findData).toHaveBeenCalledWith({
object: 'task',
query: { populate: 'assignee,project' },
});
});
});
// -----------------------------------------------------------------------
// GET /data/:object/export — streaming CSV / JSON export (M10.21 / C.21)
// -----------------------------------------------------------------------
describe('export handler', () => {
function getExportRoute(rest: any) {
const routes = rest.getRoutes();
return routes.find(
(r: any) => r.method === 'GET' && r.path === '/api/v1/data/:object/export',
);
}
function makeRes() {
const chunks: string[] = [];
const headers: Record<string, string> = {};
let status = 200;
const res: any = {
write: (s: string) => { chunks.push(s); },
end: vi.fn(),
header: (n: string, v: string) => { headers[n] = v; return res; },
status: (code: number) => { status = code; return res; },
json: vi.fn(),
};
return { res, chunks, headers, getStatus: () => status };
}
it('streams CSV with header row and quotes risky cells', async () => {
const rest = new RestServer(server as any, protocol as any);
rest.registerRoutes();
const route = getExportRoute(rest);
expect(route).toBeDefined();
protocol.findData.mockResolvedValueOnce({
data: [
{ id: '1', name: 'Acme, Inc.', note: 'line1\nline2' },
{ id: '2', name: 'Beta "Co"', note: null },
],
});
// Second call returns empty -> ends the stream
protocol.findData.mockResolvedValueOnce({ data: [] });
const { res, chunks, headers } = makeRes();
const req = {
params: { object: 'account' },
query: { format: 'csv', fields: 'id,name,note', limit: '500' },
};
await route!.handler(req as any, res);
expect(headers['Content-Type']).toBe('text/csv; charset=utf-8');
expect(headers['Content-Disposition']).toMatch(/attachment; filename="account-\d{4}-\d{2}-\d{2}\.csv"/);
const text = chunks.join('');
expect(text.startsWith('id,name,note\r\n')).toBe(true);
expect(text).toContain('1,"Acme, Inc.","line1\nline2"');
expect(text).toContain('2,"Beta ""Co""",');
expect(res.end).toHaveBeenCalled();
});
it('streams JSON array when format=json', async () => {
const rest = new RestServer(server as any, protocol as any);
rest.registerRoutes();
const route = getExportRoute(rest);
protocol.findData.mockResolvedValueOnce({
data: [{ id: 'a' }, { id: 'b' }],
});
protocol.findData.mockResolvedValueOnce({ data: [] });
const { res, chunks, headers } = makeRes();
await route!.handler({
params: { object: 'lead' },
query: { format: 'json' },
} as any, res);
expect(headers['Content-Type']).toBe('application/json; charset=utf-8');
const text = chunks.join('');
expect(text).toBe('[{"id":"a"},{"id":"b"}]');
});
it('rejects invalid JSON in filter query', async () => {
const rest = new RestServer(server as any, protocol as any);
rest.registerRoutes();
const route = getExportRoute(rest);
const { res } = makeRes();
await route!.handler({
params: { object: 'account' },
query: { filter: '{not json' },
} as any, res);
expect(res.json).toHaveBeenCalledWith(expect.objectContaining({ code: 'INVALID_REQUEST' }));
});
it('honours the hard 50k row cap', async () => {
const rest = new RestServer(server as any, protocol as any);
rest.registerRoutes();
const route = getExportRoute(rest);
// Always return full chunks so the loop is bounded only by `limit`.
protocol.findData.mockImplementation(async ({ query }: any) => {
const take = query?.$top ?? 0;
return { data: Array.from({ length: take }, (_v, i) => ({ id: String((query?.$skip ?? 0) + i) })) };
});
const { res, chunks } = makeRes();
await route!.handler({
params: { object: 'big' },
query: { format: 'csv', limit: '999999', fields: 'id' },
} as any, res);
const lines = chunks.join('').split('\r\n').filter(Boolean);
// 1 header + 50 000 rows.
expect(lines.length).toBe(50_001);
});
});
// -----------------------------------------------------------------------
// POST /email/send — IEmailService bridge (M11.B1 / M10.7)
// -----------------------------------------------------------------------
describe('email send handler', () => {
function getEmailRoute(rest: any) {
const routes = rest.getRoutes();
return routes.find(
(r: any) => r.method === 'POST' && r.path === '/api/v1/email/send',
);
}
it('returns 501 when no email service provider is wired', async () => {
const rest = new RestServer(server as any, protocol as any);
rest.registerRoutes();
const route = getEmailRoute(rest);
expect(route).toBeDefined();
const res = { json: vi.fn(), status: vi.fn().mockReturnThis() };
await route!.handler({ body: { to: 'a@b.com', subject: 'Hi', text: 'x' } } as any, res as any);
expect(res.status).toHaveBeenCalledWith(501);
expect(res.json).toHaveBeenCalledWith(expect.objectContaining({ code: 'NOT_IMPLEMENTED' }));
});
it('calls email service and returns the SendEmailResult on success', async () => {
const send = vi.fn(async () => ({ id: 'em-1', status: 'sent', messageId: '<m1@x>' }));
const provider = async () => ({ send });
const rest = new RestServer(
server as any, protocol as any, {},
undefined, undefined, undefined, undefined, undefined,
provider as any,
);
rest.registerRoutes();
const route = getEmailRoute(rest);
const res = { json: vi.fn(), status: vi.fn().mockReturnThis() };
await route!.handler({
body: { to: 'a@b.com', from: 'no@reply.com', subject: 'Hi', text: 'x' },
} as any, res as any);
expect(send).toHaveBeenCalledWith(expect.objectContaining({
to: 'a@b.com', from: 'no@reply.com', subject: 'Hi',
}));
expect(res.json).toHaveBeenCalledWith({ id: 'em-1', status: 'sent', messageId: '<m1@x>' });
});
it('translates VALIDATION_FAILED errors into 400', async () => {
const send = vi.fn(async () => { throw new Error('VALIDATION_FAILED: subject is required'); });
const provider = async () => ({ send });
const rest = new RestServer(
server as any, protocol as any, {},
undefined, undefined, undefined, undefined, undefined,
provider as any,
);
rest.registerRoutes();
const route = getEmailRoute(rest);
const res = { json: vi.fn(), status: vi.fn().mockReturnThis() };
await route!.handler({ body: { to: 'a@b.com', subject: '', text: 'x' } } as any, res as any);
expect(res.status).toHaveBeenCalledWith(400);
expect(res.json).toHaveBeenCalledWith(expect.objectContaining({
code: 'VALIDATION_FAILED',
error: 'subject is required',
}));
});
});
// -----------------------------------------------------------------------
// /data/:object/:id/shares — ISharingService bridge (M11.C17)
// -----------------------------------------------------------------------
describe('sharing endpoints', () => {
function getShareRoutes(rest: any) {
const routes = rest.getRoutes();
return {
list: routes.find((r: any) => r.method === 'GET' && r.path === '/api/v1/data/:object/:id/shares'),
grant: routes.find((r: any) => r.method === 'POST' && r.path === '/api/v1/data/:object/:id/shares'),
revoke: routes.find((r: any) => r.method === 'DELETE' && r.path === '/api/v1/data/:object/:id/shares/:shareId'),
};
}
it('returns 501 when no sharing service provider is wired', async () => {
const rest = new RestServer(server as any, protocol as any);
rest.registerRoutes();
const { list, grant, revoke } = getShareRoutes(rest);
expect(list && grant && revoke).toBeDefined();
for (const route of [list, grant, revoke]) {
const res = { json: vi.fn(), status: vi.fn().mockReturnThis(), end: vi.fn() };
await route!.handler({ params: { object: 'a', id: '1', shareId: 's1' }, body: {} } as any, res as any);
expect(res.status).toHaveBeenCalledWith(501);
}
});
it('GET returns the rows produced by listShares()', async () => {
const listShares = vi.fn(async () => [{ id: 'shr_1', recipient_id: 'bob' }]);
const provider = async () => ({ listShares, grant: vi.fn(), revoke: vi.fn() });
const rest = new RestServer(
server as any, protocol as any, {},
undefined, undefined, undefined, undefined, undefined,
undefined, provider as any,
);
rest.registerRoutes();
const { list } = getShareRoutes(rest);
const res = { json: vi.fn(), status: vi.fn().mockReturnThis() };
await list!.handler({ params: { object: 'account', id: 'a1' } } as any, res as any);
expect(listShares).toHaveBeenCalledWith('account', 'a1', expect.anything());
expect(res.json).toHaveBeenCalledWith({ data: [{ id: 'shr_1', recipient_id: 'bob' }] });
});
it('POST creates a grant and returns 201', async () => {
const grant = vi.fn(async (input: any) => ({ id: 'shr_2', ...input }));
const provider = async () => ({ listShares: vi.fn(), grant, revoke: vi.fn() });
const rest = new RestServer(
server as any, protocol as any, {},
undefined, undefined, undefined, undefined, undefined,
undefined, provider as any,
);
rest.registerRoutes();
const { grant: route } = getShareRoutes(rest);
const res = { json: vi.fn(), status: vi.fn().mockReturnThis() };
await route!.handler({
params: { object: 'account', id: 'a1' },
body: { recipientId: 'bob', accessLevel: 'edit' },
} as any, res as any);
expect(grant).toHaveBeenCalledWith(
expect.objectContaining({ object: 'account', recordId: 'a1', recipientId: 'bob', accessLevel: 'edit' }),
expect.anything(),
);
expect(res.status).toHaveBeenCalledWith(201);
});
it('POST surfaces VALIDATION_FAILED as 400', async () => {
const grant = vi.fn(async () => { throw new Error('VALIDATION_FAILED: recipientId is required'); });
const provider = async () => ({ listShares: vi.fn(), grant, revoke: vi.fn() });
const rest = new RestServer(
server as any, protocol as any, {},
undefined, undefined, undefined, undefined, undefined,
undefined, provider as any,
);
rest.registerRoutes();
const { grant: route } = getShareRoutes(rest);
const res = { json: vi.fn(), status: vi.fn().mockReturnThis() };
await route!.handler({ params: { object: 'account', id: 'a1' }, body: {} } as any, res as any);
expect(res.status).toHaveBeenCalledWith(400);
expect(res.json).toHaveBeenCalledWith(expect.objectContaining({ code: 'VALIDATION_FAILED' }));
});
it('DELETE revokes and returns 204', async () => {
const revoke = vi.fn(async () => undefined);
const provider = async () => ({ listShares: vi.fn(), grant: vi.fn(), revoke });
const rest = new RestServer(
server as any, protocol as any, {},
undefined, undefined, undefined, undefined, undefined,
undefined, provider as any,
);
rest.registerRoutes();
const { revoke: route } = getShareRoutes(rest);
const res = { json: vi.fn(), status: vi.fn().mockReturnThis(), end: vi.fn() };
await route!.handler({ params: { object: 'account', id: 'a1', shareId: 'shr_X' } } as any, res as any);
expect(revoke).toHaveBeenCalledWith('shr_X', expect.anything());
expect(res.status).toHaveBeenCalledWith(204);
});
});
// -----------------------------------------------------------------------
// /api/v1/reports — IReportService bridge (M11.C16; promoted to top-level)
// -----------------------------------------------------------------------
describe('reports endpoints', () => {
function getReportRoutes(rest: any) {
const routes = rest.getRoutes();
return {
list: routes.find((r: any) => r.method === 'GET' && r.path === '/api/v1/reports'),
save: routes.find((r: any) => r.method === 'POST' && r.path === '/api/v1/reports'),
get: routes.find((r: any) => r.method === 'GET' && r.path === '/api/v1/reports/:id'),
del: routes.find((r: any) => r.method === 'DELETE' && r.path === '/api/v1/reports/:id'),
run: routes.find((r: any) => r.method === 'POST' && r.path === '/api/v1/reports/:id/run'),
schedule: routes.find((r: any) => r.method === 'POST' && r.path === '/api/v1/reports/:id/schedule'),
schedules: routes.find((r: any) => r.method === 'GET' && r.path === '/api/v1/reports/:id/schedules'),
unschedule: routes.find((r: any) => r.method === 'DELETE' && r.path === '/api/v1/reports/schedules/:scheduleId'),
};
}
function makeRest(provider?: any) {
const rest = new RestServer(
server as any, protocol as any, {},
undefined, undefined, undefined, undefined, undefined,
undefined, undefined, provider,
);
rest.registerRoutes();
return rest;
}
it('returns 501 when no reports service provider is wired', async () => {
const rest = makeRest();
const routes = getReportRoutes(rest);
const targets = [routes.list, routes.save, routes.get, routes.del, routes.run, routes.schedule, routes.schedules, routes.unschedule];
for (const route of targets) {
expect(route).toBeDefined();
const res = { json: vi.fn(), status: vi.fn().mockReturnThis(), end: vi.fn() };
await route!.handler({ params: { id: 'r1', scheduleId: 's1' }, body: {}, query: {} } as any, res as any);
expect(res.status).toHaveBeenCalledWith(501);
}
});
it('GET /reports returns rows produced by listReports()', async () => {
const listReports = vi.fn(async () => [{ id: 'rpt_1', name: 'Open leads' }]);
const rest = makeRest(async () => ({ listReports }));
const { list } = getReportRoutes(rest);
const res = { json: vi.fn(), status: vi.fn().mockReturnThis() };
await list!.handler({ query: { object: 'lead' } } as any, res as any);
expect(listReports).toHaveBeenCalledWith({ object: 'lead', ownerId: undefined }, expect.anything());
expect(res.json).toHaveBeenCalledWith({ data: [{ id: 'rpt_1', name: 'Open leads' }] });
});
it('POST /reports creates and returns 201', async () => {
const saveReport = vi.fn(async (input: any) => ({ id: 'rpt_new', ...input }));
const rest = makeRest(async () => ({ saveReport }));
const { save } = getReportRoutes(rest);
const res = { json: vi.fn(), status: vi.fn().mockReturnThis() };
await save!.handler({ body: { name: 'X', object: 'lead', query: {} } } as any, res as any);
expect(res.status).toHaveBeenCalledWith(201);
expect(saveReport).toHaveBeenCalled();
});
it('POST /reports surfaces VALIDATION_FAILED as 400', async () => {
const saveReport = vi.fn(async () => { throw new Error('VALIDATION_FAILED: name is required'); });
const rest = makeRest(async () => ({ saveReport }));
const { save } = getReportRoutes(rest);
const res = { json: vi.fn(), status: vi.fn().mockReturnThis() };
await save!.handler({ body: {} } as any, res as any);
expect(res.status).toHaveBeenCalledWith(400);
expect(res.json).toHaveBeenCalledWith(expect.objectContaining({ code: 'VALIDATION_FAILED' }));
});
it('GET /reports/:id returns 404 when missing', async () => {
const getReport = vi.fn(async () => null);
const rest = makeRest(async () => ({ getReport }));
const { get } = getReportRoutes(rest);
const res = { json: vi.fn(), status: vi.fn().mockReturnThis() };
await get!.handler({ params: { id: 'rpt_x' } } as any, res as any);
expect(res.status).toHaveBeenCalledWith(404);
});
it('POST /reports/:id/run returns rendered result', async () => {
const run = vi.fn(async () => ({ reportId: 'r1', rowCount: 2, format: 'csv', body: 'a,b\r\n1,2', rows: [], ranAt: 'now' }));
const rest = makeRest(async () => ({ run }));
const { run: route } = getReportRoutes(rest);
const res = { json: vi.fn(), status: vi.fn().mockReturnThis() };
await route!.handler({ params: { id: 'r1' } } as any, res as any);
expect(run).toHaveBeenCalledWith('r1', expect.anything());
expect(res.json).toHaveBeenCalledWith(expect.objectContaining({ rowCount: 2, body: 'a,b\r\n1,2' }));
});
it('POST /reports/:id/run surfaces REPORT_NOT_FOUND as 404', async () => {
const run = vi.fn(async () => { throw new Error('REPORT_NOT_FOUND: r99'); });
const rest = makeRest(async () => ({ run }));
const { run: route } = getReportRoutes(rest);
const res = { json: vi.fn(), status: vi.fn().mockReturnThis() };
await route!.handler({ params: { id: 'r99' } } as any, res as any);
expect(res.status).toHaveBeenCalledWith(404);
});
it('POST /reports/:id/schedule maps body to scheduleReport input', async () => {
const scheduleReport = vi.fn(async (input: any) => ({ id: 'rsch_1', ...input }));
const rest = makeRest(async () => ({ scheduleReport }));
const { schedule } = getReportRoutes(rest);
const res = { json: vi.fn(), status: vi.fn().mockReturnThis() };
await schedule!.handler({
params: { id: 'r1' },
body: { recipients: ['x@t'], intervalMinutes: 60, format: 'csv' },
} as any, res as any);
expect(scheduleReport).toHaveBeenCalledWith(
expect.objectContaining({ reportId: 'r1', recipients: ['x@t'], intervalMinutes: 60, format: 'csv' }),
expect.anything(),
);
expect(res.status).toHaveBeenCalledWith(201);
});
it('DELETE /reports/schedules/:scheduleId returns 204', async () => {
const unscheduleReport = vi.fn(async () => undefined);
const rest = makeRest(async () => ({ unscheduleReport }));
const { unschedule } = getReportRoutes(rest);
const res = { json: vi.fn(), status: vi.fn().mockReturnThis(), end: vi.fn() };
await unschedule!.handler({ params: { scheduleId: 'rsch_1' } } as any, res as any);
expect(unscheduleReport).toHaveBeenCalledWith('rsch_1', expect.anything());
expect(res.status).toHaveBeenCalledWith(204);
});
});
});
// ---------------------------------------------------------------------------
// createRestApiPlugin
// ---------------------------------------------------------------------------
describe('createRestApiPlugin', () => {
it('should return a plugin object with name and version', () => {
const plugin = createRestApiPlugin();
expect(plugin.name).toBe('com.objectstack.rest.api');
expect(plugin.version).toBe('1.0.0');
expect(typeof plugin.init).toBe('function');
expect(typeof plugin.start).toBe('function');
});
it('should accept custom config', () => {
const cfg: RestApiPluginConfig = {
serverServiceName: 'my.server',
protocolServiceName: 'my.protocol',
};
const plugin = createRestApiPlugin(cfg);
expect(plugin.name).toBe('com.objectstack.rest.api');
});
describe('init', () => {
it('should resolve without error', async () => {
const plugin = createRestApiPlugin();
const ctx = createMockPluginContext();
await expect(plugin.init(ctx as any)).resolves.toBeUndefined();
});
});
describe('start', () => {
it('should warn and skip when http server is not found', async () => {
const plugin = createRestApiPlugin();