Refactor dry-run to else block; update in-memory issue state for accurate preview

Author: taarikashenafi

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

@@ -71,58 +71,61 @@ export default async function () {
       if (dryRun) {
         if (isResolvedFiling(filing)) {
           dryRunCounts.close++
+          filing.issue.state = 'closed'
           core.info(`[dry run] Would CLOSE issue: ${filing.issue.url}`)
         } else if (isNewFiling(filing)) {
           dryRunCounts.open++
+          ;(filing as Filing).issue = {state: 'open'} as Issue
           core.info(
             `[dry run] Would OPEN a new issue for: ${filing.findings[0].problemShort} (${filing.findings[0].url})`,
           )
         } else if (isRepeatedFiling(filing)) {
           dryRunCounts.reopen++
+          filing.issue.state = 'reopened'
           core.info(`[dry run] Would REOPEN issue: ${filing.issue.url}`)
         }
-        continue
-      }
-      if (isResolvedFiling(filing)) {
-        // Close the filing’s issue (if necessary)
-        response = await closeIssue(octokit, new Issue(filing.issue))
-        filing.issue.state = 'closed'
-      } else if (isNewFiling(filing)) {
-        // Open a new issue for the filing
-        response = await openIssue(octokit, repoWithOwner, filing.findings[0], screenshotRepo)
-        ;(filing as Filing).issue = {state: 'open'} as Issue
+      } else {
+        if (isResolvedFiling(filing)) {
+          // Close the filing's issue (if necessary)
+          response = await closeIssue(octokit, new Issue(filing.issue))
+          filing.issue.state = 'closed'
+        } else if (isNewFiling(filing)) {
+          // Open a new issue for the filing
+          response = await openIssue(octokit, repoWithOwner, filing.findings[0], screenshotRepo)
+          ;(filing as Filing).issue = {state: 'open'} as Issue
 
-        // Track for grouping
-        if (shouldOpenGroupedIssues) {
-          const problemShort: string = filing.findings[0].problemShort
-          if (!newIssuesByProblemShort[problemShort]) {
-            newIssuesByProblemShort[problemShort] = []
+          // Track for grouping
+          if (shouldOpenGroupedIssues) {
+            const problemShort: string = filing.findings[0].problemShort
+            if (!newIssuesByProblemShort[problemShort]) {
+              newIssuesByProblemShort[problemShort] = []
+            }
+            newIssuesByProblemShort[problemShort].push({
+              url: response.data.html_url,
+              id: response.data.number,
+            })
           }
-          newIssuesByProblemShort[problemShort].push({
-            url: response.data.html_url,
-            id: response.data.number,
-          })
+        } else if (isRepeatedFiling(filing)) {
+          // Reopen the filing's issue (if necessary) and update the body with the latest finding
+          response = await reopenIssue(
+            octokit,
+            new Issue(filing.issue),
+            filing.findings[0],
+            repoWithOwner,
+            screenshotRepo,
+          )
+          filing.issue.state = 'reopened'
+        }
+        if (response?.data && filing.issue) {
+          // Update the filing with the latest issue data
+          filing.issue.id = response.data.id
+          filing.issue.nodeId = response.data.node_id
+          filing.issue.url = response.data.html_url
+          filing.issue.title = response.data.title
+          core.info(
+            `Set issue ${response.data.title} (${repoWithOwner}#${response.data.number}) state to ${filing.issue.state}`,
+          )
         }
-      } else if (isRepeatedFiling(filing)) {
-        // Reopen the filing's issue (if necessary) and update the body with the latest finding
-        response = await reopenIssue(
-          octokit,
-          new Issue(filing.issue),
-          filing.findings[0],
-          repoWithOwner,
-          screenshotRepo,
-        )
-        filing.issue.state = 'reopened'
-      }
-      if (response?.data && filing.issue) {
-        // Update the filing with the latest issue data
-        filing.issue.id = response.data.id
-        filing.issue.nodeId = response.data.node_id
-        filing.issue.url = response.data.html_url
-        filing.issue.title = response.data.title
-        core.info(
-          `Set issue ${response.data.title} (${repoWithOwner}#${response.data.number}) state to ${filing.issue.state}`,
-        )
       }
     } catch (error) {
       core.setFailed(`Failed on filing: ${JSON.stringify(filing, null, 2)}\n${error}`)

.github/actions/file/tests/dryRun.test.ts

@@ -145,6 +145,38 @@ describe('file action — dry_run', () => {
     expect(outputs.filings_file).toBeDefined()
   })
 
+  it('updates in-memory issue state for an accurate preview without mutating remotely', async () => {
+    setup()
+    inputs.dry_run = 'true'
+
+    await runFileAction()
+
+    // The path written is `${RUNNER_TEMP||'/tmp'}/filings-<uuid>.json`; grab it from the output.
+    const writtenPath = outputs.filings_file
+    const writtenFilings = JSON.parse(files[writtenPath])
+
+    // Resolved cached filing (issues/2) -> would be CLOSED
+    const resolved = writtenFilings.find(
+      (f: {issue?: {url?: string}}) => f.issue?.url === 'https://github.com/org/repo/issues/2',
+    )
+    expect(resolved?.issue.state).toBe('closed')
+
+    // Repeated cached filing (issues/1) -> would be REOPENED
+    const repeated = writtenFilings.find(
+      (f: {issue?: {url?: string}}) => f.issue?.url === 'https://github.com/org/repo/issues/1',
+    )
+    expect(repeated?.issue.state).toBe('reopened')
+
+    // New filing -> issue object created with state 'open'
+    const opened = writtenFilings.find((f: {issue?: {state?: string}}) => f.issue?.state === 'open')
+    expect(opened).toBeDefined()
+
+    // And confirm we still didn't actually mutate anything remotely
+    expect(openIssue).not.toHaveBeenCalled()
+    expect(reopenIssue).not.toHaveBeenCalled()
+    expect(closeIssue).not.toHaveBeenCalled()
+  })
+
   it('does call the mutating helpers when dry_run is false (regression guard)', async () => {
     setup()
     inputs.dry_run = 'false'