@cratis/chronicle 6.53.1 → 6.55.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.
- package/ChronicleClient.ts +16 -3
- package/ChronicleOptions.ts +11 -0
- package/EventStore.ts +8 -3
- package/README.md +1 -1
- package/artifacts/refuseClientHostedObservers.ts +16 -0
- package/connection/ChronicleConnection.ts +58 -9
- package/connection/ChronicleConnectionString.ts +26 -1
- package/connection/ClientObserversRequireKeepAlive.ts +10 -0
- package/connection/for_ChronicleConnection/when_deferring_client_creation/and_connecting.spec.ts +83 -0
- package/connection/for_ChronicleConnection/when_warning_about_tls_validation/tls_validation_warning.spec.ts +80 -0
- package/dist/ChronicleClient.d.ts +1 -0
- package/dist/ChronicleClient.d.ts.map +1 -1
- package/dist/ChronicleClient.js +16 -3
- package/dist/ChronicleClient.js.map +1 -1
- package/dist/ChronicleOptions.d.ts +4 -0
- package/dist/ChronicleOptions.d.ts.map +1 -1
- package/dist/ChronicleOptions.js +7 -0
- package/dist/ChronicleOptions.js.map +1 -1
- package/dist/EventStore.d.ts +2 -1
- package/dist/EventStore.d.ts.map +1 -1
- package/dist/EventStore.js +10 -3
- package/dist/EventStore.js.map +1 -1
- package/dist/artifacts/refuseClientHostedObservers.d.ts +4 -0
- package/dist/artifacts/refuseClientHostedObservers.d.ts.map +1 -0
- package/dist/artifacts/refuseClientHostedObservers.js +15 -0
- package/dist/artifacts/refuseClientHostedObservers.js.map +1 -0
- package/dist/connection/ChronicleConnection.d.ts +9 -1
- package/dist/connection/ChronicleConnection.d.ts.map +1 -1
- package/dist/connection/ChronicleConnection.js +46 -8
- package/dist/connection/ChronicleConnection.js.map +1 -1
- package/dist/connection/ChronicleConnectionString.d.ts +8 -0
- package/dist/connection/ChronicleConnectionString.d.ts.map +1 -1
- package/dist/connection/ChronicleConnectionString.js +21 -1
- package/dist/connection/ChronicleConnectionString.js.map +1 -1
- package/dist/connection/ClientObserversRequireKeepAlive.d.ts +7 -0
- package/dist/connection/ClientObserversRequireKeepAlive.d.ts.map +1 -0
- package/dist/connection/ClientObserversRequireKeepAlive.js +14 -0
- package/dist/connection/ClientObserversRequireKeepAlive.js.map +1 -0
- package/dist/eventSequences/ITransactionalEventSequence.d.ts +6 -0
- package/dist/eventSequences/ITransactionalEventSequence.d.ts.map +1 -1
- package/dist/eventSequences/TransactionalEventSequence.d.ts.map +1 -1
- package/dist/eventSequences/TransactionalEventSequence.js +3 -1
- package/dist/eventSequences/TransactionalEventSequence.js.map +1 -1
- package/dist/for_ChronicleClient/when_skipping_keep_alive/native-exit-probe.d.ts +2 -0
- package/dist/for_ChronicleClient/when_skipping_keep_alive/native-exit-probe.d.ts.map +1 -0
- package/dist/for_ChronicleClient/when_skipping_keep_alive/native-exit-probe.js +107 -0
- package/dist/for_ChronicleClient/when_skipping_keep_alive/native-exit-probe.js.map +1 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -0
- package/dist/index.js.map +1 -1
- package/dist/reactors/Reactors.d.ts +2 -1
- package/dist/reactors/Reactors.d.ts.map +1 -1
- package/dist/reactors/Reactors.js +6 -1
- package/dist/reactors/Reactors.js.map +1 -1
- package/dist/reducers/Reducers.d.ts +2 -1
- package/dist/reducers/Reducers.d.ts.map +1 -1
- package/dist/reducers/Reducers.js +6 -1
- package/dist/reducers/Reducers.js.map +1 -1
- package/dist/transactions/AppendOptionNotSupportedInUnitOfWork.d.ts +13 -0
- package/dist/transactions/AppendOptionNotSupportedInUnitOfWork.d.ts.map +1 -0
- package/dist/transactions/AppendOptionNotSupportedInUnitOfWork.js +19 -0
- package/dist/transactions/AppendOptionNotSupportedInUnitOfWork.js.map +1 -0
- package/dist/transactions/ConflictingAppendOptionNamesInUnitOfWork.d.ts +14 -0
- package/dist/transactions/ConflictingAppendOptionNamesInUnitOfWork.d.ts.map +1 -0
- package/dist/transactions/ConflictingAppendOptionNamesInUnitOfWork.js +21 -0
- package/dist/transactions/ConflictingAppendOptionNamesInUnitOfWork.js.map +1 -0
- package/dist/transactions/IUnitOfWork.d.ts +3 -0
- package/dist/transactions/IUnitOfWork.d.ts.map +1 -1
- package/dist/transactions/TransactionalAppendOptions.d.ts +8 -0
- package/dist/transactions/TransactionalAppendOptions.d.ts.map +1 -1
- package/dist/transactions/UnitOfWork.d.ts.map +1 -1
- package/dist/transactions/UnitOfWork.js +4 -2
- package/dist/transactions/UnitOfWork.js.map +1 -1
- package/dist/transactions/concurrencyScopesAreEqual.d.ts.map +1 -1
- package/dist/transactions/concurrencyScopesAreEqual.js +4 -3
- package/dist/transactions/concurrencyScopesAreEqual.js.map +1 -1
- package/dist/transactions/index.d.ts +2 -0
- package/dist/transactions/index.d.ts.map +1 -1
- package/dist/transactions/index.js +2 -0
- package/dist/transactions/index.js.map +1 -1
- package/dist/transactions/resolveTransactionalAppendOptions.d.ts +8 -0
- package/dist/transactions/resolveTransactionalAppendOptions.d.ts.map +1 -0
- package/dist/transactions/resolveTransactionalAppendOptions.js +58 -0
- package/dist/transactions/resolveTransactionalAppendOptions.js.map +1 -0
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/eventSequences/ITransactionalEventSequence.ts +6 -0
- package/eventSequences/TransactionalEventSequence.ts +3 -1
- package/eventSequences/for_TransactionalEventSequence/when_appending_many_with_append_option_names.spec.ts +26 -0
- package/eventSequences/for_TransactionalEventSequence/when_appending_many_with_unsupported_options.spec.ts +35 -0
- package/for_ChronicleClient/against_a_kernel/when_skipping_keep_alive.integration.spec.ts +80 -0
- package/for_ChronicleClient/when_skipping_keep_alive/and_connecting.spec.ts +158 -0
- package/for_ChronicleClient/when_skipping_keep_alive/native-exit-probe.ts +84 -0
- package/for_ChronicleOptions/when_configuring_keep_alive/with_skip_keep_alive.spec.ts +35 -0
- package/for_EventStore/when_skipping_keep_alive/when_registering_artifacts.spec.ts +51 -0
- package/index.ts +1 -0
- package/package.json +1 -1
- package/reactors/Reactors.ts +4 -1
- package/reactors/for_Reactors/when_skipping_keep_alive/with_a_reactor.spec.ts +48 -0
- package/reducers/Reducers.ts +4 -1
- package/reducers/for_Reducers/when_skipping_keep_alive/with_a_reducer.spec.ts +53 -0
- package/transactions/AppendOptionNotSupportedInUnitOfWork.ts +17 -0
- package/transactions/ConflictingAppendOptionNamesInUnitOfWork.ts +17 -0
- package/transactions/IUnitOfWork.ts +3 -0
- package/transactions/TransactionalAppendOptions.ts +11 -0
- package/transactions/UnitOfWork.ts +4 -2
- package/transactions/concurrencyScopesAreEqual.ts +4 -3
- package/transactions/for_UnitOfWork/when_adding_events_with_append_option_names/and_both_names_have_different_values.spec.ts +65 -0
- package/transactions/for_UnitOfWork/when_adding_events_with_append_option_names/and_both_names_have_the_same_value.spec.ts +22 -0
- package/transactions/for_UnitOfWork/when_adding_events_with_append_option_names/and_the_append_option_names_are_used.spec.ts +25 -0
- package/transactions/for_UnitOfWork/when_adding_events_with_concurrency_scopes/and_a_routing_field_is_empty_versus_named.spec.ts +40 -0
- package/transactions/for_UnitOfWork/when_adding_events_with_concurrency_scopes/and_routing_fields_are_undefined_or_empty.spec.ts +39 -0
- package/transactions/for_UnitOfWork/when_adding_events_with_unsupported_append_options/and_a_correlation_id_is_given.spec.ts +38 -0
- package/transactions/for_UnitOfWork/when_adding_events_with_unsupported_append_options/and_an_event_source_id_is_given.spec.ts +38 -0
- package/transactions/for_UnitOfWork/when_adding_events_with_unsupported_append_options/and_concurrency_scopes_are_given.spec.ts +38 -0
- package/transactions/for_UnitOfWork/when_adding_events_with_unsupported_append_options/and_the_option_is_undefined.spec.ts +24 -0
- package/transactions/index.ts +2 -0
- package/transactions/resolveTransactionalAppendOptions.ts +68 -0
|
@@ -0,0 +1,84 @@
|
|
|
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
|
+
// This file is emitted by the ordinary build and run by plain Node, never by a TS loader.
|
|
5
|
+
import assert from 'node:assert/strict';
|
|
6
|
+
import { randomUUID } from 'node:crypto';
|
|
7
|
+
import { mock } from 'node:test';
|
|
8
|
+
import { field } from '@cratis/fundamentals';
|
|
9
|
+
import { ChronicleClient, ChronicleOptions, ClientObserversRequireKeepAlive, eventType, reactor, reducer,
|
|
10
|
+
type IClientArtifactsProvider } from '../../index.js';
|
|
11
|
+
import { ChronicleConnection } from '../../connection/ChronicleConnection.js';
|
|
12
|
+
|
|
13
|
+
@eventType('skip-keep-alive-exit-item')
|
|
14
|
+
class ExitItem {
|
|
15
|
+
@field(String) value = 'probe';
|
|
16
|
+
}
|
|
17
|
+
@reactor('exit-reactor')
|
|
18
|
+
class ExitReactor {}
|
|
19
|
+
@reducer('exit-reducer')
|
|
20
|
+
class ExitReducer {}
|
|
21
|
+
|
|
22
|
+
const connectionString = process.env.CHRONICLE_INTEGRATION_CONNECTION_STRING;
|
|
23
|
+
if (!connectionString) throw new Error('CHRONICLE_INTEGRATION_CONNECTION_STRING is required');
|
|
24
|
+
const mode = process.argv[2];
|
|
25
|
+
const skipKeepAlive = !mode.startsWith('default');
|
|
26
|
+
const intervals = mock.method(globalThis, 'setInterval');
|
|
27
|
+
const streamSpies: ReturnType<typeof spyOnConnectStream>[] = [];
|
|
28
|
+
function spyOnConnectStream(connection: ChronicleConnection) {
|
|
29
|
+
// The spy delegates to the real RPC; it never substitutes a stream or owns the channel.
|
|
30
|
+
return mock.method(connection.connections, 'connect');
|
|
31
|
+
}
|
|
32
|
+
const connect = ChronicleConnection.prototype.connect;
|
|
33
|
+
mock.method(ChronicleConnection.prototype, 'connect', async function (this: ChronicleConnection) {
|
|
34
|
+
await connect.call(this);
|
|
35
|
+
streamSpies.push(spyOnConnectStream(this));
|
|
36
|
+
});
|
|
37
|
+
function connectionCounts() {
|
|
38
|
+
const connectCalls = streamSpies.reduce((total, spy) => total + spy.mock.callCount(), 0);
|
|
39
|
+
const watchdogTimers = intervals.mock.calls.filter(call => call.arguments[1] === 5000).length;
|
|
40
|
+
assert.equal(connectCalls > 0, !skipKeepAlive);
|
|
41
|
+
assert.equal(watchdogTimers > 0, !skipKeepAlive);
|
|
42
|
+
return { connectCalls, watchdogTimers };
|
|
43
|
+
}
|
|
44
|
+
const artifacts: IClientArtifactsProvider = {
|
|
45
|
+
eventTypes: [ExitItem], reactors: mode === 'reactor' ? [ExitReactor] : [], reducers: mode === 'reducer' ? [ExitReducer] : [],
|
|
46
|
+
readModels: [], seeders: [], constraints: [], projections: [], webhooks: [], eventTypeMigrations: [], globalForHandlers: []
|
|
47
|
+
};
|
|
48
|
+
const client = new ChronicleClient(ChronicleOptions.fromConnectionString(connectionString, {
|
|
49
|
+
skipKeepAlive, discoveryPatterns: [], clientArtifactsProvider: artifacts
|
|
50
|
+
}));
|
|
51
|
+
if (mode === 'preconnect-dispose') {
|
|
52
|
+
client.dispose();
|
|
53
|
+
client.dispose();
|
|
54
|
+
assert.equal(streamSpies.length, 0);
|
|
55
|
+
console.log(JSON.stringify({ marker: 'disposed-before-connect', mode, ...connectionCounts() }));
|
|
56
|
+
} else if (mode === 'reactor' || mode === 'reducer') {
|
|
57
|
+
try {
|
|
58
|
+
await client.getEventStore('skip-exit-refusal');
|
|
59
|
+
throw new Error('Observer was not refused');
|
|
60
|
+
} catch (error) {
|
|
61
|
+
if (!(error instanceof ClientObserversRequireKeepAlive)) throw error;
|
|
62
|
+
assert.equal(streamSpies.length, 0);
|
|
63
|
+
console.log(JSON.stringify({ marker: 'observer-refused', mode, kind: error.observerKind, id: error.observerId,
|
|
64
|
+
...connectionCounts() }));
|
|
65
|
+
}
|
|
66
|
+
} else {
|
|
67
|
+
const store = await client.getEventStore(`skip-exit-${randomUUID()}`);
|
|
68
|
+
const source = randomUUID();
|
|
69
|
+
const item = new ExitItem();
|
|
70
|
+
item.value = randomUUID();
|
|
71
|
+
await store.eventLog.append(source, item);
|
|
72
|
+
const events = await store.eventLog.getForEventSourceIdAndEventTypes(source, [ExitItem]);
|
|
73
|
+
assert.deepEqual(events.map(event => event.content.value), [item.value]);
|
|
74
|
+
const counts = connectionCounts();
|
|
75
|
+
if (mode.endsWith('-dispose')) {
|
|
76
|
+
client.dispose();
|
|
77
|
+
client.dispose();
|
|
78
|
+
}
|
|
79
|
+
console.log(JSON.stringify({ marker: 'operations-completed', mode, source, expected: item.value,
|
|
80
|
+
actual: events[0].content.value, ...counts }));
|
|
81
|
+
}
|
|
82
|
+
mock.restoreAll();
|
|
83
|
+
// The skip/default no-dispose variants deliberately leave all real client resources untouched.
|
|
84
|
+
// No variant calls process.exit(), unref(), or manually closes a stream or channel.
|
|
@@ -0,0 +1,35 @@
|
|
|
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 { chai, describe, it } from 'vitest';
|
|
5
|
+
import { ChronicleOptions } from '../../ChronicleOptions.js';
|
|
6
|
+
import { ChronicleConnectionStringBuilder, ChronicleConnectionString } from '../../connection/ChronicleConnectionString.js';
|
|
7
|
+
|
|
8
|
+
chai.should();
|
|
9
|
+
|
|
10
|
+
describe('when configuring keep alive', () => {
|
|
11
|
+
it('should preserve the default', () => ChronicleOptions.development().skipKeepAlive.should.be.false);
|
|
12
|
+
it('should accept the factory option', () => ChronicleOptions.development({ skipKeepAlive: true }).skipKeepAlive.should.be.true);
|
|
13
|
+
for (const [query, option, expected] of [
|
|
14
|
+
['true', undefined, true], ['true', false, true], ['false', false, false], ['false', true, true], ['TRUE', false, false]
|
|
15
|
+
] as const) {
|
|
16
|
+
it(`should combine string ${query} and option ${option} with OR precedence`, () => {
|
|
17
|
+
ChronicleOptions.fromConnectionString(`chronicle://localhost:35000?skipKeepAlive=${query}`, {
|
|
18
|
+
skipKeepAlive: option
|
|
19
|
+
}).skipKeepAlive.should.equal(expected);
|
|
20
|
+
});
|
|
21
|
+
}
|
|
22
|
+
it('should emit and round trip the enabled key exactly once', () => {
|
|
23
|
+
const builder = new ChronicleConnectionStringBuilder();
|
|
24
|
+
builder.skipKeepAlive = true;
|
|
25
|
+
builder.build().should.equal('chronicle://localhost:35000?skipKeepAlive=true');
|
|
26
|
+
new ChronicleConnectionString(builder.build()).skipKeepAlive.should.be.true;
|
|
27
|
+
new ChronicleConnectionStringBuilder(builder.build()).skipKeepAlive.should.be.true;
|
|
28
|
+
});
|
|
29
|
+
it('should omit the disabled key', () => {
|
|
30
|
+
const builder = new ChronicleConnectionStringBuilder('chronicle://localhost:35000?skipKeepAlive=true');
|
|
31
|
+
builder.skipKeepAlive = false;
|
|
32
|
+
builder.build().should.equal('chronicle://localhost:35000');
|
|
33
|
+
new ChronicleConnectionString(builder.build()).skipKeepAlive.should.be.false;
|
|
34
|
+
});
|
|
35
|
+
});
|
|
@@ -0,0 +1,51 @@
|
|
|
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 { chai, describe, it, vi } from 'vitest';
|
|
5
|
+
import { EventStore } from '../../EventStore.js';
|
|
6
|
+
import { EventStoreName } from '../../EventStoreName.js';
|
|
7
|
+
import { EventStoreNamespaceName } from '../../EventStoreNamespaceName.js';
|
|
8
|
+
import { ChronicleConnection } from '../../connection/ChronicleConnection.js';
|
|
9
|
+
import { ConnectionLifecycle } from '../../connection/ConnectionLifecycle.js';
|
|
10
|
+
import { ClientObserversRequireKeepAlive } from '../../connection/ClientObserversRequireKeepAlive.js';
|
|
11
|
+
import { eventType } from '../../events/eventTypeDecorator.js';
|
|
12
|
+
import { fromEvent } from '../../projections/modelBound/fromEvent.js';
|
|
13
|
+
import { reactor } from '../../reactors/reactor.js';
|
|
14
|
+
|
|
15
|
+
chai.should();
|
|
16
|
+
@eventType('store-skip-item')
|
|
17
|
+
class Item {}
|
|
18
|
+
@fromEvent(Item)
|
|
19
|
+
class Model {}
|
|
20
|
+
@reactor('store-skip-reactor')
|
|
21
|
+
class Observer { item() {} }
|
|
22
|
+
|
|
23
|
+
describe('when registering store artifacts while skipping keep alive', () => {
|
|
24
|
+
for (const withObserver of [true, false]) {
|
|
25
|
+
it(`should ${withObserver ? 'refuse observers before registration' : 'allow projections read models and watchers'}`, async () => {
|
|
26
|
+
const register = vi.fn().mockResolvedValue({});
|
|
27
|
+
const watch = vi.fn().mockImplementation(async function* () {});
|
|
28
|
+
const connection = new Proxy({}, { get: (_target, property) => property === 'logger' ? undefined
|
|
29
|
+
: new Proxy({}, { get: (_service, method) => method === 'watch' ? watch : register }) }) as ChronicleConnection;
|
|
30
|
+
const lifecycle = new ConnectionLifecycle();
|
|
31
|
+
const store = new EventStore(new EventStoreName('store'), EventStoreNamespaceName.default, connection, lifecycle, 'sink', {
|
|
32
|
+
eventTypes: [Item], readModels: [Model], reactors: withObserver ? [Observer] : [], reducers: [], seeders: [],
|
|
33
|
+
constraints: [], projections: [], webhooks: [], eventTypeMigrations: [], globalForHandlers: []
|
|
34
|
+
}, undefined, undefined, undefined, undefined, true);
|
|
35
|
+
try {
|
|
36
|
+
const [result] = await Promise.allSettled([store.registerArtifacts()]);
|
|
37
|
+
result.status.should.equal(withObserver ? 'rejected' : 'fulfilled');
|
|
38
|
+
if (result.status === 'rejected') {
|
|
39
|
+
result.reason.should.be.instanceOf(ClientObserversRequireKeepAlive);
|
|
40
|
+
register.mock.calls.should.have.lengthOf(0);
|
|
41
|
+
} else {
|
|
42
|
+
register.mock.calls.length.should.be.greaterThan(0);
|
|
43
|
+
await lifecycle.connected(() => {});
|
|
44
|
+
const watcher = store.readModels.createWatcher(Model);
|
|
45
|
+
watch.mock.calls.should.have.lengthOf(1);
|
|
46
|
+
watcher.dispose();
|
|
47
|
+
}
|
|
48
|
+
} finally { store.disposeObservations(); }
|
|
49
|
+
});
|
|
50
|
+
}
|
|
51
|
+
});
|
package/index.ts
CHANGED
|
@@ -30,6 +30,7 @@ import * as confidentiality from './confidentiality/index.js';
|
|
|
30
30
|
export { ChronicleClient } from './ChronicleClient.js';
|
|
31
31
|
export { IncompatibleChronicleServer } from './connection/IncompatibleChronicleServer.js';
|
|
32
32
|
export { RejectedChronicleCredentials } from './connection/RejectedChronicleCredentials.js';
|
|
33
|
+
export { ClientObserversRequireKeepAlive } from './connection/ClientObserversRequireKeepAlive.js';
|
|
33
34
|
export type { IChronicleClient } from './IChronicleClient.js';
|
|
34
35
|
export { ChronicleOptions } from './ChronicleOptions.js';
|
|
35
36
|
export { EventStore } from './EventStore.js';
|
package/package.json
CHANGED
package/reactors/Reactors.ts
CHANGED
|
@@ -35,6 +35,7 @@ import { ArtifactKind } from '../artifacts/ArtifactKind.js';
|
|
|
35
35
|
import { ArtifactDelivery } from '../artifacts/ArtifactDelivery.js';
|
|
36
36
|
import { withActivatedArtifact, runActivated } from '../artifacts/withActivatedArtifact.js';
|
|
37
37
|
import { ArtifactCompletionFailed } from '../artifacts/ArtifactCompletionFailed.js';
|
|
38
|
+
import { refuseClientHostedObservers } from '../artifacts/refuseClientHostedObservers.js';
|
|
38
39
|
|
|
39
40
|
/** Expression used to partition reactor observations by event source ID. */
|
|
40
41
|
const EVENT_SOURCE_ID_KEY = '$eventSourceId';
|
|
@@ -135,7 +136,8 @@ export class Reactors implements IReactors {
|
|
|
135
136
|
private readonly _eventLog: IEventLog,
|
|
136
137
|
private readonly _resultHandler?: ReactorResultHandler,
|
|
137
138
|
private readonly _eventStore?: IEventStore,
|
|
138
|
-
private readonly _artifactActivator?: ClientArtifactsActivator
|
|
139
|
+
private readonly _artifactActivator?: ClientArtifactsActivator,
|
|
140
|
+
private readonly _skipKeepAlive: boolean = false
|
|
139
141
|
) {
|
|
140
142
|
this._logger = createLogger('@cratis/chronicle/reactors', _connection.logger);
|
|
141
143
|
this._lifecycle = lifecycle;
|
|
@@ -168,6 +170,7 @@ export class Reactors implements IReactors {
|
|
|
168
170
|
|
|
169
171
|
/** @inheritdoc */
|
|
170
172
|
async register(): Promise<void> {
|
|
173
|
+
if (this._skipKeepAlive) refuseClientHostedObservers({ reactors: this._clientArtifacts.reactors, reducers: [] });
|
|
171
174
|
if (this._registered || this._disposed) {
|
|
172
175
|
return;
|
|
173
176
|
}
|
|
@@ -0,0 +1,48 @@
|
|
|
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 { chai, describe, it, vi } from 'vitest';
|
|
5
|
+
import { Reactors } from '../../Reactors.js';
|
|
6
|
+
import { reactor } from '../../reactor.js';
|
|
7
|
+
import { eventType } from '../../../events/eventTypeDecorator.js';
|
|
8
|
+
import { ConnectionLifecycle } from '../../../connection/ConnectionLifecycle.js';
|
|
9
|
+
import { ChronicleConnection } from '../../../connection/ChronicleConnection.js';
|
|
10
|
+
import { ClientObserversRequireKeepAlive } from '../../../connection/ClientObserversRequireKeepAlive.js';
|
|
11
|
+
import { IClientArtifactsProvider } from '../../../artifacts/IClientArtifactsProvider.js';
|
|
12
|
+
import { IEventLog } from '../../../eventSequences/IEventLog.js';
|
|
13
|
+
|
|
14
|
+
chai.should();
|
|
15
|
+
@eventType('reactor-skip-item')
|
|
16
|
+
class Item {}
|
|
17
|
+
@reactor('late-reactor')
|
|
18
|
+
class Observer { item() {} }
|
|
19
|
+
|
|
20
|
+
describe('when registering reactors while skipping keep alive', () => {
|
|
21
|
+
for (const scenario of ['initial', 'late', 'discovered', 'default']) {
|
|
22
|
+
it(`should enforce the keep alive requirement for ${scenario} registration`, async () => {
|
|
23
|
+
const observe = vi.fn().mockImplementation(async function* () {});
|
|
24
|
+
const artifacts: IClientArtifactsProvider = { eventTypes: [Item], reactors: scenario === 'initial' ? [Observer] : [],
|
|
25
|
+
reducers: [], readModels: [], seeders: [], constraints: [], projections: [], webhooks: [], eventTypeMigrations: [], globalForHandlers: [] };
|
|
26
|
+
const lifecycle = new ConnectionLifecycle();
|
|
27
|
+
const connection = { reactors: { observe } } as unknown as ChronicleConnection;
|
|
28
|
+
const manager = new Reactors(artifacts, connection, 'store', 'Default', lifecycle, {} as IEventLog,
|
|
29
|
+
undefined, undefined, undefined, scenario !== 'default');
|
|
30
|
+
try {
|
|
31
|
+
if (scenario !== 'initial') {
|
|
32
|
+
await manager.register();
|
|
33
|
+
artifacts.reactors.push(Observer);
|
|
34
|
+
await lifecycle.disconnected(() => {});
|
|
35
|
+
if (scenario === 'discovered') await manager.discover();
|
|
36
|
+
}
|
|
37
|
+
const [result] = await Promise.allSettled([manager.register()]);
|
|
38
|
+
result.status.should.equal(scenario === 'default' ? 'fulfilled' : 'rejected');
|
|
39
|
+
if (result.status === 'rejected') {
|
|
40
|
+
result.reason.should.be.instanceOf(ClientObserversRequireKeepAlive);
|
|
41
|
+
result.reason.observerKind.should.equal('Reactor');
|
|
42
|
+
result.reason.observerId.should.equal('late-reactor');
|
|
43
|
+
observe.mock.calls.should.have.lengthOf(0);
|
|
44
|
+
} else observe.mock.calls.should.have.lengthOf(1);
|
|
45
|
+
} finally { manager.dispose(); }
|
|
46
|
+
});
|
|
47
|
+
}
|
|
48
|
+
});
|
package/reducers/Reducers.ts
CHANGED
|
@@ -33,6 +33,7 @@ import type { ClientArtifactsActivator } from '../artifacts/ClientArtifactsActiv
|
|
|
33
33
|
import type { ActivatedArtifact } from '../artifacts/ActivatedArtifact.js';
|
|
34
34
|
import { ArtifactKind } from '../artifacts/ArtifactKind.js';
|
|
35
35
|
import { ArtifactDelivery } from '../artifacts/ArtifactDelivery.js';
|
|
36
|
+
import { refuseClientHostedObservers } from '../artifacts/refuseClientHostedObservers.js';
|
|
36
37
|
import { withActivatedArtifact, runActivated } from '../artifacts/withActivatedArtifact.js';
|
|
37
38
|
|
|
38
39
|
/** Expression used to partition reducer observations by event source ID. */
|
|
@@ -134,7 +135,8 @@ export class Reducers implements IReducers {
|
|
|
134
135
|
private readonly _defaultSinkTypeId: string,
|
|
135
136
|
private readonly _eventStore?: IEventStore,
|
|
136
137
|
private readonly _artifactActivator?: ClientArtifactsActivator,
|
|
137
|
-
private readonly _readModelNamingPolicy?: ReadModelNamingPolicy
|
|
138
|
+
private readonly _readModelNamingPolicy?: ReadModelNamingPolicy,
|
|
139
|
+
private readonly _skipKeepAlive: boolean = false
|
|
138
140
|
) {
|
|
139
141
|
this._logger = createLogger('@cratis/chronicle/reducers', _connection.logger);
|
|
140
142
|
this._lifecycle = lifecycle;
|
|
@@ -167,6 +169,7 @@ export class Reducers implements IReducers {
|
|
|
167
169
|
|
|
168
170
|
/** @inheritdoc */
|
|
169
171
|
async register(): Promise<void> {
|
|
172
|
+
if (this._skipKeepAlive) refuseClientHostedObservers({ reactors: [], reducers: this._clientArtifacts.reducers });
|
|
170
173
|
if (this._registered || this._disposed) {
|
|
171
174
|
return;
|
|
172
175
|
}
|
|
@@ -0,0 +1,53 @@
|
|
|
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 { chai, describe, it, vi } from 'vitest';
|
|
5
|
+
import { Reducers } from '../../Reducers.js';
|
|
6
|
+
import { reducer } from '../../reducer.js';
|
|
7
|
+
import { eventType } from '../../../events/eventTypeDecorator.js';
|
|
8
|
+
import { ConnectionLifecycle } from '../../../connection/ConnectionLifecycle.js';
|
|
9
|
+
import { ChronicleConnection } from '../../../connection/ChronicleConnection.js';
|
|
10
|
+
import { ClientObserversRequireKeepAlive } from '../../../connection/ClientObserversRequireKeepAlive.js';
|
|
11
|
+
import { IClientArtifactsProvider } from '../../../artifacts/IClientArtifactsProvider.js';
|
|
12
|
+
|
|
13
|
+
chai.should();
|
|
14
|
+
@eventType('reducer-skip-item')
|
|
15
|
+
class Item {}
|
|
16
|
+
class Model {}
|
|
17
|
+
@reducer('late-reducer', undefined, Model)
|
|
18
|
+
class Observer { item() { return new Model(); } }
|
|
19
|
+
|
|
20
|
+
describe('when registering reducers while skipping keep alive', () => {
|
|
21
|
+
for (const scenario of ['initial', 'late', 'discovered', 'default']) {
|
|
22
|
+
it(`should enforce the keep alive requirement for ${scenario} registration`, async () => {
|
|
23
|
+
const observe = vi.fn().mockImplementation(async function* () {});
|
|
24
|
+
const registerMany = vi.fn().mockResolvedValue({});
|
|
25
|
+
const artifacts: IClientArtifactsProvider = { eventTypes: [Item], reducers: scenario === 'initial' ? [Observer] : [],
|
|
26
|
+
reactors: [], readModels: [Model], seeders: [], constraints: [], projections: [], webhooks: [], eventTypeMigrations: [], globalForHandlers: [] };
|
|
27
|
+
const lifecycle = new ConnectionLifecycle();
|
|
28
|
+
const connection = { reducers: { observe }, readModels: { registerMany } } as unknown as ChronicleConnection;
|
|
29
|
+
const manager = new Reducers(artifacts, connection, 'store', 'Default', lifecycle, 'sink',
|
|
30
|
+
undefined, undefined, undefined, scenario !== 'default');
|
|
31
|
+
try {
|
|
32
|
+
if (scenario !== 'initial') {
|
|
33
|
+
await manager.register();
|
|
34
|
+
artifacts.reducers.push(Observer);
|
|
35
|
+
await lifecycle.disconnected(() => {});
|
|
36
|
+
if (scenario === 'discovered') await manager.discover();
|
|
37
|
+
}
|
|
38
|
+
const [result] = await Promise.allSettled([manager.register()]);
|
|
39
|
+
result.status.should.equal(scenario === 'default' ? 'fulfilled' : 'rejected');
|
|
40
|
+
if (result.status === 'rejected') {
|
|
41
|
+
result.reason.should.be.instanceOf(ClientObserversRequireKeepAlive);
|
|
42
|
+
result.reason.observerKind.should.equal('Reducer');
|
|
43
|
+
result.reason.observerId.should.equal('late-reducer');
|
|
44
|
+
observe.mock.calls.should.have.lengthOf(0);
|
|
45
|
+
registerMany.mock.calls.should.have.lengthOf(0);
|
|
46
|
+
} else {
|
|
47
|
+
observe.mock.calls.should.have.lengthOf(1);
|
|
48
|
+
registerMany.mock.calls.should.have.lengthOf(1);
|
|
49
|
+
}
|
|
50
|
+
} finally { manager.dispose(); }
|
|
51
|
+
});
|
|
52
|
+
}
|
|
53
|
+
});
|
|
@@ -0,0 +1,17 @@
|
|
|
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
|
+
/**
|
|
5
|
+
* Error thrown when an append option cannot be honored in a unit of work.
|
|
6
|
+
*/
|
|
7
|
+
export class AppendOptionNotSupportedInUnitOfWork extends Error {
|
|
8
|
+
/**
|
|
9
|
+
* Initializes a new instance of the {@link AppendOptionNotSupportedInUnitOfWork} class.
|
|
10
|
+
* @param optionName - The unsupported append option name.
|
|
11
|
+
* @param guidance - How to supply the intended metadata instead.
|
|
12
|
+
*/
|
|
13
|
+
constructor(readonly optionName: string, guidance: string) {
|
|
14
|
+
super(`A unit of work cannot honour the append option '${optionName}'. ${guidance}`);
|
|
15
|
+
this.name = 'AppendOptionNotSupportedInUnitOfWork';
|
|
16
|
+
}
|
|
17
|
+
}
|
|
@@ -0,0 +1,17 @@
|
|
|
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
|
+
/**
|
|
5
|
+
* Error thrown when an append option alias and its transactional name have different values.
|
|
6
|
+
*/
|
|
7
|
+
export class ConflictingAppendOptionNamesInUnitOfWork extends Error {
|
|
8
|
+
/**
|
|
9
|
+
* Initializes a new instance of the {@link ConflictingAppendOptionNamesInUnitOfWork} class.
|
|
10
|
+
* @param appendOptionName - The ordinary append option name.
|
|
11
|
+
* @param transactionalOptionName - The transactional append option name.
|
|
12
|
+
*/
|
|
13
|
+
constructor(readonly appendOptionName: string, readonly transactionalOptionName: string) {
|
|
14
|
+
super(`The append options give both '${appendOptionName}' and '${transactionalOptionName}' with different values. Give only one of them.`);
|
|
15
|
+
this.name = 'ConflictingAppendOptionNamesInUnitOfWork';
|
|
16
|
+
}
|
|
17
|
+
}
|
|
@@ -29,6 +29,9 @@ export interface IUnitOfWork {
|
|
|
29
29
|
* @param event - The event payload.
|
|
30
30
|
* @param options - Optional append metadata for this event: registered event source / stream routing, stream and source
|
|
31
31
|
* types, stream identifier, subject, occurrence time, tags, named tags and concurrency scope. Kept with the event until commit.
|
|
32
|
+
* Accepts streamType/streamId/sourceType as aliases of eventStreamType/eventStreamId/eventSourceType.
|
|
33
|
+
* @throws {@link ConflictingAppendOptionNamesInUnitOfWork} when both names have different values; the event is not added.
|
|
34
|
+
* @throws {@link AppendOptionNotSupportedInUnitOfWork} when an unsupported option is given; the event is not added.
|
|
32
35
|
* @throws {@link InvalidNamedTag} when a named tag is invalid; the event is not added.
|
|
33
36
|
*/
|
|
34
37
|
addEvent(eventSequenceId: EventSequenceId, eventSourceId: string, event: object, options?: TransactionalAppendOptions): void;
|
|
@@ -10,6 +10,8 @@ import type { TransactionalEventRouting } from './TransactionalEventRouting.js';
|
|
|
10
10
|
* Optional append metadata for an event added to a unit of work.
|
|
11
11
|
* Every value is kept with the event and carried to the append when the unit of work commits,
|
|
12
12
|
* where it is validated like any other append.
|
|
13
|
+
* `AppendOptions`' `correlationId`, `concurrencyScopes` and `eventSourceId` cannot be honored in a unit of work
|
|
14
|
+
* and throw {@link AppendOptionNotSupportedInUnitOfWork} when given.
|
|
13
15
|
*/
|
|
14
16
|
export interface TransactionalAppendOptions extends TransactionalEventRouting {
|
|
15
17
|
/** Optional stream type. When omitted or empty, the kernel selects the route. */
|
|
@@ -21,6 +23,15 @@ export interface TransactionalAppendOptions extends TransactionalEventRouting {
|
|
|
21
23
|
/** Optional source type. When omitted or empty, the kernel selects the route. */
|
|
22
24
|
readonly eventSourceType?: string;
|
|
23
25
|
|
|
26
|
+
/** Alias of {@link eventStreamType} (the `AppendOptions` name). Giving both with different values throws {@link ConflictingAppendOptionNamesInUnitOfWork}. */
|
|
27
|
+
readonly streamType?: string;
|
|
28
|
+
|
|
29
|
+
/** Alias of {@link eventStreamId} (the `AppendOptions` name). Giving both with different values throws {@link ConflictingAppendOptionNamesInUnitOfWork}. */
|
|
30
|
+
readonly streamId?: string;
|
|
31
|
+
|
|
32
|
+
/** Alias of {@link eventSourceType} (the `AppendOptions` name). Giving both with different values throws {@link ConflictingAppendOptionNamesInUnitOfWork}. */
|
|
33
|
+
readonly sourceType?: string;
|
|
34
|
+
|
|
24
35
|
/** Optional occurrence time. When omitted, the kernel supplies the timestamp. */
|
|
25
36
|
readonly occurred?: Date;
|
|
26
37
|
|
|
@@ -16,6 +16,7 @@ import type { ConcurrencyScope } from '../eventSequences/ConcurrencyScope.js';
|
|
|
16
16
|
import { ConflictingConcurrencyScopesInUnitOfWork } from './ConflictingConcurrencyScopesInUnitOfWork.js';
|
|
17
17
|
import { concurrencyScopesAreEqual } from './concurrencyScopesAreEqual.js';
|
|
18
18
|
import { toEventForEventSourceId } from './toEventForEventSourceId.js';
|
|
19
|
+
import { resolveTransactionalAppendOptions } from './resolveTransactionalAppendOptions.js';
|
|
19
20
|
import { IUnitOfWork } from './IUnitOfWork.js';
|
|
20
21
|
|
|
21
22
|
interface EventForEventSourceIdWithSequenceNumber {
|
|
@@ -56,8 +57,9 @@ export class UnitOfWork implements IUnitOfWork {
|
|
|
56
57
|
/** @inheritdoc */
|
|
57
58
|
addEvent(eventSequenceId: EventSequenceId, eventSourceId: string, event: object, options?: TransactionalAppendOptions): void {
|
|
58
59
|
this.throwIfCompleted();
|
|
59
|
-
const
|
|
60
|
-
const
|
|
60
|
+
const resolved = resolveTransactionalAppendOptions(options);
|
|
61
|
+
const eventForEventSourceId = toEventForEventSourceId(eventSourceId, event, resolved);
|
|
62
|
+
const scope = resolved?.concurrencyScope;
|
|
61
63
|
const scopesForSequence = this._concurrencyScopes.get(eventSequenceId.value) ?? new Map<string, ConcurrencyScope>();
|
|
62
64
|
if (scope !== undefined) {
|
|
63
65
|
const enrolled = scopesForSequence.get(eventSourceId);
|
|
@@ -14,10 +14,11 @@ export function concurrencyScopesAreEqual(first: ConcurrencyScope, second: Concu
|
|
|
14
14
|
const eventTypeKeys = (scope: ConcurrencyScope) =>
|
|
15
15
|
[...new Set((scope.eventTypes ?? []).map(_ => `${_.id.value}+${_.generation.value}`))].sort().join(',');
|
|
16
16
|
|
|
17
|
+
// Undefined and empty are the same on the wire, so they are the same here.
|
|
17
18
|
return first.sequenceNumber === second.sequenceNumber
|
|
18
19
|
&& (first.eventSourceId ?? false) === (second.eventSourceId ?? false)
|
|
19
|
-
&& first.eventStreamType === second.eventStreamType
|
|
20
|
-
&& first.eventStreamId === second.eventStreamId
|
|
21
|
-
&& first.eventSourceType === second.eventSourceType
|
|
20
|
+
&& (first.eventStreamType ?? '') === (second.eventStreamType ?? '')
|
|
21
|
+
&& (first.eventStreamId ?? '') === (second.eventStreamId ?? '')
|
|
22
|
+
&& (first.eventSourceType ?? '') === (second.eventSourceType ?? '')
|
|
22
23
|
&& eventTypeKeys(first) === eventTypeKeys(second);
|
|
23
24
|
}
|
|
@@ -0,0 +1,65 @@
|
|
|
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 { beforeEach, chai, describe, it } from 'vitest';
|
|
5
|
+
import { EventSequenceId } from '../../../eventSequences/EventSequenceId.js';
|
|
6
|
+
import { ConflictingAppendOptionNamesInUnitOfWork } from '../../ConflictingAppendOptionNamesInUnitOfWork.js';
|
|
7
|
+
import type { UnitOfWork } from '../../UnitOfWork.js';
|
|
8
|
+
import { a_unit_of_work_with_a_recording_store } from '../given/a_unit_of_work_with_a_recording_store.js';
|
|
9
|
+
|
|
10
|
+
chai.should();
|
|
11
|
+
|
|
12
|
+
for (const [appendOptionName, transactionalOptionName] of [
|
|
13
|
+
['streamType', 'eventStreamType'],
|
|
14
|
+
['streamId', 'eventStreamId'],
|
|
15
|
+
['sourceType', 'eventSourceType']
|
|
16
|
+
]) {
|
|
17
|
+
describe(`when adding events and ${appendOptionName} and ${transactionalOptionName} have different values`, () => {
|
|
18
|
+
let unitOfWork: UnitOfWork;
|
|
19
|
+
let error: unknown;
|
|
20
|
+
|
|
21
|
+
beforeEach(() => {
|
|
22
|
+
({ unitOfWork } = a_unit_of_work_with_a_recording_store());
|
|
23
|
+
error = undefined;
|
|
24
|
+
unitOfWork.addEvent(EventSequenceId.eventLog, 'a-1', { order: 0 });
|
|
25
|
+
try {
|
|
26
|
+
unitOfWork.addEvent(EventSequenceId.eventLog, 'a-1', { order: 1 }, {
|
|
27
|
+
[appendOptionName]: 'private-alias-value',
|
|
28
|
+
[transactionalOptionName]: 'private-transactional-value',
|
|
29
|
+
concurrencyScope: { sequenceNumber: 2n }
|
|
30
|
+
});
|
|
31
|
+
} catch (caught) {
|
|
32
|
+
error = caught;
|
|
33
|
+
}
|
|
34
|
+
});
|
|
35
|
+
|
|
36
|
+
it('should reject the conflicting event', () => error!.should.be.instanceOf(ConflictingAppendOptionNamesInUnitOfWork));
|
|
37
|
+
it('should name the append option', () => (error as ConflictingAppendOptionNamesInUnitOfWork).appendOptionName.should.equal(appendOptionName));
|
|
38
|
+
it('should name the transactional option', () => (error as ConflictingAppendOptionNamesInUnitOfWork).transactionalOptionName.should.equal(transactionalOptionName));
|
|
39
|
+
it('should not disclose the alias value', () => (error as Error).message.should.not.contain('private-alias-value'));
|
|
40
|
+
it('should not disclose the transactional value', () => (error as Error).message.should.not.contain('private-transactional-value'));
|
|
41
|
+
it('should keep only the first event', () => unitOfWork.getEvents().should.deep.equal([{ order: 0 }]));
|
|
42
|
+
});
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
describe('when adding an event after conflicting append option names were refused', () => {
|
|
46
|
+
let error: unknown;
|
|
47
|
+
|
|
48
|
+
beforeEach(() => {
|
|
49
|
+
const { unitOfWork } = a_unit_of_work_with_a_recording_store();
|
|
50
|
+
unitOfWork.addEvent(EventSequenceId.eventLog, 'a-1', { order: 0 });
|
|
51
|
+
try {
|
|
52
|
+
unitOfWork.addEvent(EventSequenceId.eventLog, 'a-1', { order: 1 }, {
|
|
53
|
+
streamId: 'private-alias-value', eventStreamId: 'private-transactional-value', concurrencyScope: { sequenceNumber: 2n }
|
|
54
|
+
});
|
|
55
|
+
} catch { /* The conflicting event is refused. */ }
|
|
56
|
+
error = undefined;
|
|
57
|
+
try {
|
|
58
|
+
unitOfWork.addEvent(EventSequenceId.eventLog, 'a-1', { order: 2 }, { concurrencyScope: { sequenceNumber: 3n } });
|
|
59
|
+
} catch (caught) {
|
|
60
|
+
error = caught;
|
|
61
|
+
}
|
|
62
|
+
});
|
|
63
|
+
|
|
64
|
+
it('should not have enrolled the refused concurrency scope', () => chai.should().not.exist(error));
|
|
65
|
+
});
|
|
@@ -0,0 +1,22 @@
|
|
|
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 { beforeEach, chai, describe, it } from 'vitest';
|
|
5
|
+
import { EventSequenceId } from '../../../eventSequences/EventSequenceId.js';
|
|
6
|
+
import type { EventForEventSourceId } from '../../../eventSequences/EventForEventSourceId.js';
|
|
7
|
+
import { a_unit_of_work_with_a_recording_store } from '../given/a_unit_of_work_with_a_recording_store.js';
|
|
8
|
+
|
|
9
|
+
chai.should();
|
|
10
|
+
|
|
11
|
+
describe('when adding events and both names have the same value', () => {
|
|
12
|
+
let entry: EventForEventSourceId;
|
|
13
|
+
|
|
14
|
+
beforeEach(async () => {
|
|
15
|
+
const { unitOfWork, appends } = a_unit_of_work_with_a_recording_store();
|
|
16
|
+
unitOfWork.addEvent(EventSequenceId.eventLog, 'a-1', {}, { streamId: 'order-1', eventStreamId: 'order-1' });
|
|
17
|
+
await unitOfWork.commit();
|
|
18
|
+
entry = appends[0].events[0];
|
|
19
|
+
});
|
|
20
|
+
|
|
21
|
+
it('should accept the stream identifier', () => entry.eventStreamId!.should.equal('order-1'));
|
|
22
|
+
});
|
|
@@ -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 { beforeEach, chai, describe, it } from 'vitest';
|
|
5
|
+
import { EventSequenceId } from '../../../eventSequences/EventSequenceId.js';
|
|
6
|
+
import type { EventForEventSourceId } from '../../../eventSequences/EventForEventSourceId.js';
|
|
7
|
+
import { a_unit_of_work_with_a_recording_store } from '../given/a_unit_of_work_with_a_recording_store.js';
|
|
8
|
+
|
|
9
|
+
chai.should();
|
|
10
|
+
|
|
11
|
+
describe('when adding events and the append option names are used', () => {
|
|
12
|
+
let batch: EventForEventSourceId[];
|
|
13
|
+
|
|
14
|
+
beforeEach(async () => {
|
|
15
|
+
const { unitOfWork, appends } = a_unit_of_work_with_a_recording_store();
|
|
16
|
+
unitOfWork.addEvent(EventSequenceId.eventLog, 'a-1', {}, { streamType: 'Orders', streamId: 'order-1', sourceType: 'Customer' });
|
|
17
|
+
await unitOfWork.commit();
|
|
18
|
+
batch = appends[0].events;
|
|
19
|
+
});
|
|
20
|
+
|
|
21
|
+
it('should keep the stream type', () => batch[0].eventStreamType!.should.equal('Orders'));
|
|
22
|
+
it('should keep the stream identifier', () => batch[0].eventStreamId!.should.equal('order-1'));
|
|
23
|
+
it('should keep the source type', () => batch[0].eventSourceType!.should.equal('Customer'));
|
|
24
|
+
it('should not leak alias keys', () => Object.keys(batch[0]).sort().should.deep.equal(['event', 'eventSourceId', 'eventSourceType', 'eventStreamId', 'eventStreamType']));
|
|
25
|
+
});
|
|
@@ -0,0 +1,40 @@
|
|
|
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 { beforeEach, chai, describe, it } from 'vitest';
|
|
5
|
+
import { EventSequenceId } from '../../../eventSequences/EventSequenceId.js';
|
|
6
|
+
import type { ConcurrencyScope } from '../../../eventSequences/ConcurrencyScope.js';
|
|
7
|
+
import { ConflictingConcurrencyScopesInUnitOfWork } from '../../ConflictingConcurrencyScopesInUnitOfWork.js';
|
|
8
|
+
import { a_unit_of_work_with_a_recording_store } from '../given/a_unit_of_work_with_a_recording_store.js';
|
|
9
|
+
import type { UnitOfWork } from '../../UnitOfWork.js';
|
|
10
|
+
|
|
11
|
+
chai.should();
|
|
12
|
+
|
|
13
|
+
describe('when adding events with concurrency scopes and a routing field is empty versus named', () => {
|
|
14
|
+
let unitOfWork: UnitOfWork;
|
|
15
|
+
let errors: unknown[];
|
|
16
|
+
|
|
17
|
+
const tryAdd = (source: string, concurrencyScope: ConcurrencyScope) => {
|
|
18
|
+
try {
|
|
19
|
+
unitOfWork.addEvent(EventSequenceId.eventLog, source, { source }, { concurrencyScope });
|
|
20
|
+
} catch (caught) {
|
|
21
|
+
errors.push(caught);
|
|
22
|
+
}
|
|
23
|
+
};
|
|
24
|
+
|
|
25
|
+
beforeEach(() => {
|
|
26
|
+
({ unitOfWork } = a_unit_of_work_with_a_recording_store());
|
|
27
|
+
errors = [];
|
|
28
|
+
for (const field of ['eventStreamType', 'eventStreamId', 'eventSourceType'] as const) {
|
|
29
|
+
tryAdd(`${field}-undefined`, { sequenceNumber: 1n });
|
|
30
|
+
tryAdd(`${field}-undefined`, { sequenceNumber: 1n, [field]: 'Named' });
|
|
31
|
+
tryAdd(`${field}-empty`, { sequenceNumber: 1n, [field]: '' });
|
|
32
|
+
tryAdd(`${field}-empty`, { sequenceNumber: 1n, [field]: 'Named' });
|
|
33
|
+
}
|
|
34
|
+
});
|
|
35
|
+
|
|
36
|
+
it('should reject each conflicting event', () => {
|
|
37
|
+
errors.should.have.lengthOf(6);
|
|
38
|
+
errors.every(_ => _ instanceof ConflictingConcurrencyScopesInUnitOfWork).should.be.true;
|
|
39
|
+
});
|
|
40
|
+
});
|