@jrpool/kilotest 25.0.0 → 25.0.1

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
 
@@ -589,8 +586,7 @@ const requestHandler = async (request, response) => {
         if (service === 'reportIssues') {
           // Get the 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) {

package/package.json

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

package/reportIssues/api.js

@@ -10,8 +10,8 @@ const {
   getDateTime,
   getNowStamp,
   getRandomString,
-  getToolNamesString,
   isHidden,
+  researchAgents,
   tools
 } = require('../util');
 
@@ -30,24 +30,28 @@ const getToolFacts = toolIDs => {
   });
 };
 // 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 +65,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': getToolFacts(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 +120,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/util.js

@@ -34,9 +34,11 @@ 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'],
 };
+exports.researchAgents = {
+  'research-agent': 'Internal Research Agent'
+}
 
 // FUNCTIONS