feat(APIM-468): change how integer config values are parsed

src/config/app.config.test.ts

@@ -1,11 +1,9 @@
-import { RandomValueGenerator } from '@ukef-test/support/generator/random-value-generator';
+import { withEnvironmentVariableParsingUnitTests } from '@ukef-test/common-tests/environment-variable-parsing-unit-tests';
 
-import appConfig from './app.config';
+import appConfig, { AppConfig } from './app.config';
 import { InvalidConfigException } from './invalid-config.exception';
 
 describe('appConfig', () => {
-  const valueGenerator = new RandomValueGenerator();
-
   let originalProcessEnv: NodeJS.ProcessEnv;
 
   beforeEach(() => {
@@ -79,107 +77,42 @@ describe('appConfig', () => {
     });
   });
 
-  describe('parsing REDACT_LOGS', () => {
-    it('sets redactLogs to true if REDACT_LOGS is true', () => {
-      replaceEnvironmentVariables({
-        REDACT_LOGS: 'true',
-      });
-
-      const config = appConfig();
-
-      expect(config.redactLogs).toBe(true);
-    });
-
-    it('sets redactLogs to false if REDACT_LOGS is false', () => {
-      replaceEnvironmentVariables({
-        REDACT_LOGS: 'false',
-      });
-
-      const config = appConfig();
-
-      expect(config.redactLogs).toBe(false);
-    });
-
-    it('sets redactLogs to true if REDACT_LOGS is not specified', () => {
-      replaceEnvironmentVariables({});
-
-      const config = appConfig();
-
-      expect(config.redactLogs).toBe(true);
-    });
-
-    it('sets redactLogs to true if REDACT_LOGS is the empty string', () => {
-      replaceEnvironmentVariables({
-        REDACT_LOGS: '',
-      });
-
-      const config = appConfig();
-
-      expect(config.redactLogs).toBe(true);
-    });
-
-    it('sets redactLogs to true if REDACT_LOGS is any string other than true or false', () => {
-      replaceEnvironmentVariables({
-        REDACT_LOGS: valueGenerator.string(),
-      });
-
-      const config = appConfig();
-
-      expect(config.redactLogs).toBe(true);
-    });
-  });
-
-  describe('parsing SINGLE_LINE_LOG_FORMAT', () => {
-    it('sets singleLineLogFormat to true if SINGLE_LINE_LOG_FORMAT is true', () => {
-      replaceEnvironmentVariables({
-        SINGLE_LINE_LOG_FORMAT: 'true',
-      });
-
-      const config = appConfig();
-
-      expect(config.singleLineLogFormat).toBe(true);
-    });
-
-    it('sets singleLineLogFormat to false if SINGLE_LINE_LOG_FORMAT is false', () => {
-      replaceEnvironmentVariables({
-        SINGLE_LINE_LOG_FORMAT: 'false',
-      });
-
-      const config = appConfig();
-
-      expect(config.singleLineLogFormat).toBe(false);
-    });
-
-    it('sets singleLineLogFormat to true if SINGLE_LINE_LOG_FORMAT is not specified', () => {
-      replaceEnvironmentVariables({});
-
-      const config = appConfig();
-
-      expect(config.singleLineLogFormat).toBe(true);
-    });
-
-    it('sets singleLineLogFormat to true if SINGLE_LINE_LOG_FORMAT is the empty string', () => {
-      replaceEnvironmentVariables({
-        SINGLE_LINE_LOG_FORMAT: '',
-      });
-
-      const config = appConfig();
-
-      expect(config.singleLineLogFormat).toBe(true);
-    });
-
-    it('sets singleLineLogFormat to true if SINGLE_LINE_LOG_FORMAT is any string other than true or false', () => {
-      replaceEnvironmentVariables({
-        SINGLE_LINE_LOG_FORMAT: valueGenerator.string(),
-      });
-
-      const config = appConfig();
-
-      expect(config.singleLineLogFormat).toBe(true);
-    });
-  });
-
   const replaceEnvironmentVariables = (newEnvVariables: Record<string, string>): void => {
     process.env = newEnvVariables;
   };
+
+  const configParsedBooleanFromEnvironmentVariablesWithDefault: {
+    configPropertyName: keyof AppConfig;
+    environmentVariableName: string;
+    defaultConfigValue: boolean;
+  }[] = [
+    {
+      configPropertyName: 'singleLineLogFormat',
+      environmentVariableName: 'SINGLE_LINE_LOG_FORMAT',
+      defaultConfigValue: true,
+    },
+    {
+      configPropertyName: 'redactLogs',
+      environmentVariableName: 'REDACT_LOGS',
+      defaultConfigValue: true,
+    },
+  ];
+
+  const configParsedAsIntFromEnvironmentVariablesWithDefault: {
+    configPropertyName: keyof AppConfig;
+    environmentVariableName: string;
+    defaultConfigValue: number;
+  }[] = [
+    {
+      configPropertyName: 'port',
+      environmentVariableName: 'HTTP_PORT',
+      defaultConfigValue: 3003,
+    },
+  ];
+
+  withEnvironmentVariableParsingUnitTests({
+    configParsedBooleanFromEnvironmentVariablesWithDefault,
+    configParsedAsIntFromEnvironmentVariablesWithDefault,
+    getConfig: () => appConfig(),
+  });
 });

