From 1b27368f54be31ebcd54945ddf08f7aa0dcf923e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Julian=20K=C3=B6nig?=
 <33655937+jkoenig134@users.noreply.github.com>
Date: Wed, 5 Mar 2025 15:50:34 +0100
Subject: [PATCH] `unsubscribeFromAllEvents` is not safe to be called in every
 module (#446)

* fix: call unsubscribeFromAllEvents internally for every module

* refactor: do not call unsubscribeFromAllEvents manually in every module

* fix: add override

* fix: test
---
 packages/app-runtime/src/modules/AppSyncModule.ts  |  2 +-
 .../src/modules/PushNotificationModule.ts          |  4 ----
 packages/app-runtime/src/modules/SSEModule.ts      |  2 +-
 .../src/modules/appEvents/MailReceivedModule.ts    |  4 ----
 .../appEvents/OnboardingChangeReceivedModule.ts    |  4 ----
 .../RelationshipTemplateProcessedModule.ts         |  4 ----
 .../IdentityDeletionProcessStatusChangedModule.ts  |  4 ----
 .../modules/runtimeEvents/MessageReceivedModule.ts |  4 ----
 .../runtimeEvents/RelationshipChangedModule.ts     |  4 ----
 .../test/runtime/RuntimeModuleLoadingTest.test.ts  |  2 +-
 .../src/extensibility/modules/RuntimeModule.ts     | 14 +++++++++++---
 .../runtime/src/modules/AttributeListenerModule.ts |  4 ----
 packages/runtime/src/modules/DeciderModule.ts      |  4 ----
 packages/runtime/src/modules/MessageModule.ts      |  4 ----
 packages/runtime/src/modules/NotificationModule.ts |  4 ----
 packages/runtime/src/modules/RequestModule.ts      |  4 ----
 16 files changed, 14 insertions(+), 54 deletions(-)

diff --git a/packages/app-runtime/src/modules/AppSyncModule.ts b/packages/app-runtime/src/modules/AppSyncModule.ts
index 5425f6cd8..bb62c647b 100644
--- a/packages/app-runtime/src/modules/AppSyncModule.ts
+++ b/packages/app-runtime/src/modules/AppSyncModule.ts
@@ -36,7 +36,7 @@ export class AppSyncModule extends AppRuntimeModule<AppSyncModuleConfiguration>
         }
     }
 
-    public stop(): void {
+    public override stop(): void {
         this.started = false;
         clearTimeout(this.syncTimeout);
     }
diff --git a/packages/app-runtime/src/modules/PushNotificationModule.ts b/packages/app-runtime/src/modules/PushNotificationModule.ts
index 13848765b..4c747748f 100644
--- a/packages/app-runtime/src/modules/PushNotificationModule.ts
+++ b/packages/app-runtime/src/modules/PushNotificationModule.ts
@@ -141,8 +141,4 @@ export class PushNotificationModule extends AppRuntimeModule<PushNotificationMod
         }
         return Result.ok(pushTokenResult.value);
     }
-
-    public stop(): void {
-        this.unsubscribeFromAllEvents();
-    }
 }
diff --git a/packages/app-runtime/src/modules/SSEModule.ts b/packages/app-runtime/src/modules/SSEModule.ts
index 1f9fd2d75..1e1cdd01f 100644
--- a/packages/app-runtime/src/modules/SSEModule.ts
+++ b/packages/app-runtime/src/modules/SSEModule.ts
@@ -100,7 +100,7 @@ export class SSEModule extends AppRuntimeModule<SSEModuleConfiguration> {
         }
     }
 
-    public stop(): void {
+    public override stop(): void {
         for (const eventsource of Object.values(this.eventSource).filter((eventsource) => typeof eventsource !== "undefined")) {
             eventsource.close();
         }
diff --git a/packages/app-runtime/src/modules/appEvents/MailReceivedModule.ts b/packages/app-runtime/src/modules/appEvents/MailReceivedModule.ts
index 480bc08d8..cb88ba1fe 100644
--- a/packages/app-runtime/src/modules/appEvents/MailReceivedModule.ts
+++ b/packages/app-runtime/src/modules/appEvents/MailReceivedModule.ts
@@ -28,8 +28,4 @@ export class MailReceivedModule extends AppRuntimeModule<MailReceivedModuleConfi
             }
         });
     }
-
-    public stop(): void {
-        this.unsubscribeFromAllEvents();
-    }
 }
