@jrpool/kilotest 46.1.2 → 48.0.0

package/web/ai0BalanceForm/{ai0BalanceForm.test.js → ai0BalanceForm.test.ts}

@@ -1,25 +1,25 @@
 /*
-  ai0BalanceForm.test.js
-  Unit tests for web/ai0BalanceForm/index.js.
+  ai0BalanceForm.test.ts
+  Unit tests for web/ai0BalanceForm/index.ts.
 */
 
 // IMPORTS
 
-const {test, before, after} = require('node:test');
-const assert = require('node:assert/strict');
-const path = require('node:path');
-const fs = require('fs/promises');
-const {parse} = require('node-html-parser');
-const {answer} = require('./index');
+import {test, before, after} from 'node:test';
+import assert from 'node:assert/strict';
+import path from 'node:path';
+import fs from 'fs/promises';
+import {parse} from 'node-html-parser';
+import {answer} from './index.ts';
 
 // CONSTANTS
 
-const balancePath = path.join(__dirname, '..', '..', 'ai0Balance.json');
+const balancePath = path.join(import.meta.dirname, '..', '..', 'ai0Balance.json');
 
 // SETUP AND TEARDOWN
 
 const savedAuthCode = process.env.AUTH_CODE;
-let savedBalance;
+let savedBalance: any;
 
 before(async () => {
   process.env.AUTH_CODE = 'test-auth-code';
@@ -45,7 +45,7 @@ after(async () => {
 // TESTS
 
 test('ai0BalanceForm displays the current balance when no newBalance is submitted', async () => {
-  const result = await answer(null, '');
+  const result: any = await answer(null, '');
   assert.equal(result.status, 'ok');
   assert.ok(result.answerPage);
   const html = parse(result.answerPage);
@@ -53,13 +53,13 @@ test('ai0BalanceForm displays the current balance when no newBalance is submitte
 });
 
 test('ai0BalanceForm returns an error for an invalid auth code', async () => {
-  const result = await answer(null, 'authCode=wrong&newBalance=5.00');
+  const result: any = await answer(null, 'authCode=wrong&newBalance=5.00');
   assert.equal(result.status, 'error');
   assert.equal(result.message, 'Invalid authorization code');
 });
 
 test('ai0BalanceForm records a valid new balance with valid auth code', async () => {
-  const result = await answer(null, 'authCode=test-auth-code&newBalance=2.50');
+  const result: any = await answer(null, 'authCode=test-auth-code&newBalance=2.50');
   assert.equal(result.status, 'ok');
   assert.ok(result.answerPage.includes('$2.5 is the'));
   // Verify the file was written.
@@ -69,7 +69,7 @@ test('ai0BalanceForm records a valid new balance with valid auth code', async ()
 
 test('ai0BalanceForm does not record an invalid balance', async () => {
   // 150 is out of range (>= 100).
-  const result = await answer(null, 'authCode=test-auth-code&newBalance=150');
+  const result: any = await answer(null, 'authCode=test-auth-code&newBalance=150');
   assert.equal(result.status, 'ok');
   // The oldBalance should not show the new value.
   assert.ok(!result.answerPage.includes('$150 is the'));
@@ -78,7 +78,7 @@ test('ai0BalanceForm does not record an invalid balance', async () => {
 test('ai0BalanceForm shows no-balance message when balance file is missing', async () => {
   await fs.unlink(balancePath).catch(() => {});
   try {
-    const result = await answer(null, '');
+    const result: any = await answer(null, '');
     assert.equal(result.status, 'ok');
     assert.ok(result.answerPage.includes('There is no'));
   }

package/web/ai0BalanceForm/{index.js → index.ts}

@@ -1,26 +1,22 @@
 /*
-  index.js
-  Serves a form for deleting superseded reports.
+  index.ts
+  Serves a form for recording the AI service 0 balance.
 */
 
 // IMPORTS
 
-const fs = require('fs/promises');
-const path = require('path');
-const {getJSON} = require('../../util');
-
-// CONSTANTS
-
-const balancePath = path.join(__dirname, '../../ai0Balance.json');
+import fs from 'node:fs/promises';
+import {balancePath} from '../../balances.ts';
+import {getJSON, populateTemplate} from '../../util.ts';
 
 // FUNCTIONS
 
 // Returns a form for recording the AI service 0 balance.
-exports.answer = async (_, search) => {
+export const answer = async (_: any, search: string) => {
   const searchParams = new URLSearchParams(search);
   const authCode = searchParams?.get('authCode');
   const newBalanceString = searchParams?.get('newBalance');
-  let oldBalance;
+  let oldBalance: any;
   // If the form displayed itself:
   if (newBalanceString) {
     // If the authorization code is valid:
@@ -64,13 +60,9 @@ exports.answer = async (_, search) => {
       oldBalance = 'There is no';
     }
   }
-  const query = {oldBalance};
-  // Get the order form template.
-  let answerPage = await fs.readFile(path.join(__dirname, 'index.html'), 'utf8');
-  // Replace its placeholders.
-  Object.keys(query).forEach(param => {
-    answerPage = answerPage.replace(new RegExp(`__${param}__`, 'g'), query[param]);
-  });
+  const query: Record<string, any> = {oldBalance};
+  // Get the populated order form template.
+  const answerPage = await populateTemplate(import.meta.dirname, query);
   // Return the populated page.
   return {
     status: 'ok',

package/web/enqueue/index.ts

@@ -0,0 +1,56 @@
+/*
+  index.ts
+  Implements a test request approval.
+*/
+
+// IMPORTS
+
+import {
+  deleteTestRequests, getJSON, getNowStamp, getRandomString, isURL, jobsPath, populateTemplate
+} from '../../util.ts';
+import fs from 'node:fs/promises';
+import path from 'node:path';
+
+// FUNCTIONS
+
+// Implements a test request approval and returns a revised request page.
+export const answer = async (url: string, description: string, authCode: string) => {
+  // If the arguments are valid:
+  if (isURL(url) && description && authCode === process.env.AUTH_CODE) {
+    // Get the job template.
+    const jobTemplateJSON = await fs.readFile(path.join(import.meta.dirname, '..', '..', 'job.json'), 'utf8');
+    const job = JSON.parse(jobTemplateJSON);
+    const nowStamp = getNowStamp();
+    // Populate the template with job properties.
+    const jobIDSuffix = getRandomString(3);
+    const jobName = `${nowStamp}-${jobIDSuffix}`;
+    job.id = jobName;
+    job.creationTimeStamp = nowStamp;
+    job.executionTimeStamp = nowStamp;
+    job.target.what = description;
+    job.target.url = url;
+    const query: Record<string, string> = {
+      target: description,
+      jobName
+    };
+    // Save the job in the queue.
+    await fs.writeFile(
+      path.join(jobsPath(), 'queue', `${jobName}.json`), getJSON(job)
+    );
+    console.log(`Retest queued for ${description} as job ${jobName}`);
+    // Delete the test requests for the target.
+    await deleteTestRequests(url);
+    // Get the populated answer template.
+    const answerPage = await populateTemplate(import.meta.dirname, query);
+    // Return the populated page.
+    return {
+      status: 'ok',
+      answerPage
+    };
+  }
+  // Otherwise, i.e. if the authorization code is invalid, return an error page.
+  return {
+    status: 'error',
+    message: 'Invalid authorization code'
+  };
+};

package/web/enqueueForm/index.html

@@ -6,21 +6,21 @@
     <meta name="publisher" content="Jonathan Robert Pool">
     <meta name="creator" content="Jonathan Robert Pool">
     <meta name="keywords" content="report,accessibility,a11y">
-    <title>Recommendation approval or rejection | Kilotest</title>
+    <title>Request approval or rejection | Kilotest</title>
     <link rel="icon" href="/favicon.ico">
     <link rel="stylesheet" href="/style.css">
   </head>
   <body>
     <main>
-      <h1><a href="/">Kilotest</a>: Recommendation approval or rejection</h1>
-      <p>To approve a test or retest recommendation, check its recommended page name.</p>
-      <p>To approve testing a page that is not yet recommended, first <a href="listReports.html">recommend it</a>.</p>
-      <p>To reject all recommendations for a page, check the radio button of its URL.</p>
-      <form action="/recAction.html" method="post">
+      <h1><a href="/">Kilotest</a>: Request approval or rejection</h1>
+      <p>To approve a test or retest request, check its requested page name.</p>
+      <p>To approve testing a page that has not yet been requested, first <a href="listReports.html">request it</a>.</p>
+      <p>To reject all requests for a page, check the radio button of its URL.</p>
+      <form action="/requestAction.html" method="post">
         <fieldset>
-          <legend>Recommendations</legend>
-          __recs__
-          <p>__noRecs__</p>
+          <legend>Requests</legend>
+          __requests__
+          <p>__noRequests__</p>
         </fieldset>
         <p><label>
           Authorization code:

package/web/enqueueForm/index.ts

@@ -0,0 +1,43 @@
+/*
+  index.ts
+  Serves a form for approving or rejecting a test request.
+*/
+
+// IMPORTS
+
+import {getTestRequests, populateTemplate} from '../../util.ts';
+
+// FUNCTIONS
+
+// Returns a test order form.
+export const answer = async () => {
+  const testRequests = await getTestRequests() as Record<string, {description: string}[]>;
+  const urls = Object.keys(testRequests);
+  const margin = ' '.repeat(12);
+  const lines: string[] = [];
+  // For each page with any requests:
+  urls.forEach(url => {
+    // Add a radio button and its URL to the lines.
+    lines.push(`${margin}<h2><input type="radio" name="target" value="${url}" required> ${url}</h2>`);
+    // Get the requested target names for the page.
+    const targetNames = new Set(testRequests[url]!.map((req: any) => req.description));
+    // For each requested target name:
+    targetNames.forEach(description => {
+      const radio = `<input type="radio" name="target" value="${url}\t${description}" required>`;
+      // Add a radio button and the requested page name to the lines.
+      lines.push(`${margin}    <p>${radio} ${description}</p>`);
+    });
+  });
+  const query: Record<string, string> = {
+    requests: lines.join('\n'),
+    noRequests: urls.length ? '' : 'No requests exist now.',
+    disabled: urls.length ? '' : ' disabled'
+  };
+  // Get the populated order form template.
+  const answerPage = await populateTemplate(import.meta.dirname, query);
+  // Return the populated page.
+  return {
+    status: 'ok',
+    answerPage
+  };
+};

package/web/expungeReportsForm/{expungeReportsForm.test.js → expungeReportsForm.test.ts}

@@ -1,23 +1,23 @@
 /*
-  expungeReportsForm.test.js
-  Unit tests for web/expungeReportsForm/index.js.
+  expungeReportsForm.test.ts
+  Unit tests for web/expungeReportsForm/index.ts.
 */
 
 // IMPORTS
 
-const {test, before, after} = require('node:test');
-const assert = require('node:assert/strict');
-const path = require('node:path');
-const fs = require('fs/promises');
-const {parse} = require('node-html-parser');
-const {answer} = require('./index');
-const {reportsPath} = require('../../util');
+import {test, before, after} from 'node:test';
+import assert from 'node:assert/strict';
+import path from 'node:path';
+import fs from 'fs/promises';
+import {parse} from 'node-html-parser';
+import {answer} from './index.ts';
+import {reportsPath} from '../../util.ts';
 
 // SETUP AND TEARDOWN
 
 const savedAuthCode = process.env.AUTH_CODE;
 const savedDBDir = process.env.DB_DIR;
-const fixtureDBDir = path.join(__dirname, '..', '..', 'test', 'fixtures', 'db');
+import {fixtureDBDir} from '../../test/dbFixture.ts';
 
 before(() => {
   process.env.AUTH_CODE = 'test-auth-code';
@@ -36,7 +36,7 @@ after(async () => {
 // TESTS
 
 test('expungeReportsForm displays a list of reports when no submission', async () => {
-  const result = await answer(null, '');
+  const result: any = await answer(null, '');
   assert.equal(result.status, 'ok');
   assert.ok(result.answerPage);
   const html = parse(result.answerPage);
@@ -44,13 +44,13 @@ test('expungeReportsForm displays a list of reports when no submission', async (
 });
 
 test('expungeReportsForm returns an error for an invalid auth code', async () => {
-  const result = await answer(null, 'authCode=wrong&report=260101T0001-ct');
+  const result: any = await answer(null, 'authCode=wrong&report=260101T0001-ct');
   assert.equal(result.status, 'error');
   assert.equal(result.message, 'Invalid authorization code');
 });
 
 test('expungeReportsForm returns an error when deleting a nonexistent report', async () => {
-  const result = await answer(null, 'authCode=test-auth-code&report=999999T9999-nope');
+  const result: any = await answer(null, 'authCode=test-auth-code&report=999999T9999-nope');
   assert.equal(result.status, 'error');
   assert.ok(result.message.includes('Deleting sole reports'));
 });
@@ -60,7 +60,7 @@ test('expungeReportsForm deletes a sole report with valid auth code', async () =
   const reportPath = path.join(reportsPath(), '260101T0001-ct.json');
   const backup = await fs.readFile(reportPath, 'utf8');
   try {
-    const result = await answer(null, 'authCode=test-auth-code&report=260101T0001-ct');
+    const result: any = await answer(null, 'authCode=test-auth-code&report=260101T0001-ct');
     assert.equal(result.status, 'ok');
     await fs.access(reportPath).then(
       () => {throw new Error('Report should have been deleted');},
@@ -77,7 +77,7 @@ test('expungeReportsForm returns an error when a report file is corrupt', async
   const backup = await fs.readFile(reportPath, 'utf8');
   try {
     await fs.writeFile(reportPath, 'not valid json');
-    const result = await answer(null, '');
+    const result: any = await answer(null, '');
     assert.equal(result.status, 'error');
   }
   finally {
@@ -87,7 +87,7 @@ test('expungeReportsForm returns an error when a report file is corrupt', async
 
 test('expungeReportsForm shows no-deletable message when every URL has at least 2 reports', async () => {
   // Create a temp DB with two reports sharing the same URL.
-  const os = require('node:os');
+  const os = await import('node:os');
   const tmpDir = await fs.mkdtemp(path.join(os.tmpdir(), 'expunge-test-'));
   const tmpReports = path.join(tmpDir, 'reports');
   await fs.mkdir(tmpReports);
@@ -99,16 +99,14 @@ test('expungeReportsForm shows no-deletable message when every URL has at least
   const savedDBDir = process.env.DB_DIR;
   process.env.DB_DIR = tmpDir;
   try {
-    delete require.cache[require.resolve('./index')];
-    const {answer} = require('./index');
-    const result = await answer(null, '');
+    const {answer} = await import('./index.ts');
+    const result: any = await answer(null, '');
     assert.equal(result.status, 'ok');
     assert.ok(result.answerPage.includes('no reports to delete'));
     assert.ok(result.answerPage.includes('disabled'));
   }
   finally {
     process.env.DB_DIR = savedDBDir;
-    delete require.cache[require.resolve('./index')];
     await fs.rm(tmpDir, {recursive: true}).catch(() => {});
   }
 });

package/web/expungeReportsForm/index.ts

@@ -0,0 +1,18 @@
+/*
+  index.ts
+  Serves a form for deleting sole reports.
+*/
+
+// IMPORTS
+
+import {reportDeletionForm} from '../reportDeletion.ts';
+
+// FUNCTIONS
+
+// Returns a form for deleting sole reports.
+export const answer = async (_: any, search: string) => reportDeletionForm(import.meta.dirname, search, {
+  intro: 'Choose the sole reports to delete.',
+  emptyIntro: 'Each target has at least 2 reports, so there are no reports to delete.',
+  failurePrefix: 'Deleting sole reports failed',
+  isDeletable: (specs, index) => specs[index - 1]?.url !== specs[index]?.url && specs[index + 1]?.url !== specs[index]?.url
+});

package/web/hideReportForm/{hideReportForm.test.js → hideReportForm.test.ts}

@@ -1,23 +1,23 @@
 /*
-  hideReportForm.test.js
-  Unit tests for web/hideReportForm/index.js.
+  hideReportForm.test.ts
+  Unit tests for web/hideReportForm/index.ts.
 */
 
 // IMPORTS
 
-const {test, before, after} = require('node:test');
-const assert = require('node:assert/strict');
-const path = require('node:path');
-const fs = require('fs/promises');
-const {parse} = require('node-html-parser');
-const {answer} = require('./index');
-const {reportsPath, hiddenReportsPath} = require('../../util');
+import {test, before, after} from 'node:test';
+import assert from 'node:assert/strict';
+import path from 'node:path';
+import fs from 'fs/promises';
+import {parse} from 'node-html-parser';
+import {answer} from './index.ts';
+import {reportsPath, hiddenReportsPath} from '../../util.ts';
 
 // SETUP AND TEARDOWN
 
 const savedAuthCode = process.env.AUTH_CODE;
 const savedDBDir = process.env.DB_DIR;
-const fixtureDBDir = path.join(__dirname, '..', '..', 'test', 'fixtures', 'db');
+import {fixtureDBDir} from '../../test/dbFixture.ts';
 
 before(() => {
   process.env.AUTH_CODE = 'test-auth-code';
@@ -45,7 +45,7 @@ after(async () => {
 // TESTS
 
 test('hideReportForm displays a list of reports when no submission', async () => {
-  const result = await answer(null, '');
+  const result: any = await answer(null, '');
   assert.equal(result.status, 'ok');
   assert.ok(result.answerPage);
   const html = parse(result.answerPage);
@@ -54,7 +54,7 @@ test('hideReportForm displays a list of reports when no submission', async () =>
 });
 
 test('hideReportForm returns an error for an invalid auth code', async () => {
-  const result = await answer(null, 'authCode=wrong&report=260101T0009-brd');
+  const result: any = await answer(null, 'authCode=wrong&report=260101T0009-brd');
   assert.equal(result.status, 'error');
   assert.equal(result.message, 'Invalid authorization code');
 });
@@ -69,14 +69,14 @@ test('hideReportForm hides a report with valid auth code', async () => {
   catch {
     // Report may already be in reports.
   }
-  const result = await answer(null, 'authCode=test-auth-code&report=260101T0009-brd');
+  const result: any = await answer(null, 'authCode=test-auth-code&report=260101T0009-brd');
   assert.equal(result.status, 'ok');
   // The report should now be in the hidden directory.
   await fs.access(hiddenPath);
 });
 
 test('hideReportForm returns an error when hiding a nonexistent report', async () => {
-  const result = await answer(null, 'authCode=test-auth-code&report=999999T9999-nope');
+  const result: any = await answer(null, 'authCode=test-auth-code&report=999999T9999-nope');
   assert.equal(result.status, 'error');
   assert.ok(result.message.includes('Hiding report'));
 });

package/web/hideReportForm/{index.js → index.ts}

@@ -1,18 +1,18 @@
 /*
-  index.js
+  index.ts
   Serves a form for hiding a report.
 */
 
 // IMPORTS
 
-const {getReportExtracts, hiddenReportsPath, reportsPath} = require('../../util');
-const fs = require('fs/promises');
-const path = require('path');
+import {getReportExtracts, hiddenReportsPath, populateTemplate, reportsPath} from '../../util.ts';
+import fs from 'node:fs/promises';
+import path from 'node:path';
 
 // FUNCTIONS
 
 // Returns a form for hiding a report.
-exports.answer = async (_, search) => {
+export const answer = async (_: any, search: string) => {
   const searchParams = new URLSearchParams(search);
   const authCode = searchParams?.get('authCode');
   const jobName = searchParams?.get('report');
@@ -26,7 +26,7 @@ exports.answer = async (_, search) => {
         await fs.rename(path.join(reportsPath(), fileName), path.join(hiddenReportsPath(), fileName));
       }
       // If this failed:
-      catch (error) {
+      catch (error: any) {
         // Return why.
         return {
           status: 'error',
@@ -44,46 +44,42 @@ exports.answer = async (_, search) => {
     }
   }
   // Initialize an array of report specifications.
-  const reportSpecs = [];
+  const reportSpecs: any[] = [];
   // Get data on all available reports.
   const reportExtracts = await getReportExtracts();
   // For each report:
   for (const reportExtract of reportExtracts) {
-    const {jobID, timeStamp, what} = reportExtract;
+    const {jobID, timeStamp, description} = reportExtract;
     // Add the report to the array.
     reportSpecs.push({
-      what,
+      description,
       timeStamp,
       jobID
     });
   }
   // Sort the data by page name and then by time stamp.
   reportSpecs.sort((a, b) => {
-    if (a.what === b.what) {
+    if (a.description === b.description) {
       return a.timeStamp.localeCompare(b.timeStamp);
     }
-    return a.what.localeCompare(b.what);
+    return a.description.localeCompare(b.description);
   });
-  const lines = [];
+  const lines: string[] = [];
   const margin = ' '.repeat(12);
   // For each available report:
   reportSpecs.forEach(spec => {
-    const {jobID, timeStamp, what} = spec;
-    const specString = `${what} (job <code>${jobID}</code> at ${timeStamp})`;
+    const {jobID, timeStamp, description} = spec;
+    const specString = `${description} (job <code>${jobID}</code> at ${timeStamp})`;
     // Add a line with a radio button to hide it.
     lines.push(
       `${margin}<p><input type="radio" name="report" value="${timeStamp}-${jobID}"> ${specString}</p>`
     );
   });
-  const query = {
+  const query: Record<string, string> = {
     reports: lines.join('\n'),
   };
-  // Get the hiding form template.
-  let answerPage = await fs.readFile(path.join(__dirname, 'index.html'), 'utf8');
-  // Replace its placeholders.
-  Object.keys(query).forEach(param => {
-    answerPage = answerPage.replace(new RegExp(`__${param}__`, 'g'), query[param]);
-  });
+  // Get the populated hiding form template.
+  const answerPage = await populateTemplate(import.meta.dirname, query);
   // Return the populated page.
   return {
     status: 'ok',