src/config/app.config.ts

@@ -1,9 +1,26 @@
 import { registerAs } from '@nestjs/config';
+import { getIntConfig } from '@ukef/helpers/get-int-config';
 
 import { InvalidConfigException } from './invalid-config.exception';
 
 const validLogLevels = ['fatal', 'error', 'warn', 'info', 'debug', 'trace', 'silent'];
 
+export interface AppConfig {
+  name: string;
+  env: string;
+  versioning: {
+    enable: boolean;
+    prefix: string;
+    version: string;
+  };
+  globalPrefix: string;
+  port: number;
+  apiKey: string;
+  logLevel: string;
+  redactLogs: boolean;
+  singleLineLogFormat: boolean;
+}
+
 export default registerAs('app', (): Record<string, any> => {
   const logLevel = process.env.LOG_LEVEL || 'info';
   if (!validLogLevels.includes(logLevel)) {
@@ -20,7 +37,7 @@ export default registerAs('app', (): Record<string, any> => {
     },
 
     globalPrefix: '/api',
-    port: process.env.HTTP_PORT ? Number.parseInt(process.env.HTTP_PORT, 10) : 3003,
+    port: getIntConfig(process.env.HTTP_PORT, 3003),
     apiKey: process.env.API_KEY,
     logLevel: process.env.LOG_LEVEL || 'info',
     redactLogs: process.env.REDACT_LOGS !== 'false',

src/config/informatica.config.ts

@@ -1,4 +1,5 @@
 import { registerAs } from '@nestjs/config';
+import { getIntConfig } from '@ukef/helpers/get-int-config';
 
 export const KEY = 'informatica';
 
@@ -16,7 +17,7 @@ export default registerAs(
     baseUrl: process.env.APIM_INFORMATICA_URL,
     username: process.env.APIM_INFORMATICA_USERNAME,
     password: process.env.APIM_INFORMATICA_PASSWORD,
-    maxRedirects: parseInt(process.env.APIM_INFORMATICA_MAX_REDIRECTS) || 5,
-    timeout: parseInt(process.env.APIM_INFORMATICA_TIMEOUT) || 30000,
+    maxRedirects: getIntConfig(process.env.APIM_INFORMATICA_MAX_REDIRECTS, 5),
+    timeout: getIntConfig(process.env.APIM_INFORMATICA_TIMEOUT, 30000),
   }),
 );

src/helpers/get-int-config.helper.test.ts

@@ -0,0 +1,47 @@
+import { InvalidConfigException } from '@ukef/config/invalid-config.exception';
+
+import { getIntConfig } from './get-int-config';
+
+describe('GetIntConfig helper', () => {
+  describe('getIntConfig returns value', () => {
+    it.each([
+      { value: undefined, defaultValue: 60, expectedResult: 60 },
+      { value: '123', defaultValue: 60, expectedResult: 123 },
+      { value: '123', defaultValue: undefined, expectedResult: 123 },
+      { value: '-123', defaultValue: 60, expectedResult: -123 },
+      { value: '0', defaultValue: 60, expectedResult: 0 },
+      { value: `${Number.MAX_SAFE_INTEGER}`, defaultValue: 60, expectedResult: Number.MAX_SAFE_INTEGER },
+      { value: `-${Number.MAX_SAFE_INTEGER}`, defaultValue: 60, expectedResult: -Number.MAX_SAFE_INTEGER },
+    ])('if input is "$value", returns $expectedResult', ({ value, defaultValue, expectedResult }) => {
+      expect(getIntConfig(value, defaultValue)).toBe(expectedResult);
+    });
+  });
+
+  describe('getIntConfig throws invalid integer exception', () => {
+    it.each(['abc', '12.5', '20th', '0xFF', '0b101'])(`throws InvalidConfigException for "%s" because it is not valid integer`, (value) => {
+      const gettingTheConfig = () => getIntConfig(value as unknown as string);
+
+      expect(gettingTheConfig).toThrow(InvalidConfigException);
+      expect(gettingTheConfig).toThrow(`Invalid integer value "${value}" for configuration property.`);
+    });
+  });
+
+  describe('getIntConfig throws InvalidConfigException because environment variable type is not string', () => {
+    it.each([12, true, null, false, /.*/, {}, [], 0xff, 0b101])(
+      'throws InvalidConfigException for "%s" because environment variable type is not string',
+      (value) => {
+        const gettingTheConfig = () => getIntConfig(value as unknown as string);
+
+        expect(gettingTheConfig).toThrow(InvalidConfigException);
+        expect(gettingTheConfig).toThrow(`Input environment variable type for ${value} should be string.`);
+      },
+    );
+  });
+
+  it('throws InvalidConfigException if environment variable and default value is missing', () => {
+    const gettingTheConfig = () => getIntConfig(undefined);
+
+    expect(gettingTheConfig).toThrow(InvalidConfigException);
+    expect(gettingTheConfig).toThrow("Environment variable is missing and doesn't have default value.");
+  });
+});

src/helpers/get-int-config.ts

@@ -0,0 +1,21 @@
+import { InvalidConfigException } from '@ukef/config/invalid-config.exception';
+
+// This helper function is used to get integer from configuration.
+export const getIntConfig = (environmentVariable: string, defaultValue?: number): number => {
+  if (typeof environmentVariable === 'undefined') {
+    if (typeof defaultValue === 'undefined') {
+      throw new InvalidConfigException(`Environment variable is missing and doesn't have default value.`);
+    }
+    return defaultValue;
+  }
+  if (typeof environmentVariable !== 'string') {
+    throw new InvalidConfigException(`Input environment variable type for ${environmentVariable} should be string.`);
+  }
+
+  const integer = parseInt(environmentVariable, 10);
+  // Check if parseInt is number, decimal base integer and input didn't have anything non-numeric.
+  if (isNaN(integer) || integer.toString() !== environmentVariable) {
+    throw new InvalidConfigException(`Invalid integer value "${environmentVariable}" for configuration property.`);
+  }
+  return integer;
+};

src/helpers/regex.helper.test.ts

@@ -1,13 +1,13 @@
 import { regexToString } from './regex.helper';
 
-describe('Regex Helper', () => {
+describe('Regex helper', () => {
   describe('regexToString', () => {
     it('replaces the leading and trailing forward slashes with an empty string', () => {
       const regex = /test/;
       const regexString = regexToString(regex);
 
       expect(regexString).toBe('test');
       expect(new RegExp(regexString)).toEqual(regex);
     });
 
     it('escapes regexp forward slashes inside a string', () => {
@@ -15,7 +15,7 @@
       const regexString = regexToString(regex);
 
       expect(regexString).toBe('test\\/test');
       expect(new RegExp(regexString)).toEqual(regex);
     });
 
     it('escapes multiple back slashes inside a string', () => {
@@ -23,7 +23,7 @@
       const regexString = regexToString(regex);
 
       expect(regexString).toBe('^(?!\\s)[\\w\\-.()\\s]+(?<![\\s.])$');
       expect(new RegExp(regexString)).toEqual(regex);
     });
 
     it('escapes forward slashes inside a string', () => {
@@ -31,7 +31,7 @@
       const regexString = regexToString(regex);
 
       expect(regexString).toBe('^[\\w\\-:/\\\\()\\s]+$');
       expect(new RegExp(regexString)).toEqual(regex);
     });
   });
 });