Merge branch '1313-config-race-condition-c' into 1313-config-race-condition-b

Author: kriswest

src/db/file/pushes.ts

@@ -1,17 +1,14 @@
-import fs from 'fs';
 import _ from 'lodash';
 import Datastore from '@seald-io/nedb';
 import { Action } from '../../proxy/actions/Action';
 import { toClass } from '../helper';
 import { PushQuery } from '../types';
+import { initializeFolders } from './helper';
 
 const COMPACTION_INTERVAL = 1000 * 60 * 60 * 24; // once per day
 
 // these don't get coverage in tests as they have already been run once before the test
 /* istanbul ignore if */
-if (!fs.existsSync('./.data')) fs.mkdirSync('./.data');
-/* istanbul ignore if */
-if (!fs.existsSync('./.data/db')) fs.mkdirSync('./.data/db');
 
 // export for testing purposes
 export let db: Datastore;

src/proxy/actions/Action.ts

@@ -151,4 +151,4 @@ class Action {
   }
 }
 
-export { Action };
+export { Action, CommitData };

test/1.test.ts

@@ -10,9 +10,9 @@
 
 import { describe, it, beforeAll, afterAll, beforeEach, afterEach, expect, vi } from 'vitest';
 import request from 'supertest';
-import service from '../src/service';
+import { Service } from '../src/service';
 import * as db from '../src/db';
