add axe scan to docs cd

.github/workflows/docs_ci_cd.yml

@@ -42,5 +42,11 @@ jobs:
           AZURE_CLIENT_ID: ${{ secrets.AZURE_CLIENT_ID }}
           AZURE_CLIENT_SECRET: ${{ secrets.AZURE_CLIENT_SECRET }}
           AZURE_TENANT_ID: ${{ secrets.AZURE_TENANT_ID }}
+      - name: Axe Accessibility Scan
+        run: pnpm run axe
+        env:
+          AZURE_CLIENT_ID: ${{ secrets.AZURE_CLIENT_ID }}
+          AZURE_CLIENT_SECRET: ${{ secrets.AZURE_CLIENT_SECRET }}
+          AZURE_TENANT_ID: ${{ secrets.AZURE_TENANT_ID }}
 
 

cspell.json

@@ -4,6 +4,7 @@
   "useGitignore": true,
   "words": [
     "allowcolumnreorder",
+    "ansicolor",
     "clickanalytics",
     "datagridvue",
     "docsearch",

package.json

@@ -80,6 +80,7 @@
   },
   "devDependencies": {
     "@axe-core/cli": "^4.8.2",
+    "@azure/communication-email": "^1.0.0",
     "@azure/identity": "^4.0.0",
     "@azure/keyvault-secrets": "^4.7.0",
     "@babel/types": "^7.23.6",
@@ -92,6 +93,7 @@
     "@vue/tsconfig": "^0.5.1",
     "@vuepress/utils": "2.0.0-rc.0",
     "adm-zip": "^0.5.10",
+    "ansicolor": "^2.0.1",
     "cspell": "^8.3.2",
     "dotenv": "^16.3.1",
     "googleapis": "^130.0.0",

scripts/axe/axe.ts

@@ -1,21 +1,46 @@
 import { getUrlsAsync } from '../shared/urls.js'
-import { exec } from 'node:child_process'
+import { sendEmail } from '../shared/email.js'
+import { ExecException, exec } from 'node:child_process'
 
 const urls = await getUrlsAsync()
 
+const output = [] as string[]
+
+function appendLog(url: string, stdout: string) {
+  const txt = `${url} | ${stdout}`
+  output.push(txt)
+  console.log(txt)
+}
+
+function appendError(url: string, err: ExecException | string) {
+  const txt = `${url} | ${err}`
+  output.push(txt)
+  console.error(txt)
+}
+
+const promises = [] as Promise<void>[]
+
 for (const url of urls) {
-  console.log(`Processing ${url}...`)
-  exec(`./node_modules/.bin/axe "${url}"`, (err, stdout, stderr) => {
-    if (err) {
-      console.error(`Error on ${url} | ${err}`)
-      return
-    }
-
-    if (stderr) {
-      console.error(`Error on ${url} | ${err}`)
-      return
-    }
-
-    console.log(`${url} | ${stdout}`)
-  })
+  promises.push(
+    new Promise((resolve, reject) => {
+      const process = exec(`./node_modules/.bin/axe "${url}"`, (err: ExecException | null, stdout: string, stderr: string) => {
+        if (err) {
+          appendError(url, err)
+          return
+        }
+
+        if (stderr) {
+          appendError(url, stderr)
+          return
+        }
+
+        appendLog(url, stdout)
+      })
+
+      process.on('close', resolve)
+    }),
+  )
 }
+
+await Promise.all(promises)
+await sendEmail('Axe Results - data-grid-vue', output)

scripts/axe/tsconfig.axe.json

@@ -4,7 +4,8 @@
     "baseUrl": "./",
     "module": "NodeNext",
     "moduleResolution": "NodeNext",
-    "noEmit": false
+    "noEmit": false,
+    "noImplicitAny": false
   },
   "include": ["./**/*.ts", "../shared/**/*.ts"]
 }

scripts/shared/email.ts

@@ -0,0 +1,45 @@
+import { EmailClient, EmailMessage, EmailSendResponse } from '@azure/communication-email'
+import { EnvironmentCredential } from '@azure/identity'
+import { SecretClient } from '@azure/keyvault-secrets'
+import { parse } from 'ansicolor'
+
+interface AzureEmailConfig {
+  connectionString: string
+  senderAddress: string
+  toEmail: string
+}
+
+const credential = new EnvironmentCredential()
+const client = new SecretClient('https://data-grid-vue.vault.azure.net/', credential)
+
+const secret = await client.getSecret('EmailService')
+const config = JSON.parse(secret.value ?? '{}') as AzureEmailConfig
+
+const emailClient = new EmailClient(config.connectionString)
+
+export async function sendEmail(subject: string, ansiTexts: string[]): Promise<EmailSendResponse> {
+  const parsed = parse(ansiTexts.join('\r\n'))
+  const html = parsed.spans.map(s => s.text).join('<br />')
+
+  const message: EmailMessage = {
+    senderAddress: config.senderAddress,
+    recipients: {
+      to: [
+        {
+          address: config.toEmail,
+        },
+      ],
+    },
+    content: {
+      subject,
+      html,
+    },
+  }
+
+  const poller = await emailClient.beginSend(message)
+  const response = await poller.pollUntilDone()
+
+  console.log('EMAIL RESPONSE', response)
+
+  return response
+}