@jrpool/kilotest 25.0.0 → 26.0.0

package/index.js

@@ -75,9 +75,6 @@ const WAVE_THRESHOLD = Number(process.env.WAVE_BALANCE_THRESHOLD);
 const AI_SERVICE0_THRESHOLD = Number(process.env.AI_SERVICE0_BALANCE_THRESHOLD);
 const AI_MODEL0_INPUT_PRICE = Number(process.env.AI_MODEL0_INPUT_PRICE);
 const AI_MODEL0_OUTPUT_PRICE = Number(process.env.AI_MODEL0_OUTPUT_PRICE);
-const researchAgents = {
-  'research-agent': 'Internal Research Agent'
-}
 
 // FUNCTIONS
 
@@ -585,12 +582,20 @@ const requestHandler = async (request, response) => {
       }
       // Otherwise, if the agent is the authorized research agent and it is authenticated:
       else if (agentID === researchAgent && postData.agentPW === researchAgentPW) {
-        // If the service is provision of facts about issues in a report:
-        if (service === 'reportIssues') {
-          // Get the report identifiers from the path.
+        // If the service is provision of facts about the available reports:
+        if (service === 'targets') {
+          // Get the agent ID from the path.
+          const args = [agentID];
+          // Get the response (potentially error) data.
+          const responseData = await require(path.join(__dirname, 'targets', 'api')).response(args);
+          // Send them.
+          response.end(JSON.stringify(responseData));
+        }
+        // Otherwise, if the service is provision of facts about issues in a report:
+        else if (service === 'reportIssues') {
+          // Get the agent ID and report identifiers from the path.
           const [timeStamp, jobID] = specs;
-          const agentName = researchAgents[agentID];
-          const args = [agentName, timeStamp, jobID];
+          const args = [agentID, timeStamp, jobID];
           const reportSpecsBad = await isHidden(timeStamp, jobID);
           // If the report is nonexistent or hidden:
           if (reportSpecsBad) {
@@ -613,7 +618,7 @@ const requestHandler = async (request, response) => {
         // Otherwise, i.e. if the service is invalid:
         else {
           // Report this.
-          await serveError({message: 'ERROR: Invalid service request'}, response, false);
+          await serveError({message: 'ERROR: Invalid service request from research agent'}, response, false);
         }
       }
       // Otherwise, i.e. if the agent is not authorized or not authenticated:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jrpool/kilotest",
-  "version": "25.0.0",
+  "version": "26.0.0",
   "description": "An ensemble testing service with a focus on accessibility",
   "main": "index.js",
   "scripts": {

package/reportIssues/api.js

@@ -5,49 +5,42 @@
 
 // IMPORTS
 
-const {getData, getToolData} = require('./util');
+const {getData} = require('./util');
 const {
   getDateTime,
   getNowStamp,
   getRandomString,
-  getToolNamesString,
+  getToolsFacts,
   isHidden,
+  researchAgents,
   tools
 } = require('../util');
 
 // FUNCTIONS
 
-// Gets facts about tools.
-const getToolFacts = toolIDs => {
-  const crypticData = getToolData(toolIDs);
-  return crypticData.map(tool => {
-    const {toolID, toolName, toolMaker} = tool;
-    return {
-      identifier: toolID,
-      name: toolName,
-      sponsor: toolMaker
-    };
-  });
-};
 // Gets facts about an issue.
-const getIssueFacts = issue => {
-  const {issueID, reporterCount, reporterList, reporters, summary, violatorCount, wcag, why} = issue;
+const getIssueFacts = (thisHost, agentID, timeStamp, jobID, issue) => {
+  const {issueID, reporterCount, reporters, summary, violatorCount, wcag, why} = issue;
+  const wcagType = wcag.length === 3 ? 'principle' : 'success criterion';
   return {
     identifier: issueID,
     summary,
-    'related WCAG principle (n.n) or success criterion (n.n.n)': wcag,
+    [`related WCAG ${wcagType}`]: wcag,
     'impact on a user': why,
-    'tools reporting violations of rules belonging to the issue': {
-      'number of the tools': reporterCount,
-      'alphabetized list of names of the tools': reporterList,
-      'facts about the tools alphabetized by name': getToolFacts(reporters.map(tool => tool.toolID))
+    'tools reporting the issue': {
+      'number': reporterCount,
+      'names': reporters.map(tool => tool.toolName)
     },
-    'number of HTML elements reported as exhibiting the issue': violatorCount
+    'number of HTML elements reported as exhibiting the issue': violatorCount,
+    'URLs for details about the issue on the page': {
+      'for you': `${thisHost}/api/${agentID}/reportIssue/${timeStamp}/${jobID}/${issueID}`,
+      'for humans': `${thisHost}/reportIssue/${timeStamp}/${jobID}/${issueID}`
+    }
   };
 };
 // Returns a response to a target-issues request.
 exports.response = async args => {
-  const [agentName, timeStamp, jobID] = args;
+  const [agentID, timeStamp, jobID] = args;
   const reportIsHidden = await isHidden(timeStamp, jobID);
   // If the report is not available:
   if (reportIsHidden) {
@@ -61,44 +54,52 @@ exports.response = async args => {
   const {pageData, issuesData} = data;
   const {what, url, daysAgo} = pageData;
   const {issueCount, issues, preventions, reporterCount, reporters, violatorCount} = issuesData;
-  const preventedTools = getToolFacts(Object.keys(preventions));
-  preventedTools.forEach(preventedTool => {
-    preventedTool['reason for failure'] = preventions[preventedTool.identifier];
-  });
+  const preventedTools = Object.entries(preventions).map(prevention => ({
+    name: tools[prevention[0]][0],
+    'reason for failure': prevention[1]
+  }));
   const thisHost = process.env.THIS_KILOTEST_HOST;
   // Get a response.
   const response = {
-    summary: `This document fulfills a request made by an agent to Kilotest. The agent requested data from a report produced by Kilotest. The report contains results of tests performed on a web page by an ensemble of tools. The tools use a combination of rule-based and machine-learning-based methods to identify accessibility, usability, and standard-conformity issues. More detailed information about Kilotest is available from its deployed instance, ${process.env.DEPLOYED_KILOTEST_HOST}. which contains an introduction on its home page and a tutorial.`,
+    summary: `This document fulfills a request made by an agent to the Kilotest service. The agent requested data from a Kilotest report about the accessibility, usability, and standard-conformity of a web page. Kilotest, with the help of Testaro, Testilo, and an ensemble of ten testing tools, performs tests on web pages, using a combination of rule- and machine-learning-based methods, and produces reports. Kilotest exposes several API endpoints for agents and several web UI URLs for humans to obtain information from Kilotest reports. To learn more about Kilotest and the advangages of testing with an ensemble of tools, visit the deployed instance of Kilotest (${process.env.DEPLOYED_KILOTEST_HOST}), which contains an introduction on its home page and a tutorial.`,
     'tool name': 'Kilotest',
     request: {
-      'name of requesting agent': agentName,
+      'requesting agent': {
+        identifier: agentID,
+        name: researchAgents[agentID]
+      },
       'type of request': {
         identifier: 'reportIssues',
-        description: 'What issues did Kilotest report in the specified report?'
+        description: 'What issues does the specified report describe?'
+      },
+      'closest ancestor request': {
+        description: 'Which web pages are reports available about, and what are the statistics about the issues reported for each page?',
+        'URL for you': `${thisHost}/api/${agentID}/targets.html`,
+        'URL for humans': `${thisHost}/targets.html`
       }
     },
     'response metadata': {
+      identifier: `${getNowStamp()}-${getRandomString(3)}`,
       'date and time': new Date().toISOString(),
-      'identifier': `${getNowStamp()}-${getRandomString(3)}`
+      'URL of the human-oriented equivalent of this response': `${thisHost}/reportIssues.html/${timeStamp}/${jobID}`
     },
     report: {
       identifier: `${timeStamp}-${jobID}`,
       'creation date': getDateTime(timeStamp),
-      'days since the creation date': daysAgo,
-      'URL for human inspection': `${thisHost}/reportIssues.html/${timeStamp}/${jobID}`
+      'days since the creation date': daysAgo
     },
     'tested web page': {
       description: what,
       URL: url
     },
-    'names of tools that tried to test the page': getToolNamesString(Object.keys(tools)),
+    'tools that tried to test the page': getToolsFacts(Object.keys(tools)),
     'tools that were unable to test the page': preventedTools,
     'tools that reported issues': {
-      'number of tools': reporterCount,
-      'facts about the tools': getToolFacts(reporters.map(tool => tool.toolID))
+      number: reporterCount,
+      names: reporters.map(tool => tool.toolName)
     },
     'number of issues reported': {
-      'total': issueCount,
+      total: issueCount,
       'by priority': {
         'highest priority': issues[4].length,
         'high priority': issues[3].length,
@@ -108,10 +109,14 @@ exports.response = async args => {
     },
     'number of HTML elements reported as exhibiting issues': violatorCount,
     'issues reported': {
-      'highest priority': issues[4].map(issue => getIssueFacts(issue)),
-      'high priority': issues[3].map(issue => getIssueFacts(issue)),
-      'low priority': issues[2].map(issue => getIssueFacts(issue)),
-      'lowest priority': issues[1].map(issue => getIssueFacts(issue))
+      'highest priority': issues[4]
+      .map(issue => getIssueFacts(thisHost, agentID, timeStamp, jobID, issue)),
+      'high priority': issues[3]
+      .map(issue => getIssueFacts(thisHost, agentID, timeStamp, jobID, issue)),
+      'low priority': issues[2]
+      .map(issue => getIssueFacts(thisHost, agentID, timeStamp, jobID, issue)),
+      'lowest priority': issues[1]
+      .map(issue => getIssueFacts(thisHost, agentID, timeStamp, jobID, issue))
     }
   };
   return response;

package/reportIssues/util.js

@@ -5,29 +5,13 @@
 
 // IMPORTS
 
-const {getPageData, getReport, isValidReport, objectSort, tools} = require('../util');
+const {
+  getPageData, getReport, getToolsData, getToolList, isValidReport, objectSort
+} = require('../util');
 const issuesClassification = require('testilo/procs/score/tic').issues;
 
 // FUNCTIONS
 
-// Converts tool IDs to tool data sorted by tool name.
-const getToolData = exports.getToolData = toolIDs => objectSort(
-  Array.from(toolIDs).map(toolID => {
-    const toolData = tools[toolID];
-    return {
-      toolID,
-      toolName: toolData[0],
-      toolMaker: toolData[1]
-    }
-  }),
-  'toolName',
-  'alpha'
-);
-// Returns a +-delimited list of sorted tool names.
-const getToolList = toolIDs => Array.from(toolIDs)
-.map(toolID => tools[toolID][0])
-.sort((a, b) => a.localeCompare(b, 'en', {sensitivity: 'base'}))
-.join(' + ');
 // Returns data on the issues reported by a report.
 const getIssuesData = async (timeStamp, jobID) => {
   // Get the report.
@@ -96,7 +80,7 @@ const getIssuesData = async (timeStamp, jobID) => {
       }
     });
     // Finish populating the final data.
-    final.reporters = getToolData(temp.reporters);
+    final.reporters = getToolsData(temp.reporters);
     final.reporterList = getToolList(temp.reporters);
     final.reporterCount = final.reporters.length;
     final.violatorCount = temp.violators.size;
@@ -109,7 +93,7 @@ const getIssuesData = async (timeStamp, jobID) => {
         why,
         weight
       };
-      finalIssue.reporters = getToolData(issue.reporters);
+      finalIssue.reporters = getToolsData(issue.reporters);
       finalIssue.reporterList = getToolList(issue.reporters);
       finalIssue.reporterCount = finalIssue.reporters.length;
       finalIssue.violatorCount = issue.violators.size;

package/reportsExpungeForm/index.js

@@ -5,7 +5,7 @@
 
 // IMPORTS
 
-const {getTargetData, logsPath, reportsPath} = require('../util');
+const {getReportData, logsPath, reportsPath} = require('../util');
 const fs = require('fs/promises');
 const path = require('path');
 
@@ -43,13 +43,13 @@ 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 getTargetData(timeStamp, jobID);
-    const {issueSet, preventedTools, url} = reportSummary;
+    const reportSummary = await getReportData(timeStamp, jobID);
+    const {issueCount, preventedToolCount, url} = reportSummary;
     reportSpecs.push({
       timeStamp,
       jobID,
-      issueCount: issueSet.size,
-      preventionCount: preventedTools?.length ?? 0,
+      issueCount,
+      preventedToolCount,
       url
     });
   }
@@ -65,9 +65,9 @@ exports.answer = async (_, search) => {
   let anyDeletable = false;
   // For each summary:
   reportSpecs.forEach((spec, index) => {
-    const {timeStamp, jobID, issueCount, preventionCount, url} = spec;
+    const {timeStamp, jobID, issueCount, preventedToolCount, url} = spec;
     const jobName = `${timeStamp}-${jobID}`;
-    const specString = `<code>${url}</code> (<code>${jobName}</code>): preventions ${preventionCount}, issues ${issueCount}`;
+    const specString = `<code>${url}</code> (<code>${jobName}</code>): preventions ${preventedToolCount}, issues ${issueCount}`;
     // If its report is the sole report on a target:
     if (reportSpecs[index - 1]?.url !== url && reportSpecs[index + 1]?.url !== url) {
       // Add a line with a deletion checkbox.

package/reportsPruneForm/index.js

@@ -5,7 +5,7 @@
 
 // IMPORTS
 
-const {getTargetData, logsPath, reportsPath} = require('../util');
+const {getReportData, logsPath, reportsPath} = require('../util');
 const fs = require('fs/promises');
 const path = require('path');
 
@@ -43,13 +43,13 @@ 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 getTargetData(timeStamp, jobID);
-    const {issueSet, preventedTools, url} = reportSummary;
+    const reportSummary = await getReportData(timeStamp, jobID);
+    const {issueCount, preventedToolCount, url} = reportSummary;
     reportSpecs.push({
       timeStamp,
       jobID,
-      issueCount: issueSet.size,
-      preventionCount: preventedTools?.length ?? 0,
+      issueCount,
+      preventedToolCount,
       url
     });
   }
@@ -65,9 +65,9 @@ exports.answer = async (_, search) => {
   let anyDeletable = false;
   // For each summary:
   reportSpecs.forEach((spec, index) => {
-    const {timeStamp, jobID, issueCount, preventionCount, url} = spec;
+    const {timeStamp, jobID, issueCount, preventedToolCount, url} = spec;
     const jobName = `${timeStamp}-${jobID}`;
-    const specString = `<code>${url}</code> (<code>${jobName}</code>): preventions ${preventionCount}, issues ${issueCount}`;
+    const specString = `<code>${url}</code> (<code>${jobName}</code>): preventions ${preventedToolCount}, issues ${issueCount}`;
     // If its report is a non-latest report:
     if (reportSpecs[index + 1]?.url === url) {
       // Add a line with a deletion checkbox.

package/reportsRewindForm/index.js

@@ -5,7 +5,7 @@
 
 // IMPORTS
 
-const {getTargetData, logsPath, reportsPath} = require('../util');
+const {getReportData, logsPath, reportsPath} = require('../util');
 const fs = require('fs/promises');
 const path = require('path');
 
@@ -43,13 +43,13 @@ 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 getTargetData(timeStamp, jobID);
-    const {issueSet, preventedTools, url} = reportSummary;
+    const reportSummary = await getReportData(timeStamp, jobID);
+    const {issueCount, preventedToolCount, url} = reportSummary;
     reportSpecs.push({
       timeStamp,
       jobID,
-      issueCount: issueSet.size,
-      preventionCount: preventedTools?.length ?? 0,
+      issueCount,
+      preventedToolCount,
       url
     });
   }
@@ -65,9 +65,9 @@ exports.answer = async (_, search) => {
   let anyDeletable = false;
   // For each summary:
   reportSpecs.forEach((spec, index) => {
-    const {timeStamp, jobID, issueCount, preventionCount, url} = spec;
+    const {timeStamp, jobID, issueCount, preventedToolCount, url} = spec;
     const jobName = `${timeStamp}-${jobID}`;
-    const specString = `<code>${url}</code> (<code>${jobName}</code>): preventions ${preventionCount}, issues ${issueCount}`;
+    const specString = `<code>${url}</code> (<code>${jobName}</code>): preventions ${preventedToolCount}, issues ${issueCount}`;
     // If its report is the latest report on a target with at least 2 reports:
     if (reportSpecs[index - 1]?.url === url && reportSpecs[index + 1]?.url !== url) {
       // Add a line with a deletion checkbox.

package/researchAgent.js

@@ -9,12 +9,11 @@
 
 /*
   researchAgent.js
-  Module for simulating a research agent.
+  Simulates a research agent.
 */
 
 // IMPORTS
 
-const {getLogs} = require('./util');
 require('dotenv').config();
 const httpClient = require('http');
 const httpsClient = require('https');
@@ -30,22 +29,13 @@ const hostParts = kilotestHost.split(/:\/*/);
 const scheme = hostParts[0];
 const host = hostParts[1];
 const port = hostParts[2] || (scheme === 'https' ? 443 : 80);
-const services = ['reportIssues'];
-// Randomly chosen service.
-const service = services[Math.floor(services.length * Math.random())];
 
 // FUNCTIONS
 
-// Submits a random research request to a random Kilotest host.
+// Submits two request to a random Kilotest host.
 const requestService = async () => {
-  const logs = await getLogs();
-  // Randomly chosen log.
-  const log = logs[Math.floor(logs.length * Math.random())];
-  const specs = log.jobName.split('-').join('/');
-  const path = `/api/${agent}/${service}/${specs}`;
   const client = scheme === 'https' ? httpsClient : httpClient;
-  // Use its job name in the request path.
-  const requestOptions = {
+  const getRequestOptions = path => ({
     method: 'POST',
     host,
     port,
@@ -53,10 +43,11 @@ const requestService = async () => {
     headers: {
       'content-type': 'application/json; charset=utf-8'
     }
-  };
+  });
+  const path = `/api/${agent}/targets`;
   console.log(`About to submit ${scheme} request as JSON on port ${port} to ${host}${path}`);
-  // Submit a request.
-  client.request(requestOptions, response => {
+  // Submit a targets request.
+  client.request(getRequestOptions(path), response => {
     // Initialize a collection of data from the response.
     const chunks = [];
     response
@@ -73,17 +64,62 @@ const requestService = async () => {
     // When the response is completed:
     .on('end', async () => {
       const content = chunks.join('');
-      // Output it.
       try {
-        console.log(JSON.stringify(JSON.parse(content), null, 2));
+        // Output it.
+        const contentObj = JSON.parse(content);
+        console.log('======================');
+        console.log(JSON.stringify(contentObj, null, 2));
+        // Get the IDs of the available reports.
+        const reportIDs = contentObj['available reports'].map(report => report.identifier);
+        // Choose one at random.
+        const [timeStamp, jobID] = reportIDs[Math.floor(Math.random() * reportIDs.length)]
+        .split('-');
+        console.log('======================');
+        const path = `/api/${agent}/reportIssues/${timeStamp}/${jobID}`;
+        console.log(`About to submit ${scheme} request as JSON on port ${port} to ${host}${path}`);
+        const requestOptions = getRequestOptions(path);
+        // Submit an issues request for it.
+        client.request(requestOptions, response => {
+          // Initialize a collection of data from the response.
+          const chunks = [];
+          response
+          // If the response throws an error:
+          .on('error', async error => {
+            // Report it.
+            console.log(error.message);
+          })
+          // If the response delivers data:
+          .on('data', chunk => {
+            // Add them to the collection.
+            chunks.push(chunk);
+          })
+          // When the response is completed:
+          .on('end', async () => {
+            const content = chunks.join('');
+            try {
+              // Output it.
+              const contentObj = JSON.parse(content);
+              console.log(JSON.stringify(contentObj, null, 2));
+              console.log('======================');
+            }
+            catch (error) {
+              console.log(error.message);
+              console.log(`Issues response content: ${content || 'No content'}`);
+            }
+          });
+        })
+        // Finish sending the issues request.
+        .end(JSON.stringify({
+          agentPW
+        }));
       }
       catch (error) {
         console.log(error.message);
-        console.log(`Response content: ${content || 'No content'}`);
+        console.log(`Targets response content: ${content || 'No content'}`);
       }
     });
   })
-  // Finish sending the job request.
+  // Finish sending the targets request.
   .end(JSON.stringify({
     agentPW
   }));

package/targets/api.js

@@ -0,0 +1,101 @@
+/*
+  api.js
+  Responds to the targets request.
+*/
+
+// IMPORTS
+
+const {
+  getLogs,
+  getNowStamp,
+  getRandomString,
+  getReportData,
+  researchAgents
+} = require('../util');
+
+// CONSTANTS
+
+const thisHost = process.env.THIS_KILOTEST_HOST;
+
+// FUNCTIONS
+
+// Returns a response to a targets request.
+exports.response = async agentID => {
+  const availableReports = [];
+  // Get the non-hidden logs.
+  const targetLogs = await getLogs();
+  // For each log:
+  for (const targetLog of targetLogs) {
+    const {jobName} = targetLog;
+    const [timeStamp, jobID] = jobName.split('-');
+    const {superseded, url, what} = targetLog;
+    // Get data about its report.
+    const data = await getReportData(timeStamp, jobID);
+    const {
+      creationDate,
+      daysAgo,
+      issueCount,
+      toolNames,
+      toolCount,
+      reporterNames,
+      reporterCount,
+      violatorCount,
+      preventedToolNames,
+      preventedToolCount
+    } = data;
+    availableReports.push({
+      identifier: jobName,
+      'creation date': creationDate,
+      'days since the creation date': daysAgo,
+      'tested web page': {
+        description: what,
+        URL: url
+      },
+      'whether a later report about the same page exists': !! superseded,
+      'number of issues reported': issueCount,
+      'number of HTML elements reported as exhibiting issues': violatorCount,
+      'tools that tried to test the page': {
+        number: toolCount,
+        names: toolNames
+      },
+      'tools that were unable to test the page': {
+        number: preventedToolCount,
+        names: preventedToolNames
+      },
+      'tools that reported issues': {
+        number: reporterCount,
+        names: reporterNames
+      },
+      'URLs for getting data on the reported issues': {
+        'for you': `${thisHost}/api/${agentID}/reportIssues/${timeStamp}/${jobID}`,
+        'for humans': `${thisHost}/reportIssues/${timeStamp}/${jobID}`
+      },
+      'URL for getting the full technical report as JSON': `${thisHost}/fullReport.html/${timeStamp}/${jobID}`
+    });
+  }
+  // Get a response.
+  const response = {
+    summary: `This document fulfills a request made by an agent to the Kilotest service. The agent requested data about the web pages that Kilotest had tested for accessibility, usability, and standard-conformity and statistics for each page on the results of the tests. Kilotest, with the help of Testaro, Testilo, and an ensemble of ten testing tools, performs tests on web pages, using a combination of rule- and machine-learning-based methods, and produces reports. Kilotest exposes API endpoints for agents and web UI URLs for humans to recommend web pages for testing and obtain information from Kilotest reports. To learn more about Kilotest and the advangages of testing with an ensemble of tools, visit the deployed instance of Kilotest (${process.env.DEPLOYED_KILOTEST_HOST}), whose home page contains an introduction and a link to a tutorial.`,
+    'tool name': 'Kilotest',
+    request: {
+      'requesting agent': {
+        identifier: agentID,
+        name: researchAgents[agentID]
+      },
+      'type of request': {
+        identifier: 'targets',
+        description: 'Give me summary data about each available report.'
+      },
+      URLs: {
+        'URL of this request': `${thisHost}/api/${agentID}/targets`,
+        'equivalent URL for humans': `${thisHost}/targets.html`
+      }
+    },
+    'response metadata': {
+      identifier: `${getNowStamp()}-${getRandomString(3)}`,
+      'date and time': new Date().toISOString(),
+    },
+    'available reports': availableReports
+  };
+  return response;
+};

package/targets/index.js

@@ -7,13 +7,14 @@
 
 const {
   getAgoDays,
+  getCountString,
   getJobNames,
   getObject,
   getPageDataStrings,
   getRecs,
   getToolNamesString,
   getLogs,
-  getTargetData,
+  getReportData,
   isRecommendable,
   jobsPath
 } = require('../util');
@@ -22,8 +23,6 @@ const path = require('path');
 
 // FUNCTIONS
 
-// Returns a description of a tool count.
-const getToolCountString = toolCount => toolCount === 1 ? '1 tool' : `${toolCount} tools`;
 // Adds parameters to a query for the answer page.
 const populateQuery = async query => {
   const margin = ' '.repeat(8);
@@ -71,19 +70,26 @@ const populateQuery = async query => {
   query.noQueued = lines.queue.length ? '' : 'No pages are queued for testing.';
   // Add a no-claimed message, if applicable, to the query.
   query.noClaimed = lines.claimed.length ? '' : 'No pages are being tested now.';
-  // Get the logs of the reports.
-  const targetLogs = (await getLogs()).filter(log => ! log.hidden);
+  // Get the logs of the non-hidden reports.
+  const targetLogs = await getLogs();
   query.which = targetLogs.length ? 'the following' : 'no';
   query.some = (targetLogs.length || jobFileNames.queue.length || jobFileNames.claimed.length)
   ? 'another'
   : 'a';
   const multiReportTargets = new Set(targetLogs.filter(log => log.superseded).map(log => log.what));
-  // For each log that is not hidden:
+  // For each log:
   for (const targetLog of targetLogs) {
     const {jobName, url, what} = targetLog;
     const [timeStamp, jobID] = jobName.split('-');
-    const reportData = await getTargetData(timeStamp, jobID);
-    const {issueSet, preventedTools, reporterSet, violatorSet} = reportData;
+    const reportData = await getReportData(timeStamp, jobID);
+    const {
+      issueCount,
+      preventedToolCount,
+      preventedToolNames,
+      reporterNames,
+      reporterCount,
+      violatorCount
+    } = reportData;
     lines.tested.push(`${margin}<details>`);
     const daysAgo = getAgoDays(timeStamp);
     const pageDataStrings = await getPageDataStrings(timeStamp, jobID, {what, url, daysAgo});
@@ -96,38 +102,32 @@ const populateQuery = async query => {
     // Add facts about the report to the lines.
     lines.tested.push(`${margin}    <li>${testInfo}</li>`);
     // If the page prevented any tool from performing its tests:
-    if (preventedTools?.length) {
+    if (preventedToolCount) {
       // Add this to the lines.
-      const preventedToolSet = new Set(preventedTools);
-      const toolCountString = getToolCountString(preventedToolSet.size);
-      const toolsString = getToolNamesString(preventedToolSet);
+      const toolCountString = getCountString(preventedToolCount, 'tool', 'tools');
       lines.tested.push(
-        `${margin}    <li>Page not testable by ${toolCountString} (${toolsString})</li>`,
+        `${margin}    <li>Page not testable by ${toolCountString} (${preventedToolNames.join(' + ')})</li>`,
       );
     }
     // Add facts about the test results to the lines.
-    const reporterCount = reporterSet.size;
-    const reporterCountString = getToolCountString(reporterCount);
-    let reporterString = reporterCountString;
+     let reporterString = `${getCountString(reporterCount, 'tool', 'tools')} reported issues`;
     if (reporterCount) {
-      const reporterNamesString = getToolNamesString(reporterSet);
-      reporterString = `${reporterCountString} (${reporterNamesString})`;
+      const reporterNamesString = reporterNames.join(' + ');
+      reporterString = `${reporterString} (${reporterNamesString})`;
     }
-    const issueCountString = issueSet.size === 1 ? '1 issue was' : `${issueSet.size} issues were`;
-    const violatorString = violatorSet.size === 1
-    ? '1 violator was'
-    : `${violatorSet.size} violators were`;
-    lines.tested.push(`${margin}    <li>${reporterString} reported issues</li>`);
+    const issueCountString = getCountString(issueCount, 'issue was', 'issues were');
+    const violatorString = getCountString(violatorCount, 'violator was', 'violators were');
+    lines.tested.push(`${margin}    <li>${reporterString}</li>`);
     lines.tested.push(`${margin}    <li>${issueCountString} reported</li>`);
     lines.tested.push(`${margin}    <li>${violatorString} reported</li>`);
     lines.tested.push(`${margin}  </ul>`);
     lines.tested.push(`${margin}<ul class="nav">`);
     // If any issues were reported:
-    if (issueSet.size) {
+    if (issueCount) {
       // Add a question link about the reported issues to the lines.
       const href = `href="reportIssues.html/${timeStamp}/${jobID}"`;
       const label = `aria-label="What ${issueCountString} reported for the ${what} page?"`;
-      const questionString = issueSet.size === 1 ? 'was the issue' : 'were the issues';
+      const questionString = issueCount === 1 ? 'was the issue' : 'were the issues';
       const link = `<a ${href} ${label}>What ${questionString}?</a>`;
       lines.tested.push(`${margin}    <li>${link}</li>`);
     }

package/util.js

@@ -6,7 +6,7 @@
 // IMPORTS
 
 const {sendAlert} = require('./alerts');
-const {issues} = require('testilo/procs/score/tic');
+const issuesClassification = require('testilo/procs/score/tic').issues;
 const fs = require('fs/promises');
 const path = require('path');
 const querystring = require('querystring');
@@ -34,9 +34,16 @@ const tools = exports.tools = {
   nuVnu: ['Html Checker', 'World Wide Web Consortium'],
   qualWeb: ['QualWeb', 'University of Lisbon'],
   testaro: ['Testaro', 'CVS Health'],
-  wax: ['WallyAX', 'Wally'],
   wave: ['WAVE', 'Utah State University'],
+<<<<<<< HEAD
+  wax: ['WallyAX', 'Wally']
+=======
+  wax: ['WAX', 'Wally']
+>>>>>>> api3
 };
+exports.researchAgents = {
+  'research-agent': 'Internal Research Agent'
+}
 
 // FUNCTIONS
 
@@ -144,7 +151,7 @@ const alphaCompare = (a, b) => a.localeCompare(b, 'en', {sensitivity: 'base'});
 // Sorts strings alphabetically and case-insensitively.
 const alphaSort = strings => strings.sort((a, b) => alphaCompare(a, b));
 // Sorts objects by a property value.
-exports.objectSort = (objects, property, sortType) => objects
+const objectSort = exports.objectSort = (objects, property, sortType) => objects
 .sort((a, b) => {
   // If the property values are numbers to be sorted in increasing order:
   if (sortType === 'numericUp') {
@@ -172,8 +179,8 @@ const getRuleIDs = exports.getRuleIDs = () => {
   // Initialize a validity checker.
   const validityChecker = {};
   // For each classified issue:
-  Object.keys(issues).forEach(issueID => {
-    const {tools, weight} = issues[issueID];
+  Object.keys(issuesClassification).forEach(issueID => {
+    const {tools, weight} = issuesClassification[issueID];
     // If the weight is invalid:
     if (weight < 1 || weight > 4) {
       // Report this.
@@ -322,9 +329,9 @@ exports.isHidden = async (timeStamp, jobID) => {
   }
   return !! log.hidden;
 };
-// Returns summary data on the results in a report.
-exports.getTargetData = async (timeStamp, jobID) => {
-  // Vasidate the report and annotate it if necessary.
+// Returns summary data on a report.
+exports.getReportData = async (timeStamp, jobID) => {
+  // Validate the report and annotate it if necessary.
   const log = await getLog(timeStamp, jobID, true);
   // If this failed:
   if (typeof log === 'string') {
@@ -335,12 +342,22 @@ exports.getTargetData = async (timeStamp, jobID) => {
   const data = {
     what: log.what,
     url: log.url,
-    issueSet: new Set(),
-    reporterSet: new Set(),
-    violatorSet: new Set(),
-    preventedTools: {}
+    jobName: `${timeStamp}-${jobID}`,
+    creationDate: getDateTime(timeStamp),
+    daysAgo: getAgoDays(timeStamp),
+    issueCount: 0,
+    toolNames: [],
+    toolCount: 0,
+    reporterNames: [],
+    reporterCount: 0,
+    violatorCount: 0,
+    preventedToolNames: [],
+    preventedToolCount: 0
   };
-  const {issueSet, reporterSet, violatorSet} = data;
+  const issueIDSet = new Set();
+  const toolNameSet = new Set();
+  const reporterIDSet = new Set();
+  const violatorIndexSet = new Set();
   // Get the report.
   const report = await getReport(timeStamp, jobID);
   // If this failed:
@@ -353,27 +370,44 @@ exports.getTargetData = async (timeStamp, jobID) => {
     // If it is a test act:
     if (act.type === 'test') {
       const {result, which} = act;
+      // Ensure that the tool is in the temporary data.
+      toolNameSet.add(which);
       const instances = result?.standardResult?.instances ?? [];
-      // For each standard instance:
+      // For each standard instance of the act:
       instances.forEach(instance => {
         const {catalogIndex, issueID} = instance;
         // If it has a non-ignorable classified issue ID:
-        if (issueID && issues[issueID] && issueID !== 'ignorable') {
-          // Ensure that the tool is in the data.
-          reporterSet.add(which);
-          // Ensure that the issue is in the data.
-          issueSet.add(issueID);
-          // If it has a catalog index:
+        if (issueID && issuesClassification[issueID] && issueID !== 'ignorable') {
+          // Ensure that the tool is in the temporary data.
+          reporterIDSet.add(which);
+          // Ensure that the issue is in the temporary data.
+          issueIDSet.add(issueID);
+          // If the violator has a catalog index:
           if (catalogIndex) {
-            // Ensure that the violator is in the data.
-            violatorSet.add(catalogIndex);
+            // Ensure that the violator is in the temporary data.
+            violatorIndexSet.add(catalogIndex);
           }
         }
       });
     }
   });
-  // Add the IDs of any prevented tools to the data.
-  data.preventedTools = Object.keys(report.jobData?.preventions || {});
+  // Populate the data with the act data.
+  data.issueCount = issueIDSet.size;
+  data.toolNames = Array
+  .from(toolNameSet)
+  .sort((a, b) => a.localeCompare(b, 'en', {sensitivity: 'base'}));
+  data.toolCount = toolNameSet.size;
+  data.reporterNames = Array
+  .from(reporterIDSet)
+  .map(id => tools[id][0])
+  .sort((a, b) => a.localeCompare(b, 'en', {sensitivity: 'base'}));
+  data.reporterCount = data.reporterNames.length;
+  data.violatorCount = violatorIndexSet.size;
+  // Add the names of any prevented tools to the data.
+  data.preventedToolNames = Object.keys(report.jobData?.preventions || {})
+  .map(toolID => tools[toolID][0])
+  .sort((a, b) => a.localeCompare(b, 'en', {sensitivity: 'base'}));
+  data.preventedToolCount = data.preventedToolNames.length;
   // Return the data.
   return data;
 }
@@ -478,7 +512,7 @@ const getRecs = exports.getRecs = async () => {
 };
 // Returns a string of tool names.
 exports.getToolNamesString = toolIDSet =>
-  alphaSort(Array.from(toolIDSet).map(toolID => tools[toolID][0])).join(' + ');
+  alphaSort(Array.from(toolIDSet).map(toolID => tools[toolID]?.[0] || toolID)).join(' + ');
 // Converts a catalog item text to a text-fragment link destination.
 exports.getTextFragmentHref = (text, url) => {
   const fragmentList = text
@@ -488,7 +522,7 @@ exports.getTextFragmentHref = (text, url) => {
   // Return a text-fragment link.
   return `${url}#:~:text=${fragmentList}`;
 };
-// Returns an array of the logs, with job names added, of the non-hidden reports.
+// Returns a sorted array of the logs, with job names added, of the non-hidden reports.
 exports.getLogs = async () => {
   // Initialize data on the tested targets.
   const logs = [];
@@ -652,7 +686,7 @@ exports.getWCAGLink = numericID => {
   // Return the link.
   return `https://www.w3.org/WAI/WCAG22/Understanding/${wcagMap[numericID]}`;
 };
-// Gets page data from a report.
+// Returns page data from a report.
 const getPageData = exports.getPageData = async (timeStamp, jobID) => {
   // Get the log of the report.
   const log = await getLog(timeStamp, jobID, false);
@@ -673,7 +707,7 @@ const getPageData = exports.getPageData = async (timeStamp, jobID) => {
 };
 // Gets HTML strings for page data from a report.
 exports.getPageDataStrings = async (timeStamp, jobID, pageData) => {
-  // If the paga data were not specified:
+  // If the page data were not specified:
   if (! pageData) {
     // Get them.
     pageData = await getPageData(timeStamp, jobID);
@@ -688,3 +722,35 @@ exports.getPageDataStrings = async (timeStamp, jobID, pageData) => {
     testInfo: `Tested ${daysAgo} days ago by job <code>${jobID}</code> on ${when}`
   };
 };
+// Returns tool data sorted by tool name.
+const getToolsData = exports.getToolsData = toolIDs => objectSort(
+  Array.from(toolIDs).map(toolID => {
+    const toolData = tools[toolID];
+    return {
+      toolID,
+      toolName: toolData[0],
+      toolMaker: toolData[1]
+    }
+  }),
+  'toolName',
+  'alpha'
+);
+// Returns a +-delimited list of sorted tool names.
+exports.getToolList = toolIDs => Array.from(toolIDs)
+.map(toolID => tools[toolID][0])
+.sort((a, b) => a.localeCompare(b, 'en', {sensitivity: 'base'}))
+.join(' + ');
+// Returns facts about tools.
+exports.getToolsFacts = toolIDs => {
+  const crypticData = getToolsData(toolIDs);
+  return crypticData.map(tool => {
+    const {toolID, toolName, toolMaker} = tool;
+    return {
+      identifier: toolID,
+      name: toolName,
+      sponsor: toolMaker
+    };
+  });
+};
+// Returns a string describing a count.
+exports.getCountString = (count, singular, plural) => count === 1 ? `1 ${singular}` : `${count} ${plural}`;