EventStoreDB Module

EventStoreDB is an event sourcing database that stores data in streams of immutable events.

Install

npm install @testcontainers/eventstoredb --save-dev

Examples

Start container:

it("should execute write and read", async () => {
  const container = await new EventStoreDBContainer().start();

  const client = EventStoreDBClient.connectionString(container.getConnectionString());

  await client.appendToStream("User-1", [
    {
      contentType: "application/json",
      data: { email: "[email protected]" },
      type: "UserCreated",
      id: "28ab6bca-d9ae-418b-a1af-eb65dd653c38",
      metadata: {
        someMetadata: "bar",
      },
    },
  ]);

  expect(await consumeSteamingRead(client.readStream("User-1"))).toEqual([
    expect.objectContaining({
      event: expect.objectContaining({
        data: {
          email: "[email protected]",
        },
        id: "28ab6bca-d9ae-418b-a1af-eb65dd653c38",
        isJson: true,
        metadata: {
          someMetadata: "bar",
        },
        revision: 0n,
        streamId: "User-1",
        type: "UserCreated",
      }),
    }),
  ]);

  await container.stop();
});

Subscribe to standard projection:

it("should use built-in projections", async () => {
  const container = await new EventStoreDBContainer().start();
  const client = EventStoreDBClient.connectionString(container.getConnectionString());

  await client.appendToStream("Todo-1", [
    {
      contentType: "application/json",
      data: { title: "Do something" },
      metadata: {},
      id: "7eccc3a7-0664-4348-a621-029125741e22",
      type: "TodoCreated",
    },
  ]);
  const stream = client.subscribeToStream("$ce-Todo", { resolveLinkTos: true });

  expect(await getStreamFirstEvent(stream)).toEqual(
    expect.objectContaining({
      event: expect.objectContaining({
        data: { title: "Do something" },
        id: "7eccc3a7-0664-4348-a621-029125741e22",
        isJson: true,
        metadata: {},
        revision: 0n,
        streamId: "Todo-1",
        type: "TodoCreated",
      }),
      link: expect.objectContaining({
        isJson: false,
        metadata: expect.objectContaining({
          $causedBy: "7eccc3a7-0664-4348-a621-029125741e22",
          $o: "Todo-1",
        }),
        revision: 0n,
        streamId: "$ce-Todo",
        type: "$>",
      }),
    })
  );
  await stream.unsubscribe();
  await container.stop();
});