[feat] Add error handling and rename url map type

Author: DefCon-007

dist/index.js

@@ -34261,34 +34261,49 @@ async function createOrUpdateComment(pullRequestNumber, commentBody) {
     }
 }
 exports.createOrUpdateComment = createOrUpdateComment;
-async function generatePRComment(testResultUrlsMap) {
+async function generatePRComment(testRunUrlsMap) {
     /**
-     * This function generates the body of the action comment.
-     *
-     * @param {any} testResults - The test results
-     *
-     * @returns {string} - The body of the action comment
+     * This function posts/updates a comment containing the test run URLs if a pull request is present.
      *
+     * @param {TestRunUrlsMap} testResults - Map of test run URLs where the key is the script path
+     *  and the value is the test run URL
      *
      * */
+    if (Object.keys(testRunUrlsMap).length === 0) {
+        core.debug('No test result URLs found, skipping comment creation');
+        return;
+    }
     core.debug('Generating PR comment');
     let testRunUrls = '';
-    for (const [scriptPath, testRunUrl] of Object.entries(testResultUrlsMap)) {
+    for (const [scriptPath, testRunUrl] of Object.entries(testRunUrlsMap)) {
         testRunUrls += `🔗 [${scriptPath}](${testRunUrl})\n`;
     }
     let comment = `# Performance Test Results 🚀
 
-  Click on the links below to view the test results on Grafana Cloud K6:
+  Select a test run from below to view the test progress and results on Grafana Cloud K6:
 
   ${testRunUrls}
   `;
-    const pullRequestNumber = await getPullRequestNumber();
+    let pullRequestNumber;
+    try {
+        pullRequestNumber = await getPullRequestNumber();
+    }
+    catch (error) {
+        core.error(`Error getting pull request number`);
+        core.error(error);
+    }
     if (!pullRequestNumber) {
         core.debug('Pull request number not found skipping comment creation');
         return;
     }
-    await createOrUpdateComment(pullRequestNumber, comment);
-    core.debug('Comment created successfully');
+    try {
+        await createOrUpdateComment(pullRequestNumber, comment);
+        core.debug('Comment created successfully');
+    }
+    catch (error) {
+        core.error(`Error creating comment on pull request: ${pullRequestNumber}`);
+        core.error(error);
+    }
 }
 exports.generatePRComment = generatePRComment;
 
@@ -34349,8 +34364,6 @@ async function run() {
             set: (target, key, value) => {
                 target[key] = value;
                 if (Object.keys(target).length === TOTAL_TEST_RUNS) {
-                    core.debug('📊 URLs for all the tests gathered');
-                    core.debug(`📊 Test URLs: ${target}`);
                     if (isCloud) {
                         // Generate PR comment with test run URLs
                         (0, githubHelper_1.generatePRComment)(target);
@@ -34533,14 +34546,14 @@ const REGEX_EXPRESSIONS = {
     REGEX_EXPRESSIONS.executionProgress,
     REGEX_EXPRESSIONS.cloudRunExecution
 ];
-function extractTestRunUrl(data, testResultUrlsMap) {
+function extractTestRunUrl(data, testRunUrlsMap) {
     /**
      * This function extracts the script path and output URL from the k6 output.
-     * It then adds the script path and output URL to the testResultUrlsMap which is a reference to
+     * It then adds the script path and output URL to the testRunUrlsMap which is a reference to
      * an object passed from the main function to store test run urls mapped to corresponding test script.
      *
      * @param {string} data - The k6 command output data as string
-     * @param {TestResultUrlsMap} testResultUrlsMap - The map containing the script path and output URL
+     * @param {TestRunUrlsMap} testRunUrlsMap - The map containing the script path and output URL
      *
      * @returns {boolean} - Returns true if the script path and output URL were successfully extracted and added to the map. Otherwise, returns false.
      *
@@ -34554,7 +34567,7 @@ function extractTestRunUrl(data, testResultUrlsMap) {
     const outputCloudUrlMatch = output ? output.match(REGEX_EXPRESSIONS.outputCloudUrl) : null;
     const outputCloudUrl = outputCloudUrlMatch ? outputCloudUrlMatch[1] : output;
     if (scriptPath && output) {
-        testResultUrlsMap[scriptPath] = outputCloudUrl || '';
+        testRunUrlsMap[scriptPath] = outputCloudUrl || '';
         return true;
     }
     else {
@@ -34609,22 +34622,22 @@ function checkIfK6ASCIIArt(data) {
         return true;
     }
 }
-function parseK6Output(data, testResultUrlsMap, totalTestRuns) {
+function parseK6Output(data, testRunUrlsMap, totalTestRuns) {
     /*
     * This function is responsible for parsing the output of the k6 command.
     * It filters out the progress lines and logs the rest of the output.
     * It also extracts the test run URLs from the output.
     *
     * @param {Buffer} data - The k6 command output data
-    * @param {TestResultUrlsMap | null} testResultUrlsMap - The map containing the script path and output URL. If null, the function will not extract test run URLs.
+    * @param {TestRunUrlsMap | null} testRunUrlsMap - The map containing the script path and output URL. If null, the function will not extract test run URLs.
     * @param {number} totalTestRuns - The total number of test runs. This is used to determine when all test run URLs have been extracted.
     *
     * @returns {void}
     */
     const dataString = data.toString(), lines = dataString.split('\n');
     // Extract test run URLs
-    if (testResultUrlsMap && Object.keys(testResultUrlsMap).length < totalTestRuns) {
-        if (extractTestRunUrl(dataString, testResultUrlsMap)) {
+    if (testRunUrlsMap && Object.keys(testRunUrlsMap).length < totalTestRuns) {
+        if (extractTestRunUrl(dataString, testRunUrlsMap)) {
             // Test URL was extracted successfully and added to the map. 
             // Ignore further output parsing for this data.
             return;

src/githubHelper.ts

@@ -1,5 +1,6 @@
 import * as core from '@actions/core';
 import * as github from '@actions/github';
+import { TestRunUrlsMap } from './types';
 
 const { context } = github;
 const { eventName, payload } = context;
@@ -112,39 +113,53 @@ export async function createOrUpdateComment(pullRequestNumber: number, commentBo
   }
 }
 
-export async function generatePRComment(testResultUrlsMap: any) {
+export async function generatePRComment(testRunUrlsMap: TestRunUrlsMap): Promise<void> {
   /**
-   * This function generates the body of the action comment.
+   * This function posts/updates a comment containing the test run URLs if a pull request is present.
    *
-   * @param {any} testResults - The test results
-   * 
-   * @returns {string} - The body of the action comment
-   *  
+   * @param {TestRunUrlsMap} testResults - Map of test run URLs where the key is the script path 
+   *  and the value is the test run URL 
    * 
    * */
 
+  if (Object.keys(testRunUrlsMap).length === 0) {
+    core.debug('No test result URLs found, skipping comment creation');
+    return;
+  }
+
   core.debug('Generating PR comment')
 
   let testRunUrls = '';
-  for (const [scriptPath, testRunUrl] of Object.entries(testResultUrlsMap)) {
+  for (const [scriptPath, testRunUrl] of Object.entries(testRunUrlsMap)) {
     testRunUrls += `🔗 [${scriptPath}](${testRunUrl})\n`;
   }
 
   let comment = `# Performance Test Results 🚀
   
-  Click on the links below to view the test results on Grafana Cloud K6:
+  Select a test run from below to view the test progress and results on Grafana Cloud K6:
 
   ${testRunUrls}
   `;
 
-  const pullRequestNumber = await getPullRequestNumber();
+  let pullRequestNumber;
+
+  try {
+    pullRequestNumber = await getPullRequestNumber();
+  } catch (error: any) {
+    core.error(`Error getting pull request number`);
+    core.error(error);
+  }
 
   if (!pullRequestNumber) {
     core.debug('Pull request number not found skipping comment creation');
     return;
   }
 
-  await createOrUpdateComment(pullRequestNumber, comment);
-
-  core.debug('Comment created successfully');
+  try {
+    await createOrUpdateComment(pullRequestNumber, comment);
+    core.debug('Comment created successfully');
+  } catch (error: any) {
+    core.error(`Error creating comment on pull request: ${pullRequestNumber}`);
+    core.error(error);
+  }
 }

src/index.ts

@@ -4,6 +4,7 @@ import { spawn } from 'child_process';
 import * as fs from 'fs-extra';
 import { generatePRComment } from './githubHelper';
 import { parseK6Output } from './k6OutputParser';
+import { TestRunUrlsMap } from './types';
 
 const TEST_PIDS: number[] = [];
 
@@ -26,12 +27,9 @@ export async function run(): Promise<void> {
         const commands = testPaths.map(testPath => generateCommand(testPath)),
             TOTAL_TEST_RUNS = commands.length,
             TEST_RESULT_URLS_MAP = new Proxy({}, {
-                set: (target: { [key: string]: string }, key: string, value: string) => {
+                set: (target: TestRunUrlsMap, key: string, value: string) => {
                     target[key] = value;
                     if (Object.keys(target).length === TOTAL_TEST_RUNS) {
-                        core.debug('📊 URLs for all the tests gathered');
-                        core.debug(`📊 Test URLs: ${target}`);
-
                         if (isCloud) {
                             // Generate PR comment with test run URLs
                             generatePRComment(target);

src/k6OutputParser.ts

@@ -1,4 +1,4 @@
-import { TestResultUrlsMap } from './types';
+import { TestRunUrlsMap } from './types';
 
 const REGEX_EXPRESSIONS = {
     scriptPath: /^\s*script:\s*(.+)$/m,
@@ -23,14 +23,14 @@ const REGEX_EXPRESSIONS = {
     ];
 
 
-function extractTestRunUrl(data: string, testResultUrlsMap: TestResultUrlsMap): boolean {
+function extractTestRunUrl(data: string, testRunUrlsMap: TestRunUrlsMap): boolean {
     /**
      * This function extracts the script path and output URL from the k6 output.
-     * It then adds the script path and output URL to the testResultUrlsMap which is a reference to 
+     * It then adds the script path and output URL to the testRunUrlsMap which is a reference to 
      * an object passed from the main function to store test run urls mapped to corresponding test script.
      * 
      * @param {string} data - The k6 command output data as string
-     * @param {TestResultUrlsMap} testResultUrlsMap - The map containing the script path and output URL
+     * @param {TestRunUrlsMap} testRunUrlsMap - The map containing the script path and output URL
      * 
      * @returns {boolean} - Returns true if the script path and output URL were successfully extracted and added to the map. Otherwise, returns false.
      * 
@@ -47,7 +47,7 @@ function extractTestRunUrl(data: string, testResultUrlsMap: TestResultUrlsMap):
     const outputCloudUrl = outputCloudUrlMatch ? outputCloudUrlMatch[1] : output;
 
     if (scriptPath && output) {
-        testResultUrlsMap[scriptPath] = outputCloudUrl || '';
+        testRunUrlsMap[scriptPath] = outputCloudUrl || '';
         return true;
     } else {
         return false;
@@ -110,14 +110,14 @@ function checkIfK6ASCIIArt(data: string): boolean {
     }
 }
 
-export function parseK6Output(data: Buffer, testResultUrlsMap: TestResultUrlsMap | null, totalTestRuns: number): void {
+export function parseK6Output(data: Buffer, testRunUrlsMap: TestRunUrlsMap | null, totalTestRuns: number): void {
     /*
     * This function is responsible for parsing the output of the k6 command. 
     * It filters out the progress lines and logs the rest of the output.
     * It also extracts the test run URLs from the output.
     * 
     * @param {Buffer} data - The k6 command output data
-    * @param {TestResultUrlsMap | null} testResultUrlsMap - The map containing the script path and output URL. If null, the function will not extract test run URLs.
+    * @param {TestRunUrlsMap | null} testRunUrlsMap - The map containing the script path and output URL. If null, the function will not extract test run URLs.
     * @param {number} totalTestRuns - The total number of test runs. This is used to determine when all test run URLs have been extracted.
     * 
     * @returns {void}
@@ -127,8 +127,8 @@ export function parseK6Output(data: Buffer, testResultUrlsMap: TestResultUrlsMap
         lines = dataString.split('\n');
 
     // Extract test run URLs
-    if (testResultUrlsMap && Object.keys(testResultUrlsMap).length < totalTestRuns) {
-        if (extractTestRunUrl(dataString, testResultUrlsMap)) {
+    if (testRunUrlsMap && Object.keys(testRunUrlsMap).length < totalTestRuns) {
+        if (extractTestRunUrl(dataString, testRunUrlsMap)) {
             // Test URL was extracted successfully and added to the map. 
             // Ignore further output parsing for this data.
             return;

src/types.ts

@@ -1,3 +1,3 @@
-export type TestResultUrlsMap = {
+export type TestRunUrlsMap = {
     [key: string]: string;
 };