feat: converted config-loader test to typescript

Migrates the ConfigLoader test suite from JavaScript to TypeScript
for improved type safety and maintainability

Author: dcoric

package-lock.json

@@ -13,7 +13,7 @@
     "build-lib": "./scripts/build-for-publish.sh",
     "restore-lib": "./scripts/undo-build.sh",
     "check-types": "tsc",
-    "test": "NODE_ENV=test ts-mocha './test/*.js' --exit",
+    "test": "NODE_ENV=test ts-mocha './test/**/*.{js,ts}' --exit",
     "test-coverage": "nyc npm run test",
     "test-coverage-ci": "nyc --reporter=lcovonly --reporter=text npm run test",
     "prepare": "node ./scripts/prepare.js",
@@ -90,6 +90,7 @@
     "@types/lodash": "^4.17.15",
     "@types/mocha": "^10.0.10",
     "@types/node": "^22.13.5",
+    "@types/sinon": "^17.0.4",
     "@types/yargs": "^17.0.33",
     "@typescript-eslint/eslint-plugin": "^8.26.1",
     "@typescript-eslint/parser": "^8.26.1",

package.json

@@ -1,16 +1,15 @@
-const chai = require('chai');
-const fs = require('fs');
-const path = require('path');
-const { expect } = chai;
-const ConfigLoader = require('../src/config/ConfigLoader');
-const { isValidGitUrl, isValidPath, isValidBranchName } = ConfigLoader;
-const sinon = require('sinon');
-const axios = require('axios');
+import fs from 'fs';
+import path from 'path';
+import { expect } from 'chai';
+import { ConfigLoader, Configuration } from '../src/config/ConfigLoader';
+import { isValidGitUrl, isValidPath, isValidBranchName } from '../src/config/ConfigLoader';
+import sinon from 'sinon';
+import axios from 'axios';
 
 describe('ConfigLoader', () => {
-  let configLoader;
-  let tempDir;
-  let tempConfigFile;
+  let configLoader: ConfigLoader;
+  let tempDir: string;
+  let tempConfigFile: string;
 
   beforeEach(() => {
     // Create temp directory for test files
@@ -35,7 +34,11 @@ describe('ConfigLoader', () => {
       fs.writeFileSync(tempConfigFile, JSON.stringify(testConfig));
 
       configLoader = new ConfigLoader({});
-      const result = await configLoader.loadFromFile({ path: tempConfigFile });
+      const result = await configLoader.loadFromFile({
+        type: 'file',
+        enabled: true,
+        path: tempConfigFile,
+      });
 
       expect(result).to.deep.equal(testConfig);
     });
@@ -52,6 +55,8 @@ describe('ConfigLoader', () => {
 
       configLoader = new ConfigLoader({});
       const result = await configLoader.loadFromHttp({
+        type: 'http',
+        enabled: true,
         url: 'http://config-service/config',
         headers: {},
       });
@@ -64,6 +69,8 @@ describe('ConfigLoader', () => {
 
       configLoader = new ConfigLoader({});
       await configLoader.loadFromHttp({
+        type: 'http',
+        enabled: true,
         url: 'http://config-service/config',
         auth: {
           type: 'bearer',
@@ -81,7 +88,7 @@ describe('ConfigLoader', () => {
 
   describe('reloadConfiguration', () => {
     it('should emit configurationChanged event when config changes', async () => {
-      const initialConfig = {
+      const initialConfig: Configuration = {
         configurationSources: {
           enabled: true,
           sources: [
@@ -91,6 +98,7 @@ describe('ConfigLoader', () => {
               path: tempConfigFile,
             },
           ],
+          reloadIntervalSeconds: 0,
         },
       };
 
@@ -115,7 +123,7 @@ describe('ConfigLoader', () => {
         proxyUrl: 'https://test.com',
       };
 
-      const config = {
+      const config: Configuration = {
         configurationSources: {
           enabled: true,
           sources: [
@@ -125,6 +133,7 @@ describe('ConfigLoader', () => {
               path: tempConfigFile,
             },
           ],
+          reloadIntervalSeconds: 0,
         },
       };
 
@@ -169,15 +178,15 @@ describe('ConfigLoader', () => {
       await configLoader.initialize();
 
       // Check if directory exists
-      expect(fs.existsSync(configLoader.cacheDir)).to.be.true;
+      expect(fs.existsSync(configLoader.cacheDir!)).to.be.true;
     });
   });
 
   describe('loadRemoteConfig', () => {
-    let configLoader;
+    let configLoader: ConfigLoader;
     beforeEach(async () => {
       const configFilePath = path.join(__dirname, '..', 'proxy.config.json');
-      const config = JSON.parse(fs.readFileSync(configFilePath));
+      const config = JSON.parse(fs.readFileSync(configFilePath, 'utf-8')) as Configuration;
 
       config.configurationSources.enabled = true;
       configLoader = new ConfigLoader(config);
@@ -189,10 +198,11 @@ describe('ConfigLoader', () => {
       this.timeout(10000);
 
       const source = {
-        type: 'git',
+        type: 'git' as const,
         repository: 'https://github.com/finos/git-proxy.git',
         path: 'proxy.config.json',
         branch: 'main',
+        enabled: true,
       };
 
       const config = await configLoader.loadFromGit(source);
@@ -205,10 +215,11 @@ describe('ConfigLoader', () => {
 
     it('should throw error for invalid configuration file path', async function () {
       const source = {
-        type: 'git',
+        type: 'git' as const,
         repository: 'https://github.com/finos/git-proxy.git',
         path: '\0', // Invalid path
         branch: 'main',
+        enabled: true,
       };
 
       try {
@@ -224,8 +235,9 @@ describe('ConfigLoader', () => {
       this.timeout(10000);
 
       const source = {
-        type: 'http',
+        type: 'http' as const,
         url: 'https://raw.githubusercontent.com/finos/git-proxy/refs/heads/main/proxy.config.json',
+        enabled: true,
       };
 
       const config = await configLoader.loadFromHttp(source);
@@ -238,7 +250,7 @@ describe('ConfigLoader', () => {
   });
 
   describe('deepMerge', () => {
-    let configLoader;
+    let configLoader: ConfigLoader;
 
     beforeEach(() => {
       configLoader = new ConfigLoader({});
@@ -401,7 +413,7 @@ describe('Validation Helpers', () => {
       expect(isValidBranchName('fix_123')).to.be.true;
       expect(isValidBranchName('user/feature/branch')).to.be.true;
 
-      // // Invalid branch names
+      // Invalid branch names
       expect(isValidBranchName('.invalid')).to.be.false;
       expect(isValidBranchName('-invalid')).to.be.false;
       expect(isValidBranchName('branch with spaces')).to.be.false;