mongodb-dynamic-api 4.22.0 → 4.24.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/CHANGELOG.md +39 -0
- package/package.json +1 -1
- package/src/dtos/index.d.ts +1 -0
- package/src/dtos/index.js +1 -0
- package/src/dtos/index.js.map +1 -1
- package/src/dtos/paging.query.d.ts +4 -0
- package/src/dtos/paging.query.js +35 -0
- package/src/dtos/paging.query.js.map +1 -0
- package/src/dynamic-api.module.js +6 -3
- package/src/dynamic-api.module.js.map +1 -1
- package/src/guards/base-policies.guard.d.ts +4 -1
- package/src/guards/base-policies.guard.js +14 -3
- package/src/guards/base-policies.guard.js.map +1 -1
- package/src/helpers/cache-path-registry.store.d.ts +13 -0
- package/src/helpers/cache-path-registry.store.js +45 -0
- package/src/helpers/cache-path-registry.store.js.map +1 -0
- package/src/helpers/index.d.ts +3 -0
- package/src/helpers/index.js +3 -0
- package/src/helpers/index.js.map +1 -1
- package/src/helpers/mixin-data.helper.js +19 -0
- package/src/helpers/mixin-data.helper.js.map +1 -1
- package/src/helpers/paging-params.helper.d.ts +13 -0
- package/src/helpers/paging-params.helper.js +14 -0
- package/src/helpers/paging-params.helper.js.map +1 -0
- package/src/helpers/paging-presenter-warning.helper.d.ts +3 -0
- package/src/helpers/paging-presenter-warning.helper.js +16 -0
- package/src/helpers/paging-presenter-warning.helper.js.map +1 -0
- package/src/helpers/pipeline-paging.helper.d.ts +3 -0
- package/src/helpers/pipeline-paging.helper.js +13 -0
- package/src/helpers/pipeline-paging.helper.js.map +1 -0
- package/src/interceptors/dynamic-api-cache.interceptor.d.ts +5 -1
- package/src/interceptors/dynamic-api-cache.interceptor.js +18 -3
- package/src/interceptors/dynamic-api-cache.interceptor.js.map +1 -1
- package/src/interfaces/dynamic-api-cache-options.interface.d.ts +1 -0
- package/src/interfaces/dynamic-api-custom-route.interface.d.ts +8 -2
- package/src/interfaces/dynamic-api-global-state.interface.d.ts +1 -0
- package/src/interfaces/dynamic-api-service-callback.interface.d.ts +1 -0
- package/src/mixins/policies-guard.mixin.d.ts +8 -1
- package/src/mixins/policies-guard.mixin.js +6 -2
- package/src/mixins/policies-guard.mixin.js.map +1 -1
- package/src/modules/auth/services/base-auth.service.js +1 -1
- package/src/modules/auth/services/base-auth.service.js.map +1 -1
- package/src/modules/dynamic-api-config/dynamic-api-config.module.js +8 -1
- package/src/modules/dynamic-api-config/dynamic-api-config.module.js.map +1 -1
- package/src/routes/aggregate/aggregate-controller.mixin.js +2 -1
- package/src/routes/aggregate/aggregate-controller.mixin.js.map +1 -1
- package/src/routes/aggregate/aggregate-gateway.mixin.js +3 -1
- package/src/routes/aggregate/aggregate-gateway.mixin.js.map +1 -1
- package/src/routes/aggregate/base-aggregate.service.d.ts +0 -1
- package/src/routes/aggregate/base-aggregate.service.js +3 -11
- package/src/routes/aggregate/base-aggregate.service.js.map +1 -1
- package/src/routes/cache-purge/cache-purge.helper.js +5 -9
- package/src/routes/cache-purge/cache-purge.helper.js.map +1 -1
- package/src/routes/custom/create-custom-route-controller.js +83 -41
- package/src/routes/custom/create-custom-route-controller.js.map +1 -1
- package/src/routes/custom/create-custom-route-gateway.js +13 -6
- package/src/routes/custom/create-custom-route-gateway.js.map +1 -1
- package/src/routes/custom/custom-route-callback.service.d.ts +7 -0
- package/src/routes/custom/custom-route-callback.service.js +11 -0
- package/src/routes/custom/custom-route-callback.service.js.map +1 -0
- package/src/routes/get-many/get-many-controller.mixin.js +1 -1
- package/src/routes/get-many/get-many-controller.mixin.js.map +1 -1
- package/src/services/base/base.service.d.ts +4 -0
- package/src/services/base/base.service.js +58 -4
- package/src/services/base/base.service.js.map +1 -1
- package/src/services/dynamic-api-cache/dynamic-api-cache.service.d.ts +13 -0
- package/src/services/dynamic-api-cache/dynamic-api-cache.service.js +84 -0
- package/src/services/dynamic-api-cache/dynamic-api-cache.service.js.map +1 -0
- package/src/services/dynamic-api-global-state/dynamic-api-global-state.service.d.ts +1 -0
- package/src/services/dynamic-api-global-state/dynamic-api-global-state.service.js +4 -0
- package/src/services/dynamic-api-global-state/dynamic-api-global-state.service.js.map +1 -1
- package/src/services/index.d.ts +1 -0
- package/src/services/index.js +1 -0
- package/src/services/index.js.map +1 -1
- package/src/version.json +1 -1
- package/test/for-feature/aggregate-ability-predicate-paging.e2e-spec.d.ts +1 -0
- package/test/for-feature/aggregate-ability-predicate-paging.e2e-spec.js +157 -0
- package/test/for-feature/aggregate-ability-predicate-paging.e2e-spec.js.map +1 -0
- package/test/for-feature/aggregate-paging-without-from-aggregate.e2e-spec.d.ts +1 -0
- package/test/for-feature/aggregate-paging-without-from-aggregate.e2e-spec.js +68 -0
- package/test/for-feature/aggregate-paging-without-from-aggregate.e2e-spec.js.map +1 -0
- package/test/for-feature/cache-identity-key.e2e-spec.d.ts +1 -0
- package/test/for-feature/cache-identity-key.e2e-spec.js +120 -0
- package/test/for-feature/cache-identity-key.e2e-spec.js.map +1 -0
- package/test/for-feature/cache-scoped-invalidation.e2e-spec.d.ts +1 -0
- package/test/for-feature/cache-scoped-invalidation.e2e-spec.js +170 -0
- package/test/for-feature/cache-scoped-invalidation.e2e-spec.js.map +1 -0
- package/test/for-feature/custom-route-auth-ability-predicate.e2e-spec.d.ts +1 -0
- package/test/for-feature/custom-route-auth-ability-predicate.e2e-spec.js +108 -0
- package/test/for-feature/custom-route-auth-ability-predicate.e2e-spec.js.map +1 -0
- package/test/for-feature/custom-route-inject.e2e-spec.d.ts +1 -0
- package/test/for-feature/custom-route-inject.e2e-spec.js +101 -0
- package/test/for-feature/custom-route-inject.e2e-spec.js.map +1 -0
- package/test/for-feature/custom-route-params-openapi.e2e-spec.d.ts +1 -0
- package/test/for-feature/custom-route-params-openapi.e2e-spec.js +77 -0
- package/test/for-feature/custom-route-params-openapi.e2e-spec.js.map +1 -0
- package/test/for-feature/custom-route-target-param.e2e-spec.d.ts +1 -0
- package/test/for-feature/custom-route-target-param.e2e-spec.js +102 -0
- package/test/for-feature/custom-route-target-param.e2e-spec.js.map +1 -0
- package/test/for-feature/derived-fields-raw-write-recompute.e2e-spec.d.ts +1 -0
- package/test/for-feature/derived-fields-raw-write-recompute.e2e-spec.js +152 -0
- package/test/for-feature/derived-fields-raw-write-recompute.e2e-spec.js.map +1 -0
- package/test/for-feature/exclude-from-response.e2e-spec.d.ts +1 -0
- package/test/for-feature/exclude-from-response.e2e-spec.js +93 -0
- package/test/for-feature/exclude-from-response.e2e-spec.js.map +1 -0
- package/test/for-feature/index-sync.e2e-spec.js +42 -0
- package/test/for-feature/index-sync.e2e-spec.js.map +1 -1
- package/test/for-feature/paging-query-helper.e2e-spec.d.ts +1 -0
- package/test/for-feature/paging-query-helper.e2e-spec.js +92 -0
- package/test/for-feature/paging-query-helper.e2e-spec.js.map +1 -0
- package/test/for-root/auth-api-basic.e2e-spec.js +2 -0
- package/test/for-root/auth-api-basic.e2e-spec.js.map +1 -1
- package/test/for-root/auth-api-update-account-derived-field.e2e-spec.d.ts +1 -0
- package/test/for-root/auth-api-update-account-derived-field.e2e-spec.js +71 -0
- package/test/for-root/auth-api-update-account-derived-field.e2e-spec.js.map +1 -0
- package/test/for-root/initialization.e2e-spec.js +2 -0
- package/test/for-root/initialization.e2e-spec.js.map +1 -1
- package/test/for-root/websockets-auth-basic.e2e-spec.js +1 -0
- package/test/for-root/websockets-auth-basic.e2e-spec.js.map +1 -1
- package/tsconfig.tsbuildinfo +1 -1
|
@@ -0,0 +1,170 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
|
|
3
|
+
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
|
|
4
|
+
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
|
|
5
|
+
else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
|
|
6
|
+
return c > 3 && r && Object.defineProperty(target, key, r), r;
|
|
7
|
+
};
|
|
8
|
+
var __metadata = (this && this.__metadata) || function (k, v) {
|
|
9
|
+
if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
|
|
10
|
+
};
|
|
11
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
12
|
+
const mongoose_1 = require("@nestjs/mongoose");
|
|
13
|
+
const mongoose_2 = require("mongoose");
|
|
14
|
+
const src_1 = require("../../src");
|
|
15
|
+
const e2e_setup_1 = require("../e2e.setup");
|
|
16
|
+
require("dotenv/config");
|
|
17
|
+
const utils_1 = require("../utils");
|
|
18
|
+
const shared_1 = require("../shared");
|
|
19
|
+
describe('DynamicApiModule forFeature - scoped cache invalidation (e2e)', () => {
|
|
20
|
+
beforeEach(() => {
|
|
21
|
+
src_1.DynamicApiModule.state['resetState']();
|
|
22
|
+
});
|
|
23
|
+
afterEach(async () => {
|
|
24
|
+
await (0, e2e_setup_1.closeTestingApp)(mongoose_2.default.connections);
|
|
25
|
+
});
|
|
26
|
+
let CacheScopeProductEntity = class CacheScopeProductEntity extends src_1.BaseEntity {
|
|
27
|
+
};
|
|
28
|
+
__decorate([
|
|
29
|
+
(0, mongoose_1.Prop)({ type: String, required: true }),
|
|
30
|
+
__metadata("design:type", String)
|
|
31
|
+
], CacheScopeProductEntity.prototype, "name", void 0);
|
|
32
|
+
CacheScopeProductEntity = __decorate([
|
|
33
|
+
(0, mongoose_1.Schema)({ collection: 'cache_scope_products' })
|
|
34
|
+
], CacheScopeProductEntity);
|
|
35
|
+
let CacheScopeOrderEntity = class CacheScopeOrderEntity extends src_1.BaseEntity {
|
|
36
|
+
};
|
|
37
|
+
__decorate([
|
|
38
|
+
(0, mongoose_1.Prop)({ type: String, required: true }),
|
|
39
|
+
__metadata("design:type", String)
|
|
40
|
+
], CacheScopeOrderEntity.prototype, "label", void 0);
|
|
41
|
+
CacheScopeOrderEntity = __decorate([
|
|
42
|
+
(0, mongoose_1.Schema)({ collection: 'cache_scope_orders' })
|
|
43
|
+
], CacheScopeOrderEntity);
|
|
44
|
+
describe('F3 — write to one entity never invalidates another entity\'s cache', () => {
|
|
45
|
+
beforeEach(async () => {
|
|
46
|
+
await (0, shared_1.initApp)({
|
|
47
|
+
entity: CacheScopeProductEntity,
|
|
48
|
+
controllerOptions: { path: 'cache-scope-products', isPublic: true },
|
|
49
|
+
routes: [
|
|
50
|
+
{ type: 'GetMany' },
|
|
51
|
+
{ type: 'CreateOne' },
|
|
52
|
+
],
|
|
53
|
+
extraImports: [
|
|
54
|
+
src_1.DynamicApiModule.forFeature({
|
|
55
|
+
entity: CacheScopeOrderEntity,
|
|
56
|
+
controllerOptions: { path: 'cache-scope-orders', isPublic: true },
|
|
57
|
+
routes: [{ type: 'GetMany' }],
|
|
58
|
+
}),
|
|
59
|
+
],
|
|
60
|
+
});
|
|
61
|
+
});
|
|
62
|
+
it('should refresh the written entity\'s cache while leaving another entity\'s cache untouched', async () => {
|
|
63
|
+
const productModel = await (0, utils_1.getModelFromEntity)(CacheScopeProductEntity);
|
|
64
|
+
const orderModel = await (0, utils_1.getModelFromEntity)(CacheScopeOrderEntity);
|
|
65
|
+
await productModel.insertMany([{ name: 'product-1' }]);
|
|
66
|
+
await orderModel.insertMany([{ label: 'order-1' }]);
|
|
67
|
+
const productsFirst = await e2e_setup_1.server.get('/cache-scope-products');
|
|
68
|
+
const ordersFirst = await e2e_setup_1.server.get('/cache-scope-orders');
|
|
69
|
+
expect(productsFirst.body).toHaveLength(1);
|
|
70
|
+
expect(ordersFirst.body).toHaveLength(1);
|
|
71
|
+
await orderModel.insertMany([{ label: 'order-2' }]);
|
|
72
|
+
const created = await e2e_setup_1.server.post('/cache-scope-products', { name: 'product-2' });
|
|
73
|
+
expect(created.status).toBe(201);
|
|
74
|
+
const productsSecond = await e2e_setup_1.server.get('/cache-scope-products');
|
|
75
|
+
const ordersSecond = await e2e_setup_1.server.get('/cache-scope-orders');
|
|
76
|
+
expect(productsSecond.body).toHaveLength(2);
|
|
77
|
+
expect(ordersSecond.body).toHaveLength(1);
|
|
78
|
+
});
|
|
79
|
+
});
|
|
80
|
+
describe('F3 — the manual DELETE .../cache purge endpoint is scoped too', () => {
|
|
81
|
+
beforeEach(async () => {
|
|
82
|
+
await (0, shared_1.initApp)({
|
|
83
|
+
entity: CacheScopeProductEntity,
|
|
84
|
+
controllerOptions: { path: 'cache-scope-products', isPublic: true },
|
|
85
|
+
routes: [{ type: 'GetMany' }],
|
|
86
|
+
extraImports: [
|
|
87
|
+
src_1.DynamicApiModule.forFeature({
|
|
88
|
+
entity: CacheScopeOrderEntity,
|
|
89
|
+
controllerOptions: { path: 'cache-scope-orders', isPublic: true },
|
|
90
|
+
routes: [{ type: 'GetMany' }],
|
|
91
|
+
}),
|
|
92
|
+
],
|
|
93
|
+
});
|
|
94
|
+
});
|
|
95
|
+
it('should purge only the requested entity\'s cache, not every entity\'s', async () => {
|
|
96
|
+
const productModel = await (0, utils_1.getModelFromEntity)(CacheScopeProductEntity);
|
|
97
|
+
const orderModel = await (0, utils_1.getModelFromEntity)(CacheScopeOrderEntity);
|
|
98
|
+
await productModel.insertMany([{ name: 'product-1' }]);
|
|
99
|
+
await orderModel.insertMany([{ label: 'order-1' }]);
|
|
100
|
+
await e2e_setup_1.server.get('/cache-scope-products');
|
|
101
|
+
await e2e_setup_1.server.get('/cache-scope-orders');
|
|
102
|
+
await orderModel.insertMany([{ label: 'order-2' }]);
|
|
103
|
+
await productModel.insertMany([{ name: 'product-2' }]);
|
|
104
|
+
const purge = await e2e_setup_1.server.delete('/cache-scope-products/cache');
|
|
105
|
+
expect(purge.status).toBe(200);
|
|
106
|
+
expect(purge.body).toEqual({ purged: true });
|
|
107
|
+
const productsAfterPurge = await e2e_setup_1.server.get('/cache-scope-products');
|
|
108
|
+
const ordersAfterPurge = await e2e_setup_1.server.get('/cache-scope-orders');
|
|
109
|
+
expect(productsAfterPurge.body).toHaveLength(2);
|
|
110
|
+
expect(ordersAfterPurge.body).toHaveLength(1);
|
|
111
|
+
});
|
|
112
|
+
});
|
|
113
|
+
describe('F4 — DynamicApiCacheService invalidates a raw, outside-HTTP write', () => {
|
|
114
|
+
beforeEach(async () => {
|
|
115
|
+
await (0, shared_1.initApp)({
|
|
116
|
+
entity: CacheScopeProductEntity,
|
|
117
|
+
controllerOptions: { path: 'cache-scope-products', isPublic: true },
|
|
118
|
+
routes: [{ type: 'GetMany' }],
|
|
119
|
+
});
|
|
120
|
+
});
|
|
121
|
+
it('should leave the cache stale after a raw write, then refresh it once DynamicApiCacheService.invalidate is called', async () => {
|
|
122
|
+
const model = await (0, utils_1.getModelFromEntity)(CacheScopeProductEntity);
|
|
123
|
+
await model.insertMany([{ name: 'seed' }]);
|
|
124
|
+
const first = await e2e_setup_1.server.get('/cache-scope-products');
|
|
125
|
+
expect(first.body).toHaveLength(1);
|
|
126
|
+
await model.insertMany([{ name: 'added-by-cron' }]);
|
|
127
|
+
const stillCached = await e2e_setup_1.server.get('/cache-scope-products');
|
|
128
|
+
expect(stillCached.body).toHaveLength(1);
|
|
129
|
+
const cacheService = global.app.get(src_1.DynamicApiCacheService);
|
|
130
|
+
await cacheService.invalidate(CacheScopeProductEntity);
|
|
131
|
+
const fresh = await e2e_setup_1.server.get('/cache-scope-products');
|
|
132
|
+
expect(fresh.body).toHaveLength(2);
|
|
133
|
+
});
|
|
134
|
+
});
|
|
135
|
+
describe('suggestion #11 — DynamicApiCacheService reachable from a custom route handler via inject', () => {
|
|
136
|
+
const invalidateProductsRoute = {
|
|
137
|
+
path: 'bulk-rename',
|
|
138
|
+
method: 'POST',
|
|
139
|
+
isPublic: true,
|
|
140
|
+
inject: [src_1.DynamicApiCacheService],
|
|
141
|
+
handler: async ({ methods, body }, [cacheService]) => {
|
|
142
|
+
const { from, to } = body;
|
|
143
|
+
await methods.updateManyDocuments(CacheScopeProductEntity, { name: from }, { $set: { name: to } });
|
|
144
|
+
await cacheService.invalidate(CacheScopeProductEntity);
|
|
145
|
+
return { renamed: true };
|
|
146
|
+
},
|
|
147
|
+
};
|
|
148
|
+
beforeEach(async () => {
|
|
149
|
+
await (0, shared_1.initApp)({
|
|
150
|
+
entity: CacheScopeProductEntity,
|
|
151
|
+
controllerOptions: { path: 'cache-scope-products', isPublic: true },
|
|
152
|
+
routes: [{ type: 'GetMany' }],
|
|
153
|
+
customRoutes: [invalidateProductsRoute],
|
|
154
|
+
});
|
|
155
|
+
});
|
|
156
|
+
it('should leave the cache stale after methods.updateManyDocuments alone, then refresh it once the injected DynamicApiCacheService invalidates', async () => {
|
|
157
|
+
const model = await (0, utils_1.getModelFromEntity)(CacheScopeProductEntity);
|
|
158
|
+
await model.insertMany([{ name: 'old-name' }]);
|
|
159
|
+
const first = await e2e_setup_1.server.get('/cache-scope-products');
|
|
160
|
+
expect(first.body).toHaveLength(1);
|
|
161
|
+
expect(first.body[0].name).toBe('old-name');
|
|
162
|
+
const renamed = await e2e_setup_1.server.post('/cache-scope-products/bulk-rename', { from: 'old-name', to: 'new-name' });
|
|
163
|
+
expect(renamed.status).toBe(201);
|
|
164
|
+
const fresh = await e2e_setup_1.server.get('/cache-scope-products');
|
|
165
|
+
expect(fresh.body).toHaveLength(1);
|
|
166
|
+
expect(fresh.body[0].name).toBe('new-name');
|
|
167
|
+
});
|
|
168
|
+
});
|
|
169
|
+
});
|
|
170
|
+
//# sourceMappingURL=cache-scoped-invalidation.e2e-spec.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"cache-scoped-invalidation.e2e-spec.js","sourceRoot":"","sources":["../../../libs/dynamic-api/test/for-feature/cache-scoped-invalidation.e2e-spec.ts"],"names":[],"mappings":";;;;;;;;;;;AACA,+CAAgD;AAChD,uCAAgC;AAChC,mCAKmB;AACnB,4CAAuD;AACvD,yBAAuB;AACvB,oCAA8C;AAC9C,sCAAoC;AAYpC,QAAQ,CAAC,+DAA+D,EAAE,GAAG,EAAE;IAE7E,UAAU,CAAC,GAAG,EAAE;QACd,sBAAgB,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,CAAC;IACzC,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,KAAK,IAAI,EAAE;QACnB,MAAM,IAAA,2BAAe,EAAC,kBAAQ,CAAC,WAAW,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IAGH,IAAM,uBAAuB,GAA7B,MAAM,uBAAwB,SAAQ,gBAAU;KAG/C,CAAA;IADC;QADC,IAAA,eAAI,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;yDAC1B;IAFT,uBAAuB;QAD5B,IAAA,iBAAM,EAAC,EAAE,UAAU,EAAE,sBAAsB,EAAE,CAAC;OACzC,uBAAuB,CAG5B;IAGD,IAAM,qBAAqB,GAA3B,MAAM,qBAAsB,SAAQ,gBAAU;KAG7C,CAAA;IADC;QADC,IAAA,eAAI,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;wDACzB;IAFV,qBAAqB;QAD1B,IAAA,iBAAM,EAAC,EAAE,UAAU,EAAE,oBAAoB,EAAE,CAAC;OACvC,qBAAqB,CAG1B;IAED,QAAQ,CAAC,oEAAoE,EAAE,GAAG,EAAE;QAClF,UAAU,CAAC,KAAK,IAAI,EAAE;YACpB,MAAM,IAAA,gBAAO,EAAC;gBACZ,MAAM,EAAE,uBAAuB;gBAC/B,iBAAiB,EAAE,EAAE,IAAI,EAAE,sBAAsB,EAAE,QAAQ,EAAE,IAAI,EAAE;gBACnE,MAAM,EAAE;oBACN,EAAE,IAAI,EAAE,SAAS,EAAE;oBACnB,EAAE,IAAI,EAAE,WAAW,EAAE;iBACtB;gBACD,YAAY,EAAE;oBACZ,sBAAgB,CAAC,UAAU,CAAC;wBAC1B,MAAM,EAAE,qBAAqB;wBAC7B,iBAAiB,EAAE,EAAE,IAAI,EAAE,oBAAoB,EAAE,QAAQ,EAAE,IAAI,EAAE;wBACjE,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;qBAC9B,CAAC;iBACH;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4FAA4F,EAAE,KAAK,IAAI,EAAE;YAC1G,MAAM,YAAY,GAAG,MAAM,IAAA,0BAAkB,EAAC,uBAAuB,CAAC,CAAC;YACvE,MAAM,UAAU,GAAG,MAAM,IAAA,0BAAkB,EAAC,qBAAqB,CAAC,CAAC;YACnE,MAAM,YAAY,CAAC,UAAU,CAAC,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC;YACvD,MAAM,UAAU,CAAC,UAAU,CAAC,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;YAGpD,MAAM,aAAa,GAAG,MAAM,kBAAM,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;YAChE,MAAM,WAAW,GAAG,MAAM,kBAAM,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;YAC5D,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YAC3C,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YAIzC,MAAM,UAAU,CAAC,UAAU,CAAC,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;YAGpD,MAAM,OAAO,GAAG,MAAM,kBAAM,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC;YAClF,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAEjC,MAAM,cAAc,GAAG,MAAM,kBAAM,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;YACjE,MAAM,YAAY,GAAG,MAAM,kBAAM,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;YAG7D,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YAG5C,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,+DAA+D,EAAE,GAAG,EAAE;QAC7E,UAAU,CAAC,KAAK,IAAI,EAAE;YACpB,MAAM,IAAA,gBAAO,EAAC;gBACZ,MAAM,EAAE,uBAAuB;gBAC/B,iBAAiB,EAAE,EAAE,IAAI,EAAE,sBAAsB,EAAE,QAAQ,EAAE,IAAI,EAAE;gBACnE,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;gBAC7B,YAAY,EAAE;oBACZ,sBAAgB,CAAC,UAAU,CAAC;wBAC1B,MAAM,EAAE,qBAAqB;wBAC7B,iBAAiB,EAAE,EAAE,IAAI,EAAE,oBAAoB,EAAE,QAAQ,EAAE,IAAI,EAAE;wBACjE,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;qBAC9B,CAAC;iBACH;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sEAAsE,EAAE,KAAK,IAAI,EAAE;YACpF,MAAM,YAAY,GAAG,MAAM,IAAA,0BAAkB,EAAC,uBAAuB,CAAC,CAAC;YACvE,MAAM,UAAU,GAAG,MAAM,IAAA,0BAAkB,EAAC,qBAAqB,CAAC,CAAC;YACnE,MAAM,YAAY,CAAC,UAAU,CAAC,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC;YACvD,MAAM,UAAU,CAAC,UAAU,CAAC,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;YAEpD,MAAM,kBAAM,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;YAC1C,MAAM,kBAAM,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;YAExC,MAAM,UAAU,CAAC,UAAU,CAAC,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;YACpD,MAAM,YAAY,CAAC,UAAU,CAAC,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC;YAEvD,MAAM,KAAK,GAAG,MAAM,kBAAM,CAAC,MAAM,CAAC,6BAA6B,CAAC,CAAC;YACjE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC/B,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;YAE7C,MAAM,kBAAkB,GAAG,MAAM,kBAAM,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;YACrE,MAAM,gBAAgB,GAAG,MAAM,kBAAM,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;YAEjE,MAAM,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YAChD,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAChD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,mEAAmE,EAAE,GAAG,EAAE;QACjF,UAAU,CAAC,KAAK,IAAI,EAAE;YACpB,MAAM,IAAA,gBAAO,EAAC;gBACZ,MAAM,EAAE,uBAAuB;gBAC/B,iBAAiB,EAAE,EAAE,IAAI,EAAE,sBAAsB,EAAE,QAAQ,EAAE,IAAI,EAAE;gBACnE,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;aAC9B,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,kHAAkH,EAAE,KAAK,IAAI,EAAE;YAChI,MAAM,KAAK,GAAG,MAAM,IAAA,0BAAkB,EAAC,uBAAuB,CAAC,CAAC;YAChE,MAAM,KAAK,CAAC,UAAU,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;YAE3C,MAAM,KAAK,GAAG,MAAM,kBAAM,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;YACxD,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YAGnC,MAAM,KAAK,CAAC,UAAU,CAAC,CAAC,EAAE,IAAI,EAAE,eAAe,EAAE,CAAC,CAAC,CAAC;YAEpD,MAAM,WAAW,GAAG,MAAM,kBAAM,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;YAC9D,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YAIzC,MAAM,YAAY,GAAI,MAAM,CAAC,GAAwB,CAAC,GAAG,CAAC,4BAAsB,CAAC,CAAC;YAClF,MAAM,YAAY,CAAC,UAAU,CAAC,uBAAuB,CAAC,CAAC;YAEvD,MAAM,KAAK,GAAG,MAAM,kBAAM,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;YACxD,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,0FAA0F,EAAE,GAAG,EAAE;QAOxG,MAAM,uBAAuB,GAA+C;YAC1E,IAAI,EAAE,aAAa;YACnB,MAAM,EAAE,MAAM;YACd,QAAQ,EAAE,IAAI;YACd,MAAM,EAAE,CAAC,4BAAsB,CAAC;YAChC,OAAO,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,CAAC,YAAY,CAAC,EAAE,EAAE;gBACnD,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,IAAoC,CAAC;gBAC1D,MAAM,OAAO,CAAC,mBAAmB,CAAC,uBAAuB,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;gBACnG,MAAO,YAAuC,CAAC,UAAU,CAAC,uBAAuB,CAAC,CAAC;gBACnF,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;YAC3B,CAAC;SACF,CAAC;QAEF,UAAU,CAAC,KAAK,IAAI,EAAE;YACpB,MAAM,IAAA,gBAAO,EAAC;gBACZ,MAAM,EAAE,uBAAuB;gBAC/B,iBAAiB,EAAE,EAAE,IAAI,EAAE,sBAAsB,EAAE,QAAQ,EAAE,IAAI,EAAE;gBACnE,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;gBAC7B,YAAY,EAAE,CAAC,uBAAuB,CAAC;aACxC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4IAA4I,EAAE,KAAK,IAAI,EAAE;YAC1J,MAAM,KAAK,GAAG,MAAM,IAAA,0BAAkB,EAAC,uBAAuB,CAAC,CAAC;YAChE,MAAM,KAAK,CAAC,UAAU,CAAC,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC;YAE/C,MAAM,KAAK,GAAG,MAAM,kBAAM,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;YACxD,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YACnC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAI5C,MAAM,OAAO,GAAG,MAAM,kBAAM,CAAC,IAAI,CAAC,mCAAmC,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC;YAC7G,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAEjC,MAAM,KAAK,GAAG,MAAM,kBAAM,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;YACxD,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YACnC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
import 'dotenv/config';
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
|
|
3
|
+
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
|
|
4
|
+
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
|
|
5
|
+
else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
|
|
6
|
+
return c > 3 && r && Object.defineProperty(target, key, r), r;
|
|
7
|
+
};
|
|
8
|
+
var __metadata = (this && this.__metadata) || function (k, v) {
|
|
9
|
+
if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
|
|
10
|
+
};
|
|
11
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
12
|
+
const mongoose_1 = require("@nestjs/mongoose");
|
|
13
|
+
const mongoose_2 = require("mongoose");
|
|
14
|
+
const src_1 = require("../../src");
|
|
15
|
+
const e2e_setup_1 = require("../e2e.setup");
|
|
16
|
+
require("dotenv/config");
|
|
17
|
+
const shared_1 = require("../shared");
|
|
18
|
+
describe('DynamicApiModule forFeature - custom route authAbilityPredicate (e2e)', () => {
|
|
19
|
+
beforeEach(() => {
|
|
20
|
+
src_1.DynamicApiModule.state['resetState']();
|
|
21
|
+
});
|
|
22
|
+
afterEach(async () => {
|
|
23
|
+
await (0, e2e_setup_1.closeTestingApp)(mongoose_2.default.connections);
|
|
24
|
+
});
|
|
25
|
+
let AuthPredicateUserEntity = class AuthPredicateUserEntity extends src_1.BaseEntity {
|
|
26
|
+
};
|
|
27
|
+
__decorate([
|
|
28
|
+
(0, mongoose_1.Prop)({ type: String, required: true }),
|
|
29
|
+
__metadata("design:type", String)
|
|
30
|
+
], AuthPredicateUserEntity.prototype, "email", void 0);
|
|
31
|
+
__decorate([
|
|
32
|
+
(0, mongoose_1.Prop)({ type: String, required: true }),
|
|
33
|
+
__metadata("design:type", String)
|
|
34
|
+
], AuthPredicateUserEntity.prototype, "password", void 0);
|
|
35
|
+
__decorate([
|
|
36
|
+
(0, mongoose_1.Prop)({ type: String, default: 'user' }),
|
|
37
|
+
__metadata("design:type", String)
|
|
38
|
+
], AuthPredicateUserEntity.prototype, "role", void 0);
|
|
39
|
+
AuthPredicateUserEntity = __decorate([
|
|
40
|
+
(0, mongoose_1.Schema)({ collection: 'auth_predicate_users' })
|
|
41
|
+
], AuthPredicateUserEntity);
|
|
42
|
+
let AuthPredicateAdminAuditLogEntity = class AuthPredicateAdminAuditLogEntity extends src_1.BaseEntity {
|
|
43
|
+
};
|
|
44
|
+
__decorate([
|
|
45
|
+
(0, mongoose_1.Prop)({ type: String }),
|
|
46
|
+
__metadata("design:type", String)
|
|
47
|
+
], AuthPredicateAdminAuditLogEntity.prototype, "action", void 0);
|
|
48
|
+
AuthPredicateAdminAuditLogEntity = __decorate([
|
|
49
|
+
(0, mongoose_1.Schema)({ collection: 'auth_predicate_admin_audit_log' })
|
|
50
|
+
], AuthPredicateAdminAuditLogEntity);
|
|
51
|
+
const registerAndLogin = async (email, role) => {
|
|
52
|
+
await e2e_setup_1.server.post('/auth/register', { email, password: 'password123', role });
|
|
53
|
+
const { body: { accessToken } } = await e2e_setup_1.server.post('/auth/login', { email, password: 'password123' });
|
|
54
|
+
const { body: account } = await e2e_setup_1.server.get('/auth/account', { authToken: accessToken });
|
|
55
|
+
return { accessToken, id: account.id };
|
|
56
|
+
};
|
|
57
|
+
const isAdminRole = (_entity, user) => user.role === 'admin';
|
|
58
|
+
const adminOverviewRoute = (useAuthAbilityPredicate) => ({
|
|
59
|
+
path: 'admin-overview',
|
|
60
|
+
method: 'GET',
|
|
61
|
+
...(useAuthAbilityPredicate
|
|
62
|
+
? { authAbilityPredicate: (user) => user.role === 'admin' }
|
|
63
|
+
: { abilityPredicate: isAdminRole }),
|
|
64
|
+
handler: async () => ({ ok: true }),
|
|
65
|
+
});
|
|
66
|
+
const setup = async (useAuthAbilityPredicate) => {
|
|
67
|
+
await (0, shared_1.initApp)({
|
|
68
|
+
entity: AuthPredicateAdminAuditLogEntity,
|
|
69
|
+
controllerOptions: { path: 'auth-predicate-admin-audit-log' },
|
|
70
|
+
customRoutes: [adminOverviewRoute(useAuthAbilityPredicate)],
|
|
71
|
+
}, {
|
|
72
|
+
useAuth: {
|
|
73
|
+
userEntity: AuthPredicateUserEntity,
|
|
74
|
+
login: { loginField: 'email', passwordField: 'password', additionalFields: ['role'] },
|
|
75
|
+
register: {
|
|
76
|
+
additionalFields: [{ name: 'role', required: false }],
|
|
77
|
+
},
|
|
78
|
+
},
|
|
79
|
+
});
|
|
80
|
+
};
|
|
81
|
+
describe('abilityPredicate on a document-less route — the bug this option exists to fix', () => {
|
|
82
|
+
beforeEach(() => setup(false));
|
|
83
|
+
it('demonstrates the fail-open bug: a non-admin gets 200 because the backing collection is empty', async () => {
|
|
84
|
+
const nonAdmin = await registerAndLogin('member@auth-predicate.co', 'user');
|
|
85
|
+
const { status } = await e2e_setup_1.server.get('/auth-predicate-admin-audit-log/admin-overview', { authToken: nonAdmin.accessToken });
|
|
86
|
+
expect(status).toBe(200);
|
|
87
|
+
});
|
|
88
|
+
});
|
|
89
|
+
describe('authAbilityPredicate on the same document-less route — the fix', () => {
|
|
90
|
+
beforeEach(() => setup(true));
|
|
91
|
+
it('denies a non-admin, regardless of the backing collection being empty', async () => {
|
|
92
|
+
const nonAdmin = await registerAndLogin('member2@auth-predicate.co', 'user');
|
|
93
|
+
const { status } = await e2e_setup_1.server.get('/auth-predicate-admin-audit-log/admin-overview', { authToken: nonAdmin.accessToken });
|
|
94
|
+
expect(status).toBe(403);
|
|
95
|
+
});
|
|
96
|
+
it('allows an admin', async () => {
|
|
97
|
+
const admin = await registerAndLogin('admin@auth-predicate.co', 'admin');
|
|
98
|
+
const { status, body } = await e2e_setup_1.server.get('/auth-predicate-admin-audit-log/admin-overview', { authToken: admin.accessToken });
|
|
99
|
+
expect(status).toBe(200);
|
|
100
|
+
expect(body).toEqual({ ok: true });
|
|
101
|
+
});
|
|
102
|
+
it('denies an unauthenticated request', async () => {
|
|
103
|
+
const { status } = await e2e_setup_1.server.get('/auth-predicate-admin-audit-log/admin-overview');
|
|
104
|
+
expect(status).toBe(401);
|
|
105
|
+
});
|
|
106
|
+
});
|
|
107
|
+
});
|
|
108
|
+
//# sourceMappingURL=custom-route-auth-ability-predicate.e2e-spec.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"custom-route-auth-ability-predicate.e2e-spec.js","sourceRoot":"","sources":["../../../libs/dynamic-api/test/for-feature/custom-route-auth-ability-predicate.e2e-spec.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,+CAAgD;AAChD,uCAAgC;AAChC,mCAA4E;AAC5E,4CAAuD;AACvD,yBAAuB;AACvB,sCAAoC;AAcpC,QAAQ,CAAC,uEAAuE,EAAE,GAAG,EAAE;IAErF,UAAU,CAAC,GAAG,EAAE;QACd,sBAAgB,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,CAAC;IACzC,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,KAAK,IAAI,EAAE;QACnB,MAAM,IAAA,2BAAe,EAAC,kBAAQ,CAAC,WAAW,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IAGH,IAAM,uBAAuB,GAA7B,MAAM,uBAAwB,SAAQ,gBAAU;KAS/C,CAAA;IAPC;QADC,IAAA,eAAI,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;0DACzB;IAGd;QADC,IAAA,eAAI,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;6DACtB;IAGjB;QADC,IAAA,eAAI,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;;yDAC3B;IART,uBAAuB;QAD5B,IAAA,iBAAM,EAAC,EAAE,UAAU,EAAE,sBAAsB,EAAE,CAAC;OACzC,uBAAuB,CAS5B;IAMD,IAAM,gCAAgC,GAAtC,MAAM,gCAAiC,SAAQ,gBAAU;KAGxD,CAAA;IADC;QADC,IAAA,eAAI,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;;oEACP;IAFZ,gCAAgC;QADrC,IAAA,iBAAM,EAAC,EAAE,UAAU,EAAE,gCAAgC,EAAE,CAAC;OACnD,gCAAgC,CAGrC;IAED,MAAM,gBAAgB,GAAG,KAAK,EAAE,KAAa,EAAE,IAAY,EAAE,EAAE;QAC7D,MAAM,kBAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;QAC9E,MAAM,EAAE,IAAI,EAAE,EAAE,WAAW,EAAE,EAAE,GAAG,MAAM,kBAAM,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,aAAa,EAAE,CAAC,CAAC;QACvG,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,MAAM,kBAAM,CAAC,GAAG,CAAC,eAAe,EAAE,EAAE,SAAS,EAAE,WAAW,EAAE,CAAC,CAAC;QAExF,OAAO,EAAE,WAAW,EAAE,EAAE,EAAE,OAAO,CAAC,EAAY,EAAE,CAAC;IACnD,CAAC,CAAC;IAEF,MAAM,WAAW,GAAG,CAClB,OAAyC,EACzC,IAAsB,EACtB,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,OAAO,CAAC;IAE3B,MAAM,kBAAkB,GAAG,CACzB,uBAAgC,EACqB,EAAE,CAAC,CAAC;QACzD,IAAI,EAAE,gBAAgB;QACtB,MAAM,EAAE,KAAK;QACb,GAAG,CAAC,uBAAuB;YACzB,CAAC,CAAC,EAAE,oBAAoB,EAAE,CAAC,IAAsB,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,OAAO,EAAE;YAC7E,CAAC,CAAC,EAAE,gBAAgB,EAAE,WAAW,EAAE,CAAC;QACtC,OAAO,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC;KACpC,CAAC,CAAC;IAEH,MAAM,KAAK,GAAG,KAAK,EAAE,uBAAgC,EAAE,EAAE;QACvD,MAAM,IAAA,gBAAO,EACX;YACE,MAAM,EAAE,gCAAgC;YACxC,iBAAiB,EAAE,EAAE,IAAI,EAAE,gCAAgC,EAAE;YAC7D,YAAY,EAAE,CAAC,kBAAkB,CAAC,uBAAuB,CAAC,CAAC;SAC5D,EACD;YACE,OAAO,EAAE;gBACP,UAAU,EAAE,uBAAuB;gBACnC,KAAK,EAAE,EAAE,UAAU,EAAE,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,gBAAgB,EAAE,CAAC,MAAM,CAAC,EAAE;gBACrF,QAAQ,EAAE;oBACR,gBAAgB,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;iBACtD;aACF;SACF,CACF,CAAC;IACJ,CAAC,CAAC;IAEF,QAAQ,CAAC,+EAA+E,EAAE,GAAG,EAAE;QAC7F,UAAU,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;QAE/B,EAAE,CAAC,8FAA8F,EAAE,KAAK,IAAI,EAAE;YAC5G,MAAM,QAAQ,GAAG,MAAM,gBAAgB,CAAC,0BAA0B,EAAE,MAAM,CAAC,CAAC;YAE5E,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,kBAAM,CAAC,GAAG,CACjC,gDAAgD,EAChD,EAAE,SAAS,EAAE,QAAQ,CAAC,WAAW,EAAE,CACpC,CAAC;YAMF,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,gEAAgE,EAAE,GAAG,EAAE;QAC9E,UAAU,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;QAE9B,EAAE,CAAC,sEAAsE,EAAE,KAAK,IAAI,EAAE;YACpF,MAAM,QAAQ,GAAG,MAAM,gBAAgB,CAAC,2BAA2B,EAAE,MAAM,CAAC,CAAC;YAE7E,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,kBAAM,CAAC,GAAG,CACjC,gDAAgD,EAChD,EAAE,SAAS,EAAE,QAAQ,CAAC,WAAW,EAAE,CACpC,CAAC;YAEF,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iBAAiB,EAAE,KAAK,IAAI,EAAE;YAC/B,MAAM,KAAK,GAAG,MAAM,gBAAgB,CAAC,yBAAyB,EAAE,OAAO,CAAC,CAAC;YAEzE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,kBAAM,CAAC,GAAG,CACvC,gDAAgD,EAChD,EAAE,SAAS,EAAE,KAAK,CAAC,WAAW,EAAE,CACjC,CAAC;YAEF,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACzB,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mCAAmC,EAAE,KAAK,IAAI,EAAE;YACjD,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,kBAAM,CAAC,GAAG,CAAC,gDAAgD,CAAC,CAAC;YAEtF,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
import 'dotenv/config';
|
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
|
|
3
|
+
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
|
|
4
|
+
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
|
|
5
|
+
else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
|
|
6
|
+
return c > 3 && r && Object.defineProperty(target, key, r), r;
|
|
7
|
+
};
|
|
8
|
+
var __metadata = (this && this.__metadata) || function (k, v) {
|
|
9
|
+
if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
|
|
10
|
+
};
|
|
11
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
12
|
+
const common_1 = require("@nestjs/common");
|
|
13
|
+
const mongoose_1 = require("@nestjs/mongoose");
|
|
14
|
+
const mongoose_2 = require("mongoose");
|
|
15
|
+
const src_1 = require("../../src");
|
|
16
|
+
const e2e_setup_1 = require("../e2e.setup");
|
|
17
|
+
require("dotenv/config");
|
|
18
|
+
const shared_1 = require("../shared");
|
|
19
|
+
describe('DynamicApiModule forFeature - custom route inject (e2e)', () => {
|
|
20
|
+
beforeEach(() => {
|
|
21
|
+
src_1.DynamicApiModule.state['resetState']();
|
|
22
|
+
});
|
|
23
|
+
afterEach(async () => {
|
|
24
|
+
await (0, e2e_setup_1.closeTestingApp)(mongoose_2.default.connections);
|
|
25
|
+
});
|
|
26
|
+
let MailService = class MailService {
|
|
27
|
+
constructor() {
|
|
28
|
+
this.sentCount = 0;
|
|
29
|
+
}
|
|
30
|
+
send(to) {
|
|
31
|
+
this.sentCount += 1;
|
|
32
|
+
return { to, sent: true };
|
|
33
|
+
}
|
|
34
|
+
};
|
|
35
|
+
MailService = __decorate([
|
|
36
|
+
(0, common_1.Injectable)()
|
|
37
|
+
], MailService);
|
|
38
|
+
let InviteFamilyEntity = class InviteFamilyEntity extends src_1.BaseEntity {
|
|
39
|
+
};
|
|
40
|
+
__decorate([
|
|
41
|
+
(0, mongoose_1.Prop)({ type: String, required: true }),
|
|
42
|
+
__metadata("design:type", String)
|
|
43
|
+
], InviteFamilyEntity.prototype, "name", void 0);
|
|
44
|
+
InviteFamilyEntity = __decorate([
|
|
45
|
+
(0, mongoose_1.Schema)({ collection: 'invite_families' })
|
|
46
|
+
], InviteFamilyEntity);
|
|
47
|
+
const inviteMemberRoute = {
|
|
48
|
+
path: 'invite-member',
|
|
49
|
+
method: 'POST',
|
|
50
|
+
inject: [MailService],
|
|
51
|
+
handler: async (ctx, [mailService]) => {
|
|
52
|
+
const mail = mailService;
|
|
53
|
+
const body = ctx.body;
|
|
54
|
+
return mail.send(body.email);
|
|
55
|
+
},
|
|
56
|
+
};
|
|
57
|
+
it('should resolve the injected provider and let the handler use it', async () => {
|
|
58
|
+
await (0, shared_1.initApp)({
|
|
59
|
+
entity: InviteFamilyEntity,
|
|
60
|
+
controllerOptions: { path: 'invite-families', isPublic: true },
|
|
61
|
+
routes: [{ type: 'GetOne', isPublic: true }],
|
|
62
|
+
customRoutes: [inviteMemberRoute],
|
|
63
|
+
extraProviders: [MailService],
|
|
64
|
+
});
|
|
65
|
+
const { status, body } = await e2e_setup_1.server.post('/invite-families/invite-member', {
|
|
66
|
+
email: 'new-member@family.test',
|
|
67
|
+
});
|
|
68
|
+
expect(status).toBe(201);
|
|
69
|
+
expect(body).toEqual({ to: 'new-member@family.test', sent: true });
|
|
70
|
+
});
|
|
71
|
+
it('should reuse the same Nest-managed singleton instance across requests', async () => {
|
|
72
|
+
await (0, shared_1.initApp)({
|
|
73
|
+
entity: InviteFamilyEntity,
|
|
74
|
+
controllerOptions: { path: 'invite-families', isPublic: true },
|
|
75
|
+
routes: [{ type: 'GetOne', isPublic: true }],
|
|
76
|
+
customRoutes: [inviteMemberRoute],
|
|
77
|
+
extraProviders: [MailService],
|
|
78
|
+
});
|
|
79
|
+
await e2e_setup_1.server.post('/invite-families/invite-member', { email: 'first@family.test' });
|
|
80
|
+
await e2e_setup_1.server.post('/invite-families/invite-member', { email: 'second@family.test' });
|
|
81
|
+
const thirdRoute = {
|
|
82
|
+
path: 'invite-count',
|
|
83
|
+
method: 'GET',
|
|
84
|
+
inject: [MailService],
|
|
85
|
+
handler: async (_ctx, [mailService]) => ({ sentCount: mailService.sentCount }),
|
|
86
|
+
};
|
|
87
|
+
await (0, e2e_setup_1.closeTestingApp)(mongoose_2.default.connections);
|
|
88
|
+
await (0, shared_1.initApp)({
|
|
89
|
+
entity: InviteFamilyEntity,
|
|
90
|
+
controllerOptions: { path: 'invite-families', isPublic: true },
|
|
91
|
+
routes: [{ type: 'GetOne', isPublic: true }],
|
|
92
|
+
customRoutes: [inviteMemberRoute, thirdRoute],
|
|
93
|
+
extraProviders: [MailService],
|
|
94
|
+
});
|
|
95
|
+
await e2e_setup_1.server.post('/invite-families/invite-member', { email: 'a@family.test' });
|
|
96
|
+
await e2e_setup_1.server.post('/invite-families/invite-member', { email: 'b@family.test' });
|
|
97
|
+
const { body } = await e2e_setup_1.server.get('/invite-families/invite-count');
|
|
98
|
+
expect(body).toEqual({ sentCount: 2 });
|
|
99
|
+
});
|
|
100
|
+
});
|
|
101
|
+
//# sourceMappingURL=custom-route-inject.e2e-spec.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"custom-route-inject.e2e-spec.js","sourceRoot":"","sources":["../../../libs/dynamic-api/test/for-feature/custom-route-inject.e2e-spec.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,2CAA4C;AAC5C,+CAAgD;AAChD,uCAAgC;AAChC,mCAA4E;AAC5E,4CAAuD;AACvD,yBAAuB;AACvB,sCAAoC;AASpC,QAAQ,CAAC,yDAAyD,EAAE,GAAG,EAAE;IAEvE,UAAU,CAAC,GAAG,EAAE;QACd,sBAAgB,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,CAAC;IACzC,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,KAAK,IAAI,EAAE;QACnB,MAAM,IAAA,2BAAe,EAAC,kBAAQ,CAAC,WAAW,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IAGH,IAAM,WAAW,GAAjB,MAAM,WAAW;QAAjB;YACE,cAAS,GAAG,CAAC,CAAC;QAMhB,CAAC;QAJC,IAAI,CAAC,EAAU;YACb,IAAI,CAAC,SAAS,IAAI,CAAC,CAAC;YACpB,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;QAC5B,CAAC;KACF,CAAA;IAPK,WAAW;QADhB,IAAA,mBAAU,GAAE;OACP,WAAW,CAOhB;IAGD,IAAM,kBAAkB,GAAxB,MAAM,kBAAmB,SAAQ,gBAAU;KAG1C,CAAA;IADC;QADC,IAAA,eAAI,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;oDAC1B;IAFT,kBAAkB;QADvB,IAAA,iBAAM,EAAC,EAAE,UAAU,EAAE,iBAAiB,EAAE,CAAC;OACpC,kBAAkB,CAGvB;IAED,MAAM,iBAAiB,GAA0C;QAC/D,IAAI,EAAE,eAAe;QACrB,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,CAAC,WAAW,CAAC;QACrB,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,WAAW,CAAC,EAAE,EAAE;YACpC,MAAM,IAAI,GAAG,WAA0B,CAAC;YACxC,MAAM,IAAI,GAAG,GAAG,CAAC,IAAyB,CAAC;YAC3C,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/B,CAAC;KACF,CAAC;IAEF,EAAE,CAAC,iEAAiE,EAAE,KAAK,IAAI,EAAE;QAC/E,MAAM,IAAA,gBAAO,EACX;YACE,MAAM,EAAE,kBAAkB;YAC1B,iBAAiB,EAAE,EAAE,IAAI,EAAE,iBAAiB,EAAE,QAAQ,EAAE,IAAI,EAAE;YAG9D,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;YAC5C,YAAY,EAAE,CAAC,iBAAiB,CAAC;YACjC,cAAc,EAAE,CAAC,WAAW,CAAC;SAC9B,CACF,CAAC;QAEF,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,kBAAM,CAAC,IAAI,CAAC,gCAAgC,EAAE;YAC3E,KAAK,EAAE,wBAAwB;SAChC,CAAC,CAAC;QAEH,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACzB,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,wBAAwB,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IACrE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uEAAuE,EAAE,KAAK,IAAI,EAAE;QACrF,MAAM,IAAA,gBAAO,EACX;YACE,MAAM,EAAE,kBAAkB;YAC1B,iBAAiB,EAAE,EAAE,IAAI,EAAE,iBAAiB,EAAE,QAAQ,EAAE,IAAI,EAAE;YAC9D,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;YAC5C,YAAY,EAAE,CAAC,iBAAiB,CAAC;YACjC,cAAc,EAAE,CAAC,WAAW,CAAC;SAC9B,CACF,CAAC;QAEF,MAAM,kBAAM,CAAC,IAAI,CAAC,gCAAgC,EAAE,EAAE,KAAK,EAAE,mBAAmB,EAAE,CAAC,CAAC;QACpF,MAAM,kBAAM,CAAC,IAAI,CAAC,gCAAgC,EAAE,EAAE,KAAK,EAAE,oBAAoB,EAAE,CAAC,CAAC;QAKrF,MAAM,UAAU,GAA0C;YACxD,IAAI,EAAE,cAAc;YACpB,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,CAAC,WAAW,CAAC;YACrB,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,WAAW,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,SAAS,EAAG,WAA2B,CAAC,SAAS,EAAE,CAAC;SAChG,CAAC;QAIF,MAAM,IAAA,2BAAe,EAAC,kBAAQ,CAAC,WAAW,CAAC,CAAC;QAC5C,MAAM,IAAA,gBAAO,EACX;YACE,MAAM,EAAE,kBAAkB;YAC1B,iBAAiB,EAAE,EAAE,IAAI,EAAE,iBAAiB,EAAE,QAAQ,EAAE,IAAI,EAAE;YAC9D,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;YAC5C,YAAY,EAAE,CAAC,iBAAiB,EAAE,UAAU,CAAC;YAC7C,cAAc,EAAE,CAAC,WAAW,CAAC;SAC9B,CACF,CAAC;QAEF,MAAM,kBAAM,CAAC,IAAI,CAAC,gCAAgC,EAAE,EAAE,KAAK,EAAE,eAAe,EAAE,CAAC,CAAC;QAChF,MAAM,kBAAM,CAAC,IAAI,CAAC,gCAAgC,EAAE,EAAE,KAAK,EAAE,eAAe,EAAE,CAAC,CAAC;QAChF,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,kBAAM,CAAC,GAAG,CAAC,+BAA+B,CAAC,CAAC;QAEnE,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
import 'dotenv/config';
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
|
|
3
|
+
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
|
|
4
|
+
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
|
|
5
|
+
else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
|
|
6
|
+
return c > 3 && r && Object.defineProperty(target, key, r), r;
|
|
7
|
+
};
|
|
8
|
+
var __metadata = (this && this.__metadata) || function (k, v) {
|
|
9
|
+
if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
|
|
10
|
+
};
|
|
11
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
12
|
+
const mongoose_1 = require("@nestjs/mongoose");
|
|
13
|
+
const swagger_1 = require("@nestjs/swagger");
|
|
14
|
+
const mongoose_2 = require("mongoose");
|
|
15
|
+
const src_1 = require("../../src");
|
|
16
|
+
const e2e_setup_1 = require("../e2e.setup");
|
|
17
|
+
require("dotenv/config");
|
|
18
|
+
const shared_1 = require("../shared");
|
|
19
|
+
describe('DynamicApiModule forFeature - custom route dTOs.params in OpenAPI (e2e)', () => {
|
|
20
|
+
beforeEach(() => {
|
|
21
|
+
src_1.DynamicApiModule.state['resetState']();
|
|
22
|
+
});
|
|
23
|
+
afterEach(async () => {
|
|
24
|
+
await (0, e2e_setup_1.closeTestingApp)(mongoose_2.default.connections);
|
|
25
|
+
});
|
|
26
|
+
let OpenApiFamilyEntity = class OpenApiFamilyEntity extends src_1.BaseEntity {
|
|
27
|
+
};
|
|
28
|
+
__decorate([
|
|
29
|
+
(0, mongoose_1.Prop)({ type: String, required: true }),
|
|
30
|
+
__metadata("design:type", String)
|
|
31
|
+
], OpenApiFamilyEntity.prototype, "name", void 0);
|
|
32
|
+
OpenApiFamilyEntity = __decorate([
|
|
33
|
+
(0, mongoose_1.Schema)({ collection: 'openapi_families' })
|
|
34
|
+
], OpenApiFamilyEntity);
|
|
35
|
+
class InviteMemberParams {
|
|
36
|
+
constructor() {
|
|
37
|
+
this.familyId = '';
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
const inviteMemberRoute = {
|
|
41
|
+
path: ':familyId/invite-member',
|
|
42
|
+
method: 'POST',
|
|
43
|
+
dTOs: { params: InviteMemberParams },
|
|
44
|
+
handler: async () => ({ sent: true }),
|
|
45
|
+
};
|
|
46
|
+
it('should declare the custom route\'s path param in the generated OpenAPI document', async () => {
|
|
47
|
+
await (0, shared_1.initApp)({
|
|
48
|
+
entity: OpenApiFamilyEntity,
|
|
49
|
+
controllerOptions: { path: 'openapi-families', isPublic: true },
|
|
50
|
+
customRoutes: [inviteMemberRoute],
|
|
51
|
+
});
|
|
52
|
+
const document = swagger_1.SwaggerModule.createDocument(global.app, new swagger_1.DocumentBuilder().build());
|
|
53
|
+
const operation = document.paths['/openapi-families/{familyId}/invite-member']?.post;
|
|
54
|
+
expect(operation).toBeDefined();
|
|
55
|
+
const pathParams = (operation?.parameters ?? []).filter((p) => 'in' in p && p.in === 'path');
|
|
56
|
+
expect(pathParams).toEqual([
|
|
57
|
+
expect.objectContaining({ name: 'familyId', in: 'path' }),
|
|
58
|
+
]);
|
|
59
|
+
});
|
|
60
|
+
it('should not declare any path param when dTOs.params is omitted', async () => {
|
|
61
|
+
const noParamsRoute = {
|
|
62
|
+
path: 'stats',
|
|
63
|
+
method: 'GET',
|
|
64
|
+
handler: async () => ({ count: 0 }),
|
|
65
|
+
};
|
|
66
|
+
await (0, shared_1.initApp)({
|
|
67
|
+
entity: OpenApiFamilyEntity,
|
|
68
|
+
controllerOptions: { path: 'openapi-families', isPublic: true },
|
|
69
|
+
customRoutes: [noParamsRoute],
|
|
70
|
+
});
|
|
71
|
+
const document = swagger_1.SwaggerModule.createDocument(global.app, new swagger_1.DocumentBuilder().build());
|
|
72
|
+
const operation = document.paths['/openapi-families/stats']?.get;
|
|
73
|
+
const pathParams = (operation?.parameters ?? []).filter((p) => 'in' in p && p.in === 'path');
|
|
74
|
+
expect(pathParams).toEqual([]);
|
|
75
|
+
});
|
|
76
|
+
});
|
|
77
|
+
//# sourceMappingURL=custom-route-params-openapi.e2e-spec.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"custom-route-params-openapi.e2e-spec.js","sourceRoot":"","sources":["../../../libs/dynamic-api/test/for-feature/custom-route-params-openapi.e2e-spec.ts"],"names":[],"mappings":";;;;;;;;;;;AACA,+CAAgD;AAChD,6CAAgF;AAChF,uCAAgC;AAChC,mCAA4E;AAC5E,4CAA+C;AAC/C,yBAAuB;AACvB,sCAAoC;AAapC,QAAQ,CAAC,yEAAyE,EAAE,GAAG,EAAE;IAEvF,UAAU,CAAC,GAAG,EAAE;QACd,sBAAgB,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,CAAC;IACzC,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,KAAK,IAAI,EAAE;QACnB,MAAM,IAAA,2BAAe,EAAC,kBAAQ,CAAC,WAAW,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IAGH,IAAM,mBAAmB,GAAzB,MAAM,mBAAoB,SAAQ,gBAAU;KAG3C,CAAA;IADC;QADC,IAAA,eAAI,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;qDAC1B;IAFT,mBAAmB;QADxB,IAAA,iBAAM,EAAC,EAAE,UAAU,EAAE,kBAAkB,EAAE,CAAC;OACrC,mBAAmB,CAGxB;IAED,MAAM,kBAAkB;QAAxB;YACE,aAAQ,GAAG,EAAE,CAAC;QAChB,CAAC;KAAA;IAED,MAAM,iBAAiB,GAA2C;QAChE,IAAI,EAAE,yBAAyB;QAC/B,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,EAAE,MAAM,EAAE,kBAAkB,EAAE;QACpC,OAAO,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;KACtC,CAAC;IAEF,EAAE,CAAC,iFAAiF,EAAE,KAAK,IAAI,EAAE;QAC/F,MAAM,IAAA,gBAAO,EAAC;YACZ,MAAM,EAAE,mBAAmB;YAC3B,iBAAiB,EAAE,EAAE,IAAI,EAAE,kBAAkB,EAAE,QAAQ,EAAE,IAAI,EAAE;YAC/D,YAAY,EAAE,CAAC,iBAAiB,CAAC;SAClC,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAkB,uBAAa,CAAC,cAAc,CAC1D,MAAM,CAAC,GAAuB,EAC9B,IAAI,yBAAe,EAAE,CAAC,KAAK,EAAE,CAC9B,CAAC;QAEF,MAAM,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC,4CAA4C,CAAC,EAAE,IAAI,CAAC;QACrF,MAAM,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,CAAC;QAEhC,MAAM,UAAU,GAAG,CAAC,SAAS,EAAE,UAAU,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,MAAM,CAAC,CAAC;QAC7F,MAAM,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC;YACzB,MAAM,CAAC,gBAAgB,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC;SAC1D,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+DAA+D,EAAE,KAAK,IAAI,EAAE;QAC7E,MAAM,aAAa,GAA2C;YAC5D,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;SACpC,CAAC;QAEF,MAAM,IAAA,gBAAO,EAAC;YACZ,MAAM,EAAE,mBAAmB;YAC3B,iBAAiB,EAAE,EAAE,IAAI,EAAE,kBAAkB,EAAE,QAAQ,EAAE,IAAI,EAAE;YAC/D,YAAY,EAAE,CAAC,aAAa,CAAC;SAC9B,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAkB,uBAAa,CAAC,cAAc,CAC1D,MAAM,CAAC,GAAuB,EAC9B,IAAI,yBAAe,EAAE,CAAC,KAAK,EAAE,CAC9B,CAAC;QAEF,MAAM,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC,yBAAyB,CAAC,EAAE,GAAG,CAAC;QACjE,MAAM,UAAU,GAAG,CAAC,SAAS,EAAE,UAAU,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,MAAM,CAAC,CAAC;QAC7F,MAAM,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
import 'dotenv/config';
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
|
|
3
|
+
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
|
|
4
|
+
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
|
|
5
|
+
else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
|
|
6
|
+
return c > 3 && r && Object.defineProperty(target, key, r), r;
|
|
7
|
+
};
|
|
8
|
+
var __metadata = (this && this.__metadata) || function (k, v) {
|
|
9
|
+
if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
|
|
10
|
+
};
|
|
11
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
12
|
+
const mongoose_1 = require("@nestjs/mongoose");
|
|
13
|
+
const mongoose_2 = require("mongoose");
|
|
14
|
+
const src_1 = require("../../src");
|
|
15
|
+
const e2e_setup_1 = require("../e2e.setup");
|
|
16
|
+
require("dotenv/config");
|
|
17
|
+
const shared_1 = require("../shared");
|
|
18
|
+
describe('DynamicApiModule forFeature - custom route targetParam (e2e)', () => {
|
|
19
|
+
beforeEach(() => {
|
|
20
|
+
src_1.DynamicApiModule.state['resetState']();
|
|
21
|
+
});
|
|
22
|
+
afterEach(async () => {
|
|
23
|
+
await (0, e2e_setup_1.closeTestingApp)(mongoose_2.default.connections);
|
|
24
|
+
});
|
|
25
|
+
let TargetParamUserEntity = class TargetParamUserEntity extends src_1.BaseEntity {
|
|
26
|
+
};
|
|
27
|
+
__decorate([
|
|
28
|
+
(0, mongoose_1.Prop)({ type: String, required: true }),
|
|
29
|
+
__metadata("design:type", String)
|
|
30
|
+
], TargetParamUserEntity.prototype, "email", void 0);
|
|
31
|
+
__decorate([
|
|
32
|
+
(0, mongoose_1.Prop)({ type: String, required: true }),
|
|
33
|
+
__metadata("design:type", String)
|
|
34
|
+
], TargetParamUserEntity.prototype, "password", void 0);
|
|
35
|
+
__decorate([
|
|
36
|
+
(0, mongoose_1.Prop)({ type: Boolean, default: false }),
|
|
37
|
+
__metadata("design:type", Boolean)
|
|
38
|
+
], TargetParamUserEntity.prototype, "consented", void 0);
|
|
39
|
+
TargetParamUserEntity = __decorate([
|
|
40
|
+
(0, mongoose_1.Schema)({ collection: 'target_param_users' })
|
|
41
|
+
], TargetParamUserEntity);
|
|
42
|
+
const registerAndLogin = async (email) => {
|
|
43
|
+
await e2e_setup_1.server.post('/auth/register', { email, password: 'password123' });
|
|
44
|
+
const { body: { accessToken } } = await e2e_setup_1.server.post('/auth/login', { email, password: 'password123' });
|
|
45
|
+
const { body: account } = await e2e_setup_1.server.get('/auth/account', { authToken: accessToken });
|
|
46
|
+
return { accessToken, id: account.id };
|
|
47
|
+
};
|
|
48
|
+
const isNotSelf = (target, user) => target.id !== user.id;
|
|
49
|
+
const parentalConsentRoute = (targetParam) => ({
|
|
50
|
+
path: 'parental-consent/:userId',
|
|
51
|
+
method: 'PATCH',
|
|
52
|
+
abilityPredicate: isNotSelf,
|
|
53
|
+
...(targetParam ? { targetParam } : {}),
|
|
54
|
+
handler: async ({ model, params }) => model.findByIdAndUpdate(params.userId, { consented: true }, { new: true }),
|
|
55
|
+
});
|
|
56
|
+
describe('with targetParam set to the route\'s actual param', () => {
|
|
57
|
+
beforeEach(async () => {
|
|
58
|
+
await (0, shared_1.initApp)({
|
|
59
|
+
entity: TargetParamUserEntity,
|
|
60
|
+
controllerOptions: { path: 'target-param-users' },
|
|
61
|
+
customRoutes: [parentalConsentRoute('userId')],
|
|
62
|
+
}, {
|
|
63
|
+
useAuth: {
|
|
64
|
+
userEntity: TargetParamUserEntity,
|
|
65
|
+
login: { loginField: 'email', passwordField: 'password' },
|
|
66
|
+
},
|
|
67
|
+
});
|
|
68
|
+
});
|
|
69
|
+
it('should deny a user granting parental consent to themselves', async () => {
|
|
70
|
+
const minor = await registerAndLogin('minor@target-param.co');
|
|
71
|
+
const { status } = await e2e_setup_1.server.patch(`/target-param-users/parental-consent/${minor.id}`, {}, { authToken: minor.accessToken });
|
|
72
|
+
expect(status).toBe(403);
|
|
73
|
+
});
|
|
74
|
+
it('should allow a user granting parental consent to someone else', async () => {
|
|
75
|
+
const parent = await registerAndLogin('parent@target-param.co');
|
|
76
|
+
const minor = await registerAndLogin('minor2@target-param.co');
|
|
77
|
+
const { status } = await e2e_setup_1.server.patch(`/target-param-users/parental-consent/${minor.id}`, {}, { authToken: parent.accessToken });
|
|
78
|
+
expect(status).toBe(200);
|
|
79
|
+
});
|
|
80
|
+
});
|
|
81
|
+
describe('without targetParam — the misconfiguration this option exists to fix', () => {
|
|
82
|
+
beforeEach(async () => {
|
|
83
|
+
await (0, shared_1.initApp)({
|
|
84
|
+
entity: TargetParamUserEntity,
|
|
85
|
+
controllerOptions: { path: 'target-param-users' },
|
|
86
|
+
customRoutes: [parentalConsentRoute()],
|
|
87
|
+
}, {
|
|
88
|
+
useAuth: {
|
|
89
|
+
userEntity: TargetParamUserEntity,
|
|
90
|
+
login: { loginField: 'email', passwordField: 'password' },
|
|
91
|
+
},
|
|
92
|
+
});
|
|
93
|
+
});
|
|
94
|
+
it('demonstrates the misconfiguration this fix exists for: a legitimate request gets wrongly denied', async () => {
|
|
95
|
+
const parent = await registerAndLogin('parent3@target-param.co');
|
|
96
|
+
const minor = await registerAndLogin('minor3@target-param.co');
|
|
97
|
+
const { status } = await e2e_setup_1.server.patch(`/target-param-users/parental-consent/${minor.id}`, {}, { authToken: parent.accessToken });
|
|
98
|
+
expect(status).toBe(403);
|
|
99
|
+
});
|
|
100
|
+
});
|
|
101
|
+
});
|
|
102
|
+
//# sourceMappingURL=custom-route-target-param.e2e-spec.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"custom-route-target-param.e2e-spec.js","sourceRoot":"","sources":["../../../libs/dynamic-api/test/for-feature/custom-route-target-param.e2e-spec.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,+CAAgD;AAChD,uCAAgC;AAChC,mCAA4E;AAC5E,4CAAuD;AACvD,yBAAuB;AACvB,sCAAoC;AAYpC,QAAQ,CAAC,8DAA8D,EAAE,GAAG,EAAE;IAE5E,UAAU,CAAC,GAAG,EAAE;QACd,sBAAgB,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,CAAC;IACzC,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,KAAK,IAAI,EAAE;QACnB,MAAM,IAAA,2BAAe,EAAC,kBAAQ,CAAC,WAAW,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IAGH,IAAM,qBAAqB,GAA3B,MAAM,qBAAsB,SAAQ,gBAAU;KAS7C,CAAA;IAPC;QADC,IAAA,eAAI,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;wDACzB;IAGd;QADC,IAAA,eAAI,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;2DACtB;IAGjB;QADC,IAAA,eAAI,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;;4DACrB;IARf,qBAAqB;QAD1B,IAAA,iBAAM,EAAC,EAAE,UAAU,EAAE,oBAAoB,EAAE,CAAC;OACvC,qBAAqB,CAS1B;IAED,MAAM,gBAAgB,GAAG,KAAK,EAAE,KAAa,EAAE,EAAE;QAC/C,MAAM,kBAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,aAAa,EAAE,CAAC,CAAC;QACxE,MAAM,EAAE,IAAI,EAAE,EAAE,WAAW,EAAE,EAAE,GAAG,MAAM,kBAAM,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,aAAa,EAAE,CAAC,CAAC;QACvG,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,MAAM,kBAAM,CAAC,GAAG,CAAC,eAAe,EAAE,EAAE,SAAS,EAAE,WAAW,EAAE,CAAC,CAAC;QAExF,OAAO,EAAE,WAAW,EAAE,EAAE,EAAE,OAAO,CAAC,EAAY,EAAE,CAAC;IACnD,CAAC,CAAC;IAIF,MAAM,SAAS,GAAG,CAAC,MAA6B,EAAE,IAAoB,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;IAEjG,MAAM,oBAAoB,GAAG,CAC3B,WAAoB,EACsB,EAAE,CAAC,CAAC;QAC9C,IAAI,EAAE,0BAA0B;QAChC,MAAM,EAAE,OAAO;QACf,gBAAgB,EAAE,SAAS;QAC3B,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACvC,OAAO,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,iBAAiB,CAC3D,MAAM,CAAC,MAAM,EACb,EAAE,SAAS,EAAE,IAAI,EAAE,EACnB,EAAE,GAAG,EAAE,IAAI,EAAE,CACd;KACF,CAAC,CAAC;IAEH,QAAQ,CAAC,mDAAmD,EAAE,GAAG,EAAE;QACjE,UAAU,CAAC,KAAK,IAAI,EAAE;YACpB,MAAM,IAAA,gBAAO,EACX;gBACE,MAAM,EAAE,qBAAqB;gBAC7B,iBAAiB,EAAE,EAAE,IAAI,EAAE,oBAAoB,EAAE;gBACjD,YAAY,EAAE,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;aAC/C,EACD;gBACE,OAAO,EAAE;oBACP,UAAU,EAAE,qBAAqB;oBACjC,KAAK,EAAE,EAAE,UAAU,EAAE,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE;iBAC1D;aACF,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4DAA4D,EAAE,KAAK,IAAI,EAAE;YAC1E,MAAM,KAAK,GAAG,MAAM,gBAAgB,CAAC,uBAAuB,CAAC,CAAC;YAE9D,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,kBAAM,CAAC,KAAK,CACnC,wCAAwC,KAAK,CAAC,EAAE,EAAE,EAClD,EAAE,EACF,EAAE,SAAS,EAAE,KAAK,CAAC,WAAW,EAAE,CACjC,CAAC;YAEF,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,+DAA+D,EAAE,KAAK,IAAI,EAAE;YAC7E,MAAM,MAAM,GAAG,MAAM,gBAAgB,CAAC,wBAAwB,CAAC,CAAC;YAChE,MAAM,KAAK,GAAG,MAAM,gBAAgB,CAAC,wBAAwB,CAAC,CAAC;YAE/D,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,kBAAM,CAAC,KAAK,CACnC,wCAAwC,KAAK,CAAC,EAAE,EAAE,EAClD,EAAE,EACF,EAAE,SAAS,EAAE,MAAM,CAAC,WAAW,EAAE,CAClC,CAAC;YAEF,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,sEAAsE,EAAE,GAAG,EAAE;QACpF,UAAU,CAAC,KAAK,IAAI,EAAE;YACpB,MAAM,IAAA,gBAAO,EACX;gBACE,MAAM,EAAE,qBAAqB;gBAC7B,iBAAiB,EAAE,EAAE,IAAI,EAAE,oBAAoB,EAAE;gBACjD,YAAY,EAAE,CAAC,oBAAoB,EAAE,CAAC;aACvC,EACD;gBACE,OAAO,EAAE;oBACP,UAAU,EAAE,qBAAqB;oBACjC,KAAK,EAAE,EAAE,UAAU,EAAE,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE;iBAC1D;aACF,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iGAAiG,EAAE,KAAK,IAAI,EAAE;YAS/G,MAAM,MAAM,GAAG,MAAM,gBAAgB,CAAC,yBAAyB,CAAC,CAAC;YACjE,MAAM,KAAK,GAAG,MAAM,gBAAgB,CAAC,wBAAwB,CAAC,CAAC;YAE/D,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,kBAAM,CAAC,KAAK,CACnC,wCAAwC,KAAK,CAAC,EAAE,EAAE,EAClD,EAAE,EACF,EAAE,SAAS,EAAE,MAAM,CAAC,WAAW,EAAE,CAClC,CAAC;YAEF,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
import 'dotenv/config';
|