refactor: set strictnullchecks = true

Author: rsdmike

.eslintrc.json

@@ -38,6 +38,7 @@
         "@typescript-eslint/consistent-type-assertions": 0,
         "@typescript-eslint/no-dynamic-delete": 0,
         "@typescript-eslint/prefer-nullish-coalescing": 0,
-        "@typescript-eslint/unbound-method": 0
+        "@typescript-eslint/unbound-method": 0,
+        "@typescript-eslint/no-non-null-assertion": "off"
     }
 }

src/DataProcessor.ts

@@ -16,7 +16,7 @@ import { Maintenance, type MaintenanceEvent } from './stateMachines/maintenance/
 import { Activation, type ActivationEvent } from './stateMachines/activation.js'
 import ClientResponseMsg from './utils/ClientResponseMsg.js'
 import { parseChunkedMessage } from './utils/parseChunkedMessage.js'
-import { UNEXPECTED_PARSE_ERROR } from './utils/constants.js'
+import { UNEXPECTED_PARSE_ERROR, type UnexpectedParseError } from './utils/constants.js'
 import { SyncTimeEventType } from './stateMachines/maintenance/syncTime.js'
 import { ChangePasswordEventType } from './stateMachines/maintenance/changePassword.js'
 import { SyncHostNameEventType } from './stateMachines/maintenance/syncHostName.js'
