testilo 13.1.1 → 13.2.0

package/call.js

@@ -117,7 +117,8 @@ const callScore = async (scorerID, selector = '') => {
       // Save it.
       await fs.writeFile(`${scoredReportDir}/${report.id}.json`, JSON.stringify(report, null, 2));
     };
-  }
+    console.log(`Reports scored and saved in ${scoredReportDir}`);
+    }
   // Otherwise, i.e. if no raw reports are to be scored:
   else {
     // Report this.
@@ -132,17 +133,16 @@ const callDigest = async (digesterID, selector = '') => {
   if (reports.length) {
     const digesterDir = `${functionDir}/digest/${digesterID}`;
     // Get the digester.
-    const digester = require(`${digesterDir}/index`).makeQuery;
-    // Get the template.
-    const template = await fs.readFile(`${digesterDir}/index.html`, 'utf8');
+    const {digester} = require(`${digesterDir}/index`);
     // Digest the reports.
-    const digestedReports = digest(template, digester, reports);
+    const digestedReports = await digest(digester, reports);
     const digestedReportDir = `${reportDir}/digested`;
     // For each digested report:
     for (const reportID of Object.keys(digestedReports)) {
       // Save it.
       await fs.writeFile(`${digestedReportDir}/${reportID}.html`, digestedReports[reportID]);
     };
+    console.log(`Reports digested and saved in ${digestedReportDir}`);
   }
   // Otherwise, i.e. if no scored reports are to be digested:
   else {

package/digest.js

@@ -9,16 +9,16 @@
 // ########## FUNCTIONS
 
 // Digests the scored reports and returns them, digested.
-exports.digest = (digester, reports) => {
+exports.digest = async (digester, reports) => {
   const digests = {};
   // For each report:
-  reports.forEach(report => {
+  for (const report of reports) {
     // Use it to create a digest.
-    const digestedReport = digester(report);
+    const digestedReport = await digester(report);
     // Add the digest to the array of digests.
     digests[report.id] = digestedReport;
     console.log(`Report ${report.id} digested`);
-  });
+  };
   // Return the digests.
   console.log(`Digesting complete. Report count: ${reports.length}`);
   return digests;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testilo",
-  "version": "13.1.1",
+  "version": "13.2.0",
   "description": "Client that scores and digests Testaro reports",
   "main": "aim.js",
   "scripts": {

package/procs/digest/tdp27/index.html

@@ -22,7 +22,7 @@
           <tr><th>URL</th><td>__url__</td></tr>
           <tr><th>Requester</th><td>__requester__</td></tr>
           <tr><th>Test date</th><td>__dateSlash__</td></tr>
-          <tr><th>Score</th><td>__totalScore__</td></tr>
+          <tr><th>Score</th><td>__total__</td></tr>
           <tr><th>Tested by</th><td>Testaro, procedure <code>__ts__</code></td></tr>
           <tr><th>Scored by</th><td>Testilo, procedure <code>__sp__</code></td></tr>
           <tr><th>Digested by</th><td>Testilo, procedure <code>__dp__</code></td></tr>
@@ -31,18 +31,22 @@
       <h2>Introduction</h2>
       <p>This is a digest of results from a battery of accessibility tests.</p>
       <p>The battery includes about 1350 tests drawn from ten different packages: Alfa, Axe, Continuum, Equal Access, HTML CodeSniffer, Nu Html Checker, QualWeb, Tenon, Testaro, and WAVE.</p>
-      <p>These tests were run on the web page named above and gave the page a score of __totalScore__, where 0 would be <q>perfect</q>.</p>
-      <h2>Score summary</h2>
+      <p>These tests were run on the web page named above and gave the page a score of __total__, where 0 would be <q>perfect</q>.</p>
+      <h2>Scores</h2>
       <table class="allBorder secondCellRight">
         <caption>Score summary</caption>
         <thead>
           <tr><th>Component</th><th>Score</th></tr>
         </thead>
         <tbody class="headersLeft">
-          __summaryRows__
+          <tr><th>total</th><td>__total__</td></tr>
+          <tr><th>issue</th><td>__issue__</td></tr>
+          <tr><th>tool</th><td>__tool__</td></tr>
+          <tr><th>prevention</th><td>__prevention__</td></tr>
+          <tr><th>log</th><td>__log__</td></tr>
+          <tr><th>latency</th><td>__latency__</td></tr>
         </tbody>
       </table>
-      <h2>Issue scores</h2>
       <table class="allBorder secondCellRight">
         <caption>Issue scores</caption>
         <thead>

package/procs/digest/tdp27/index.js

@@ -2,7 +2,10 @@
 
 // IMPORTS
 
+// Issue classification
 const {issueClasses} = require('../../score/tic27');
+// Function to process files.
+const fs = require('fs/promises');
 
 // CONSTANTS
 
@@ -23,10 +26,10 @@ const htmlEscape = textOrNumber => textOrNumber
 // Gets a row of the score-summary table.
 const getScoreRow = (componentName, score) => `<tr><th>${componentName}</th><td>${score}</td></tr>`;
 // Adds parameters to a query for a digest.
-const makeQuery = (report, query) => {
+const populateQuery = (report, query) => {
   const {sources, jobData, score} = report;
   const {script, target, requester} = sources;
-  const {scoreProcID, summary, issues} = score;
+  const {scoreProcID, summary, details} = score;
   const {total} = summary;
   query.ts = script;
   query.sp = scoreProcID;
@@ -37,15 +40,10 @@ const makeQuery = (report, query) => {
   query.org = target.what;
   query.url = target.which;
   query.requester = requester;
-  // Add the total score to the query.
-  if (typeof total === 'number') {
-    query.totalScore = total;
-  }
-  else {
-    console.log('ERROR: missing or invalid total score');
-    return;
-  }
-  // Get rows for a score-summary table.
+  // Add values for the score-summary table to the query.
+  ['total', 'issue', 'tool', 'prevention', 'log', 'latency'].forEach(sumItem => {
+    query[sumItem] = summary[sumItem];
+  });
   const rows = {
     summaryRows: [],
     issueRows: []
@@ -57,8 +55,8 @@ const makeQuery = (report, query) => {
     }
   });
   // Get rows for an issue-score table.
-  Object.keys(issues).forEach(issueID => {
-    rows.issueRows.push(getScoreRow(issueID, issues[issueID]));
+  Object.keys(details.issue).forEach(issueID => {
+    rows.issueRows.push(getScoreRow(issueID, details.issue[issueID].score));
   });
   // Add the rows to the query.
   ['summaryRows', 'issueRows'].forEach(rowType => {
@@ -66,13 +64,13 @@ const makeQuery = (report, query) => {
   });
   // Add paragraphs about the issues to the query.
   const issueSummaryItems = [];
-  Object.keys(issues).forEach(issueID => {
+  Object.keys(details.issue).forEach(issueID => {
     const issueHeading = `<h4>Issue ${issueID}</h4>`;
     const wcagP = `<p>WCAG: ${issueClasses[issueID].wcag || 'N/A'}</p>`;
-    const scoreP = `<p>Score: ${issues[issueID]}</p>`;
+    const scoreP = `<p>Score: ${details.issue[issueID]}</p>`;
     const issueIntroP = '<p>Issue reports in this category:</p>';
     const issueListItems = [];
-    const issueData = issueDetails.issues[issueName];
+    const issueData = details.issue[issueID];
     const toolIDs = Object.keys(issueData.tools);
     toolIDs.forEach(toolID => {
       const testIDs = Object.keys(issueData.tools[toolID]);
@@ -100,7 +98,8 @@ const makeQuery = (report, query) => {
 // Returns a digested report.
 exports.digester = async report => {
   // Create a query to replace plateholders.
-  const query = makeQuery(report, {});
+  const query = {};
+  populateQuery(report, query);
   // Get the template.
   let template = await fs.readFile(`${__dirname}/index.html`, 'utf8');
   // Replace its placeholders.

package/procs/score/tsp27.js

@@ -81,9 +81,14 @@ exports.scorer = report => {
       const {summary, details} = score;
       // For each test act:
       testActs.forEach(act => {
-        // If a successful standard result exists:
+        // If the page prevented the tool from operating:
         const {which, standardResult} = act;
-        if (
+        if (standardResult.prevented) {
+          // Add this to the score.
+          details.prevention[which] = preventionWeight;
+        }
+        // Otherwise, if a successful standard result exists:
+        else if (
           standardResult
           && standardResult.totals
           && standardResult.totals.length === 4
@@ -105,6 +110,8 @@ exports.scorer = report => {
               const issueID = issueIndex[which][ruleID];
               if (! details.issue[issueID]) {
                 details.issue[issueID] = {
+                  score: 0,
+                  maxCount: 0,
                   weight: issueClasses[issueID].weight,
                   tools: {}
                 };
@@ -144,17 +151,29 @@ exports.scorer = report => {
         }
         // Otherwise, i.e. if no successful standard result exists:
         else {
-          // Add a prevented result to the act if not already there.
-          if (! act.result) {
-            act.result = {};
-          }
-          if (! act.result.prevented) {
-            act.result.prevented = true;
-          };
-          // Add the tool and the prevention score to the score.
+          // Add an inferred prevention to the score.
           details.prevention[which] = preventionWeight;
         }
       });
+      // For each issue with any complaints:
+      Object.keys(details.issue).forEach(issueID => {
+        const issueData = details.issue[issueID];
+        // For each tool with any complaints for the issue:
+        Object.keys(issueData.tools).forEach(toolID => {
+          // Get the sum of the weighted counts of its issue rules.
+          let weightedCount = 0;
+          Object.values(issueData.tools[toolID]).forEach(ruleData => {
+            weightedCount += ruleData.quality * ruleData.complaints.countTotal;
+          });
+          // If the sum exceeds the existing maximum weighted count for the issue:
+          if (weightedCount > issueData.maxCount) {
+            // Change the maximum count for the issue to the sum.
+            issueData.maxCount = weightedCount;
+          }
+        });
+        // Get the score for the issue.
+        issueData.score = issueData.weight * issueData.maxCount;
+      });
       // Add the severity detail totals to the score.
       details.severity.total = Object.keys(details.severity.byTool).reduce((severityTotals, toolID) => {
         details.severity.byTool[toolID].forEach((severityScore, index) => {
@@ -163,15 +182,9 @@ exports.scorer = report => {
         return severityTotals;
       }, details.severity.total);
       // Add the summary issue total to the score.
-      Object.keys(details.issue).forEach(issueID => {
-        Object.keys(details.issue[issueID].tools).forEach(toolID => {
-          Object.keys(details.issue[issueID].tools[toolID]).forEach(ruleID => {
-            summary.issue += details.issue[issueID].weight
-            * details.issue[issueID].tools[toolID][ruleID].quality
-            * details.issue[issueID].tools[toolID][ruleID].complaints.countTotal;
-          });
-        });
-      });
+      summary.issue = Object
+      .values(details.issue)
+      .reduce((total, current) => total + current.score, 0);
       // Add the summary tool total to the score.
       summary.tool = toolWeight * details.severity.total.reduce(
         (total, current, index) => total + severityWeights[index] * current, 0