@jrpool/kilotest 37.1.0 → 38.1.0

package/reportIssue/index.js

@@ -1,6 +1,6 @@
 /*
   index.js
-  Answers the diagnoses question.
+  Answers the reportIssue question.
 */
 
 // IMPORTS
@@ -25,10 +25,26 @@ const path = require('path');
 
 // Adds parameters to a query for the answer page.
 const populateQuery = async (issueID, timeStamp, jobID, query) => {
-  // Add facts about the issue to the query.
-  query.issue = issues[issueID].summary;
+  // Get descriptions of the page facts.
   const pageDataStrings = await getPageDataStrings(timeStamp, jobID);
-  const {what, url, urlLink, testInfo} = pageDataStrings;
+  // If this failed:
+  if (pageDataStrings.error) {
+    // Populate the query with the reason.
+    query.error = pageDataStrings.error;
+    // Stop populating the query.
+    return;
+  }
+  // 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) {
+    // Populate the query with the reason.
+    query.error = 'Issue not found';
+    // Stop populating the query.
+    return;
+  }
+  const {testInfo, url, urlLink, what} = pageDataStrings;
+  // Add page facts to the query.
   query.target = what;
   query.urlLink = urlLink;
   query.testInfo = testInfo;
@@ -44,6 +60,14 @@ const populateQuery = async (issueID, timeStamp, jobID, query) => {
   // Get the report.
   const report = await getReport(timeStamp, jobID);
   const {acts, catalog} = report;
+  // If this failed:
+  if (report.error) {
+    // Populate the query with the reason.
+    query.error = report.error;
+    // Stop populating the query.
+    return;
+  }
+  // Otherwise, i.e. if it succeeded, get the test acts of the report.
   const testActs = acts.filter(act => act.type === 'test');
   // For each test act:
   testActs.forEach(act => {
@@ -159,7 +183,15 @@ exports.answer = async pageArgs => {
   const query = {};
   // Create a query to replace the placeholders.
   await populateQuery(issueID, timeStamp, jobID, query);
-  // If the test specifications are valid:
+  // If this failed:
+  if (query.error) {
+    // Return the error.
+    return {
+      status: 'error',
+      message: query.error
+    };
+  }
+  // Otherwise, if it succeeded and the report facts were obtained:
   if (query.testInfo) {
     // Get the template.
     let answerPage = await fs.readFile(path.join(__dirname, 'index.html'), 'utf8');
@@ -173,9 +205,9 @@ exports.answer = async pageArgs => {
       answerPage
     };
   }
-  // Otherwise, report this.
+  // Otherwise, i.e. if the report facts were not obtained, report this.
   return {
     status: 'error',
-    message: 'Invalid report specification'
+    message: 'Report facts not obtained'
   };
 };

package/reportIssues/index.js

@@ -24,20 +24,24 @@ const populateQuery = async (timeStamp, jobID, query) => {
   // Get data on the target and its issues according to the report.
   const data = await getData(timeStamp, jobID);
   const {pageData, issuesData} = data;
-  // If the page data are invalid:
-  if (typeof pageData === 'string') {
-    // Return this.
-    return pageData;
+  // If this failed:
+  if (data.error) {
+    // Populate the query with the reason.
+    query.error = data.error;
+    // Stop populating the query.
+    return;
   }
-  // Otherwise, if the issues data are invalid:
-  if (typeof issuesData === 'string') {
-    // Return this.
-    return issuesData;
-  }
-  // Otherwise, get fact descriptions for the target.
+  // Otherwise, i.e. if it succeeded, get fact descriptions for the target.
   const pageInfo = await getPageDataStrings(timeStamp, jobID, pageData);
-  const {what, urlLink, testInfo} = pageInfo;
-  // Add target data to the query.
+  const {testInfo, urlLink, what} = pageInfo;
+  // If this failed:
+  if (pageInfo.error) {
+    // Populate the query with the reason.
+    query.error = pageInfo.error;
+    // Stop populating the query.
+    return;
+  }
+  // Otherwise, i.e. if it succeeded, add target data to the query.
   query.target = what;
   query.urlLink = urlLink;
   query.testInfo = testInfo;
@@ -154,7 +158,15 @@ exports.answer = async pageArgs => {
   const query = {};
   // Create a query to replace the placeholders.
   await populateQuery(timeStamp, jobID, query);
-  // If the report facts were obtained:
+  // If this failed:
+  if (query.error) {
+    // Return the error.
+    return {
+      status: 'error',
+      message: query.error
+    };
+  }
+  // Otherwise, if it succeeded and the report facts were obtained:
   if (query.testInfo) {
     // Get the template.
     let answerPage = await fs.readFile(path.join(__dirname, 'index.html'), 'utf8');
@@ -171,6 +183,6 @@ exports.answer = async pageArgs => {
   // Otherwise, i.e. if they were not obtained, report this.
   return {
     status: 'error',
-    message: 'Report processing failed'
+    message: 'Report facts not obtained'
   };
 };

package/reportIssues/util.js

@@ -6,7 +6,7 @@
 // IMPORTS
 
 const {
-  getPageData, getReport, getToolsData, getToolList, isValidReport, objectSort
+  getPageData, getReport, getToolsData, getToolList, isHidden, isValidReport, objectSort
 } = require('../util');
 const issuesClassification = require('testilo/procs/score/tic').issues;
 
@@ -16,7 +16,12 @@ const issuesClassification = require('testilo/procs/score/tic').issues;
 const getIssuesData = async (timeStamp, jobID) => {
   // Get the report.
   const report = await getReport(timeStamp, jobID);
-  // If it is valid:
+  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 = {
@@ -110,10 +115,24 @@ const getIssuesData = async (timeStamp, jobID) => {
     // Return the data.
     return final;
   }
-  // Otherwise, i.e. if it is invalid, return this.
-  return 'ERROR: Report missing or invalid.';
+  // 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.
+exports.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
+  };
 };
-exports.getData = async (timeStamp, jobID) => ({
-  pageData: await getPageData(timeStamp, jobID),
-  issuesData: await getIssuesData(timeStamp, jobID)
-});

package/reportUnhideForm/index.js

@@ -22,7 +22,15 @@ exports.answer = async (_, search) => {
     if (authCode === process.env.AUTH_CODE) {
       // Get the log of the report.
       const log = await getLog(... jobName.split('-'));
-      // Reverse the hiddenness property of the log.
+      // If this failed:
+      if (log.error) {
+        // Return why.
+        return {
+          status: 'error',
+          message: log.error
+        }
+      }
+      // 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));
@@ -37,13 +45,23 @@ 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 {what, hidden} = log;
+    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({
       what,
       timeStamp,

package/reportsExpungeForm/index.js

@@ -44,7 +44,15 @@ exports.answer = async (_, search) => {
     const [timeStamp, jobID] = reportName.slice(0, -5).split('-');
     // Get a summary of it.
     const reportSummary = await getReportData(timeStamp, jobID);
-    const {issueCount, preventedToolCount, url} = reportSummary;
+    const {error, issueCount, preventedToolCount, url} = reportSummary;
+    // If this failed:
+    if (error) {
+      // Return why.
+      return {
+        status: 'error',
+        message: error
+      }
+    }
     reportSpecs.push({
       timeStamp,
       jobID,

package/reportsPruneForm/index.js

@@ -38,13 +38,23 @@ exports.answer = async (_, search) => {
     }
   }
   const reportNames = await fs.readdir(reportsPath);
+  // Initialize an array of report summaries.
   const reportSpecs = [];
   // For each report:
   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 {issueCount, preventedToolCount, url} = reportSummary;
+    const {error, issueCount, preventedToolCount, url} = reportSummary;
+    // If this failed:
+    if (error) {
+      // Return why.
+      return {
+        status: 'error',
+        message: error
+      }
+    }
+    // Otherwise, i.e. if it succeeded, add the summary to the array.
     reportSpecs.push({
       timeStamp,
       jobID,

package/reportsRewindForm/index.js

@@ -44,7 +44,15 @@ exports.answer = async (_, search) => {
     const [timeStamp, jobID] = reportName.slice(0, -5).split('-');
     // Get a summary of it.
     const reportSummary = await getReportData(timeStamp, jobID);
-    const {issueCount, preventedToolCount, url} = reportSummary;
+    const {error, issueCount, preventedToolCount, url} = reportSummary;
+    // If this failed:
+    if (error) {
+      // Return why.
+      return {
+        status: 'error',
+        message: error
+      }
+    }
     reportSpecs.push({
       timeStamp,
       jobID,

package/researchAgent.js

@@ -80,11 +80,10 @@ const getRequestOptions = (path, method = 'GET') => ({
   }
 });
 // Submits a request, returns the response content, and increments the results.
-const submitRequest = async (results, path, method, body = null) => new Promise(resolve => {
+const submitRequest = async (path, method, body = null) => new Promise(resolve => {
   console.log(`Making ${scheme} ${method} request on port ${port} to ${host}${path}`);
   client.request(getRequestOptions(path, method), async response => {
     const responseContent = await getContent(response);
-    results.push(responseContent.error ? 'bad' : 'good');
     resolve(responseContent);
   })
   .on('error', error => {
@@ -104,26 +103,25 @@ const requestService = async () => {
   let jobID;
   let description;
   let url;
-  const results = [];
-  console.log('======================\nRequest 1: Summarize nonexistent reports');
+  console.log('======================\nRequest: Summarize nonexistent reports');
   method = 'POST';
   path = '/api/target';
-  content = await submitRequest(results, path, method, {
-    what: 'oesntuhaesouht',
+  content = await submitRequest(path, method, {
+    description: 'oesntuhaesouht',
     hostname: 'osentuhaoesuht.aoesntuh'
   });
   if (content.error) {
     return;
   }
-  console.log('======================\nRequest 2: List all available reports');
+  console.log('======================\nRequest: List all available reports');
   method = 'GET';
   path = '/api/reportList';
-  content = await submitRequest(results, path, method);
-  reports = content?.['available reports'] ?? [];
+  content = await submitRequest(path, method);
+  reports = content?.['response content'] ?? [];
   if (content.error || ! Array.isArray(reports) || ! reports.length) {
     return;
   }
-  console.log('======================\nRequest 3: Summarize matching reports');
+  console.log('======================\nRequest: Summarize matching reports');
   // Choose one available report at random.
   report = reports[Math.floor(Math.random() * reports.length)];
   ({description, URL: url} = report?.['tested web page'] ?? ['', '']);
@@ -132,61 +130,72 @@ const requestService = async () => {
   }
   method = 'POST';
   path = '/api/target';
-  content = await submitRequest(results, path, method, {
-    what: description,
+  content = await submitRequest(path, method, {
+    description,
     hostname: new URL(url).hostname ?? ''
   });
   if (content.error) {
     return;
   }
-  console.log('======================\nRequest 4: Summarize the issues in a report');
+  console.log('======================\nRequest: Summarize one nonexistent report');
+  [timeStamp, jobID] = ['111111T1111', 'abc'];
+  method = 'GET';
+  path = `/api/reportSummary/${timeStamp}/${jobID}`;
+  content = await submitRequest(path, method);
+  if (! content.message) {
+    return;
+  }
+  console.log('======================\nRequest: Summarize one report');
   [timeStamp, jobID] = report.identifier?.split('-') ?? ['', ''];
   if (! (timeStamp && jobID)) {
     return;
   }
   method = 'GET';
-  path = `/api/reportIssues/${timeStamp}/${jobID}`;
-  content = await submitRequest(results, path, method);
-  if (content.error) {
+  path = `/api/reportSummary/${timeStamp}/${jobID}`;
+  content = await submitRequest(path, method);
+  if (content.message || ! content.summary) {
     return;
   }
-  console.log('======================\nRequest 5: Describe one issue from one report');
-  if (content['number of HTML elements reported as exhibiting issues'] === 0) {
+  console.log('======================\nRequest: Describe one issue from one report');
+  if (content['response content']['number of elements reported as violators'] === 0) {
     console.log('reportIssue request cannot be submitted, because no issues were reported');
   }
   else {
     // Get the issue IDs.
     const issueIDs = Object
-    .values(content['issues reported'])
-    .map(levelIssues => levelIssues.map(issue => issue.identifier))
-    .flat();
+    .values(content['response content']['issues revealed'])
+    .map(issue => issue.identifier);
     // Choose one at random.
     const issueID = issueIDs[Math.floor(Math.random() * issueIDs.length)];
     method = 'GET';
     path = `/api/reportIssue/${issueID}/${timeStamp}/${jobID}`;
-    content = await submitRequest(results, path, method);
-    if (content.error) {
+    content = await submitRequest(path, method);
+    if (content.message) {
       return;
     }
   }
-  console.log('======================\nRequest 6: Make a permitted test recommendation');
+  console.log('======================\nRequest: Make a permitted test recommendation');
   method = 'POST';
   path = '/api/testRecForm';
-  content = await submitRequest(results, path, method, {
+  content = await submitRequest(path, method, {
     'description of the web page': 'aoseeou',
     'URL of the web page': 'https://oaaestuh.osneth',
     'reason for testing the web page': 'Just testing'
   });
-  if (content.error) {
+  if (content.message) {
     return;
   }
-  console.log('======================\nRequest 7: Make an illicit test recommendation');
-  await submitRequest(results, path, method, {
+  console.log('======================\nRequest: Make an illicit test recommendation');
+  content = await submitRequest(path, method, {
     'description of the web page': description,
     'URL of the web page': url,
     'reason for testing the web page': 'Just testing'
   });
-  console.log(`======================\nResults: ${results}\n`);
+  if (! content.message) {
+    return;
+  }
+  console.log('======================\nRequest: Results');
+  console.log('All tests succeeded');
 };
 
 // EXECUTION

package/retestRec/index.js

@@ -12,8 +12,17 @@ const {getLog, processRec} = require('../util');
 // Records a retest recommendation and returns an acknowledgement page.
 exports.answer = async (pageArgs, why) => {
   const [timeStamp, jobID] = pageArgs.split('/');
+  // Get the log of the specified report.
   const log = await getLog(timeStamp, jobID);
-  const {url, what} = log;
-  // Process the recommendation.
+  const {error, url, what} = log;
+  // If this failed:
+  if (error) {
+    // Return why.
+    return {
+      status: 'error',
+      message: error
+    };
+  }
+  // Otherwise, i.e. if it succeeded, process the recommendation.
   return await processRec('retest', __dirname, what, url, why);
 };

package/retestRecForm/index.js

@@ -15,6 +15,11 @@ const path = require('path');
 exports.answer = async pageArgs => {
   const [timeStamp, jobID] = pageArgs.split('/');
   const log = await getLog(timeStamp, jobID);
+  // If this failed:
+  if (log.error) {
+    // Make the form report the failure.
+    log.what = 'The specified page is not available for retesting';
+  }
   const query = {
     target: log.what,
     timeStamp,

package/target/api.js

@@ -21,9 +21,10 @@ const thisHost = process.env.THIS_KILOTEST_HOST;
 
 // Returns a response to a target request.
 exports.response = async args => {
-  const [what = '', hostname = ''] = args;
+  const [description = '', hostname = ''] = args;
   const hostLC = hostname.toLowerCase();
-  const whatLC = what.toLowerCase();
+  const whatLC = description.toLowerCase();
+  // Initialize an array of summaries of matching reports.
   const matchingReports = [];
   // Get the non-hidden logs.
   const targetLogs = await getLogs();
@@ -42,6 +43,7 @@ exports.response = async args => {
       // Get data about its report.
       const data = await getReportData(timeStamp, jobID);
       const {
+        error,
         creationDate,
         daysAgo,
         issueCount,
@@ -53,35 +55,44 @@ exports.response = async args => {
         preventedToolNames,
         preventedToolCount
       } = data;
-      matchingReports.push({
-        identifier: jobName,
-        'creation date': creationDate,
-        'days since the creation date': daysAgo,
-        'tested web page': {
-          description: reportWhat,
-          URL: reportURL
-        },
-        'whether a later report about the same page exists': !! superseded,
-        'rule engines that tried to test the page': {
-          number: toolCount,
-          names: toolNames
-        },
-        'rule engines that were unable to test the page': {
-          number: preventedToolCount,
-          names: preventedToolNames
-        },
-        'rule engines that reported issues': {
-          number: reporterCount,
-          names: reporterNames
-        },
-        'number of issues reported': issueCount,
-        'number of HTML elements reported as exhibiting issues': violatorCount,
-        'URLs for getting data about the reported issues': {
-          'for you': `${thisHost}/api/reportIssues/${timeStamp}/${jobID}`,
-          'for humans': `${thisHost}/reportIssues.html/${timeStamp}/${jobID}`
-        },
-        'URL for getting the full technical report as JSON': `${thisHost}/fullReport.json/${timeStamp}/${jobID}`
-      });
+      // If this failed:
+      if (error) {
+        // Report why.
+        console.error(error);
+      }
+      // Otherwise, i.e. if it succeeded:
+      else {
+        // Add a report summary to the array.
+        matchingReports.push({
+          identifier: jobName,
+          'creation date': creationDate,
+          'days since the creation date': daysAgo,
+          'tested web page': {
+            description: reportWhat,
+            URL: reportURL
+          },
+          'whether a later report about the same page exists': !! superseded,
+          'rule engines that tried to test the page': {
+            number: toolCount,
+            names: toolNames
+          },
+          'rule engines that were unable to test the page': {
+            number: preventedToolCount,
+            names: preventedToolNames
+          },
+          'rule engines that reported issues': {
+            number: reporterCount,
+            names: reporterNames
+          },
+          'number of issues reported': issueCount,
+          'number of HTML elements reported as exhibiting issues': violatorCount,
+          'URLs for getting data about the reported issues': {
+            'for you': `${thisHost}/api/reportSummary/${timeStamp}/${jobID}`,
+            'for humans': `${thisHost}/reportIssues.html/${timeStamp}/${jobID}`
+          },
+          'URL for getting the full technical report as JSON': `${thisHost}/fullReport.json/${timeStamp}/${jobID}`
+        });
+      }
     }
   }
   // Get a response.
@@ -96,12 +107,12 @@ exports.response = async args => {
       },
       method: 'POST',
       payload: {
-        'all or part of a description of the web page': what,
-        'all or part of the hostname of the URL of the web page': hostname
+        description,
+        hostname
       },
       URLs: {
-        'URL of your request': `${thisHost}/api/target`,
-        'equivalent URL for humans': 'none'
+        'for you': `${thisHost}/api/target`,
+        'for humans': 'none'
       },
       'closest ancestor request': null
     },

package/targets/index.js

@@ -80,8 +80,10 @@ const populateQuery = async query => {
   for (const targetLog of targetLogs) {
     const {jobName, url, what} = targetLog;
     const [timeStamp, jobID] = jobName.split('-');
+    // Get data about its report.
     const reportData = await getReportData(timeStamp, jobID);
     const {
+      error,
       issueCount,
       preventedToolCount,
       preventedToolNames,
@@ -89,6 +91,15 @@ const populateQuery = async query => {
       reporterCount,
       violatorCount
     } = reportData;
+    // If this failed:
+    if (error) {
+      console.error(error);
+      // Populate the query with the reason.
+      query.error = error;
+      // Stop populating the query.
+      return;
+    }
+    // Otherwise, i.e. if it succeeded, add lines about the report.
     lines.tested.push(`${margin}<details>`);
     const daysAgo = getAgoDays(timeStamp);
     const pageDataStrings = await getPageDataStrings(timeStamp, jobID, {what, url, daysAgo});
@@ -155,7 +166,15 @@ exports.answer = async () => {
   const query = {};
   // Create a query to replace placeholders.
   await populateQuery(query);
-  // Get the template.
+  // If the query reports an error:
+  if (query.error) {
+    // Return it.
+    return {
+      status: 'error',
+      message: query.error
+    };
+  }
+  // Otherwise, i.e. if it does not report an error, get the template.
   let answerPage = await fs.readFile(path.join(__dirname, 'index.html'), 'utf8');
   // Replace its placeholders.
   Object.keys(query).forEach(param => {

package/testRecForm/api.js

@@ -41,8 +41,8 @@ exports.response = async (what, url, why) => {
         'reason for testing the web page': why
       },
       URLs: {
-        'URL of your request': `${thisHost}/api/testRecForm`,
-        'equivalent URL for humans': `${thisHost}/testRecForm.html`
+        'for you': `${thisHost}/api/testRecForm`,
+        'for humans': `${thisHost}/testRecForm.html`
       },
       'closest ancestor request': null
     },