-import Proxy from '../src/proxy';
+import { Proxy } from '../src/proxy';
 
 // Create constants for values used in multiple tests
 const TEST_REPO = {
@@ -29,7 +29,7 @@ describe('init', () => {
   beforeAll(async function () {
     // Starts the service and returns the express app
     const proxy = new Proxy();
-    app = await service.start(proxy);
+    app = await Service.start(proxy);
   });
 
   // Runs before each test
@@ -52,7 +52,7 @@ describe('init', () => {
   // Runs after all tests
   afterAll(function () {
     // Must close the server to avoid EADDRINUSE errors when running tests in parallel
-    service.httpServer.close();
+    Service.httpServer.close();
   });
 
   // Example test: check server is running

test/ConfigLoader.test.ts

@@ -1,7 +1,7 @@
 import { describe, it, beforeEach, afterEach, afterAll, expect, vi } from 'vitest';
 import fs from 'fs';
 import path from 'path';
-import { configFile } from '../src/config/file';
+import { getConfigFile } from '../src/config/file';
 import {
   ConfigLoader,
   isValidGitUrl,
@@ -39,6 +39,7 @@ describe('ConfigLoader', () => {
 
   afterAll(async () => {
     // reset config to default after all tests have run
+    const configFile = getConfigFile();
     console.log(`Restoring config to defaults from file ${configFile}`);
     configLoader = new ConfigLoader({});
     await configLoader.loadFromFile({

test/processors/checkAuthorEmails.test.ts

@@ -3,7 +3,7 @@ import { exec } from '../../src/proxy/processors/push-action/checkAuthorEmails';
 import { Action } from '../../src/proxy/actions';
 import * as configModule from '../../src/config';
 import * as validator from 'validator';
-import { Commit } from '../../src/proxy/actions/Action';
+import { CommitData } from '../../src/proxy/actions/Action';
 
 // mock dependencies
 vi.mock('../../src/config', async (importOriginal) => {
@@ -66,8 +66,8 @@ describe('checkAuthorEmails', () => {
     describe('basic email validation', () => {
       it('should allow valid email addresses', async () => {
         mockAction.commitData = [
-          { authorEmail: '[email protected]' } as Commit,
-          { authorEmail: '[email protected]' } as Commit,
+          { authorEmail: '[email protected]' } as CommitData,
+          { authorEmail: '[email protected]' } as CommitData,
         ];
 
         const result = await exec(mockReq, mockAction);
@@ -78,7 +78,7 @@ describe('checkAuthorEmails', () => {
       });
 
       it('should reject empty email', async () => {
-        mockAction.commitData = [{ authorEmail: '' } as Commit];
+        mockAction.commitData = [{ authorEmail: '' } as CommitData];
 
         const result = await exec(mockReq, mockAction);
 
@@ -88,7 +88,7 @@ describe('checkAuthorEmails', () => {
 
       it('should reject null/undefined email', async () => {
         vi.mocked(validator.isEmail).mockReturnValue(false);
-        mockAction.commitData = [{ authorEmail: null as any } as Commit];
+        mockAction.commitData = [{ authorEmail: null as any } as CommitData];
 
         const result = await exec(mockReq, mockAction);
 
@@ -99,9 +99,9 @@ describe('checkAuthorEmails', () => {
       it('should reject invalid email format', async () => {
         vi.mocked(validator.isEmail).mockReturnValue(false);
         mockAction.commitData = [
-          { authorEmail: 'not-an-email' } as Commit,
-          { authorEmail: 'missing@domain' } as Commit,
-          { authorEmail: '@nodomain.com' } as Commit,
+          { authorEmail: 'not-an-email' } as CommitData,
+          { authorEmail: 'missing@domain' } as CommitData,
+          { authorEmail: '@nodomain.com' } as CommitData,
         ];
 
         const result = await exec(mockReq, mockAction);
@@ -127,8 +127,8 @@ describe('checkAuthorEmails', () => {
         } as any);
 
         mockAction.commitData = [
-          { authorEmail: '[email protected]' } as Commit,
-          { authorEmail: '[email protected]' } as Commit,
+          { authorEmail: '[email protected]' } as CommitData,
+          { authorEmail: '[email protected]' } as CommitData,
         ];
 
         const result = await exec(mockReq, mockAction);
@@ -152,8 +152,8 @@ describe('checkAuthorEmails', () => {
         } as any);
 
         mockAction.commitData = [
-          { authorEmail: '[email protected]' } as Commit,
-          { authorEmail: '[email protected]' } as Commit,
+          { authorEmail: '[email protected]' } as CommitData,
+          { authorEmail: '[email protected]' } as CommitData,
         ];
 
         const result = await exec(mockReq, mockAction);
@@ -177,8 +177,8 @@ describe('checkAuthorEmails', () => {
         } as any);
 
         mockAction.commitData = [
-          { authorEmail: '[email protected]' } as Commit,
-          { authorEmail: '[email protected]' } as Commit,
+          { authorEmail: '[email protected]' } as CommitData,
+          { authorEmail: '[email protected]' } as CommitData,
         ];
 
         const result = await exec(mockReq, mockAction);
@@ -203,8 +203,8 @@ describe('checkAuthorEmails', () => {
         } as any);
 
         mockAction.commitData = [
-          { authorEmail: '[email protected]' } as Commit,
-          { authorEmail: '[email protected]' } as Commit,
+          { authorEmail: '[email protected]' } as CommitData,
+          { authorEmail: '[email protected]' } as CommitData,
         ];
 
         const result = await exec(mockReq, mockAction);
@@ -230,8 +230,8 @@ describe('checkAuthorEmails', () => {
         } as any);
 
         mockAction.commitData = [
-          { authorEmail: '[email protected]' } as Commit,
-          { authorEmail: '[email protected]' } as Commit,
+          { authorEmail: '[email protected]' } as CommitData,
+          { authorEmail: '[email protected]' } as CommitData,
         ];
 
         const result = await exec(mockReq, mockAction);
@@ -255,8 +255,8 @@ describe('checkAuthorEmails', () => {
         } as any);
 
         mockAction.commitData = [
-          { authorEmail: '[email protected]' } as Commit,
-          { authorEmail: '[email protected]' } as Commit,
+          { authorEmail: '[email protected]' } as CommitData,
+          { authorEmail: '[email protected]' } as CommitData,
         ];
 
         const result = await exec(mockReq, mockAction);
@@ -280,9 +280,9 @@ describe('checkAuthorEmails', () => {
         } as any);
 
         mockAction.commitData = [
-          { authorEmail: '[email protected]' } as Commit,
-          { authorEmail: '[email protected]' } as Commit,
-          { authorEmail: '[email protected]' } as Commit,
+          { authorEmail: '[email protected]' } as CommitData,
+          { authorEmail: '[email protected]' } as CommitData,
+          { authorEmail: '[email protected]' } as CommitData,
         ];
 
         const result = await exec(mockReq, mockAction);
@@ -306,8 +306,8 @@ describe('checkAuthorEmails', () => {
         } as any);
 
         mockAction.commitData = [
-          { authorEmail: '[email protected]' } as Commit,
-          { authorEmail: '[email protected]' } as Commit,
+          { authorEmail: '[email protected]' } as CommitData,
+          { authorEmail: '[email protected]' } as CommitData,
         ];
 
         const result = await exec(mockReq, mockAction);
@@ -333,9 +333,9 @@ describe('checkAuthorEmails', () => {
         } as any);
 
         mockAction.commitData = [
-          { authorEmail: '[email protected]' } as Commit, // valid
-          { authorEmail: '[email protected]' } as Commit, // invalid: blocked local
-          { authorEmail: '[email protected]' } as Commit, // invalid: wrong domain
+          { authorEmail: '[email protected]' } as CommitData, // valid
+          { authorEmail: '[email protected]' } as CommitData, // invalid: blocked local
+          { authorEmail: '[email protected]' } as CommitData, // invalid: wrong domain
         ];
 
         const result = await exec(mockReq, mockAction);
@@ -348,7 +348,7 @@ describe('checkAuthorEmails', () => {
 
   describe('exec function behavior', () => {
     it('should create a step with name "checkAuthorEmails"', async () => {
-      mockAction.commitData = [{ authorEmail: '[email protected]' } as Commit];
+      mockAction.commitData = [{ authorEmail: '[email protected]' } as CommitData];
 
       await exec(mockReq, mockAction);
 
@@ -361,11 +361,11 @@ describe('checkAuthorEmails', () => {
 
     it('should handle unique author emails correctly', async () => {
       mockAction.commitData = [
-        { authorEmail: '[email protected]' } as Commit,
-        { authorEmail: '[email protected]' } as Commit,
-        { authorEmail: '[email protected]' } as Commit, // Duplicate
-        { authorEmail: '[email protected]' } as Commit,
-        { authorEmail: '[email protected]' } as Commit, // Duplicate
+        { authorEmail: '[email protected]' } as CommitData,
+        { authorEmail: '[email protected]' } as CommitData,
+        { authorEmail: '[email protected]' } as CommitData, // Duplicate
+        { authorEmail: '[email protected]' } as CommitData,
+        { authorEmail: '[email protected]' } as CommitData, // Duplicate
       ];
 
       await exec(mockReq, mockAction);
@@ -395,15 +395,15 @@ describe('checkAuthorEmails', () => {
 
     it('should log error message when illegal emails found', async () => {
       vi.mocked(validator.isEmail).mockReturnValue(false);
-      mockAction.commitData = [{ authorEmail: 'invalid-email' } as Commit];
+      mockAction.commitData = [{ authorEmail: 'invalid-email' } as CommitData];
 
       await exec(mockReq, mockAction);
     });
 
     it('should log success message when all emails are legal', async () => {
       mockAction.commitData = [
-        { authorEmail: '[email protected]' } as Commit,
-        { authorEmail: '[email protected]' } as Commit,
+        { authorEmail: '[email protected]' } as CommitData,
+        { authorEmail: '[email protected]' } as CommitData,
       ];
 
       await exec(mockReq, mockAction);
@@ -415,7 +415,7 @@ describe('checkAuthorEmails', () => {
 
     it('should set error on step when illegal emails found', async () => {
       vi.mocked(validator.isEmail).mockReturnValue(false);
-      mockAction.commitData = [{ authorEmail: 'bad@email' } as Commit];
+      mockAction.commitData = [{ authorEmail: 'bad@email' } as CommitData];
 
       await exec(mockReq, mockAction);
 
@@ -425,7 +425,7 @@ describe('checkAuthorEmails', () => {
 
     it('should call step.setError with user-friendly message', async () => {
       vi.mocked(validator.isEmail).mockReturnValue(false);
-      mockAction.commitData = [{ authorEmail: 'bad' } as Commit];
+      mockAction.commitData = [{ authorEmail: 'bad' } as CommitData];
 
       await exec(mockReq, mockAction);
 
@@ -437,7 +437,7 @@ describe('checkAuthorEmails', () => {
     });
 
     it('should return the action object', async () => {
-      mockAction.commitData = [{ authorEmail: '[email protected]' } as Commit];
+      mockAction.commitData = [{ authorEmail: '[email protected]' } as CommitData];
 
       const result = await exec(mockReq, mockAction);
 
@@ -446,9 +446,9 @@ describe('checkAuthorEmails', () => {
 
     it('should handle mixed valid and invalid emails', async () => {
       mockAction.commitData = [
-        { authorEmail: '[email protected]' } as Commit,
-        { authorEmail: 'invalid' } as Commit,
-        { authorEmail: '[email protected]' } as Commit,
+        { authorEmail: '[email protected]' } as CommitData,
+        { authorEmail: 'invalid' } as CommitData,
+        { authorEmail: '[email protected]' } as CommitData,
       ];
 
       vi.mocked(validator.isEmail).mockImplementation((email: string) => {
@@ -471,7 +471,7 @@ describe('checkAuthorEmails', () => {
   describe('edge cases', () => {
     it('should handle email with multiple @ symbols', async () => {
       vi.mocked(validator.isEmail).mockReturnValue(false);
-      mockAction.commitData = [{ authorEmail: 'user@@example.com' } as Commit];
+      mockAction.commitData = [{ authorEmail: 'user@@example.com' } as CommitData];
 
       const result = await exec(mockReq, mockAction);
 
@@ -481,7 +481,7 @@ describe('checkAuthorEmails', () => {
 
     it('should handle email without domain', async () => {
       vi.mocked(validator.isEmail).mockReturnValue(false);
-      mockAction.commitData = [{ authorEmail: 'user@' } as Commit];
+      mockAction.commitData = [{ authorEmail: 'user@' } as CommitData];
 
       const result = await exec(mockReq, mockAction);
 
@@ -492,7 +492,7 @@ describe('checkAuthorEmails', () => {
     it('should handle very long email addresses', async () => {
       const longLocal = 'a'.repeat(64);
       const longEmail = `${longLocal}@example.com`;
-      mockAction.commitData = [{ authorEmail: longEmail } as Commit];
+      mockAction.commitData = [{ authorEmail: longEmail } as CommitData];
 
       const result = await exec(mockReq, mockAction);
 
@@ -501,9 +501,9 @@ describe('checkAuthorEmails', () => {
 
     it('should handle special characters in local part', async () => {
       mockAction.commitData = [
-        { authorEmail: '[email protected]' } as Commit,
-        { authorEmail: '[email protected]' } as Commit,
-        { authorEmail: '[email protected]' } as Commit,
+        { authorEmail: '[email protected]' } as CommitData,
+        { authorEmail: '[email protected]' } as CommitData,
+        { authorEmail: '[email protected]' } as CommitData,
       ];
 
       const result = await exec(mockReq, mockAction);
@@ -527,8 +527,8 @@ describe('checkAuthorEmails', () => {
       } as any);
 
       mockAction.commitData = [
-        { authorEmail: '[email protected]' } as Commit,
-        { authorEmail: '[email protected]' } as Commit,
+        { authorEmail: '[email protected]' } as CommitData,
+        { authorEmail: '[email protected]' } as CommitData,
       ];
 
       const result = await exec(mockReq, mockAction);