@cratis/chronicle 6.62.0 → 6.63.0

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 (84) hide show
  1. package/ChronicleClient.ts +86 -3
  2. package/connection/ConnectionLifecycle.ts +42 -1
  3. package/dist/ChronicleClient.d.ts +28 -1
  4. package/dist/ChronicleClient.d.ts.map +1 -1
  5. package/dist/ChronicleClient.js +71 -3
  6. package/dist/ChronicleClient.js.map +1 -1
  7. package/dist/connection/ConnectionLifecycle.d.ts +24 -0
  8. package/dist/connection/ConnectionLifecycle.d.ts.map +1 -1
  9. package/dist/connection/ConnectionLifecycle.js +40 -1
  10. package/dist/connection/ConnectionLifecycle.js.map +1 -1
  11. package/dist/observation/ObservationReconnectBackoff.d.ts +64 -0
  12. package/dist/observation/ObservationReconnectBackoff.d.ts.map +1 -0
  13. package/dist/observation/ObservationReconnectBackoff.js +75 -0
  14. package/dist/observation/ObservationReconnectBackoff.js.map +1 -0
  15. package/dist/observation/ObservationStreamOutcome.d.ts +10 -0
  16. package/dist/observation/ObservationStreamOutcome.d.ts.map +1 -0
  17. package/dist/observation/ObservationStreamOutcome.js +4 -0
  18. package/dist/observation/ObservationStreamOutcome.js.map +1 -0
  19. package/dist/observation/classifyStreamError.d.ts +25 -0
  20. package/dist/observation/classifyStreamError.d.ts.map +1 -0
  21. package/dist/observation/classifyStreamError.js +55 -0
  22. package/dist/observation/classifyStreamError.js.map +1 -0
  23. package/dist/observation/for_ObservationReconnectBackoff/given/a_backoff.d.ts +13 -0
  24. package/dist/observation/for_ObservationReconnectBackoff/given/a_backoff.d.ts.map +1 -0
  25. package/dist/observation/for_ObservationReconnectBackoff/given/a_backoff.js +25 -0
  26. package/dist/observation/for_ObservationReconnectBackoff/given/a_backoff.js.map +1 -0
  27. package/dist/observation/for_ObservationReconnectBackoff/given/a_scripted_stream.d.ts +27 -0
  28. package/dist/observation/for_ObservationReconnectBackoff/given/a_scripted_stream.d.ts.map +1 -0
  29. package/dist/observation/for_ObservationReconnectBackoff/given/a_scripted_stream.js +36 -0
  30. package/dist/observation/for_ObservationReconnectBackoff/given/a_scripted_stream.js.map +1 -0
  31. package/dist/reactors/Reactors.d.ts +15 -5
  32. package/dist/reactors/Reactors.d.ts.map +1 -1
  33. package/dist/reactors/Reactors.js +95 -18
  34. package/dist/reactors/Reactors.js.map +1 -1
  35. package/dist/reactors/for_Reactors/when_reconnecting_the_observation_stream/given/a_reactor_whose_stream_ends.d.ts +26 -0
  36. package/dist/reactors/for_Reactors/when_reconnecting_the_observation_stream/given/a_reactor_whose_stream_ends.d.ts.map +1 -0
  37. package/dist/reactors/for_Reactors/when_reconnecting_the_observation_stream/given/a_reactor_whose_stream_ends.js +64 -0
  38. package/dist/reactors/for_Reactors/when_reconnecting_the_observation_stream/given/a_reactor_whose_stream_ends.js.map +1 -0
  39. package/dist/reducers/Reducers.d.ts +11 -5
  40. package/dist/reducers/Reducers.d.ts.map +1 -1
  41. package/dist/reducers/Reducers.js +93 -19
  42. package/dist/reducers/Reducers.js.map +1 -1
  43. package/dist/reducers/for_Reducers/when_reconnecting_the_observation_stream/given/a_reducer_whose_stream_ends.d.ts +25 -0
  44. package/dist/reducers/for_Reducers/when_reconnecting_the_observation_stream/given/a_reducer_whose_stream_ends.d.ts.map +1 -0
  45. package/dist/reducers/for_Reducers/when_reconnecting_the_observation_stream/given/a_reducer_whose_stream_ends.js +70 -0
  46. package/dist/reducers/for_Reducers/when_reconnecting_the_observation_stream/given/a_reducer_whose_stream_ends.js.map +1 -0
  47. package/dist/tsconfig.tsbuildinfo +1 -1
  48. package/for_ChronicleClient/when_reconnecting/and_an_observation_stream_lost_its_session.spec.ts +212 -0
  49. package/observation/ObservationReconnectBackoff.ts +109 -0
  50. package/observation/ObservationStreamOutcome.ts +12 -0
  51. package/observation/classifyStreamError.ts +67 -0
  52. package/observation/for_ObservationReconnectBackoff/given/a_backoff.ts +29 -0
  53. package/observation/for_ObservationReconnectBackoff/given/a_scripted_stream.ts +52 -0
  54. package/observation/for_ObservationReconnectBackoff/when_a_stream_delivered_before_it_ended.spec.ts +23 -0
  55. package/observation/for_ObservationReconnectBackoff/when_a_stream_stayed_open_before_it_ended.spec.ts +25 -0
  56. package/observation/for_ObservationReconnectBackoff/when_jittering_the_delay.spec.ts +24 -0
  57. package/observation/for_ObservationReconnectBackoff/when_streams_keep_ending_without_working.spec.ts +24 -0
  58. package/observation/for_ObservationReconnectBackoff/when_the_base_delay_is_not_positive.spec.ts +18 -0
  59. package/observation/for_ObservationReconnectBackoff/when_the_settings_are_not_finite.spec.ts +32 -0
  60. package/observation/for_ObservationReconnectBackoff/when_using_the_defaults.spec.ts +29 -0
  61. package/observation/for_classifyStreamError/when_classifying_a_stream_error.spec.ts +36 -0
  62. package/package.json +1 -1
  63. package/reactors/Reactors.ts +101 -18
  64. package/reactors/for_Reactors/when_reconnecting_the_observation_stream/and_a_handler_failed_with_a_lost_session.spec.ts +32 -0
  65. package/reactors/for_Reactors/when_reconnecting_the_observation_stream/and_a_replaced_stream_fails_late.spec.ts +28 -0
  66. package/reactors/for_Reactors/when_reconnecting_the_observation_stream/and_a_stream_delivered_before_it_ended.spec.ts +24 -0
  67. package/reactors/for_Reactors/when_reconnecting_the_observation_stream/and_a_stream_stayed_open_before_it_ended.spec.ts +23 -0
  68. package/reactors/for_Reactors/when_reconnecting_the_observation_stream/and_it_is_disposed_while_waiting_to_reopen.spec.ts +27 -0
  69. package/reactors/for_Reactors/when_reconnecting_the_observation_stream/and_streams_keep_ending_without_working.spec.ts +24 -0
  70. package/reactors/for_Reactors/when_reconnecting_the_observation_stream/and_the_client_reconnected_after_streams_kept_ending.spec.ts +24 -0
  71. package/reactors/for_Reactors/when_reconnecting_the_observation_stream/and_the_client_reconnected_while_waiting_to_reopen.spec.ts +25 -0
  72. package/reactors/for_Reactors/when_reconnecting_the_observation_stream/and_the_kernel_lost_the_session.spec.ts +24 -0
  73. package/reactors/for_Reactors/when_reconnecting_the_observation_stream/given/a_reactor_whose_stream_ends.ts +69 -0
  74. package/reducers/Reducers.ts +99 -19
  75. package/reducers/for_Reducers/when_reconnecting_the_observation_stream/and_a_reducer_failed_with_a_lost_session.spec.ts +33 -0
  76. package/reducers/for_Reducers/when_reconnecting_the_observation_stream/and_a_replaced_stream_fails_late.spec.ts +28 -0
  77. package/reducers/for_Reducers/when_reconnecting_the_observation_stream/and_a_stream_delivered_before_it_ended.spec.ts +24 -0
  78. package/reducers/for_Reducers/when_reconnecting_the_observation_stream/and_a_stream_stayed_open_before_it_ended.spec.ts +23 -0
  79. package/reducers/for_Reducers/when_reconnecting_the_observation_stream/and_it_is_disposed_while_waiting_to_reopen.spec.ts +27 -0
  80. package/reducers/for_Reducers/when_reconnecting_the_observation_stream/and_streams_keep_ending_without_working.spec.ts +24 -0
  81. package/reducers/for_Reducers/when_reconnecting_the_observation_stream/and_the_client_reconnected_after_streams_kept_ending.spec.ts +24 -0
  82. package/reducers/for_Reducers/when_reconnecting_the_observation_stream/and_the_client_reconnected_while_waiting_to_reopen.spec.ts +25 -0
  83. package/reducers/for_Reducers/when_reconnecting_the_observation_stream/and_the_kernel_lost_the_session.spec.ts +24 -0
  84. package/reducers/for_Reducers/when_reconnecting_the_observation_stream/given/a_reducer_whose_stream_ends.ts +69 -0
