@axinom/mosaic-service-common 0.27.0-rc.8 → 0.27.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@axinom/mosaic-service-common",
-  "version": "0.27.0-rc.8",
+  "version": "0.27.0",
   "description": "Common helpers and PostgreSQL-related functionality",
   "author": "Axinom",
   "license": "PROPRIETARY",
@@ -10,7 +10,8 @@
     "axinom mosaic"
   ],
   "files": [
-    "dist"
+    "dist",
+    "src"
   ],
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -69,5 +70,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "6cb62b11947643eaaa60e4c0465cb166c215a937"
+  "gitHead": "3f6c3692341670efa37fc109a382b88ef2a65209"
 }

package/src/common/config/basic-config-definitions.spec.ts

@@ -0,0 +1,200 @@
+import 'jest-extended';
+import { pick } from '../helpers';
+import { defaultMaskKeywordsArray } from '../logging';
+import {
+  getBasicConfigDefinitions,
+  getBasicDbConfigDefinitions,
+  getBasicManagedConfigDefinitions,
+} from './basic-config-definitions';
+import { getValidatedConfig } from './config-validation';
+
+describe('getBasicConfigDefinitions', () => {
+  it.each([
+    'SECRETS_HIDDEN',
+    'UNSAFE_DEBUG_UNSAFE',
+    'UNSAFE_SECRETS_NOT_HIDDEN_UNSAFE',
+  ])(
+    'SECURE_LOGGING_MODE with %p value -> keywords defined',
+    (secureLoggingValue) => {
+      // Arrange
+      const env = {
+        NODE_ENV: 'production',
+        SERVICE_ID: 'test-service',
+        SECURE_LOGGING_MODE: secureLoggingValue,
+      };
+
+      // Act
+      const config = getValidatedConfig(getBasicConfigDefinitions(env));
+
+      // Assert
+      expect(config).toEqual({
+        environment: 'production',
+        healthEndpointPort: 9000,
+        isDev: false,
+        isProd: true,
+        logLevel: 'INFO',
+        logMaskKeywords: defaultMaskKeywordsArray,
+        secureLoggingMode: secureLoggingValue,
+        serviceId: 'test-service',
+      });
+    },
+  );
+
+  it('SECURE_LOGGING_MODE not explicitly set and NODE_ENV is production -> keywords defined and SECRETS_HIDDEN mode used', () => {
+    // Arrange
+    const env = {
+      NODE_ENV: 'production',
+      SERVICE_ID: 'test-service',
+    };
+
+    // Act
+    const config = getValidatedConfig(getBasicConfigDefinitions(env));
+
+    // Assert
+    expect(config).toEqual(
+      expect.objectContaining({
+        logMaskKeywords: defaultMaskKeywordsArray,
+        secureLoggingMode: 'SECRETS_HIDDEN',
+      }),
+    );
+  });
+
+  it('SECURE_LOGGING_MODE not explicitly set and NODE_ENV is development -> UNSAFE_DEBUG_UNSAFE mode used', () => {
+    // Arrange
+    const env = {
+      NODE_ENV: 'development',
+      SERVICE_ID: 'test-service',
+    };
+
+    // Act
+    const config = getValidatedConfig(getBasicConfigDefinitions(env));
+
+    // Assert
+    expect(config).toEqual(
+      expect.objectContaining({
+        secureLoggingMode: 'UNSAFE_DEBUG_UNSAFE',
+      }),
+    );
+  });
+
+  it('SECURE_LOGGING_MODE with invalid value -> error is thrown', () => {
+    // Arrange
+    const env = {
+      NODE_ENV: 'production',
+      SERVICE_ID: 'test-service',
+      SECURE_LOGGING_MODE: 'Show Everything!',
+    };
+
+    // Assert
+    expect(() => {
+      getValidatedConfig(getBasicConfigDefinitions(env));
+    }).toThrow(
+      'Environment variable validation failed:\n- env-var: "SECURE_LOGGING_MODE" should be one of [SECRETS_HIDDEN, UNSAFE_SECRETS_NOT_HIDDEN_UNSAFE, UNSAFE_DEBUG_UNSAFE]',
+    );
+  });
+});
+
+describe('getBasicDbConfigDefinitions', () => {
+  it.each([
+    'a',
+    '_',
+    '_a',
+    '_a_',
+    'test_custom_service_owner',
+    'value_with_valid_characters_with_length_exactly_63_characters_',
+    'media_128fcad0cc2fa2cabf63cc19_login',
+  ])('DATABASE_LOGIN with valid values -> config is valid', (value) => {
+    // Arrange
+    const env = {
+      DATABASE_LOGIN: value,
+    };
+
+    // Act
+    const validatedConfig = getValidatedConfig(
+      pick(getBasicDbConfigDefinitions(env), 'dbLogin'),
+    );
+
+    // Assert
+    expect(validatedConfig).toEqual({ dbLogin: value });
+  });
+
+  it.each([
+    'stringWithCapitalLetters',
+    'string-with-dashes',
+    '5tarts_with_number',
+    'value_with_all_valid_characters_but_with_length_longer_than_63_characters',
+  ])('DATABASE_LOGIN with invalid value -> error is thrown', (value) => {
+    // Arrange
+    const env = {
+      DATABASE_LOGIN: value,
+    };
+
+    // Assert
+    expect(() => {
+      getValidatedConfig(pick(getBasicDbConfigDefinitions(env), 'dbLogin'));
+    }).toThrow(
+      'Environment variable validation failed:\n- env-var: "DATABASE_LOGIN" must only contain lowercase letters, numbers, or underscores. It must not be longer than 63 characters and must not start with a number.',
+    );
+  });
+
+  it('All db identifier config keys with valid values -> config is valid', () => {
+    // Arrange
+    const env = {
+      POSTGRESQL_ROOT: 'a',
+      DATABASE_OWNER: '_',
+      DATABASE_LOGIN: 'test_custom_service_owner',
+      DATABASE_GQL_ROLE:
+        'value_with_valid_characters_with_length_exactly_63_characters_',
+      DATABASE_ENV_OWNER: 'media_128fcad0cc2fa2cabf63cc19_login',
+    };
+    const config = {
+      ...getBasicManagedConfigDefinitions(env),
+      ...getBasicDbConfigDefinitions(env),
+    };
+
+    // Act
+    const validatedConfig = getValidatedConfig(
+      pick(config, 'pgRoot', 'dbOwner', 'dbLogin', 'dbGqlRole', 'dbEnvOwner'),
+    );
+
+    // Assert
+    expect(validatedConfig).toEqual({
+      dbEnvOwner: 'media_128fcad0cc2fa2cabf63cc19_login',
+      dbGqlRole:
+        'value_with_valid_characters_with_length_exactly_63_characters_',
+      dbLogin: 'test_custom_service_owner',
+      dbOwner: '_',
+      pgRoot: 'a',
+    });
+  });
+
+  it('All db identifier config keys with invalid values -> error is thrown', () => {
+    // Arrange
+    const env = {
+      POSTGRESQL_ROOT: 'stringWithCapitalLetters',
+      DATABASE_OWNER: 'string-with-dashes',
+      DATABASE_LOGIN: '12345',
+      DATABASE_GQL_ROLE: '5tarts_with_number',
+      DATABASE_ENV_OWNER:
+        'value_with_all_valid_characters_but_with_length_longer_than_63_characters',
+    };
+    const config = {
+      ...getBasicManagedConfigDefinitions(env),
+      ...getBasicDbConfigDefinitions(env),
+    };
+
+    // Assert
+    expect(() => {
+      getValidatedConfig(
+        pick(config, 'pgRoot', 'dbOwner', 'dbLogin', 'dbGqlRole', 'dbEnvOwner'),
+      );
+    }).toThrow(
+      `Environment variable validation failed:
+- env-var: "POSTGRESQL_ROOT" must only contain lowercase letters, numbers, or underscores. It must not be longer than 63 characters and must not start with a number.
+- env-var: "DATABASE_OWNER" must only contain lowercase letters, numbers, or underscores. It must not be longer than 63 characters and must not start with a number.
+- env-var: "DATABASE_LOGIN" must only contain lowercase letters, numbers, or underscores. It must not be longer than 63 characters and must not start with a number.
+- env-var: "DATABASE_GQL_ROLE" must only contain lowercase letters, numbers, or underscores. It must not be longer than 63 characters and must not start with a number.
+- env-var: "DATABASE_ENV_OWNER" must only contain lowercase letters, numbers, or underscores. It must not be longer than 63 characters and must not start with a number.`,
+    );
+  });
+});