@cratis/chronicle 6.54.0 → 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/artifacts/refuseClientHostedObservers.ts +16 -0
- package/connection/ChronicleConnection.ts +21 -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/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 +7 -1
- package/dist/connection/ChronicleConnection.d.ts.map +1 -1
- package/dist/connection/ChronicleConnection.js +13 -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,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
|
+
});
|
|
@@ -0,0 +1,39 @@
|
|
|
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 { a_unit_of_work_with_a_recording_store, type RecordedAppend } from '../given/a_unit_of_work_with_a_recording_store.js';
|
|
8
|
+
|
|
9
|
+
chai.should();
|
|
10
|
+
|
|
11
|
+
describe('when adding events with concurrency scopes and the routing fields are undefined or empty', () => {
|
|
12
|
+
let appends: RecordedAppend[];
|
|
13
|
+
let errors: unknown[];
|
|
14
|
+
|
|
15
|
+
beforeEach(async () => {
|
|
16
|
+
const recording = a_unit_of_work_with_a_recording_store();
|
|
17
|
+
errors = [];
|
|
18
|
+
const fields = ['eventStreamType', 'eventStreamId', 'eventSourceType'] as const;
|
|
19
|
+
for (const field of fields) {
|
|
20
|
+
const undefinedScope: ConcurrencyScope = { sequenceNumber: 1n };
|
|
21
|
+
const emptyScope: ConcurrencyScope = { sequenceNumber: 1n, [field]: '' };
|
|
22
|
+
const pairs = [[undefinedScope, emptyScope], [emptyScope, undefinedScope]];
|
|
23
|
+
pairs.forEach(([first, second], index) => {
|
|
24
|
+
const source = `${field}-${index}`;
|
|
25
|
+
try {
|
|
26
|
+
recording.unitOfWork.addEvent(EventSequenceId.eventLog, source, { order: 0 }, { concurrencyScope: first });
|
|
27
|
+
recording.unitOfWork.addEvent(EventSequenceId.eventLog, source, { order: 1 }, { concurrencyScope: second });
|
|
28
|
+
} catch (caught) {
|
|
29
|
+
errors.push(caught);
|
|
30
|
+
}
|
|
31
|
+
});
|
|
32
|
+
}
|
|
33
|
+
await recording.unitOfWork.commit();
|
|
34
|
+
appends = recording.appends;
|
|
35
|
+
});
|
|
36
|
+
|
|
37
|
+
it('should not reject any event', () => errors.should.be.empty);
|
|
38
|
+
it('should append every event', () => appends[0].events.should.have.lengthOf(12));
|
|
39
|
+
});
|
|
@@ -0,0 +1,38 @@
|
|
|
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 type { AppendOptions } from '../../../eventSequences/AppendOptions.js';
|
|
6
|
+
import { EventSequenceId } from '../../../eventSequences/EventSequenceId.js';
|
|
7
|
+
import { AppendOptionNotSupportedInUnitOfWork } from '../../AppendOptionNotSupportedInUnitOfWork.js';
|
|
8
|
+
import { a_unit_of_work_with_a_recording_store, type RecordingUnitOfWork } from '../given/a_unit_of_work_with_a_recording_store.js';
|
|
9
|
+
|
|
10
|
+
chai.should();
|
|
11
|
+
|
|
12
|
+
describe('when adding events and a correlation identifier is given', () => {
|
|
13
|
+
let recording: RecordingUnitOfWork;
|
|
14
|
+
let error: unknown;
|
|
15
|
+
let buffered: ReadonlyArray<object>;
|
|
16
|
+
|
|
17
|
+
beforeEach(async () => {
|
|
18
|
+
recording = a_unit_of_work_with_a_recording_store();
|
|
19
|
+
const { unitOfWork } = recording;
|
|
20
|
+
unitOfWork.addEvent(EventSequenceId.eventLog, 'a-1', { order: 0 });
|
|
21
|
+
const options: AppendOptions = { correlationId: 'private-correlation-id', subject: 's', concurrencyScope: { sequenceNumber: 2n } };
|
|
22
|
+
error = undefined;
|
|
23
|
+
try {
|
|
24
|
+
unitOfWork.addEvent(EventSequenceId.eventLog, 'a-1', { order: 1 }, options);
|
|
25
|
+
} catch (caught) {
|
|
26
|
+
error = caught;
|
|
27
|
+
}
|
|
28
|
+
buffered = unitOfWork.getEvents();
|
|
29
|
+
await unitOfWork.commit();
|
|
30
|
+
});
|
|
31
|
+
|
|
32
|
+
it('should reject the unsupported option', () => error!.should.be.instanceOf(AppendOptionNotSupportedInUnitOfWork));
|
|
33
|
+
it('should name the option', () => (error as AppendOptionNotSupportedInUnitOfWork).optionName.should.equal('correlationId'));
|
|
34
|
+
it('should not disclose the value', () => (error as Error).message.should.not.contain('private-correlation-id'));
|
|
35
|
+
it('should keep only the first event', () => buffered.should.deep.equal([{ order: 0 }]));
|
|
36
|
+
it('should commit only the first event', () => recording.appends[0].events.should.deep.equal([{ eventSourceId: 'a-1', event: { order: 0 } }]));
|
|
37
|
+
it('should not enroll the refused scope', () => recording.appends[0].options.should.not.have.property('concurrencyScopes'));
|
|
38
|
+
});
|
|
@@ -0,0 +1,38 @@
|
|
|
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 type { AppendOptions } from '../../../eventSequences/AppendOptions.js';
|
|
6
|
+
import { EventSequenceId } from '../../../eventSequences/EventSequenceId.js';
|
|
7
|
+
import { AppendOptionNotSupportedInUnitOfWork } from '../../AppendOptionNotSupportedInUnitOfWork.js';
|
|
8
|
+
import { a_unit_of_work_with_a_recording_store, type RecordingUnitOfWork } from '../given/a_unit_of_work_with_a_recording_store.js';
|
|
9
|
+
|
|
10
|
+
chai.should();
|
|
11
|
+
|
|
12
|
+
describe('when adding events and an event source identifier is given', () => {
|
|
13
|
+
let recording: RecordingUnitOfWork;
|
|
14
|
+
let error: unknown;
|
|
15
|
+
let buffered: ReadonlyArray<object>;
|
|
16
|
+
|
|
17
|
+
beforeEach(async () => {
|
|
18
|
+
recording = a_unit_of_work_with_a_recording_store();
|
|
19
|
+
const { unitOfWork } = recording;
|
|
20
|
+
unitOfWork.addEvent(EventSequenceId.eventLog, 'a-1', { order: 0 });
|
|
21
|
+
const options: AppendOptions = { eventSourceId: 'private-source-id', subject: 's', concurrencyScope: { sequenceNumber: 2n } };
|
|
22
|
+
error = undefined;
|
|
23
|
+
try {
|
|
24
|
+
unitOfWork.addEvent(EventSequenceId.eventLog, 'a-1', { order: 1 }, options);
|
|
25
|
+
} catch (caught) {
|
|
26
|
+
error = caught;
|
|
27
|
+
}
|
|
28
|
+
buffered = unitOfWork.getEvents();
|
|
29
|
+
await unitOfWork.commit();
|
|
30
|
+
});
|
|
31
|
+
|
|
32
|
+
it('should reject the unsupported option', () => error!.should.be.instanceOf(AppendOptionNotSupportedInUnitOfWork));
|
|
33
|
+
it('should name the option', () => (error as AppendOptionNotSupportedInUnitOfWork).optionName.should.equal('eventSourceId'));
|
|
34
|
+
it('should not disclose the value', () => (error as Error).message.should.not.contain('private-source-id'));
|
|
35
|
+
it('should keep only the first event', () => buffered.should.deep.equal([{ order: 0 }]));
|
|
36
|
+
it('should commit only the first event', () => recording.appends[0].events.should.deep.equal([{ eventSourceId: 'a-1', event: { order: 0 } }]));
|
|
37
|
+
it('should not enroll the refused scope', () => recording.appends[0].options.should.not.have.property('concurrencyScopes'));
|
|
38
|
+
});
|
|
@@ -0,0 +1,38 @@
|
|
|
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 type { AppendOptions } from '../../../eventSequences/AppendOptions.js';
|
|
6
|
+
import { EventSequenceId } from '../../../eventSequences/EventSequenceId.js';
|
|
7
|
+
import { AppendOptionNotSupportedInUnitOfWork } from '../../AppendOptionNotSupportedInUnitOfWork.js';
|
|
8
|
+
import { a_unit_of_work_with_a_recording_store, type RecordingUnitOfWork } from '../given/a_unit_of_work_with_a_recording_store.js';
|
|
9
|
+
|
|
10
|
+
chai.should();
|
|
11
|
+
|
|
12
|
+
describe('when adding events and concurrency scopes are given', () => {
|
|
13
|
+
let recording: RecordingUnitOfWork;
|
|
14
|
+
let error: unknown;
|
|
15
|
+
let buffered: ReadonlyArray<object>;
|
|
16
|
+
|
|
17
|
+
beforeEach(async () => {
|
|
18
|
+
recording = a_unit_of_work_with_a_recording_store();
|
|
19
|
+
const { unitOfWork } = recording;
|
|
20
|
+
unitOfWork.addEvent(EventSequenceId.eventLog, 'a-1', { order: 0 });
|
|
21
|
+
const options: AppendOptions = { concurrencyScopes: { 'private-source-id': { sequenceNumber: 7n } }, subject: 's', concurrencyScope: { sequenceNumber: 2n } };
|
|
22
|
+
error = undefined;
|
|
23
|
+
try {
|
|
24
|
+
unitOfWork.addEvent(EventSequenceId.eventLog, 'a-1', { order: 1 }, options);
|
|
25
|
+
} catch (caught) {
|
|
26
|
+
error = caught;
|
|
27
|
+
}
|
|
28
|
+
buffered = unitOfWork.getEvents();
|
|
29
|
+
await unitOfWork.commit();
|
|
30
|
+
});
|
|
31
|
+
|
|
32
|
+
it('should reject the unsupported option', () => error!.should.be.instanceOf(AppendOptionNotSupportedInUnitOfWork));
|
|
33
|
+
it('should name the option', () => (error as AppendOptionNotSupportedInUnitOfWork).optionName.should.equal('concurrencyScopes'));
|
|
34
|
+
it('should not disclose the value', () => (error as Error).message.should.not.contain('private-source-id'));
|
|
35
|
+
it('should keep only the first event', () => buffered.should.deep.equal([{ order: 0 }]));
|
|
36
|
+
it('should commit only the first event', () => recording.appends[0].events.should.deep.equal([{ eventSourceId: 'a-1', event: { order: 0 } }]));
|
|
37
|
+
it('should not enroll the refused scope', () => recording.appends[0].options.should.not.have.property('concurrencyScopes'));
|
|
38
|
+
});
|
|
@@ -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 { beforeEach, chai, describe, it } from 'vitest';
|
|
5
|
+
import type { AppendOptions } from '../../../eventSequences/AppendOptions.js';
|
|
6
|
+
import type { EventForEventSourceId } from '../../../eventSequences/EventForEventSourceId.js';
|
|
7
|
+
import { EventSequenceId } from '../../../eventSequences/EventSequenceId.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
|
+
describe('when adding events and unsupported options are undefined', () => {
|
|
13
|
+
let entry: EventForEventSourceId;
|
|
14
|
+
|
|
15
|
+
beforeEach(async () => {
|
|
16
|
+
const { unitOfWork, appends } = a_unit_of_work_with_a_recording_store();
|
|
17
|
+
const options: AppendOptions = { correlationId: undefined, concurrencyScopes: undefined, eventSourceId: undefined, subject: 's' };
|
|
18
|
+
unitOfWork.addEvent(EventSequenceId.eventLog, 'a-1', {}, options);
|
|
19
|
+
await unitOfWork.commit();
|
|
20
|
+
entry = appends[0].events[0];
|
|
21
|
+
});
|
|
22
|
+
|
|
23
|
+
it('should keep the subject', () => entry.subject!.should.equal('s'));
|
|
24
|
+
});
|
package/transactions/index.ts
CHANGED
|
@@ -9,3 +9,5 @@ export { UnitOfWorkManager } from './UnitOfWorkManager.js';
|
|
|
9
9
|
export type { TransactionalEventRouting } from './TransactionalEventRouting.js';
|
|
10
10
|
export type { TransactionalAppendOptions } from './TransactionalAppendOptions.js';
|
|
11
11
|
export { ConflictingConcurrencyScopesInUnitOfWork } from './ConflictingConcurrencyScopesInUnitOfWork.js';
|
|
12
|
+
export { ConflictingAppendOptionNamesInUnitOfWork } from './ConflictingAppendOptionNamesInUnitOfWork.js';
|
|
13
|
+
export { AppendOptionNotSupportedInUnitOfWork } from './AppendOptionNotSupportedInUnitOfWork.js';
|
|
@@ -0,0 +1,68 @@
|
|
|
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 type { TransactionalAppendOptions } from './TransactionalAppendOptions.js';
|
|
5
|
+
import { AppendOptionNotSupportedInUnitOfWork } from './AppendOptionNotSupportedInUnitOfWork.js';
|
|
6
|
+
import { ConflictingAppendOptionNamesInUnitOfWork } from './ConflictingAppendOptionNamesInUnitOfWork.js';
|
|
7
|
+
|
|
8
|
+
const unsupportedOptions = [
|
|
9
|
+
['correlationId', 'The unit of work appends with its own correlation identifier; begin the unit of work with it instead: unitOfWorkManager.begin(correlationId).'],
|
|
10
|
+
['concurrencyScopes', 'Give each event its own concurrencyScope; the unit of work combines them per event source identifier.'],
|
|
11
|
+
['eventSourceId', 'The event source identifier is the append argument.']
|
|
12
|
+
] as const;
|
|
13
|
+
|
|
14
|
+
const aliases = [
|
|
15
|
+
['streamType', 'eventStreamType'],
|
|
16
|
+
['streamId', 'eventStreamId'],
|
|
17
|
+
['sourceType', 'eventSourceType']
|
|
18
|
+
] as const;
|
|
19
|
+
|
|
20
|
+
type OptionValues = Record<string, unknown>;
|
|
21
|
+
|
|
22
|
+
function throwIfUnsupported(values: Readonly<OptionValues>): void {
|
|
23
|
+
const unsupported = unsupportedOptions.find(([optionName]) => values[optionName] !== undefined);
|
|
24
|
+
if (unsupported) {
|
|
25
|
+
throw new AppendOptionNotSupportedInUnitOfWork(unsupported[0], unsupported[1]);
|
|
26
|
+
}
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
function isConflicting(values: Readonly<OptionValues>, appendOptionName: string, transactionalOptionName: string): boolean {
|
|
30
|
+
const appendValue = values[appendOptionName];
|
|
31
|
+
const transactionalValue = values[transactionalOptionName];
|
|
32
|
+
return appendValue !== undefined && transactionalValue !== undefined && appendValue !== transactionalValue;
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
function throwIfConflicting(values: Readonly<OptionValues>): void {
|
|
36
|
+
const conflict = aliases.find(([appendOptionName, transactionalOptionName]) => isConflicting(values, appendOptionName, transactionalOptionName));
|
|
37
|
+
if (conflict) {
|
|
38
|
+
throw new ConflictingAppendOptionNamesInUnitOfWork(conflict[0], conflict[1]);
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
function normalizeAliases(values: Readonly<OptionValues>): OptionValues {
|
|
43
|
+
const normalized: OptionValues = { ...values };
|
|
44
|
+
for (const [appendOptionName, transactionalOptionName] of aliases) {
|
|
45
|
+
const value = values[transactionalOptionName] ?? values[appendOptionName];
|
|
46
|
+
delete normalized[appendOptionName];
|
|
47
|
+
delete normalized[transactionalOptionName];
|
|
48
|
+
if (value !== undefined) {
|
|
49
|
+
normalized[transactionalOptionName] = value;
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
return normalized;
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
/**
|
|
56
|
+
* Validates transactional append options and normalizes ordinary append option aliases.
|
|
57
|
+
* @param options - Optional metadata for an event added to a unit of work.
|
|
58
|
+
* @returns The options with aliases replaced by their transactional names.
|
|
59
|
+
*/
|
|
60
|
+
export function resolveTransactionalAppendOptions(options?: TransactionalAppendOptions): TransactionalAppendOptions | undefined {
|
|
61
|
+
if (options === undefined) {
|
|
62
|
+
return undefined;
|
|
63
|
+
}
|
|
64
|
+
const values = options as Readonly<OptionValues>;
|
|
65
|
+
throwIfUnsupported(values);
|
|
66
|
+
throwIfConflicting(values);
|
|
67
|
+
return normalizeAliases(values) as TransactionalAppendOptions;
|
|
68
|
+
}
|