fix(store): complete action results on destroy (#2282)

We complete the `InternalDispatchedActionResults` once the application is destroyed
to ensure there are no active subscribers after resources have been cleaned up.

CHANGELOG.md

@@ -7,6 +7,7 @@ $ npm install @ngxs/store@dev
 ### To become next patch version
 
 - Fix(store): Add root store initializer guard [#2278](https://github.com/ngxs/store/pull/2278)
+- Fix(store): Complete action results on destroy [#2282](https://github.com/ngxs/store/pull/2282)
 
 ### 19.0.0 2024-12-3
 

packages/store/internals/src/state-stream.ts

@@ -21,9 +21,12 @@ export class ɵStateStream extends ɵOrderedBehaviorSubject<ɵPlainObject> imple
   }
 
   ngOnDestroy(): void {
-    // The StateStream should never emit values once the root view is removed,
-    // such as when the `NgModuleRef.destroy()` method is called. This is crucial
-    // for preventing memory leaks in server-side rendered apps, where a new StateStream
+    // Complete the subject once the root injector is destroyed to ensure
+    // there are no active subscribers that would receive events or perform
+    // any actions after the application is destroyed.
+    // The `StateStream` should never emit values once the root view is removed,
+    // such as when the `ApplicationRef.destroy()` method is called. This is crucial
+    // for preventing memory leaks in server-side rendered apps, where a new `StateStream`
     // is created for each HTTP request. If users forget to unsubscribe from `store.select`
     // or `store.subscribe`, it can result in significant memory leaks in SSR apps.
     this.complete();

packages/store/src/actions-stream.ts

@@ -39,6 +39,9 @@ export class InternalActions extends ɵOrderedSubject<ActionContext> implements
   }
 
   ngOnDestroy(): void {
+    // Complete the subject once the root injector is destroyed to ensure
+    // there are no active subscribers that would receive events or perform
+    // any actions after the application is destroyed.
     this.complete();
   }
 }

packages/store/src/internal/action-results.ts

@@ -0,0 +1,23 @@
+import { Injectable, OnDestroy } from '@angular/core';
+import { Subject } from 'rxjs';
+
+import type { ActionContext } from '../actions-stream';
+
+/**
+ * Internal Action result stream that is emitted when an action is completed.
+ * This is used as a method of returning the action result to the dispatcher
+ * for the observable returned by the dispatch(...) call.
+ * The dispatcher then asynchronously pushes the result from this stream onto the main action stream as a result.
+ */
+@Injectable({ providedIn: 'root' })
+export class InternalDispatchedActionResults
+  extends Subject<ActionContext>
+  implements OnDestroy
+{
+  ngOnDestroy(): void {
+    // Complete the subject once the root injector is destroyed to ensure
+    // there are no active subscribers that would receive events or perform
+    // any actions after the application is destroyed.
+    this.complete();
+  }
+}

packages/store/src/internal/dispatcher.ts

@@ -1,24 +1,16 @@
 import { inject, Injectable, Injector, NgZone, runInInjectionContext } from '@angular/core';
-import { forkJoin, Observable, of, Subject, throwError } from 'rxjs';
+import { forkJoin, Observable, of, throwError } from 'rxjs';
 import { filter, map, mergeMap, shareReplay, take } from 'rxjs/operators';
 
 import { getActionTypeFromInstance } from '@ngxs/store/plugins';
 import { ɵPlainObject, ɵStateStream } from '@ngxs/store/internals';
 
-import { ActionContext, ActionStatus, InternalActions } from '../actions-stream';
 import { PluginManager } from '../plugin-manager';
-import { InternalNgxsExecutionStrategy } from '../execution/internal-ngxs-execution-strategy';
 import { leaveNgxs } from '../operators/leave-ngxs';
 import { fallbackSubscriber } from './fallback-subscriber';
-
-/**
- * Internal Action result stream that is emitted when an action is completed.
- * This is used as a method of returning the action result to the dispatcher
- * for the observable returned by the dispatch(...) call.
- * The dispatcher then asynchronously pushes the result from this stream onto the main action stream as a result.
- */
-@Injectable({ providedIn: 'root' })
-export class InternalDispatchedActionResults extends Subject<ActionContext> {}
+import { InternalDispatchedActionResults } from './action-results';
+import { ActionContext, ActionStatus, InternalActions } from '../actions-stream';
+import { InternalNgxsExecutionStrategy } from '../execution/internal-ngxs-execution-strategy';
 
 @Injectable({ providedIn: 'root' })
 export class InternalDispatcher {

packages/store/src/internal/state-factory.ts

@@ -42,7 +42,7 @@ import {
 } from './internals';
 import { NgxsActionRegistry } from '../actions/action-registry';
 import { ActionContext, ActionStatus, InternalActions } from '../actions-stream';
-import { InternalDispatchedActionResults } from '../internal/dispatcher';
+import { InternalDispatchedActionResults } from '../internal/action-results';
 import { ensureStateNameIsUnique, ensureStatesAreDecorated } from '../utils/store-validators';
 import { ensureStateClassIsInjectable } from '../ivy/ivy-enabled-in-dev-mode';
 import { NgxsUnhandledActionsLogger } from '../dev-features/ngxs-unhandled-actions-logger';