refactor(chore): fix sonar code smells (#207)

sf-sahil-jassal · web-flow · commit 023690319314 · 2024-01-04T16:57:22.000+05:30
fix sonar code smells related to function type, any typings and empty constructors GH-204
diff --git a/src/__tests__/fixtures/providers/azuread-auth.provider.ts b/src/__tests__/fixtures/providers/azuread-auth.provider.ts
@@ -7,8 +7,6 @@ import {Request} from '@loopback/rest';
 export class BearerTokenVerifyProvider
   implements Provider<VerifyFunction.AzureADAuthFn>
 {
-  constructor() {}
-
   value(): VerifyFunction.AzureADAuthFn {
     return async (
       accessToken: string,
diff --git a/src/strategies/client-auth-strategy.provider.ts b/src/strategies/client-auth-strategy.provider.ts
@@ -29,7 +29,9 @@ export class ClientAuthStrategyProvider
         this.clientMetadata.options as StrategyOptionsWithRequestInterface,
       );
     } else {
-      return Promise.reject(`The strategy ${name} is not available.`);
+      return Promise.reject(
+        new Error(`The strategy ${name} is not available.`),
+      );
     }
   }
 }
diff --git a/src/strategies/passport/passport-apple-oauth2/apple-auth-strategy-factory-provider.ts b/src/strategies/passport/passport-apple-oauth2/apple-auth-strategy-factory-provider.ts
@@ -1,25 +1,23 @@
 import {inject, Provider} from '@loopback/core';
+import {AnyObject} from '@loopback/repository';
 import {HttpErrors, Request} from '@loopback/rest';
 import {HttpsProxyAgent} from 'https-proxy-agent';
-import {
-  Profile,
+// eslint-disable-next-line @typescript-eslint/naming-convention
+import Strategy, {
   AuthenticateOptions,
   AuthenticateOptionsWithRequest,
-  VerifyCallback,
   DecodedIdToken,
+  Profile,
+  VerifyCallback,
 } from 'passport-apple';
 import {AuthErrorKeys} from '../../../error-keys';
 import {Strategies} from '../../keys';
-
 import {VerifyFunction} from '../../types';
-// eslint-disable-next-line @typescript-eslint/naming-convention
-import Strategy from 'passport-apple';
-export interface AppleAuthStrategyFactory {
-  (
-    options: AuthenticateOptions | AuthenticateOptionsWithRequest,
-    verifierPassed?: VerifyFunction.AppleAuthFn,
-  ): Strategy;
-}
+
+export type AppleAuthStrategyFactory = (
+  options: AuthenticateOptions | AuthenticateOptionsWithRequest,
+  verifierPassed?: VerifyFunction.AppleAuthFn,
+) => Strategy;
 
 export class AppleAuthStrategyFactoryProvider
   implements Provider<AppleAuthStrategyFactory>
@@ -109,8 +107,7 @@ export class AppleAuthStrategyFactoryProvider
     return strategy;
   }
 
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  private _setupProxy(strategy: any) {
+  private _setupProxy(strategy: AnyObject) {
     // Setup proxy if any
     let httpsProxyAgent;
     if (process.env['https_proxy']) {
@@ -119,6 +116,6 @@ export class AppleAuthStrategyFactoryProvider
     } else if (process.env['HTTPS_PROXY']) {
       httpsProxyAgent = new HttpsProxyAgent(process.env['HTTPS_PROXY']);
       strategy._oauth2.setAgent(httpsProxyAgent);
-    }
+    } else return;
   }
 }
