@talkpilot/core-db 1.3.6 → 1.3.7

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 (167) hide show
  1. package/.cursor/rules/development.mdc +65 -65
  2. package/DEVELOPMENT.md +141 -141
  3. package/README.md +190 -190
  4. package/README_OLD.md +160 -160
  5. package/dist/talkpilot/flows/flows.schema.d.ts +3 -0
  6. package/dist/talkpilot/flows/flows.schema.d.ts.map +1 -1
  7. package/dist/talkpilot/flows/flows.schema.js +1 -0
  8. package/dist/talkpilot/flows/flows.schema.js.map +1 -1
  9. package/dist/talkpilot/flows/flows.types.d.ts +1 -0
  10. package/dist/talkpilot/flows/flows.types.d.ts.map +1 -1
  11. package/jest.config.js +20 -20
  12. package/package.json +46 -46
  13. package/src/__tests__/setup.ts +20 -20
  14. package/src/connection.ts +54 -54
  15. package/src/index.ts +26 -26
  16. package/src/municipal/__tests__/validation.spec.ts +62 -62
  17. package/src/municipal/cities/cities.getters.ts +50 -50
  18. package/src/municipal/cities/cities.types.ts +11 -11
  19. package/src/municipal/cities/index.ts +2 -2
  20. package/src/municipal/departmentsSubjects/departmentsSubjects.getters.ts +282 -282
  21. package/src/municipal/departmentsSubjects/departmentsSubjects.types.ts +72 -72
  22. package/src/municipal/departmentsSubjects/index.ts +9 -9
  23. package/src/municipal/index.ts +22 -22
  24. package/src/municipal/mongodb-client.ts +61 -61
  25. package/src/municipal/muniIssues/__tests__/muniIssues.setters.spec.ts +92 -92
  26. package/src/municipal/muniIssues/__tests__/muniIssues.setup.spec.ts +92 -92
  27. package/src/municipal/muniIssues/index.ts +17 -17
  28. package/src/municipal/muniIssues/muniIssues.constants.ts +18 -18
  29. package/src/municipal/muniIssues/muniIssues.getters.ts +24 -24
  30. package/src/municipal/muniIssues/muniIssues.schema.ts +66 -66
  31. package/src/municipal/muniIssues/muniIssues.setters.ts +24 -24
  32. package/src/municipal/muniIssues/muniIssues.setup.ts +65 -65
  33. package/src/municipal/muniIssues/muniIssues.types.ts +37 -37
  34. package/src/municipal/streets/index.ts +2 -2
  35. package/src/municipal/streets/streets.getters.ts +125 -125
  36. package/src/municipal/streets/streets.types.ts +18 -18
  37. package/src/municipal/systemInstructions/__tests__/getters.spec.ts +113 -113
  38. package/src/municipal/systemInstructions/__tests__/setters.spec.ts +274 -274
  39. package/src/municipal/systemInstructions/index.ts +7 -7
  40. package/src/municipal/systemInstructions/instructions.getters.ts +57 -57
  41. package/src/municipal/systemInstructions/instructions.setters.ts +119 -119
  42. package/src/municipal/systemInstructions/instructions.types.ts +30 -30
  43. package/src/municipal/tickets/__tests__/tickets.getters.spec.ts +30 -30
  44. package/src/municipal/tickets/__tests__/tickets.statistics.spec.ts +51 -51
  45. package/src/municipal/tickets/index.ts +3 -3
  46. package/src/municipal/tickets/tickets.constants.ts +8 -8
  47. package/src/municipal/tickets/tickets.getters.ts +121 -121
  48. package/src/municipal/tickets/tickets.statistics.aggregation.ts +96 -96
  49. package/src/municipal/tickets/tickets.statistics.getters.ts +71 -71
  50. package/src/municipal/tickets/tickets.types.ts +53 -53
  51. package/src/municipal/utils/types.ts +11 -11
  52. package/src/talkpilot/__tests__/db.spec.ts +38 -38
  53. package/src/talkpilot/__tests__/mongodb-client.spec.ts +18 -18
  54. package/src/talkpilot/__tests__/validation.spec.ts +68 -68
  55. package/src/talkpilot/agents/__tests__/agents.getters.spec.ts +29 -29
  56. package/src/talkpilot/agents/agents.getters.ts +34 -34
  57. package/src/talkpilot/agents/agents.types.ts +14 -14
  58. package/src/talkpilot/agents/index.ts +2 -2
  59. package/src/talkpilot/backgroundToolResults/__tests__/backgroundToolResults.getters.spec.ts +147 -147
  60. package/src/talkpilot/backgroundToolResults/backgroundToolResults.getters.ts +65 -65
  61. package/src/talkpilot/backgroundToolResults/backgroundToolResults.types.ts +23 -23
  62. package/src/talkpilot/backgroundToolResults/index.ts +2 -2
  63. package/src/talkpilot/calls/__tests__/callStats.utils.spec.ts +128 -128
  64. package/src/talkpilot/calls/__tests__/calls.dashboard.spec.ts +149 -149
  65. package/src/talkpilot/calls/__tests__/calls.spec.ts +270 -270
  66. package/src/talkpilot/calls/__tests__/calls.statistics.spec.ts +344 -344
  67. package/src/talkpilot/calls/calls.constants.ts +20 -20
  68. package/src/talkpilot/calls/calls.getters.ts +248 -248
  69. package/src/talkpilot/calls/calls.statistics.getters.ts +587 -587
  70. package/src/talkpilot/calls/calls.statistics.types.ts +44 -44
  71. package/src/talkpilot/calls/calls.types.ts +119 -119
  72. package/src/talkpilot/calls/dashboard/calls.dashboard.ts +292 -292
  73. package/src/talkpilot/calls/dashboard/calls.dashboard.types.ts +57 -57
  74. package/src/talkpilot/calls/index.ts +6 -6
  75. package/src/talkpilot/clientAudioBuffers/__tests__/clientAudioBuffer.getters.spec.ts +160 -160
  76. package/src/talkpilot/clientAudioBuffers/clientAudioBuffer.getters.ts +117 -117
  77. package/src/talkpilot/clientAudioBuffers/clientsAudioBuffers.types.ts +25 -25
  78. package/src/talkpilot/clientAudioBuffers/index.ts +2 -2
  79. package/src/talkpilot/clients/clients.getters.ts +16 -16
  80. package/src/talkpilot/clients/clients.types.ts +14 -14
  81. package/src/talkpilot/clients/index.ts +2 -2
  82. package/src/talkpilot/clientsConfig/__tests__/clientsConfig.getters.spec.ts +53 -53
  83. package/src/talkpilot/clientsConfig/__tests__/clientsConfig.spec.ts +190 -190
  84. package/src/talkpilot/clientsConfig/clientsConfig.getters.ts +55 -55
  85. package/src/talkpilot/clientsConfig/clientsConfig.types.ts +127 -127
  86. package/src/talkpilot/clientsConfig/index.ts +2 -2
  87. package/src/talkpilot/contextNotes/__tests__/contextNotes.getters.spec.ts +176 -176
  88. package/src/talkpilot/contextNotes/contextNotes.getters.ts +86 -86
  89. package/src/talkpilot/contextNotes/contextNotes.types.ts +20 -20
  90. package/src/talkpilot/contextNotes/index.ts +2 -2
  91. package/src/talkpilot/flows/__tests__/flows.schema.spec.ts +96 -71
  92. package/src/talkpilot/flows/flows.getter.ts +14 -14
  93. package/src/talkpilot/flows/flows.schema.ts +154 -153
  94. package/src/talkpilot/flows/flows.types.ts +187 -186
  95. package/src/talkpilot/flows/index.ts +2 -2
  96. package/src/talkpilot/groups/__tests__/groups.spec.ts +90 -90
  97. package/src/talkpilot/groups/__tests__/phone.utils.spec.ts +32 -32
  98. package/src/talkpilot/groups/groups.getters.ts +30 -30
  99. package/src/talkpilot/groups/groups.types.ts +29 -29
  100. package/src/talkpilot/groups/index.ts +3 -3
  101. package/src/talkpilot/groups/phone.utils.ts +46 -46
  102. package/src/talkpilot/index.ts +31 -31
  103. package/src/talkpilot/leads/index.ts +2 -2
  104. package/src/talkpilot/leads/leads.getter.ts +6 -6
  105. package/src/talkpilot/leads/leads.schema.ts +33 -33
  106. package/src/talkpilot/leads/leads.types.ts +20 -20
  107. package/src/talkpilot/mongodb-client.ts +78 -78
  108. package/src/talkpilot/phone_numbers/__tests__/phone_numbers.spec.ts +252 -252
  109. package/src/talkpilot/phone_numbers/index.ts +2 -2
  110. package/src/talkpilot/phone_numbers/phone_numbers.getter.ts +158 -158
  111. package/src/talkpilot/phone_numbers/phone_numbers.schema.ts +17 -17
  112. package/src/talkpilot/phone_numbers/phone_numbers.types.ts +30 -30
  113. package/src/talkpilot/plans/__tests__/plans.spec.ts +70 -70
  114. package/src/talkpilot/plans/index.ts +2 -2
  115. package/src/talkpilot/plans/plans.getters.ts +132 -132
  116. package/src/talkpilot/plans/plans.types.ts +89 -89
  117. package/src/talkpilot/products/__tests__/products.getters.spec.ts +45 -45
  118. package/src/talkpilot/products/index.ts +2 -2
  119. package/src/talkpilot/products/products.getters.ts +12 -12
  120. package/src/talkpilot/products/products.types.ts +9 -9
  121. package/src/talkpilot/results/index.ts +7 -7
  122. package/src/talkpilot/results/results.getter.ts +39 -39
  123. package/src/talkpilot/results/results.schema.ts +25 -25
  124. package/src/talkpilot/results/results.types.ts +34 -34
  125. package/src/talkpilot/retry_analyze/__tests__/retryAnalyze.getters.spec.ts +156 -156
  126. package/src/talkpilot/retry_analyze/index.ts +2 -2
  127. package/src/talkpilot/retry_analyze/retryAnalyze.getters.ts +84 -84
  128. package/src/talkpilot/retry_analyze/retryAnalyze.types.ts +13 -13
  129. package/src/talkpilot/sessions/__tests__/sessions.spec.ts +147 -147
  130. package/src/talkpilot/sessions/index.ts +2 -2
  131. package/src/talkpilot/sessions/sessions.getter.ts +92 -92
  132. package/src/talkpilot/sessions/sessions.schema.ts +34 -34
  133. package/src/talkpilot/sessions/sessions.types.ts +30 -30
  134. package/src/talkpilot/subscriptions/__tests__/subscriptions.getters.utils.spec.ts +45 -45
  135. package/src/talkpilot/subscriptions/index.ts +3 -3
  136. package/src/talkpilot/subscriptions/subscriptions.getters.ts +146 -146
  137. package/src/talkpilot/subscriptions/subscriptions.getters.utils.ts +33 -33
  138. package/src/talkpilot/subscriptions/subscriptions.types.ts +66 -66
  139. package/src/talkpilot/utils/__tests__/query.utils.spec.ts +49 -49
  140. package/src/talkpilot/utils/query.utils.ts +21 -21
  141. package/src/test-utils/db-utils.ts +26 -26
  142. package/src/test-utils/factories/index.ts +15 -15
  143. package/src/test-utils/factories/municipal/cities.ts +16 -16
  144. package/src/test-utils/factories/municipal/departmentsSubjects.ts +37 -37
  145. package/src/test-utils/factories/municipal/muniIssues.ts +32 -32
  146. package/src/test-utils/factories/municipal/streets.ts +22 -22
  147. package/src/test-utils/factories/municipal/tickets.ts +39 -39
  148. package/src/test-utils/factories/talkpilot/agents.ts +19 -19
  149. package/src/test-utils/factories/talkpilot/calls.ts +37 -37
  150. package/src/test-utils/factories/talkpilot/clientAudioBuffers.ts +20 -20
  151. package/src/test-utils/factories/talkpilot/clientsConfig.ts +18 -18
  152. package/src/test-utils/factories/talkpilot/contextNotes.ts +33 -33
  153. package/src/test-utils/factories/talkpilot/flows.ts +33 -33
  154. package/src/test-utils/factories/talkpilot/groups.ts +33 -33
  155. package/src/test-utils/factories/talkpilot/phone_numbers.ts +22 -22
  156. package/src/test-utils/factories/talkpilot/sessions.ts +35 -35
  157. package/src/test-utils/factories/websitalk/scans.ts +23 -23
  158. package/src/utils/date.utils.ts +116 -116
  159. package/src/utils/shared.types.ts +4 -4
  160. package/src/utils/validation.ts +23 -23
  161. package/src/websitalk/index.ts +15 -15
  162. package/src/websitalk/mongodb-client.ts +61 -61
  163. package/src/websitalk/scans/__tests__/scans.spec.ts +218 -218
  164. package/src/websitalk/scans/index.ts +2 -2
  165. package/src/websitalk/scans/scans.getters.ts +113 -113
  166. package/src/websitalk/scans/scans.types.ts +53 -53
  167. package/tsconfig.json +23 -23
