@flusys/nestjs-shared 6.0.1 → 6.1.0
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.
- package/cjs/classes/api-controller.class.spec.js +684 -0
- package/cjs/classes/api-service.class.spec.js +809 -0
- package/cjs/classes/handle-custome-db.spec.js +82 -0
- package/cjs/classes/hybrid-cache.class.spec.js +168 -0
- package/cjs/classes/winston.logger.class.spec.js +330 -0
- package/cjs/constants/index.js +1 -1
- package/cjs/decorators/api-response.decorator.spec.js +126 -0
- package/cjs/decorators/current-user.decorator.spec.js +74 -0
- package/cjs/decorators/log-action.decorator.spec.js +353 -0
- package/cjs/decorators/public.decorator.spec.js +50 -0
- package/cjs/decorators/require-permission.decorator.spec.js +147 -0
- package/cjs/exceptions/base-app.exception.spec.js +157 -0
- package/cjs/exceptions/permission.exception.spec.js +82 -0
- package/cjs/filters/global-exception.filter.spec.js +440 -0
- package/cjs/guards/jwt-auth.guard.spec.js +75 -0
- package/cjs/guards/optional-jwt-auth.guard.spec.js +55 -0
- package/cjs/guards/permission.guard.js +11 -10
- package/cjs/guards/permission.guard.spec.js +358 -0
- package/cjs/interceptors/delete-empty-id-from-body.interceptor.spec.js +107 -0
- package/cjs/interceptors/idempotency.interceptor.spec.js +116 -0
- package/cjs/interceptors/response-meta.interceptor.spec.js +89 -0
- package/cjs/interceptors/set-user-field-on-body.interceptor.spec.js +128 -0
- package/cjs/interceptors/slug.interceptor.spec.js +110 -0
- package/cjs/interfaces/index.js +1 -0
- package/cjs/interfaces/permission-sync-adapter.interface.js +11 -0
- package/cjs/middlewares/logger.middleware.spec.js +462 -0
- package/cjs/modules/cache/cache.module.spec.js +48 -0
- package/cjs/modules/datasource/multi-tenant-datasource.service.spec.js +381 -0
- package/cjs/modules/utils/utils.service.spec.js +169 -0
- package/cjs/utils/date-time.util.spec.js +84 -0
- package/cjs/utils/html-sanitizer.util.spec.js +76 -0
- package/cjs/utils/index.js +1 -0
- package/cjs/utils/permission-cache-key.util.js +31 -0
- package/cjs/utils/permission-cache-key.util.spec.js +88 -0
- package/cjs/utils/query-helpers.util.spec.js +209 -0
- package/cjs/utils/request.util.spec.js +249 -0
- package/cjs/utils/string.util.spec.js +63 -0
- package/constants/index.d.ts +1 -1
- package/fesm/classes/api-controller.class.spec.js +680 -0
- package/fesm/classes/api-service.class.spec.js +805 -0
- package/fesm/classes/handle-custome-db.spec.js +78 -0
- package/fesm/classes/hybrid-cache.class.spec.js +164 -0
- package/fesm/classes/winston.logger.class.spec.js +327 -0
- package/fesm/constants/index.js +1 -1
- package/fesm/decorators/api-response.decorator.spec.js +122 -0
- package/fesm/decorators/current-user.decorator.spec.js +73 -0
- package/fesm/decorators/log-action.decorator.spec.js +349 -0
- package/fesm/decorators/public.decorator.spec.js +46 -0
- package/fesm/decorators/require-permission.decorator.spec.js +143 -0
- package/fesm/exceptions/base-app.exception.spec.js +153 -0
- package/fesm/exceptions/permission.exception.spec.js +78 -0
- package/fesm/filters/global-exception.filter.spec.js +436 -0
- package/fesm/guards/jwt-auth.guard.spec.js +71 -0
- package/fesm/guards/optional-jwt-auth.guard.spec.js +51 -0
- package/fesm/guards/permission.guard.js +12 -11
- package/fesm/guards/permission.guard.spec.js +354 -0
- package/fesm/interceptors/delete-empty-id-from-body.interceptor.spec.js +103 -0
- package/fesm/interceptors/idempotency.interceptor.spec.js +112 -0
- package/fesm/interceptors/response-meta.interceptor.spec.js +85 -0
- package/fesm/interceptors/set-user-field-on-body.interceptor.spec.js +124 -0
- package/fesm/interceptors/slug.interceptor.spec.js +106 -0
- package/fesm/interfaces/index.js +1 -0
- package/fesm/interfaces/permission-sync-adapter.interface.js +1 -0
- package/fesm/middlewares/logger.middleware.spec.js +459 -0
- package/fesm/modules/cache/cache.module.spec.js +44 -0
- package/fesm/modules/datasource/multi-tenant-datasource.service.spec.js +377 -0
- package/fesm/modules/utils/utils.service.spec.js +165 -0
- package/fesm/utils/date-time.util.spec.js +80 -0
- package/fesm/utils/html-sanitizer.util.spec.js +72 -0
- package/fesm/utils/index.js +1 -0
- package/fesm/utils/permission-cache-key.util.js +10 -0
- package/fesm/utils/permission-cache-key.util.spec.js +84 -0
- package/fesm/utils/query-helpers.util.spec.js +205 -0
- package/fesm/utils/request.util.spec.js +245 -0
- package/fesm/utils/string.util.spec.js +59 -0
- package/guards/permission.guard.d.ts +0 -1
- package/interfaces/index.d.ts +1 -0
- package/interfaces/permission-sync-adapter.interface.d.ts +7 -0
- package/package.json +2 -2
- package/utils/index.d.ts +1 -0
- package/utils/permission-cache-key.util.d.ts +9 -0
|
@@ -0,0 +1,805 @@
|
|
|
1
|
+
function _define_property(obj, key, value) {
|
|
2
|
+
if (key in obj) {
|
|
3
|
+
Object.defineProperty(obj, key, {
|
|
4
|
+
value: value,
|
|
5
|
+
enumerable: true,
|
|
6
|
+
configurable: true,
|
|
7
|
+
writable: true
|
|
8
|
+
});
|
|
9
|
+
} else {
|
|
10
|
+
obj[key] = value;
|
|
11
|
+
}
|
|
12
|
+
return obj;
|
|
13
|
+
}
|
|
14
|
+
import { Logger, InternalServerErrorException, NotFoundException } from '@nestjs/common';
|
|
15
|
+
import { createMockRepository, createMockDataSourceProvider } from '@test-utils/mocks/repository.mock';
|
|
16
|
+
import { buildMockUser } from '@test-utils/mocks/logged-user.mock';
|
|
17
|
+
import { ApiService } from './api-service.class';
|
|
18
|
+
import { UtilsService } from '../modules/utils/utils.service';
|
|
19
|
+
import { Identity } from '../entities';
|
|
20
|
+
let TestEntity = class TestEntity extends Identity {
|
|
21
|
+
constructor(...args){
|
|
22
|
+
super(...args), _define_property(this, "name", void 0);
|
|
23
|
+
}
|
|
24
|
+
};
|
|
25
|
+
let TestApiService = class TestApiService extends ApiService {
|
|
26
|
+
};
|
|
27
|
+
function createMockQueryRunner() {
|
|
28
|
+
return {
|
|
29
|
+
connect: jest.fn(),
|
|
30
|
+
startTransaction: jest.fn(),
|
|
31
|
+
commitTransaction: jest.fn(),
|
|
32
|
+
rollbackTransaction: jest.fn(),
|
|
33
|
+
release: jest.fn(),
|
|
34
|
+
manager: {
|
|
35
|
+
save: jest.fn(),
|
|
36
|
+
update: jest.fn(),
|
|
37
|
+
delete: jest.fn(),
|
|
38
|
+
softDelete: jest.fn(),
|
|
39
|
+
restore: jest.fn()
|
|
40
|
+
}
|
|
41
|
+
};
|
|
42
|
+
}
|
|
43
|
+
describe('ApiService', ()=>{
|
|
44
|
+
let mockRepo;
|
|
45
|
+
let mockCache;
|
|
46
|
+
let utilsService;
|
|
47
|
+
let mockQueryRunner;
|
|
48
|
+
let mockUser;
|
|
49
|
+
let debugSpy;
|
|
50
|
+
let errorLogSpy;
|
|
51
|
+
function makeService(isCacheable = false) {
|
|
52
|
+
const dataSourceProvider = createMockDataSourceProvider(mockRepo);
|
|
53
|
+
return new TestApiService('test-entity', mockCache, utilsService, 'TestApiService', isCacheable, undefined, TestEntity, dataSourceProvider);
|
|
54
|
+
}
|
|
55
|
+
beforeEach(()=>{
|
|
56
|
+
mockRepo = createMockRepository();
|
|
57
|
+
mockRepo.create.mockReturnValue({});
|
|
58
|
+
mockQueryRunner = createMockQueryRunner();
|
|
59
|
+
mockRepo.manager.connection.createQueryRunner = jest.fn().mockReturnValue(mockQueryRunner);
|
|
60
|
+
mockCache = {
|
|
61
|
+
get: jest.fn(),
|
|
62
|
+
set: jest.fn(),
|
|
63
|
+
del: jest.fn()
|
|
64
|
+
};
|
|
65
|
+
utilsService = new UtilsService();
|
|
66
|
+
mockUser = buildMockUser();
|
|
67
|
+
// LogAction falls back to a real Nest Logger when no moduleName is set — silence it.
|
|
68
|
+
debugSpy = jest.spyOn(Logger.prototype, 'debug').mockImplementation(()=>undefined);
|
|
69
|
+
errorLogSpy = jest.spyOn(Logger.prototype, 'error').mockImplementation(()=>undefined);
|
|
70
|
+
});
|
|
71
|
+
afterEach(()=>{
|
|
72
|
+
debugSpy.mockRestore();
|
|
73
|
+
errorLogSpy.mockRestore();
|
|
74
|
+
jest.clearAllMocks();
|
|
75
|
+
});
|
|
76
|
+
describe('insert', ()=>{
|
|
77
|
+
it('should save a new entity and return the converted response dto', async ()=>{
|
|
78
|
+
const service = makeService();
|
|
79
|
+
const created = {
|
|
80
|
+
id: undefined,
|
|
81
|
+
name: 'x'
|
|
82
|
+
};
|
|
83
|
+
mockRepo.create.mockReturnValue(created);
|
|
84
|
+
mockQueryRunner.manager.save.mockResolvedValue({
|
|
85
|
+
id: 'new-1',
|
|
86
|
+
name: 'Widget'
|
|
87
|
+
});
|
|
88
|
+
const result = await service.insert({
|
|
89
|
+
name: 'Widget'
|
|
90
|
+
}, mockUser);
|
|
91
|
+
expect(mockQueryRunner.connect).toHaveBeenCalled();
|
|
92
|
+
expect(mockQueryRunner.startTransaction).toHaveBeenCalled();
|
|
93
|
+
expect(mockQueryRunner.manager.save).toHaveBeenCalledWith(mockRepo.target, [
|
|
94
|
+
expect.objectContaining({
|
|
95
|
+
name: 'Widget'
|
|
96
|
+
})
|
|
97
|
+
]);
|
|
98
|
+
expect(mockQueryRunner.commitTransaction).toHaveBeenCalled();
|
|
99
|
+
expect(mockQueryRunner.release).toHaveBeenCalled();
|
|
100
|
+
expect(result).toEqual({
|
|
101
|
+
id: 'new-1',
|
|
102
|
+
name: 'Widget'
|
|
103
|
+
});
|
|
104
|
+
});
|
|
105
|
+
it('should look up and merge onto the existing entity when the dto carries an id', async ()=>{
|
|
106
|
+
const service = makeService();
|
|
107
|
+
const existing = {
|
|
108
|
+
id: 'existing-1',
|
|
109
|
+
name: 'Old'
|
|
110
|
+
};
|
|
111
|
+
mockRepo.findOne.mockResolvedValue(existing);
|
|
112
|
+
mockQueryRunner.manager.save.mockImplementation((_target, entities)=>entities);
|
|
113
|
+
await service.insert({
|
|
114
|
+
id: 'existing-1',
|
|
115
|
+
name: 'New'
|
|
116
|
+
}, mockUser);
|
|
117
|
+
expect(mockRepo.findOne).toHaveBeenCalledWith({
|
|
118
|
+
where: {
|
|
119
|
+
id: 'existing-1'
|
|
120
|
+
}
|
|
121
|
+
});
|
|
122
|
+
expect(mockQueryRunner.manager.save).toHaveBeenCalledWith(mockRepo.target, [
|
|
123
|
+
expect.objectContaining({
|
|
124
|
+
id: 'existing-1',
|
|
125
|
+
name: 'New'
|
|
126
|
+
})
|
|
127
|
+
]);
|
|
128
|
+
});
|
|
129
|
+
it('should throw NotFoundException and roll back when the dto id does not match any entity', async ()=>{
|
|
130
|
+
const service = makeService();
|
|
131
|
+
mockRepo.findOne.mockResolvedValue(null);
|
|
132
|
+
await expect(service.insert({
|
|
133
|
+
id: 'missing',
|
|
134
|
+
name: 'x'
|
|
135
|
+
}, mockUser)).rejects.toThrow(NotFoundException);
|
|
136
|
+
expect(mockQueryRunner.rollbackTransaction).toHaveBeenCalled();
|
|
137
|
+
expect(mockQueryRunner.release).toHaveBeenCalled();
|
|
138
|
+
});
|
|
139
|
+
it('should roll back and rethrow when save fails', async ()=>{
|
|
140
|
+
const service = makeService();
|
|
141
|
+
mockQueryRunner.manager.save.mockRejectedValue(new Error('db down'));
|
|
142
|
+
await expect(service.insert({
|
|
143
|
+
name: 'Widget'
|
|
144
|
+
}, mockUser)).rejects.toThrow('db down');
|
|
145
|
+
expect(mockQueryRunner.rollbackTransaction).toHaveBeenCalled();
|
|
146
|
+
expect(mockQueryRunner.commitTransaction).not.toHaveBeenCalled();
|
|
147
|
+
});
|
|
148
|
+
it('should wrap a non-Error rejection in InternalServerErrorException', async ()=>{
|
|
149
|
+
const service = makeService();
|
|
150
|
+
mockQueryRunner.manager.save.mockRejectedValue('raw string failure');
|
|
151
|
+
await expect(service.insert({
|
|
152
|
+
name: 'Widget'
|
|
153
|
+
}, mockUser)).rejects.toThrow(InternalServerErrorException);
|
|
154
|
+
});
|
|
155
|
+
it('should clear cache entries only when the service is cacheable', async ()=>{
|
|
156
|
+
const cacheableService = makeService(true);
|
|
157
|
+
mockQueryRunner.manager.save.mockResolvedValue({
|
|
158
|
+
id: 'new-1',
|
|
159
|
+
name: 'Widget'
|
|
160
|
+
});
|
|
161
|
+
mockCache.get.mockResolvedValue([]);
|
|
162
|
+
await cacheableService.insert({
|
|
163
|
+
name: 'Widget'
|
|
164
|
+
}, mockUser);
|
|
165
|
+
expect(mockCache.del).toHaveBeenCalled();
|
|
166
|
+
});
|
|
167
|
+
it('should not touch the cache when the service is not cacheable', async ()=>{
|
|
168
|
+
const service = makeService(false);
|
|
169
|
+
mockQueryRunner.manager.save.mockResolvedValue({
|
|
170
|
+
id: 'new-1',
|
|
171
|
+
name: 'Widget'
|
|
172
|
+
});
|
|
173
|
+
await service.insert({
|
|
174
|
+
name: 'Widget'
|
|
175
|
+
}, mockUser);
|
|
176
|
+
expect(mockCache.get).not.toHaveBeenCalled();
|
|
177
|
+
expect(mockCache.del).not.toHaveBeenCalled();
|
|
178
|
+
});
|
|
179
|
+
});
|
|
180
|
+
describe('insertMany', ()=>{
|
|
181
|
+
it('should save every dto and return one response entry per saved entity', async ()=>{
|
|
182
|
+
const service = makeService();
|
|
183
|
+
mockQueryRunner.manager.save.mockResolvedValue([
|
|
184
|
+
{
|
|
185
|
+
id: '1',
|
|
186
|
+
name: 'A'
|
|
187
|
+
},
|
|
188
|
+
{
|
|
189
|
+
id: '2',
|
|
190
|
+
name: 'B'
|
|
191
|
+
}
|
|
192
|
+
]);
|
|
193
|
+
const result = await service.insertMany([
|
|
194
|
+
{
|
|
195
|
+
name: 'A'
|
|
196
|
+
},
|
|
197
|
+
{
|
|
198
|
+
name: 'B'
|
|
199
|
+
}
|
|
200
|
+
], mockUser);
|
|
201
|
+
expect(result).toEqual([
|
|
202
|
+
{
|
|
203
|
+
id: '1',
|
|
204
|
+
name: 'A'
|
|
205
|
+
},
|
|
206
|
+
{
|
|
207
|
+
id: '2',
|
|
208
|
+
name: 'B'
|
|
209
|
+
}
|
|
210
|
+
]);
|
|
211
|
+
});
|
|
212
|
+
});
|
|
213
|
+
describe('update / updateMany', ()=>{
|
|
214
|
+
it('should update a single entity in place', async ()=>{
|
|
215
|
+
const service = makeService();
|
|
216
|
+
mockRepo.findOne.mockResolvedValue({
|
|
217
|
+
id: '1',
|
|
218
|
+
name: 'Old'
|
|
219
|
+
});
|
|
220
|
+
mockQueryRunner.manager.save.mockResolvedValue({
|
|
221
|
+
id: '1',
|
|
222
|
+
name: 'Updated'
|
|
223
|
+
});
|
|
224
|
+
const result = await service.update({
|
|
225
|
+
id: '1',
|
|
226
|
+
name: 'Updated'
|
|
227
|
+
}, mockUser);
|
|
228
|
+
expect(result).toEqual({
|
|
229
|
+
id: '1',
|
|
230
|
+
name: 'Updated'
|
|
231
|
+
});
|
|
232
|
+
});
|
|
233
|
+
it('should update multiple entities and return all of them', async ()=>{
|
|
234
|
+
const service = makeService();
|
|
235
|
+
mockRepo.findOne.mockResolvedValue({
|
|
236
|
+
id: 'x',
|
|
237
|
+
name: 'Old'
|
|
238
|
+
});
|
|
239
|
+
mockQueryRunner.manager.save.mockResolvedValue([
|
|
240
|
+
{
|
|
241
|
+
id: '1',
|
|
242
|
+
name: 'A2'
|
|
243
|
+
},
|
|
244
|
+
{
|
|
245
|
+
id: '2',
|
|
246
|
+
name: 'B2'
|
|
247
|
+
}
|
|
248
|
+
]);
|
|
249
|
+
const result = await service.updateMany([
|
|
250
|
+
{
|
|
251
|
+
id: '1',
|
|
252
|
+
name: 'A2'
|
|
253
|
+
},
|
|
254
|
+
{
|
|
255
|
+
id: '2',
|
|
256
|
+
name: 'B2'
|
|
257
|
+
}
|
|
258
|
+
], mockUser);
|
|
259
|
+
expect(result).toHaveLength(2);
|
|
260
|
+
});
|
|
261
|
+
it('should throw NotFoundException when the id to update does not exist', async ()=>{
|
|
262
|
+
const service = makeService();
|
|
263
|
+
mockRepo.findOne.mockResolvedValue(null);
|
|
264
|
+
await expect(service.update({
|
|
265
|
+
id: 'missing',
|
|
266
|
+
name: 'x'
|
|
267
|
+
}, mockUser)).rejects.toThrow(NotFoundException);
|
|
268
|
+
expect(mockQueryRunner.rollbackTransaction).toHaveBeenCalled();
|
|
269
|
+
});
|
|
270
|
+
});
|
|
271
|
+
describe('bulkUpsert', ()=>{
|
|
272
|
+
it('should run insert and update phases and combine the results', async ()=>{
|
|
273
|
+
const service = makeService();
|
|
274
|
+
mockRepo.findOne.mockResolvedValue({
|
|
275
|
+
id: 'existing-1',
|
|
276
|
+
name: 'Old'
|
|
277
|
+
});
|
|
278
|
+
mockQueryRunner.manager.save.mockResolvedValueOnce([
|
|
279
|
+
{
|
|
280
|
+
id: 'new-1',
|
|
281
|
+
name: 'Inserted'
|
|
282
|
+
}
|
|
283
|
+
]).mockResolvedValueOnce([
|
|
284
|
+
{
|
|
285
|
+
id: 'existing-1',
|
|
286
|
+
name: 'Updated'
|
|
287
|
+
}
|
|
288
|
+
]);
|
|
289
|
+
const result = await service.bulkUpsert([
|
|
290
|
+
{
|
|
291
|
+
name: 'Inserted'
|
|
292
|
+
}
|
|
293
|
+
], [
|
|
294
|
+
{
|
|
295
|
+
id: 'existing-1',
|
|
296
|
+
name: 'Updated'
|
|
297
|
+
}
|
|
298
|
+
], mockUser);
|
|
299
|
+
expect(result).toEqual([
|
|
300
|
+
{
|
|
301
|
+
id: 'new-1',
|
|
302
|
+
name: 'Inserted'
|
|
303
|
+
},
|
|
304
|
+
{
|
|
305
|
+
id: 'existing-1',
|
|
306
|
+
name: 'Updated'
|
|
307
|
+
}
|
|
308
|
+
]);
|
|
309
|
+
expect(mockQueryRunner.manager.save).toHaveBeenCalledTimes(2);
|
|
310
|
+
});
|
|
311
|
+
it('should skip the insert phase entirely when there is nothing to insert', async ()=>{
|
|
312
|
+
const service = makeService();
|
|
313
|
+
mockRepo.findOne.mockResolvedValue({
|
|
314
|
+
id: 'existing-1',
|
|
315
|
+
name: 'Old'
|
|
316
|
+
});
|
|
317
|
+
mockQueryRunner.manager.save.mockResolvedValue([
|
|
318
|
+
{
|
|
319
|
+
id: 'existing-1',
|
|
320
|
+
name: 'Updated'
|
|
321
|
+
}
|
|
322
|
+
]);
|
|
323
|
+
await service.bulkUpsert([], [
|
|
324
|
+
{
|
|
325
|
+
id: 'existing-1',
|
|
326
|
+
name: 'Updated'
|
|
327
|
+
}
|
|
328
|
+
], mockUser);
|
|
329
|
+
expect(mockQueryRunner.manager.save).toHaveBeenCalledTimes(1);
|
|
330
|
+
});
|
|
331
|
+
it('should skip the update phase entirely when there is nothing to update', async ()=>{
|
|
332
|
+
const service = makeService();
|
|
333
|
+
mockQueryRunner.manager.save.mockResolvedValue([
|
|
334
|
+
{
|
|
335
|
+
id: 'new-1',
|
|
336
|
+
name: 'Inserted'
|
|
337
|
+
}
|
|
338
|
+
]);
|
|
339
|
+
await service.bulkUpsert([
|
|
340
|
+
{
|
|
341
|
+
name: 'Inserted'
|
|
342
|
+
}
|
|
343
|
+
], [], mockUser);
|
|
344
|
+
expect(mockQueryRunner.manager.save).toHaveBeenCalledTimes(1);
|
|
345
|
+
});
|
|
346
|
+
});
|
|
347
|
+
describe('findByIds', ()=>{
|
|
348
|
+
it('should return converted results for matching ids', async ()=>{
|
|
349
|
+
const service = makeService();
|
|
350
|
+
const qb = mockRepo.createQueryBuilder();
|
|
351
|
+
qb.getMany.mockResolvedValue([
|
|
352
|
+
{
|
|
353
|
+
id: '1',
|
|
354
|
+
name: 'A'
|
|
355
|
+
},
|
|
356
|
+
{
|
|
357
|
+
id: '2',
|
|
358
|
+
name: 'B'
|
|
359
|
+
}
|
|
360
|
+
]);
|
|
361
|
+
const result = await service.findByIds([
|
|
362
|
+
'1',
|
|
363
|
+
'2'
|
|
364
|
+
], mockUser);
|
|
365
|
+
const whereArg = qb.where.mock.calls[0][0];
|
|
366
|
+
expect(whereArg.id._type).toBe('in');
|
|
367
|
+
expect(whereArg.id._value).toEqual([
|
|
368
|
+
'1',
|
|
369
|
+
'2'
|
|
370
|
+
]);
|
|
371
|
+
expect(result).toEqual([
|
|
372
|
+
{
|
|
373
|
+
id: '1',
|
|
374
|
+
name: 'A'
|
|
375
|
+
},
|
|
376
|
+
{
|
|
377
|
+
id: '2',
|
|
378
|
+
name: 'B'
|
|
379
|
+
}
|
|
380
|
+
]);
|
|
381
|
+
});
|
|
382
|
+
it('should accept a comma-separated select string and split it', async ()=>{
|
|
383
|
+
const service = makeService();
|
|
384
|
+
const qb = mockRepo.createQueryBuilder();
|
|
385
|
+
qb.getMany.mockResolvedValue([
|
|
386
|
+
{
|
|
387
|
+
id: '1',
|
|
388
|
+
name: 'A'
|
|
389
|
+
}
|
|
390
|
+
]);
|
|
391
|
+
await service.findByIds([
|
|
392
|
+
'1'
|
|
393
|
+
], mockUser, 'id, name');
|
|
394
|
+
expect(qb.select).toHaveBeenCalledWith([
|
|
395
|
+
'test-entity.id',
|
|
396
|
+
'test-entity.name'
|
|
397
|
+
]);
|
|
398
|
+
});
|
|
399
|
+
it('should throw NotFoundException when no rows match', async ()=>{
|
|
400
|
+
const service = makeService();
|
|
401
|
+
const qb = mockRepo.createQueryBuilder();
|
|
402
|
+
qb.getMany.mockResolvedValue([]);
|
|
403
|
+
await expect(service.findByIds([
|
|
404
|
+
'missing'
|
|
405
|
+
], mockUser)).rejects.toThrow(NotFoundException);
|
|
406
|
+
});
|
|
407
|
+
it('should wrap unexpected errors via handleError', async ()=>{
|
|
408
|
+
const service = makeService();
|
|
409
|
+
const qb = mockRepo.createQueryBuilder();
|
|
410
|
+
qb.getMany.mockRejectedValue('boom');
|
|
411
|
+
await expect(service.findByIds([
|
|
412
|
+
'1'
|
|
413
|
+
], mockUser)).rejects.toThrow(InternalServerErrorException);
|
|
414
|
+
});
|
|
415
|
+
});
|
|
416
|
+
describe('findById', ()=>{
|
|
417
|
+
it('should return the converted entity when found', async ()=>{
|
|
418
|
+
const service = makeService();
|
|
419
|
+
const qb = mockRepo.createQueryBuilder();
|
|
420
|
+
qb.getOne.mockResolvedValue({
|
|
421
|
+
id: '1',
|
|
422
|
+
name: 'A'
|
|
423
|
+
});
|
|
424
|
+
const result = await service.findById('1', mockUser);
|
|
425
|
+
expect(qb.where).toHaveBeenCalledWith({
|
|
426
|
+
id: '1'
|
|
427
|
+
});
|
|
428
|
+
expect(result).toEqual({
|
|
429
|
+
id: '1',
|
|
430
|
+
name: 'A'
|
|
431
|
+
});
|
|
432
|
+
});
|
|
433
|
+
it('should throw NotFoundException when nothing matches the id', async ()=>{
|
|
434
|
+
const service = makeService();
|
|
435
|
+
const qb = mockRepo.createQueryBuilder();
|
|
436
|
+
qb.getOne.mockResolvedValue(null);
|
|
437
|
+
await expect(service.findById('missing', mockUser)).rejects.toThrow(NotFoundException);
|
|
438
|
+
});
|
|
439
|
+
it('should return the cached value without querying when isCacheable and the cache hits', async ()=>{
|
|
440
|
+
const service = makeService(true);
|
|
441
|
+
mockCache.get.mockResolvedValue({
|
|
442
|
+
id: '1',
|
|
443
|
+
name: 'Cached'
|
|
444
|
+
});
|
|
445
|
+
const qb = mockRepo.createQueryBuilder();
|
|
446
|
+
const result = await service.findById('1', mockUser);
|
|
447
|
+
expect(result).toEqual({
|
|
448
|
+
id: '1',
|
|
449
|
+
name: 'Cached'
|
|
450
|
+
});
|
|
451
|
+
expect(qb.getOne).not.toHaveBeenCalled();
|
|
452
|
+
});
|
|
453
|
+
it('should query, then populate the cache on a miss when isCacheable', async ()=>{
|
|
454
|
+
const service = makeService(true);
|
|
455
|
+
mockCache.get.mockResolvedValue(undefined);
|
|
456
|
+
const qb = mockRepo.createQueryBuilder();
|
|
457
|
+
qb.getOne.mockResolvedValue({
|
|
458
|
+
id: '1',
|
|
459
|
+
name: 'Fresh'
|
|
460
|
+
});
|
|
461
|
+
const result = await service.findById('1', mockUser);
|
|
462
|
+
expect(result).toEqual({
|
|
463
|
+
id: '1',
|
|
464
|
+
name: 'Fresh'
|
|
465
|
+
});
|
|
466
|
+
expect(mockCache.set).toHaveBeenCalledWith(expect.any(String), {
|
|
467
|
+
id: '1',
|
|
468
|
+
name: 'Fresh'
|
|
469
|
+
});
|
|
470
|
+
});
|
|
471
|
+
it('should never touch the cache when the service is not cacheable', async ()=>{
|
|
472
|
+
const service = makeService(false);
|
|
473
|
+
const qb = mockRepo.createQueryBuilder();
|
|
474
|
+
qb.getOne.mockResolvedValue({
|
|
475
|
+
id: '1',
|
|
476
|
+
name: 'A'
|
|
477
|
+
});
|
|
478
|
+
await service.findById('1', mockUser);
|
|
479
|
+
expect(mockCache.get).not.toHaveBeenCalled();
|
|
480
|
+
expect(mockCache.set).not.toHaveBeenCalled();
|
|
481
|
+
});
|
|
482
|
+
});
|
|
483
|
+
describe('getAll', ()=>{
|
|
484
|
+
it('should return paginated, converted results', async ()=>{
|
|
485
|
+
const service = makeService();
|
|
486
|
+
const qb = mockRepo.createQueryBuilder();
|
|
487
|
+
qb.getManyAndCount.mockResolvedValue([
|
|
488
|
+
[
|
|
489
|
+
{
|
|
490
|
+
id: '1',
|
|
491
|
+
name: 'A'
|
|
492
|
+
}
|
|
493
|
+
],
|
|
494
|
+
1
|
|
495
|
+
]);
|
|
496
|
+
const result = await service.getAll('', {
|
|
497
|
+
pagination: {
|
|
498
|
+
currentPage: 0,
|
|
499
|
+
pageSize: 10
|
|
500
|
+
}
|
|
501
|
+
}, mockUser);
|
|
502
|
+
expect(result.data).toEqual([
|
|
503
|
+
{
|
|
504
|
+
id: '1',
|
|
505
|
+
name: 'A'
|
|
506
|
+
}
|
|
507
|
+
]);
|
|
508
|
+
expect(result.total).toBe(1);
|
|
509
|
+
expect(qb.skip).toHaveBeenCalledWith(0);
|
|
510
|
+
expect(qb.take).toHaveBeenCalledWith(10);
|
|
511
|
+
});
|
|
512
|
+
it('should compute the correct offset for page > 0', async ()=>{
|
|
513
|
+
const service = makeService();
|
|
514
|
+
const qb = mockRepo.createQueryBuilder();
|
|
515
|
+
qb.getManyAndCount.mockResolvedValue([
|
|
516
|
+
[],
|
|
517
|
+
0
|
|
518
|
+
]);
|
|
519
|
+
await service.getAll('', {
|
|
520
|
+
pagination: {
|
|
521
|
+
currentPage: 2,
|
|
522
|
+
pageSize: 25
|
|
523
|
+
}
|
|
524
|
+
}, mockUser);
|
|
525
|
+
expect(qb.skip).toHaveBeenCalledWith(50);
|
|
526
|
+
expect(qb.take).toHaveBeenCalledWith(25);
|
|
527
|
+
});
|
|
528
|
+
it('should apply filter conditions via andWhere', async ()=>{
|
|
529
|
+
const service = makeService();
|
|
530
|
+
const qb = mockRepo.createQueryBuilder();
|
|
531
|
+
qb.getManyAndCount.mockResolvedValue([
|
|
532
|
+
[],
|
|
533
|
+
0
|
|
534
|
+
]);
|
|
535
|
+
await service.getAll('', {
|
|
536
|
+
filter: {
|
|
537
|
+
isActive: true
|
|
538
|
+
}
|
|
539
|
+
}, mockUser);
|
|
540
|
+
expect(qb.andWhere).toHaveBeenCalledWith('test-entity.isActive = :value', {
|
|
541
|
+
value: true
|
|
542
|
+
});
|
|
543
|
+
});
|
|
544
|
+
it('should apply a global search filter when a search term is given', async ()=>{
|
|
545
|
+
const service = makeService();
|
|
546
|
+
const qb = mockRepo.createQueryBuilder();
|
|
547
|
+
qb.getManyAndCount.mockResolvedValue([
|
|
548
|
+
[],
|
|
549
|
+
0
|
|
550
|
+
]);
|
|
551
|
+
await service.getAll('widget', {}, mockUser);
|
|
552
|
+
expect(qb.andWhere).toHaveBeenCalledWith('test-entity.name LIKE :search', {
|
|
553
|
+
search: '%widget%'
|
|
554
|
+
});
|
|
555
|
+
});
|
|
556
|
+
it('should apply sort as addOrderBy', async ()=>{
|
|
557
|
+
const service = makeService();
|
|
558
|
+
const qb = mockRepo.createQueryBuilder();
|
|
559
|
+
qb.getManyAndCount.mockResolvedValue([
|
|
560
|
+
[],
|
|
561
|
+
0
|
|
562
|
+
]);
|
|
563
|
+
await service.getAll('', {
|
|
564
|
+
sort: {
|
|
565
|
+
name: 'DESC'
|
|
566
|
+
}
|
|
567
|
+
}, mockUser);
|
|
568
|
+
expect(qb.addOrderBy).toHaveBeenCalledWith('test-entity.name', 'DESC');
|
|
569
|
+
});
|
|
570
|
+
it('should include soft-deleted rows only when withDeleted is set', async ()=>{
|
|
571
|
+
const service = makeService();
|
|
572
|
+
const qb = mockRepo.createQueryBuilder();
|
|
573
|
+
qb.getManyAndCount.mockResolvedValue([
|
|
574
|
+
[],
|
|
575
|
+
0
|
|
576
|
+
]);
|
|
577
|
+
qb.withDeleted = jest.fn().mockReturnThis();
|
|
578
|
+
await service.getAll('', {
|
|
579
|
+
withDeleted: true
|
|
580
|
+
}, mockUser);
|
|
581
|
+
expect(qb.withDeleted).toHaveBeenCalled();
|
|
582
|
+
});
|
|
583
|
+
it('should return the cached page without querying on a cache hit', async ()=>{
|
|
584
|
+
const service = makeService(true);
|
|
585
|
+
const cached = {
|
|
586
|
+
data: [
|
|
587
|
+
{
|
|
588
|
+
id: '1',
|
|
589
|
+
name: 'Cached'
|
|
590
|
+
}
|
|
591
|
+
],
|
|
592
|
+
total: 1
|
|
593
|
+
};
|
|
594
|
+
mockCache.get.mockResolvedValue(cached);
|
|
595
|
+
const qb = mockRepo.createQueryBuilder();
|
|
596
|
+
const result = await service.getAll('', {}, mockUser);
|
|
597
|
+
expect(result).toBe(cached);
|
|
598
|
+
expect(qb.getManyAndCount).not.toHaveBeenCalled();
|
|
599
|
+
});
|
|
600
|
+
it('should populate the cache after a fresh query on a miss', async ()=>{
|
|
601
|
+
const service = makeService(true);
|
|
602
|
+
mockCache.get.mockResolvedValue(undefined);
|
|
603
|
+
const qb = mockRepo.createQueryBuilder();
|
|
604
|
+
qb.getManyAndCount.mockResolvedValue([
|
|
605
|
+
[
|
|
606
|
+
{
|
|
607
|
+
id: '1',
|
|
608
|
+
name: 'A'
|
|
609
|
+
}
|
|
610
|
+
],
|
|
611
|
+
1
|
|
612
|
+
]);
|
|
613
|
+
await service.getAll('', {}, mockUser);
|
|
614
|
+
expect(mockCache.set).toHaveBeenCalledWith(expect.any(String), {
|
|
615
|
+
data: [
|
|
616
|
+
{
|
|
617
|
+
id: '1',
|
|
618
|
+
name: 'A'
|
|
619
|
+
}
|
|
620
|
+
],
|
|
621
|
+
total: 1
|
|
622
|
+
});
|
|
623
|
+
});
|
|
624
|
+
it('should wrap query errors via handleError', async ()=>{
|
|
625
|
+
const service = makeService();
|
|
626
|
+
const qb = mockRepo.createQueryBuilder();
|
|
627
|
+
qb.getManyAndCount.mockRejectedValue(new Error('query failed'));
|
|
628
|
+
await expect(service.getAll('', {}, mockUser)).rejects.toThrow('query failed');
|
|
629
|
+
});
|
|
630
|
+
describe('raw query mode', ()=>{
|
|
631
|
+
let RawTestApiService = class RawTestApiService extends ApiService {
|
|
632
|
+
async getSelectQuery(query) {
|
|
633
|
+
return {
|
|
634
|
+
query,
|
|
635
|
+
isRaw: true
|
|
636
|
+
};
|
|
637
|
+
}
|
|
638
|
+
};
|
|
639
|
+
function makeRawService(dbType) {
|
|
640
|
+
mockRepo.manager.connection.options.type = dbType;
|
|
641
|
+
const dataSourceProvider = createMockDataSourceProvider(mockRepo);
|
|
642
|
+
return new RawTestApiService('test-entity', mockCache, utilsService, 'RawTestApiService', false, undefined, TestEntity, dataSourceProvider);
|
|
643
|
+
}
|
|
644
|
+
function primeRawQueryBuilder(qb) {
|
|
645
|
+
qb.expressionMap = {
|
|
646
|
+
orderBys: {
|
|
647
|
+
x: 'ASC'
|
|
648
|
+
}
|
|
649
|
+
};
|
|
650
|
+
qb.getQuery.mockReturnValue('SELECT * FROM test_entity');
|
|
651
|
+
qb.getQueryAndParameters.mockReturnValue([
|
|
652
|
+
'SELECT 1',
|
|
653
|
+
[]
|
|
654
|
+
]);
|
|
655
|
+
qb.getParameters.mockReturnValue({});
|
|
656
|
+
}
|
|
657
|
+
it('should build a postgres-style positional count query and use getRawMany for data', async ()=>{
|
|
658
|
+
const service = makeRawService('postgres');
|
|
659
|
+
const qb = mockRepo.createQueryBuilder();
|
|
660
|
+
primeRawQueryBuilder(qb);
|
|
661
|
+
qb.getRawMany.mockResolvedValue([
|
|
662
|
+
{
|
|
663
|
+
id: '1',
|
|
664
|
+
name: 'Raw'
|
|
665
|
+
}
|
|
666
|
+
]);
|
|
667
|
+
mockRepo.query.mockResolvedValue([
|
|
668
|
+
{
|
|
669
|
+
count: '3'
|
|
670
|
+
}
|
|
671
|
+
]);
|
|
672
|
+
const result = await service.getAll('', {}, mockUser);
|
|
673
|
+
expect(mockRepo.query).toHaveBeenCalledWith(expect.stringContaining('SELECT COUNT(*)'), []);
|
|
674
|
+
expect(result.total).toBe(3);
|
|
675
|
+
expect(result.data).toEqual([
|
|
676
|
+
{
|
|
677
|
+
id: '1',
|
|
678
|
+
name: 'Raw'
|
|
679
|
+
}
|
|
680
|
+
]);
|
|
681
|
+
});
|
|
682
|
+
it('should convert ? placeholders positionally for postgres and throw on a missing parameter', async ()=>{
|
|
683
|
+
const service = makeRawService('postgres');
|
|
684
|
+
const qb = mockRepo.createQueryBuilder();
|
|
685
|
+
primeRawQueryBuilder(qb);
|
|
686
|
+
// simulate a parameter referenced in SQL but absent from getParameters()
|
|
687
|
+
qb.getQuery = jest.fn().mockReturnValue('SELECT * FROM t WHERE id = :missingKey');
|
|
688
|
+
qb.getParameters = jest.fn().mockReturnValue({});
|
|
689
|
+
await expect(service.getAll('', {}, mockUser)).rejects.toThrow(InternalServerErrorException);
|
|
690
|
+
});
|
|
691
|
+
it('should use ? placeholders (unchanged) for mysql', async ()=>{
|
|
692
|
+
const service = makeRawService('mysql');
|
|
693
|
+
const qb = mockRepo.createQueryBuilder();
|
|
694
|
+
primeRawQueryBuilder(qb);
|
|
695
|
+
qb.getRawMany.mockResolvedValue([]);
|
|
696
|
+
mockRepo.query.mockResolvedValue([
|
|
697
|
+
{
|
|
698
|
+
count: '0'
|
|
699
|
+
}
|
|
700
|
+
]);
|
|
701
|
+
await service.getAll('', {}, mockUser);
|
|
702
|
+
const [sql] = mockRepo.query.mock.calls[0];
|
|
703
|
+
expect(sql).not.toContain('$1');
|
|
704
|
+
});
|
|
705
|
+
});
|
|
706
|
+
});
|
|
707
|
+
describe('delete', ()=>{
|
|
708
|
+
it('should soft-delete and stamp deletedById for type "delete"', async ()=>{
|
|
709
|
+
const service = makeService();
|
|
710
|
+
await service.delete({
|
|
711
|
+
id: '1',
|
|
712
|
+
type: 'delete',
|
|
713
|
+
deletedById: 'user-1'
|
|
714
|
+
}, mockUser);
|
|
715
|
+
expect(mockQueryRunner.manager.softDelete).toHaveBeenCalledWith(mockRepo.target, '1');
|
|
716
|
+
expect(mockQueryRunner.manager.update).toHaveBeenCalledWith(mockRepo.target, '1', {
|
|
717
|
+
deletedById: 'user-1'
|
|
718
|
+
});
|
|
719
|
+
expect(mockQueryRunner.commitTransaction).toHaveBeenCalled();
|
|
720
|
+
});
|
|
721
|
+
it('should restore and stamp deletedById for type "restore"', async ()=>{
|
|
722
|
+
const service = makeService();
|
|
723
|
+
await service.delete({
|
|
724
|
+
id: '1',
|
|
725
|
+
type: 'restore'
|
|
726
|
+
}, mockUser);
|
|
727
|
+
expect(mockQueryRunner.manager.restore).toHaveBeenCalledWith(mockRepo.target, '1');
|
|
728
|
+
expect(mockQueryRunner.manager.update).toHaveBeenCalled();
|
|
729
|
+
});
|
|
730
|
+
it('should hard-delete for any other type', async ()=>{
|
|
731
|
+
const service = makeService();
|
|
732
|
+
await service.delete({
|
|
733
|
+
id: '1',
|
|
734
|
+
type: 'permanent'
|
|
735
|
+
}, mockUser);
|
|
736
|
+
expect(mockQueryRunner.manager.delete).toHaveBeenCalledWith(mockRepo.target, '1');
|
|
737
|
+
expect(mockQueryRunner.manager.softDelete).not.toHaveBeenCalled();
|
|
738
|
+
});
|
|
739
|
+
it('should support deleting multiple ids at once', async ()=>{
|
|
740
|
+
const service = makeService();
|
|
741
|
+
await service.delete({
|
|
742
|
+
id: [
|
|
743
|
+
'1',
|
|
744
|
+
'2'
|
|
745
|
+
],
|
|
746
|
+
type: 'permanent'
|
|
747
|
+
}, mockUser);
|
|
748
|
+
expect(mockQueryRunner.manager.delete).toHaveBeenCalledWith(mockRepo.target, [
|
|
749
|
+
'1',
|
|
750
|
+
'2'
|
|
751
|
+
]);
|
|
752
|
+
});
|
|
753
|
+
it('should roll back and rethrow when the delete operation fails', async ()=>{
|
|
754
|
+
const service = makeService();
|
|
755
|
+
mockQueryRunner.manager.delete.mockRejectedValue(new Error('fk violation'));
|
|
756
|
+
await expect(service.delete({
|
|
757
|
+
id: '1',
|
|
758
|
+
type: 'permanent'
|
|
759
|
+
}, mockUser)).rejects.toThrow('fk violation');
|
|
760
|
+
expect(mockQueryRunner.rollbackTransaction).toHaveBeenCalled();
|
|
761
|
+
expect(mockQueryRunner.release).toHaveBeenCalled();
|
|
762
|
+
});
|
|
763
|
+
it('should always attempt cache invalidation, even when the service is not cacheable', async ()=>{
|
|
764
|
+
const service = makeService(false);
|
|
765
|
+
mockCache.get.mockResolvedValue([]);
|
|
766
|
+
await service.delete({
|
|
767
|
+
id: '1',
|
|
768
|
+
type: 'permanent'
|
|
769
|
+
}, mockUser);
|
|
770
|
+
expect(mockCache.del).toHaveBeenCalled();
|
|
771
|
+
});
|
|
772
|
+
it('should always release the query runner even after a successful commit', async ()=>{
|
|
773
|
+
const service = makeService();
|
|
774
|
+
await service.delete({
|
|
775
|
+
id: '1',
|
|
776
|
+
type: 'permanent'
|
|
777
|
+
}, mockUser);
|
|
778
|
+
expect(mockQueryRunner.release).toHaveBeenCalledTimes(1);
|
|
779
|
+
});
|
|
780
|
+
});
|
|
781
|
+
describe('clearCacheForAll / clearCacheForId', ()=>{
|
|
782
|
+
it('clearCacheForAll should delegate to utilsService.clearCache with the entity name', async ()=>{
|
|
783
|
+
const service = makeService();
|
|
784
|
+
const clearSpy = jest.spyOn(utilsService, 'clearCache');
|
|
785
|
+
mockCache.get.mockResolvedValue([]);
|
|
786
|
+
await service.clearCacheForAll();
|
|
787
|
+
expect(clearSpy).toHaveBeenCalledWith('test-entity', mockCache);
|
|
788
|
+
});
|
|
789
|
+
it('clearCacheForId should clear cache per entity id', async ()=>{
|
|
790
|
+
const service = makeService();
|
|
791
|
+
const clearSpy = jest.spyOn(utilsService, 'clearCache');
|
|
792
|
+
mockCache.get.mockResolvedValue([]);
|
|
793
|
+
await service.clearCacheForId([
|
|
794
|
+
{
|
|
795
|
+
id: 'a'
|
|
796
|
+
},
|
|
797
|
+
{
|
|
798
|
+
id: 'b'
|
|
799
|
+
}
|
|
800
|
+
]);
|
|
801
|
+
expect(clearSpy).toHaveBeenCalledWith('test-entity', mockCache, 'a');
|
|
802
|
+
expect(clearSpy).toHaveBeenCalledWith('test-entity', mockCache, 'b');
|
|
803
|
+
});
|
|
804
|
+
});
|
|
805
|
+
});
|