diff --git a/src/strategies/passport/passport-azure-ad/azuread-auth-verify.provider.ts b/src/strategies/passport/passport-azure-ad/azuread-auth-verify.provider.ts
@@ -11,8 +11,6 @@ import {VerifyFunction} from '../../types';
 export class AzureADAuthVerifyProvider
   implements Provider<VerifyFunction.AzureADAuthFn>
 {
-  constructor() {}
-
   value(): VerifyFunction.AzureADAuthFn {
     return async (
       accessToken: string,
diff --git a/src/strategies/passport/passport-bearer/bearer-token-verify.provider.ts b/src/strategies/passport/passport-bearer/bearer-token-verify.provider.ts
@@ -11,8 +11,6 @@ import {VerifyFunction} from '../../types';
 export class BearerTokenVerifyProvider
   implements Provider<VerifyFunction.BearerFn>
 {
-  constructor() {}
-
   value(): VerifyFunction.BearerFn {
     return async (token: string) => {
       throw new HttpErrors.NotImplemented(
diff --git a/src/strategies/passport/passport-client-password/client-password-verify.provider.ts b/src/strategies/passport/passport-client-password/client-password-verify.provider.ts
@@ -11,8 +11,6 @@ import {VerifyFunction} from '../../types';
 export class ClientPasswordVerifyProvider
   implements Provider<VerifyFunction.OauthClientPasswordFn>
 {
-  constructor() {}
-
   value(): VerifyFunction.OauthClientPasswordFn {
     return async (clientId: string, clientSecret: string) => {
       throw new HttpErrors.NotImplemented(
diff --git a/src/strategies/passport/passport-cognito-oauth2/cognito-auth-verify.provider.ts b/src/strategies/passport/passport-cognito-oauth2/cognito-auth-verify.provider.ts
@@ -10,8 +10,6 @@ import {Cognito, VerifyFunction} from '../../types';
 export class CognitoAuthVerifyProvider
   implements Provider<VerifyFunction.CognitoAuthFn>
 {
-  constructor() {}
-
   value(): VerifyFunction.CognitoAuthFn {
     return async (
       accessToken: string,
diff --git a/src/strategies/passport/passport-facebook-oauth2/facebook-auth-strategy-factory-provider.ts b/src/strategies/passport/passport-facebook-oauth2/facebook-auth-strategy-factory-provider.ts
@@ -1,4 +1,5 @@
 import {inject, Provider} from '@loopback/core';
+import {AnyObject} from '@loopback/repository';
 import {HttpErrors, Request} from '@loopback/rest';
 import {HttpsProxyAgent} from 'https-proxy-agent';
 import {
@@ -7,7 +8,6 @@ import {
   StrategyOption,
   StrategyOptionWithRequest,
 } from 'passport-facebook';
-
 import {AuthErrorKeys} from '../../../error-keys';
 import {Strategies} from '../../keys';
 import {VerifyCallback, VerifyFunction} from '../../types';
@@ -99,8 +99,7 @@ export class FacebookAuthStrategyFactoryProvider
     return strategy;
   }
 
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  private _setupProxy(strategy: any) {
+  private _setupProxy(strategy: AnyObject) {
     // Setup proxy if any
     let httpsProxyAgent;
     if (process.env['https_proxy']) {
diff --git a/src/strategies/passport/passport-facebook-oauth2/facebook-auth-verify.provider.ts b/src/strategies/passport/passport-facebook-oauth2/facebook-auth-verify.provider.ts
@@ -11,8 +11,6 @@ import {VerifyCallback, VerifyFunction} from '../../types';
 export class FacebookAuthVerifyProvider
   implements Provider<VerifyFunction.FacebookAuthFn>
 {
-  constructor() {}
-
   value(): VerifyFunction.FacebookAuthFn {
     return async (
       accessToken: string,
diff --git a/src/strategies/passport/passport-google-oauth2/google-auth-strategy-factory-provider.ts b/src/strategies/passport/passport-google-oauth2/google-auth-strategy-factory-provider.ts
@@ -8,7 +8,7 @@ import {
   StrategyOptionsWithRequest,
   VerifyCallback,
 } from 'passport-google-oauth20';
-
+import {AnyObject} from '@loopback/repository';
 import {AuthErrorKeys} from '../../../error-keys';
 import {Strategies} from '../../keys';
 import {VerifyFunction} from '../../types';
@@ -97,8 +97,7 @@ export class GoogleAuthStrategyFactoryProvider
     return strategy;
   }
 
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  private _setupProxy(strategy: any) {
+  private _setupProxy(strategy: AnyObject) {
     // Setup proxy if any
     let httpsProxyAgent;
     if (process.env['https_proxy']) {
diff --git a/src/strategies/passport/passport-google-oauth2/google-auth-verify.provider.ts b/src/strategies/passport/passport-google-oauth2/google-auth-verify.provider.ts
@@ -13,8 +13,6 @@ import {VerifyFunction} from '../../types';
 export class GoogleAuthVerifyProvider
   implements Provider<VerifyFunction.GoogleAuthFn>
 {
-  constructor() {}
-
   value(): VerifyFunction.GoogleAuthFn {
     return async (
       accessToken: string,
diff --git a/src/strategies/passport/passport-insta-oauth2/insta-auth-strategy-factory-provider.ts b/src/strategies/passport/passport-insta-oauth2/insta-auth-strategy-factory-provider.ts
@@ -1,4 +1,5 @@
 import {inject, Provider} from '@loopback/core';
+import {AnyObject} from '@loopback/repository';
 import {HttpErrors, Request} from '@loopback/rest';
 import {HttpsProxyAgent} from 'https-proxy-agent';
 import {
@@ -7,7 +8,6 @@ import {
   StrategyOption,
   StrategyOptionWithRequest,
 } from 'passport-instagram';
-
 import {AuthErrorKeys} from '../../../error-keys';
 import {Strategies} from '../../keys';
 import {VerifyCallback, VerifyFunction} from '../../types';
@@ -95,8 +95,7 @@ export class InstagramAuthStrategyFactoryProvider
     return strategy;
   }
 
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  private _setupProxy(strategy: any) {
+  private _setupProxy(strategy: AnyObject) {
     // Setup proxy if any
     let httpsProxyAgent;
     if (process.env['https_proxy']) {
diff --git a/src/strategies/passport/passport-insta-oauth2/insta-auth-verify.provider.ts b/src/strategies/passport/passport-insta-oauth2/insta-auth-verify.provider.ts
@@ -11,8 +11,6 @@ import {VerifyCallback, VerifyFunction} from '../../types';
 export class InstagramAuthVerifyProvider
   implements Provider<VerifyFunction.InstagramAuthFn>
 {
-  constructor() {}
-
   value(): VerifyFunction.InstagramAuthFn {
     return async (
       accessToken: string,
diff --git a/src/strategies/passport/passport-keycloak/keycloak-verify.provider.ts b/src/strategies/passport/passport-keycloak/keycloak-verify.provider.ts
@@ -11,8 +11,6 @@ import {Keycloak, VerifyFunction} from '../../types';
 export class KeycloakVerifyProvider
   implements Provider<VerifyFunction.KeycloakAuthFn>
 {
-  constructor() {}
-
   value(): VerifyFunction.KeycloakAuthFn {
     return async (
       accessToken: string,
diff --git a/src/strategies/passport/passport-local/local-password-verify.provider.ts b/src/strategies/passport/passport-local/local-password-verify.provider.ts
@@ -11,8 +11,6 @@ import {VerifyFunction} from '../../types';
 export class LocalPasswordVerifyProvider
   implements Provider<VerifyFunction.LocalPasswordFn>
 {
-  constructor() {}
-
   value(): VerifyFunction.LocalPasswordFn {
     return async (username: string, password: string) => {
       throw new HttpErrors.NotImplemented(
diff --git a/src/strategies/passport/passport-otp/otp-auth.ts b/src/strategies/passport/passport-otp/otp-auth.ts
@@ -1,11 +1,16 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
+import {AnyObject} from '@loopback/repository';
+import {Request} from '@loopback/rest';
 import * as passport from 'passport';
 
 export namespace Otp {
   export type VerifyFunction = (
     key: string,
     otp: string,
-    done: (error: any, user?: any, info?: any) => void,
+    done: (
+      error?: string | Error | null,
+      user?: AnyObject,
+      info?: AnyObject,
+    ) => void,
   ) => void;
 
   export interface StrategyOptions {
@@ -15,8 +20,8 @@ export namespace Otp {
 
   export type VerifyCallback = (
     err?: string | Error | null,
-    user?: any,
-    info?: any,
+    user?: AnyObject,
+    info?: AnyObject,
   ) => void;
 
   export class Strategy extends passport.Strategy {
@@ -31,7 +36,7 @@ export namespace Otp {
     name: string;
     private readonly verify: VerifyFunction;
 
-    authenticate(req: any, options?: StrategyOptions): void {
+    authenticate(req: Request, options?: StrategyOptions): void {
       const key = req.body.key || options?.key;
       const otp = req.body.otp || options?.otp;
 
@@ -40,7 +45,11 @@ export namespace Otp {
         return;
       }
 
-      const verified = (err?: any, user?: any, _info?: any) => {
+      const verified = (
+        err?: string | Error | null,
+        user?: AnyObject,
+        _info?: AnyObject,
+      ) => {
         if (err) {
           this.error(err);
           return;
diff --git a/src/strategies/passport/passport-otp/otp-verify.provider.ts b/src/strategies/passport/passport-otp/otp-verify.provider.ts
@@ -4,8 +4,6 @@ import {HttpErrors} from '@loopback/rest';
 import {VerifyFunction} from '../../types';
 
 export class OtpVerifyProvider implements Provider<VerifyFunction.OtpAuthFn> {
-  constructor() {}
-
   value(): VerifyFunction.OtpAuthFn {
     return async (_key: string, _otp: string) => {
       throw new HttpErrors.NotImplemented(
diff --git a/src/strategies/passport/passport-resource-owner-password/resource-owner-strategy-factory-provider.ts b/src/strategies/passport/passport-resource-owner-password/resource-owner-strategy-factory-provider.ts
@@ -8,12 +8,10 @@ import {VerifyFunction} from '../../types';
 import {Oauth2ResourceOwnerPassword} from './oauth2-resource-owner-password-grant';
 import {isEmpty} from 'lodash';
 
-export interface ResourceOwnerPasswordStrategyFactory {
-  (
-    options?: Oauth2ResourceOwnerPassword.StrategyOptionsWithRequestInterface,
-    verifierPassed?: VerifyFunction.ResourceOwnerPasswordFn,
-  ): Oauth2ResourceOwnerPassword.Strategy;
-}
+export type ResourceOwnerPasswordStrategyFactory = (
+  options?: Oauth2ResourceOwnerPassword.StrategyOptionsWithRequestInterface,
+  verifierPassed?: VerifyFunction.ResourceOwnerPasswordFn,
+) => Oauth2ResourceOwnerPassword.Strategy;
 
 export class ResourceOwnerPasswordStrategyFactoryProvider
   implements Provider<ResourceOwnerPasswordStrategyFactory>
diff --git a/src/strategies/passport/passport-resource-owner-password/resource-owner-verify.provider.ts b/src/strategies/passport/passport-resource-owner-password/resource-owner-verify.provider.ts
@@ -12,8 +12,6 @@ import {VerifyFunction} from '../../types';
 export class ResourceOwnerVerifyProvider
   implements Provider<VerifyFunction.ResourceOwnerPasswordFn>
 {
-  constructor() {}
-
   value(): VerifyFunction.ResourceOwnerPasswordFn {
     return async (clientId, clientSecret, username, password) => {
       throw new HttpErrors.NotImplemented(
diff --git a/src/strategies/user-auth-strategy.provider.ts b/src/strategies/user-auth-strategy.provider.ts
@@ -313,7 +313,9 @@ export class AuthStrategyProvider implements Provider<Strategy | undefined> {
         return this.processSamlFactory(verifier);
       }
       default:
-        return Promise.reject(`The strategy ${name} is not available.`);
+        return Promise.reject(
+          new Error(`The strategy ${name} is not available.`),
+        );
     }
   }
 }
diff --git a/src/types.ts b/src/types.ts
@@ -42,9 +42,10 @@ export interface AuthenticationMetadata<T = void> {
  * interface definition of a function which accepts a request
  * and returns an authenticated user
  */
-export interface AuthenticateFn<T> {
-  (request: Request, response?: Response): Promise<T>;
-}
+export type AuthenticateFn<T> = (
+  request: Request,
+  response?: Response,
+) => Promise<T>;
 
 export interface ClientAuthCode<T extends IAuthUser, ID = number> {
   clientId: string;

Original file line number	Diff line number	Diff line change
`@@ -7,8 +7,6 @@ import {Request} from '@loopback/rest';`
`7`	`7`	`export class BearerTokenVerifyProvider`
`8`	`8`	`implements Provider<VerifyFunction.AzureADAuthFn>`
`9`	`9`	`{`
`10`		`- constructor() {}`
`11`		`-`
`12`	`10`	`value(): VerifyFunction.AzureADAuthFn {`
`13`	`11`	`return async (`
`14`	`12`	`accessToken: string,`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,9 @@ export class ClientAuthStrategyProvider`
`29`	`29`	`this.clientMetadata.options as StrategyOptionsWithRequestInterface,`
`30`	`30`	`);`
`31`	`31`	`} else {`
`32`		- return Promise.reject(`The strategy ${name} is not available.`);
	`32`	`+ return Promise.reject(`
	`33`	+ new Error(`The strategy ${name} is not available.`),
	`34`	`+ );`
`33`	`35`	`}`
`34`	`36`	`}`
`35`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,8 +11,6 @@ import {VerifyFunction} from '../../types';`
`11`	`11`	`export class AzureADAuthVerifyProvider`
`12`	`12`	`implements Provider<VerifyFunction.AzureADAuthFn>`
`13`	`13`	`{`
`14`		`- constructor() {}`
`15`		`-`
`16`	`14`	`value(): VerifyFunction.AzureADAuthFn {`
`17`	`15`	`return async (`
`18`	`16`	`accessToken: string,`
Original file line number	Diff line number	Diff line change
`@@ -10,8 +10,6 @@ import {Cognito, VerifyFunction} from '../../types';`
`10`	`10`	`export class CognitoAuthVerifyProvider`
`11`	`11`	`implements Provider<VerifyFunction.CognitoAuthFn>`
`12`	`12`	`{`
`13`		`- constructor() {}`
`14`		`-`
`15`	`13`	`value(): VerifyFunction.CognitoAuthFn {`
`16`	`14`	`return async (`
`17`	`15`	`accessToken: string,`
Original file line number	Diff line number	Diff line change
`@@ -11,8 +11,6 @@ import {VerifyCallback, VerifyFunction} from '../../types';`
`11`	`11`	`export class FacebookAuthVerifyProvider`
`12`	`12`	`implements Provider<VerifyFunction.FacebookAuthFn>`
`13`	`13`	`{`
`14`		`- constructor() {}`
`15`		`-`
`16`	`14`	`value(): VerifyFunction.FacebookAuthFn {`
`17`	`15`	`return async (`
`18`	`16`	`accessToken: string,`