@@ -1,61 +1,61 @@
1
- import { MongoClient, Db } from "mongodb";
2
- import { setDb } from "./index";
3
- import { validateConfig, validateMongoUri } from "../utils/validation";
4
-
5
- class WebsitalkMongoDBClient {
6
- private client: MongoClient | null = null;
7
- private db: Db | null = null;
8
- private readonly defaultDbName = "website-talk";
9
-
10
- async connect(uri?: string, dbName?: string): Promise<void> {
11
- if (this.client) {
12
- return;
13
- }
14
-
15
- const mongodbUri = uri || process.env.MONGO_URI || process.env.MONGODB_URI;
16
- validateConfig("MONGO_URI", mongodbUri);
17
- validateMongoUri(mongodbUri!);
18
-
19
- try {
20
- this.client = new MongoClient(mongodbUri!);
21
- await this.client.connect();
22
- const targetDbName =
23
- dbName || process.env.WEBSITALK_DB_NAME || this.defaultDbName;
24
- this.db = this.client.db(targetDbName);
25
- setDb(this.db);
26
- console.info(`[core-db] Website Talk MongoDB connected: ${targetDbName}`);
27
- } catch (error) {
28
- console.error("[core-db] Website Talk connection failed", error);
29
- throw error;
30
- }
31
- }
32
-
33
- async disconnect(): Promise<void> {
34
- if (this.client) {
35
- try {
36
- await this.client.close();
37
- this.client = null;
38
- this.db = null;
39
- console.info("Website Talk MongoDB disconnected successfully");
40
- } catch (error) {
41
- console.error("[core-db] Website Talk disconnection failed", error);
42
- throw error;
43
- }
44
- }
45
- }
46
-
47
- getDb(): Db {
48
- if (!this.db) {
49
- throw new Error(
50
- "Website Talk database not initialized. Call connect() first.",
51
- );
52
- }
53
- return this.db;
54
- }
55
-
56
- isConnected(): boolean {
57
- return this.client !== null && this.client !== undefined;
58
- }
59
- }
60
-
61
- export const websitalkMongodbClient = new WebsitalkMongoDBClient();
1
+ import { MongoClient, Db } from "mongodb";
2
+ import { setDb } from "./index";
3
+ import { validateConfig, validateMongoUri } from "../utils/validation";
4
+
5
+ class WebsitalkMongoDBClient {
6
+ private client: MongoClient | null = null;
7
+ private db: Db | null = null;
8
+ private readonly defaultDbName = "website-talk";
9
+
10
+ async connect(uri?: string, dbName?: string): Promise<void> {
11
+ if (this.client) {
12
+ return;
13
+ }
14
+
15
+ const mongodbUri = uri || process.env.MONGO_URI || process.env.MONGODB_URI;
16
+ validateConfig("MONGO_URI", mongodbUri);
17
+ validateMongoUri(mongodbUri!);
18
+
19
+ try {
20
+ this.client = new MongoClient(mongodbUri!);
21
+ await this.client.connect();
22
+ const targetDbName =
23
+ dbName || process.env.WEBSITALK_DB_NAME || this.defaultDbName;
24
+ this.db = this.client.db(targetDbName);
25
+ setDb(this.db);
26
+ console.info(`[core-db] Website Talk MongoDB connected: ${targetDbName}`);
27
+ } catch (error) {
28
+ console.error("[core-db] Website Talk connection failed", error);
29
+ throw error;
30
+ }
31
+ }
32
+
33
+ async disconnect(): Promise<void> {
34
+ if (this.client) {
35
+ try {
36
+ await this.client.close();
37
+ this.client = null;
38
+ this.db = null;
39
+ console.info("Website Talk MongoDB disconnected successfully");
40
+ } catch (error) {
41
+ console.error("[core-db] Website Talk disconnection failed", error);
42
+ throw error;
43
+ }
44
+ }
45
+ }
46
+
47
+ getDb(): Db {
48
+ if (!this.db) {
49
+ throw new Error(
50
+ "Website Talk database not initialized. Call connect() first.",
51
+ );
52
+ }
53
+ return this.db;
54
+ }
55
+
56
+ isConnected(): boolean {
57
+ return this.client !== null && this.client !== undefined;
58
+ }
59
+ }
60
+
61
+ export const websitalkMongodbClient = new WebsitalkMongoDBClient();
@@ -1,218 +1,218 @@
1
- import {
2
- getScansCollection,
3
- getScansByClientAndDateRange,
4
- getScanFieldsByClientAndDateRange,
5
- findScansByQuery,
6
- countScans,
7
- createScanDoc,
8
- updateScanDoc,
9
- getActiveScanStatus,
10
- } from "../scans.getters";
11
- import { createScanFixture } from "../../../test-utils/factories";
12
- import { ObjectId } from "mongodb";
13
-
14
- describe("db.websitalk.scans", () => {
15
- describe("getScansByClientAndDateRange()", () => {
16
- it("should return full scan documents within the date range", async () => {
17
- const clientId = "dateRangeClient";
18
- const startDate = new Date("2023-05-01");
19
- const endDate = new Date("2023-05-31");
20
-
21
- const scanInside = createScanFixture({ clientId, status: "COMPLETED" });
22
- const scanBefore = createScanFixture({ clientId });
23
- const scanAfter = createScanFixture({ clientId });
24
-
25
- await getScansCollection().insertMany([
26
- { ...scanInside, createdAt: new Date("2023-05-15") },
27
- { ...scanBefore, createdAt: new Date("2023-04-30") },
28
- { ...scanAfter, createdAt: new Date("2023-06-01") },
29
- ]);
30
-
31
- const result = await getScansByClientAndDateRange(
32
- clientId,
33
- startDate,
34
- endDate,
35
- );
36
-
37
- expect(result.length).toBe(1);
38
- expect(result[0]).toMatchObject({
39
- clientId,
40
- baseUrl: scanInside.baseUrl,
41
- status: "COMPLETED",
42
- });
43
- expect(result[0]).toHaveProperty("siteChrome");
44
- expect(result[0]).toHaveProperty("skipped");
45
- });
46
-
47
- it("should respect the date range boundaries (inclusive)", async () => {
48
- const clientId = "boundaryClient";
49
- const onStart = createScanFixture({ clientId });
50
- const onEnd = createScanFixture({ clientId });
51
-
52
- await getScansCollection().insertMany([
53
- { ...onStart, createdAt: new Date("2023-05-01") },
54
- { ...onEnd, createdAt: new Date("2023-05-31") },
55
- ]);
56
-
57
- const result = await getScansByClientAndDateRange(
58
- clientId,
59
- new Date("2023-05-01"),
60
- new Date("2023-05-31"),
61
- );
62
-
63
- expect(result.length).toBe(2);
64
- });
65
- });
66
-
67
- describe("getScanFieldsByClientAndDateRange()", () => {
68
- it("should return only the requested fields (plus _id)", async () => {
69
- const clientId = "projectionClient";
70
- const scan = createScanFixture({
71
- clientId,
72
- status: "COMPLETED",
73
- siteChrome: { url: "https://example.com", sourceType: "site_chrome" },
74
- skipped: [{ path: "/broken", reason: "HTTP 500" }],
75
- });
76
-
77
- await getScansCollection().insertOne({
78
- ...scan,
79
- createdAt: new Date("2023-05-15"),
80
- });
81
-
82
- const [result] = await getScanFieldsByClientAndDateRange(
83
- clientId,
84
- new Date("2023-05-01"),
85
- new Date("2023-05-31"),
86
- ["clientId", "baseUrl", "status"],
87
- );
88
-
89
- expect(result).toMatchObject({
90
- clientId,
91
- baseUrl: scan.baseUrl,
92
- status: "COMPLETED",
93
- });
94
- expect(result).toHaveProperty("_id");
95
- expect(result).not.toHaveProperty("siteChrome");
96
- expect(result).not.toHaveProperty("skipped");
97
- expect(result).not.toHaveProperty("createdAt");
98
- });
99
- });
100
-
101
- describe("findScansByQuery() / countScans()", () => {
102
- it("should find scans matching a raw filter and count them", async () => {
103
- const clientId = "queryClient";
104
- const completed = createScanFixture({ clientId, status: "COMPLETED" });
105
- const scanning = createScanFixture({ clientId, status: "SCANNING" });
106
-
107
- await getScansCollection().insertMany([completed, scanning]);
108
-
109
- const result = await findScansByQuery({ clientId, status: "COMPLETED" });
110
- const count = await countScans({ clientId });
111
-
112
- expect(result.length).toBe(1);
113
- expect(result[0].baseUrl).toBe(completed.baseUrl);
114
- expect(count).toBe(2);
115
- });
116
- });
117
-
118
- describe("createScanDoc()", () => {
119
- it("should insert a scan with default values for the rest of the fields", async () => {
120
- const clientId = "createClient";
121
- const baseUrl = "https://example.com";
122
-
123
- const { insertedId } = await createScanDoc({ clientId, baseUrl });
124
-
125
- const result = await getScansCollection().findOne({ _id: insertedId });
126
-
127
- expect(result).toMatchObject({
128
- clientId,
129
- baseUrl,
130
- status: "CHECKING",
131
- activeTasksCount: 0,
132
- pagesScanned: 0,
133
- pagesSkipped: 0,
134
- skipped: [],
135
- siteChrome: {},
136
- });
137
- expect(result?.createdAt).toBeInstanceOf(Date);
138
- expect(result?.updatedAt).toBeInstanceOf(Date);
139
- });
140
- });
141
-
142
- describe("updateScanDoc()", () => {
143
- it("should update the given fields and bump updatedAt", async () => {
144
- const scan = createScanFixture({ status: "SCANNING", pagesScanned: 0 });
145
- const { insertedId } = await getScansCollection().insertOne(scan);
146
-
147
- const result = await updateScanDoc(insertedId, {
148
- status: "COMPLETED",
149
- pagesScanned: 10,
150
- });
151
-
152
- expect(result).toMatchObject({
153
- _id: insertedId,
154
- status: "COMPLETED",
155
- pagesScanned: 10,
156
- });
157
- expect(result?.updatedAt.getTime()).toBeGreaterThan(
158
- scan.updatedAt.getTime(),
159
- );
160
- });
161
-
162
- it("should return null when the scan does not exist", async () => {
163
- const result = await updateScanDoc(new ObjectId(), { status: "FAILED" });
164
-
165
- expect(result).toBeNull();
166
- });
167
- });
168
-
169
- describe("getActiveScanStatus()", () => {
170
- it("should return isActive: true with the status when the latest scan is still in progress", async () => {
171
- const clientId = "activeClient";
172
-
173
- await getScansCollection().insertMany([
174
- createScanFixture({
175
- clientId,
176
- status: "COMPLETED",
177
- createdAt: new Date("2023-05-01"),
178
- }),
179
- createScanFixture({
180
- clientId,
181
- status: "SCANNING",
182
- createdAt: new Date("2023-05-15"),
183
- }),
184
- ]);
185
-
186
- const result = await getActiveScanStatus(clientId);
187
-
188
- expect(result).toEqual({ isActive: true, status: "SCANNING" });
189
- });
190
-
191
- it("should return isActive: false when the latest scan finished (COMPLETED / FAILED)", async () => {
192
- const clientId = "finishedClient";
193
-
194
- await getScansCollection().insertMany([
195
- createScanFixture({
196
- clientId,
197
- status: "SCANNING",
198
- createdAt: new Date("2023-05-01"),
199
- }),
200
- createScanFixture({
201
- clientId,
202
- status: "FAILED",
203
- createdAt: new Date("2023-05-15"),
204
- }),
205
- ]);
206
-
207
- const result = await getActiveScanStatus(clientId);
208
-
209
- expect(result).toEqual({ isActive: false });
210
- });
211
-
212
- it("should return isActive: false when the client has no scans", async () => {
213
- const result = await getActiveScanStatus("noScansClient");
214
-
215
- expect(result).toEqual({ isActive: false });
216
- });
217
- });
218
- });
1
+ import {
2
+ getScansCollection,
3
+ getScansByClientAndDateRange,
4
+ getScanFieldsByClientAndDateRange,
5
+ findScansByQuery,
6
+ countScans,
7
+ createScanDoc,
8
+ updateScanDoc,
9
+ getActiveScanStatus,
10
+ } from "../scans.getters";
11
+ import { createScanFixture } from "../../../test-utils/factories";
12
+ import { ObjectId } from "mongodb";
13
+
14
+ describe("db.websitalk.scans", () => {
15
+ describe("getScansByClientAndDateRange()", () => {
16
+ it("should return full scan documents within the date range", async () => {
17
+ const clientId = "dateRangeClient";
18
+ const startDate = new Date("2023-05-01");
19
+ const endDate = new Date("2023-05-31");
20
+
21
+ const scanInside = createScanFixture({ clientId, status: "COMPLETED" });
22
+ const scanBefore = createScanFixture({ clientId });
23
+ const scanAfter = createScanFixture({ clientId });
24
+
25
+ await getScansCollection().insertMany([
26
+ { ...scanInside, createdAt: new Date("2023-05-15") },
27
+ { ...scanBefore, createdAt: new Date("2023-04-30") },
28
+ { ...scanAfter, createdAt: new Date("2023-06-01") },
29
+ ]);
30
+
31
+ const result = await getScansByClientAndDateRange(
32
+ clientId,
33
+ startDate,
34
+ endDate,
35
+ );
36
+
37
+ expect(result.length).toBe(1);
38
+ expect(result[0]).toMatchObject({
39
+ clientId,
40
+ baseUrl: scanInside.baseUrl,
41
+ status: "COMPLETED",
42
+ });
43
+ expect(result[0]).toHaveProperty("siteChrome");
44
+ expect(result[0]).toHaveProperty("skipped");
45
+ });
46
+
47
+ it("should respect the date range boundaries (inclusive)", async () => {
48
+ const clientId = "boundaryClient";
49
+ const onStart = createScanFixture({ clientId });
50
+ const onEnd = createScanFixture({ clientId });
51
+
52
+ await getScansCollection().insertMany([
53
+ { ...onStart, createdAt: new Date("2023-05-01") },
54
+ { ...onEnd, createdAt: new Date("2023-05-31") },
55
+ ]);
56
+
57
+ const result = await getScansByClientAndDateRange(
58
+ clientId,
59
+ new Date("2023-05-01"),
60
+ new Date("2023-05-31"),
61
+ );
62
+
63
+ expect(result.length).toBe(2);
64
+ });
65
+ });
66
+
67
+ describe("getScanFieldsByClientAndDateRange()", () => {
68
+ it("should return only the requested fields (plus _id)", async () => {
69
+ const clientId = "projectionClient";
70
+ const scan = createScanFixture({
71
+ clientId,
72
+ status: "COMPLETED",
73
+ siteChrome: { url: "https://example.com", sourceType: "site_chrome" },
74
+ skipped: [{ path: "/broken", reason: "HTTP 500" }],
75
+ });
76
+
77
+ await getScansCollection().insertOne({
78
+ ...scan,
79
+ createdAt: new Date("2023-05-15"),
80
+ });
81
+
82
+ const [result] = await getScanFieldsByClientAndDateRange(
83
+ clientId,
84
+ new Date("2023-05-01"),
85
+ new Date("2023-05-31"),
86
+ ["clientId", "baseUrl", "status"],
87
+ );
88
+
89
+ expect(result).toMatchObject({
90
+ clientId,
91
+ baseUrl: scan.baseUrl,
92
+ status: "COMPLETED",
93
+ });
94
+ expect(result).toHaveProperty("_id");
95
+ expect(result).not.toHaveProperty("siteChrome");
96
+ expect(result).not.toHaveProperty("skipped");
97
+ expect(result).not.toHaveProperty("createdAt");
98
+ });
99
+ });
100
+
101
+ describe("findScansByQuery() / countScans()", () => {
102
+ it("should find scans matching a raw filter and count them", async () => {
103
+ const clientId = "queryClient";
104
+ const completed = createScanFixture({ clientId, status: "COMPLETED" });
105
+ const scanning = createScanFixture({ clientId, status: "SCANNING" });
106
+
107
+ await getScansCollection().insertMany([completed, scanning]);
108
+
109
+ const result = await findScansByQuery({ clientId, status: "COMPLETED" });
110
+ const count = await countScans({ clientId });
111
+
112
+ expect(result.length).toBe(1);
113
+ expect(result[0].baseUrl).toBe(completed.baseUrl);
114
+ expect(count).toBe(2);
115
+ });
116
+ });
117
+
118
+ describe("createScanDoc()", () => {
119
+ it("should insert a scan with default values for the rest of the fields", async () => {
120
+ const clientId = "createClient";
121
+ const baseUrl = "https://example.com";
122
+
123
+ const { insertedId } = await createScanDoc({ clientId, baseUrl });
124
+
125
+ const result = await getScansCollection().findOne({ _id: insertedId });
126
+
127
+ expect(result).toMatchObject({
128
+ clientId,
129
+ baseUrl,
130
+ status: "CHECKING",
131
+ activeTasksCount: 0,
132
+ pagesScanned: 0,
133
+ pagesSkipped: 0,
134
+ skipped: [],
135
+ siteChrome: {},
136
+ });
137
+ expect(result?.createdAt).toBeInstanceOf(Date);
138
+ expect(result?.updatedAt).toBeInstanceOf(Date);
139
+ });
140
+ });
141
+
142
+ describe("updateScanDoc()", () => {
143
+ it("should update the given fields and bump updatedAt", async () => {
144
+ const scan = createScanFixture({ status: "SCANNING", pagesScanned: 0 });
145
+ const { insertedId } = await getScansCollection().insertOne(scan);
146
+
147
+ const result = await updateScanDoc(insertedId, {
148
+ status: "COMPLETED",
149
+ pagesScanned: 10,
150
+ });
151
+
152
+ expect(result).toMatchObject({
153
+ _id: insertedId,
154
+ status: "COMPLETED",
155
+ pagesScanned: 10,
156
+ });
157
+ expect(result?.updatedAt.getTime()).toBeGreaterThan(
158
+ scan.updatedAt.getTime(),
159
+ );
160
+ });
161
+
162
+ it("should return null when the scan does not exist", async () => {
163
+ const result = await updateScanDoc(new ObjectId(), { status: "FAILED" });
164
+
165
+ expect(result).toBeNull();
166
+ });
167
+ });
168
+
169
+ describe("getActiveScanStatus()", () => {
170
+ it("should return isActive: true with the status when the latest scan is still in progress", async () => {
171
+ const clientId = "activeClient";
172
+
173
+ await getScansCollection().insertMany([
174
+ createScanFixture({
175
+ clientId,
176
+ status: "COMPLETED",
177
+ createdAt: new Date("2023-05-01"),
178
+ }),
179
+ createScanFixture({
180
+ clientId,
181
+ status: "SCANNING",
182
+ createdAt: new Date("2023-05-15"),
183
+ }),
184
+ ]);
185
+
186
+ const result = await getActiveScanStatus(clientId);
187
+
188
+ expect(result).toEqual({ isActive: true, status: "SCANNING" });
189
+ });
190
+
191
+ it("should return isActive: false when the latest scan finished (COMPLETED / FAILED)", async () => {
192
+ const clientId = "finishedClient";
193
+
194
+ await getScansCollection().insertMany([
195
+ createScanFixture({
196
+ clientId,
197
+ status: "SCANNING",
198
+ createdAt: new Date("2023-05-01"),
199
+ }),
200
+ createScanFixture({
201
+ clientId,
202
+ status: "FAILED",
203
+ createdAt: new Date("2023-05-15"),
204
+ }),
205
+ ]);
206
+
207
+ const result = await getActiveScanStatus(clientId);
208
+
209
+ expect(result).toEqual({ isActive: false });
210
+ });
211
+
212
+ it("should return isActive: false when the client has no scans", async () => {
213
+ const result = await getActiveScanStatus("noScansClient");
214
+
215
+ expect(result).toEqual({ isActive: false });
216
+ });
217
+ });
218
+ });
@@ -1,2 +1,2 @@
1
- export * from "./scans.getters";
2
- export * from "./scans.types";
1
+ export * from "./scans.getters";
2
+ export * from "./scans.types";