fix: Do not expose internal stores to extensions

packages/rx-effects/src/effect.ts

@@ -66,7 +66,7 @@ export type Effect<Event, Result = void, ErrorType = Error> = EffectState<
   readonly destroy: () => void;
 };
 
-const PENDING_COUNT_STATE = declareState(0);
+const PENDING_COUNT_STATE = declareState(0, { internal: true });
 const increaseCount = (count: number): number => count + 1;
 const decreaseCount = (count: number): number => count - 1;
 

packages/rx-effects/src/stateDeclaration.ts

@@ -44,6 +44,9 @@ export type StateDeclarationOptions<State> = Readonly<{
 
   /** A comparator for detecting changes between old and new states */
   stateComparator?: (prevState: State, nextState: State) => boolean;
+
+  /** @internal */
+  internal?: boolean;
 }>;
 
 /**
@@ -56,7 +59,7 @@ export function declareState<State>(
   stateOrFactory: State | StateFactory<State>,
   options?: StateDeclarationOptions<State>,
 ): StateDeclaration<State> {
-  const { name, stateComparator } = options ?? {};
+  const { name, stateComparator, internal } = options ?? {};
 
   let initialState: State;
   let stateFactory: StateFactory<State>;
@@ -79,7 +82,7 @@ export function declareState<State>(
 
   const storeFactory = (values?: Partial<State>): Store<State> => {
     const state = stateFactory(values);
-    return createStore(state, { name, stateComparator });
+    return createStore(state, { name, stateComparator, internal });
   };
 
   return {

packages/rx-effects/src/store.ts

@@ -3,6 +3,7 @@ import { Controller } from './controller';
 import { StateMutation } from './stateMutation';
 import { mapQuery, StateQuery, StateQueryOptions } from './stateQuery';
 import { STORE_EVENT_BUS } from './storeEvents';
+import { setInternalStoreFlag } from './storeMetadata';
 import { DEFAULT_COMPARATOR, isReadonlyArray } from './utils';
 
 let STORE_SEQ_NUMBER = 0;
@@ -67,6 +68,9 @@ export type StoreOptions<State> = Readonly<{
 
   /** A comparator for detecting changes between old and new states */
   stateComparator?: (prevState: State, nextState: State) => boolean;
+
+  /** @internal */
+  internal?: boolean;
 }>;
 
 /**
@@ -180,6 +184,10 @@ export function createStore<State>(
     }
   }
 
+  if (options?.internal) {
+    setInternalStoreFlag(store);
+  }
+
   STORE_EVENT_BUS.next({ type: 'created', store });
 
   return store;

packages/rx-effects/src/storeExtensions.test.ts

@@ -1,5 +1,8 @@
+import { createAction } from './action';
+import { createScope } from './scope';
 import { createStore } from './store';
 import { registerStoreExtension } from './storeExtensions';
+import { createStoreLoggerExtension } from './storeLoggerExtension';
 
 describe('registerStoreExtension()', () => {
   it('should register an extension', () => {
@@ -22,4 +25,16 @@ describe('registerStoreExtension()', () => {
     createStore<number>(0, { name: 'test' });
     expect.assertions(0);
   });
+
+  it('should not emit events from internal stores', () => {
+    const eventHandler = jest.fn();
+
+    registerStoreExtension(() => ({
+      onStoreEvent: eventHandler,
+    }));
+
+    createStore<number>(0, { name: 'test', internal: true });
+
+    expect(eventHandler).toBeCalledTimes(0);
+  });
 });

packages/rx-effects/src/storeExtensions.ts

@@ -1,6 +1,6 @@
 import { Subscription } from 'rxjs';
 import { STORE_EVENT_BUS, StoreEvent } from './storeEvents';
-import { getStateMutationMetadata } from './storeMetadata';
+import { getStateMutationMetadata, isInternalStore } from './storeMetadata';
 
 export type StoreExtensionApi = Readonly<{
   getStateMutationMetadata: typeof getStateMutationMetadata;
@@ -20,6 +20,8 @@ export function registerStoreExtension(
   const middleware = extension(api);
 
   return STORE_EVENT_BUS.subscribe((event) => {
-    middleware.onStoreEvent?.(event);
+    if (middleware.onStoreEvent && !isInternalStore(event.store)) {
+      middleware.onStoreEvent(event);
+    }
   });
 }

packages/rx-effects/src/storeLoggerExtension.test.ts

@@ -1,3 +1,5 @@
+import { createAction } from './action';
+import { createScope } from './scope';
 import { StateMutation } from './stateMutation';
 import { createStore } from './store';
 import { createStoreActions } from './storeActions';
@@ -62,4 +64,19 @@ describe('createStoreLoggerExtension()', () => {
     createStore<number>(0);
     expect(logger).nthCalledWith(1, expect.stringMatching(/^#\d/), 'created');
   });
+
+  it('should not log events from internal stores', () => {
+    const logger = jest.fn();
+
+    registerStoreExtension(createStoreLoggerExtension(logger));
+
+    const scope = createScope();
+    const action = createAction<number>();
+    scope.handleAction(action, () => {
+      // Do nothing
+    });
+    action(1);
+
+    expect(logger).toBeCalledTimes(0);
+  });
 });

packages/rx-effects/src/storeMetadata.ts

@@ -1,6 +1,8 @@
 import { StateMutation } from './stateMutation';
+import { Store } from './store';
 
 const MUTATION_NAME_SYMBOL = Symbol();
+const INTERNAL_STORE_SYMBOL = Symbol();
 
 export type StateMutationMetadata = Readonly<{
   name?: string;
@@ -21,3 +23,11 @@ export function setStateMutationName<State>(
 ): void {
   (mutation as any)[MUTATION_NAME_SYMBOL] = name;
 }
+
+export function isInternalStore(store: Store<any>): boolean {
+  return (store as any)[INTERNAL_STORE_SYMBOL] === true;
+}
+
+export function setInternalStoreFlag(store: Store<any>): void {
+  (store as any)[INTERNAL_STORE_SYMBOL] = true;
+}