@jrpool/kilotest 35.0.1 → 35.1.0

package/SERVICE.md

@@ -20,6 +20,8 @@ Any other application `xyz` can be installed at `/opt/jpdev/xyz` on the server.
 
 ## Process management
 
+### Process manager
+
 Kilotest is managed with [PM2](https://pm2.keymetrics.io) on the server (not on the local development host). The PM2 configuration is specified in the repository as `pm2.config.js`:
 
 ```javascript
@@ -49,6 +51,10 @@ pm2 restart kilotest --time --update-env
 pm2 save
 ```
 
+The management of the PM2 logs is [documented by PM2](https://pm2.keymetrics.io/docs/usage/log-management/).
+
+### Process tuning
+
 The server configuration has been tuned for improved performance. The file edited for this purpose is `/etc/default/zramswap`:
 
 ```properties

package/ai0BalanceForm/index.js

@@ -47,7 +47,7 @@ exports.answer = async (_, search) => {
       // Report the error.
       return {
         status: 'error',
-        error: 'Invalid authorization code'
+        message: 'Invalid authorization code'
       }
     }
   }
@@ -60,7 +60,7 @@ exports.answer = async (_, search) => {
       oldBalance = `$${balanceData.balance} is the`;
     }
     // If the balance file does not exist or is invalid:
-    catch (error) {
+    catch {
       oldBalance = 'There is no';
     }
   }

package/diagnoses/index.js

@@ -135,6 +135,6 @@ exports.answer = async (pageArgs, search) => {
   // Otherwise, report this.
   return {
     status: 'error',
-    error: 'Invalid report specification'
+    message: 'Invalid report specification'
   };
 };

package/index.js

@@ -80,7 +80,8 @@ const AI_MODEL0_OUTPUT_PRICE = Number(process.env.AI_MODEL0_OUTPUT_PRICE);
 
 // Serves or sends an error message.
 const serveError = async (error, response, isHumanUser = true) => {
-  console.log(error.message || 'ERROR');
+  const errorLines = Object.entries(error).map(pair => `${pair[0]}: ${pair[1]}`);
+  console.log(errorLines.join('\n') || 'ERROR');
   if (! response.writableEnded) {
     response.statusCode = 400;
     // If the request is from a human user:
@@ -128,7 +129,7 @@ const checkBalancesForAlerts = async report => {
       // Get the recorded AI service 0 balance.
       balanceJSON = await fs.readFile(balancePath, 'utf8');
     }
-    catch (error) {
+    catch {
       console.error('ERROR: AI service 0 balance file missing');
     }
     // If the variables required for an AI service 0 balance alert are defined:
@@ -169,6 +170,21 @@ const checkBalancesForAlerts = async report => {
     }
   }
 };
+// Creates an error object about a suspicious request.
+const getAbuseError = (request, reason) => {
+  const {method, url, headers} = request;
+  const ip = headers['x-forwarded-for'] || request.socket.remoteAddress || 'unknown';
+  return {
+    message: 'Invalid request',
+    reason,
+    'IP address': ip,
+    method,
+    URL: url,
+    'user agent': headers['user-agent'] || 'none',
+    referer: headers.referer || 'none',
+    time: new Date().toISOString()
+  };
+};
 // Handles a request.
 const requestHandler = async (request, response) => {
   // Sets response headers.
@@ -260,17 +276,17 @@ const requestHandler = async (request, response) => {
         // If the report exists and is hidden:
         if (reportHidden === true) {
           console.log(`ERROR: Hidden report ${timeStamp}-${jobID} requested`);
-          // Report this.
+          // Report this as suspected abuse.
           await serveError(
-            {message: `ERROR: requested report ${timeStamp}-${jobID} not available`},
+            getAbuseError(request, `Requested report ${timeStamp}-${jobID} not available`),
             response,
             true
           );
         }
-        // Otherwise, if any other error occurred:
+        // Otherwise, if the report does not exist or another error occurred:
         else if (typeof reportHidden === 'string') {
-          // Report it.
-          await serveError({message: reportHidden}, response, true);
+          // Report this as suspected abuse.
+          await serveError(getAbuseError(request, reportHidden), response, true);
         }
         // Otherwise, i.e. if the report log is valid and not hidden:
         else {
@@ -314,14 +330,14 @@ const requestHandler = async (request, response) => {
         }
         // Otherwise, i.e. if they are invalid:
         else {
-          // Report the error.
-          await serveError({message: answerData.error}, response, true);
+          // Report the error as suspected abuse.
+          await serveError(getAbuseError(request, answerData.message), response, true);
         }
       }
       // Otherwise, i.e. if the answer cannot be generated:
       else {
-        // Report the error.
-        await serveError({message: 'ERROR: Invalid request'}, response, true);
+        // Report the error as suspected abuse.
+        await serveError(getAbuseError(request, 'Request for nonexistent page'), response, true);
       }
     }
     // Otherwise, if it is for an API service:
@@ -377,7 +393,7 @@ const requestHandler = async (request, response) => {
         setHeaders(mimeTypes[ext] || 'application/octet-stream', null, 'low');
         response.end(img);
       }
-      catch (_) {
+      catch {
         await serveError({message: 'ERROR: Image not found'}, response, true);
       }
     }
@@ -439,7 +455,7 @@ const requestHandler = async (request, response) => {
           // Otherwise, i.e. if they are invalid:
           else {
             // Report the error.
-            await serveError({message: answerData.error}, response, true);
+            await serveError({message: answerData.message}, response, true);
           }
         }
         // Otherwise, i.e. if the request is invalid:
@@ -473,7 +489,7 @@ const requestHandler = async (request, response) => {
             // Otherwise, i.e. if they are invalid:
             else {
               // Report the error.
-              await serveError({message: answerData.error}, response, true);
+              await serveError({message: answerData.message}, response, true);
             }
           }
         }
@@ -506,7 +522,7 @@ const requestHandler = async (request, response) => {
             // Otherwise, i.e. if they are invalid:
             else {
               // Report the error.
-              await serveError({message: answerData.error}, response, true);
+              await serveError({message: answerData.message}, response, true);
             }
           }
           // Otherwise, i.e. if it is a rejection:
@@ -547,7 +563,7 @@ const requestHandler = async (request, response) => {
         // Otherwise, i.e. if they are invalid:
         else {
           // Report the error.
-          await serveError({message: answerData.error}, response, true);
+          await serveError({message: answerData.message}, response, true);
         }
       }
       // Otherwise, if it is a WCAG map renewal:
@@ -566,7 +582,7 @@ const requestHandler = async (request, response) => {
         // Otherwise, i.e. if they are invalid:
         else {
           // Report the error.
-          await serveError({message: answerData.error}, response, true);
+          await serveError({message: answerData.message}, response, true);
         }
       }
       // Otherwise, if it is a request from an agent:
@@ -753,7 +769,7 @@ const requestHandler = async (request, response) => {
         }
         else {
           response.statusCode = 400;
-          response.end(JSON.stringify({status: 'error', message: answerData.error}));
+          response.end(JSON.stringify({status: 'error', message: answerData.message}));
         }
       }
       // Otherwise, i.e. if it is any other POST request:

package/package.json

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

package/reannotate/index.js

@@ -34,6 +34,6 @@ exports.answer = async authCode => {
   // Otherwise, i.e. if the authorization code is invalid, return an error page.
   return {
     status: 'error',
-    error: 'Invalid authorization code'
+    message: 'Invalid authorization code'
   };
 };

package/reportHideForm/index.js

@@ -32,7 +32,7 @@ exports.answer = async (_, search) => {
       // Report the error.
       return {
         status: 'error',
-        error: 'Invalid authorization code'
+        message: 'Invalid authorization code'
       }
     }
   }

package/reportIssue/index.js

@@ -176,6 +176,6 @@ exports.answer = async pageArgs => {
   // Otherwise, report this.
   return {
     status: 'error',
-    error: 'Invalid report specification'
+    message: 'Invalid report specification'
   };
 };

package/reportIssues/index.js

@@ -171,6 +171,6 @@ exports.answer = async pageArgs => {
   // Otherwise, i.e. if they were not obtained, report this.
   return {
     status: 'error',
-    error: 'Report processing failed'
+    message: 'Report processing failed'
   };
 };

package/reportUnhideForm/index.js

@@ -32,7 +32,7 @@ exports.answer = async (_, search) => {
       // Report the error.
       return {
         status: 'error',
-        error: 'Invalid authorization code'
+        message: 'Invalid authorization code'
       }
     }
   }

package/reportsExpungeForm/index.js

@@ -33,7 +33,7 @@ exports.answer = async (_, search) => {
       // Report the error.
       return {
         status: 'error',
-        error: 'Invalid authorization code'
+        message: 'Invalid authorization code'
       }
     }
   }

package/reportsPruneForm/index.js

@@ -33,7 +33,7 @@ exports.answer = async (_, search) => {
       // Report the error.
       return {
         status: 'error',
-        error: 'Invalid authorization code'
+        message: 'Invalid authorization code'
       }
     }
   }

package/reportsRewindForm/index.js

@@ -33,7 +33,7 @@ exports.answer = async (_, search) => {
       // Report the error.
       return {
         status: 'error',
-        error: 'Invalid authorization code'
+        message: 'Invalid authorization code'
       }
     }
   }

package/researchAgent.js

@@ -63,7 +63,7 @@ const getContent = async response => {
       // If it is not JSON:
       catch {
         // Return this.
-        resolve({error: `Response content not JSON (${contentString})`});
+        resolve({message: `Response content not JSON (${contentString})`});
       }
     });
   });

package/style.css

@@ -57,7 +57,7 @@ code.thin {
   margin-top: 0;
 }
 details {
-  padding: rem;
+  padding: 0.5rem;
   border: solid #000 1px;
 }
 .error {

package/targets/index.js

@@ -12,7 +12,6 @@ const {
   getObject,
   getPageDataStrings,
   getRecs,
-  getToolNamesString,
   getLogs,
   getReportData,
   isRecommendable,

package/testOrder/index.js

@@ -57,6 +57,6 @@ exports.answer = async (url, what, authCode) => {
   // Otherwise, i.e. if the authorization code is invalid, return an error page.
   return {
     status: 'error',
-    error: 'Invalid authorization code'
+    message: 'Invalid authorization code'
   };
 };

package/testRec/index.js

@@ -17,7 +17,7 @@ exports.answer = async (what, url, why) => {
     // Return an answer reporting this.
     return {
       status: 'error',
-      error: `Page is already ${status}`
+      message: `Page is already ${status}`
     };
   }
   // Otherwise, i.e. if it is recommendable, process the recommendation.

package/tutorial/index.js

@@ -33,11 +33,11 @@ exports.answer = async () => {
 // Sanitizes and saves a tutorial comment to comments.json.
 exports.saveComment = async content => {
   if (!content || typeof content !== 'string') {
-    return {status: 'error', error: 'No content provided'};
+    return {status: 'error', message: 'No content provided'};
   }
   const sanitized = sanitize(content);
   if (!sanitized) {
-    return {status: 'error', error: 'Comment is empty after sanitization'};
+    return {status: 'error', message: 'Comment is empty after sanitization'};
   }
   let comments = [];
   try {

package/util.js

@@ -679,7 +679,7 @@ exports.processRec = async (testType, dirName, what, url, why) => {
   }
   return {
     status: 'error',
-    error: 'Invalid recommendation'
+    message: 'Invalid recommendation'
   };
 };
 // Gets the WCAG Understanding link for a numeric WCAG standard identifier.

package/wcagRenew/index.js

@@ -50,21 +50,21 @@ exports.answer = async authCode => {
         // Report this.
         return {
           status: 'error',
-          error: 'No entries found in WCAG map source'
+          message: 'No entries found in WCAG map source'
         };
       }
     }
     else {
       return {
         status: 'error',
-        error: 'WCAG map source not retrieved'
+        message: 'WCAG map source not retrieved'
       };
     }
   }
   else {
     return {
       status: 'error',
-      error: 'Authorization code invalid'
+      message: 'Authorization code invalid'
     };
   }
 };