@@ -40,7 +40,7 @@ export class DataProcessor {
      */
   async processData (message: WebSocket.Data, clientId: string): Promise<ClientMsg | null> {
     try {
-      let clientMsg: ClientMsg = null
+      let clientMsg: ClientMsg
 
       try {
         clientMsg = this.validator.parseClientMsg(message, clientId)
@@ -77,6 +77,7 @@ export class DataProcessor {
         ClientResponseMsg.get(clientId, null, 'error', 'failed', 'request failed')
       }
     }
+    return null
   }
 
   async activateDevice (clientMsg: ClientMsg, clientId: string, activation: Activation = new Activation()): Promise<void> {
@@ -104,7 +105,7 @@ export class DataProcessor {
   async handleResponse (clientMsg: ClientMsg, clientId: string): Promise<void> {
     const clientObj = devices[clientId]
     let resolveValue = null
-    let rejectValue = null
+    let rejectValue: UnexpectedParseError | HttpZResponseModel | null = null
     let statusCode = -1
     try {
       const { parse } = pkg
@@ -124,10 +125,12 @@ export class DataProcessor {
       rejectValue = new UNEXPECTED_PARSE_ERROR()
     }
     if (clientObj.pendingPromise != null) {
-      if (resolveValue) {
-        clientObj.resolve(resolveValue)
-      } else {
-        clientObj.reject(rejectValue)
+      if (clientObj.resolve && clientObj.reject) {
+        if (resolveValue) {
+          clientObj.resolve(resolveValue)
+        } else {
+          clientObj.reject(rejectValue)
+        }
       }
     }
     this.logger.debug(`Device ${clientId}` +
@@ -177,7 +180,7 @@ export class DataProcessor {
     return mEvent
   }
 
-  setConnectionParams (clientId: string, username: string = null, password: string = null, uuid: string = null): void {
+  setConnectionParams (clientId: string, username: string | null = null, password: string | null = null, uuid: string | null = null): void {
     const clientObj = devices[clientId]
     clientObj.connectionParams = {
       port: 16992,

src/DomainCredentialManager.ts

@@ -12,12 +12,12 @@ import { type ISecretManagerService, type CertCredentials } from './interfaces/I
 export class DomainCredentialManager implements IDomainCredentialManager {
   private readonly amtDomains: IDomainsTable
   private readonly logger: ILogger
-  private readonly secretsManager: ISecretManagerService = null
+  private readonly secretsManager: ISecretManagerService | null = null
 
   constructor (logger: ILogger, amtDomains: IDomainsTable, secretsManager?: ISecretManagerService) {
     this.amtDomains = amtDomains
     this.logger = logger
-    this.secretsManager = secretsManager
+    this.secretsManager = secretsManager ?? null
   }
 
   /**
@@ -26,7 +26,7 @@ export class DomainCredentialManager implements IDomainCredentialManager {
      * @param {string} tenantId
      * @returns {AMTDomain} returns domain object
      */
-  async getProvisioningCert (domainSuffix: string, tenantId: string): Promise<AMTDomain> {
+  async getProvisioningCert (domainSuffix: string, tenantId: string): Promise<AMTDomain | null> {
     const domain = await this.amtDomains.getDomainByDomainSuffix(domainSuffix, tenantId)
     this.logger.debug(`domain : ${JSON.stringify(domain)}`)
 

src/HttpHandler.test.ts

@@ -122,6 +122,6 @@ it('should return a null when no xml is passed to wrap a WSMan request', async (
     username: 'admin',
     password: 'P@ssw0rd'
   }
-  const result = httpHandler.wrapIt(null, connectionParams)
+  const result = httpHandler.wrapIt(null as any, connectionParams)
   expect(result).toBe(null)
 })

src/HttpHandler.ts

@@ -24,7 +24,7 @@ export class HttpHandler {
     this.logger = new Logger('HttpHandler')
   }
 
-  wrapIt (data: string, connectionParams: connectionParams): string {
+  wrapIt (data: string, connectionParams: connectionParams): string | null {
     try {
       const url = '/wsman'
       const action = 'POST'
@@ -34,7 +34,7 @@ export class HttpHandler {
       }
       if (connectionParams.digestChallenge != null) {
         // Prepare an Authorization request header from the 401 unauthorized response from AMT
-        let responseDigest = null
+        let responseDigest: string | null = null
         // console nonce should be a unique opaque quoted string
         connectionParams.consoleNonce = Math.random().toString(36).substring(7)
         const nc = ('00000000' + (this.nonceCounter++).toString(16)).slice(-8)
@@ -77,7 +77,7 @@ export class HttpHandler {
 
   // Prepares Authorization Request Header
   digestIt (params: object): string {
-    const paramNames = []
+    const paramNames: string[] = []
     for (const i in params) {
       paramNames.push(i)
     }

src/Index.ts

@@ -10,9 +10,7 @@ import { WebSocketListener } from './WebSocketListener.js'
 import { Configurator } from './Configurator.js'
 import { Environment } from './utils/Environment.js'
 import { type RPSConfig } from './models/index.js'
-import { parseValue } from './utils/parseEnvValue.js'
 import routes from './routes/index.js'
-import rc from 'rc'
 import { MqttProvider } from './utils/MqttProvider.js'
 import { DbCreatorFactory } from './factories/DbCreatorFactory.js'
 import { backOff } from 'exponential-backoff'
@@ -30,22 +28,6 @@ import { URL, fileURLToPath, pathToFileURL } from 'node:url'
 const __dirname = fileURLToPath(new URL('.', import.meta.url))
 const log = new Logger('Index')
 
-// To merge ENV variables. consider after lowercasing ENV since our config keys are lowercase
-process.env = Object.keys(process.env)
-  .reduce((destination, key) => {
-    destination[key.toLowerCase()] = parseValue(process.env[key])
-    return destination
-  }, {})
-
-// build config object
-const config: RPSConfig = rc('rps')
-config.delay_activation_sync = config.delay_timer * 1000
-config.delay_setup_and_config_sync = 5000
-config.delay_tls_put_data_sync = 5000
-log.silly(`config: ${JSON.stringify(config, null, 2)}`)
-
-Environment.Config = config
-
 const app = express()
 app.use(cors())
 app.use(express.urlencoded())
@@ -75,7 +57,7 @@ export const startItUp = (): void => {
   const serverForEnterpriseAssistant: WSEnterpriseAssistantListener = new WSEnterpriseAssistantListener(new Logger('WSEnterpriseAssistantListener'))
   const server: WebSocketListener = new WebSocketListener(new Logger('WebSocketListener'), configurator.dataProcessor)
 
-  const mqtt: MqttProvider = new MqttProvider(config)
+  const mqtt: MqttProvider = new MqttProvider(Environment.Config)
   mqtt.connectBroker()
 
   const dbFactory = new DbCreatorFactory()
@@ -125,8 +107,8 @@ export const startItUp = (): void => {
         await waitForSecretsManager(configurator.secretsManager)
       })
       .then(() => {
-        app.listen(config.web_port, () => {
-          log.info(`RPS Microservice Rest APIs listening on http://:${config.web_port}.`)
+        app.listen(Environment.Config.web_port, () => {
+          log.info(`RPS Microservice Rest APIs listening on http://:${Environment.Config.web_port}.`)
         })
         server.connect()
         serverForEnterpriseAssistant.connect()
@@ -144,8 +126,8 @@ export async function setupServiceManager (config: RPSConfig): Promise<void> {
   await processServiceConfigs(consul, config)
 }
 
-if (config.consul_enabled) {
-  setupServiceManager(config).then(() => {
+if (Environment.Config.consul_enabled) {
+  setupServiceManager(Environment.Config).then(() => {
     startItUp()
   }).catch(err => {
     log.error(`Unable to reach consul: ${err}`)

src/NodeForge.ts

@@ -18,7 +18,7 @@ export class NodeForge {
   }
 
   getBags (pkcs12Pfx: forge.pkcs12.Pkcs12Pfx, filter: forge.pkcs12.BagsFilter): {
-    [key: string]: forge.pkcs12.Bag[]
+    [key: string]: forge.pkcs12.Bag[] | undefined
     localKeyId?: forge.pkcs12.Bag[]
     friendlyName?: forge.pkcs12.Bag[]
   } {

src/ProfileManager.ts

@@ -29,9 +29,9 @@ export class ProfileManager implements IProfileManager {
    * @param {string} profileName profile to look up
    * @returns {string} returns the activation to be performed
    */
-  public async getActivationMode (profileName: string, tenantId: string): Promise<string> {
+  public async getActivationMode (profileName: string, tenantId: string): Promise<string | null> {
     const profile = await this.getAmtProfile(profileName, tenantId)
-    let activation: string
+    let activation: string | null = null
 
     if (profile?.activation) {
       this.logger.debug(`found activation for profile ${profileName}`)
@@ -48,15 +48,19 @@ export class ProfileManager implements IProfileManager {
    * @param {string} profile of cira config
    * @returns {string} returns the config for CIRA for a given profile
    */
-  public async getCiraConfiguration (profileName: string, tenantId: string): Promise<CIRAConfig> {
+  public async getCiraConfiguration (profileName: string | null, tenantId: string): Promise<CIRAConfig | null> {
     const profile = await this.getAmtProfile(profileName, tenantId)
-    let ciraConfig: CIRAConfig
+    let ciraConfig: CIRAConfig | null = null
 
-    if (profile?.ciraConfigName && profile.ciraConfigObject) {
-      this.logger.debug(`found CIRAConfigObject for profile: ${profile.profileName}`)
-      ciraConfig = profile.ciraConfigObject
+    if (profile) {
+      if (profile.ciraConfigName && profile.ciraConfigObject) {
+        this.logger.debug(`found CIRAConfigObject for profile: ${profile.profileName}`)
+        ciraConfig = profile.ciraConfigObject
+      } else {
+        this.logger.debug(`unable to find CIRAConfig for profile ${profile.profileName}`)
+      }
     } else {
-      this.logger.debug(`unable to find CIRAConfig for profile ${profile.profileName}`)
+      this.logger.debug(`unable to find CIRAConfig for profile ${profileName}`)
     }
 
     return ciraConfig
@@ -67,9 +71,9 @@ export class ProfileManager implements IProfileManager {
    * @param {string} profileName profile name of amt password
    * @returns {string} returns the amt password for a given profile
    */
-  public async getAmtPassword (profileName: string, tenantId: string): Promise<string> {
-    const profile: AMTConfiguration = await this.getAmtProfile(profileName, tenantId)
-    let amtPassword: string
+  public async getAmtPassword (profileName: string, tenantId: string): Promise<string | null> {
+    const profile: AMTConfiguration | null = await this.getAmtProfile(profileName, tenantId)
+    let amtPassword: string | null = null
     if (profile) {
       if (profile.generateRandomPassword) {
         amtPassword = PasswordHelper.generateRandomPassword()
@@ -82,27 +86,30 @@ export class ProfileManager implements IProfileManager {
       } else if (this.secretsManager) {
         amtPassword = await this.secretsManager.getSecretFromKey(`profiles/${profileName}`, 'AMT_PASSWORD')
       } else {
-        amtPassword = profile.amtPassword
+        if (profile.amtPassword) {
+          amtPassword = profile.amtPassword
+        }
       }
-      this.logger.debug(`found amtPassword for profile ${profileName}`)
       if (!amtPassword) {
         this.logger.error('password cannot be blank')
         throw new Error('password cannot be blank')
       }
+      this.logger.debug(`found amtPassword for profile ${profileName}`)
       return amtPassword
     } else {
       this.logger.error(`unable to find amtPassword for profile ${profileName}`)
     }
+    return null
   }
 
   /**
     * @description Retrieves the amt password set in the configuration or generates a nonstatic password
     * @param {string} profileName profile name of amt password
     * @returns {string} returns the amt password for a given profile
    */
-  public async getMEBxPassword (profileName: string, tenantId: string): Promise<string> {
-    const profile: AMTConfiguration = await this.getAmtProfile(profileName, tenantId)
-    let mebxPassword: string
+  public async getMEBxPassword (profileName: string, tenantId: string): Promise<string | null> {
+    const profile: AMTConfiguration | null = await this.getAmtProfile(profileName, tenantId)
+    let mebxPassword: string | null = null
     if (profile) {
       if (profile.generateRandomMEBxPassword) {
         mebxPassword = PasswordHelper.generateRandomPassword()
@@ -115,18 +122,20 @@ export class ProfileManager implements IProfileManager {
       } else if (this.secretsManager) {
         mebxPassword = await this.secretsManager.getSecretFromKey(`profiles/${profileName}`, 'MEBX_PASSWORD')
       } else {
-        mebxPassword = profile.mebxPassword
+        if (profile.mebxPassword) {
+          mebxPassword = profile.mebxPassword
+        }
       }
-
-      this.logger.debug(`found amtPassword for profile ${profileName}`)
       if (!mebxPassword) {
         this.logger.error('mebx password cannot be blank')
         throw new Error('mebx password cannot be blank')
       }
+      this.logger.debug(`found amtPassword for profile ${profileName}`)
       return mebxPassword
     } else {
       this.logger.error(`unable to find mebxPassword for profile ${profileName}`)
     }
+    return null
   }
 
   /**
@@ -136,8 +145,8 @@ export class ProfileManager implements IProfileManager {
      * @returns {string} returns the MPS password for a given profile
      */
   public async getMPSPassword (profileName: string, tenantId: string): Promise<string> {
-    const profile: AMTConfiguration = await this.getAmtProfile(profileName, tenantId)
-    let mpsPassword: string
+    const profile: AMTConfiguration | null = await this.getAmtProfile(profileName, tenantId)
+    let mpsPassword: string | null = null
 
     if (profile?.ciraConfigObject) {
       mpsPassword = PasswordHelper.generateRandomPassword()
@@ -164,14 +173,17 @@ export class ProfileManager implements IProfileManager {
     * @param {string} profile
     * @returns {AMTConfiguration} returns AMTConfig object if profile exists otherwise null.
     */
-  public async getAmtProfile (profile: string, tenantId: string): Promise<AMTConfiguration> {
+  public async getAmtProfile (profile: string | null, tenantId: string): Promise<AMTConfiguration | null> {
     try {
       if (!profile) {
         return null
       }
-      const amtProfile: AMTConfiguration = await this.amtConfigurations.getByName(profile, tenantId)
+      const amtProfile: AMTConfiguration | null = await this.amtConfigurations.getByName(profile, tenantId)
+      if (!amtProfile) {
+        return null
+      }
       // If the CIRA Config associated with profile, retrieves from DB
-      if (amtProfile?.ciraConfigName != null) {
+      if (amtProfile.ciraConfigName != null) {
         amtProfile.ciraConfigObject = await this.amtConfigurations.getCiraConfigForProfile(amtProfile.ciraConfigName, tenantId)
       }
       // If the TLS Config associated with profile, retrieves from DB
@@ -182,7 +194,7 @@ export class ProfileManager implements IProfileManager {
         }
       }
       // If the CIRA Config associated with profile, retrieves from DB
-      if (amtProfile?.ieee8021xProfileName != null) {
+      if (amtProfile.ieee8021xProfileName != null) {
         amtProfile.ieee8021xProfileObject = await this.amtConfigurations.get8021XConfigForProfile(amtProfile.ieee8021xProfileName, tenantId)
       }
       this.logger.debug(`AMT Profile returned from db: ${amtProfile?.profileName}`)