@jrpool/kilotest 46.0.3 → 46.0.5

package/api/requestRetest.js

@@ -6,7 +6,7 @@
 // IMPORTS
 
 const {getResponseMetadata, getToolsFacts, processTestRequest, thisHost} = require('./util');
-const {getLatestReportExtracts, getReportsExtract} = require('../util');
+const {getLatestReportExtracts, getReportExtract} = require('../util');
 
 // FUNCTIONS
 
@@ -19,15 +19,11 @@ exports.response = async args => {
     'disposition of your request': null
   };
   const reasonLength = reason.length;
-  // Get data on the available reports.
-  const reportsExtract = await getReportsExtract();
   // Get data on the report.
-  const reportExtract = Object
-  .values(reportsExtract)
-  .find(extract => extract.timeStamp === timeStamp && extract.jobID === jobID);
-  const {what, url} = reportExtract || {};
+  const reportExtract = await getReportExtract(timeStamp, jobID);
+  const {what, url} = reportExtract.error ? {} : reportExtract;
   // If this failed:
-  if (!reportExtract) {
+  if (reportExtract.error) {
     // Add this to the response content.
     responseContent['details about your request'] = {
       error: 'request invalid: the specified existing report is not an available report'

package/index.js

@@ -24,7 +24,6 @@ const {
   isTimeStamp,
   isJobID,
   jobsPath,
-  makeReportsExtract,
   recsLock,
   reportsPath
 } = require('./util');
@@ -747,8 +746,6 @@ const requestHandler = async (request, response) => {
                 report.sources = {...report.sources, worker: workerName};
                 // Save the report.
                 await fs.writeFile(getReportPath(timeStamp, jobID), getJSON(report));
-                // Update the data on the available reports.
-                await makeReportsExtract();
                 // Annotate the report.
                 await annotateReport(timeStamp, jobID);
                 console.log(`Testaro report ${id} was annotated, saved, and indexed`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jrpool/kilotest",
-  "version": "46.0.3",
+  "version": "46.0.5",
   "description": "Ensemble testing for front-end web quality",
   "main": "index.js",
   "engines": {

package/test/fixtures/buildFixtures.js

@@ -2,14 +2,9 @@
   buildFixtures.js
   Builds the fixture corpus for Kilotest tests.
 
-  Each fixture is a minimal Testaro report in the current format, crafted so
-  that the expected API response can be hand-computed and hard-coded into
-  tests. The fixtures collectively cover the `outcome` property values
-  (`failed`, `cantTell`, and missing/undefined), superseded reports, empty
-  reports, and prevented rule engines.
+  Each fixture is a minimal Testaro report in the current format, crafted so that the expected API response can be hand-computed and hard-coded into tests. The fixtures collectively cover the `outcome` property values (`failed`, `cantTell`, and missing/undefined), superseded reports, empty reports, and prevented rule engines.
 
   Run with: node test/fixtures/buildFixtures.js [targetDir]
-  Defaults to test/fixtures/db under the project root.
 */
 
 // IMPORTS
@@ -20,14 +15,17 @@ const path = require('path');
 // CONSTANTS
 
 // Issue IDs with known specs in testaro-issues, chosen for different weights.
-const ISSUE_LINK_NO_TEXT = 'linkNoText';       // weight 4 (highest)
-const ISSUE_FOCUS_INDICATION = 'focusIndicationBad'; // weight 4
-const ISSUE_ALL_CAPS = 'allCaps';              // weight 1 (lowest)
+// weight 4 (highest)
+const issueLinkNoText = 'linkNoText';
+// weight 4
+const issueFocusIndication = 'focusIndicationBad';
+// weight 1 (lowest)
+const issueAllCaps = 'allCaps';
 
 // Rule engine IDs that exist in util.js ruleEngines.
-const ENGINE_AXE = 'axe';
-const ENGINE_ALFA = 'alfa';
-const ENGINE_IBM = 'ibm';
+const engineAxe = 'axe';
+const engineAlfa = 'alfa';
+const engineIbm = 'ibm';
 
 // FUNCTIONS
 
@@ -116,27 +114,23 @@ const main = async () => {
   await fs.mkdir(path.join(targetDir, 'jobs', 'failed'), {recursive: true});
   await fs.mkdir(path.join(targetDir, 'hiddenReports'), {recursive: true});
 
-  // Fixture 1: mixedOutcomes
-  // Two rule engines, three instances: one failed, one cantTell, one failed.
-  // The cantTell instance must be excluded from issue/violator counts.
-  // Two distinct issues (linkNoText weight 4, allCaps weight 1) and two
-  // distinct violator catalog indexes (0 and 1).
+  // Fixture 1: mixedOutcomes. Two rule engines, four instances: two failed (same issue, same violator, two engines), one cantTell (excluded from counts), one failed (different issue, different violator). Two distinct issues (linkNoText weight 4, allCaps weight 1) and two distinct violator catalog indexes (0 and 1).
   const mixedCatalog = {
     '0': catalogItem('A', 'About Us', '/html/body/a[1]', '10:20:80:30'),
     '1': catalogItem('P', 'ALL ABOUT US', '/html/body/p[1]', '10:60:80:20')
   };
   const mixedActs = [
-    testAct(ENGINE_AXE, [
+    testAct(engineAxe, [
       instance('r11', 'The link does not have an accessible name', 'failed',
-        ISSUE_LINK_NO_TEXT, 0, 2, 1),
+        issueLinkNoText, 0, 2, 1),
       instance('r65', 'Focus Visible', 'cantTell',
-        ISSUE_FOCUS_INDICATION, 0, 0, 1)
+        issueFocusIndication, 0, 0, 1)
     ]),
-    testAct(ENGINE_ALFA, [
+    testAct(engineAlfa, [
       instance('r11', 'The link does not have an accessible name', 'failed',
-        ISSUE_LINK_NO_TEXT, 0, 2, 1),
+        issueLinkNoText, 0, 2, 1),
       instance('r3', 'Text is all-capital', 'failed',
-        ISSUE_ALL_CAPS, 1, 1, 1)
+        issueAllCaps, 1, 1, 1)
     ])
   ];
   await writeJSON(
@@ -145,16 +139,14 @@ const main = async () => {
       'https://example.com/mixed', mixedActs, mixedCatalog)
   );
 
-  // Fixture 2: allCantTell
-  // All instances have outcome cantTell, so no issues or violators should be
-  // reported by listIssues, listViolators, or listDiagnoses.
+  // Fixture 2: allCantTell. All instances have outcome cantTell, so no issues or violators should be reported by listIssues, listViolators, or listDiagnoses.
   const cantTellCatalog = {
     '0': catalogItem('A', 'Click here', '/html/body/a[1]', '5:10:60:20')
   };
   const cantTellActs = [
-    testAct(ENGINE_AXE, [
+    testAct(engineAxe, [
       instance('r65', 'Focus Visible', 'cantTell',
-        ISSUE_FOCUS_INDICATION, 0, 0, 1)
+        issueFocusIndication, 0, 0, 1)
     ])
   ];
   await writeJSON(
@@ -163,15 +155,12 @@ const main = async () => {
       'https://example.com/canttell', cantTellActs, cantTellCatalog)
   );
 
-  // Fixture 3: noOutcomes
-  // Instances with no outcome property. Testaro defaults to 'failed', but
-  // Kilotest code checks `outcome !== 'cantTell'`, so missing outcome (undefined)
-  // is treated as a violation. This verifies that behavior.
+  // Fixture 3: noOutcomes. Instances with no outcome property. Testaro defaults to 'failed', but Kilotest code checks `outcome !== 'cantTell'`, so missing outcome (undefined) is treated as a violation. This verifies that behavior.
   const noOutcomeCatalog = {
     '0': catalogItem('BUTTON', 'Submit', '/html/body/button[1]', '15:25:70:30')
   };
   const noOutcomeActs = [
-    testAct(ENGINE_IBM, [
+    testAct(engineIbm, [
       {
         ruleID: 'r1',
         what: 'Button has no accessible name',
@@ -179,7 +168,7 @@ const main = async () => {
         count: 1,
         catalogIndex: '0',
         checkpoint: 0,
-        issueID: ISSUE_LINK_NO_TEXT
+        issueID: issueLinkNoText
       }
     ])
   ];
@@ -189,13 +178,11 @@ const main = async () => {
       'https://example.com/nooutcomes', noOutcomeActs, noOutcomeCatalog)
   );
 
-  // Fixture 4: superseded
-  // A report about the same page as mixedOutcomes but with a later timestamp,
-  // so mixedOutcomes is superseded by this one.
+  // Fixture 4: superseded. A report about the same page as mixedOutcomes but with a later timestamp, so mixedOutcomes is superseded by this one.
   const newerActs = [
-    testAct(ENGINE_AXE, [
+    testAct(engineAxe, [
       instance('r11', 'The link does not have an accessible name', 'failed',
-        ISSUE_LINK_NO_TEXT, 0, 2, 1)
+        issueLinkNoText, 0, 2, 1)
     ])
   ];
   await writeJSON(
@@ -204,24 +191,21 @@ const main = async () => {
       'https://example.com/mixed', newerActs, mixedCatalog, '26-02-02T00:10')
   );
 
-  // Fixture 5: empty
-  // A valid report with no test acts that have instances, so listIssues
-  // returns zero issues.
+  // Fixture 5: empty. A valid report with no test acts that have instances, so listIssues returns zero issues.
   await writeJSON(
     path.join(reportsDir, '260101T0005-emp.json'),
     report('260101T0005-emp', 'Empty Results Page',
-      'https://example.com/empty', [testAct(ENGINE_AXE, [])], {})
+      'https://example.com/empty', [testAct(engineAxe, [])], {})
   );
 
-  // Fixture 6: prevented
-  // A report where one rule engine was prevented from testing.
+  // Fixture 6: prevented. A report where one rule engine was prevented from testing.
   const preventedCatalog = {
     '0': catalogItem('IMG', 'An image', '/html/body/img[1]', '0:0:200:100')
   };
   const preventedActs = [
-    testAct(ENGINE_AXE, [
+    testAct(engineAxe, [
       instance('r11', 'The image has no alt text', 'failed',
-        ISSUE_LINK_NO_TEXT, 0, 2, 1)
+        issueLinkNoText, 0, 2, 1)
     ])
   ];
   const preventedReport = report('260101T0006-prv', 'Prevented Page',
@@ -232,6 +216,23 @@ const main = async () => {
     preventedReport
   );
 
+  // Fixture 7: hidden. A report placed in hiddenReports/ instead of reports/, so it must not appear in listReports, listIssues, listViolators, listDiagnoses, or getReport API responses.
+  const hiddenCatalog = {
+    '0': catalogItem('A', 'Secret link', '/html/body/a[1]', '5:10:60:20')
+  };
+  const hiddenActs = [
+    testAct(engineAxe, [
+      instance('r11', 'The link does not have an accessible name', 'failed',
+        issueLinkNoText, 0, 2, 1)
+    ])
+  ];
+  const hiddenReport = report('260101T0007-hid', 'Hidden Page',
+    'https://example.com/hidden', hiddenActs, hiddenCatalog);
+  await writeJSON(
+    path.join(targetDir, 'hiddenReports', '260101T0007-hid.json'),
+    hiddenReport
+  );
+
   // Write an empty recs.json so getRecs does not try to create one.
   await writeJSON(path.join(targetDir, 'jobs', 'recs.json'), {});
 

package/test/fixtures/db/hiddenReports/260101T0007-hid.json

@@ -0,0 +1,69 @@
+{
+  "id": "260101T0007-hid",
+  "what": "Hidden Page",
+  "strict": false,
+  "standard": "only",
+  "device": {
+    "id": "default"
+  },
+  "browserID": "chromium",
+  "creationTimeStamp": "260101T0007",
+  "executionTimeStamp": "260101T0007",
+  "target": {
+    "what": "Hidden Page",
+    "url": "https://example.com/hidden"
+  },
+  "sources": {
+    "worker": "test-worker"
+  },
+  "acts": [
+    {
+      "type": "test",
+      "which": "axe",
+      "startTime": "26-01-01T00:00",
+      "endTime": "26-01-01T00:01",
+      "result": {
+        "standardResult": {
+          "instances": [
+            {
+              "ruleID": "r11",
+              "what": "The link does not have an accessible name",
+              "ordinalSeverity": 2,
+              "outcome": "failed",
+              "count": 1,
+              "catalogIndex": "0",
+              "checkpoint": 0,
+              "issueID": "linkNoText"
+            }
+          ],
+          "outcomeTotals": {
+            "failed": 1,
+            "cantTell": 0
+          }
+        }
+      }
+    }
+  ],
+  "jobData": {
+    "startTime": "26-01-01T00:00",
+    "endTime": "26-01-01T00:10",
+    "elapsedSeconds": 600,
+    "preventions": {},
+    "issuelessRules": []
+  },
+  "catalog": {
+    "0": {
+      "tagName": "A",
+      "id": "",
+      "startTag": "<a>",
+      "text": "Secret link",
+      "textLinkable": false,
+      "boxID": "5:10:60:20",
+      "pathID": "/html/body/a[1]",
+      "headingIndex": "",
+      "checkpoint": 0
+    }
+  },
+  "images": {},
+  "checkpoints": []
+}

package/util.js

@@ -14,8 +14,7 @@ const wcagMap = require('./wcagMap.json');
 
 // CONSTANTS
 
-// Path of the data directory. Read afresh on every call (rather than cached at module load) so
-// that tests can point Kilotest at a fixture directory via the DB_DIR environment variable.
+// Path of the data directory. Read afresh on every call (rather than cached at module load) so that tests can point Kilotest at a fixture directory via the DB_DIR environment variable.
 const dbPath = exports.dbPath = () => process.env.DB_DIR || path.join(__dirname, 'db');
 // Path of the jobs directory.
 const jobsPath = exports.jobsPath = () => path.join(dbPath(), 'jobs');
@@ -25,8 +24,6 @@ const recsPath = exports.recsPath = () => path.join(jobsPath(), 'recs.json');
 const reportsPath = exports.reportsPath = () => path.join(dbPath(), 'reports');
 // Path of the hidden-reports directory.
 const hiddenReportsPath = exports.hiddenReportsPath = () => path.join(dbPath(), 'hiddenReports');
-// Path of the reports data file.
-const reportsExtractPath = exports.reportsExtractPath = () => path.join(dbPath(), 'reportsExtract.json');
 // IDs, names, and sponsors of Testaro rule engines.
 const ruleEngines = exports.ruleEngines = {
   alfa: ['Alfa', 'Siteimprove'],
@@ -663,68 +660,43 @@ exports.isHidden = async (timeStamp, jobID) => {
   // Return whether the report is among them.
   return hiddenReportFileNames.includes(`${timeStamp}-${jobID}.json`);
 };
-// Creates, saves, and returns an extract of all available reports.
-const makeReportsExtract = exports.makeReportsExtract = async () => {
-  // Initialize the reports data.
-  const reportsExtract = {};
-  // Get the names of all report files.
-  const reportFileNames = await fs.readdir(reportsPath());
-  // For each of them:
-  for (const reportFileName of reportFileNames) {
-    // Get its content.
-    const reportJSON = await fs.readFile(path.join(reportsPath(), reportFileName), 'utf8');
-    // Get the object that it represents.
+// Returns an extract of an available report, or an error object if it cannot be read or parsed.
+const getReportExtract = exports.getReportExtract = async (timeStamp, jobID) => {
+  try {
+    const reportJSON = await fs.readFile(
+      path.join(reportsPath(), `${timeStamp}-${jobID}.json`), 'utf8'
+    );
     const report = JSON.parse(reportJSON);
     const {target, jobData} = report;
-    const jobName = reportFileName.slice(0, -5);
-    const [timeStamp, jobID] = jobName.split('-');
     const {what, url} = target;
-    // Get an extract from it.
-    const reportExtract = {
+    return {
       timeStamp,
       jobID,
       what,
       url,
       reportTime: new Date(`20${jobData.endTime}Z`).toISOString()
     };
-    // Add the report extract to the reports extract.
-    reportsExtract[jobName] = reportExtract;
-  }
-  // Ensure the data directory exists.
-  await fs.mkdir(dbPath(), {recursive: true});
-  // Save the extract of the reports.
-  await fs.writeFile(reportsExtractPath(), getJSON(reportsExtract));
-  // Return it.
-  return reportsExtract;
-};
-// Gets an extract of all available reports.
-const getReportsExtract = exports.getReportsExtract = async () => {
-  let reportsExtract;
-  try {
-    // Get the reports extract file.
-    const reportsExtractJSON = await fs.readFile(reportsExtractPath(), 'utf8');
-    // Get its data.
-    reportsExtract = JSON.parse(reportsExtractJSON);
-    // If it is empty:
-    if (!Object.keys(reportsExtract).length) {
-      // Throw an error.
-      throw new Error('Reports extract file is empty');
-    }
   }
-  // If this fails:
   catch {
-    // Create or recreate and get the reports extract.
-    reportsExtract = await makeReportsExtract();
+    return {
+      error: `No report ${timeStamp}-${jobID} is available`
+    };
   }
-  // Return the extract.
-  return reportsExtract;
 };
 // Returns extracts of all available reports.
 const getReportExtracts = exports.getReportExtracts = async () => {
-  const reportsExtract = await getReportsExtract();
-  return Object.values(reportsExtract);
+  const reportFileNames = await fs.readdir(reportsPath());
+  const extracts = [];
+  for (const reportFileName of reportFileNames) {
+    const [timeStamp, jobID] = reportFileName.slice(0, -5).split('-');
+    const extract = await getReportExtract(timeStamp, jobID);
+    if (!extract.error) {
+      extracts.push(extract);
+    }
+  }
+  return extracts;
 };
-// Returns whether a report is available on a page with a description or URL.
+// Returns whether a report with a description or URL is available.
 exports.isReportAvailable = async (what, url) => {
   const reportExtracts = await getReportExtracts();
   const whats = reportExtracts.map(reportExtract => reportExtract.what);
@@ -733,43 +705,19 @@ exports.isReportAvailable = async (what, url) => {
 };
 // Gets extracts of the latest available reports for all page descriptions.
 exports.getLatestReportExtracts = async () => {
-  // Get extracts of all available reports.
   const reportExtracts = await getReportExtracts();
-  // Sort them primarily by page description and secondarily by completion time.
   objectSort(reportExtracts, 'reportTime', 'alpha');
   objectSort(reportExtracts, 'what', 'alpha');
-  // Get the latest ones for all page descriptions.
   const latestReportExtracts = reportExtracts
   .filter((extract, index) => extract.what !== reportExtracts[index + 1]?.what);
-  // Return them.
   return latestReportExtracts;
 };
-// Returns an extract of an available report.
-exports.getReportExtract = async (timeStamp, jobID) => {
-  // Get the extract of all available reports.
-  const reportsExtract = await getReportsExtract();
-  // Get the extract of the report from it.
-  const reportExtract = reportsExtract[`${timeStamp}-${jobID}`];
-  // If it exists:
-  if (reportExtract) {
-    // Return it.
-    return reportExtract;
-  }
-  // Otherwise, i.e. if it does not exist, return this.
-  return {
-    error: `No report ${timeStamp}-${jobID} is available`
-  };
-};
 // Gets the descriptions of multi-report pages.
 exports.getMultiReportWhats = async () => {
-  // Get extracts of all available reports.
   const reportExtracts = await getReportExtracts();
-  // Get their sorted page descriptions.
   const sortedWhats = reportExtracts.map(extract => extract.what).sort();
-  // Get those that at least 2 reports have.
   const multiReportWhats = sortedWhats.filter(
     (what, index) => what !== sortedWhats[index - 1] && what === sortedWhats[index + 1]
   );
-  // Return an array of descriptions of multi-report pages.
   return multiReportWhats;
 };

package/util.test.js

@@ -13,8 +13,7 @@ const {
   jobsPath,
   recsPath,
   reportsPath,
-  hiddenReportsPath,
-  reportsExtractPath
+  hiddenReportsPath
 } = require('./util');
 
 // TESTS
@@ -48,7 +47,7 @@ test('dbPath honors DB_DIR when it is set', () => {
   }
 });
 
-test('jobsPath, recsPath, reportsPath, hiddenReportsPath, and reportsExtractPath derive from DB_DIR', () => {
+test('jobsPath, recsPath, reportsPath, and hiddenReportsPath derive from DB_DIR', () => {
   const saved = process.env.DB_DIR;
   process.env.DB_DIR = '/tmp/kilotest-fixtures';
   try {
@@ -56,7 +55,6 @@ test('jobsPath, recsPath, reportsPath, hiddenReportsPath, and reportsExtractPath
     assert.equal(recsPath(), path.join('/tmp/kilotest-fixtures', 'jobs', 'recs.json'));
     assert.equal(reportsPath(), path.join('/tmp/kilotest-fixtures', 'reports'));
     assert.equal(hiddenReportsPath(), path.join('/tmp/kilotest-fixtures', 'hiddenReports'));
-    assert.equal(reportsExtractPath(), path.join('/tmp/kilotest-fixtures', 'reportsExtract.json'));
   }
   finally {
     if (saved !== undefined) {

package/web/expungeReportsForm/index.js

@@ -5,7 +5,7 @@
 
 // IMPORTS
 
-const {getReportData, makeReportsExtract, objectSort, reportsPath} = require('../../util');
+const {getReportData, objectSort, reportsPath} = require('../../util');
 const fs = require('fs/promises');
 const path = require('path');
 
@@ -26,8 +26,6 @@ exports.answer = async (_, search) => {
           // Delete it.
           await fs.unlink(path.join(reportsPath(), `${jobName}.json`));
         }
-        // Update the extract of the available reports.
-        await makeReportsExtract();
       }
       // If this failed:
       catch (error) {

package/web/hideReportForm/index.js

@@ -5,7 +5,7 @@
 
 // IMPORTS
 
-const {getReportExtracts, hiddenReportsPath, makeReportsExtract, reportsPath} = require('../../util');
+const {getReportExtracts, hiddenReportsPath, reportsPath} = require('../../util');
 const fs = require('fs/promises');
 const path = require('path');
 
@@ -24,8 +24,6 @@ exports.answer = async (_, search) => {
       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:
       catch (error) {

package/web/pruneReportsForm/index.js

@@ -5,7 +5,7 @@
 
 // IMPORTS
 
-const {getReportData, makeReportsExtract, reportsPath} = require('../../util');
+const {getReportData, reportsPath} = require('../../util');
 const fs = require('fs/promises');
 const path = require('path');
 
@@ -26,8 +26,6 @@ exports.answer = async (_, search) => {
           // Delete it.
           await fs.unlink(path.join(reportsPath(), `${jobName}.json`));
         }
-        // Update the extract of the available reports.
-        await makeReportsExtract();
       }
       // If this failed:
       catch (error) {

package/web/unhideReportForm/index.js

@@ -5,7 +5,7 @@
 
 // IMPORTS
 
-const {hiddenReportsPath, makeReportsExtract, reportsPath} = require('../../util');
+const {hiddenReportsPath, reportsPath} = require('../../util');
 const fs = require('fs/promises');
 const path = require('path');
 
@@ -24,8 +24,6 @@ exports.answer = async (_, search) => {
       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.