@agentica/core 0.43.3 → 0.44.0-dev.20260313-2

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 (205) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +218 -218
  3. package/lib/constants/AgenticaSystemPrompt.js +1 -1
  4. package/lib/constants/AgenticaSystemPrompt.js.map +1 -1
  5. package/lib/context/AgenticaOperation.d.ts +3 -2
  6. package/lib/context/internal/AgenticaOperationComposer.js.map +1 -1
  7. package/lib/context/internal/AgenticaTokenUsageAggregator.js.map +1 -1
  8. package/lib/context/internal/__IChatInitialApplication.d.ts +1 -1
  9. package/lib/errors/AgenticaJsonParseError.d.ts +5 -8
  10. package/lib/errors/AgenticaJsonParseError.js +11 -6
  11. package/lib/errors/AgenticaJsonParseError.js.map +1 -1
  12. package/lib/errors/AgenticaValidationError.d.ts +1 -1
  13. package/lib/events/AgenticaExecuteEvent.d.ts +1 -1
  14. package/lib/events/AgenticaJsonParseErrorEvent.d.ts +2 -2
  15. package/lib/factory/events.d.ts +2 -3
  16. package/lib/factory/events.js +1 -2
  17. package/lib/factory/events.js.map +1 -1
  18. package/lib/functional/assertHttpController.d.ts +2 -3
  19. package/lib/functional/assertHttpController.js +3939 -2656
  20. package/lib/functional/assertHttpController.js.map +1 -1
  21. package/lib/functional/assertHttpLlmApplication.d.ts +3 -3
  22. package/lib/functional/assertHttpLlmApplication.js +3939 -2656
  23. package/lib/functional/assertHttpLlmApplication.js.map +1 -1
  24. package/lib/functional/assertMcpController.d.ts +2 -2
  25. package/lib/functional/assertMcpController.js +202 -629
  26. package/lib/functional/assertMcpController.js.map +1 -1
  27. package/lib/functional/createMcpLlmApplication.d.ts +6 -0
  28. package/lib/functional/createMcpLlmApplication.js +56 -0
  29. package/lib/functional/createMcpLlmApplication.js.map +1 -0
  30. package/lib/functional/validateHttpController.d.ts +3 -3
  31. package/lib/functional/validateHttpController.js +3367 -2268
  32. package/lib/functional/validateHttpController.js.map +1 -1
  33. package/lib/functional/validateHttpLlmApplication.d.ts +3 -4
  34. package/lib/functional/validateHttpLlmApplication.js +3367 -2268
  35. package/lib/functional/validateHttpLlmApplication.js.map +1 -1
  36. package/lib/functional/validateMcpController.d.ts +2 -2
  37. package/lib/functional/validateMcpController.js +388 -1161
  38. package/lib/functional/validateMcpController.js.map +1 -1
  39. package/lib/histories/AgenticaExecuteHistory.d.ts +1 -1
  40. package/lib/index.mjs +21256 -18946
  41. package/lib/index.mjs.map +1 -1
  42. package/lib/orchestrate/call.js +43 -56
  43. package/lib/orchestrate/call.js.map +1 -1
  44. package/lib/orchestrate/cancel.js +9 -66
  45. package/lib/orchestrate/cancel.js.map +1 -1
  46. package/lib/orchestrate/initialize.js +4 -947
  47. package/lib/orchestrate/initialize.js.map +1 -1
  48. package/lib/orchestrate/select.js +11 -68
  49. package/lib/orchestrate/select.js.map +1 -1
  50. package/lib/structures/IAgenticaController.d.ts +143 -151
  51. package/lib/structures/IMcpTool.d.ts +52 -0
  52. package/lib/structures/IMcpTool.js +3 -0
  53. package/lib/structures/IMcpTool.js.map +1 -0
  54. package/lib/utils/ChatGptCompletionMessageUtil.js +16 -5
  55. package/lib/utils/ChatGptCompletionMessageUtil.js.map +1 -1
  56. package/lib/utils/ChatGptCompletionMessageUtil.spec.js +0 -5
  57. package/lib/utils/ChatGptCompletionMessageUtil.spec.js.map +1 -1
  58. package/package.json +7 -9
  59. package/prompts/cancel.md +5 -5
  60. package/prompts/common.md +3 -3
  61. package/prompts/describe.md +7 -7
  62. package/prompts/execute.md +122 -122
  63. package/prompts/initialize.md +3 -3
  64. package/prompts/json_parse_error.md +35 -33
  65. package/prompts/select.md +7 -7
  66. package/prompts/validate.md +123 -123
  67. package/prompts/validate_repeated.md +31 -31
  68. package/src/Agentica.ts +367 -367
  69. package/src/MicroAgentica.ts +357 -357
  70. package/src/constants/AgenticaConstant.ts +4 -4
  71. package/src/constants/AgenticaDefaultPrompt.ts +44 -44
  72. package/src/constants/AgenticaSystemPrompt.ts +1 -1
  73. package/src/constants/index.ts +2 -2
  74. package/src/context/AgenticaContext.ts +136 -136
  75. package/src/context/AgenticaContextRequestResult.ts +14 -14
  76. package/src/context/AgenticaOperation.ts +73 -72
  77. package/src/context/AgenticaOperationCollection.ts +49 -49
  78. package/src/context/AgenticaOperationSelection.ts +9 -9
  79. package/src/context/AgenticaTokenUsage.ts +186 -186
  80. package/src/context/MicroAgenticaContext.ts +99 -99
  81. package/src/context/index.ts +5 -5
  82. package/src/context/internal/AgenticaOperationComposer.ts +177 -177
  83. package/src/context/internal/AgenticaTokenUsageAggregator.ts +66 -66
  84. package/src/context/internal/__IChatCancelFunctionsApplication.ts +23 -23
  85. package/src/context/internal/__IChatFunctionReference.ts +21 -21
  86. package/src/context/internal/__IChatInitialApplication.ts +15 -15
  87. package/src/context/internal/__IChatSelectFunctionsApplication.ts +24 -24
  88. package/src/context/internal/isAgenticaContext.ts +11 -11
  89. package/src/errors/AgenticaJsonParseError.ts +52 -47
  90. package/src/errors/AgenticaValidationError.ts +49 -49
  91. package/src/errors/index.ts +2 -2
  92. package/src/events/AgenticaAssistantMessageEvent.ts +12 -12
  93. package/src/events/AgenticaCallEvent.ts +27 -27
  94. package/src/events/AgenticaCancelEvent.ts +9 -9
  95. package/src/events/AgenticaDescribeEvent.ts +14 -14
  96. package/src/events/AgenticaEvent.ts +59 -59
  97. package/src/events/AgenticaEvent.type.ts +19 -19
  98. package/src/events/AgenticaEventBase.ts +18 -18
  99. package/src/events/AgenticaEventSource.ts +6 -6
  100. package/src/events/AgenticaExecuteEvent.ts +45 -45
  101. package/src/events/AgenticaInitializeEvent.ts +7 -7
  102. package/src/events/AgenticaJsonParseErrorEvent.ts +16 -15
  103. package/src/events/AgenticaRequestEvent.ts +27 -27
  104. package/src/events/AgenticaResponseEvent.ts +32 -32
  105. package/src/events/AgenticaSelectEvent.ts +11 -11
  106. package/src/events/AgenticaUserMessageEvent.ts +12 -12
  107. package/src/events/AgenticaValidateEvent.ts +32 -32
  108. package/src/events/MicroAgenticaEvent.ts +45 -45
  109. package/src/events/index.ts +15 -15
  110. package/src/factory/events.ts +357 -359
  111. package/src/factory/histories.ts +348 -348
  112. package/src/factory/index.ts +3 -3
  113. package/src/factory/operations.ts +16 -16
  114. package/src/functional/assertHttpController.ts +106 -104
  115. package/src/functional/assertHttpLlmApplication.ts +52 -57
  116. package/src/functional/assertMcpController.ts +47 -44
  117. package/src/functional/createMcpLlmApplication.ts +72 -0
  118. package/src/functional/index.ts +7 -7
  119. package/src/functional/validateHttpController.ts +113 -110
  120. package/src/functional/validateHttpLlmApplication.ts +65 -70
  121. package/src/functional/validateMcpController.ts +53 -50
  122. package/src/histories/AgenticaAssistantMessageHistory.ts +10 -10
  123. package/src/histories/AgenticaCancelHistory.ts +8 -8
  124. package/src/histories/AgenticaDescribeHistory.ts +18 -18
  125. package/src/histories/AgenticaExecuteHistory.ts +64 -64
  126. package/src/histories/AgenticaHistory.ts +28 -28
  127. package/src/histories/AgenticaHistoryBase.ts +35 -35
  128. package/src/histories/AgenticaSelectHistory.ts +8 -8
  129. package/src/histories/AgenticaSystemMessageHistory.ts +10 -10
  130. package/src/histories/AgenticaUserMessageHistory.ts +11 -11
  131. package/src/histories/MicroAgenticaHistory.ts +19 -19
  132. package/src/histories/contents/AgenticaUserMessageAudioContent.ts +21 -21
  133. package/src/histories/contents/AgenticaUserMessageContent.ts +19 -19
  134. package/src/histories/contents/AgenticaUserMessageContentBase.ts +6 -6
  135. package/src/histories/contents/AgenticaUserMessageFileContent.ts +25 -25
  136. package/src/histories/contents/AgenticaUserMessageImageContent.ts +33 -33
  137. package/src/histories/contents/AgenticaUserMessageTextContent.ts +15 -15
  138. package/src/histories/contents/index.ts +5 -5
  139. package/src/histories/index.ts +10 -10
  140. package/src/index.ts +15 -15
  141. package/src/json/IAgenticaEventJson.ts +265 -265
  142. package/src/json/IAgenticaEventJson.type.ts +19 -19
  143. package/src/json/IAgenticaHistoryJson.ts +165 -165
  144. package/src/json/IAgenticaHistoryJson.type.ts +19 -19
  145. package/src/json/IAgenticaOperationJson.ts +36 -36
  146. package/src/json/IAgenticaOperationSelectionJson.ts +26 -26
  147. package/src/json/IAgenticaTokenUsageJson.ts +107 -107
  148. package/src/json/IMicroAgenticaEventJson.ts +22 -22
  149. package/src/json/IMicroAgenticaHistoryJson.ts +25 -25
  150. package/src/json/index.ts +7 -7
  151. package/src/orchestrate/call.ts +542 -558
  152. package/src/orchestrate/cancel.ts +265 -269
  153. package/src/orchestrate/describe.ts +66 -66
  154. package/src/orchestrate/execute.ts +61 -61
  155. package/src/orchestrate/index.ts +6 -6
  156. package/src/orchestrate/initialize.ts +102 -102
  157. package/src/orchestrate/internal/cancelFunctionFromContext.ts +33 -33
  158. package/src/orchestrate/internal/selectFunctionFromContext.ts +34 -34
  159. package/src/orchestrate/select.ts +320 -322
  160. package/src/structures/IAgenticaConfig.ts +83 -83
  161. package/src/structures/IAgenticaConfigBase.ts +87 -87
  162. package/src/structures/IAgenticaController.ts +143 -151
  163. package/src/structures/IAgenticaExecutor.ts +167 -167
  164. package/src/structures/IAgenticaProps.ts +78 -78
  165. package/src/structures/IAgenticaSystemPrompt.ts +236 -236
  166. package/src/structures/IAgenticaVendor.ts +54 -54
  167. package/src/structures/IMcpTool.ts +60 -0
  168. package/src/structures/IMicroAgenticaConfig.ts +56 -56
  169. package/src/structures/IMicroAgenticaExecutor.ts +67 -67
  170. package/src/structures/IMicroAgenticaProps.ts +77 -77
  171. package/src/structures/IMicroAgenticaSystemPrompt.ts +169 -169
  172. package/src/structures/index.ts +10 -10
  173. package/src/transformers/transformHistory.ts +172 -172
  174. package/src/utils/AssistantMessageEmptyError.ts +20 -20
  175. package/src/utils/AsyncQueue.spec.ts +355 -355
  176. package/src/utils/AsyncQueue.ts +95 -95
  177. package/src/utils/ByteArrayUtil.ts +5 -5
  178. package/src/utils/ChatGptCompletionMessageUtil.spec.ts +314 -320
  179. package/src/utils/ChatGptCompletionMessageUtil.ts +210 -195
  180. package/src/utils/ChatGptCompletionStreamingUtil.spec.ts +909 -909
  181. package/src/utils/ChatGptCompletionStreamingUtil.ts +91 -91
  182. package/src/utils/ChatGptTokenUsageAggregator.spec.ts +226 -226
  183. package/src/utils/ChatGptTokenUsageAggregator.ts +57 -57
  184. package/src/utils/MPSC.spec.ts +276 -276
  185. package/src/utils/MPSC.ts +42 -42
  186. package/src/utils/Singleton.spec.ts +138 -138
  187. package/src/utils/Singleton.ts +42 -42
  188. package/src/utils/StreamUtil.spec.ts +512 -512
  189. package/src/utils/StreamUtil.ts +87 -87
  190. package/src/utils/__map_take.spec.ts +140 -140
  191. package/src/utils/__map_take.ts +13 -13
  192. package/src/utils/__retry.spec.ts +198 -198
  193. package/src/utils/__retry.ts +18 -18
  194. package/src/utils/assertExecuteFailure.ts +16 -16
  195. package/src/utils/index.ts +4 -4
  196. package/src/utils/request.ts +140 -140
  197. package/src/utils/types.ts +50 -50
  198. package/lib/context/internal/AgenticaOperationComposer.spec.d.ts +0 -1
  199. package/lib/context/internal/AgenticaOperationComposer.spec.js +0 -353
  200. package/lib/context/internal/AgenticaOperationComposer.spec.js.map +0 -1
  201. package/lib/utils/JsonUtil.d.ts +0 -8
  202. package/lib/utils/JsonUtil.js +0 -349
  203. package/lib/utils/JsonUtil.js.map +0 -1
  204. package/src/context/internal/AgenticaOperationComposer.spec.ts +0 -401
  205. package/src/utils/JsonUtil.ts +0 -460