diff --git a/packages/app-runtime/src/modules/appEvents/OnboardingChangeReceivedModule.ts b/packages/app-runtime/src/modules/appEvents/OnboardingChangeReceivedModule.ts
index 7408b7c19..88fb0a078 100644
--- a/packages/app-runtime/src/modules/appEvents/OnboardingChangeReceivedModule.ts
+++ b/packages/app-runtime/src/modules/appEvents/OnboardingChangeReceivedModule.ts
@@ -54,8 +54,4 @@ export class OnboardingChangeReceivedModule extends AppRuntimeModule<OnboardingC
             }
         });
     }
-
-    public stop(): void {
-        this.unsubscribeFromAllEvents();
-    }
 }
diff --git a/packages/app-runtime/src/modules/appEvents/RelationshipTemplateProcessedModule.ts b/packages/app-runtime/src/modules/appEvents/RelationshipTemplateProcessedModule.ts
index 3e24de180..e9a252b43 100644
--- a/packages/app-runtime/src/modules/appEvents/RelationshipTemplateProcessedModule.ts
+++ b/packages/app-runtime/src/modules/appEvents/RelationshipTemplateProcessedModule.ts
@@ -85,8 +85,4 @@ export class RelationshipTemplateProcessedModule extends AppRuntimeModule<Relati
             }
         }
     }
-
-    public stop(): void {
-        this.unsubscribeFromAllEvents();
-    }
 }
diff --git a/packages/app-runtime/src/modules/runtimeEvents/IdentityDeletionProcessStatusChangedModule.ts b/packages/app-runtime/src/modules/runtimeEvents/IdentityDeletionProcessStatusChangedModule.ts
index be0319832..27005d985 100644
--- a/packages/app-runtime/src/modules/runtimeEvents/IdentityDeletionProcessStatusChangedModule.ts
+++ b/packages/app-runtime/src/modules/runtimeEvents/IdentityDeletionProcessStatusChangedModule.ts
@@ -58,8 +58,4 @@ export class IdentityDeletionProcessStatusChangedModule extends AppRuntimeModule
         if (!publishEvent) return;
         this.runtime.eventBus.publish(new LocalAccountDeletionDateChangedEvent(eventTargetAddress, LocalAccountMapper.toLocalAccountDTO(localAccount)));
     }
-
-    public override stop(): Promise<void> | void {
-        this.unsubscribeFromAllEvents();
-    }
 }
diff --git a/packages/app-runtime/src/modules/runtimeEvents/MessageReceivedModule.ts b/packages/app-runtime/src/modules/runtimeEvents/MessageReceivedModule.ts
index dbe223aa4..17156a186 100644
--- a/packages/app-runtime/src/modules/runtimeEvents/MessageReceivedModule.ts
+++ b/packages/app-runtime/src/modules/runtimeEvents/MessageReceivedModule.ts
@@ -28,8 +28,4 @@ export class MessageReceivedModule extends AppRuntimeModule<MessageReceivedModul
                 break;
         }
     }
-
-    public stop(): void {
-        this.unsubscribeFromAllEvents();
-    }
 }
diff --git a/packages/app-runtime/src/modules/runtimeEvents/RelationshipChangedModule.ts b/packages/app-runtime/src/modules/runtimeEvents/RelationshipChangedModule.ts
index f366a5b5f..5b8869bfb 100644
--- a/packages/app-runtime/src/modules/runtimeEvents/RelationshipChangedModule.ts
+++ b/packages/app-runtime/src/modules/runtimeEvents/RelationshipChangedModule.ts
@@ -41,8 +41,4 @@ export class RelationshipChangedModule extends AppRuntimeModule<RelationshipChan
         const eventToPublish = new OnboardingChangeReceivedEvent(event.eventTargetAddress, relationship, lastAuditLogEntry, relationshipDVO);
         this.runtime.eventBus.publish(eventToPublish);
     }
-
-    public stop(): void {
-        this.unsubscribeFromAllEvents();
-    }
 }
