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

@@ -36,7 +36,7 @@ export class AppSyncModule extends AppRuntimeModule<AppSyncModuleConfiguration>
         }
     }
 
-    public stop(): void {
+    public override stop(): void {
         this.started = false;
         clearTimeout(this.syncTimeout);
     }

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();
-    }
 }

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();
         }

packages/app-runtime/src/modules/appEvents/MailReceivedModule.ts

@@ -28,8 +28,4 @@ export class MailReceivedModule extends AppRuntimeModule<MailReceivedModuleConfi
             }
         });
     }
-
-    public stop(): void {
-        this.unsubscribeFromAllEvents();
-    }
 }

packages/app-runtime/src/modules/appEvents/OnboardingChangeReceivedModule.ts

@@ -54,8 +54,4 @@ export class OnboardingChangeReceivedModule extends AppRuntimeModule<OnboardingC
             }
         });
     }
-
-    public stop(): void {
-        this.unsubscribeFromAllEvents();
-    }
 }

packages/app-runtime/src/modules/appEvents/RelationshipTemplateProcessedModule.ts

@@ -85,8 +85,4 @@ export class RelationshipTemplateProcessedModule extends AppRuntimeModule<Relati
             }
         }
     }
-
-    public stop(): void {
-        this.unsubscribeFromAllEvents();
-    }
 }

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();
-    }
 }

packages/app-runtime/src/modules/runtimeEvents/MessageReceivedModule.ts

@@ -28,8 +28,4 @@ export class MessageReceivedModule extends AppRuntimeModule<MessageReceivedModul
                 break;
         }
     }
-
-    public stop(): void {
-        this.unsubscribeFromAllEvents();
-    }
 }

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();
-    }
 }

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;
             }
         }

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);
     }

packages/runtime/src/modules/AttributeListenerModule.ts

@@ -160,8 +160,4 @@ export class AttributeListenerModule extends RuntimeModule {
             }
         }
     }
-
-    public stop(): void {
-        this.unsubscribeFromAllEvents();
-    }
 }

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 {

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();
-    }
 }

packages/runtime/src/modules/NotificationModule.ts

@@ -43,8 +43,4 @@ export class NotificationModule extends RuntimeModule {
             return;
         }
     }
-
-    public stop(): void {
-        this.unsubscribeFromAllEvents();
-    }
 }

packages/runtime/src/modules/RequestModule.ts

@@ -354,8 +354,4 @@ export class RequestModule extends RuntimeModule {
             return;
         }
     }
-
-    public stop(): void {
-        this.unsubscribeFromAllEvents();
-    }
 }