@@ -0,0 +1,24 @@
1
+ // Copyright (c) Cratis. All rights reserved.
2
+ // Licensed under the MIT license. See LICENSE file in the project root for full license information.
3
+
4
+ import { afterEach, beforeEach, chai, describe, it, vi } from 'vitest';
5
+ import { ClientError, Status } from 'nice-grpc';
6
+ import { a_reducer_whose_stream_ends } from './given/a_reducer_whose_stream_ends.js';
7
+
8
+ chai.should();
9
+
10
+ describe('when reconnecting a reducer observation stream and streams keep ending without working', () => {
11
+ let context: a_reducer_whose_stream_ends;
12
+
13
+ beforeEach(async () => {
14
+ context = new a_reducer_whose_stream_ends();
15
+ context.scripts.push({}, { error: new ClientError('/Reducers/Observe', Status.UNAVAILABLE, 'kernel stopping') });
16
+ await context.reducers.register();
17
+ await vi.advanceTimersByTimeAsync(60_000);
18
+ });
19
+
20
+ afterEach(() => context.dispose());
21
+
22
+ it('should double the wait each time a stream ends', () => context.waits.slice(0, 5).should.deep.equal([1_000, 2_000, 4_000, 8_000, 16_000]));
23
+ it('should not reconnect the client', () => context.reconnectRequests.should.be.empty);
24
+ });
@@ -0,0 +1,24 @@
1
+ // Copyright (c) Cratis. All rights reserved.
2
+ // Licensed under the MIT license. See LICENSE file in the project root for full license information.
3
+
4
+ import { afterEach, beforeEach, chai, describe, it, vi } from 'vitest';
5
+ import { a_reducer_whose_stream_ends } from './given/a_reducer_whose_stream_ends.js';
6
+
7
+ chai.should();
8
+
9
+ describe('when reconnecting a reducer observation stream and the client reconnected after streams kept ending', () => {
10
+ let context: a_reducer_whose_stream_ends;
11
+
12
+ beforeEach(async () => {
13
+ context = new a_reducer_whose_stream_ends();
14
+ context.scripts.push({}, {}, {}, { untilAborted: true });
15
+ await context.reducers.register();
16
+ await vi.advanceTimersByTimeAsync(1_000);
17
+ await context.reconnect();
18
+ await vi.advanceTimersByTimeAsync(4_000);
19
+ });
20
+
21
+ afterEach(() => context.dispose());
22
+
23
+ it('should keep the wait it had grown to', () => context.waits.should.deep.equal([1_000, 0, 4_000]));
24
+ });
@@ -0,0 +1,25 @@
1
+ // Copyright (c) Cratis. All rights reserved.
2
+ // Licensed under the MIT license. See LICENSE file in the project root for full license information.
3
+
4
+ import { afterEach, beforeEach, chai, describe, it, vi } from 'vitest';
5
+ import { a_reducer_whose_stream_ends } from './given/a_reducer_whose_stream_ends.js';
6
+
7
+ chai.should();
8
+
9
+ describe('when reconnecting a reducer observation stream and the client reconnected while it waited to reopen', () => {
10
+ let context: a_reducer_whose_stream_ends;
11
+
12
+ beforeEach(async () => {
13
+ context = new a_reducer_whose_stream_ends();
14
+ context.scripts.push({}, { untilAborted: true });
15
+ await context.reducers.register();
16
+ await vi.advanceTimersByTimeAsync(0);
17
+ await context.reconnect();
18
+ await vi.advanceTimersByTimeAsync(120_000);
19
+ });
20
+
21
+ afterEach(() => context.dispose());
22
+
23
+ it('should only open the stream the reconnect registered', () => context.openedAt.should.have.lengthOf(2));
24
+ it('should leave exactly one stream open', () => context.stream.open.should.equal(1));
25
+ });
@@ -0,0 +1,24 @@
1
+ // Copyright (c) Cratis. All rights reserved.
2
+ // Licensed under the MIT license. See LICENSE file in the project root for full license information.
3
+
4
+ import { afterEach, beforeEach, chai, describe, it, vi } from 'vitest';
5
+ import { ClientError, Status } from 'nice-grpc';
6
+ import { a_reducer_whose_stream_ends } from './given/a_reducer_whose_stream_ends.js';
7
+
8
+ chai.should();
9
+
10
+ describe('when reconnecting a reducer observation stream and the kernel lost the session', () => {
11
+ let context: a_reducer_whose_stream_ends;
12
+
13
+ beforeEach(async () => {
14
+ context = new a_reducer_whose_stream_ends();
15
+ context.scripts.push({ error: new ClientError('/Reducers/Observe', Status.UNKNOWN, 'ClientIsNotConnected: connection is not connected') });
16
+ await context.reducers.register();
17
+ await vi.advanceTimersByTimeAsync(120_000);
18
+ });
19
+
20
+ afterEach(() => context.dispose());
21
+
22
+ it('should ask the whole client to reconnect', () => context.reconnectRequests.should.deep.equal(['reducer-session-lost']));
23
+ it('should not open the stream again with the same connection', () => context.openedAt.should.have.lengthOf(1));
24
+ });
@@ -0,0 +1,69 @@
1
+ // Copyright (c) Cratis. All rights reserved.
2
+ // Licensed under the MIT license. See LICENSE file in the project root for full license information.
3
+
4
+ import { vi } from 'vitest';
5
+ import type { ReduceOperationMessage } from '@cratis/chronicle.contracts';
6
+ import { Reducers } from '../../../Reducers.js';
7
+ import { reducer } from '../../../reducer.js';
8
+ import { eventType } from '../../../../events/eventTypeDecorator.js';
9
+ import { ConnectionLifecycle } from '../../../../connection/ConnectionLifecycle.js';
10
+ import type { ChronicleConnection } from '../../../../connection/ChronicleConnection.js';
11
+ import type { IClientArtifactsProvider } from '../../../../artifacts/IClientArtifactsProvider.js';
12
+ import { a_scripted_stream, type StreamScript } from '../../../../observation/for_ObservationReconnectBackoff/given/a_scripted_stream.js';
13
+
14
+ @eventType('reconnecting-reducer-item')
15
+ class Item {}
16
+ class Model {}
17
+
18
+ @reducer('reconnecting-reducer', undefined, Model)
19
+ class Observer { item() { return new Model(); } }
20
+
21
+ /**
22
+ * A reducer whose observation streams follow a script, on fake timers and a jitter of zero, so every wait is
23
+ * exactly half of its ceiling.
24
+ */
25
+ export class a_reducer_whose_stream_ends {
26
+ readonly lifecycle = new ConnectionLifecycle();
27
+ readonly reconnectRequests: string[] = [];
28
+ readonly stream = new a_scripted_stream<ReduceOperationMessage>();
29
+ readonly reducers: Reducers;
30
+
31
+ constructor() {
32
+ vi.useFakeTimers();
33
+ this.lifecycle.onReconnectRequested(reason => this.reconnectRequests.push(reason));
34
+ const artifacts = { eventTypes: [Item], reducers: [Observer], reactors: [], readModels: [Model], seeders: [], constraints: [],
35
+ projections: [], webhooks: [], eventTypeMigrations: [], globalForHandlers: [] } as IClientArtifactsProvider;
36
+ const connection = {
37
+ reducers: { observe: this.stream.observe },
38
+ readModels: { registerMany: vi.fn().mockResolvedValue({}) }
39
+ } as unknown as ChronicleConnection;
40
+ this.reducers = new Reducers(artifacts, connection, 'store', 'Default', this.lifecycle, 'sink',
41
+ undefined, undefined, undefined, false, { now: () => Date.now(), nextJitter: () => 0 });
42
+ }
43
+
44
+ /** Gets the scripts the next streams follow. */
45
+ get scripts(): StreamScript<ReduceOperationMessage>[] {
46
+ return this.stream.scripts;
47
+ }
48
+
49
+ /** Gets when each stream was opened. */
50
+ get openedAt(): number[] {
51
+ return this.stream.openedAt;
52
+ }
53
+
54
+ /** Gets the wait before each stream after the first was opened. */
55
+ get waits(): number[] {
56
+ return this.stream.waits;
57
+ }
58
+
59
+ /** Drops the session and registers again, as a client reconnect does. */
60
+ async reconnect(): Promise<void> {
61
+ await this.lifecycle.disconnected(() => undefined);
62
+ await this.reducers.register();
63
+ }
64
+
65
+ dispose(): void {
66
+ this.reducers.dispose();
67
+ vi.useRealTimers();
68
+ }
69
+ }