feat(auth): add injectable reducers (#2454)

* feat(auth): add injectable reducers

* feat(auth): export individual selector factories

* use reducers from token

libs/auth/state/src/auth-state.module.ts

@@ -14,14 +14,12 @@ import { DaffAuthEffects } from './effects/auth.effects';
 import { DaffAuthLoginEffects } from './effects/login.effects';
 import { DaffAuthRegisterEffects } from './effects/register.effects';
 import { DaffAuthResetPasswordEffects } from './effects/reset-password.effects';
-import {
-  DAFF_AUTH_STORE_FEATURE_KEY,
-  daffAuthReducers,
-} from './reducers/public_api';
+import { DAFF_AUTH_STORE_FEATURE_KEY } from './reducers/public_api';
+import { DAFF_AUTH_REDUCERS } from './reducers/token/reducers.token';
 
 @NgModule({
   imports: [
-    StoreModule.forFeature(DAFF_AUTH_STORE_FEATURE_KEY, daffAuthReducers),
+    StoreModule.forFeature(DAFF_AUTH_STORE_FEATURE_KEY, DAFF_AUTH_REDUCERS),
     EffectsModule.forFeature([
       DaffAuthEffects,
       DaffAuthLoginEffects,

libs/auth/state/src/facades/auth/facade.ts

@@ -9,7 +9,7 @@ import { Observable } from 'rxjs';
 import { DaffStateError } from '@daffodil/core/state';
 
 import { DaffAuthStateRootSlice } from '../../reducers/public_api';
-import { getAuthSelectors } from '../../selectors/auth/auth.selector';
+import { daffAuthSelectorFactory } from '../../selectors/auth/auth.selector';
 import { DaffAuthFacadeInterface } from './facade.interface';
 
 /**
@@ -28,7 +28,7 @@ export class DaffAuthFacade implements DaffAuthFacadeInterface {
       selectLoading,
       selectErrors,
       selectAuthLoggedIn,
-    } = getAuthSelectors();
+    } = daffAuthSelectorFactory();
 
     this.loading$ = this.store.pipe(select(selectLoading));
     this.errors$ = this.store.pipe(select(selectErrors));

libs/auth/state/src/facades/login/facade.ts

@@ -9,7 +9,7 @@ import { Observable } from 'rxjs';
 import { DaffStateError } from '@daffodil/core/state';
 
 import { DaffAuthStateRootSlice } from '../../reducers/public_api';
-import { getDaffAuthLoginSelectors } from '../../selectors/login/login.selector';
+import { daffAuthLoginSelectorFactory } from '../../selectors/login/login.selector';
 import { DaffAuthLoginFacadeInterface } from './facade.interface';
 
 /**
@@ -26,7 +26,7 @@ export class DaffAuthLoginFacade implements DaffAuthLoginFacadeInterface {
     const {
       selectLoading,
       selectErrors,
-    } = getDaffAuthLoginSelectors();
+    } = daffAuthLoginSelectorFactory();
 
     this.loading$ = this.store.pipe(select(selectLoading));
     this.errors$ = this.store.pipe(select(selectErrors));

libs/auth/state/src/facades/register/facade.ts

@@ -9,7 +9,7 @@ import { Observable } from 'rxjs';
 import { DaffStateError } from '@daffodil/core/state';
 
 import { DaffAuthStateRootSlice } from '../../reducers/public_api';
-import { getDaffAuthRegisterSelectors } from '../../selectors/register/register.selector';
+import { daffAuthRegisterSelectorFactory } from '../../selectors/register/register.selector';
 import { DaffAuthRegisterFacadeInterface } from './facade.interface';
 
 /**
@@ -26,7 +26,7 @@ export class DaffAuthRegisterFacade implements DaffAuthRegisterFacadeInterface {
     const {
       selectLoading,
       selectErrors,
-    } = getDaffAuthRegisterSelectors();
+    } = daffAuthRegisterSelectorFactory();
 
     this.loading$ = this.store.pipe(select(selectLoading));
     this.errors$ = this.store.pipe(select(selectErrors));

libs/auth/state/src/facades/reset-password/facade.ts

@@ -10,7 +10,7 @@ import { DaffAuthResetPasswordInfo } from '@daffodil/auth';
 import { DaffStateError } from '@daffodil/core/state';
 
 import { DaffAuthStateRootSlice } from '../../reducers/public_api';
-import { getDaffAuthResetPasswordSelectors } from '../../selectors/reset-password/selector';
+import { daffAuthResetPasswordSelectorFactory } from '../../selectors/reset-password/selector';
 import { DaffAuthResetPasswordFacadeInterface } from './facade.interface';
 
 /**
@@ -30,7 +30,7 @@ export class DaffAuthResetPasswordFacade implements DaffAuthResetPasswordFacadeI
       selectLoading,
       selectErrors,
       selectAuthResetPasswordToken,
-    } = getDaffAuthResetPasswordSelectors();
+    } = daffAuthResetPasswordSelectorFactory();
 
     this.token$ = this.store.pipe(select(selectAuthResetPasswordToken));
 

libs/auth/state/src/reducers/public_api.ts

@@ -2,6 +2,7 @@ export * from './auth/public_api';
 export * from './login/public_api';
 export * from './register/public_api';
 export * from './reset-password/public_api';
+export * from './token/public_api';
 
 export { DAFF_AUTH_STORE_FEATURE_KEY } from './auth-store-feature-key';
 export { daffAuthReducers } from './auth-reducers';

libs/auth/state/src/reducers/token/extra.token.spec.ts

@@ -0,0 +1,35 @@
+import { TestBed } from '@angular/core/testing';
+import { ActionReducer } from '@ngrx/store';
+
+import { DaffAuthFeatureState } from '@daffodil/auth/state';
+
+import {
+  daffAuthProvideExtraReducers,
+  DAFF_AUTH_EXTRA_REDUCERS,
+} from './extra.token';
+
+describe('daffAuthProvideExtraReducers', () => {
+  let reducers: ActionReducer<DaffAuthFeatureState>[];
+  let result: ActionReducer<DaffAuthFeatureState>[];
+
+  beforeEach(() => {
+    reducers = [
+      (state, action) => state,
+      (state, action) => state,
+    ];
+
+    TestBed.configureTestingModule({
+      providers: [
+        ...daffAuthProvideExtraReducers(...reducers),
+      ],
+    });
+
+    result = TestBed.inject(DAFF_AUTH_EXTRA_REDUCERS);
+  });
+
+  it('should provide the reducers to the token', () => {
+    reducers.forEach(reducer => {
+      expect(result).toContain(reducer);
+    });
+  });
+});

libs/auth/state/src/reducers/token/extra.token.ts

@@ -0,0 +1,39 @@
+import {
+  InjectionToken,
+  Provider,
+} from '@angular/core';
+import { ActionReducer } from '@ngrx/store';
+
+import { DaffAuthFeatureState } from '../auth-feature-state.interface';
+
+/**
+ * A token to hold the injectable extra reducers.
+ *
+ * Prefer using {@link daffAuthProvideExtraReducers}.
+ */
+export const DAFF_AUTH_EXTRA_REDUCERS = new InjectionToken<ActionReducer<DaffAuthFeatureState>[]>(
+  'DAFF_AUTH_EXTRA_REDUCERS',
+  { factory: () => []},
+);
+
+/**
+ * Provides additional reducers that run after the standard Daffodil auth reducers.
+ *
+ * ```ts
+ * providers: [
+ *   ...daffAuthProvideExtraReducers(
+ *     myReducer1,
+ *     myReducer2
+ *   )
+ * ]
+ * ```
+ */
+export function daffAuthProvideExtraReducers(
+  ...reducers: ActionReducer<DaffAuthFeatureState>[]
+): Provider[] {
+  return reducers.map(reducer => ({
+    provide: DAFF_AUTH_EXTRA_REDUCERS,
+    useValue: reducer,
+    multi: true,
+  }));
+}

libs/auth/state/src/reducers/token/public_api.ts

@@ -0,0 +1,4 @@
+export {
+  daffAuthProvideExtraReducers,
+  DAFF_AUTH_EXTRA_REDUCERS,
+} from './extra.token';

libs/auth/state/src/reducers/token/reducers.token.spec.ts

@@ -0,0 +1,61 @@
+import { TestBed } from '@angular/core/testing';
+import { ActionReducer } from '@ngrx/store';
+
+import {
+  DaffAuthFeatureState,
+  daffAuthInitialState,
+  DaffAuthCheck,
+} from '@daffodil/auth/state';
+import { DaffStateError } from '@daffodil/core/state';
+
+import { daffAuthProvideExtraReducers } from './extra.token';
+import { DAFF_AUTH_REDUCERS } from './reducers.token';
+
+describe('daffAuthProvideExtraReducers', () => {
+  let extraReducer: ActionReducer<DaffAuthFeatureState>;
+  let reducer: ActionReducer<DaffAuthFeatureState>;
+  let result: DaffAuthFeatureState;
+  let error: DaffStateError;
+
+  beforeEach(() => {
+    error = {
+      code: 'code',
+      message: 'message',
+    };
+    const initialState: DaffAuthFeatureState = {
+      auth: {
+        ...daffAuthInitialState,
+        daffErrors: [
+          { code: '0', message: '0' },
+        ],
+      },
+      login: null,
+      register: null,
+      resetPassword: null,
+    };
+    extraReducer = (state, action) => ({
+      ...state,
+      auth: {
+        ...state.auth,
+        daffErrors: [
+          ...state.auth.daffErrors,
+          error,
+        ],
+      },
+    });
+
+    TestBed.configureTestingModule({
+      providers: [
+        ...daffAuthProvideExtraReducers(extraReducer),
+      ],
+    });
+
+    reducer = TestBed.inject(DAFF_AUTH_REDUCERS);
+
+    result = reducer(initialState, new DaffAuthCheck());
+  });
+
+  it('should run the extra reducer after the daffodil reducers', () => {
+    expect(result.auth.daffErrors[1]).toEqual(error);
+  });
+});

libs/auth/state/src/reducers/token/reducers.token.ts

@@ -0,0 +1,30 @@
+import {
+  inject,
+  InjectionToken,
+} from '@angular/core';
+import {
+  ActionReducer,
+  combineReducers,
+} from '@ngrx/store';
+
+import { daffComposeReducers } from '@daffodil/core/state';
+
+import { DaffAuthFeatureState } from '../auth-feature-state.interface';
+import { daffAuthReducers } from '../auth-reducers';
+import { DAFF_AUTH_EXTRA_REDUCERS } from './extra.token';
+
+/**
+ * An internal token to hold the Daffodil auth reducers.
+ * Includes the extra and standard reducers.
+ *
+ * @docs-private
+ */
+export const DAFF_AUTH_REDUCERS = new InjectionToken<ActionReducer<DaffAuthFeatureState>>(
+  'DAFF_AUTH_REDUCERS',
+  {
+    factory: () => daffComposeReducers([
+      combineReducers(daffAuthReducers),
+      ...inject(DAFF_AUTH_EXTRA_REDUCERS),
+    ]),
+  },
+);

libs/auth/state/src/selectors/auth-all.selector.ts

@@ -3,20 +3,20 @@ import { MemoizedSelector } from '@ngrx/store';
 import { DaffAuthFeatureState } from '../reducers/public_api';
 import { getDaffAuthFeatureStateSelector } from './auth-feature.selector';
 import {
-  getAuthSelectors,
+  daffAuthSelectorFactory,
   AuthSelectors,
 } from './auth/auth.selector';
 import {
-  getDaffAuthLoginSelectors,
+  daffAuthLoginSelectorFactory,
   DaffAuthLoginSelectors,
 } from './login/login.selector';
 import {
-  getDaffAuthRegisterSelectors,
+  daffAuthRegisterSelectorFactory,
   DaffAuthRegisterSelectors,
 } from './register/register.selector';
 import {
   DaffAuthResetPasswordSelectors,
-  getDaffAuthResetPasswordSelectors,
+  daffAuthResetPasswordSelectorFactory,
 } from './reset-password/selector';
 
 export interface DaffAuthSelectors extends
@@ -31,10 +31,10 @@ export const getDaffAuthSelectors = (() => {
   let cache;
   return (): DaffAuthSelectors =>
     cache = cache || {
-      ...getAuthSelectors(),
-      ...getDaffAuthLoginSelectors(),
-      ...getDaffAuthRegisterSelectors(),
-      ...getDaffAuthResetPasswordSelectors(),
+      ...daffAuthSelectorFactory(),
+      ...daffAuthLoginSelectorFactory(),
+      ...daffAuthRegisterSelectorFactory(),
+      ...daffAuthResetPasswordSelectorFactory(),
       selectAuthFeatureState: getDaffAuthFeatureStateSelector(),
     };
 })();

libs/auth/state/src/selectors/auth/auth.selector.spec.ts

@@ -16,9 +16,9 @@ import {
 } from '@daffodil/auth/state';
 import { DaffStateError } from '@daffodil/core/state';
 
-import { getAuthSelectors } from './auth.selector';
+import { daffAuthSelectorFactory } from './auth.selector';
 
-describe('@daffodil/auth/state | getAuthSelectors', () => {
+describe('@daffodil/auth/state | daffAuthSelectorFactory', () => {
   let store: Store<DaffAuthStateRootSlice>;
 
   let state: DaffAuthReducerState;
@@ -29,7 +29,7 @@ describe('@daffodil/auth/state | getAuthSelectors', () => {
   const {
     selectAuthState,
     selectAuthLoggedIn,
-  } = getAuthSelectors();
+  } = daffAuthSelectorFactory();
 
   beforeEach(() => {
     TestBed.configureTestingModule({

libs/auth/state/src/selectors/auth/auth.selector.ts

@@ -37,7 +37,7 @@ const createAuthSelectors = () => {
   };
 };
 
-export const getAuthSelectors = (() => {
+export const daffAuthSelectorFactory = (() => {
   let cache;
   return (): AuthSelectors =>
     cache = cache || createAuthSelectors();

libs/auth/state/src/selectors/login/login.selector.ts

@@ -32,7 +32,7 @@ const createLoginSelectors = () => {
   };
 };
 
-export const getDaffAuthLoginSelectors = (() => {
+export const daffAuthLoginSelectorFactory = (() => {
   let cache;
   return (): DaffAuthLoginSelectors =>
     cache = cache || createLoginSelectors();

libs/auth/state/src/selectors/public_api.ts

@@ -1 +1,5 @@
 export * from './auth-all.selector';
+export * from './auth/auth.selector';
+export * from './login/login.selector';
+export * from './register/register.selector';
+export * from './reset-password/selector';

libs/auth/state/src/selectors/register/register.selector.ts

@@ -30,7 +30,7 @@ const createRegisterSelectors = () => {
   };
 };
 
-export const getDaffAuthRegisterSelectors = (() => {
+export const daffAuthRegisterSelectorFactory = (() => {
   let cache;
   return (): DaffAuthRegisterSelectors =>
     cache = cache || createRegisterSelectors();

libs/auth/state/src/selectors/reset-password/selector.spec.ts

@@ -19,9 +19,9 @@ import {
   DaffResetPasswordLanding,
   daffAuthResetPasswordInitialState,
 } from '../../public_api';
-import { getDaffAuthResetPasswordSelectors } from './selector';
+import { daffAuthResetPasswordSelectorFactory } from './selector';
 
-describe('@daffodil/auth/state | getDaffAuthResetPasswordSelectors', () => {
+describe('@daffodil/auth/state | daffAuthResetPasswordSelectorFactory', () => {
   let store: Store<DaffAuthStateRootSlice>;
 
   let state: DaffAuthResetPasswordReducerState;
@@ -32,7 +32,7 @@ describe('@daffodil/auth/state | getDaffAuthResetPasswordSelectors', () => {
   const {
     selectAuthResetPasswordState,
     selectAuthResetPasswordToken,
-  } = getDaffAuthResetPasswordSelectors();
+  } = daffAuthResetPasswordSelectorFactory();
 
   beforeEach(() => {
     TestBed.configureTestingModule({

libs/auth/state/src/selectors/reset-password/selector.ts

@@ -38,7 +38,7 @@ const createResetPasswordSelectors = (): DaffAuthResetPasswordSelectors => {
   };
 };
 
-export const getDaffAuthResetPasswordSelectors = (() => {
+export const daffAuthResetPasswordSelectorFactory = (() => {
   let cache;
   return (): DaffAuthResetPasswordSelectors =>
     cache = cache || createResetPasswordSelectors();