@daffodil/search 0.0.0-PLACEHOLDER

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (146) hide show
  1. package/.eslintrc.js +52 -0
  2. package/README.md +11 -0
  3. package/driver/federated/README.md +3 -0
  4. package/driver/federated/ng-package.json +8 -0
  5. package/driver/federated/package.json +3 -0
  6. package/driver/federated/src/config/default.ts +6 -0
  7. package/driver/federated/src/config/interface.ts +21 -0
  8. package/driver/federated/src/config/public_api.ts +5 -0
  9. package/driver/federated/src/index.ts +1 -0
  10. package/driver/federated/src/injection-tokens/drivers.token.spec.ts +64 -0
  11. package/driver/federated/src/injection-tokens/drivers.token.ts +37 -0
  12. package/driver/federated/src/public_api.ts +4 -0
  13. package/driver/federated/src/search-driver.module.ts +62 -0
  14. package/driver/federated/src/search.service.spec.ts +86 -0
  15. package/driver/federated/src/search.service.ts +49 -0
  16. package/driver/in-memory/ng-package.json +8 -0
  17. package/driver/in-memory/package.json +3 -0
  18. package/driver/in-memory/src/backend/search.service.spec.ts +111 -0
  19. package/driver/in-memory/src/backend/search.service.ts +83 -0
  20. package/driver/in-memory/src/driver/search-driver.module.ts +33 -0
  21. package/driver/in-memory/src/driver/search.service.spec.ts +75 -0
  22. package/driver/in-memory/src/driver/search.service.ts +33 -0
  23. package/driver/in-memory/src/index.ts +1 -0
  24. package/driver/in-memory/src/injection-tokens/backends.token.spec.ts +69 -0
  25. package/driver/in-memory/src/injection-tokens/backends.token.ts +36 -0
  26. package/driver/in-memory/src/interfaces/get-backend.interface.ts +17 -0
  27. package/driver/in-memory/src/interfaces/public_api.ts +1 -0
  28. package/driver/in-memory/src/public_api.ts +7 -0
  29. package/driver/ng-package.json +8 -0
  30. package/driver/package.json +3 -0
  31. package/driver/src/errors/invalid-api-response.ts +17 -0
  32. package/driver/src/errors/map.ts +16 -0
  33. package/driver/src/errors/public_api.ts +9 -0
  34. package/driver/src/errors/query-too-short.ts +17 -0
  35. package/driver/src/index.ts +1 -0
  36. package/driver/src/interfaces/response.interface.ts +18 -0
  37. package/driver/src/interfaces/search-service-kinded.interface.ts +17 -0
  38. package/driver/src/interfaces/search-service.interface.ts +42 -0
  39. package/driver/src/public_api.ts +9 -0
  40. package/driver/testing/ng-package.json +8 -0
  41. package/driver/testing/package.json +3 -0
  42. package/driver/testing/src/drivers/public_api.ts +2 -0
  43. package/driver/testing/src/drivers/search-driver.module.ts +31 -0
  44. package/driver/testing/src/drivers/search.service.spec.ts +29 -0
  45. package/driver/testing/src/drivers/search.service.ts +37 -0
  46. package/driver/testing/src/index.ts +1 -0
  47. package/driver/testing/src/public_api.ts +1 -0
  48. package/karma.conf.js +11 -0
  49. package/ng-package.json +7 -0
  50. package/ng-package.prod.json +7 -0
  51. package/package.json +40 -0
  52. package/routing/ng-package.json +8 -0
  53. package/routing/package.json +3 -0
  54. package/routing/src/index.ts +1 -0
  55. package/routing/src/injection-tokens/public_api.ts +6 -0
  56. package/routing/src/injection-tokens/search-options/builder.token.ts +10 -0
  57. package/routing/src/injection-tokens/search-options/builders.token.spec.ts +35 -0
  58. package/routing/src/injection-tokens/search-options/builders.token.ts +42 -0
  59. package/routing/src/module.ts +26 -0
  60. package/routing/src/public_api.ts +3 -0
  61. package/routing/src/resolvers/public_api.ts +1 -0
  62. package/routing/src/resolvers/search/search.resolver.spec.ts +166 -0
  63. package/routing/src/resolvers/search/search.resolver.ts +65 -0
  64. package/src/index.ts +1 -0
  65. package/src/injection-tokens/error-matcher.token.ts +12 -0
  66. package/src/injection-tokens/public_api.ts +1 -0
  67. package/src/models/public_api.ts +2 -0
  68. package/src/models/search-result-collection.type.ts +6 -0
  69. package/src/models/search-result.type.ts +10 -0
  70. package/src/public_api.ts +3 -0
  71. package/src/transforms/public_api.ts +1 -0
  72. package/src/transforms/results-to-collection.spec.ts +28 -0
  73. package/src/transforms/results-to-collection.ts +14 -0
  74. package/state/ng-package.json +8 -0
  75. package/state/package.json +3 -0
  76. package/state/src/actions/search.actions.ts +93 -0
  77. package/state/src/config/default.ts +10 -0
  78. package/state/src/config/interface.ts +20 -0
  79. package/state/src/config/public_api.ts +3 -0
  80. package/state/src/config/token.ts +11 -0
  81. package/state/src/effects/incremental.effects.spec.ts +205 -0
  82. package/state/src/effects/incremental.effects.ts +74 -0
  83. package/state/src/effects/page.effects.spec.ts +179 -0
  84. package/state/src/effects/page.effects.ts +57 -0
  85. package/state/src/facades/public_api.ts +4 -0
  86. package/state/src/facades/search/base.facade.spec.ts +148 -0
  87. package/state/src/facades/search/base.facade.ts +53 -0
  88. package/state/src/facades/search/incremental.facade.ts +25 -0
  89. package/state/src/facades/search/page.facade.ts +25 -0
  90. package/state/src/facades/search/search-facade.interface.ts +38 -0
  91. package/state/src/incremental.module.ts +35 -0
  92. package/state/src/index.ts +1 -0
  93. package/state/src/page.module.ts +15 -0
  94. package/state/src/public_api.ts +9 -0
  95. package/state/src/reducers/incremental/public_api.ts +1 -0
  96. package/state/src/reducers/incremental/reducer.spec.ts +142 -0
  97. package/state/src/reducers/incremental/reducer.ts +34 -0
  98. package/state/src/reducers/page/public_api.ts +1 -0
  99. package/state/src/reducers/page/reducer.spec.ts +142 -0
  100. package/state/src/reducers/page/reducer.ts +34 -0
  101. package/state/src/reducers/public_api.ts +11 -0
  102. package/state/src/reducers/reducers.interface.ts +19 -0
  103. package/state/src/reducers/reducers.spec.ts +16 -0
  104. package/state/src/reducers/reducers.ts +13 -0
  105. package/state/src/reducers/search/adapter.spec.ts +130 -0
  106. package/state/src/reducers/search/adapter.ts +71 -0
  107. package/state/src/reducers/search/initial-state.ts +11 -0
  108. package/state/src/reducers/search/interface.ts +26 -0
  109. package/state/src/reducers/search/public_api.ts +3 -0
  110. package/state/src/reducers/store-feature-key.ts +4 -0
  111. package/state/src/reducers/token/extra.token.spec.ts +35 -0
  112. package/state/src/reducers/token/extra.token.ts +44 -0
  113. package/state/src/reducers/token/public_api.ts +4 -0
  114. package/state/src/reducers/token/reducers.token.spec.ts +51 -0
  115. package/state/src/reducers/token/reducers.token.ts +33 -0
  116. package/state/src/search.module.ts +15 -0
  117. package/state/src/selectors/incremental/selectors.ts +21 -0
  118. package/state/src/selectors/page/selectors.ts +21 -0
  119. package/state/src/selectors/public_api.ts +4 -0
  120. package/state/src/selectors/search-feature.selector.ts +27 -0
  121. package/state/src/selectors/search.selector.spec.ts +137 -0
  122. package/state/src/selectors/search.selector.ts +78 -0
  123. package/state/testing/ng-package.json +8 -0
  124. package/state/testing/package.json +3 -0
  125. package/state/testing/src/index.ts +1 -0
  126. package/state/testing/src/mock-search-facade.ts +24 -0
  127. package/state/testing/src/public_api.ts +2 -0
  128. package/state/testing/src/search-testing.module.ts +19 -0
  129. package/test.ts +23 -0
  130. package/testing/ng-package.json +8 -0
  131. package/testing/package.json +3 -0
  132. package/testing/src/factories/kind.factory.spec.ts +57 -0
  133. package/testing/src/factories/kind.factory.ts +37 -0
  134. package/testing/src/factories/public_api.ts +2 -0
  135. package/testing/src/factories/search-result.factory.spec.ts +39 -0
  136. package/testing/src/factories/search-result.factory.ts +26 -0
  137. package/testing/src/index.ts +1 -0
  138. package/testing/src/injection-tokens/factories/kind.token.spec.ts +51 -0
  139. package/testing/src/injection-tokens/factories/kind.token.ts +43 -0
  140. package/testing/src/injection-tokens/public_api.ts +4 -0
  141. package/testing/src/public_api.ts +4 -0
  142. package/testing/src/testing.module.ts +18 -0
  143. package/tsconfig.json +38 -0
  144. package/tsconfig.lib.json +28 -0
  145. package/tsconfig.lib.prod.json +9 -0
  146. package/tsconfig.spec.json +17 -0
@@ -0,0 +1,205 @@
1
+ import { TestBed } from '@angular/core/testing';
2
+ import { provideMockActions } from '@ngrx/effects/testing';
3
+ import {
4
+ Observable,
5
+ of,
6
+ tap,
7
+ } from 'rxjs';
8
+ import { TestScheduler } from 'rxjs/testing';
9
+
10
+ import { daffTransformErrorToStateError } from '@daffodil/core/state';
11
+ import {
12
+ DaffSearchResult,
13
+ DaffSearchResultCollection,
14
+ daffSearchTransformResultsToCollection,
15
+ } from '@daffodil/search';
16
+ import {
17
+ DaffSearchDriverInterface,
18
+ DaffSearchDriver,
19
+ DaffSearchInvalidAPIResponseError,
20
+ DaffSearchDriverOptions,
21
+ DaffSearchDriverResponse,
22
+ } from '@daffodil/search/driver';
23
+ import { DaffSearchTestingDriverModule } from '@daffodil/search/driver/testing';
24
+ import {
25
+ DaffSearchIncremental,
26
+ DaffSearchIncrementalFailure,
27
+ DaffSearchIncrementalSuccess,
28
+ DAFF_SEARCH_STATE_CONFIG,
29
+ } from '@daffodil/search/state';
30
+ import { DaffSearchResultFactory } from '@daffodil/search/testing';
31
+
32
+ import { DaffSearchIncrementalEffects } from './incremental.effects';
33
+
34
+ describe('@daffodil/search/state | DaffSearchIncrementalEffects', () => {
35
+ let actions$: Observable<any>;
36
+ let effects: DaffSearchIncrementalEffects<DaffSearchResult>;
37
+
38
+ let mockSearchResults: DaffSearchResult[];
39
+ let mockCollection: DaffSearchResultCollection;
40
+ let mockResponse: DaffSearchDriverResponse;
41
+ let query: string;
42
+ let options: DaffSearchDriverOptions;
43
+
44
+ let searchResultFactory: DaffSearchResultFactory;
45
+
46
+ let daffDriver: DaffSearchDriverInterface;
47
+ let driverSearchSpy: jasmine.Spy<DaffSearchDriverInterface['search']>;
48
+
49
+ beforeEach(() => {
50
+ TestBed.configureTestingModule({
51
+ imports: [
52
+ DaffSearchTestingDriverModule.forRoot(),
53
+ ],
54
+ providers: [
55
+ DaffSearchIncrementalEffects,
56
+ provideMockActions(() => actions$),
57
+ {
58
+ provide: DAFF_SEARCH_STATE_CONFIG,
59
+ useValue: {
60
+ incrementalResultLimit: 10,
61
+ },
62
+ },
63
+ ],
64
+ });
65
+
66
+ effects = TestBed.inject(DaffSearchIncrementalEffects);
67
+ daffDriver = TestBed.inject<DaffSearchDriverInterface>(DaffSearchDriver);
68
+ searchResultFactory = TestBed.inject(DaffSearchResultFactory);
69
+
70
+ mockSearchResults = searchResultFactory.createMany(5);
71
+ mockCollection = daffSearchTransformResultsToCollection(mockSearchResults);
72
+ mockResponse = {
73
+ collection: mockCollection,
74
+ metadata: {},
75
+ };
76
+ query = 'query';
77
+ options = <DaffSearchDriverOptions>{
78
+ thing: 'thing',
79
+ };
80
+
81
+ driverSearchSpy = spyOn(daffDriver, 'search');
82
+ driverSearchSpy.and.returnValue(of(mockResponse));
83
+ });
84
+
85
+ it('should be created', () => {
86
+ expect(effects).toBeTruthy();
87
+ });
88
+
89
+ describe('when DaffSearchIncrementalAction is triggered', () => {
90
+ let expected;
91
+ let searchIncrementalAction: DaffSearchIncremental;
92
+
93
+ beforeEach(() => {
94
+ searchIncrementalAction = new DaffSearchIncremental(query, options);
95
+ });
96
+
97
+ describe('debouncing the request', () => {
98
+ it('should call the driver', () => {
99
+ const testScheduler = new TestScheduler((actual, ex) => {
100
+ expect(actual).toEqual(ex);
101
+ });
102
+
103
+ const searchResultIncrementalSuccessAction = new DaffSearchIncrementalSuccess(mockResponse);
104
+
105
+ testScheduler.run(({ hot, expectObservable }) => {
106
+ actions$ = hot('--a-a-a-a-a', { a: searchIncrementalAction });
107
+
108
+ const expectedMarble = '310ms a';
109
+ const expectedValue = {
110
+ a: searchResultIncrementalSuccessAction,
111
+ };
112
+
113
+ expectObservable(
114
+ effects.incremental$(300, testScheduler),
115
+ ).toBe(expectedMarble, expectedValue);
116
+ });
117
+ });
118
+ });
119
+
120
+ it('should call the driver with the query and the limit', done => {
121
+ const testScheduler = new TestScheduler((actual, ex) => {
122
+ expect(actual).toEqual(ex);
123
+ });
124
+
125
+ const searchResultIncrementalSuccessAction = new DaffSearchIncrementalSuccess({
126
+ collection: mockCollection,
127
+ metadata: {},
128
+ });
129
+
130
+ testScheduler.run(({ hot, expectObservable }) => {
131
+ actions$ = hot('--a', { a: searchIncrementalAction });
132
+
133
+ const expectedMarble = '--a';
134
+ const expectedValue = {
135
+ a: searchResultIncrementalSuccessAction,
136
+ };
137
+
138
+ expectObservable(
139
+ effects.incremental$(0, testScheduler).pipe(
140
+ tap(() => {
141
+ expect(driverSearchSpy).toHaveBeenCalledWith(query, {
142
+ ...options,
143
+ limit: 10,
144
+ });
145
+ done();
146
+ }),
147
+ ),
148
+ ).toBe(expectedMarble, expectedValue);
149
+ });
150
+ });
151
+
152
+ describe('and the call to SearchDriver is successful', () => {
153
+ it('should return a DaffSearchIncrementalSucess action', () => {
154
+ const testScheduler = new TestScheduler((actual, ex) => {
155
+ expect(actual).toEqual(ex);
156
+ });
157
+
158
+ const searchResultIncrementalSuccessAction = new DaffSearchIncrementalSuccess({
159
+ collection: mockCollection,
160
+ metadata: {},
161
+ });
162
+
163
+ testScheduler.run(({ hot, expectObservable }) => {
164
+ actions$ = hot('--a', { a: searchIncrementalAction });
165
+
166
+ const expectedMarble = '--a';
167
+ const expectedValue = {
168
+ a: searchResultIncrementalSuccessAction,
169
+ };
170
+
171
+ expectObservable(
172
+ effects.incremental$(0, testScheduler),
173
+ ).toBe(expectedMarble, expectedValue);
174
+ });
175
+ });
176
+ });
177
+
178
+ describe('and the call to SearchDriver fails', () => {
179
+ let searchResultIncrementalFailureAction: DaffSearchIncrementalFailure;
180
+
181
+ it('should return a DaffSearchIncrementalFailure action', () => {
182
+ const testScheduler = new TestScheduler((actual, ex) => {
183
+ expect(actual).toEqual(ex);
184
+ });
185
+
186
+ testScheduler.run(({ hot, expectObservable, cold }) => {
187
+ const error = new DaffSearchInvalidAPIResponseError('Failed to search');
188
+ const response = cold<DaffSearchDriverResponse>('#', {}, error);
189
+ driverSearchSpy.and.returnValue(response);
190
+ searchResultIncrementalFailureAction = new DaffSearchIncrementalFailure(daffTransformErrorToStateError(error));
191
+ actions$ = hot('--a', { a: searchIncrementalAction });
192
+
193
+ const expectedMarble = '--a';
194
+ const expectedValue = {
195
+ a: searchResultIncrementalFailureAction,
196
+ };
197
+
198
+ expectObservable(
199
+ effects.incremental$(0, testScheduler),
200
+ ).toBe(expectedMarble, expectedValue);
201
+ });
202
+ });
203
+ });
204
+ });
205
+ });
@@ -0,0 +1,74 @@
1
+ import {
2
+ Injectable,
3
+ Inject,
4
+ } from '@angular/core';
5
+ import {
6
+ Actions,
7
+ createEffect,
8
+ ofType,
9
+ } from '@ngrx/effects';
10
+ import {
11
+ asyncScheduler,
12
+ Observable,
13
+ of,
14
+ } from 'rxjs';
15
+ import {
16
+ switchMap,
17
+ map,
18
+ catchError,
19
+ debounceTime,
20
+ } from 'rxjs/operators';
21
+
22
+ import { DaffError } from '@daffodil/core';
23
+ import { ErrorTransformer } from '@daffodil/core/state';
24
+ import {
25
+ DaffSearchResult,
26
+ DAFF_SEARCH_ERROR_MATCHER,
27
+ } from '@daffodil/search';
28
+ import {
29
+ DaffSearchDriverInterface,
30
+ DaffSearchDriver,
31
+ } from '@daffodil/search/driver';
32
+
33
+ import {
34
+ DaffSearchActionTypes,
35
+ DaffSearchIncremental,
36
+ DaffSearchIncrementalSuccess,
37
+ DaffSearchIncrementalFailure,
38
+ } from '../actions/search.actions';
39
+ import {
40
+ DaffSearchStateConfig,
41
+ DAFF_SEARCH_STATE_CONFIG,
42
+ } from '../config/public_api';
43
+
44
+ @Injectable()
45
+ export class DaffSearchIncrementalEffects<
46
+ T extends DaffSearchResult = DaffSearchResult,
47
+ > {
48
+ constructor(
49
+ private actions$: Actions,
50
+ @Inject(DaffSearchDriver) private driver: DaffSearchDriverInterface<T>,
51
+ @Inject(DAFF_SEARCH_ERROR_MATCHER) private errorMatcher: ErrorTransformer,
52
+ @Inject(DAFF_SEARCH_STATE_CONFIG) private config: DaffSearchStateConfig,
53
+ ) {}
54
+
55
+ /**
56
+ * An effect for incremental searching with the provided driver.
57
+ */
58
+ incremental$: (throttleWindow: number, scheduler: typeof asyncScheduler) => Observable<
59
+ DaffSearchIncrementalSuccess | DaffSearchIncrementalFailure
60
+ > = createEffect(() => (throttleWindow = 200, scheduler = asyncScheduler) => this.actions$.pipe(
61
+ ofType(DaffSearchActionTypes.SearchIncrementalAction),
62
+ debounceTime(throttleWindow, scheduler),
63
+ switchMap((action: DaffSearchIncremental) =>
64
+ this.driver.search(action.query, {
65
+ limit: this.config.incrementalResultLimit,
66
+ ...action.options,
67
+ }).pipe(
68
+ map(resp => new DaffSearchIncrementalSuccess<T>(resp)),
69
+ catchError((error: DaffError) => of(new DaffSearchIncrementalFailure(this.errorMatcher(error)))),
70
+ ),
71
+ ),
72
+ ));
73
+ }
74
+
@@ -0,0 +1,179 @@
1
+ import { TestBed } from '@angular/core/testing';
2
+ import { provideMockActions } from '@ngrx/effects/testing';
3
+ import {
4
+ Observable,
5
+ of,
6
+ tap,
7
+ } from 'rxjs';
8
+ import { TestScheduler } from 'rxjs/testing';
9
+
10
+ import { daffTransformErrorToStateError } from '@daffodil/core/state';
11
+ import {
12
+ DaffSearchResult,
13
+ DaffSearchResultCollection,
14
+ daffSearchTransformResultsToCollection,
15
+ } from '@daffodil/search';
16
+ import {
17
+ DaffSearchDriverInterface,
18
+ DaffSearchDriver,
19
+ DaffSearchInvalidAPIResponseError,
20
+ DaffSearchDriverOptions,
21
+ DaffSearchDriverResponse,
22
+ } from '@daffodil/search/driver';
23
+ import { DaffSearchTestingDriverModule } from '@daffodil/search/driver/testing';
24
+ import {
25
+ DaffSearchLoad,
26
+ DaffSearchLoadSuccess,
27
+ DaffSearchLoadFailure,
28
+ DAFF_SEARCH_STATE_CONFIG,
29
+ } from '@daffodil/search/state';
30
+ import { DaffSearchResultFactory } from '@daffodil/search/testing';
31
+
32
+ import { DaffSearchPageEffects } from './page.effects';
33
+
34
+ describe('@daffodil/search/state | DaffSearchPageEffects', () => {
35
+ let actions$: Observable<any>;
36
+ let effects: DaffSearchPageEffects<DaffSearchResult>;
37
+
38
+ let mockSearchResults: DaffSearchResult[];
39
+ let mockCollection: DaffSearchResultCollection;
40
+ let mockResponse: DaffSearchDriverResponse;
41
+ let query: string;
42
+ let options: DaffSearchDriverOptions;
43
+
44
+ let searchResultFactory: DaffSearchResultFactory;
45
+
46
+ let daffDriver: DaffSearchDriverInterface;
47
+ let driverSearchSpy: jasmine.Spy<DaffSearchDriverInterface['search']>;
48
+
49
+ beforeEach(() => {
50
+ TestBed.configureTestingModule({
51
+ imports: [
52
+ DaffSearchTestingDriverModule.forRoot(),
53
+ ],
54
+ providers: [
55
+ DaffSearchPageEffects,
56
+ provideMockActions(() => actions$),
57
+ {
58
+ provide: DAFF_SEARCH_STATE_CONFIG,
59
+ useValue: {
60
+ incrementalResultLimit: 10,
61
+ },
62
+ },
63
+ ],
64
+ });
65
+
66
+ effects = TestBed.inject(DaffSearchPageEffects);
67
+ daffDriver = TestBed.inject<DaffSearchDriverInterface>(DaffSearchDriver);
68
+ searchResultFactory = TestBed.inject(DaffSearchResultFactory);
69
+
70
+ mockSearchResults = searchResultFactory.createMany(5);
71
+ mockCollection = daffSearchTransformResultsToCollection(mockSearchResults);
72
+ mockResponse = {
73
+ collection: mockCollection,
74
+ metadata: {},
75
+ };
76
+ query = 'query';
77
+ options = <DaffSearchDriverOptions>{
78
+ thing: 'thing',
79
+ };
80
+
81
+ driverSearchSpy = spyOn(daffDriver, 'search');
82
+ driverSearchSpy.and.returnValue(of(mockResponse));
83
+ });
84
+
85
+ it('should be created', () => {
86
+ expect(effects).toBeTruthy();
87
+ });
88
+
89
+ describe('when DaffSearchLoadAction is triggered', () => {
90
+ let expected;
91
+ let searchLoadAction: DaffSearchLoad;
92
+
93
+ beforeEach(() => {
94
+ searchLoadAction = new DaffSearchLoad(query, options);
95
+ });
96
+
97
+ it('should call the driver with the query', done => {
98
+ const testScheduler = new TestScheduler((actual, ex) => {
99
+ expect(actual).toEqual(ex);
100
+ });
101
+
102
+ const searchResultLoadSuccessAction = new DaffSearchLoadSuccess({
103
+ collection: mockCollection,
104
+ metadata: {},
105
+ });
106
+
107
+ testScheduler.run(({ hot, expectObservable }) => {
108
+ actions$ = hot('--a', { a: searchLoadAction });
109
+
110
+ const expectedMarble = '--a';
111
+ const expectedValue = {
112
+ a: searchResultLoadSuccessAction,
113
+ };
114
+
115
+ expectObservable(
116
+ effects.search$.pipe(
117
+ tap(() => {
118
+ expect(driverSearchSpy).toHaveBeenCalledWith(query, options);
119
+ done();
120
+ }),
121
+ ),
122
+ ).toBe(expectedMarble, expectedValue);
123
+ });
124
+ });
125
+
126
+ describe('and the call to SearchDriver is successful', () => {
127
+ it('should return a DaffSearchLoadSucess action', () => {
128
+ const testScheduler = new TestScheduler((actual, ex) => {
129
+ expect(actual).toEqual(ex);
130
+ });
131
+
132
+ const searchResultLoadSuccessAction = new DaffSearchLoadSuccess({
133
+ collection: mockCollection,
134
+ metadata: {},
135
+ });
136
+
137
+ testScheduler.run(({ hot, expectObservable }) => {
138
+ actions$ = hot('--a', { a: searchLoadAction });
139
+
140
+ const expectedMarble = '--a';
141
+ const expectedValue = {
142
+ a: searchResultLoadSuccessAction,
143
+ };
144
+
145
+ expectObservable(
146
+ effects.search$,
147
+ ).toBe(expectedMarble, expectedValue);
148
+ });
149
+ });
150
+ });
151
+
152
+ describe('and the call to SearchDriver fails', () => {
153
+ let searchResultLoadFailureAction: DaffSearchLoadFailure;
154
+
155
+ it('should return a DaffSearchLoadFailure action', () => {
156
+ const testScheduler = new TestScheduler((actual, ex) => {
157
+ expect(actual).toEqual(ex);
158
+ });
159
+
160
+ testScheduler.run(({ hot, expectObservable, cold }) => {
161
+ const error = new DaffSearchInvalidAPIResponseError('Failed to search');
162
+ const response = cold<DaffSearchDriverResponse>('#', {}, error);
163
+ driverSearchSpy.and.returnValue(response);
164
+ searchResultLoadFailureAction = new DaffSearchLoadFailure(daffTransformErrorToStateError(error));
165
+ actions$ = hot('--a', { a: searchLoadAction });
166
+
167
+ const expectedMarble = '--a';
168
+ const expectedValue = {
169
+ a: searchResultLoadFailureAction,
170
+ };
171
+
172
+ expectObservable(
173
+ effects.search$,
174
+ ).toBe(expectedMarble, expectedValue);
175
+ });
176
+ });
177
+ });
178
+ });
179
+ });
@@ -0,0 +1,57 @@
1
+ import {
2
+ Injectable,
3
+ Inject,
4
+ } from '@angular/core';
5
+ import {
6
+ Actions,
7
+ createEffect,
8
+ ofType,
9
+ } from '@ngrx/effects';
10
+ import { of } from 'rxjs';
11
+ import {
12
+ switchMap,
13
+ map,
14
+ catchError,
15
+ } from 'rxjs/operators';
16
+
17
+ import { DaffError } from '@daffodil/core';
18
+ import { ErrorTransformer } from '@daffodil/core/state';
19
+ import {
20
+ DaffSearchResult,
21
+ DAFF_SEARCH_ERROR_MATCHER,
22
+ } from '@daffodil/search';
23
+ import {
24
+ DaffSearchDriverInterface,
25
+ DaffSearchDriver,
26
+ } from '@daffodil/search/driver';
27
+
28
+ import {
29
+ DaffSearchActionTypes,
30
+ DaffSearchLoad,
31
+ DaffSearchLoadSuccess,
32
+ DaffSearchLoadFailure,
33
+ } from '../actions/search.actions';
34
+
35
+ @Injectable()
36
+ export class DaffSearchPageEffects<
37
+ T extends DaffSearchResult = DaffSearchResult,
38
+ > {
39
+ constructor(
40
+ private actions$: Actions,
41
+ @Inject(DaffSearchDriver) private driver: DaffSearchDriverInterface<T>,
42
+ @Inject(DAFF_SEARCH_ERROR_MATCHER) private errorMatcher: ErrorTransformer,
43
+ ) {}
44
+
45
+ /**
46
+ * An effect for searching with the provided driver.
47
+ */
48
+ search$ = createEffect(() => this.actions$.pipe(
49
+ ofType(DaffSearchActionTypes.SearchLoadAction),
50
+ switchMap((action: DaffSearchLoad) =>
51
+ this.driver.search(action.query, action.options).pipe(
52
+ map(resp => new DaffSearchLoadSuccess<T>(resp)),
53
+ catchError((error: DaffError) => of(new DaffSearchLoadFailure(this.errorMatcher(error)))),
54
+ ),
55
+ ),
56
+ ));
57
+ }
@@ -0,0 +1,4 @@
1
+ export { DaffSearchFacadeInterface } from './search/search-facade.interface';
2
+ export { DaffSearchFacadeBase } from './search/base.facade';
3
+ export { DaffSearchIncrementalFacade } from './search/incremental.facade';
4
+ export { DaffSearchPageFacade } from './search/page.facade';
@@ -0,0 +1,148 @@
1
+ import { Injectable } from '@angular/core';
2
+ import { TestBed } from '@angular/core/testing';
3
+ import {
4
+ StoreModule,
5
+ combineReducers,
6
+ Store,
7
+ } from '@ngrx/store';
8
+ import { cold } from 'jasmine-marbles';
9
+
10
+ import { DaffStateError } from '@daffodil/core/state';
11
+ import {
12
+ DaffSearchResult,
13
+ DaffSearchResultCollection,
14
+ daffSearchTransformResultsToCollection,
15
+ } from '@daffodil/search';
16
+ import {
17
+ DaffSearchLoad,
18
+ DaffSearchLoadSuccess,
19
+ DaffSearchLoadFailure,
20
+ DaffSearchStateRootSlice,
21
+ daffSearchReducers,
22
+ DAFF_SEARCH_STORE_FEATURE_KEY,
23
+ daffSearchGetPageSelectors,
24
+ } from '@daffodil/search/state';
25
+ import { DaffSearchResultFactory } from '@daffodil/search/testing';
26
+
27
+ import { DaffSearchFacadeBase } from './base.facade';
28
+
29
+ @Injectable()
30
+ export class TestFacade extends DaffSearchFacadeBase {
31
+ constructor(
32
+ store: Store<DaffSearchStateRootSlice>,
33
+ ) {
34
+ super(store, daffSearchGetPageSelectors());
35
+ }
36
+ }
37
+
38
+ describe('@daffodil/search/state | DaffSearchFacadeBase', () => {
39
+ let store: Store<DaffSearchStateRootSlice>;
40
+ let facade: TestFacade;
41
+ let searchResultFactory: DaffSearchResultFactory;
42
+
43
+ let mockSearchResult: DaffSearchResult;
44
+ let mockSearchResultCollection: DaffSearchResultCollection;
45
+ let searchResultId: DaffSearchResult['id'];
46
+ let errors: string[];
47
+
48
+ beforeEach(() => {
49
+ TestBed.configureTestingModule({
50
+ imports: [
51
+ StoreModule.forRoot({
52
+ [DAFF_SEARCH_STORE_FEATURE_KEY]: combineReducers(daffSearchReducers),
53
+ }),
54
+ ],
55
+ providers: [
56
+ TestFacade,
57
+ ],
58
+ });
59
+
60
+ store = TestBed.inject(Store);
61
+ facade = TestBed.inject(TestFacade);
62
+ searchResultFactory = TestBed.inject(DaffSearchResultFactory);
63
+
64
+ mockSearchResult = searchResultFactory.create();
65
+ mockSearchResultCollection = daffSearchTransformResultsToCollection([mockSearchResult]);
66
+ searchResultId = mockSearchResult.id;
67
+ errors = [];
68
+ });
69
+
70
+ it('should be created', () => {
71
+ expect(facade).toBeTruthy();
72
+ });
73
+
74
+ it('should be able to dispatch an action to the store', () => {
75
+ spyOn(store, 'dispatch');
76
+ const action = { type: 'SOME_TYPE' };
77
+
78
+ facade.dispatch(action);
79
+ expect(store.dispatch).toHaveBeenCalledWith(action);
80
+ expect(store.dispatch).toHaveBeenCalledTimes(1);
81
+ });
82
+
83
+ describe('loading$', () => {
84
+ it('should be false if the search is not loading', () => {
85
+ const expected = cold('a', { a: false });
86
+ expect(facade.loading$).toBeObservable(expected);
87
+ });
88
+
89
+ it('should be true if the search is loading', () => {
90
+ const expected = cold('a', { a: true });
91
+ store.dispatch(new DaffSearchLoad('query'));
92
+ expect(facade.loading$).toBeObservable(expected);
93
+ });
94
+ });
95
+
96
+ describe('errors$', () => {
97
+ it('should initially be an empty array', () => {
98
+ const expected = cold('a', { a: errors });
99
+ expect(facade.errors$).toBeObservable(expected);
100
+ });
101
+
102
+ it('should contain an error upon a failed load', () => {
103
+ const error: DaffStateError = { code: 'code', message: 'message' };
104
+ const expected = cold('a', { a: [error]});
105
+ store.dispatch(new DaffSearchLoadFailure(error));
106
+ expect(facade.errors$).toBeObservable(expected);
107
+ });
108
+ });
109
+
110
+ describe('recent$', () => {
111
+ it('should be the recent search queries', () => {
112
+ const expected = cold('a', { a: []});
113
+ expect(facade.recent$).toBeObservable(expected);
114
+ });
115
+ });
116
+
117
+ describe('searchResultIds$', () => {
118
+ it('should initially be an empty array', () => {
119
+ const expected = cold('a', { a: {}});
120
+ expect(facade.searchResultIds$).toBeObservable(expected);
121
+ });
122
+
123
+ it('should contain the search id upon a successful search load', () => {
124
+ const expected = cold('a', { a: { [mockSearchResult.kind]: [searchResultId]}});
125
+ store.dispatch(new DaffSearchLoadSuccess({
126
+ collection: mockSearchResultCollection,
127
+ metadata: {},
128
+ }));
129
+ expect(facade.searchResultIds$).toBeObservable(expected);
130
+ });
131
+ });
132
+
133
+ describe('resultCount$', () => {
134
+ it('should initially be zero', () => {
135
+ const expected = cold('a', { a: 0 });
136
+ expect(facade.resultCount$).toBeObservable(expected);
137
+ });
138
+
139
+ it('should be one upon a successful search load', () => {
140
+ const expected = cold('a', { a: 1 });
141
+ store.dispatch(new DaffSearchLoadSuccess({
142
+ collection: mockSearchResultCollection,
143
+ metadata: {},
144
+ }));
145
+ expect(facade.resultCount$).toBeObservable(expected);
146
+ });
147
+ });
148
+ });