feat: Avoid creating duplicate issues

Author: smockle

.github/actions/file/README.md

@@ -22,8 +22,28 @@ Files GitHub issues to track potential accessibility gaps.
 
 **Required** Token with fine-grained permission 'issues: write'.
 
+#### `cached_findings`
+
+**Optional** Cached findings from previous runs, as stringified JSON. Without this, duplicate issues may be filed. For example: `'[]'`.
+
 ### Outputs
 
-#### `issue_numbers`
+#### `findings`
+
+List of potential accessibility gaps (plus issue URLs), as stringified JSON. For example:
+
+```JS
+'[]'
+```
+
+#### `closed_issue_urls`
+
+List of URLs for closed issues, as stringified JSON. For example: `'[123, 124, 126, 127]'`.
+
+#### `opened_issue_urls`
+
+List of URLs for newly-opened issues, as stringified JSON. For example: `'[123, 124, 126, 127]'`.
+
+#### `repeated_issue_urls`
 
-List of issue numbers for created issues, as stringified JSON. For example: `'[123, 124, 126, 127]'`.
+List of URLs for repeated issues, as stringified JSON. For example: `'[123, 124, 126, 127]'`.

.github/actions/file/action.yml

@@ -11,10 +11,19 @@ inputs:
   token:
     description: "Token with fine-grained permission 'issues: write'"
     required: true
+  cached_findings:
+    description: "Cached findings from previous runs, as stringified JSON. Without this, duplicate issues may be filed."
+    required: false
 
 outputs:
-  issue_numbers:
-    description: "List of issue numbers for created issues, as stringified JSON"
+  findings:
+    description: "List of potential accessibility gaps (plus issue URLs), as stringified JSON"
+  closed_issue_urls:
+    description: "List of URLs for closed issues, as stringified JSON"
+  opened_issue_urls:
+    description: "List of URLs for newly-opened issues, as stringified JSON"
+  repeated_issue_urls:
+    description: "List of URLs for repeated issues, as stringified JSON"
 
 runs:
   using: "node20"

.github/actions/file/src/closeIssueForFinding.ts

@@ -0,0 +1,17 @@
+import type { Octokit } from '@octokit/core';
+import type { Finding } from './types.d.js';
+
+export async function closeIssueForFinding(octokit: Octokit, repoWithOwner: string, finding: Finding) {
+  const owner = repoWithOwner.split('/')[0];
+  const repo = repoWithOwner.split('/')[1];
+  const issueNumber = finding.issueUrl?.split('/').pop();
+  if (!issueNumber) {
+    throw new Error(`Invalid issue URL: ${finding.issueUrl}`);
+  }
+  return await octokit.request(`PATCH /repos/${owner}/${repo}/issues/${issueNumber}`, {
+    owner,
+    repo,
+    issue_number: issueNumber,
+    state: 'closed'
+  });
+}

.github/actions/file/src/fileIssueForFinding.ts

@@ -1,20 +1,51 @@
 import type { Finding } from "./types.d.js";
 import core from "@actions/core";
 import { Octokit } from '@octokit/core';
-import { fileIssueForFinding } from "./fileIssueForFinding.js";
+import { toFindingsMap } from "./toFindingsMap.js"
+import { closeIssueForFinding } from "./closeIssueForFinding.js";
+import { openIssueForFinding } from "./openIssueForFinding.js";
 
 export default async function () {
   const findings: Finding[] = JSON.parse(core.getInput('findings', { required: true }));
   const repoWithOwner = core.getInput('repository', { required: true });
   const token = core.getInput('token', { required: true });
+  const cachedFindings: Finding[] = JSON.parse(core.getInput('cached_findings', { required: false }) || "[]");
+
+  const findingsMap = toFindingsMap(findings);
+  const cachedFindingsMap = toFindingsMap(cachedFindings);
 
-  const issueNumbers = [];
   const octokit = new Octokit({ auth: token });
+
+  const closedIssueUrls = [];
+  for (const cachedFinding of cachedFindings) {
+    if (!findingsMap.has(`${cachedFinding.url};${cachedFinding.problemShort};${cachedFinding.html}`)) {
+      // Finding was not found in the latest run, so close its issue (if necessary)
+      const response = await closeIssueForFinding(octokit, repoWithOwner, cachedFinding);
+      closedIssueUrls.push(response.data.html_url);
+      console.log(`Closed issue: ${response.data.title} (${repoWithOwner}#${response.data.number})`);
+    }
+  }
+
+  const openedIssueUrls = [];
+  const repeatIssueUrls = [];
   for (const finding of findings) {
-    const response = await fileIssueForFinding(octokit, repoWithOwner, finding);
-    issueNumbers.push(response.data.number);
-    console.log(`Created issue: ${response.data.title} (${repoWithOwner}#${response.data.number})`);
+    const cachedIssueUrl = cachedFindingsMap.get(`${finding.url};${finding.problemShort};${finding.html}`)?.issueUrl
+    finding.issueUrl = cachedIssueUrl;
+    const response = await openIssueForFinding(octokit, repoWithOwner, finding);
+    finding.issueUrl = response.data.html_url;
+    if (response.data.html_url === cachedIssueUrl) {
+      // Finding was found in previous and latest runs, so reopen its issue (if necessary)
+      repeatIssueUrls.push(response.data.html_url);
+      console.log(`Repeated issue: ${response.data.title} (${repoWithOwner}#${response.data.number})`);
+    } else {
+      // New finding was found in the latest run, so create its issue
+      openedIssueUrls.push(response.data.html_url);
+      console.log(`Created issue: ${response.data.title} (${repoWithOwner}#${response.data.number})`);
+    }
   }
 
-  core.setOutput("issue_numbers", JSON.stringify(issueNumbers));
-}
+  core.setOutput("closed_issue_urls", JSON.stringify(closedIssueUrls));
+  core.setOutput("opened_issue_urls", JSON.stringify(openedIssueUrls));
+  core.setOutput("repeated_issue_urls", JSON.stringify(repeatIssueUrls));
+  core.setOutput("findings", JSON.stringify(findings));
+}

