Skip to content

chore: Stop observing in the tests once the expected events arrived, instead of after a fixed time. #428

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
goloroden merged 2 commits into from
Oct 19, 2026
Merged

chore: Stop observing in the tests once the expected events arrived, instead of after a fixed time. #428

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4fab4d5
chore: Stop observing in the tests once the expected events arrived, …
goloroden Oct 19, 2026
200988b
Merge branch 'main' into chore/stop-observing-once-events-arrived
goloroden Oct 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
156 changes: 86 additions & 70 deletions src/observeEvents.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,42 @@ import { getImageTag } from './getImageTag.js';
import { containerStartTimeout } from './testing/containerStartTimeout.js';
import { integrationTimeout } from './testing/integrationTimeout.js';

// The events of a test are written before it observes them, so they arrive
// at once. A test stops observing once the expected number of events has
// arrived, and fails if they have not arrived within this many milliseconds.
const observeTimeout = 10_000;

const observeUntil = async (
observe: (signal: AbortSignal) => AsyncGenerator<Event, void, void>,
expectedCount: number,
): Promise<Event[]> => {
const events: Event[] = [];
const controller = new AbortController();
const timer = setTimeout(() => {
controller.abort();
}, observeTimeout);

try {
for await (const event of observe(controller.signal)) {
events.push(event);

if (events.length === expectedCount) {
break;
}
}
} finally {
clearTimeout(timer);
}

if (events.length < expectedCount) {
throw new Error(
`Observed ${events.length} of ${expectedCount} events within ${observeTimeout} milliseconds.`,
);
}

return events;
};

suite('observeEvents', () => {
let container: Container;

Expand Down Expand Up @@ -72,22 +108,17 @@ suite('observeEvents', () => {

await client.writeEvents([firstEvent, secondEvent]);

const controller = new AbortController();

setTimeout(() => {
controller.abort();
}, 100);

const eventsObserved: Event[] = [];
for await (const event of client.observeEvents(
'/test',
{
recursive: false,
},
controller.signal,
)) {
eventsObserved.push(event);
}
const eventsObserved = await observeUntil(
signal =>
client.observeEvents(
'/test',
{
recursive: false,
},
signal,
),
2,
);

assert.equal(eventsObserved.length, 2);
},
Expand Down Expand Up @@ -116,22 +147,17 @@ suite('observeEvents', () => {

await client.writeEvents([firstEvent, secondEvent]);

const controller = new AbortController();

setTimeout(() => {
controller.abort();
}, 100);

const eventsObserved: Event[] = [];
for await (const event of client.observeEvents(
'/',
{
recursive: true,
},
controller.signal,
)) {
eventsObserved.push(event);
}
const eventsObserved = await observeUntil(
signal =>
client.observeEvents(
'/',
{
recursive: true,
},
signal,
),
2,
);

assert.equal(eventsObserved.length, 2);
});
Expand Down Expand Up @@ -159,23 +185,18 @@ suite('observeEvents', () => {

await client.writeEvents([firstEvent, secondEvent]);

const controller = new AbortController();

setTimeout(() => {
controller.abort();
}, 100);

const eventsObserved: Event[] = [];
for await (const event of client.observeEvents(
'/test',
{
recursive: false,
lowerBound: { id: '1', type: 'inclusive' },
},
controller.signal,
)) {
eventsObserved.push(event);
}
const eventsObserved = await observeUntil(
signal =>
client.observeEvents(
'/test',
{
recursive: false,
lowerBound: { id: '1', type: 'inclusive' },
},
signal,
),
1,
);

assert.equal(eventsObserved.length, 1);
const [eventObserved] = eventsObserved;
Expand Down Expand Up @@ -206,27 +227,22 @@ suite('observeEvents', () => {

await client.writeEvents([firstEvent, secondEvent]);

const controller = new AbortController();

setTimeout(() => {
controller.abort();
}, 100);

const eventsObserved: Event[] = [];
for await (const event of client.observeEvents(
'/test',
{
recursive: false,
fromLatestEvent: {
subject: '/test',
type: 'io.eventsourcingdb.test.bar',
ifEventIsMissing: 'read-everything',
},
},
controller.signal,
)) {
eventsObserved.push(event);
}
const eventsObserved = await observeUntil(
signal =>
client.observeEvents(
'/test',
{
recursive: false,
fromLatestEvent: {
subject: '/test',
type: 'io.eventsourcingdb.test.bar',
ifEventIsMissing: 'read-everything',
},
},
signal,
),
1,
);

assert.equal(eventsObserved.length, 1);
const [eventObserved] = eventsObserved;
Expand Down
Loading