Updated API tests to use strongly-typed Event Store type

Previously it was always taking the Event Store implementation which was forcing to do casting while setting up, which was not great. Fixed also Event Store wrapper to just override the needed methods passing the rest as they are. Without it, event store extensions (like MongoDB projections api) wouldn't work. Removed event store wrapper usage from E2E tests, as it was redundant: checks are only made on responses.
event-driven-io · Dec 29, 2024 · 6a18731 · 6a18731
1 parent cd245e9
commit 6a18731
Show file tree

Hide file tree

Showing 11 changed files with 50 additions and 62 deletions.
diff --git a/src/docs/snippets/gettingStarted/webApi/apiBDD.e2e.spec.ts b/src/docs/snippets/gettingStarted/webApi/apiBDD.e2e.spec.ts
@@ -4,7 +4,6 @@ import { ShoppingCartStatus } from './shoppingCart';
 import { shoppingCartApi } from './simpleApi';
 
 // #region getting-started-e2e-tests
-import { type EventStore } from '@event-driven-io/emmett';
 import { getEventStoreDBEventStore } from '@event-driven-io/emmett-esdb';
 import {
   ApiE2ESpecification,
@@ -29,8 +28,8 @@ void describe('ShoppingCart E2E', () => {
     esdbContainer = await new EventStoreDBContainer().start();
 
     given = ApiE2ESpecification.for(
-      (): EventStore => getEventStoreDBEventStore(esdbContainer.getClient()),
-      (eventStore: EventStore) =>
+      () => getEventStoreDBEventStore(esdbContainer.getClient()),
+      (eventStore) =>
         getApplication({
           apis: [
             shoppingCartApi(

diff --git a/src/docs/snippets/gettingStarted/webApi/apiBDD.int.spec.ts b/src/docs/snippets/gettingStarted/webApi/apiBDD.int.spec.ts
@@ -2,10 +2,7 @@ import { beforeEach, describe, it } from 'node:test';
 import type { PricedProductItem, ShoppingCartEvent } from '../events';
 import { shoppingCartApi } from './simpleApi';
 // #region getting-started-integration-tests
-import {
-  getInMemoryEventStore,
-  type EventStore,
-} from '@event-driven-io/emmett';
+import { getInMemoryEventStore } from '@event-driven-io/emmett';
 import {
   ApiSpecification,
   existingStream,
@@ -119,8 +116,8 @@ void describe('ShoppingCart', () => {
   const unitPrice = Math.random() * 10;
 
   const given = ApiSpecification.for<ShoppingCartEvent>(
-    (): EventStore => getInMemoryEventStore(),
-    (eventStore: EventStore) =>
+    () => getInMemoryEventStore(),
+    (eventStore) =>
       getApplication({
         apis: [
           shoppingCartApi(

diff --git a/src/docs/snippets/gettingStarted/webApi/apiBDDE2EGiven.ts b/src/docs/snippets/gettingStarted/webApi/apiBDDE2EGiven.ts
@@ -27,16 +27,15 @@ void describe('ShoppingCart E2E', () => {
 // #endregion test-container
 
 // #region given
-import { type EventStore } from '@event-driven-io/emmett';
 import { getEventStoreDBEventStore } from '@event-driven-io/emmett-esdb';
 import {
   ApiE2ESpecification,
   getApplication,
 } from '@event-driven-io/emmett-expressjs';
 
 const given = ApiE2ESpecification.for(
-  (): EventStore => getEventStoreDBEventStore(esdbContainer.getClient()),
-  (eventStore: EventStore) =>
+  () => getEventStoreDBEventStore(esdbContainer.getClient()),
+  (eventStore) =>
     getApplication({
       apis: [
         shoppingCartApi(

diff --git a/src/docs/snippets/gettingStarted/webApi/apiBDDE2ETest.ts b/src/docs/snippets/gettingStarted/webApi/apiBDDE2ETest.ts
@@ -1,4 +1,3 @@
-import { type EventStore } from '@event-driven-io/emmett';
 import {
   ApiE2ESpecification,
   getApplication,
@@ -15,8 +14,8 @@ const now = new Date();
 const unitPrice = Math.random() * 10;
 
 const given = ApiE2ESpecification.for(
-  (): EventStore => getEventStoreDBEventStore(esdbContainer.getClient()),
-  (eventStore: EventStore) =>
+  () => getEventStoreDBEventStore(esdbContainer.getClient()),
+  (eventStore) =>
     getApplication({
       apis: [
         shoppingCartApi(

diff --git a/src/docs/snippets/gettingStarted/webApi/apiBDDIntGiven.ts b/src/docs/snippets/gettingStarted/webApi/apiBDDIntGiven.ts
@@ -3,10 +3,7 @@ import type { ShoppingCartEvent } from '../events';
 import { shoppingCartApi } from './simpleApi';
 
 // #region given
-import {
-  getInMemoryEventStore,
-  type EventStore,
-} from '@event-driven-io/emmett';
+import { getInMemoryEventStore } from '@event-driven-io/emmett';
 import {
   ApiSpecification,
   getApplication,
@@ -16,8 +13,8 @@ const unitPrice = 100;
 const now = new Date();
 
 const given = ApiSpecification.for<ShoppingCartEvent>(
-  (): EventStore => getInMemoryEventStore(),
-  (eventStore: EventStore) =>
+  () => getInMemoryEventStore(),
+  (eventStore) =>
     getApplication({
       apis: [
         shoppingCartApi(

diff --git a/src/docs/snippets/gettingStarted/webApi/apiBDDIntTest.ts b/src/docs/snippets/gettingStarted/webApi/apiBDDIntTest.ts
@@ -1,7 +1,4 @@
-import {
-  getInMemoryEventStore,
-  type EventStore,
-} from '@event-driven-io/emmett';
+import { getInMemoryEventStore } from '@event-driven-io/emmett';
 import {
   ApiSpecification,
   getApplication,
@@ -18,8 +15,8 @@ const now = new Date();
 const unitPrice = Math.random() * 10;
 
 const given = ApiSpecification.for<ShoppingCartEvent>(
-  (): EventStore => getInMemoryEventStore(),
-  (eventStore: EventStore) =>
+  () => getInMemoryEventStore(),
+  (eventStore) =>
     getApplication({
       apis: [
         shoppingCartApi(

diff --git a/src/package-lock.json b/src/package-lock.json
diff --git a/src/packages/emmett-expressjs/src/testing/apiE2ESpecification.ts b/src/packages/emmett-expressjs/src/testing/apiE2ESpecification.ts
@@ -1,7 +1,6 @@
 import supertest, { type Response } from 'supertest';
 
 import type { EventStore } from '@event-driven-io/emmett';
-import { WrapEventStore } from '@event-driven-io/emmett';
 import assert from 'assert';
 import type { Application } from 'express';
 import type { TestRequest } from './apiSpecification';
@@ -17,13 +16,13 @@ export type ApiE2ESpecification = (...givenRequests: TestRequest[]) => {
 };
 
 export const ApiE2ESpecification = {
-  for: (
-    getEventStore: () => EventStore,
-    getApplication: (eventStore: EventStore) => Application,
+  for: <Store extends EventStore = EventStore>(
+    getEventStore: () => Store,
+    getApplication: (eventStore: Store) => Application,
   ): ApiE2ESpecification => {
     {
       return (...givenRequests: TestRequest[]) => {
-        const eventStore = WrapEventStore(getEventStore());
+        const eventStore = getEventStore();
         const application = getApplication(eventStore);
 
         return {

diff --git a/src/packages/emmett-expressjs/src/testing/apiSpecification.ts b/src/packages/emmett-expressjs/src/testing/apiSpecification.ts
@@ -85,9 +85,9 @@ export type ApiSpecification<EventType extends Event = Event> = (
 };
 
 export const ApiSpecification = {
-  for: <EventType extends Event = Event>(
-    getEventStore: () => EventStore,
-    getApplication: (eventStore: EventStore) => Application,
+  for: <EventType extends Event = Event, Store extends EventStore = EventStore>(
+    getEventStore: () => Store,
+    getApplication: (eventStore: Store) => Application,
   ): ApiSpecification<EventType> => {
     {
       return (...givenStreams: TestEventStream<EventType>[]) => {

diff --git a/src/packages/emmett-sqlite/package.json b/src/packages/emmett-sqlite/package.json
@@ -73,7 +73,7 @@
     "@types/sqlite3": "^3.1.11"
   },
   "peerDependencies": {
-    "@event-driven-io/emmett": "^0.23.0-alpha.7",
+    "@event-driven-io/emmett": "0.23.0-alpha.7",
     "sqlite3": "^5.1.7"
   }
 }
diff --git a/src/packages/emmett/src/testing/wrapEventStore.ts b/src/packages/emmett/src/testing/wrapEventStore.ts
@@ -30,6 +30,7 @@ export const WrapEventStore = <Store extends EventStore>(
   const appendedEvents = new Map<string, TestEventStream>();
 
   const wrapped = {
+    ...eventStore,
     aggregateStream<State, EventType extends Event>(
       streamName: string,
       options: AggregateStreamOptions<State, EventType>,