.github/actions/file/src/index.ts

@@ -0,0 +1,45 @@
+import type { Octokit } from '@octokit/core';
+import type { Finding } from './types.d.js';
+import * as url from 'node:url'
+const URL = url.URL;
+
+export async function openIssueForFinding(octokit: Octokit, repoWithOwner: string, finding: Finding) {
+  const owner = repoWithOwner.split('/')[0];
+  const repo = repoWithOwner.split('/')[1];
+  const issueNumber = finding.issueUrl?.split('/').pop();
+  if (issueNumber) {
+    // If an issue already exists, ensure it is open
+    return await octokit.request(`PATCH /repos/${owner}/${repo}/issues/${issueNumber}`, {
+      owner,
+      repo,
+      issue_number: issueNumber,
+      state: 'open'
+    });
+  } else {
+    // Otherwise, create a new issue
+    const title = `Accessibility issue: ${finding.problemShort[0].toUpperCase() + finding.problemShort.slice(1)} on ${new URL(finding.url).pathname}`;
+    const solutionLong = finding.solutionLong
+      ?.split("\n")
+      .map((line) =>
+        !line.trim().startsWith("Fix any") &&
+        !line.trim().startsWith("Fix all") &&
+        line.trim() !== ""
+          ? `- ${line}`
+          : line
+      )
+      .join("\n");
+    const body = `
+An accessibility scan flagged the element \`${finding.html}\` on ${finding.url} because ${finding.problemShort}. Learn more about why this was flagged by visiting ${finding.problemUrl}.
+
+To fix this, ${finding.solutionShort}.
+${solutionLong ? `\nSpecifically:\n\n${solutionLong}` : ''}
+`;
+
+    return await octokit.request(`POST /repos/${owner}/${repo}/issues`, {
+      owner,
+      repo,
+      title,
+      body
+    });
+  }
+}

.github/actions/file/src/openIssueForFinding.ts

@@ -0,0 +1,10 @@
+import type {Finding} from "./types.d.js";
+
+export function toFindingsMap(findings: Finding[]): Map<string, Finding> {
+  const map = new Map<string, Finding>();
+  for (const finding of findings) {
+    const key = `${finding.url};${finding.problemShort};${finding.html}`;
+    map.set(key, finding);
+  }
+  return map;
+}

.github/actions/file/src/toFindingsMap.ts

@@ -5,4 +5,5 @@ export type Finding = {
   problemUrl: string;
   solutionShort: string;
   solutionLong?: string;
+  issueUrl?: string;
 }

.github/actions/file/src/types.d.ts

@@ -21,7 +21,7 @@ https://primer.style/octicons/
 
 #### `token`
 
-**Required** Personal access token (PAT) with fine-grained permissions 'issues: write' and 'pull_requests: write'.
+**Required** Personal access token (PAT) with fine-grained permissions 'contents: write', 'issues: write', and 'pull_requests: write'.
 
 ### Example workflow
 

README.md

@@ -10,12 +10,18 @@ inputs:
     description: "Repository (with owner) to file issues in"
     required: true
   token:
-    description: "Personal access token (PAT) with fine-grained permissions 'issues: write' and 'pull_requests: write'"
+    description: "Personal access token (PAT) with fine-grained permissions 'contents: write', 'issues: write', and 'pull_requests: write'"
     required: true
 
 runs:
   using: "composite"
   steps:
+    - name: Restore cached_findings
+      id: restore
+      uses: github/continuous-accessibility-scanner/.github/actions/gh-cache/cache@main
+      with:
+        key: cached_findings-${{ github.ref_name }}
+        token: ${{ inputs.token }}
     - name: Find
       id: find
       uses: github/continuous-accessibility-scanner/.github/actions/find@main
@@ -28,13 +34,20 @@ runs:
         findings: ${{ steps.find.outputs.findings }}
         repository: ${{ inputs.repository }}
         token: ${{ inputs.token }}
+        cached_findings: ${{ steps.restore.outputs.value }}
     - name: Fix
       id: fix
       uses: github/continuous-accessibility-scanner/.github/actions/fix@main
       with:
         issue_numbers: ${{ steps.file.outputs.issue_numbers }}
         repository: ${{ inputs.repository }}
         token: ${{ inputs.token }}
+    - name: Save cached_findings
+      uses: github/continuous-accessibility-scanner/.github/actions/gh-cache/cache@main
+      with:
+        key: cached_findings-${{ github.ref_name }}
+        value: ${{ steps.file.outputs.findings }}
+        token: ${{ inputs.token }}
 
 branding:
   icon: "compass"