-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathCameraKitProvider.test.tsx
More file actions
1045 lines (816 loc) · 34.7 KB
/
CameraKitProvider.test.tsx
File metadata and controls
1045 lines (816 loc) · 34.7 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 React from "react";
import { render, renderHook, waitFor, act } from "@testing-library/react";
import { CameraKitProvider, useCameraKit, useInternalCameraKit } from "./CameraKitProvider";
import { bootstrapCameraKit, CameraKit, CameraKitSession, Lens, createMediaStreamSource } from "@snap/camera-kit";
import { createConsoleLogger } from "./internal/logging";
jest.mock("@snap/camera-kit", () => ({
bootstrapCameraKit: jest.fn(),
createMediaStreamSource: jest.fn(),
Transform2D: jest.fn(),
Count: { count: jest.fn((name: string, n: number, dims: Record<string, string>) => ({ name, n, dims })) },
// Legacy API
Injectable: jest.fn((_token: unknown, _deps: unknown[], factory: unknown) => ({ token: _token, factory })),
externalMetricsSubjectFactory: { token: Symbol("externalMetricsSubjectFactory") },
// Newer API
ConcatInjectable: jest.fn((_token: unknown, factory: () => unknown) => ({ token: _token, factory })),
externalMetricsFactory: { token: Symbol("externalMetricsFactory") },
}));
const mockBootstrapCameraKit = bootstrapCameraKit as jest.MockedFunction<typeof bootstrapCameraKit>;
const mockCreateMediaStreamSource = createMediaStreamSource as jest.MockedFunction<typeof createMediaStreamSource>;
describe("CameraKitProvider", () => {
let mockKit: jest.Mocked<CameraKit>;
let mockSession: jest.Mocked<CameraKitSession>;
let mockLiveCanvas: HTMLCanvasElement;
let mockCaptureCanvas: HTMLCanvasElement;
beforeEach(() => {
jest.clearAllMocks();
// Suppress React act warnings from async bootstrap
jest.spyOn(console, "error").mockImplementation(() => {});
mockLiveCanvas = document.createElement("canvas");
mockCaptureCanvas = document.createElement("canvas");
mockSession = {
output: {
live: mockLiveCanvas,
capture: mockCaptureCanvas,
},
events: {
addEventListener: jest.fn(),
removeEventListener: jest.fn(),
},
playing: { live: false, capture: false },
play: jest.fn().mockResolvedValue(undefined),
pause: jest.fn().mockResolvedValue(undefined),
applyLens: jest.fn().mockResolvedValue(true),
removeLens: jest.fn().mockResolvedValue(true),
setSource: jest.fn().mockResolvedValue(undefined),
setRenderSize: jest.fn().mockResolvedValue(undefined),
setVolume: jest.fn().mockResolvedValue(undefined),
setFPSLimit: jest.fn().mockResolvedValue(undefined),
mute: jest.fn(),
unmute: jest.fn(),
keyboard: undefined,
} as any;
mockKit = {
destroy: jest.fn().mockResolvedValue(undefined),
createSession: jest.fn().mockResolvedValue(mockSession),
lensRepository: {
loadLens: jest.fn(),
loadLensGroups: jest.fn(),
},
} as any;
// Mock createMediaStreamSource to return a source with required methods
mockCreateMediaStreamSource.mockReturnValue({
setTransform: jest.fn().mockResolvedValue(undefined),
setRenderSize: jest.fn().mockResolvedValue(undefined),
} as any);
// Use flush promises to ensure state updates happen in act()
mockBootstrapCameraKit.mockImplementation(() => Promise.resolve(mockKit));
});
describe("Provider initialization", () => {
it("should render children when provided", async () => {
const { getByText } = render(
<CameraKitProvider apiToken="test-token">
<div>Test Child</div>
</CameraKitProvider>,
);
expect(getByText("Test Child")).toBeTruthy();
});
it("should bootstrap CameraKit with apiToken", async () => {
render(
<CameraKitProvider apiToken="test-token">
<div>Test</div>
</CameraKitProvider>,
);
await waitFor(() => {
expect(mockBootstrapCameraKit).toHaveBeenCalledWith(
expect.objectContaining({ apiToken: "test-token" }),
expect.any(Function),
);
});
});
it("should create a session after bootstrapping", async () => {
render(
<CameraKitProvider apiToken="test-token">
<div>Test</div>
</CameraKitProvider>,
);
await waitFor(() => {
expect(mockKit.createSession).toHaveBeenCalled();
});
});
it("should throw error when nested within another provider", () => {
const consoleError = jest.spyOn(console, "error").mockImplementation();
expect(() =>
render(
<CameraKitProvider apiToken="test-token">
<CameraKitProvider apiToken="test-token-2">
<div>Nested</div>
</CameraKitProvider>
</CameraKitProvider>,
),
).toThrow("CameraKitProvider cannot be nested within another CameraKitProvider.");
consoleError.mockRestore();
});
});
describe("useCameraKit hook", () => {
it("should throw error when used outside provider", () => {
const consoleError = jest.spyOn(console, "error").mockImplementation();
expect(() => {
renderHook(() => useCameraKit());
}).toThrow("useCameraKit must be used within a CameraKitProvider");
consoleError.mockRestore();
});
it("should provide context when used inside provider", async () => {
const wrapper = ({ children }: { children: React.ReactNode }) => (
<CameraKitProvider apiToken="test-token">{children}</CameraKitProvider>
);
const { result } = renderHook(() => useCameraKit(), { wrapper });
await waitFor(() => {
expect(result.current.sdkStatus).toBe("ready");
});
});
it("should expose liveCanvas when session is ready", async () => {
const wrapper = ({ children }: { children: React.ReactNode }) => (
<CameraKitProvider apiToken="test-token">{children}</CameraKitProvider>
);
const { result } = renderHook(() => useCameraKit(), { wrapper });
await waitFor(() => {
expect(result.current.liveCanvas).toBe(mockLiveCanvas);
});
});
it("should expose captureCanvas when session is ready", async () => {
const wrapper = ({ children }: { children: React.ReactNode }) => (
<CameraKitProvider apiToken="test-token">{children}</CameraKitProvider>
);
const { result } = renderHook(() => useCameraKit(), { wrapper });
await waitFor(() => {
expect(result.current.captureCanvas).toBe(mockCaptureCanvas);
});
});
it("should not expose internal fields", async () => {
const wrapper = ({ children }: { children: React.ReactNode }) => (
<CameraKitProvider apiToken="test-token">{children}</CameraKitProvider>
);
const { result } = renderHook(() => useCameraKit(), { wrapper });
await waitFor(() => {
expect(result.current.sdkStatus).toBe("ready");
});
expect((result.current as any).cameraKit).toBeUndefined();
expect((result.current as any).currentSession).toBeUndefined();
expect((result.current as any).getLogger).toBeUndefined();
});
});
describe("useInternalCameraKit hook", () => {
it("should throw error when used outside provider", () => {
const consoleError = jest.spyOn(console, "error").mockImplementation();
expect(() => {
renderHook(() => useInternalCameraKit());
}).toThrow("useInternalCameraKit must be used within a CameraKitProvider");
consoleError.mockRestore();
});
it("should expose internal fields", async () => {
const wrapper = ({ children }: { children: React.ReactNode }) => (
<CameraKitProvider apiToken="test-token">{children}</CameraKitProvider>
);
const { result } = renderHook(() => useInternalCameraKit(), { wrapper });
await waitFor(() => {
expect(result.current.cameraKit).toBe(mockKit);
expect(result.current.currentSession).toBe(mockSession);
expect(typeof result.current.getLogger).toBe("function");
});
});
});
describe("SDK status", () => {
it("should start with initializing status", () => {
const wrapper = ({ children }: { children: React.ReactNode }) => (
<CameraKitProvider apiToken="test-token">{children}</CameraKitProvider>
);
const { result } = renderHook(() => useCameraKit(), { wrapper });
expect(result.current.sdkStatus).toBe("initializing");
});
it("should transition to ready when bootstrap succeeds", async () => {
const wrapper = ({ children }: { children: React.ReactNode }) => (
<CameraKitProvider apiToken="test-token">{children}</CameraKitProvider>
);
const { result } = renderHook(() => useCameraKit(), { wrapper });
await waitFor(() => {
expect(result.current.sdkStatus).toBe("ready");
});
});
it("should transition to error when bootstrap fails", async () => {
mockBootstrapCameraKit.mockRejectedValue(new Error("Bootstrap failed"));
const wrapper = ({ children }: { children: React.ReactNode }) => (
<CameraKitProvider apiToken="test-token">{children}</CameraKitProvider>
);
const { result } = renderHook(() => useCameraKit(), { wrapper });
await waitFor(() => {
expect(result.current.sdkStatus).toBe("error");
expect(result.current.sdkError?.message).toBe("Bootstrap failed");
});
});
});
describe("Logger configuration", () => {
it("should use noop logger by default", async () => {
const wrapper = ({ children }: { children: React.ReactNode }) => (
<CameraKitProvider apiToken="test-token">{children}</CameraKitProvider>
);
renderHook(() => useCameraKit(), { wrapper });
await waitFor(() => {
expect(mockBootstrapCameraKit).toHaveBeenCalled();
});
});
it("should accept custom logger", async () => {
// Suppress console output since we're using console logger
const consoleErrorSpy = jest.spyOn(console, "error").mockImplementation(() => {});
const consoleInfoSpy = jest.spyOn(console, "info").mockImplementation(() => {});
const customLogger = createConsoleLogger();
const wrapper = ({ children }: { children: React.ReactNode }) => (
<CameraKitProvider apiToken="test-token" logger={customLogger}>
{children}
</CameraKitProvider>
);
renderHook(() => useCameraKit(), { wrapper });
await waitFor(() => {
expect(mockBootstrapCameraKit).toHaveBeenCalled();
});
consoleErrorSpy.mockRestore();
consoleInfoSpy.mockRestore();
});
it("should use specified log level", async () => {
const wrapper = ({ children }: { children: React.ReactNode }) => (
<CameraKitProvider apiToken="test-token" logLevel="debug">
{children}
</CameraKitProvider>
);
renderHook(() => useCameraKit(), { wrapper });
await waitFor(() => {
expect(mockBootstrapCameraKit).toHaveBeenCalled();
});
});
});
describe("Lens management", () => {
it("should fetch lens by id and group", async () => {
const mockLens = { id: "lens-1", groupId: "group-1" } as Lens;
(mockKit.lensRepository.loadLens as any).mockResolvedValue(mockLens);
const wrapper = ({ children }: { children: React.ReactNode }) => (
<CameraKitProvider apiToken="test-token">{children}</CameraKitProvider>
);
const { result } = renderHook(() => useCameraKit(), { wrapper });
await waitFor(() => {
expect(result.current.sdkStatus).toBe("ready");
});
let fetchedLens: Lens | undefined;
await act(async () => {
fetchedLens = await result.current.fetchLens("lens-1", "group-1");
});
expect(fetchedLens).toBe(mockLens);
expect(mockKit.lensRepository.loadLens).toHaveBeenCalledWith("lens-1", "group-1");
});
it("should cache fetched lenses", async () => {
const mockLens = { id: "lens-1", groupId: "group-1" } as Lens;
(mockKit.lensRepository.loadLens as any).mockResolvedValue(mockLens);
const wrapper = ({ children }: { children: React.ReactNode }) => (
<CameraKitProvider apiToken="test-token">{children}</CameraKitProvider>
);
const { result } = renderHook(() => useCameraKit(), { wrapper });
await waitFor(() => {
expect(result.current.sdkStatus).toBe("ready");
});
await act(async () => {
await result.current.fetchLens("lens-1", "group-1");
await result.current.fetchLens("lens-1", "group-1");
});
expect(mockKit.lensRepository.loadLens).toHaveBeenCalledTimes(1);
});
it("should fetch lens groups", async () => {
const mockLenses = [
{ id: "lens-1", groupId: "group-1" },
{ id: "lens-2", groupId: "group-1" },
] as Lens[];
(mockKit.lensRepository.loadLensGroups as any).mockResolvedValue({ lenses: mockLenses });
const wrapper = ({ children }: { children: React.ReactNode }) => (
<CameraKitProvider apiToken="test-token">{children}</CameraKitProvider>
);
const { result } = renderHook(() => useCameraKit(), { wrapper });
await waitFor(() => {
expect(result.current.sdkStatus).toBe("ready");
});
await act(async () => {
await result.current.fetchLenses("group-1");
});
expect(mockKit.lensRepository.loadLensGroups).toHaveBeenCalledWith(["group-1"]);
expect(result.current.lenses).toHaveLength(2);
});
it("should clear lens cache on re-bootstrap", async () => {
const mockLens = { id: "lens-1", groupId: "group-1" } as Lens;
(mockKit.lensRepository.loadLens as any).mockResolvedValue(mockLens);
const mockKit2 = {
destroy: jest.fn().mockResolvedValue(undefined),
createSession: jest.fn().mockResolvedValue(mockSession),
lensRepository: {
loadLens: jest.fn().mockResolvedValue(mockLens),
loadLensGroups: jest.fn(),
},
} as any;
mockBootstrapCameraKit.mockReset().mockResolvedValueOnce(mockKit).mockResolvedValueOnce(mockKit2);
let stabilityKey = "key-1";
const wrapper = ({ children }: { children: React.ReactNode }) => (
<CameraKitProvider apiToken="test-token" stabilityKey={stabilityKey}>
{children}
</CameraKitProvider>
);
const { result, rerender } = renderHook(() => useCameraKit(), { wrapper });
await waitFor(() => {
expect(result.current.sdkStatus).toBe("ready");
});
// Fetch a lens — populates the cache
await act(async () => {
await result.current.fetchLens("lens-1", "group-1");
});
expect(mockKit.lensRepository.loadLens).toHaveBeenCalledTimes(1);
expect(result.current.lenses).toHaveLength(1);
// Trigger re-bootstrap by changing stabilityKey
stabilityKey = "key-2";
rerender();
await waitFor(() => {
expect(result.current.sdkStatus).toBe("ready");
expect(mockBootstrapCameraKit).toHaveBeenCalledTimes(2);
});
// Lenses state should have been cleared
expect(result.current.lenses).toHaveLength(0);
// Fetch the same lens again — should NOT hit cache, should call new kit's loadLens
await act(async () => {
await result.current.fetchLens("lens-1", "group-1");
});
expect(mockKit2.lensRepository.loadLens).toHaveBeenCalledWith("lens-1", "group-1");
});
it("should apply lens", async () => {
const mockLens = { id: "lens-1", groupId: "group-1" } as Lens;
(mockKit.lensRepository.loadLens as any).mockResolvedValue(mockLens);
const wrapper = ({ children }: { children: React.ReactNode }) => (
<CameraKitProvider apiToken="test-token">{children}</CameraKitProvider>
);
const { result } = renderHook(() => useCameraKit(), { wrapper });
await waitFor(() => {
expect(result.current.sdkStatus).toBe("ready");
});
await act(async () => {
await result.current.applyLens("lens-1", "group-1");
});
expect(mockSession.applyLens).toHaveBeenCalledWith(mockLens, undefined);
expect(result.current.lens.status).toBe("ready");
expect(result.current.lens.lensId).toBe("lens-1");
});
it("should remove lens", async () => {
const wrapper = ({ children }: { children: React.ReactNode }) => (
<CameraKitProvider apiToken="test-token">{children}</CameraKitProvider>
);
const { result } = renderHook(() => useCameraKit(), { wrapper });
await waitFor(() => {
expect(result.current.sdkStatus).toBe("ready");
});
await act(async () => {
await result.current.removeLens();
});
expect(mockSession.removeLens).toHaveBeenCalled();
expect(result.current.lens.status).toBe("none");
});
});
describe("Source management", () => {
const mockMediaStream = {
getVideoTracks: jest.fn().mockReturnValue([
{
getSettings: jest.fn().mockReturnValue({ width: 1280, height: 720, deviceId: "device-1" }),
label: "Camera",
},
]),
getTracks: jest.fn().mockReturnValue([{ stop: jest.fn() }]),
} as any;
beforeEach(() => {
Object.defineProperty(global.navigator, "mediaDevices", {
value: {
getUserMedia: jest.fn().mockResolvedValue(mockMediaStream),
},
writable: true,
configurable: true,
});
});
it("should apply camera source", async () => {
const wrapper = ({ children }: { children: React.ReactNode }) => (
<CameraKitProvider apiToken="test-token">{children}</CameraKitProvider>
);
const { result } = renderHook(() => useCameraKit(), { wrapper });
await waitFor(() => {
expect(result.current.sdkStatus).toBe("ready");
});
await act(async () => {
await result.current.applySource({ kind: "camera" });
});
expect(result.current.source.status).toBe("ready");
expect(result.current.source.input?.kind).toBe("camera");
});
it("should remove source", async () => {
const wrapper = ({ children }: { children: React.ReactNode }) => (
<CameraKitProvider apiToken="test-token">{children}</CameraKitProvider>
);
const { result } = renderHook(() => useCameraKit(), { wrapper });
await waitFor(() => {
expect(result.current.sdkStatus).toBe("ready");
});
await act(async () => {
await result.current.removeSource();
});
expect(result.current.source.status).toBe("none");
});
});
describe("Playback options", () => {
it("should set FPS limit", async () => {
const wrapper = ({ children }: { children: React.ReactNode }) => (
<CameraKitProvider apiToken="test-token">{children}</CameraKitProvider>
);
const { result } = renderHook(() => useCameraKit(), { wrapper });
await waitFor(() => {
expect(result.current.sdkStatus).toBe("ready");
});
await act(async () => {
await result.current.setFPSLimit(30);
});
expect(result.current.fpsLimit).toBe(30);
});
it("should set muted state", async () => {
const wrapper = ({ children }: { children: React.ReactNode }) => (
<CameraKitProvider apiToken="test-token">{children}</CameraKitProvider>
);
const { result } = renderHook(() => useCameraKit(), { wrapper });
await waitFor(() => {
expect(result.current.sdkStatus).toBe("ready");
});
act(() => {
result.current.setMuted(true);
});
expect(result.current.isMuted).toBe(true);
});
it("should toggle muted state", async () => {
const wrapper = ({ children }: { children: React.ReactNode }) => (
<CameraKitProvider apiToken="test-token">{children}</CameraKitProvider>
);
const { result } = renderHook(() => useCameraKit(), { wrapper });
await waitFor(() => {
expect(result.current.sdkStatus).toBe("ready");
});
const initialMuted = result.current.isMuted;
act(() => {
result.current.toggleMuted();
});
expect(result.current.isMuted).toBe(!initialMuted);
});
});
describe("Reinitialize", () => {
it("should reinitialize when in error state", async () => {
mockBootstrapCameraKit.mockRejectedValueOnce(new Error("First error")).mockResolvedValue(mockKit);
const wrapper = ({ children }: { children: React.ReactNode }) => (
<CameraKitProvider apiToken="test-token">{children}</CameraKitProvider>
);
const { result } = renderHook(() => useCameraKit(), { wrapper });
await waitFor(() => {
expect(result.current.sdkStatus).toBe("error");
});
await act(async () => {
result.current.reinitialize();
});
await waitFor(() => {
expect(result.current.sdkStatus).toBe("ready");
});
});
it("should throw error when not in error state", async () => {
const wrapper = ({ children }: { children: React.ReactNode }) => (
<CameraKitProvider apiToken="test-token">{children}</CameraKitProvider>
);
const { result } = renderHook(() => useCameraKit(), { wrapper });
await waitFor(() => {
expect(result.current.sdkStatus).toBe("ready");
});
expect(() => {
result.current.reinitialize();
}).toThrow("Cannot re-initialize CameraKit when it is not in an aborted state.");
});
});
describe("Configuration updates", () => {
it("should re-bootstrap when apiToken changes", async () => {
const { rerender } = render(
<CameraKitProvider apiToken="token-1">
<div>Test</div>
</CameraKitProvider>,
);
await waitFor(() => {
expect(mockBootstrapCameraKit).toHaveBeenCalledWith(
expect.objectContaining({ apiToken: "token-1" }),
expect.any(Function),
);
});
mockBootstrapCameraKit.mockClear();
rerender(
<CameraKitProvider apiToken="token-2">
<div>Test</div>
</CameraKitProvider>,
);
await waitFor(() => {
expect(mockBootstrapCameraKit).toHaveBeenCalledWith(
expect.objectContaining({ apiToken: "token-2" }),
expect.any(Function),
);
});
});
it("should re-bootstrap when stabilityKey changes", async () => {
const { rerender } = render(
<CameraKitProvider apiToken="token-1" stabilityKey="key-1">
<div>Test</div>
</CameraKitProvider>,
);
await waitFor(() => {
expect(mockBootstrapCameraKit).toHaveBeenCalledTimes(1);
});
mockBootstrapCameraKit.mockClear();
rerender(
<CameraKitProvider apiToken="token-1" stabilityKey="key-2">
<div>Test</div>
</CameraKitProvider>,
);
await waitFor(() => {
expect(mockBootstrapCameraKit).toHaveBeenCalledTimes(1);
});
});
});
describe("Cleanup", () => {
it("should cleanup on unmount", async () => {
const { unmount } = render(
<CameraKitProvider apiToken="test-token">
<div>Test</div>
</CameraKitProvider>,
);
await waitFor(() => {
expect(mockBootstrapCameraKit).toHaveBeenCalled();
});
unmount();
await waitFor(() => {
expect(mockKit.destroy).toHaveBeenCalled();
});
});
});
describe("Extended container", () => {
it("should pass extendContainer to bootstrapCameraKit", async () => {
const extendContainer = jest.fn((container) => container);
render(
<CameraKitProvider apiToken="test-token" extendContainer={extendContainer}>
<div>Test</div>
</CameraKitProvider>,
);
await waitFor(() => {
expect(mockBootstrapCameraKit).toHaveBeenCalledWith(expect.any(Object), expect.any(Function));
});
// The composed function should call both the user's extendContainer and inject metrics.
const composedFn = mockBootstrapCameraKit.mock.calls[0]![1] as (container: any) => any;
const mockContainer = { provides: jest.fn() };
composedFn(mockContainer);
// Metrics injection should call container.provides
expect(mockContainer.provides).toHaveBeenCalled();
// User's extendContainer should also be called
expect(extendContainer).toHaveBeenCalledWith(mockContainer);
});
});
describe("Lens error recovery", () => {
it("should recover from LensExecutionError when a new lens is applied", async () => {
// Track event handlers registered on the session
let errorHandler: ((event: any) => void) | undefined;
mockSession.events.addEventListener = jest.fn().mockImplementation((eventName, handler) => {
if (eventName === "error") {
errorHandler = handler;
}
});
const mockLens1: Lens = { id: "lens-1", groupId: "group-1", name: "Lens 1" } as any;
const mockLens2: Lens = { id: "lens-2", groupId: "group-1", name: "Lens 2" } as any;
mockKit.lensRepository.loadLens = jest.fn().mockImplementation((lensId) => {
if (lensId === "lens-1") return Promise.resolve(mockLens1);
if (lensId === "lens-2") return Promise.resolve(mockLens2);
return Promise.reject(new Error("Lens not found"));
});
const wrapper = ({ children }: { children: React.ReactNode }) => (
<CameraKitProvider apiToken="test-token">{children}</CameraKitProvider>
);
const { result } = renderHook(() => useCameraKit(), { wrapper });
// Wait for SDK to be ready
await waitFor(() => {
expect(result.current.sdkStatus).toBe("ready");
});
// Apply lens-1
await act(async () => {
await result.current.applyLens("lens-1", "group-1");
});
expect(result.current.lens.status).toBe("ready");
expect(result.current.lens.lensId).toBe("lens-1");
// Simulate a LensExecutionError during rendering
await act(async () => {
const lensExecutionError = new Error("Lens rendering failed");
lensExecutionError.name = "LensExecutionError";
errorHandler?.({ detail: { error: lensExecutionError } });
});
// Lens should be in error state, but SDK should still be ready
expect(result.current.lens.status).toBe("error");
expect(result.current.lens.error?.name).toBe("LensExecutionError");
expect(result.current.sdkStatus).toBe("ready"); // SDK should NOT be in error state
// Apply a new lens - it should work and recover from the error
await act(async () => {
await result.current.applyLens("lens-2", "group-1");
});
// New lens should be applied successfully
expect(result.current.lens.status).toBe("ready");
expect(result.current.lens.lensId).toBe("lens-2");
expect(result.current.lens.error).toBeUndefined();
expect(result.current.sdkStatus).toBe("ready");
});
it("should clear lens error state when applying a new lens after LensExecutionError", async () => {
let errorHandler: ((event: any) => void) | undefined;
mockSession.events.addEventListener = jest.fn().mockImplementation((eventName, handler) => {
if (eventName === "error") {
errorHandler = handler;
}
});
const mockLens1: Lens = { id: "lens-1", groupId: "group-1", name: "Lens 1" } as any;
const mockLens2: Lens = { id: "lens-2", groupId: "group-1", name: "Lens 2" } as any;
mockKit.lensRepository.loadLens = jest.fn().mockImplementation((lensId) => {
if (lensId === "lens-1") return Promise.resolve(mockLens1);
if (lensId === "lens-2") return Promise.resolve(mockLens2);
return Promise.reject(new Error("Lens not found"));
});
const wrapper = ({ children }: { children: React.ReactNode }) => (
<CameraKitProvider apiToken="test-token">{children}</CameraKitProvider>
);
const { result } = renderHook(() => useCameraKit(), { wrapper });
await waitFor(() => {
expect(result.current.sdkStatus).toBe("ready");
});
// Apply first lens
await act(async () => {
await result.current.applyLens("lens-1", "group-1");
});
// Trigger LensExecutionError
await act(async () => {
const lensExecutionError = new Error("Lens crashed");
lensExecutionError.name = "LensExecutionError";
errorHandler?.({ detail: { error: lensExecutionError } });
});
// Verify lens is in error state
expect(result.current.lens.status).toBe("error");
// Apply a new lens
await act(async () => {
await result.current.applyLens("lens-2", "group-1");
});
// Verify the error is cleared and new lens is applied
expect(result.current.lens.status).toBe("ready");
expect(result.current.lens.error).toBeUndefined();
expect(result.current.lens.lensId).toBe("lens-2");
});
it("should abort SDK when LensAbortError occurs", async () => {
let errorHandler: ((event: any) => void) | undefined;
mockSession.events.addEventListener = jest.fn().mockImplementation((eventName, handler) => {
if (eventName === "error") {
errorHandler = handler;
}
});
const mockLens1: Lens = { id: "lens-1", groupId: "group-1", name: "Lens 1" } as any;
mockKit.lensRepository.loadLens = jest.fn().mockResolvedValue(mockLens1);
const wrapper = ({ children }: { children: React.ReactNode }) => (
<CameraKitProvider apiToken="test-token">{children}</CameraKitProvider>
);
const { result } = renderHook(() => useCameraKit(), { wrapper });
await waitFor(() => {
expect(result.current.sdkStatus).toBe("ready");
});
// Apply a lens
await act(async () => {
await result.current.applyLens("lens-1", "group-1");
});
expect(result.current.lens.status).toBe("ready");
// Simulate a LensAbortError - this is a critical error
await act(async () => {
const lensAbortError = new Error("Lens aborted");
lensAbortError.name = "LensAbortError";
errorHandler?.({ detail: { error: lensAbortError } });
});
// SDK should be in error state (aborted)
expect(result.current.sdkStatus).toBe("error");
expect(result.current.sdkError?.name).toBe("LensAbortError");
expect(mockKit.destroy).toHaveBeenCalled();
});
it("should require reinitialize after LensAbortError", async () => {
let errorHandler: ((event: any) => void) | undefined;
mockSession.events.addEventListener = jest.fn().mockImplementation((eventName, handler) => {
if (eventName === "error") {
errorHandler = handler;
}
});
const mockLens1: Lens = { id: "lens-1", groupId: "group-1", name: "Lens 1" } as any;
mockKit.lensRepository.loadLens = jest.fn().mockResolvedValue(mockLens1);
const wrapper = ({ children }: { children: React.ReactNode }) => (
<CameraKitProvider apiToken="test-token">{children}</CameraKitProvider>
);
const { result } = renderHook(() => useCameraKit(), { wrapper });
await waitFor(() => {
expect(result.current.sdkStatus).toBe("ready");
});
// Apply a lens
await act(async () => {
await result.current.applyLens("lens-1", "group-1");
});
// Simulate a LensAbortError
await act(async () => {
const lensAbortError = new Error("Lens aborted");
lensAbortError.name = "LensAbortError";
errorHandler?.({ detail: { error: lensAbortError } });
});
// SDK should be in error state
expect(result.current.sdkStatus).toBe("error");
// Reset mocks for reinitialize
mockKit.destroy.mockClear();
mockBootstrapCameraKit.mockResolvedValue(mockKit);
// Reinitialize should work
await act(async () => {
result.current.reinitialize();
});
await waitFor(() => {
expect(result.current.sdkStatus).toBe("ready");
});
});
it("should not affect SDK or lens state for other errors like LensImagePickerError", async () => {
let errorHandler: ((event: any) => void) | undefined;
mockSession.events.addEventListener = jest.fn().mockImplementation((eventName, handler) => {
if (eventName === "error") {
errorHandler = handler;
}
});
const mockLens1: Lens = { id: "lens-1", groupId: "group-1", name: "Lens 1" } as any;
mockKit.lensRepository.loadLens = jest.fn().mockResolvedValue(mockLens1);
const wrapper = ({ children }: { children: React.ReactNode }) => (
<CameraKitProvider apiToken="test-token">{children}</CameraKitProvider>
);
const { result } = renderHook(() => useCameraKit(), { wrapper });
await waitFor(() => {
expect(result.current.sdkStatus).toBe("ready");
});
// Apply a lens
await act(async () => {
await result.current.applyLens("lens-1", "group-1");
});
expect(result.current.lens.status).toBe("ready");
expect(result.current.lens.lensId).toBe("lens-1");
// Simulate a LensImagePickerError - this is a non-critical user interaction error
await act(async () => {
const imagePickerError = new Error("Image picker failed");
imagePickerError.name = "LensImagePickerError";
errorHandler?.({ detail: { error: imagePickerError } });
});
// SDK should remain ready (not aborted)
expect(result.current.sdkStatus).toBe("ready");
expect(result.current.sdkError).toBeUndefined();
// Lens should remain in ready state (not affected)
expect(result.current.lens.status).toBe("ready");
expect(result.current.lens.lensId).toBe("lens-1");
expect(result.current.lens.error).toBeUndefined();
// SDK should not be destroyed
expect(mockKit.destroy).not.toHaveBeenCalled();
});