fix: Remove duplicated job from check-run (#20)

Author: cbeauchesne

.vscode/launch.json

@@ -10,9 +10,9 @@
       "runtimeExecutable": "node",
       "env": {
         "GITHUB_JOB": "build-and-test",
-        "GITHUB_RUN_ID": "14889189674",
+        "GITHUB_RUN_ID": "14931757054",
         "GITHUB_EVENT_PATH": "${workspaceFolder}/.vscode/mock-event.json",
-        "GITHUB_REPOSITORY": "DataDog/ensure-ci-success",
+        "GITHUB_REPOSITORY": "DataDog/system-tests",
         "GITHUB_EVENT_NAME": "pull_request",
         "GITHUB_REF": "refs/pull/123/merge",
         "INPUT-INITIAL-DELAY-SECONDS": "1",

.vscode/mock-event.json

@@ -1,7 +1,7 @@
 {
   "pull_request": {
     "head": {
-      "sha": "b2801e7303a63bf353431b91960eef449d4c5c62"
+      "sha": "06b38da42a718808cc59f75a086c89e931a088ad"
     }
   }
 }

dist/index.js

@@ -116359,34 +116359,51 @@ class CheckReport {
             ref: this.sha,
             per_page: 100,
         });
-        const checkRuns = [];
+        const checkRuns = {};
         for (const suite of checkSuites) {
             if (suite.latest_check_runs_count === 0) {
                 coreExports.debug(`Check suite ${suite.id} has no check runs (${suite.url}`);
             }
-            else if (suite.conclusion !== null &&
-                ['success', 'neutral', 'skipped'].includes(suite.conclusion)) {
-                coreExports.info(`Check suite ${suite.id} conclusion is ${suite.conclusion} (${suite.latest_check_runs_count} runs) (${suite.url})`);
-            }
             else {
-                coreExports.info(`Get ${suite.latest_check_runs_count} runs for check suite ${suite.url}`);
+                // we cannot skip any suite, because rerun may have been triggered
+                coreExports.info(`Get ${suite.latest_check_runs_count} runs for check suite ${suite.url} (conclusion: ${suite.conclusion})`);
                 const subCheckRuns = await octokit.paginate(octokit.rest.checks.listForSuite, {
                     owner: this.owner,
                     repo: this.repo,
                     check_suite_id: suite.id,
                     per_page: 100,
                 });
-                checkRuns.push(...subCheckRuns);
+                subCheckRuns.forEach(checkRun => {
+                    // dark corners of github API: there is no way to get "last check run" for a ref
+                    // so we filter out them by app.id/names
+                    if (checkRun.name.includes('${{')) {
+                        // dark dark corners of github API: names can be not fully interpreted
+                        // ignoring them
+                        coreExports.debug(`Skipping GitHub Actions check run ${checkRun.html_url}`);
+                        return;
+                    }
+                    const key = `${checkRun.app?.id}#${checkRun.name}`;
+                    if (key in checkRuns) {
+                        coreExports.debug(`Duplicate check run ${checkRun.html_url}`);
+                        if (checkRun.id > checkRuns[key].id) {
+                            // pick the last one
+                            checkRuns[key] = checkRun;
+                        }
+                    }
+                    else {
+                        checkRuns[key] = checkRun;
+                    }
+                });
             }
         }
-        coreExports.info(`Found ${checkRuns.length} check runs`);
+        coreExports.info(`Found ${Object.keys(checkRuns).length} check runs`);
         const statuses = await getAllCombinedStatuses(octokit, {
             owner: this.owner,
             repo: this.repo,
             ref: this.sha,
         });
         coreExports.info(`Found ${statuses.length} commit statuses`);
-        for (const check of checkRuns) {
+        for (const check of Object.values(checkRuns)) {
             this.items.push(SummaryRow.fromCheck(check, this.ignoredNameRegexps, this.currentJobName));
         }
         for (const status of statuses) {

dist/index.js.map

@@ -85,31 +85,49 @@ export class CheckReport {
       per_page: 100,
     });
 
-    const checkRuns: CheckRunType[] = [];
+    const checkRuns: Record<string, CheckRunType> = {};
 
     for (const suite of checkSuites) {
       if (suite.latest_check_runs_count === 0) {
         core.debug(`Check suite ${suite.id} has no check runs (${suite.url}`);
-      } else if (
-        suite.conclusion !== null &&
-        ['success', 'neutral', 'skipped'].includes(suite.conclusion)
-      ) {
+      } else {
+        // we cannot skip any suite, because rerun may have been triggered
         core.info(
-          `Check suite ${suite.id} conclusion is ${suite.conclusion} (${suite.latest_check_runs_count} runs) (${suite.url})`
+          `Get ${suite.latest_check_runs_count} runs for check suite ${suite.url} (conclusion: ${suite.conclusion})`
         );
-      } else {
-        core.info(`Get ${suite.latest_check_runs_count} runs for check suite ${suite.url}`);
         const subCheckRuns = await octokit.paginate(octokit.rest.checks.listForSuite, {
           owner: this.owner,
           repo: this.repo,
           check_suite_id: suite.id,
           per_page: 100,
         });
-        checkRuns.push(...subCheckRuns);
+        subCheckRuns.forEach(checkRun => {
+          // dark corners of github API: there is no way to get "last check run" for a ref
+          // so we filter out them by app.id/names
+
+          if (checkRun.name.includes('${{')) {
+            // dark dark corners of github API: names can be not fully interpreted
+            // ignoring them
+            core.debug(`Skipping GitHub Actions check run ${checkRun.html_url}`);
+            return;
+          }
+
+          const key = `${checkRun.app?.id}#${checkRun.name}`;
+
+          if (key in checkRuns) {
+            core.debug(`Duplicate check run ${checkRun.html_url}`);
+            if (checkRun.id > checkRuns[key].id) {
+              // pick the last one
+              checkRuns[key] = checkRun;
+            }
+          } else {
+            checkRuns[key] = checkRun;
+          }
+        });
       }
     }
 
-    core.info(`Found ${checkRuns.length} check runs`);
+    core.info(`Found ${Object.keys(checkRuns).length} check runs`);
 
     const statuses = await getAllCombinedStatuses(octokit, {
       owner: this.owner,
@@ -118,7 +136,7 @@ export class CheckReport {
     });
     core.info(`Found ${statuses.length} commit statuses`);
 
-    for (const check of checkRuns) {
+    for (const check of Object.values(checkRuns)) {
       this.items.push(SummaryRow.fromCheck(check, this.ignoredNameRegexps, this.currentJobName));
     }