refactor: enable strict mode

Papooch · Oct 5, 2022 · ea9b386 · ea9b386
1 parent ae5f6d9
commit ea9b386
Show file tree

Hide file tree

Showing 10 changed files with 69 additions and 53 deletions.
diff --git a/src/lib/cls.guard.ts b/src/lib/cls.guard.ts
@@ -10,9 +10,11 @@ import { ClsGuardOptions } from './cls.interfaces';
 
 @Injectable()
 export class ClsGuard implements CanActivate {
+    private readonly options: Omit<ClsGuardOptions, 'mount'>;
+
     constructor(
         @Inject(CLS_GUARD_OPTIONS)
-        private readonly options?: ClsGuardOptions,
+        options: Omit<ClsGuardOptions, 'mount'>,
     ) {
         this.options = { ...new ClsGuardOptions(), ...options };
     }
@@ -22,7 +24,7 @@ export class ClsGuard implements CanActivate {
         return cls.exit(async () => {
             cls.enter();
             if (this.options.generateId) {
-                const id = await this.options.idGenerator(context);
+                const id = await this.options.idGenerator?.(context);
                 cls.set<any>(CLS_ID, id);
             }
             if (this.options.setup) {

diff --git a/src/lib/cls.interceptor.ts b/src/lib/cls.interceptor.ts
@@ -12,9 +12,11 @@ import { ClsInterceptorOptions } from './cls.interfaces';
 
 @Injectable()
 export class ClsInterceptor implements NestInterceptor {
+    private readonly options: Omit<ClsInterceptorOptions, 'mount'>;
+
     constructor(
         @Inject(CLS_INTERCEPTOR_OPTIONS)
-        private readonly options?: Omit<ClsInterceptorOptions, 'mount'>,
+        options?: Omit<ClsInterceptorOptions, 'mount'>,
     ) {
         this.options = { ...new ClsInterceptorOptions(), ...options };
     }
@@ -24,7 +26,7 @@ export class ClsInterceptor implements NestInterceptor {
         return new Observable((subscriber) => {
             cls.run(async () => {
                 if (this.options.generateId) {
-                    const id = await this.options.idGenerator(context);
+                    const id = await this.options.idGenerator?.(context);
                     cls.set<any>(CLS_ID, id);
                 }
                 if (this.options.setup) {

diff --git a/src/lib/cls.interfaces.ts b/src/lib/cls.interfaces.ts
@@ -11,20 +11,20 @@ export class ClsModuleOptions {
     /**
      * An object with additional options for the `ClsMiddleware`
      */
-    middleware?: ClsMiddlewareOptions = null;
+    middleware?: ClsMiddlewareOptions;
 
     /**
      * An object with additional options for the `ClsGuard`
      */
-    guard?: ClsGuardOptions = null;
+    guard?: ClsGuardOptions;
 
     /**
      * An object with additional options for the `ClsInterceptor`
      */
-    interceptor?: ClsInterceptorOptions = null;
+    interceptor?: ClsInterceptorOptions;
 
     /**
-     *
+     * Array of Proxy Provider classes to register
      */
     proxyProviders?: Type[];
 }
@@ -35,7 +35,7 @@ export type ClsModuleFactoryOptions = Omit<
 >;
 export interface ClsModuleAsyncOptions extends Pick<ModuleMetadata, 'imports'> {
     inject?: any[];
-    useFactory?: (
+    useFactory: (
         ...args: any[]
     ) => Promise<ClsModuleFactoryOptions> | ClsModuleFactoryOptions;
     /**
@@ -45,9 +45,9 @@ export interface ClsModuleAsyncOptions extends Pick<ModuleMetadata, 'imports'> {
     global?: boolean;
 
     /**
-     *
+     * Array of Proxy Provider classes to register
      */
-    providers?: Type[];
+    proxyProviders?: Type[];
 }
 
 export class ClsMiddlewareOptions {

diff --git a/src/lib/cls.middleware.ts b/src/lib/cls.middleware.ts
@@ -12,10 +12,11 @@ import { ClsService } from './cls.service';
 @Injectable()
 export class ClsMiddleware implements NestMiddleware {
     private readonly cls: ClsService;
+    private readonly options: Omit<ClsMiddlewareOptions, 'mount'>;
 
     constructor(
         @Inject(CLS_MIDDLEWARE_OPTIONS)
-        private readonly options?: Omit<ClsMiddlewareOptions, 'mount'>,
+        options?: Omit<ClsMiddlewareOptions, 'mount'>,
     ) {
         this.options = { ...new ClsMiddlewareOptions(), ...options };
     }
@@ -24,7 +25,7 @@ export class ClsMiddleware implements NestMiddleware {
         const callback = async () => {
             this.options.useEnterWith && cls.enter();
             if (this.options.generateId) {
-                const id = await this.options.idGenerator(req);
+                const id = await this.options.idGenerator?.(req);
                 cls.set<any>(CLS_ID, id);
             }
             if (this.options.saveReq) cls.set<any>(CLS_REQ, req);

diff --git a/src/lib/cls.module.ts b/src/lib/cls.module.ts
@@ -88,12 +88,9 @@ export class ClsModule implements NestModule {
     static forRoot(options?: ClsModuleOptions): DynamicModule {
         options = { ...new ClsModuleOptions(), ...options };
         const { providers, exports } = this.getProviders();
-        const proxyProviders =
-            options.proxyProviders?.map((providerClass) =>
-                ProxyProviderManager.createProxyProvider({
-                    useClass: providerClass,
-                }),
-            ) ?? [];
+        const proxyProviders = this.createProxyClassProviders(
+            options.proxyProviders,
+        );
 
         return {
             module: ClsModule,
@@ -112,6 +109,9 @@ export class ClsModule implements NestModule {
 
     static forRootAsync(asyncOptions: ClsModuleAsyncOptions): DynamicModule {
         const { providers, exports } = this.getProviders();
+        const proxyProviders = this.createProxyClassProviders(
+            asyncOptions.proxyProviders,
+        );
 
         return {
             module: ClsModule,
@@ -123,8 +123,9 @@ export class ClsModule implements NestModule {
                     useFactory: asyncOptions.useFactory,
                 },
                 ...providers,
+                ...proxyProviders,
             ],
-            exports,
+            exports: [...exports, ...proxyProviders.map((p) => p.provide)],
             global: asyncOptions.global,
         };
     }
@@ -133,14 +134,10 @@ export class ClsModule implements NestModule {
      * Registers the `ClsService` provider in the module
      */
     static forFeature(): DynamicModule;
-    static forFeature(...requestScopedProviders: Array<Type>): DynamicModule;
-    static forFeature(...requestScopedProviders: Array<Type>): DynamicModule {
+    static forFeature(...proxyProviderClasses: Array<Type>): DynamicModule;
+    static forFeature(...proxyProviderClasses: Array<Type>): DynamicModule {
         const proxyProviders =
-            requestScopedProviders.map((providerClass) =>
-                ProxyProviderManager.createProxyProvider({
-                    useClass: providerClass,
-                }),
-            ) ?? [];
+            this.createProxyClassProviders(proxyProviderClasses);
         const providers = [...commonProviders];
         return {
             module: ClsModule,
@@ -165,6 +162,18 @@ export class ClsModule implements NestModule {
         };
     }
 
+    private static createProxyClassProviders(
+        proxyProviderClasses?: Array<Type>,
+    ) {
+        return (
+            proxyProviderClasses?.map((providerClass) =>
+                ProxyProviderManager.createProxyProvider({
+                    useClass: providerClass,
+                }),
+            ) ?? []
+        );
+    }
+
     private static getProviders() {
         const providers: Provider[] = [
             ...commonProviders,

diff --git a/src/lib/proxy-provider/proxy-provider-manager.ts b/src/lib/proxy-provider/proxy-provider-manager.ts
@@ -125,7 +125,9 @@ export class ProxyProviderManager {
     }
 
     private static async resolveProxyProvider(providerSymbol: symbol) {
-        const provider = this.proxyProviderMap.get(providerSymbol);
+        const provider = this.proxyProviderMap.get(
+            providerSymbol,
+        ) as ProxyProvider;
         if (isProxyClassProvider(provider)) {
             await this.resolveProxyClassProvider(providerSymbol, provider);
         } else {

diff --git a/src/lib/proxy-provider/proxy-provider.exceptions.ts b/src/lib/proxy-provider/proxy-provider.exceptions.ts
@@ -32,7 +32,7 @@ export class UnknownProxyDependenciesException extends Error {
         // matches the parameters from NestJS's error message:
         // e.g: "Nest can't resolve dependencies of the Something (Cats, ?). [...]"
         // returns ['Cats', '?']
-        return error.message.match(/\w+ \((.*?)\)./)[1].split(', ');
+        return error.message.match(/\w+ \((.*?)\)./)?.[1].split(', ') ?? [];
     }
 
     private static composeMessage(

diff --git a/src/utils/value-from-path.ts b/src/utils/value-from-path.ts
@@ -5,7 +5,7 @@ import {
 
 export function getValueFromPath<T, TP extends RecursiveKeyOf<T> & string>(
     obj: T,
-    path?: TP,
+    path: TP,
 ): DeepPropertyType<T, TP> {
     const pathSegments = path.split('.');
     return pathSegments.reduce((acc, curr) => acc?.[curr], obj);

diff --git a/test/proxy-providers/for-feature.spec.ts b/test/proxy-providers/for-feature.spec.ts
@@ -20,7 +20,7 @@ async function createAndInitTestingApp(imports: ModuleMetadata['imports']) {
     const moduleFixture: TestingModule = await Test.createTestingModule({
         imports: [
             ClsModule.forRoot({ middleware: { mount: true } }),
-            ...imports,
+            ...(imports ?? []),
         ],
     }).compile();
     const app = moduleFixture.createNestApplication();

diff --git a/tsconfig.json b/tsconfig.json
@@ -1,24 +1,24 @@
 {
-  "compilerOptions": {
-    "module": "commonjs",
-    "esModuleInterop": true,
-    "declaration": true,
-    "removeComments": true,
-    "emitDecoratorMetadata": true,
-    "experimentalDecorators": true,
-    "allowSyntheticDefaultImports": true,
-    "target": "es2017",
-    "sourceMap": true,
-    "rootDir": ".",
-    "outDir": "./dist",
-    "baseUrl": "./",
-    "incremental": true,
-    "skipLibCheck": true,
-    "strictNullChecks": false,
-    "noImplicitAny": false,
-    "strictBindCallApply": false,
-    "forceConsistentCasingInFileNames": false,
-    "noFallthroughCasesInSwitch": false,
-  },
-  "include": ["src/**/*.ts", "test/**/*.ts"]
+    "compilerOptions": {
+        "module": "commonjs",
+        "esModuleInterop": true,
+        "declaration": true,
+        "removeComments": true,
+        "emitDecoratorMetadata": true,
+        "experimentalDecorators": true,
+        "allowSyntheticDefaultImports": true,
+        "target": "es2017",
+        "sourceMap": true,
+        "rootDir": ".",
+        "outDir": "./dist",
+        "baseUrl": "./",
+        "incremental": true,
+        "skipLibCheck": true,
+        "strictNullChecks": true,
+        "noImplicitAny": false,
+        "strictBindCallApply": false,
+        "forceConsistentCasingInFileNames": false,
+        "noFallthroughCasesInSwitch": false
+    },
+    "include": ["src/**/*.ts", "test/**/*.ts"]
 }