refactor: #346 Extracting userId out from timeRange object

Author: Juan Gabriel Guzman

src/app/modules/reports/components/time-range-form/time-range-form.component.ts

@@ -25,7 +25,6 @@ export class TimeRangeFormComponent {
     this.store.dispatch(new entryActions.LoadEntriesByTimeRange({
       start_date: moment(this.startDate.value).startOf('day'),
       end_date: moment(this.endDate.value).endOf('day'),
-      user_id: '*',
     }));
   }
 }

src/app/modules/reports/components/time-range-form/time-range.component.spec.ts

@@ -65,8 +65,7 @@ describe('Reports Page', () => {
 
       expect(store.dispatch).toHaveBeenCalledWith(new entryActions.LoadEntriesByTimeRange({
         start_date: yesterday.startOf('day'),
-        end_date: today.endOf('day'),
-        user_id: '*',
+        end_date: today.endOf('day')
       }));
     });
 

src/app/modules/time-clock/models/time-entries-time-range.ts

@@ -3,5 +3,4 @@ import {Moment} from 'moment';
 export interface TimeEntriesTimeRange {
   start_date: Moment;
   end_date: Moment;
-  user_id: string;
 }

src/app/modules/time-clock/services/entry.service.spec.ts

@@ -1,10 +1,10 @@
-import {HttpClientTestingModule, HttpTestingController} from '@angular/common/http/testing';
-import {inject, TestBed} from '@angular/core/testing';
+import { HttpClientTestingModule, HttpTestingController } from '@angular/common/http/testing';
+import { inject, TestBed } from '@angular/core/testing';
 
-import {EntryService} from './entry.service';
-import {NewEntry} from '../../shared/models';
-import {DatePipe} from '@angular/common';
-import {TimeEntriesTimeRange} from '../models/time-entries-time-range';
+import { EntryService } from './entry.service';
+import { NewEntry } from '../../shared/models';
+import { DatePipe } from '@angular/common';
+import { TimeEntriesTimeRange } from '../models/time-entries-time-range';
 import * as moment from 'moment';
 
 describe('EntryService', () => {
@@ -93,14 +93,15 @@ describe('EntryService', () => {
     const yesterday = moment(new Date()).subtract(1, 'day');
     const today = moment(new Date());
     const pipe: DatePipe = new DatePipe('en');
-    const timeRange: TimeEntriesTimeRange = {start_date: yesterday, end_date: today, user_id: '*'};
+    const timeRange: TimeEntriesTimeRange = {start_date: yesterday, end_date: today};
+    const userId = '123';
 
-    service.loadEntriesByTimeRange(timeRange).subscribe();
+    service.loadEntriesByTimeRange(timeRange, userId).subscribe();
 
     const loadEntryRequest = httpMock.expectOne(req => req.method === 'GET' && req.url === service.baseUrl);
-
     expect(loadEntryRequest.request.params.get('start_date')).toBe(pipe.transform(yesterday,
       EntryService.TIME_ENTRIES_DATE_TIME_FORMAT));
     expect(loadEntryRequest.request.params.get('end_date')).toBe(pipe.transform(today, EntryService.TIME_ENTRIES_DATE_TIME_FORMAT));
+    expect(loadEntryRequest.request.params.get('user_id')).toEqual('123');
   });
 });

src/app/modules/time-clock/services/entry.service.ts

@@ -50,13 +50,13 @@ export class EntryService {
     return this.http.get<TimeEntriesSummary>(summaryUrl);
   }
 
