adjust code

- refactor input loading to keep main function scope limited and easier to read
- change url_config to url_configs
- change some ternaries and conditional logic from copilot to be easier to understand

Author: abdulahmad307

.github/actions/find/action.yml

@@ -6,7 +6,7 @@ inputs:
     description: 'Newline-delimited list of URLs to check for accessibility issues'
     required: false
     multiline: true
-  url_config:
+  url_configs:
     description: "Stringified JSON array of URL config objects, each with a 'url' field and an optional 'excludeSelectors' field (array of CSS selectors to exclude from the Axe scan for that URL). When provided, takes precedence over the 'urls' input."
     required: false
   auth_context:

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

@@ -1,4 +1,4 @@
-import type {ColorSchemePreference, Finding, ReducedMotionPreference} from './types.d.js'
+import type {ColorSchemePreference, Finding, ReducedMotionPreference, UrlConfig} from './types.d.js'
 import {AxeBuilder} from '@axe-core/playwright'
 import playwright from 'playwright'
 import {AuthContext} from './AuthContext.js'
@@ -8,13 +8,13 @@ import {getScansContext} from './scansContextProvider.js'
 import * as core from '@actions/core'
 
 export async function findForUrl(
-  url: string,
+  urlConfig: UrlConfig,
   authContext?: AuthContext,
   includeScreenshots: boolean = false,
   reducedMotion?: ReducedMotionPreference,
   colorScheme?: ColorSchemePreference,
-  exclude?: string[],
 ): Promise<Finding[]> {
+  const {url, excludeSelectors} = urlConfig
   const browser = await playwright.chromium.launch({
     headless: true,
     executablePath: process.env.CI ? '/usr/bin/google-chrome' : undefined,
@@ -57,7 +57,7 @@ export async function findForUrl(
     }
 
     if (scansContext.shouldPerformAxeScan) {
-      await runAxeScan({page, addFinding, exclude})
+      await runAxeScan({page, addFinding, excludeSelectors})
     }
   } catch (e) {
     core.error(`Error during accessibility scan: ${e}`)
@@ -70,17 +70,17 @@ export async function findForUrl(
 async function runAxeScan({
   page,
   addFinding,
-  exclude,
+  excludeSelectors,
 }: {
   page: playwright.Page
   addFinding: (findingData: Finding, options?: {includeScreenshots?: boolean}) => Promise<void>
-  exclude?: string[]
+  excludeSelectors?: string[]
 }) {
   const url = page.url()
   core.info(`Scanning ${url}`)
-  const axeBuilder = exclude && exclude.length > 0
-    ? exclude.reduce((builder, selector) => builder.exclude(selector), new AxeBuilder({page}))
-    : new AxeBuilder({page})
+  const axeBuilder = new AxeBuilder({page})
+  excludeSelectors?.forEach(selector => axeBuilder.exclude(selector))
+
   const rawFindings = await axeBuilder.analyze()
 
   if (rawFindings) {

.github/actions/find/src/index.ts

@@ -7,67 +7,22 @@ import {findForUrl} from './findForUrl.js'
 
 export default async function () {
   core.info("Starting 'find' action")
-  const urlConfigInput = core.getInput('url_config', {required: false})
-  let urlConfigs: UrlConfig[] | undefined
-  if (urlConfigInput) {
-    try {
-      const parsed = JSON.parse(urlConfigInput)
-      if (!Array.isArray(parsed)) {
-        throw new Error("Input 'url_config' must be a JSON array.")
-      }
-      for (const item of parsed) {
-        if (typeof item !== 'object' || item === null || typeof item.url !== 'string') {
-          throw new Error("Each entry in 'url_config' must be an object with a 'url' string field.")
-        }
-      }
-      urlConfigs = parsed as UrlConfig[]
-    } catch (e) {
-      throw new Error(`Invalid 'url_config' input: ${(e as Error).message}`)
-    }
-  }
+  let urlConfigs = loadUrlConfigs()
+  let urls = loadUrls({urlConfigs})
+  let reducedMotion = loadReducedMotion()
+  let colorScheme = loadColorScheme()
 
-  let urls: string[]
-  if (urlConfigs) {
-    core.debug(`Input: 'url_config: ${JSON.stringify(urlConfigs)}'`)
-    urls = urlConfigs.map(c => c.url)
-  } else {
-    urls = core.getMultilineInput('urls', {required: false})
-    core.debug(`Input: 'urls: ${JSON.stringify(urls)}'`)
-    if (urls.length === 0) {
-      throw new Error("Either 'urls' or 'url_config' input must be provided.")
-    }
-  }
+  const actualUrls = urlConfigs || urls || []
 
   const authContextInput: AuthContextInput = JSON.parse(core.getInput('auth_context', {required: false}) || '{}')
   const authContext = new AuthContext(authContextInput)
-
   const includeScreenshots = core.getInput('include_screenshots', {required: false}) !== 'false'
-  const reducedMotionInput = core.getInput('reduced_motion', {required: false})
-  let reducedMotion: ReducedMotionPreference | undefined
-  if (reducedMotionInput) {
-    if (!['reduce', 'no-preference', null].includes(reducedMotionInput)) {
-      throw new Error(
-        "Input 'reduced_motion' must be one of: 'reduce', 'no-preference', or null per Playwright documentation.",
-      )
-    }
-    reducedMotion = reducedMotionInput as ReducedMotionPreference
-  }
-  const colorSchemeInput = core.getInput('color_scheme', {required: false})
-  let colorScheme: ColorSchemePreference | undefined
-  if (colorSchemeInput) {
-    if (!['light', 'dark', 'no-preference', null].includes(colorSchemeInput)) {
-      throw new Error(
-        "Input 'color_scheme' must be one of: 'light', 'dark', 'no-preference', or null per Playwright documentation.",
-      )
-    }
-    colorScheme = colorSchemeInput as ColorSchemePreference
-  }
 
   const findings = []
-  for (const url of urls) {
+  for (const urlConfig of actualUrls) {
+    const {url} = urlConfig
     core.info(`Preparing to scan ${url}`)
-    const excludeSelectors = urlConfigs?.find(c => c.url === url)?.excludeSelectors
-    const findingsForUrl = await findForUrl(url, authContext, includeScreenshots, reducedMotion, colorScheme, excludeSelectors)
+    const findingsForUrl = await findForUrl(urlConfig, authContext, includeScreenshots, reducedMotion, colorScheme)
     if (findingsForUrl.length === 0) {
       core.info(`No accessibility gaps were found on ${url}`)
       continue
@@ -84,3 +39,67 @@ export default async function () {
   core.info(`Found ${findings.length} findings in total`)
   core.info("Finished 'find' action")
 }
+
+function loadUrlConfigs() {
+  const urlConfigInput = core.getInput('url_configs', {required: false})
+
+  if (!urlConfigInput) return
+
+  try {
+    const parsed = JSON.parse(urlConfigInput)
+
+    if (!Array.isArray(parsed)) {
+      throw new Error("Input 'url_configs' must be a JSON array.")
+    }
+
+    for (const item of parsed) {
+      if (typeof item !== 'object' || item === null || typeof item.url !== 'string') {
+        throw new Error("Each entry in 'url_configs' must be an object with a 'url' string field.")
+      }
+    }
+
+    return parsed as UrlConfig[]
+  } catch (e) {
+    throw new Error(`Invalid 'url_configs' input: ${(e as Error).message}`)
+  }
+}
+
+function loadUrls({urlConfigs}: {urlConfigs?: UrlConfig[]} = {}) {
+  // - no need to process this input if url_configs is provided
+  if (urlConfigs) return
+
+  let urls: string[]
+  urls = core.getMultilineInput('urls', {required: false})
+  core.debug(`Input: 'urls: ${JSON.stringify(urls)}'`)
+
+  if (urls.length === 0) {
+    throw new Error("Either 'urls' or 'url_configs' input must be provided.")
+  }
+
+  return urls.map(url => ({url})) as UrlConfig[]
+}
+
+function loadReducedMotion() {
+  const reducedMotionInput = core.getInput('reduced_motion', {required: false})
+  if (!reducedMotionInput) return
+
+  if (!['reduce', 'no-preference', null].includes(reducedMotionInput)) {
+    throw new Error(
+      "Input 'reduced_motion' must be one of: 'reduce', 'no-preference', or null per Playwright documentation.",
+    )
+  }
+  return reducedMotionInput as ReducedMotionPreference
+}
+
+function loadColorScheme() {
+  const colorSchemeInput = core.getInput('color_scheme', {required: false})
+  if (!colorSchemeInput) return
+
+  if (!['light', 'dark', 'no-preference', null].includes(colorSchemeInput)) {
+    throw new Error(
+      "Input 'color_scheme' must be one of: 'light', 'dark', 'no-preference', or null per Playwright documentation.",
+    )
+  }
+
+  return colorSchemeInput as ColorSchemePreference
+}