1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
|
import { HttpClient, HttpErrorResponse } from '@angular/common/http';
import { HttpClientTestingModule, HttpTestingController } from '@angular/common/http/testing';
import { fakeAsync, TestBed, tick } from '@angular/core/testing';
import { Router } from '@angular/router';
import { ToastrService } from 'ngx-toastr';
import { AppModule } from '~/app/app.module';
import { configureTestBed } from '~/testing/unit-test-helper';
import { NotificationType } from '../enum/notification-type.enum';
import { CdNotification, CdNotificationConfig } from '../models/cd-notification';
import { ApiInterceptorService } from './api-interceptor.service';
import { NotificationService } from './notification.service';
describe('ApiInterceptorService', () => {
let notificationService: NotificationService;
let httpTesting: HttpTestingController;
let httpClient: HttpClient;
let router: Router;
const url = 'api/xyz';
const httpError = (error: any, errorOpts: object, done = (_resp: any): any => undefined) => {
httpClient.get(url).subscribe(
() => true,
(resp) => {
// Error must have been forwarded by the interceptor.
expect(resp instanceof HttpErrorResponse).toBeTruthy();
done(resp);
}
);
httpTesting.expectOne(url).error(error, errorOpts);
};
const runRouterTest = (errorOpts: object, expectedCallParams: any[]) => {
httpError(new ErrorEvent('abc'), errorOpts);
httpTesting.verify();
expect(router.navigate).toHaveBeenCalledWith(...expectedCallParams);
};
const runNotificationTest = (
error: any,
errorOpts: object,
expectedCallParams: CdNotification
) => {
httpError(error, errorOpts);
httpTesting.verify();
expect(notificationService.show).toHaveBeenCalled();
expect(notificationService.save).toHaveBeenCalledWith(expectedCallParams);
};
const createCdNotification = (
type: NotificationType,
title?: string,
message?: string,
options?: any,
application?: string
) => {
return new CdNotification(new CdNotificationConfig(type, title, message, options, application));
};
configureTestBed({
imports: [AppModule, HttpClientTestingModule],
providers: [
NotificationService,
{
provide: ToastrService,
useValue: {
error: () => true
}
}
]
});
beforeEach(() => {
const baseTime = new Date('2022-02-22');
spyOn(global, 'Date').and.returnValue(baseTime);
httpClient = TestBed.inject(HttpClient);
httpTesting = TestBed.inject(HttpTestingController);
notificationService = TestBed.inject(NotificationService);
spyOn(notificationService, 'show').and.callThrough();
spyOn(notificationService, 'save');
router = TestBed.inject(Router);
spyOn(router, 'navigate');
});
it('should be created', () => {
const service = TestBed.inject(ApiInterceptorService);
expect(service).toBeTruthy();
});
describe('test different error behaviours', () => {
beforeEach(() => {
spyOn(window, 'setTimeout').and.callFake((fn) => fn());
});
it('should redirect 401', () => {
runRouterTest(
{
status: 401
},
[['/login']]
);
});
it('should redirect 403', () => {
runRouterTest(
{
status: 403
},
[['error'], {'state': {'header': 'Access Denied', 'icon': 'fa fa-lock', 'message': 'Sorry, you don’t have permission to view this page or resource.', 'source': 'forbidden'}}] // prettier-ignore
);
});
it('should show notification (error string)', () => {
runNotificationTest(
'foobar',
{
status: 500,
statusText: 'Foo Bar'
},
createCdNotification(0, '500 - Foo Bar', 'foobar')
);
});
it('should show notification (error object, triggered from backend)', () => {
runNotificationTest(
{ detail: 'abc' },
{
status: 504,
statusText: 'AAA bbb CCC'
},
createCdNotification(0, '504 - AAA bbb CCC', 'abc')
);
});
it('should show notification (error object with unknown keys)', () => {
runNotificationTest(
{ type: 'error' },
{
status: 0,
statusText: 'Unknown Error',
message: 'Http failure response for (unknown url): 0 Unknown Error',
name: 'HttpErrorResponse',
ok: false,
url: null
},
createCdNotification(
0,
'0 - Unknown Error',
'Http failure response for api/xyz: 0 Unknown Error'
)
);
});
it('should show notification (undefined error)', () => {
runNotificationTest(
undefined,
{
status: 502
},
createCdNotification(0, '502 - Unknown Error', 'Http failure response for api/xyz: 502 ')
);
});
it('should show 400 notification', () => {
spyOn(notificationService, 'notifyTask');
httpError({ task: { name: 'mytask', metadata: { component: 'foobar' } } }, { status: 400 });
httpTesting.verify();
expect(notificationService.show).toHaveBeenCalledTimes(0);
expect(notificationService.notifyTask).toHaveBeenCalledWith({
exception: { task: { metadata: { component: 'foobar' }, name: 'mytask' } },
metadata: { component: 'foobar' },
name: 'mytask',
success: false
});
});
});
describe('interceptor error handling', () => {
const expectSaveToHaveBeenCalled = (called: boolean) => {
tick(510);
if (called) {
expect(notificationService.save).toHaveBeenCalled();
} else {
expect(notificationService.save).not.toHaveBeenCalled();
}
};
it('should show default behaviour', fakeAsync(() => {
httpError(undefined, { status: 500 });
expectSaveToHaveBeenCalled(true);
}));
it('should prevent the default behaviour with preventDefault', fakeAsync(() => {
httpError(undefined, { status: 500 }, (resp) => resp.preventDefault());
expectSaveToHaveBeenCalled(false);
}));
it('should be able to use preventDefault with 400 errors', fakeAsync(() => {
httpError(
{ task: { name: 'someName', metadata: { component: 'someComponent' } } },
{ status: 400 },
(resp) => resp.preventDefault()
);
expectSaveToHaveBeenCalled(false);
}));
it('should prevent the default behaviour by status code', fakeAsync(() => {
httpError(undefined, { status: 500 }, (resp) => resp.ignoreStatusCode(500));
expectSaveToHaveBeenCalled(false);
}));
it('should use different application icon (default Ceph) in error message', fakeAsync(() => {
const msg = 'Cannot connect to Alertmanager';
httpError(undefined, { status: 500 }, (resp) => {
(resp.application = 'Prometheus'), (resp.message = msg);
});
expectSaveToHaveBeenCalled(true);
expect(notificationService.save).toHaveBeenCalledWith(
createCdNotification(0, '500 - Unknown Error', msg, undefined, 'Prometheus')
);
}));
});
});
|
