@hyper-fetch/firebase 7.5.1 → 7.5.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (36) hide show
  1. package/__tests__/features/firestore/shared/constraints.shared.tests.ts +72 -0
  2. package/__tests__/features/firestore/shared/methods/add-doc.test.suite.ts +32 -0
  3. package/__tests__/features/firestore/shared/methods/delete-doc.test.suite.ts +52 -0
  4. package/__tests__/features/firestore/shared/methods/get-doc.test.suite.ts +60 -0
  5. package/__tests__/features/firestore/shared/methods/get-docs.test.suite.ts +45 -0
  6. package/__tests__/features/firestore/shared/methods/on-snapshot.test.suite.ts +290 -0
  7. package/__tests__/features/firestore/shared/methods/set-doc.test.suite.ts +70 -0
  8. package/__tests__/features/firestore/shared/methods/update-doc.test.suite.ts +40 -0
  9. package/__tests__/features/firestore/shared/methods.shared.tests.ts +24 -0
  10. package/__tests__/features/firestore/web/constraints.web.spec.ts +24 -0
  11. package/__tests__/features/firestore/web/methods.web.spec.ts +21 -0
  12. package/__tests__/features/firestore/web/sockets.base.spec.ts +18 -0
  13. package/__tests__/features/realtime/browser/constraints.web.spec.ts +14 -0
  14. package/__tests__/features/realtime/browser/methods.web.spec.ts +19 -0
  15. package/__tests__/features/realtime/browser/sockets.base.spec.ts +12 -0
  16. package/__tests__/features/realtime/shared/constraints.shared.tests.ts +60 -0
  17. package/__tests__/features/realtime/shared/methods/get.test.suite.ts +64 -0
  18. package/__tests__/features/realtime/shared/methods/on-value.test.suite.ts +189 -0
  19. package/__tests__/features/realtime/shared/methods/push.test.suite.ts +47 -0
  20. package/__tests__/features/realtime/shared/methods/remove.test.suite.ts +46 -0
  21. package/__tests__/features/realtime/shared/methods/set.test.suite.ts +72 -0
  22. package/__tests__/features/realtime/shared/methods/update.test.suite.ts +42 -0
  23. package/__tests__/features/realtime/shared/methods.shared.tests.ts +25 -0
  24. package/__tests__/global.d.ts +1 -0
  25. package/__tests__/jest.setup.ts +8 -0
  26. package/__tests__/shared/request-events.shared.ts +32 -0
  27. package/__tests__/tsconfig.json +8 -0
  28. package/__tests__/utils/browser/clean.browser.ts +17 -0
  29. package/__tests__/utils/browser/initialize.firestore.browser.ts +20 -0
  30. package/__tests__/utils/browser/initialize.realtime.browser.ts +20 -0
  31. package/__tests__/utils/browser/seed.browser.ts +23 -0
  32. package/__tests__/utils/index.ts +4 -0
  33. package/__tests__/utils/seed/seed.data.ts +21 -0
  34. package/jest.config.ts +9 -0
  35. package/package.json +1 -1
  36. package/project.json +4 -0