-  loadEntriesByTimeRange(range: TimeEntriesTimeRange): Observable<any> {
+  loadEntriesByTimeRange(range: TimeEntriesTimeRange, userId: string): Observable<any> {
     return this.http.get(this.baseUrl,
       {
         params: {
           start_date: this.datePipe.transform(range.start_date, EntryService.TIME_ENTRIES_DATE_TIME_FORMAT),
           end_date: this.datePipe.transform(range.end_date, EntryService.TIME_ENTRIES_DATE_TIME_FORMAT),
-          user_id: range.user_id
+          user_id: userId
         }
       }
     );

src/app/modules/time-clock/store/entry.actions.spec.ts

@@ -1,4 +1,7 @@
 import * as actions from './entry.actions';
+import * as moment from 'moment';
+import { DatePipe } from '@angular/common';
+import { TimeEntriesTimeRange } from '../models/time-entries-time-range';
 
 describe('Actions for Entries', () => {
 
@@ -83,8 +86,14 @@ describe('Actions for Entries', () => {
   });
 
   it('LoadEntriesByTimeRange type is EntryActionTypes.LOAD_ENTRIES_BY_TIME_RANGE', () => {
-    const action = new actions.LoadEntriesByTimeRange(null);
+    const yesterday = moment(new Date()).subtract(1, 'day');
+    const today = moment(new Date());
+    const pipe: DatePipe = new DatePipe('en');
+    const timeRange: TimeEntriesTimeRange = {start_date: yesterday, end_date: today};
+    const action = new actions.LoadEntriesByTimeRange(timeRange);
     expect(action.type).toEqual(actions.EntryActionTypes.LOAD_ENTRIES_BY_TIME_RANGE);
+    expect(action.timeRange).toEqual(timeRange);
+    expect(action.userId).toEqual('*');
   });
 
   it('LoadEntriesByTimeRangeSuccess type is EntryActionTypes.LOAD_ENTRIES_BY_TIME_RANGE_SUCCESS', () => {

src/app/modules/time-clock/store/entry.actions.ts

@@ -167,7 +167,7 @@ export class DefaultEntry implements Action {
 
 export class LoadEntriesByTimeRange implements Action {
   public readonly type = EntryActionTypes.LOAD_ENTRIES_BY_TIME_RANGE;
-  constructor(readonly timeRange: TimeEntriesTimeRange) {
+  constructor(readonly timeRange: TimeEntriesTimeRange, readonly userId: string= '*') {
   }
 }
 

src/app/modules/time-clock/store/entry.effects.spec.ts

@@ -1,15 +1,15 @@
 import { INFO_SAVED_SUCCESSFULLY } from './../../shared/messages';
-import {TestBed} from '@angular/core/testing';
-import {provideMockActions} from '@ngrx/effects/testing';
-import {EntryEffects} from './entry.effects';
-import {Observable, of, throwError} from 'rxjs';
-import {HttpClientTestingModule} from '@angular/common/http/testing';
+import { TestBed } from '@angular/core/testing';
+import { provideMockActions } from '@ngrx/effects/testing';
+import { EntryEffects } from './entry.effects';
+import { Observable, of, throwError } from 'rxjs';
+import { HttpClientTestingModule } from '@angular/common/http/testing';
 import { ToastrModule, ToastrService } from 'ngx-toastr';
-import {Action} from '@ngrx/store';
-import {DatePipe} from '@angular/common';
-import {EntryActionTypes} from './entry.actions';
-import {EntryService} from '../services/entry.service';
-import {TimeEntriesTimeRange} from '../models/time-entries-time-range';
+import { Action } from '@ngrx/store';
+import { DatePipe } from '@angular/common';
+import { EntryActionTypes } from './entry.actions';
+import { EntryService } from '../services/entry.service';
+import { TimeEntriesTimeRange } from '../models/time-entries-time-range';
 import * as moment from 'moment';
 
 describe('TimeEntryActionEffects', () => {
@@ -38,7 +38,7 @@ describe('TimeEntryActionEffects', () => {
     expect(effects).toBeTruthy();
   });
 
-  it('returns an action with type LOAD_ENTRIES_SUMMARY_SUCCESS when the service returns a value',  () => {
+  it('returns an action with type LOAD_ENTRIES_SUMMARY_SUCCESS when the service returns a value', () => {
     actions$ = of({type: EntryActionTypes.LOAD_ENTRIES_SUMMARY});
     const serviceSpy = spyOn(service, 'summary');
     serviceSpy.and.returnValue(of({}));
@@ -48,7 +48,7 @@ describe('TimeEntryActionEffects', () => {
     });
   });
 
-  it('returns an action with type LOAD_ENTRIES_SUMMARY_FAIL when the service fails',  () => {
+  it('returns an action with type LOAD_ENTRIES_SUMMARY_FAIL when the service fails', () => {
     actions$ = of({type: EntryActionTypes.LOAD_ENTRIES_SUMMARY});
     spyOn(service, 'summary').and.returnValue(throwError('any error'));
 
@@ -57,9 +57,10 @@ describe('TimeEntryActionEffects', () => {
     });
   });
 
-  it('When the service returns a value, then LOAD_ENTRIES_BY_TIME_RANGE_SUCCESS should be triggered',  () => {
-    const timeRange: TimeEntriesTimeRange = {start_date: moment(new Date()), end_date: moment(new Date()), user_id: '*' };
-    actions$ = of({type: EntryActionTypes.LOAD_ENTRIES_BY_TIME_RANGE, timeRange});
+  it('When the service returns a value, then LOAD_ENTRIES_BY_TIME_RANGE_SUCCESS should be triggered', () => {
+    const timeRange: TimeEntriesTimeRange = {start_date: moment(new Date()), end_date: moment(new Date())};
+    const userId = '*';
+    actions$ = of({type: EntryActionTypes.LOAD_ENTRIES_BY_TIME_RANGE, timeRange, userId});
     const serviceSpy = spyOn(service, 'loadEntriesByTimeRange');
     serviceSpy.and.returnValue(of([]));
 
@@ -70,13 +71,14 @@ describe('TimeEntryActionEffects', () => {
   });
 
   it('When the service fails, then LOAD_ENTRIES_BY_TIME_RANGE_FAIL should be triggered', async () => {
-      const timeRange: TimeEntriesTimeRange = {start_date: moment(new Date()), end_date: moment(new Date()), user_id: '*'};
-      actions$ = of({type: EntryActionTypes.LOAD_ENTRIES_BY_TIME_RANGE, timeRange});
-      spyOn(service, 'loadEntriesByTimeRange').and.returnValue(throwError('any error'));
+    const timeRange: TimeEntriesTimeRange = {start_date: moment(new Date()), end_date: moment(new Date())};
+    const userId = '*';
+    actions$ = of({type: EntryActionTypes.LOAD_ENTRIES_BY_TIME_RANGE, timeRange, userId});
+    spyOn(service, 'loadEntriesByTimeRange').and.returnValue(throwError('any error'));
 
-      effects.loadEntriesByTimeRange$.subscribe(action => {
-        expect(action.type).toEqual(EntryActionTypes.LOAD_ENTRIES_BY_TIME_RANGE_FAIL);
-      });
+    effects.loadEntriesByTimeRange$.subscribe(action => {
+      expect(action.type).toEqual(EntryActionTypes.LOAD_ENTRIES_BY_TIME_RANGE_FAIL);
+    });
   });
 
   it('returns a LOAD_ACTIVE_ENTRY_SUCCESS when the entry that is running it is in the same day', async () => {
@@ -92,7 +94,7 @@ describe('TimeEntryActionEffects', () => {
 
   it('returns a LOAD_ACTIVE_ENTRY_SUCCESS when the entry that is running it is in the same day', async () => {
     const startDateInPast = new Date();
-    startDateInPast.setDate( startDateInPast.getDate() - 5);
+    startDateInPast.setDate(startDateInPast.getDate() - 5);
     const activeEntry = {start_date: startDateInPast};
     actions$ = of({type: EntryActionTypes.LOAD_ACTIVE_ENTRY, activeEntry});
     const serviceSpy = spyOn(service, 'loadActiveEntry');

src/app/modules/time-clock/store/entry.effects.ts

@@ -168,9 +168,9 @@ export class EntryEffects {
   @Effect()
   loadEntriesByTimeRange$: Observable<Action> = this.actions$.pipe(
     ofType(actions.EntryActionTypes.LOAD_ENTRIES_BY_TIME_RANGE),
-    map((action: actions.LoadEntriesByTimeRange) => action.timeRange),
-    mergeMap((timeRange) =>
-      this.entryService.loadEntriesByTimeRange(timeRange).pipe(
+    map((action: actions.LoadEntriesByTimeRange) => action),
+    mergeMap((action) =>
+      this.entryService.loadEntriesByTimeRange(action.timeRange, action.userId).pipe(
         map((response) => {
           return new actions.LoadEntriesByTimeRangeSuccess(response);
         }),

src/app/modules/time-clock/store/entry.reducer.spec.ts

@@ -1,7 +1,7 @@
-import {TimeDetails, TimeEntriesSummary} from '../models/time.entry.summary';
-import {Entry, NewEntry} from './../../shared/models';
+import { TimeDetails, TimeEntriesSummary } from '../models/time.entry.summary';
+import { Entry, NewEntry } from './../../shared/models';
 import * as actions from './entry.actions';
-import {entryReducer, EntryState} from './entry.reducer';
+import { entryReducer, EntryState } from './entry.reducer';
 
 describe('entryReducer', () => {