@@ -1,355 +1,355 @@
1
- import { AsyncQueue } from "./AsyncQueue";
2
-
3
- describe("the AsyncQueue", () => {
4
- describe("basic functionality", () => {
5
- it("enqueue and dequeue test", async () => {
6
- const queue = new AsyncQueue<number>();
7
-
8
- // Enqueue items
9
- queue.enqueue(1);
10
- queue.enqueue(2);
11
- queue.enqueue(3);
12
-
13
- // Dequeue items
14
- const result1 = await queue.dequeue();
15
- const result2 = await queue.dequeue();
16
- const result3 = await queue.dequeue();
17
-
18
- expect(result1.value).toBe(1);
19
- expect(result1.done).toBe(false);
20
- expect(result2.value).toBe(2);
21
- expect(result2.done).toBe(false);
22
- expect(result3.value).toBe(3);
23
- expect(result3.done).toBe(false);
24
- });
25
-
26
- it("isEmpty test", async () => {
27
- const queue = new AsyncQueue<number>();
28
-
29
- expect(queue.isEmpty()).toBe(true);
30
-
31
- queue.enqueue(1);
32
- expect(queue.isEmpty()).toBe(false);
33
-
34
- await queue.dequeue();
35
- expect(queue.isEmpty()).toBe(true);
36
- });
37
-
38
- it("isClosed test", () => {
39
- const queue = new AsyncQueue<number>();
40
-
41
- expect(queue.isClosed()).toBe(false);
42
-
43
- queue.close();
44
- expect(queue.isClosed()).toBe(true);
45
- });
46
-
47
- it("done test", async () => {
48
- const queue = new AsyncQueue<number>();
49
-
50
- expect(queue.done()).toBe(false);
51
-
52
- queue.enqueue(1);
53
- expect(queue.done()).toBe(false);
54
-
55
- await queue.dequeue();
56
- expect(queue.done()).toBe(false);
57
-
58
- queue.close();
59
- expect(queue.done()).toBe(true);
60
- });
61
- });
62
-
63
- describe("close functionality", () => {
64
- it("close test with empty queue", async () => {
65
- const queue = new AsyncQueue<number>();
66
-
67
- queue.close();
68
-
69
- const result = await queue.dequeue();
70
- expect(result.done).toBe(true);
71
- expect(result.value).toBeUndefined();
72
- });
73
-
74
- it("close test with non-empty queue", async () => {
75
- const queue = new AsyncQueue<number>();
76
-
77
- queue.enqueue(1);
78
- queue.enqueue(2);
79
- queue.close();
80
-
81
- const result1 = await queue.dequeue();
82
- const result2 = await queue.dequeue();
83
- const result3 = await queue.dequeue();
84
-
85
- expect(result1.value).toBe(1);
86
- expect(result1.done).toBe(false);
87
- expect(result2.value).toBe(2);
88
- expect(result2.done).toBe(false);
89
- expect(result3.done).toBe(true);
90
- expect(result3.value).toBeUndefined();
91
- });
92
-
93
- it("close test with waiting dequeue", async () => {
94
- const queue = new AsyncQueue<number>();
95
-
96
- // Start dequeue before enqueue
97
- const dequeuePromise = queue.dequeue();
98
-
99
- // Close the queue
100
- queue.close();
101
-
102
- const result = await dequeuePromise;
103
- expect(result.done).toBe(true);
104
- expect(result.value).toBeUndefined();
105
- });
106
- });
107
-
108
- describe("waitUntilEmpty functionality", () => {
109
- it("waitUntilEmpty test with empty queue", async () => {
110
- const queue = new AsyncQueue<number>();
111
-
112
- // Should resolve immediately since queue is empty
113
- await queue.waitUntilEmpty();
114
-
115
- queue.enqueue(1);
116
- const result = await queue.dequeue();
117
- expect(result.value).toBe(1);
118
- expect(result.done).toBe(false);
119
- });
120
-
121
- it("waitUntilEmpty test with non-empty queue", async () => {
122
- const queue = new AsyncQueue<number>();
123
-
124
- queue.enqueue(1);
125
- queue.enqueue(2);
126
-
127
- // waitUntilEmpty should not resolve since queue is not empty
128
- const waitPromise = queue.waitUntilEmpty();
129
-
130
- // Dequeue first value
131
- const result1 = await queue.dequeue();
132
- expect(result1.value).toBe(1);
133
-
134
- // Dequeue second value
135
- const result2 = await queue.dequeue();
136
- expect(result2.value).toBe(2);
137
-
138
- // Now queue is empty, waitUntilEmpty should resolve\
139
- await waitPromise;
140
- });
141
- });
142
-
143
- describe("waitClosed functionality", () => {
144
- it("waitClosed test with unclosed queue", async () => {
145
- const queue = new AsyncQueue<number>();
146
-
147
- // waitClosed should not resolve since queue is not closed
148
- const waitPromise = queue.waitClosed();
149
-
150
- queue.enqueue(1);
151
- const result = await queue.dequeue();
152
- expect(result.value).toBe(1);
153
-
154
- // Close the queue
155
- queue.close();
156
-
157
- // Now queue is closed, waitClosed should resolve
158
- await waitPromise;
159
- });
160
-
161
- it("waitClosed test with already closed queue", async () => {
162
- const queue = new AsyncQueue<number>();
163
-
164
- queue.close();
165
-
166
- // waitClosed should resolve immediately since queue is already closed
167
- await queue.waitClosed();
168
- });
169
-
170
- it("multiple waitClosed calls test", async () => {
171
- const queue = new AsyncQueue<number>();
172
-
173
- // Create multiple waitClosed promises
174
- const waitPromises = [queue.waitClosed(), queue.waitClosed(), queue.waitClosed()];
175
-
176
- // Close the queue
177
- queue.close();
178
-
179
- // All promises should resolve
180
- await Promise.all(waitPromises);
181
- });
182
-
183
- it("waitClosed test with delayed close", async () => {
184
- const queue = new AsyncQueue<string>();
185
-
186
- // Start waiting for close
187
- const closePromise = queue.waitClosed();
188
-
189
- // Close after delay
190
- setTimeout(() => {
191
- queue.close();
192
- }, 10);
193
-
194
- await closePromise; // Should resolve when queue is closed
195
- });
196
- });
197
-
198
- describe("dequeue behavior", () => {
199
- it("dequeue before enqueue test", async () => {
200
- const queue = new AsyncQueue<number>();
201
-
202
- // Start dequeue before enqueue
203
- const dequeuePromise = queue.dequeue();
204
-
205
- // Enqueue after a small delay
206
- setTimeout(() => {
207
- queue.enqueue(42);
208
- }, 10);
209
-
210
- const result = await dequeuePromise;
211
- expect(result.value).toBe(42);
212
- expect(result.done).toBe(false);
213
- });
214
-
215
- it("multiple dequeue calls test", async () => {
216
- const queue = new AsyncQueue<number>();
217
-
218
- // Start multiple dequeue calls
219
- const dequeuePromises = [
220
- queue.dequeue(),
221
- queue.dequeue(),
222
- queue.dequeue(),
223
- ];
224
-
225
- // Enqueue values
226
- queue.enqueue(1);
227
- queue.enqueue(2);
228
- queue.enqueue(3);
229
-
230
- const results = await Promise.all(dequeuePromises);
231
-
232
- expect(results[0]?.value).toBe(1);
233
- expect(results[0]?.done).toBe(false);
234
- expect(results[1]?.value).toBe(2);
235
- expect(results[1]?.done).toBe(false);
236
- expect(results[2]?.value).toBe(3);
237
- expect(results[2]?.done).toBe(false);
238
- });
239
-
240
- it("dequeue after close test", async () => {
241
- const queue = new AsyncQueue<number>();
242
-
243
- queue.enqueue(1);
244
- queue.close();
245
-
246
- const result1 = await queue.dequeue();
247
- expect(result1.value).toBe(1);
248
- expect(result1.done).toBe(false);
249
-
250
- const result2 = await queue.dequeue();
251
- expect(result2.done).toBe(true);
252
- expect(result2.value).toBeUndefined();
253
- });
254
-
255
- it("duplicate dequeue test", async () => {
256
- const queue = new AsyncQueue<string>();
257
-
258
- // Start dequeue operation that will wait for an item
259
- const pendingDequeue = queue.dequeue();
260
-
261
- // Add item after a small delay
262
- setTimeout(() => {
263
- queue.enqueue("delayed item");
264
- }, 10);
265
-
266
- const delayedResult = await pendingDequeue;
267
- expect(delayedResult.value).toBe("delayed item");
268
- expect(delayedResult.done).toBe(false);
269
-
270
- // Check for duplicate dequeue
271
- const duplicatedResult = await Promise.race([
272
- queue.dequeue(),
273
- new Promise(resolve => setTimeout(resolve, 0, false)),
274
- ]) as false | IteratorResult<string, undefined>;
275
-
276
- // If duplicatedResult is false, it means the race timed out (expected)
277
- // If it's an IteratorResult, it should not have the same value
278
- if (duplicatedResult !== false) {
279
- expect(duplicatedResult.value).not.toBe("delayed item");
280
- }
281
- });
282
- });
283
-
284
- describe("edge cases and error handling", () => {
285
- it("enqueue after close test", async () => {
286
- const queue = new AsyncQueue<number>();
287
-
288
- queue.close();
289
- queue.enqueue(1); // Should still work, but dequeue will return done: true
290
-
291
- const result = await queue.dequeue();
292
- expect(result.done).toBe(true);
293
- expect(result.value).toBeUndefined();
294
- });
295
-
296
- it("multiple close calls test", async () => {
297
- const queue = new AsyncQueue<number>();
298
-
299
- queue.close();
300
- queue.close(); // Second close should not cause issues
301
-
302
- const result = await queue.dequeue();
303
- expect(result.done).toBe(true);
304
- expect(result.value).toBeUndefined();
305
- });
306
-
307
- it("waitUntilEmpty with multiple calls test", async () => {
308
- const queue = new AsyncQueue<number>();
309
-
310
- queue.enqueue(1);
311
-
312
- // Create multiple waitUntilEmpty promises
313
- const waitPromises = [queue.waitUntilEmpty(), queue.waitUntilEmpty()];
314
-
315
- // Dequeue the value
316
- await queue.dequeue();
317
-
318
- // All promises should resolve
319
- await Promise.all(waitPromises);
320
- });
321
-
322
- it("concurrent enqueue and dequeue test", async () => {
323
- const queue = new AsyncQueue<number>();
324
- const results: number[] = [];
325
-
326
- // Start multiple dequeue operations
327
- const dequeuePromises = Array.from({ length: 5 }).fill(0).map(async () => queue.dequeue());
328
-
329
- // Enqueue values with small delays
330
- for (let i = 0; i < 5; i++) {
331
- setTimeout(() => {
332
- queue.enqueue(i);
333
- }, i * 10);
334
- }
335
-
336
- // Wait for all dequeue operations to complete
337
- const dequeuedResults = await Promise.all(dequeuePromises);
338
-
339
- // Collect values
340
- dequeuedResults.forEach((result) => {
341
- if (result.value !== undefined) {
342
- results.push(result.value);
343
- }
344
- });
345
-
346
- // Check that all values were dequeued
347
- expect(results.length).toBe(5);
348
- expect(results).toContain(0);
349
- expect(results).toContain(1);
350
- expect(results).toContain(2);
351
- expect(results).toContain(3);
352
- expect(results).toContain(4);
353
- });
354
- });
355
- });
1
+ import { AsyncQueue } from "./AsyncQueue";
2
+
3
+ describe("the AsyncQueue", () => {
4
+ describe("basic functionality", () => {
5
+ it("enqueue and dequeue test", async () => {
6
+ const queue = new AsyncQueue<number>();
7
+
8
+ // Enqueue items
9
+ queue.enqueue(1);
10
+ queue.enqueue(2);
11
+ queue.enqueue(3);
12
+
13
+ // Dequeue items
14
+ const result1 = await queue.dequeue();
15
+ const result2 = await queue.dequeue();
16
+ const result3 = await queue.dequeue();
17
+
18
+ expect(result1.value).toBe(1);
19
+ expect(result1.done).toBe(false);
20
+ expect(result2.value).toBe(2);
21
+ expect(result2.done).toBe(false);
22
+ expect(result3.value).toBe(3);
23
+ expect(result3.done).toBe(false);
24
+ });
25
+
26
+ it("isEmpty test", async () => {
27
+ const queue = new AsyncQueue<number>();
28
+
29
+ expect(queue.isEmpty()).toBe(true);
30
+
31
+ queue.enqueue(1);
32
+ expect(queue.isEmpty()).toBe(false);
33
+
34
+ await queue.dequeue();
35
+ expect(queue.isEmpty()).toBe(true);
36
+ });
37
+
38
+ it("isClosed test", () => {
39
+ const queue = new AsyncQueue<number>();
40
+
41
+ expect(queue.isClosed()).toBe(false);
42
+
43
+ queue.close();
44
+ expect(queue.isClosed()).toBe(true);
45
+ });
46
+
47
+ it("done test", async () => {
48
+ const queue = new AsyncQueue<number>();
49
+
50
+ expect(queue.done()).toBe(false);
51
+
52
+ queue.enqueue(1);
53
+ expect(queue.done()).toBe(false);
54
+
55
+ await queue.dequeue();
56
+ expect(queue.done()).toBe(false);
57
+
58
+ queue.close();
59
+ expect(queue.done()).toBe(true);
60
+ });
61
+ });
62
+
63
+ describe("close functionality", () => {
64
+ it("close test with empty queue", async () => {
65
+ const queue = new AsyncQueue<number>();
66
+
67
+ queue.close();
68
+
69
+ const result = await queue.dequeue();
70
+ expect(result.done).toBe(true);
71
+ expect(result.value).toBeUndefined();
72
+ });
73
+
74
+ it("close test with non-empty queue", async () => {
75
+ const queue = new AsyncQueue<number>();
76
+
77
+ queue.enqueue(1);
78
+ queue.enqueue(2);
79
+ queue.close();
80
+
81
+ const result1 = await queue.dequeue();
82
+ const result2 = await queue.dequeue();
83
+ const result3 = await queue.dequeue();
84
+
85
+ expect(result1.value).toBe(1);
86
+ expect(result1.done).toBe(false);
87
+ expect(result2.value).toBe(2);
88
+ expect(result2.done).toBe(false);
89
+ expect(result3.done).toBe(true);
90
+ expect(result3.value).toBeUndefined();
91
+ });
92
+
93
+ it("close test with waiting dequeue", async () => {
94
+ const queue = new AsyncQueue<number>();
95
+
96
+ // Start dequeue before enqueue
97
+ const dequeuePromise = queue.dequeue();
98
+
99
+ // Close the queue
100
+ queue.close();
101
+
102
+ const result = await dequeuePromise;
103
+ expect(result.done).toBe(true);
104
+ expect(result.value).toBeUndefined();
105
+ });
106
+ });
107
+
108
+ describe("waitUntilEmpty functionality", () => {
109
+ it("waitUntilEmpty test with empty queue", async () => {
110
+ const queue = new AsyncQueue<number>();
111
+
112
+ // Should resolve immediately since queue is empty
113
+ await queue.waitUntilEmpty();
114
+
115
+ queue.enqueue(1);
116
+ const result = await queue.dequeue();
117
+ expect(result.value).toBe(1);
118
+ expect(result.done).toBe(false);
119
+ });
120
+
121
+ it("waitUntilEmpty test with non-empty queue", async () => {
122
+ const queue = new AsyncQueue<number>();
123
+
124
+ queue.enqueue(1);
125
+ queue.enqueue(2);
126
+
127
+ // waitUntilEmpty should not resolve since queue is not empty
128
+ const waitPromise = queue.waitUntilEmpty();
129
+
130
+ // Dequeue first value
131
+ const result1 = await queue.dequeue();
132
+ expect(result1.value).toBe(1);
133
+
134
+ // Dequeue second value
135
+ const result2 = await queue.dequeue();
136
+ expect(result2.value).toBe(2);
137
+
138
+ // Now queue is empty, waitUntilEmpty should resolve\
139
+ await waitPromise;
140
+ });
141
+ });
142
+
143
+ describe("waitClosed functionality", () => {
144
+ it("waitClosed test with unclosed queue", async () => {
145
+ const queue = new AsyncQueue<number>();
146
+
147
+ // waitClosed should not resolve since queue is not closed
148
+ const waitPromise = queue.waitClosed();
149
+
150
+ queue.enqueue(1);
151
+ const result = await queue.dequeue();
152
+ expect(result.value).toBe(1);
153
+
154
+ // Close the queue
155
+ queue.close();
156
+
157
+ // Now queue is closed, waitClosed should resolve
158
+ await waitPromise;
159
+ });
160
+
161
+ it("waitClosed test with already closed queue", async () => {
162
+ const queue = new AsyncQueue<number>();
163
+
164
+ queue.close();
165
+
166
+ // waitClosed should resolve immediately since queue is already closed
167
+ await queue.waitClosed();
168
+ });
169
+
170
+ it("multiple waitClosed calls test", async () => {
171
+ const queue = new AsyncQueue<number>();
172
+
173
+ // Create multiple waitClosed promises
174
+ const waitPromises = [queue.waitClosed(), queue.waitClosed(), queue.waitClosed()];
175
+
176
+ // Close the queue
177
+ queue.close();
178
+
179
+ // All promises should resolve
180
+ await Promise.all(waitPromises);
181
+ });
182
+
183
+ it("waitClosed test with delayed close", async () => {
184
+ const queue = new AsyncQueue<string>();
185
+
186
+ // Start waiting for close
187
+ const closePromise = queue.waitClosed();
188
+
189
+ // Close after delay
190
+ setTimeout(() => {
191
+ queue.close();
192
+ }, 10);
193
+
194
+ await closePromise; // Should resolve when queue is closed
195
+ });
196
+ });
197
+
198
+ describe("dequeue behavior", () => {
199
+ it("dequeue before enqueue test", async () => {
200
+ const queue = new AsyncQueue<number>();
201
+
202
+ // Start dequeue before enqueue
203
+ const dequeuePromise = queue.dequeue();
204
+
205
+ // Enqueue after a small delay
206
+ setTimeout(() => {
207
+ queue.enqueue(42);
208
+ }, 10);
209
+
210
+ const result = await dequeuePromise;
211
+ expect(result.value).toBe(42);
212
+ expect(result.done).toBe(false);
213
+ });
214
+
215
+ it("multiple dequeue calls test", async () => {
216
+ const queue = new AsyncQueue<number>();
217
+
218
+ // Start multiple dequeue calls
219
+ const dequeuePromises = [
220
+ queue.dequeue(),
221
+ queue.dequeue(),
222
+ queue.dequeue(),
223
+ ];
224
+
225
+ // Enqueue values
226
+ queue.enqueue(1);
227
+ queue.enqueue(2);
228
+ queue.enqueue(3);
229
+
230
+ const results = await Promise.all(dequeuePromises);
231
+
232
+ expect(results[0]?.value).toBe(1);
233
+ expect(results[0]?.done).toBe(false);
234
+ expect(results[1]?.value).toBe(2);
235
+ expect(results[1]?.done).toBe(false);
236
+ expect(results[2]?.value).toBe(3);
237
+ expect(results[2]?.done).toBe(false);
238
+ });
239
+
240
+ it("dequeue after close test", async () => {
241
+ const queue = new AsyncQueue<number>();
242
+
243
+ queue.enqueue(1);
244
+ queue.close();
245
+
246
+ const result1 = await queue.dequeue();
247
+ expect(result1.value).toBe(1);
248
+ expect(result1.done).toBe(false);
249
+
250
+ const result2 = await queue.dequeue();
251
+ expect(result2.done).toBe(true);
252
+ expect(result2.value).toBeUndefined();
253
+ });
254
+
255
+ it("duplicate dequeue test", async () => {
256
+ const queue = new AsyncQueue<string>();
257
+
258
+ // Start dequeue operation that will wait for an item
259
+ const pendingDequeue = queue.dequeue();
260
+
261
+ // Add item after a small delay
262
+ setTimeout(() => {
263
+ queue.enqueue("delayed item");
264
+ }, 10);
265
+
266
+ const delayedResult = await pendingDequeue;
267
+ expect(delayedResult.value).toBe("delayed item");
268
+ expect(delayedResult.done).toBe(false);
269
+
270
+ // Check for duplicate dequeue
271
+ const duplicatedResult = await Promise.race([
272
+ queue.dequeue(),
273
+ new Promise(resolve => setTimeout(resolve, 0, false)),
274
+ ]) as false | IteratorResult<string, undefined>;
275
+
276
+ // If duplicatedResult is false, it means the race timed out (expected)
277
+ // If it's an IteratorResult, it should not have the same value
278
+ if (duplicatedResult !== false) {
279
+ expect(duplicatedResult.value).not.toBe("delayed item");
280
+ }
281
+ });
282
+ });
283
+
284
+ describe("edge cases and error handling", () => {
285
+ it("enqueue after close test", async () => {
286
+ const queue = new AsyncQueue<number>();
287
+
288
+ queue.close();
289
+ queue.enqueue(1); // Should still work, but dequeue will return done: true
290
+
291
+ const result = await queue.dequeue();
292
+ expect(result.done).toBe(true);
293
+ expect(result.value).toBeUndefined();
294
+ });
295
+
296
+ it("multiple close calls test", async () => {
297
+ const queue = new AsyncQueue<number>();
298
+
299
+ queue.close();
300
+ queue.close(); // Second close should not cause issues
301
+
302
+ const result = await queue.dequeue();
303
+ expect(result.done).toBe(true);
304
+ expect(result.value).toBeUndefined();
305
+ });
306
+
307
+ it("waitUntilEmpty with multiple calls test", async () => {
308
+ const queue = new AsyncQueue<number>();
309
+
310
+ queue.enqueue(1);
311
+
312
+ // Create multiple waitUntilEmpty promises
313
+ const waitPromises = [queue.waitUntilEmpty(), queue.waitUntilEmpty()];
314
+
315
+ // Dequeue the value
316
+ await queue.dequeue();
317
+
318
+ // All promises should resolve
319
+ await Promise.all(waitPromises);
320
+ });
321
+
322
+ it("concurrent enqueue and dequeue test", async () => {
323
+ const queue = new AsyncQueue<number>();
324
+ const results: number[] = [];
325
+
326
+ // Start multiple dequeue operations
327
+ const dequeuePromises = Array.from({ length: 5 }).fill(0).map(async () => queue.dequeue());
328
+
329
+ // Enqueue values with small delays
330
+ for (let i = 0; i < 5; i++) {
331
+ setTimeout(() => {
332
+ queue.enqueue(i);
333
+ }, i * 10);
334
+ }
335
+
336
+ // Wait for all dequeue operations to complete
337
+ const dequeuedResults = await Promise.all(dequeuePromises);
338
+
339
+ // Collect values
340
+ dequeuedResults.forEach((result) => {
341
+ if (result.value !== undefined) {
342
+ results.push(result.value);
343
+ }
344
+ });
345
+
346
+ // Check that all values were dequeued
347
+ expect(results.length).toBe(5);
348
+ expect(results).toContain(0);
349
+ expect(results).toContain(1);
350
+ expect(results).toContain(2);
351
+ expect(results).toContain(3);
352
+ expect(results).toContain(4);
353
+ });
354
+ });
355
+ });