refactor: checkCommitMessages logs moved to step.log

Author: RichardUri

src/proxy/processors/push-action/checkCommitMessages.ts

@@ -1,20 +1,20 @@
 import { Action, Step } from '../../actions';
 import { getCommitConfig } from '../../../config';
 
-const isMessageAllowed = (commitMessage: string): boolean => {
+const isMessageAllowed = (commitMessage: any): string | null => {
   try {
     const commitConfig = getCommitConfig();
 
     // Commit message is empty, i.e. '', null or undefined
     if (!commitMessage) {
-      console.log('No commit message included...');
-      return false;
+      // console.log('No commit message included...');
+      return 'No commit message included...';
     }
 
     // Validation for configured block pattern(s) check...
     if (typeof commitMessage !== 'string') {
-      console.log('A non-string value has been captured for the commit message...');
-      return false;
+      // console.log('A non-string value has been captured for the commit message...');
+      return 'A non-string value has been captured for the commit message...';
     }
 
     // Configured blocked literals and patterns
@@ -36,15 +36,15 @@ const isMessageAllowed = (commitMessage: string): boolean => {
 
     // Commit message matches configured block pattern(s)
     if (literalMatches.length || patternMatches.length) {
-      console.log('Commit message is blocked via configured literals/patterns...');
-      return false;
+      // console.log('Commit message is blocked via configured literals/patterns...');
+      return 'Commit message is blocked via configured literals/patterns...';
     }
   } catch (error) {
-    console.log('Invalid regex pattern...');
-    return false;
+    // console.log('Invalid regex pattern...');
+    return 'Invalid regex pattern...';
   }
 
-  return true;
+  return null;
 };
 
 // Execute if the repo is approved
@@ -53,13 +53,23 @@ const exec = async (req: any, action: Action): Promise<Action> => {
 
   const uniqueCommitMessages = [...new Set(action.commitData?.map((commit) => commit.message))];
 
-  const illegalMessages = uniqueCommitMessages.filter((message) => !isMessageAllowed(message));
+  // const illegalMessages = uniqueCommitMessages.filter((message) => !isMessageAllowed(message));
+  const illegalMessages = uniqueCommitMessages.filter(
+    (message) => isMessageAllowed(message) !== null,
+  );
 
   if (illegalMessages.length > 0) {
-    console.log(`The following commit messages are illegal: ${illegalMessages}`);
+    // console.log(`The following commit messages are illegal: ${illegalMessages}`);
 
-    step.error = true;
-    step.log(`The following commit messages are illegal: ${illegalMessages}`);
+    illegalMessages.forEach((message) => {
+      const error = isMessageAllowed(message);
+      step.log(
+        `Illegal commit message detected: "${message}" - Reason: ${error ?? 'Unknown reason'}`,
+      );
+    });
+
+    // step.error = true;
+    // step.log(`The following commit messages are illegal: ${illegalMessages}`);
     step.setError(
       `\n\n\nYour push has been blocked.\nPlease ensure your commit message(s) does not contain sensitive information or URLs.\n\nThe following commit messages are illegal: ${JSON.stringify(illegalMessages)}\n\n`,
     );
@@ -68,7 +78,8 @@ const exec = async (req: any, action: Action): Promise<Action> => {
     return action;
   }
 
-  console.log(`The following commit messages are legal: ${uniqueCommitMessages}`);
+  // console.log(`The following commit messages are legal: ${uniqueCommitMessages}`);
+  step.log(`The following commit messages are legal: ${JSON.stringify(uniqueCommitMessages)}`);
   action.addStep(step);
   return action;
 };

test/processors/checkCommitMessages.test.ts

@@ -46,7 +46,7 @@ describe('checkCommitMessages', () => {
         const result = await exec({}, action);
 
         expect(result.steps[0].error).toBe(true);
-        expect(consoleLogSpy).toHaveBeenCalledWith('No commit message included...');
+        expect(result.steps[0].logs.join('\n')).toContain('No commit message included...');
       });
 
       it('should block null commit messages', async () => {
@@ -74,7 +74,7 @@ describe('checkCommitMessages', () => {
         const result = await exec({}, action);
 
         expect(result.steps[0].error).toBe(true);
-        expect(consoleLogSpy).toHaveBeenCalledWith(
+        expect(JSON.stringify(result.steps[0])).toContain(
           'A non-string value has been captured for the commit message...',
         );
       });
@@ -106,7 +106,7 @@ describe('checkCommitMessages', () => {
         const result = await exec({}, action);
 
         expect(result.steps[0].error).toBe(true);
-        expect(consoleLogSpy).toHaveBeenCalledWith(
+        expect(JSON.stringify(result.steps[0])).toContain(
           'Commit message is blocked via configured literals/patterns...',
         );
       });
@@ -241,8 +241,8 @@ describe('checkCommitMessages', () => {
         const result = await exec({}, action);
 
         expect(result.steps[0].error).toBe(false);
-        expect(consoleLogSpy).toHaveBeenCalledWith(
-          expect.stringContaining('The following commit messages are legal:'),
+        expect(JSON.stringify(result.steps[0])).toContain(
+          'The following commit messages are legal:',
         );
       });