@@ -0,0 +1,24 @@
1
+ /**
2
+ * @jest-environment node
3
+ */
4
+ import { Client } from "@hyper-fetch/core";
5
+
6
+ import { FirebaseAdapter } from "adapter";
7
+ import { firestoreDbBrowser } from "../../../utils/browser/initialize.firestore.browser";
8
+ import { seedFirestoreDatabaseBrowser, deleteCollectionForBrowser } from "../../../utils";
9
+ import { constraintsSharedTestCases } from "../shared/constraints.shared.tests";
10
+
11
+ describe("Firestore Browser [ Constraints ]", () => {
12
+ let client = new Client({ url: "teas/" }).setAdapter(FirebaseAdapter(firestoreDbBrowser));
13
+
14
+ beforeEach(async () => {
15
+ await seedFirestoreDatabaseBrowser(firestoreDbBrowser);
16
+ client = new Client({ url: "teas/" }).setAdapter(FirebaseAdapter(firestoreDbBrowser));
17
+ });
18
+
19
+ afterEach(async () => {
20
+ await deleteCollectionForBrowser(firestoreDbBrowser, "teas/");
21
+ });
22
+
23
+ constraintsSharedTestCases(client);
24
+ });
@@ -0,0 +1,21 @@
1
+ /**
2
+ * @jest-environment node
3
+ */
4
+
5
+ import { FirebaseAdapter } from "adapter";
6
+ import { seedFirestoreDatabaseBrowser } from "../../../utils/browser/seed.browser";
7
+ import { deleteCollectionForBrowser } from "../../../utils/browser/clean.browser";
8
+ import { methodsSharedTestCases } from "../shared/methods.shared.tests";
9
+ import { firestoreDbBrowser } from "../../../utils/browser/initialize.firestore.browser";
10
+
11
+ describe("Firestore Browser [ Methods ]", () => {
12
+ beforeEach(async () => {
13
+ await seedFirestoreDatabaseBrowser(firestoreDbBrowser);
14
+ });
15
+
16
+ afterEach(async () => {
17
+ await deleteCollectionForBrowser(firestoreDbBrowser, "teas");
18
+ });
19
+
20
+ methodsSharedTestCases(() => FirebaseAdapter(firestoreDbBrowser));
21
+ });
@@ -0,0 +1,18 @@
1
+ /**
2
+ * @jest-environment node
3
+ */
4
+
5
+ import { FirebaseAdapter, FirebaseSocketsAdapter } from "adapter";
6
+ import { deleteCollectionForBrowser, seedFirestoreDatabaseBrowser } from "../../../utils";
7
+ import { firestoreDbBrowser } from "../../../utils/browser/initialize.firestore.browser";
8
+ import { socketsMethodsSharedTestCases } from "../shared/methods.shared.tests";
9
+
10
+ describe("Firestore Database Browser [Sockets]", () => {
11
+ beforeEach(async () => {
12
+ await seedFirestoreDatabaseBrowser(firestoreDbBrowser);
13
+ });
14
+ afterEach(async () => {
15
+ await deleteCollectionForBrowser(firestoreDbBrowser, "teas");
16
+ });
17
+ socketsMethodsSharedTestCases(FirebaseSocketsAdapter(firestoreDbBrowser), () => FirebaseAdapter(firestoreDbBrowser));
18
+ });
@@ -0,0 +1,14 @@
1
+ import { ref, set } from "firebase/database";
2
+
3
+ import { FirebaseAdapter } from "adapter";
4
+ import { realtimeDBBrowser, seedRealtimeDatabaseBrowser } from "../../../utils";
5
+ import { constraintsSharedTestCases } from "../shared/constraints.shared.tests";
6
+
7
+ describe("Realtime Database Browser [Constraints]", () => {
8
+ beforeEach(async () => {
9
+ await set(ref(realtimeDBBrowser, "teas/"), null);
10
+ await seedRealtimeDatabaseBrowser(realtimeDBBrowser);
11
+ });
12
+
13
+ constraintsSharedTestCases(() => FirebaseAdapter(realtimeDBBrowser));
14
+ });
@@ -0,0 +1,19 @@
1
+ import { set, ref } from "firebase/database";
2
+
3
+ import { FirebaseAdapter } from "adapter";
4
+ import { realtimeDBBrowser } from "../../../utils";
5
+ import { seedRealtimeDatabaseBrowser } from "../../../utils/browser/seed.browser";
6
+ import { methodsSharedTestCases } from "../shared/methods.shared.tests";
7
+
8
+ describe("Realtime Database Browser [ Methods ]", () => {
9
+ beforeEach(async () => {
10
+ await set(ref(realtimeDBBrowser, "teas/"), null);
11
+ await seedRealtimeDatabaseBrowser(realtimeDBBrowser);
12
+ });
13
+
14
+ afterEach(async () => {
15
+ await set(ref(realtimeDBBrowser, "teas/"), null);
16
+ });
17
+
18
+ methodsSharedTestCases(() => FirebaseAdapter(realtimeDBBrowser));
19
+ });
@@ -0,0 +1,12 @@
1
+ import { realtimeDBBrowser, seedRealtimeDatabaseBrowser } from "../../../utils";
2
+ import { socketsMethodsSharedTestCases } from "../shared/methods.shared.tests";
3
+ import { FirebaseAdapter, FirebaseSocketsAdapter } from "adapter";
4
+
5
+ describe("Realtime Database Browser [Sockets]", () => {
6
+ socketsMethodsSharedTestCases(
7
+ realtimeDBBrowser,
8
+ seedRealtimeDatabaseBrowser,
9
+ FirebaseSocketsAdapter,
10
+ FirebaseAdapter,
11
+ );
12
+ });
@@ -0,0 +1,60 @@
1
+ import { Client } from "@hyper-fetch/core";
2
+
3
+ import { $endAt, $limitToFirst, $orderByChild, $startAt } from "constraints";
4
+ import { FirebaseAdapter } from "adapter";
5
+ import { Tea } from "../../../utils";
6
+
7
+ export const constraintsSharedTestCases = (adapterFunction: () => ReturnType<typeof FirebaseAdapter>) => {
8
+ describe("Ordering", () => {
9
+ it("Should allow ordering by child", async () => {
10
+ const client = new Client({ url: "teas/" }).setAdapter(adapterFunction());
11
+ const req = client.createRequest<{ response: Tea[] }>()({
12
+ endpoint: "",
13
+ method: "getDocs",
14
+ });
15
+ const { data } = await req.send({
16
+ // TODO: Fix this
17
+ queryParams: { constraints: [$orderByChild("origin")] },
18
+ });
19
+ expect(data!.map((el) => el.origin)).toStrictEqual([
20
+ "China",
21
+ "China",
22
+ "China",
23
+ "China",
24
+ "China",
25
+ "China",
26
+ "China",
27
+ "Japan",
28
+ "Taiwan",
29
+ "Taiwan",
30
+ ]);
31
+ });
32
+ });
33
+ describe("Filtering and ordering", () => {
34
+ it("Should allow to limit the result and order it", async () => {
35
+ const client = new Client({ url: "teas/" }).setAdapter(adapterFunction());
36
+ const req = client.createRequest<{ response: Tea[] }>()({
37
+ endpoint: "",
38
+ method: "getDocs",
39
+ });
40
+ const { data } = await req.send({
41
+ // TODO: Fix this
42
+ queryParams: { constraints: [$orderByChild("origin"), $limitToFirst(5)] },
43
+ });
44
+ expect(data!.map((tea) => tea.origin)).toStrictEqual(["China", "China", "China", "China", "China"]);
45
+ });
46
+ it("Should allow to combine multiple filters", async () => {
47
+ const client = new Client({ url: "teas/" }).setAdapter(adapterFunction());
48
+ const req = client.createRequest<{ response: Tea[] }>()({
49
+ endpoint: "",
50
+ method: "getDocs",
51
+ });
52
+ const { data } = await req.send({
53
+ // TODO: Fix this
54
+ queryParams: { constraints: [$orderByChild("year"), $startAt(2021), $endAt(2022)] },
55
+ });
56
+ expect(data).toHaveLength(5);
57
+ expect(data!.map((tea) => tea.year)).toStrictEqual([2021, 2021, 2021, 2022, 2022]);
58
+ });
59
+ });
60
+ };
@@ -0,0 +1,64 @@
1
+ import { Client } from "@hyper-fetch/core";
2
+
3
+ import { FirebaseAdapter } from "adapter";
4
+ import { testLifecycleEvents } from "../../../../shared/request-events.shared";
5
+ import { Tea } from "../../../../utils";
6
+
7
+ export const getTestSuite = (adapterFunction: () => ReturnType<typeof FirebaseAdapter>) => {
8
+ describe("get", () => {
9
+ let client = new Client({ url: "teas/" }).setAdapter(adapterFunction());
10
+ let clientBees = new Client({ url: "bees/" }).setAdapter(adapterFunction());
11
+ beforeEach(() => {
12
+ clientBees = new Client({ url: "bees/" }).setAdapter(adapterFunction());
13
+ client = new Client({ url: "teas/" }).setAdapter(adapterFunction());
14
+ });
15
+
16
+ it("should return data available for endpoint", async () => {
17
+ const req = client.createRequest<{ response: Tea[] }>()({
18
+ endpoint: "",
19
+ method: "getDocs",
20
+ });
21
+ const { data, extra, status, success, error } = await req.send();
22
+ expect(data).toHaveLength(10);
23
+ expect(data?.[0]).toHaveProperty("__key");
24
+ expect(extra).toHaveProperty("snapshot");
25
+ expect(extra).toHaveProperty("ref");
26
+ expect(status).toBe("success");
27
+ expect(success).toBe(true);
28
+ expect(error).toBe(null);
29
+ });
30
+ it("should return data for dynamic endpoint", async () => {
31
+ const req = client
32
+ .createRequest<{ response: Tea }>()({
33
+ endpoint: ":teaId",
34
+ method: "getDoc",
35
+ })
36
+ .setParams({ teaId: 1 });
37
+
38
+ const { data } = await req.send();
39
+ expect(data).toStrictEqual({ amount: 150, name: "Taiping Hou Kui", origin: "China", type: "Green", year: 2023 });
40
+ });
41
+ it("should return emptyResource status for non existing resource", async () => {
42
+ const req = clientBees
43
+ .createRequest<{ response: Tea }>()({
44
+ endpoint: ":teaId",
45
+ method: "getDoc",
46
+ })
47
+ .setParams({ teaId: 1 });
48
+
49
+ const { data, status } = await req.send();
50
+ expect(data).toStrictEqual(null);
51
+ expect(status).toStrictEqual("emptyResource");
52
+ });
53
+ it("should emit lifecycle events", async () => {
54
+ const req = clientBees
55
+ .createRequest<{ response: Tea }>()({
56
+ endpoint: ":teaId",
57
+ method: "getDoc",
58
+ })
59
+ .setParams({ teaId: 1 });
60
+
61
+ await testLifecycleEvents(req);
62
+ });
63
+ });
64
+ };
@@ -0,0 +1,189 @@
1
+ /* eslint-disable max-params */
2
+ import { Socket } from "@hyper-fetch/sockets";
3
+ import { Client } from "@hyper-fetch/core";
4
+ import waitForExpect from "wait-for-expect";
5
+
6
+ import { FirebaseAdapterTypes, FirebaseDBTypes, FirebaseSocketAdapterTypes } from "adapter";
7
+ import { Tea } from "../../../../utils";
8
+
9
+ export const onValueTestSuite = (
10
+ db: FirebaseDBTypes,
11
+ seedDb: (initializedDb: FirebaseDBTypes) => Promise<void>,
12
+ socketsAdapter: (database: FirebaseDBTypes) => FirebaseSocketAdapterTypes<any>,
13
+ coreAdapter: (database: FirebaseDBTypes) => FirebaseAdapterTypes<any>,
14
+ ) => {
15
+ describe("when using onValue method", () => {
16
+ let initializedSocketsAdapter: FirebaseSocketAdapterTypes<any>;
17
+ let initializedCoreAdapter: FirebaseAdapterTypes<any>;
18
+ let initializedDb: FirebaseDBTypes;
19
+ let spy = jest.fn();
20
+ const newData = { origin: "Poland", type: "Green", year: 2043, name: "Pou Ran Do Cha", amount: 100 } as Tea;
21
+
22
+ beforeAll(async () => {
23
+ initializedDb = await db;
24
+ initializedSocketsAdapter = socketsAdapter(initializedDb);
25
+ initializedCoreAdapter = coreAdapter(initializedDb);
26
+ });
27
+
28
+ beforeEach(async () => {
29
+ await seedDb(initializedDb);
30
+ });
31
+
32
+ const initialize = async () => {
33
+ const client = new Client({ url: "teas/" }).setAdapter(initializedCoreAdapter);
34
+ const socket = new Socket({ url: "teas/", adapter: initializedSocketsAdapter });
35
+ const pushReq = client
36
+ .createRequest<{ response: Tea; payload: Tea }>()({
37
+ endpoint: "",
38
+ method: "push",
39
+ })
40
+ .setPayload(newData);
41
+ const socketBees = new Socket({ url: "bees/", adapter: initializedSocketsAdapter });
42
+
43
+ return { client, socket, pushReq, socketBees };
44
+ };
45
+
46
+ beforeEach(() => {
47
+ jest.resetAllMocks();
48
+ jest.clearAllMocks();
49
+ spy = jest.fn();
50
+ });
51
+
52
+ it("should return unmount function", async () => {
53
+ const { socket } = await initialize();
54
+ const onValueReq = socket.createListener<Tea[]>()({
55
+ topic: "",
56
+ });
57
+ const unmount = onValueReq.listen(spy);
58
+ expect(unmount).toBeFunction();
59
+ });
60
+
61
+ it("should unmount listeners", async () => {
62
+ const { socket, pushReq } = await initialize();
63
+ const onValueReq = socket.createListener<Tea[]>()({
64
+ topic: "",
65
+ });
66
+ const unmount = onValueReq.listen(spy);
67
+
68
+ await waitForExpect(async () => {
69
+ expect(spy).toHaveBeenCalledTimes(1);
70
+ });
71
+
72
+ unmount();
73
+
74
+ await pushReq.send();
75
+ await pushReq.send();
76
+
77
+ await waitForExpect(async () => {
78
+ expect(spy).toHaveBeenCalledTimes(1);
79
+ }, 1000);
80
+
81
+ expect(socket.adapter.listeners.get(onValueReq.topic)?.size).toBe(0);
82
+ });
83
+
84
+ it("should return emptyResource status", async () => {
85
+ const { socketBees } = await initialize();
86
+ const onValueReq = socketBees.createListener<Tea[]>()({
87
+ topic: "",
88
+ options: { onlyOnce: false },
89
+ });
90
+
91
+ let receivedData: Tea[] | null;
92
+ let receivedExtra: any;
93
+
94
+ const unmount = onValueReq.listen(({ data, extra }) => {
95
+ spy();
96
+ receivedData = data;
97
+ receivedExtra = extra;
98
+ });
99
+
100
+ await waitForExpect(async () => {
101
+ expect(spy).toHaveBeenCalled();
102
+ expect(receivedData).toBeNull();
103
+ expect(receivedExtra.status).toBe("emptyResource");
104
+ });
105
+
106
+ unmount();
107
+ });
108
+
109
+ it("should be called once with onlyOnce option", async () => {
110
+ const { socket, pushReq } = await initialize();
111
+ const onValueReq = socket.createListener<Tea[]>()({
112
+ topic: "",
113
+ options: { onlyOnce: true },
114
+ });
115
+
116
+ const unmount = onValueReq.listen(spy);
117
+
118
+ await pushReq.send();
119
+
120
+ await waitForExpect(async () => {
121
+ expect(spy).toHaveBeenCalledTimes(1);
122
+ });
123
+
124
+ unmount();
125
+ });
126
+
127
+ it("should receive updates", async () => {
128
+ const { socket, pushReq } = await initialize();
129
+
130
+ const onValueReq = socket.createListener<Tea[]>()({
131
+ topic: "",
132
+ options: { onlyOnce: false },
133
+ });
134
+
135
+ let receivedData: Tea[] | null;
136
+ let receivedExtra: any;
137
+
138
+ const unmount = onValueReq.listen(({ data, extra }) => {
139
+ spy();
140
+ receivedData = data;
141
+ receivedExtra = extra;
142
+ });
143
+
144
+ const { data } = await pushReq.send();
145
+
146
+ await waitForExpect(async () => {
147
+ expect(receivedData).toIncludeAllMembers([{ ...newData, __key: data?.__key }]);
148
+ expect(receivedExtra).toHaveProperty("snapshot");
149
+ expect(receivedExtra).toHaveProperty("status");
150
+ expect(receivedExtra).toHaveProperty("ref");
151
+ expect(receivedExtra.status).toBe("success");
152
+ });
153
+
154
+ unmount();
155
+ });
156
+
157
+ it("should return data available for doc", async () => {
158
+ const { socket } = await initialize();
159
+ const onValueReq = socket
160
+ .createListener<Tea[]>()({
161
+ topic: ":teaId",
162
+ })
163
+ .setParams({ teaId: 1 });
164
+
165
+ let receivedData: Tea[] | null;
166
+ let receivedExtra: any;
167
+ const unmount = onValueReq.listen(({ data, extra }) => {
168
+ spy();
169
+ receivedData = data;
170
+ receivedExtra = extra;
171
+ });
172
+
173
+ await waitForExpect(async () => {
174
+ expect(receivedData).toStrictEqual({
175
+ amount: 150,
176
+ name: "Taiping Hou Kui",
177
+ origin: "China",
178
+ type: "Green",
179
+ year: 2023,
180
+ });
181
+ expect(receivedExtra).toHaveProperty("snapshot");
182
+ expect(receivedExtra).toHaveProperty("ref");
183
+ expect(receivedExtra.status).toBe("success");
184
+ });
185
+
186
+ unmount();
187
+ });
188
+ });
189
+ };
@@ -0,0 +1,47 @@
1
+ import { Client } from "@hyper-fetch/core";
2
+
3
+ import { FirebaseAdapter } from "adapter";
4
+ import { testLifecycleEvents } from "../../../../shared/request-events.shared";
5
+ import { Tea } from "../../../../utils";
6
+
7
+ export const pushTestSuite = (adapterFunction: () => ReturnType<typeof FirebaseAdapter>) => {
8
+ describe("push", () => {
9
+ let client = new Client({ url: "teas/" }).setAdapter(adapterFunction());
10
+ beforeEach(() => {
11
+ client = new Client({ url: "teas/" }).setAdapter(adapterFunction());
12
+ });
13
+
14
+ it("should allow for adding data to a list", async () => {
15
+ const newData = { origin: "Poland", type: "Green", year: 2023, name: "Pou Ran Do Cha", amount: 100 } as Tea;
16
+ const getReq = client.createRequest<{ response: Tea[] }>()({
17
+ endpoint: "",
18
+ method: "get",
19
+ });
20
+ const pushReq = client
21
+ .createRequest<{ response: Tea; payload: Tea }>()({
22
+ endpoint: "",
23
+ method: "push",
24
+ options: {},
25
+ })
26
+ .setPayload(newData);
27
+ const { data: pushedData, extra } = await pushReq.send();
28
+ const { data } = await getReq.send();
29
+
30
+ expect(data).toHaveLength(11);
31
+ expect(data).toContainEqual({ ...newData, __key: pushedData.__key });
32
+ expect(extra).toHaveProperty("key");
33
+ });
34
+ it("should emit lifecycle events", async () => {
35
+ const newData = { origin: "Poland", type: "Green", year: 2043, name: "Pou Ran Do Cha", amount: 100 } as Tea;
36
+
37
+ const pushReq = client
38
+ .createRequest<{ response: Tea; payload: Tea }>()({
39
+ endpoint: "teas/",
40
+ method: "push",
41
+ })
42
+ .setPayload(newData);
43
+
44
+ await testLifecycleEvents(pushReq);
45
+ });
46
+ });
47
+ };
@@ -0,0 +1,46 @@
1
+ import { Client } from "@hyper-fetch/core";
2
+
3
+ import { FirebaseAdapter } from "adapter";
4
+ import { testLifecycleEvents } from "../../../../shared/request-events.shared";
5
+ import { Tea } from "../../../../utils";
6
+
7
+ export const removeTestSuite = (adapterFunction: () => ReturnType<typeof FirebaseAdapter>) => {
8
+ let client = new Client({ url: "teas/" }).setAdapter(adapterFunction());
9
+ beforeEach(() => {
10
+ client = new Client({ url: "teas/" }).setAdapter(adapterFunction());
11
+ });
12
+ describe("remove", () => {
13
+ it("should allow for removing data", async () => {
14
+ const getReq = client
15
+ .createRequest<{ response: Tea }>()({
16
+ endpoint: ":teaId",
17
+ method: "getDoc",
18
+ })
19
+ .setParams({ teaId: 1 });
20
+
21
+ const removeReq = client
22
+ .createRequest<{ response: Tea }>()({
23
+ endpoint: ":teaId",
24
+ method: "deleteDoc",
25
+ })
26
+ .setParams({ teaId: 1 });
27
+
28
+ await removeReq.send();
29
+ const { data, extra } = await getReq.send();
30
+ expect(data).toBe(null);
31
+ // eslint-disable-next-line @typescript-eslint/ban-ts-comment
32
+ // @ts-ignore
33
+ expect(extra?.snapshot?.exists()).toBe(false);
34
+ });
35
+ it("should emit lifecycle events", async () => {
36
+ const removeReq = client
37
+ .createRequest<{ response: Tea }>()({
38
+ endpoint: ":teaId",
39
+ method: "deleteDoc",
40
+ })
41
+ .setParams({ teaId: 1 });
42
+
43
+ await testLifecycleEvents(removeReq);
44
+ });
45
+ });
46
+ };
@@ -0,0 +1,72 @@
1
+ import { Client } from "@hyper-fetch/core";
2
+
3
+ import { FirebaseAdapter } from "adapter";
4
+ import { testLifecycleEvents } from "../../../../shared/request-events.shared";
5
+ import { Tea } from "../../../../utils";
6
+
7
+ export const setTestSuite = (adapterFunction: () => ReturnType<typeof FirebaseAdapter>) => {
8
+ describe("set", () => {
9
+ let client = new Client({ url: "teas/" }).setAdapter(adapterFunction());
10
+ beforeEach(() => {
11
+ client = new Client({ url: "teas/" }).setAdapter(adapterFunction());
12
+ });
13
+ it("should set data", async () => {
14
+ const newData = { origin: "Poland", type: "Green", year: 2023, name: "Pou Ran Do Cha", amount: 10 } as Tea;
15
+
16
+ const getReq = client
17
+ .createRequest<{ response: Tea }>()({
18
+ endpoint: ":teaId",
19
+ method: "getDoc",
20
+ })
21
+ .setParams({ teaId: 1 });
22
+ const setReq = client
23
+ .createRequest<{ response: Tea; payload: Tea }>()({
24
+ endpoint: ":teaId",
25
+ method: "setDoc",
26
+ })
27
+ .setParams({ teaId: 1 })
28
+ .setPayload(newData);
29
+
30
+ await setReq.send();
31
+ const { data, extra } = await getReq.send();
32
+ expect(data).toStrictEqual(newData);
33
+ // eslint-disable-next-line @typescript-eslint/ban-ts-comment
34
+ // @ts-ignore
35
+ expect(extra.snapshot.exists()).toBe(true);
36
+ });
37
+ it("should allow for removing data via set", async () => {
38
+ const getReq = client
39
+ .createRequest<{ response: Tea }>()({
40
+ endpoint: ":teaId",
41
+ method: "getDoc",
42
+ })
43
+ .setParams({ teaId: 1 });
44
+
45
+ const setReq = client
46
+ .createRequest<{ response: Tea; payload: { data: null } }>()({
47
+ endpoint: ":teaId",
48
+ method: "setDoc",
49
+ })
50
+ .setParams({ teaId: 1 })
51
+ .setPayload({ data: null });
52
+
53
+ await setReq.send();
54
+ const { data, extra } = await getReq.send();
55
+ expect(data).toBe(null);
56
+ // eslint-disable-next-line @typescript-eslint/ban-ts-comment
57
+ // @ts-ignore
58
+ expect(extra?.snapshot?.exists()).toBe(false);
59
+ });
60
+ it("should emit lifecycle events", async () => {
61
+ const setReq = client
62
+ .createRequest<{ response: Tea; payload: { data: null } }>()({
63
+ endpoint: ":teaId",
64
+ method: "setDoc",
65
+ })
66
+ .setParams({ teaId: 1 })
67
+ .setPayload({ data: null });
68
+
69
+ await testLifecycleEvents(setReq);
70
+ });
71
+ });
72
+ };
@@ -0,0 +1,42 @@
1
+ import { Client } from "@hyper-fetch/core";
2
+
3
+ import { FirebaseAdapter } from "adapter";
4
+ import { testLifecycleEvents } from "../../../../shared/request-events.shared";
5
+ import { Tea } from "../../../../utils";
6
+
7
+ export const updateTestSuite = (adapterFunction: () => ReturnType<typeof FirebaseAdapter>) => {
8
+ describe("update", () => {
9
+ let client = new Client({ url: "teas/" }).setAdapter(adapterFunction());
10
+ beforeEach(() => {
11
+ client = new Client({ url: "teas/" }).setAdapter(adapterFunction());
12
+ });
13
+
14
+ it("should allow for updating data", async () => {
15
+ const newData = { name: "Pou Ran Do Cha", amount: 100, year: 966 } as Tea;
16
+ const updateReq = client
17
+ .createRequest<{ response: Tea; payload: Tea }>()({
18
+ endpoint: ":teaId",
19
+ method: "updateDoc",
20
+ })
21
+ .setPayload(newData);
22
+ const getReq = client.createRequest<{ response: Tea }>()({
23
+ endpoint: ":teaId",
24
+ method: "getDoc",
25
+ });
26
+ await updateReq.send({ params: { teaId: 1 } });
27
+ const { data } = await getReq.send({ params: { teaId: 1 } });
28
+ expect(data).toStrictEqual({ ...newData, origin: "China", type: "Green" });
29
+ });
30
+ it("should emit lifecycle events", async () => {
31
+ const newData = { name: "Pou Ran Do Cha", amount: 100, year: 966 } as Tea;
32
+
33
+ const updateReq = client
34
+ .createRequest<{ response: Tea; payload: Tea }>()({
35
+ endpoint: ":teaId",
36
+ method: "updateDoc",
37
+ })
38
+ .setPayload(newData);
39
+ await testLifecycleEvents(updateReq);
40
+ });
41
+ });
42
+ };
@@ -0,0 +1,25 @@
1
+ /* eslint-disable max-params */
2
+ import { FirebaseAdapter, FirebaseAdapterTypes, FirebaseDBTypes, FirebaseSocketAdapterTypes } from "adapter";
3
+ import { pushTestSuite } from "./methods/push.test.suite";
4
+ import { onValueTestSuite } from "./methods/on-value.test.suite";
5
+ import { getTestSuite } from "./methods/get.test.suite";
6
+ import { setTestSuite } from "./methods/set.test.suite";
7
+ import { updateTestSuite } from "./methods/update.test.suite";
8
+ import { removeTestSuite } from "./methods/remove.test.suite";
9
+
10
+ export const methodsSharedTestCases = (adapterFunction: () => ReturnType<typeof FirebaseAdapter>) => {
11
+ getTestSuite(adapterFunction);
12
+ setTestSuite(adapterFunction);
13
+ pushTestSuite(adapterFunction);
14
+ updateTestSuite(adapterFunction);
15
+ removeTestSuite(adapterFunction);
16
+ };
17
+
18
+ export const socketsMethodsSharedTestCases = (
19
+ db: FirebaseDBTypes,
20
+ seedDbMethod: (db: any) => Promise<void>,
21
+ socketsAdapter: (database: FirebaseDBTypes) => FirebaseSocketAdapterTypes<any>,
22
+ coreAdapter: (database: FirebaseDBTypes) => FirebaseAdapterTypes<any>,
23
+ ) => {
24
+ onValueTestSuite(db, seedDbMethod, socketsAdapter, coreAdapter);
25
+ };
@@ -0,0 +1 @@
1
+ import "jest-extended";
@@ -0,0 +1,8 @@
1
+ import { setImmediate } from "timers";
2
+ import { AbortController } from "abortcontroller-polyfill/dist/cjs-ponyfill";
3
+
4
+ global.setImmediate = setImmediate;
5
+
6
+ if (!global.AbortController) {
7
+ global.AbortController = AbortController as any;
8
+ }