@jrpool/kilotest 38.0.0 → 39.0.0

package/package.json

@@ -1,12 +1,14 @@
 {
   "name": "@jrpool/kilotest",
-  "version": "38.0.0",
-  "description": "An ensemble testing service with a focus on accessibility",
+  "version": "39.0.0",
+  "description": "Ensemble testing for front-end web quality",
   "main": "index.js",
   "scripts": {
     "start": "node index",
-    "lint": "npx eslint",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "lint": "npx eslint && npx markdownlint-cli2",
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "test:api": "node api/testSuite",
+    "generate:openapi": "node scripts/generate-openapi"
   },
   "repository": {
     "type": "git",
@@ -20,7 +22,8 @@
   "author": "Jonathan Robert Pool <pool@jpdev.pro>",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/jrpool/kilotest/issues"
+    "url": "https://github.com/jrpool/kilotest/issues",
+    "email": "info@kilotest.com"
   },
   "homepage": "https://github.com/jrpool/kilotest",
   "dependencies": {
@@ -30,12 +33,16 @@
     "zod": "*"
   },
   "devDependencies": {
-    "@eslint/css": "^1.0.0",
-    "@eslint/js": "^10.0.1",
-    "@eslint/json": "^1.1.0",
-    "@eslint/markdown": "^7.5.1",
-    "eslint": "^10.0.3",
-    "globals": "^17.4.0"
+    "@eslint/css": "*",
+    "@eslint/js": "*",
+    "@eslint/json": "*",
+    "@eslint/markdown": "*",
+    "@redocly/cli": "*",
+    "eslint": "*",
+    "globals": "*",
+    "js-yaml": "*",
+    "markdownlint-cli2": "*",
+    "zod-openapi": "*"
   },
   "allowScripts": {
     "fsevents@2.3.2": true

package/reannotate/index.js

@@ -5,7 +5,7 @@
 
 // IMPORTS
 
-const {annotateReport, getLogs, ruleIDs} = require('../util');
+const {annotateReport, getReportExtracts, ruleIDs} = require('../util');
 const fs = require('fs/promises');
 const path = require('path');
 
@@ -15,22 +15,33 @@ const path = require('path');
 exports.answer = async authCode => {
   // If the authorization code is valid:
   if (authCode === process.env.AUTH_CODE) {
-    // Get the logs of the latest reports per target.
-    const targetsData = (await getLogs()).filter(log => ! log.superseded);
-    // For each report:
-    for (const targetData of targetsData) {
-      const [timeStamp, jobID] = targetData.jobName.split('-');
-      // Reannotate it.
-      const annotationError = await annotateReport(ruleIDs, timeStamp, jobID);
-      // If this failed:
-      if (annotationError) {
-        // Return an error page.
-        return {
-          status: 'error',
-          message: annotationError
-        };
+    // Get data on the available reports.
+    const reportExtracts = await getReportExtracts();
+    // If any exist:
+    if (reportExtracts.length) {
+      // For each report:
+      for (const reportExtract of reportExtracts) {
+        const {timeStamp, jobID} = reportExtract;
+        // Reannotate it.
+        const annotationError = await annotateReport(ruleIDs, timeStamp, jobID);
+        // If this failed:
+        if (annotationError) {
+          // Return an error page.
+          return {
+            status: 'error',
+            message: annotationError
+          };
+        }
       }
     }
+    // Otherwis, i.e. if it failed:
+    else {
+      // Return an error page.
+      return {
+        status: 'error',
+        message: 'Got data on no available reports'
+      };
+    }
     // If every annotation succeeded, get the answer page.
     let answerPage = await fs.readFile(path.join(__dirname, 'index.html'), 'utf8');
     // Return it.

package/reannotateForm/index.js

@@ -1,11 +1,11 @@
 /*
   index.js
-  Discloses unclassified rules.
+  Discloses unclassified and reclassified rules and serves a form to reannotate reports.
 */
 
 // IMPORTS
 
-const {getIssue, getReport, getLogs, ruleIDs} = require('../util');
+const {getIssue, getReport, getReportExtracts, ruleIDs} = require('../util');
 const fs = require('fs/promises');
 const path = require('path');
 
@@ -13,15 +13,17 @@ const path = require('path');
 
 // Adds parameters to a query for the answer page.
 const populateQuery = async query => {
-  const targetLogs = (await getLogs()).filter(log => ! log.superseded);
-  const stillUnclassified = {};
+  // Initialize data on rule classification.
   const reClassified = {};
-  // For each target:
-  for (const targetLog of targetLogs) {
-    const {jobName = '-'} = targetLog;
-    // Get the latest report on it.
-    const report = await getReport(... jobName.split('-'));
-    const {acts = [], error} = report;
+  const stillUnclassified = {};
+  // Get an extract of all available reports.
+  const reportExtracts = await getReportExtracts();
+  // For each report:
+  for (const reportExtract of reportExtracts) {
+    const {jobID, timeStamp} = reportExtract;
+    // Get it.
+    const report = await getReport(timeStamp, jobID);
+    const {acts = [], error, id} = report;
     // If this failed:
     if (error) {
       // Populate the query with the reason.
@@ -44,14 +46,14 @@ const populateQuery = async query => {
             // Add the rule and the report to the rules with changed issue IDs.
             reClassified[which] ??= {};
             reClassified[which][ruleID] ??= new Set();
-            reClassified[which][ruleID].add(jobName);
+            reClassified[which][ruleID].add(id);
           }
           // Otherwise, if the instance and the rule both have no issue ID:
-          else if (! issueID){
+          else if (!issueID){
             // Add the rule and the report to the rules that are still unclassified.
             stillUnclassified[which] ??= {};
             stillUnclassified[which][ruleID] ??= new Set();
-            stillUnclassified[which][ruleID].add(jobName);
+            stillUnclassified[which][ruleID].add(id);
           }
         });
       }

package/redocly.yaml

@@ -0,0 +1,4 @@
+extends:
+  - recommended
+rules:
+  operation-4xx-response: off

package/reportHideForm/index.html

@@ -20,7 +20,7 @@
           __reports__
         </fieldset>
         <p><label>
-          Authorization code: <input size="3" minLength="3" maxlength="3" name="authCode" required>
+          Authorization code: <input size="3" minlength="3" maxlength="3" name="authCode" required>
         </label></p>
         <p><button type="submit">Submit</button></p>
       </form>

package/reportHideForm/index.js

@@ -5,7 +5,7 @@
 
 // IMPORTS
 
-const {getJSON, getLog, logsPath, reportsPath} = require('../util');
+const {getReportExtracts, hiddenReportsPath, makeReportsExtract, reportsPath} = require('../util');
 const fs = require('fs/promises');
 const path = require('path');
 
@@ -20,20 +20,21 @@ exports.answer = async (_, search) => {
   if (jobName) {
     // If the authorization code is valid:
     if (authCode === process.env.AUTH_CODE) {
-      // Get the log of the report.
-      const log = await getLog(... jobName.split('-'));
+      const fileName = `${jobName}.json`;
+      try {
+        // Move the specified report to the directory of hidden reports.
+        await fs.rename(path.join(reportsPath, fileName), path.join(hiddenReportsPath, fileName));
+        // Update the data on the available reports.
+        await makeReportsExtract();
+      }
       // If this failed:
-      if (log.error) {
+      catch (error) {
         // Return why.
         return {
           status: 'error',
-          message: log.error
-        }
+          message: `Hiding report ${jobName} failed (${error.message})`
+        };
       }
-      // Otherwise, i.e. if it succeeded, add a hiddenness property to the log.
-      log.hidden = true;
-      // Save the updated log.
-      await fs.writeFile(path.join(logsPath, `${jobName}.json`), getJSON(log));
     }
     // Otherwise, i.e. if the authorization code is invalid:
     else {
@@ -44,33 +45,21 @@ exports.answer = async (_, search) => {
       }
     }
   }
-  const reportFileNames = await fs.readdir(reportsPath);
   // Initialize an array of report specifications.
   const reportSpecs = [];
+  // Get data on all available reports.
+  const reportExtracts = await getReportExtracts();
   // For each report:
-  for (const reportFileName of reportFileNames) {
-    const [timeStamp, jobID] = reportFileName.slice(0, -5).split('-');
-    // Get its log.
-    const log = await getLog(timeStamp, jobID);
-    // If this failed:
-    if (log.error) {
-      // Return why.
-      return {
-        status: 'error',
-        message: log.error
-      }
-    }
-    // Otherwise, i.e. if it succeeded:
-    const {what, hidden} = log;
+  for (const reportExtract of reportExtracts) {
+    const {jobID, timeStamp, what} = reportExtract;
     // Add the report to the array.
     reportSpecs.push({
       what,
       timeStamp,
-      jobID,
-      hidden
+      jobID
     });
   }
-  // Sort the logs by page name and then by time stamp.
+  // Sort the data by page name and then by time stamp.
   reportSpecs.sort((a, b) => {
     if (a.what === b.what) {
       return a.timeStamp.localeCompare(b.timeStamp);
@@ -79,17 +68,14 @@ exports.answer = async (_, search) => {
   });
   const lines = [];
   const margin = ' '.repeat(12);
-  // For each report:
+  // For each available report:
   reportSpecs.forEach(spec => {
-    const {hidden, what, timeStamp, jobID} = spec;
-    // If it is not already hidden:
-    if (! hidden) {
-      const specString = `${what} (job <code>${jobID}</code> at ${timeStamp})`;
-      // Add a line with a radio button to hide it.
-      lines.push(
-        `${margin}<p><input type="radio" name="report" value="${timeStamp}-${jobID}"> ${specString}</p>`
-      );
-    }
+    const {jobID, timeStamp, what} = spec;
+    const specString = `${what} (job <code>${jobID}</code> at ${timeStamp})`;
+    // Add a line with a radio button to hide it.
+    lines.push(
+      `${margin}<p><input type="radio" name="report" value="${timeStamp}-${jobID}"> ${specString}</p>`
+    );
   });
   const query = {
     reports: lines.join('\n'),

package/reportIssue/index.js

@@ -37,7 +37,7 @@ const populateQuery = async (issueID, timeStamp, jobID, query) => {
   // Otherwise, i.e. if it succeeded, add the issue summary to the query.
   query.issue = issues[issueID]?.summary;
   // If adding the issue summary failed:
-  if (! query.issue) {
+  if (!query.issue) {
     // Populate the query with the reason.
     query.error = 'Issue not found';
     // Stop populating the query.
@@ -112,7 +112,7 @@ const populateQuery = async (issueID, timeStamp, jobID, query) => {
   // Convert the violator data to an array.
   violators = Object.entries(violators).map(entry => ({
     catalogIndex: entry[0],
-    ... entry[1]
+    ...entry[1]
   }));
   // Sort the violators in XPath order.
   violators.sort((a, b) => a.pathID.localeCompare(b.pathID));
@@ -133,7 +133,7 @@ const populateQuery = async (issueID, timeStamp, jobID, query) => {
     if (tagName) {
       lines.push(`${margin}    <li>Tag name: <code>${tagName}</code></li>`);
     }
-    if (text && ! ['HTML', 'HEAD', 'BODY', 'MAIN', 'NOSCRIPT'].includes(tagName)) {
+    if (text && !['HTML', 'HEAD', 'BODY', 'MAIN', 'NOSCRIPT'].includes(tagName)) {
       const textString = text.split('\n').join(' … ');
       lines.push(`${margin}    <li>Text: <q>${htmlSafe(textString)}</q></li>`);
     }

package/reportIssues/index.js

@@ -5,20 +5,147 @@
 
 // IMPORTS
 
-const {getData} = require('./util');
 const {
+  getPageData,
   getPageDataStrings,
+  getReport,
+  getToolList,
   getWCAGLink,
   getWeightName,
   htmlSafe,
   isHidden,
+  isValidReport,
+  objectSort,
   tools
 } = require('../util');
+const issuesClassification = require('testilo/procs/score/tic').issues;
 const fs = require('fs/promises');
 const path = require('path');
 
 // FUNCTIONS
 
+// Returns data on the issues reported by a report.
+const getIssuesData = async (timeStamp, jobID) => {
+  // Get the report.
+  const report = await getReport(timeStamp, jobID);
+  const reportIsHidden = await isHidden(timeStamp, jobID);
+  // If it exists and is hidden:
+  if (reportIsHidden) {
+    return {error: 'Report is not available'}
+  }
+  // Otherwise, if it exists and is valid:
+  if (isValidReport(report)) {
+    // Initialize the temporary data.
+    const temp = {
+      issues: {},
+      reporters: new Set(),
+      violators: new Set()
+    };
+    // Initialize the final data.
+    const final = {
+      reporters: [],
+      reporterList: '',
+      reporterCount: 0,
+      violatorCount: 0,
+      preventions: report.jobData.preventions,
+      issues: {
+        4: [],
+        3: [],
+        2: [],
+        1: []
+      },
+      issueCount: 0
+    };
+    // For each act in the report:
+    report.acts.forEach(act => {
+      // If it is a test act:
+      if (act.type === 'test') {
+        const {result, which} = act;
+        const instances = result?.standardResult?.instances ?? [];
+        // For each of its standard instances:
+        instances.forEach(instance => {
+          const {catalogIndex, issueID} = instance;
+          // If the instance identifies its rule as belonging to a non-ignorable issue:
+          if (issueID && issueID !== 'ignorable') {
+            const issueClassification = issuesClassification[issueID];
+            // If the issue has a current weighted classification:
+            if (issueClassification && [1, 2, 3, 4].includes(issueClassification.weight)) {
+              const {summary, wcag, weight, why} = issueClassification;
+              // Initialize the temporary data on the issue if necessary.
+              temp.issues[issueID] ??= {
+                issueID,
+                summary,
+                wcag,
+                why,
+                weight,
+                reporters: new Set(),
+                reporterList: '',
+                violators: new Set()
+              };
+              // Ensure the tool is in the temporary data.
+              temp.issues[issueID].reporters.add(which);
+              temp.reporters.add(which);
+              // If the instance has a catalog index:
+              if (catalogIndex) {
+                // Ensure the violator is in the temporary data.
+                temp.issues[issueID].violators.add(catalogIndex);
+                temp.violators.add(catalogIndex);
+              }
+            }
+          }
+        });
+      }
+    });
+    // Finish populating the final data.
+    final.reporterList = getToolList(temp.reporters);
+    final.reporterCount = temp.reporters.size;
+    final.violatorCount = temp.violators.size;
+    Object.values(temp.issues).forEach(issue => {
+      const {issueID, summary, wcag, why, weight} = issue;
+      const finalIssue = {
+        issueID,
+        summary,
+        wcag,
+        why,
+        weight
+      };
+      finalIssue.reporterList = getToolList(issue.reporters);
+      finalIssue.reporterCount = issue.reporters.size;
+      finalIssue.violatorCount = issue.violators.size;
+      final.issues[issue.weight].push(finalIssue);
+    });
+    final.issueCount = Object.keys(temp.issues).length;
+    // For each weight:
+    [4, 3, 2, 1].forEach(weight => {
+      // Sort its issues in the final data alphabetically by reporter names.
+      objectSort(final.issues[weight], 'reporterList', 'alpha');
+      // Sort the issues again in descending reporter-count order, making this the primary order.
+      objectSort(final.issues[weight], 'reporterCount', 'numericDown');
+    });
+    // Return the data.
+    return final;
+  }
+  // Otherwise, i.e. if it is invalid or does not exist, return this.
+  return {error: 'Report missing or invalid.'};
+};
+// Get page and issues data from a report.
+const getData = async (timeStamp, jobID) => {
+  const pageData = await getPageData(timeStamp, jobID);
+  const issuesData = await getIssuesData(timeStamp, jobID);
+  const pageError = pageData.error || '';
+  const issuesError = issuesData.error || '';
+  const errors = [pageError, issuesError].filter(Boolean).join('; ');
+  // If the data of either type are missing or invalid:
+  if (errors) {
+    // Return this.
+    return {error: errors};
+  }
+  // Otherwise, return the data.
+  return {
+    pageData,
+    issuesData
+  };
+};
 // Adds parameters to a query for the answer page.
 const populateQuery = async (timeStamp, jobID, query) => {
   // Get data on the target and its issues according to the report.

package/reportUnhideForm/index.js

@@ -5,7 +5,7 @@
 
 // IMPORTS
 
-const {getJSON, getLog, logsPath, reportsPath} = require('../util');
+const {hiddenReportsPath, makeReportsExtract, reportsPath} = require('../util');
 const fs = require('fs/promises');
 const path = require('path');
 
@@ -20,20 +20,20 @@ exports.answer = async (_, search) => {
   if (jobName) {
     // If the authorization code is valid:
     if (authCode === process.env.AUTH_CODE) {
-      // Get the log of the report.
-      const log = await getLog(... jobName.split('-'));
-      // If this failed:
-      if (log.error) {
+      const fileName = `${jobName}.json`;
+      try {
+        // Move the report to the reports directory.
+        await fs.rename(path.join(hiddenReportsPath, fileName), path.join(reportsPath, fileName));
+        // Update the data on the available reports.
+        await makeReportsExtract();
+      }
+      catch (error) {
         // Return why.
         return {
           status: 'error',
-          message: log.error
+          message: `Unhiding report file ${fileName} failed (${error.message})`
         }
       }
-      // Otherwise, i.e. if it succeeded, reverse the hiddenness property of the log.
-      log.hidden = false;
-      // Save the updated log.
-      await fs.writeFile(path.join(logsPath, `${jobName}.json`), getJSON(log));
     }
     // Otherwise, i.e. if the authorization code is invalid:
     else {
@@ -44,51 +44,43 @@ exports.answer = async (_, search) => {
       }
     }
   }
-  const reportFileNames = await fs.readdir(reportsPath);
-  // Initialize an array of report specifications.
-  const reportSpecs = [];
-  // For each report:
-  for (const reportFileName of reportFileNames) {
-    const [timeStamp, jobID] = reportFileName.slice(0, -5).split('-');
-    // Get its log.
-    const log = await getLog(timeStamp, jobID);
-    const {error, what, hidden} = log;
-    // If this failed:
-    if (error) {
-      // Return why.
-      return {
-        status: 'error',
-        message: error
-      }
-    }
-    // Otherwise, i.e. if it succeeded, add the report to the array.
-    reportSpecs.push({
+  // Initialize an array of data on reports to be unhidden.
+  const reportsData = [];
+  // Get the names of the hidden report files.
+  const hiddenReportFileNames = await fs.readdir(hiddenReportsPath);
+  // For each hidden report:
+  for (const reportFileName of hiddenReportFileNames) {
+    // Get its file.
+    const reportJSON = await fs.readFile(path.join(hiddenReportsPath, reportFileName), 'utf8');
+    // Get the report.
+    const report = JSON.parse(reportJSON);
+    const {id, target} = report;
+    const [timeStamp, jobID] = id.split('-');
+    const {what} = target;
+    // Add its data to the array.
+    reportsData.push({
       what,
       timeStamp,
-      jobID,
-      hidden
+      jobID
     });
   }
-  // Sort the logs by page name and then by time stamp.
-  reportSpecs.sort((a, b) => {
+  // Sort the data by page name and then by time stamp.
+  reportsData.sort((a, b) => {
     if (a.what === b.what) {
       return a.timeStamp.localeCompare(b.timeStamp);
     }
-    return a.what.localeCompare(b.what);
+    return a.what.localeCompare(b.what, 'en', {sensitivity: 'base'});
   });
   const lines = [];
   const margin = ' '.repeat(12);
   // For each report:
-  reportSpecs.forEach(spec => {
-    const {hidden, what, timeStamp, jobID} = spec;
-    // If it is hidden:
-    if (hidden) {
-      const specString = `${what} (job <code>${jobID}</code> at ${timeStamp})`;
-      // Add a line with a radio button to unhide it.
-      lines.push(
-        `${margin}<p><input type="radio" name="report" value="${timeStamp}-${jobID}"> ${specString}</p>`
-      );
-    }
+  reportsData.forEach(data => {
+    const {jobID, timeStamp, what} = data;
+    const specString = `${what} (job <code>${jobID}</code> at ${timeStamp})`;
+    // Add a line with a radio button to unhide it.
+    lines.push(
+      `${margin}<p><input type="radio" name="report" value="${timeStamp}-${jobID}"> ${specString}</p>`
+    );
   });
   const query = {
     reports: lines.join('\n'),

package/reportsExpungeForm/index.js

@@ -5,7 +5,7 @@
 
 // IMPORTS
 
-const {getReportData, logsPath, reportsPath} = require('../util');
+const {getReportData, makeReportsExtract, objectSort, reportsPath} = require('../util');
 const fs = require('fs/promises');
 const path = require('path');
 
@@ -20,12 +20,22 @@ exports.answer = async (_, search) => {
   if (jobNames?.length) {
     // If the authorization code is valid:
     if (authCode === process.env.AUTH_CODE) {
-      // For each report to be deleted:
-      for (const jobName of jobNames) {
-        // Delete it.
-        await fs.unlink(path.join(reportsPath, `${jobName}.json`));
-        // Delete its log.
-        await fs.unlink(path.join(logsPath, `${jobName}.json`));
+      try {
+        // For each report to be deleted:
+        for (const jobName of jobNames) {
+          // Delete it.
+          await fs.unlink(path.join(reportsPath, `${jobName}.json`));
+        }
+        // Update the extract of the available reports.
+        await makeReportsExtract();
+      }
+      // If this failed:
+      catch (error) {
+        // Return why.
+        return {
+          status: 'error',
+          message: `Deleting sole reports failed (${error.message})`
+        }
       }
     }
     // Otherwise, i.e. if the authorization code is invalid:
@@ -43,8 +53,8 @@ exports.answer = async (_, search) => {
   for (const reportName of reportNames) {
     const [timeStamp, jobID] = reportName.slice(0, -5).split('-');
     // Get a summary of it.
-    const reportSummary = await getReportData(timeStamp, jobID);
-    const {error, issueCount, preventedToolCount, url} = reportSummary;
+    const reportFacts = await getReportData(timeStamp, jobID);
+    const {error, issueCount, preventedToolCount, url} = reportFacts;
     // If this failed:
     if (error) {
       // Return why.
@@ -61,13 +71,9 @@ exports.answer = async (_, search) => {
       url
     });
   }
-  // Sort the summaries by URL and then by time stamp.
-  reportSpecs.sort((a, b) => {
-    if (a.url === b.url) {
-      return a.timeStamp.localeCompare(b.timeStamp);
-    }
-    return a.url.localeCompare(b.url);
-  });
+  // Sort the summaries primarily URL and secondarily by time stamp.
+  objectSort(reportSpecs, 'timeStamp', 'alpha');
+  objectSort(reportSpecs, 'url', 'alpha');
   const lines = [];
   const margin = ' '.repeat(12);
   let anyDeletable = false;