fix!: rename delivedToListeners to deliveredToListeners (#2)

Fix typo in field name throughout codebase and add database migrations
to rename the column from delived_to_listeners to delivered_to_listeners.

BREAKING CHANGE: Existing databases require running the new migration
to rename the column.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude <noreply@anthropic.com>

Author: jtomaszewski

packages/core/src/model/inbox-outbox-transport-event.interface.ts

@@ -2,7 +2,7 @@ export interface InboxOutboxTransportEvent {
   id: number;
   eventName: string;
   eventPayload: any;
-  delivedToListeners: string[];
+  deliveredToListeners: string[];
   readyToRetryAfter: number | null;
   expireAt: number;
   insertedAt: number;

packages/core/src/poller/retryable-inbox-outbox-event.poller.ts

@@ -58,7 +58,7 @@ export class RetryableInboxOutboxEventPoller implements OnModuleInit {
     return Promise.allSettled(
       inboxOutboxTransportEvents.map((inboxOutboxTransportEvent) => {
         const notDeliveredToListeners = this.transactionalEventEmitter.getListeners(inboxOutboxTransportEvent.eventName).filter((listener) => {
-          return !inboxOutboxTransportEvent.delivedToListeners.includes(listener.getName());
+          return !inboxOutboxTransportEvent.deliveredToListeners.includes(listener.getName());
         });
 
         return this.inboxOutboxEventProcessor.process(

packages/core/src/processor/inbox-outbox-event.processor.ts

@@ -34,7 +34,7 @@ export class InboxOutboxEventProcessor implements InboxOutboxEventProcessorContr
     }
 
     if (deliveredToListeners.length > 0) {
-      inboxOutboxTransportEvent.delivedToListeners.push(...deliveredToListeners);
+      inboxOutboxTransportEvent.deliveredToListeners.push(...deliveredToListeners);
       await databaseDriver.persist(inboxOutboxTransportEvent);
     }
 

packages/core/src/test/unit/inbox-outbox-event-processor.spec.ts

@@ -68,7 +68,7 @@ describe('InboxOutboxEventProcessor', () => {
 
         const inboxOutboxTransportEvent : InboxOutboxTransportEvent = {
             readyToRetryAfter: new Date().getTime(),
-            delivedToListeners: [],
+            deliveredToListeners: [],
             eventName: 'newEvent',
             eventPayload: {},
             expireAt: new Date().getTime() + 1000,
@@ -116,7 +116,7 @@ describe('InboxOutboxEventProcessor', () => {
 
         const inboxOutboxTransportEvent : InboxOutboxTransportEvent = {
             readyToRetryAfter: new Date().getTime(),
-            delivedToListeners: [],
+            deliveredToListeners: [],
             eventName: 'newEvent',
             eventPayload: {},
             expireAt: new Date().getTime() + 1000,

packages/mikroorm-driver/src/migrations/MigrationInboxOutbox1733250000.ts

@@ -0,0 +1,23 @@
+import { Migration } from '@mikro-orm/migrations';
+
+export class MigrationInboxOutbox1733250000 extends Migration {
+  async up(): Promise<void> {
+    this.addSql(
+      this.getKnex()
+        .schema.alterTable('inbox_outbox_transport_event', (table) => {
+          table.renameColumn('delived_to_listeners', 'delivered_to_listeners');
+        })
+        .toQuery(),
+    );
+  }
+
+  async down(): Promise<void> {
+    this.addSql(
+      this.getKnex()
+        .schema.alterTable('inbox_outbox_transport_event', (table) => {
+          table.renameColumn('delivered_to_listeners', 'delived_to_listeners');
+        })
+        .toQuery(),
+    );
+  }
+}

packages/mikroorm-driver/src/migrations/migrations.ts

@@ -1,3 +1,4 @@
 import { MigrationInboxOutbox1708527074 } from "./MigrationInboxOutbox1708527074";
- 
-export const InboxOutboxMigrations = [MigrationInboxOutbox1708527074];
+import { MigrationInboxOutbox1733250000 } from "./MigrationInboxOutbox1733250000";
+
+export const InboxOutboxMigrations = [MigrationInboxOutbox1708527074, MigrationInboxOutbox1733250000];

packages/mikroorm-driver/src/model/mikroorm-inbox-outbox-transport-event.model.ts

@@ -18,8 +18,9 @@ export class MikroOrmInboxOutboxTransportEvent implements InboxOutboxTransportEv
 
   @Property({
     type: 'json',
+    fieldName: 'delivered_to_listeners',
   })
-  delivedToListeners: string[];
+  deliveredToListeners: string[];
 
   @Property({ type: 'bigint' })
   readyToRetryAfter: number;
@@ -37,7 +38,7 @@ export class MikroOrmInboxOutboxTransportEvent implements InboxOutboxTransportEv
     event.expireAt = expireAt;
     event.readyToRetryAfter = readyToRetryAfter;
     event.insertedAt = Date.now();
-    event.delivedToListeners = [];
+    event.deliveredToListeners = [];
     return event;
   }
 }

packages/mikroorm-driver/src/test/mikroorm-inbox-outbox-transport-event.spec.ts

@@ -52,7 +52,7 @@ describe('MikroOrmInboxOutboxTransportEvent', () => {
       expect(event.eventPayload).toEqual(eventPayload);
       expect(event.expireAt).toBe(expireAt);
       expect(event.readyToRetryAfter).toBe(readyToRetryAfter);
-      expect(event.delivedToListeners).toEqual([]);
+      expect(event.deliveredToListeners).toEqual([]);
       expect(event.insertedAt).toBeDefined();
       expect(event.insertedAt).toBeLessThanOrEqual(Date.now());
     });
@@ -88,7 +88,7 @@ describe('MikroOrmInboxOutboxTransportEvent', () => {
       expect(retrieved).toBeDefined();
       expect(retrieved!.eventName).toBe('PersistenceTest');
       expect(retrieved!.eventPayload).toEqual(eventPayload);
-      expect(retrieved!.delivedToListeners).toEqual([]);
+      expect(retrieved!.deliveredToListeners).toEqual([]);
     });
 
     it('should persist JSON payload correctly', async () => {
@@ -116,22 +116,22 @@ describe('MikroOrmInboxOutboxTransportEvent', () => {
       expect(retrieved!.eventPayload).toEqual(complexPayload);
     });
 
-    it('should persist delivedToListeners as JSON array', async () => {
+    it('should persist deliveredToListeners as JSON array', async () => {
       const event = new MikroOrmInboxOutboxTransportEvent().create(
         'ListenersTest',
         {},
         Date.now() + 60000,
         Date.now() + 5000,
       );
-      event.delivedToListeners = ['listener1', 'listener2'];
+      event.deliveredToListeners = ['listener1', 'listener2'];
 
       orm.em.persist(event);
       await orm.em.flush();
       orm.em.clear();
 
       const retrieved = await orm.em.findOne(MikroOrmInboxOutboxTransportEvent, { eventName: 'ListenersTest' });
 
-      expect(retrieved!.delivedToListeners).toEqual(['listener1', 'listener2']);
+      expect(retrieved!.deliveredToListeners).toEqual(['listener1', 'listener2']);
     });
 
     it('should generate auto-increment id on persist', async () => {

packages/typeorm-driver/src/migrations/MigrationInboxOutbox1733250000.ts

@@ -0,0 +1,19 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+
+export class MigrationInboxOutbox1733250000 implements MigrationInterface {
+  async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.renameColumn(
+      'inbox_outbox_transport_event',
+      'delived_to_listeners',
+      'delivered_to_listeners'
+    );
+  }
+
+  async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.renameColumn(
+      'inbox_outbox_transport_event',
+      'delivered_to_listeners',
+      'delived_to_listeners'
+    );
+  }
+}

packages/typeorm-driver/src/migrations/index.ts

@@ -1,3 +1,4 @@
 import { MigrationInboxOutbox1726154235704 } from "./MigrationInboxOutbox1726154235704";
+import { MigrationInboxOutbox1733250000 } from "./MigrationInboxOutbox1733250000";
 
-export const InboxOutboxTransportEventMigrations = [MigrationInboxOutbox1726154235704]
+export const InboxOutboxTransportEventMigrations = [MigrationInboxOutbox1726154235704, MigrationInboxOutbox1733250000]