diff --git a/packages/app-runtime/test/runtime/RuntimeModuleLoadingTest.test.ts b/packages/app-runtime/test/runtime/RuntimeModuleLoadingTest.test.ts
index 6250ea36a..cb7bfcf2c 100644
--- a/packages/app-runtime/test/runtime/RuntimeModuleLoadingTest.test.ts
+++ b/packages/app-runtime/test/runtime/RuntimeModuleLoadingTest.test.ts
@@ -29,7 +29,7 @@ describe("RuntimeModuleLoading", function () {
                 moduleStarted = true;
             }
 
-            public stop(): void {
+            public override stop(): void {
                 moduleStopped = true;
             }
         }
diff --git a/packages/runtime/src/extensibility/modules/RuntimeModule.ts b/packages/runtime/src/extensibility/modules/RuntimeModule.ts
index 31ec7e331..f1996d491 100644
--- a/packages/runtime/src/extensibility/modules/RuntimeModule.ts
+++ b/packages/runtime/src/extensibility/modules/RuntimeModule.ts
@@ -14,7 +14,13 @@ export abstract class RuntimeModule<TConfig extends ModuleConfiguration = Module
         public readonly runtime: TRuntime,
         public readonly configuration: TConfig,
         public readonly logger: ILogger
-    ) {}
+    ) {
+        const originalStopMethod = this.stop;
+        this.stop = async () => {
+            await originalStopMethod.call(this);
+            this.#unsubscribeFromAllEvents();
+        };
+    }
 
     public get name(): string {
         return this.configuration.name;
@@ -26,7 +32,9 @@ export abstract class RuntimeModule<TConfig extends ModuleConfiguration = Module
 
     public abstract init(): Promise<void> | void;
     public abstract start(): Promise<void> | void;
-    public abstract stop(): Promise<void> | void;
+    public stop(): Promise<void> | void {
+        // Nothing to do here
+    }
 
     private readonly subscriptionIds: number[] = [];
 
@@ -35,7 +43,7 @@ export abstract class RuntimeModule<TConfig extends ModuleConfiguration = Module
         this.subscriptionIds.push(subscriptionId);
     }
 
-    protected unsubscribeFromAllEvents(): void {
+    #unsubscribeFromAllEvents(): void {
         this.subscriptionIds.forEach((id) => this.runtime.eventBus.unsubscribe(id));
         this.subscriptionIds.splice(0);
     }
diff --git a/packages/runtime/src/modules/AttributeListenerModule.ts b/packages/runtime/src/modules/AttributeListenerModule.ts
index c483da51a..3990bf485 100644
--- a/packages/runtime/src/modules/AttributeListenerModule.ts
+++ b/packages/runtime/src/modules/AttributeListenerModule.ts
@@ -160,8 +160,4 @@ export class AttributeListenerModule extends RuntimeModule {
             }
         }
     }
-
-    public stop(): void {
-        this.unsubscribeFromAllEvents();
-    }
 }
diff --git a/packages/runtime/src/modules/DeciderModule.ts b/packages/runtime/src/modules/DeciderModule.ts
index 60fdca051..b5c74b5e6 100644
--- a/packages/runtime/src/modules/DeciderModule.ts
+++ b/packages/runtime/src/modules/DeciderModule.ts
@@ -239,10 +239,6 @@ export class DeciderModule extends RuntimeModule<DeciderModuleConfiguration> {
                 break;
         }
     }
-
-    public stop(): void {
-        this.unsubscribeFromAllEvents();
-    }
 }
 
 function containsItem(objectWithItems: { items: any[] }, callback: (element: any) => boolean): boolean {
diff --git a/packages/runtime/src/modules/MessageModule.ts b/packages/runtime/src/modules/MessageModule.ts
index d457fe0f6..a06f68c81 100644
--- a/packages/runtime/src/modules/MessageModule.ts
+++ b/packages/runtime/src/modules/MessageModule.ts
@@ -45,8 +45,4 @@ export class MessageModule extends RuntimeModule<MessageModuleConfiguration> {
         this.runtime.eventBus.publish(new RelationshipEvent(messageReceivedEvent.eventTargetAddress, event, relationship));
         this.logger.trace(`Published RelationshipEvent for ${message.id} to ${relationship.id}`);
     }
-
-    public stop(): void {
-        this.unsubscribeFromAllEvents();
-    }
 }
diff --git a/packages/runtime/src/modules/NotificationModule.ts b/packages/runtime/src/modules/NotificationModule.ts
index a5da641f6..923a7380a 100644
--- a/packages/runtime/src/modules/NotificationModule.ts
+++ b/packages/runtime/src/modules/NotificationModule.ts
@@ -43,8 +43,4 @@ export class NotificationModule extends RuntimeModule {
             return;
         }
     }
-
-    public stop(): void {
-        this.unsubscribeFromAllEvents();
-    }
 }
diff --git a/packages/runtime/src/modules/RequestModule.ts b/packages/runtime/src/modules/RequestModule.ts
index fa28c74a3..befc85684 100644
--- a/packages/runtime/src/modules/RequestModule.ts
+++ b/packages/runtime/src/modules/RequestModule.ts
@@ -354,8 +354,4 @@ export class RequestModule extends RuntimeModule {
             return;
         }
     }
-
-    public stop(): void {
-        this.unsubscribeFromAllEvents();
-    }
 }