Removes passing in url, updates cache key

Author: lindseywild

.github/actions/file/src/openIssue.ts

@@ -21,11 +21,12 @@ export async function openIssue(octokit: Octokit, repoWithOwner: string, finding
   const owner = repoWithOwner.split('/')[0]
   const repo = repoWithOwner.split('/')[1]
 
+  const labels = [`${finding.scannerType}-scanning-issue`]
   // Only include a ruleId label when it's defined
-  const labels = [
-    `${finding.scannerType}-scanning-issue`,
-    ...(finding.ruleId ? [`${finding.scannerType} rule: ${finding.ruleId}`] : []),
-  ]
+  if (finding.ruleId) {
+    labels.push(`${finding.scannerType} rule: ${finding.ruleId}`)
+  }
+
   const title = truncateWithEllipsis(
     `Accessibility issue: ${finding.problemShort[0].toUpperCase() + finding.problemShort.slice(1)} on ${new URL(finding.url).pathname}`,
     GITHUB_ISSUE_TITLE_MAX_LENGTH,

.github/actions/file/src/updateFilingsWithNewFindings.ts

@@ -5,6 +5,9 @@ function getFilingKey(filing: ResolvedFiling | RepeatedFiling): string {
 }
 
 function getFindingKey(finding: Finding): string {
+  if (finding.ruleId && finding.html) {
+    return `${finding.url};${finding.ruleId};${finding.html}`
+  }
   return `${finding.url};${finding.scannerType};${finding.problemUrl}`
 }
 

.github/actions/find/src/findForUrl.ts

@@ -48,7 +48,6 @@ export async function findForUrl(
             plugin,
             page,
             addFinding,
-            url,
           })
         } else {
           core.info(`Skipping plugin ${plugin.name} because it is not included in the 'scans' input`)

.github/actions/find/src/pluginManager.ts

@@ -13,7 +13,6 @@ const __dirname = path.dirname(__filename)
 type PluginDefaultParams = {
   page: playwright.Page
   addFinding: (findingData: Finding) => Promise<void>
-  url: string
 }
 
 type Plugin = {
@@ -109,6 +108,6 @@ export async function loadPluginsFromPath({pluginsPath}: {pluginsPath: string})
 type InvokePluginParams = PluginDefaultParams & {
   plugin: Plugin
 }
-export function invokePlugin({plugin, page, addFinding, url}: InvokePluginParams) {
-  return plugin.default({page, addFinding, url})
+export function invokePlugin({plugin, page, addFinding}: InvokePluginParams) {
+  return plugin.default({page, addFinding})
 }

.github/scanner-plugins/reflow-scan/index.js

@@ -1,5 +1,6 @@
-export default async function reflowScan({page, addFinding, url} = {}) {
+export default async function reflowScan({page, addFinding} = {}) {
   const originalViewport = page.viewportSize()
+  const url = page.url()
   // Check for horizontal scrolling at 320x256 viewport
   try {
     await page.setViewportSize({width: 320, height: 256})

PLUGINS.md

@@ -22,10 +22,6 @@ A async function (you must use `await` or `.then` when invoking this function) t
 
 - An object that should match the [`Finding` type](https://github.com/github/accessibility-scanner/blob/main/.github/actions/find/src/types.d.ts#L1-L9).
 
-#### `url`
-
-Passes in the URL of the page being scanned to be used when a finding is added.
-
 ## How to create plugins
 
 As mentioned above, plugins need to exist under `./.github/scanner-plugins`. For a plugin to work, it needs to meet the following criteria: