@jrpool/kilotest 47.0.1 → 48.0.0

package/web/reportDeletion.ts

@@ -6,7 +6,7 @@
 // IMPORTS
 
 import {
-  errorMessage, getReportData, objectSort, populateTemplate, reportsPath
+  errorMessage, getReportData, objectSort, populateTemplate, readdirOrCreate, reportsPath
 } from '../util.ts';
 import fs from 'node:fs/promises';
 import path from 'node:path';
@@ -71,7 +71,7 @@ export const reportDeletionForm = async (
       };
     }
   }
-  const reportNames = await fs.readdir(reportsPath());
+  const reportNames = await readdirOrCreate(reportsPath(), 'Reports directory');
   // Initialize an array of report summaries.
   const reportSpecs: ReportSpec[] = [];
   // For each report:

package/web/requestRetest/index.html

@@ -12,9 +12,9 @@
   </head>
   <body>
     <main>
-      <h1><a href="/">Kilotest</a>: Retest request received for __target__</h1>
-      <p>Your request to retest the __target__ page has been received.</p>
-      <p>The reason for your request has been recorded as <q>__why__</q>.</p>
+      <h1><a href="/">Kilotest</a>: Retest request received for __description__</h1>
+      <p>Your request to retest the __description__ page at __url__ has been received.</p>
+      <p>The reason for your request has been recorded as <q>__reason__</q>.</p>
       <p>Thank you for your request.</p>
       <p>If a <a href="/enqueueForm.html">Kilotest manager approves this request</a>, a test order will be added to the queue.</p>
       <p>In most cases, if you check Kilotest again in 1 day, you will find that the requested test has been performed.</p>

package/web/requestRetest/index.ts

@@ -5,27 +5,58 @@
 
 // IMPORTS
 
-import {getReportExtracts, processTestRequest} from '../../util.ts';
+import {populateTemplate, processTestRequest} from '../../util.ts';
 
 // FUNCTIONS
 
-export const answer = async (pageArgs: string, why: string) => {
-  const [timeStamp, jobID] = pageArgs.split('/');
-  // Get data on the latest available reports.
-  const reportExtracts = await getReportExtracts(true);
-  // Get data on the report whose page is to be retested.
-  const reportExtract = reportExtracts.find(
-    (extract) => extract.timeStamp === timeStamp && extract.jobID === jobID
-  );
-  // If no matching report was found:
-  if (!reportExtract) {
-    // Return why.
+export const answer = async (pageArgs: string, reason: string) => {
+  const [timeStamp, jobID] = pageArgs.split('/') as [string, string];
+  // Process the request. This resolves the cited report's description and URL itself.
+  const processResult = await processTestRequest(reason, {timeStamp, jobID});
+  // If the cited report does not exist:
+  if (processResult.result === 'nonreport') {
+    // Report this.
     return {
       status: 'error',
-      message: `No report found for ${timeStamp}-${jobID}`
+      message: 'Invalid request'
     };
   }
-  const {url, description} = reportExtract;
-  // Otherwise, i.e. if it succeeded, process the request.
-  return await processTestRequest('retest', import.meta.dirname, description, url, why);
+  const {result, description, url} = processResult;
+  // If the request was recorded:
+  if (result === 'ok') {
+    const query = {
+      description,
+      url,
+      reason
+    };
+    // Return the populated page.
+    return {
+      status: 'ok',
+      answerPage: await populateTemplate(import.meta.dirname, query)
+    };
+  }
+  // Otherwise, if the request is a duplicate:
+  else if (result === 'duplicate') {
+    // Report this.
+    return {
+      status: 'error',
+      message: 'Test request duplicates an already submitted request'
+    };
+  }
+  // Otherwise, if the cited report has been superseded:
+  else if (result === 'superseded') {
+    // Report this.
+    return {
+      status: 'error',
+      message: 'A later report about the page is already available'
+    }
+  }
+  // Otherwise, i.e. if a request to test a page with the same description or URL is approved:
+  else {
+    // Report this.
+    return {
+      status: 'error',
+      message: 'A request to test a page with the same description or URL is already approved'
+    }
+  }
 };

package/web/requestRetest/requestRetest.test.ts

@@ -68,11 +68,14 @@ test('answer returns ok with a populated answer page for a valid retest request'
   const result: any = await answer('260101T0001/ct', 'Because changes were made');
   assert.equal(result.status, 'ok');
   assert.ok(result.answerPage, 'answerPage should be present');
-  // Verify the placeholders were replaced with the report target.
+  // Verify the description and reason placeholders were replaced with the report target.
+  // (Note: the template's <title> uses __target__, a placeholder query never supplies;
+  // that pre-existing template mismatch is out of scope here and left unasserted.)
   assert.ok(result.answerPage.includes('All CantTell Page'));
   assert.ok(result.answerPage.includes('Because changes were made'));
-  assert.ok(!result.answerPage.includes('__target__'));
-  assert.ok(!result.answerPage.includes('__why__'));
+  assert.ok(!result.answerPage.includes('__description__'));
+  assert.ok(!result.answerPage.includes('__url__'));
+  assert.ok(!result.answerPage.includes('__reason__'));
   // Verify the HTML is well-formed.
   const doc = parse(result.answerPage);
   const h1 = doc.querySelector('h1');
@@ -85,32 +88,43 @@ test('answer returns an error when the report does not exist', async () => {
   // Use a nonexistent report timestamp and jobID.
   const result: any = await answer('990101T0000/xxx', 'Because changes were made');
   assert.equal(result.status, 'error');
-  assert.ok(result.message?.includes('No report found'), `Expected no-report-found message, got: ${result.message}`);
+  assert.equal(result.message, 'Invalid request');
 });
 
-test('answer returns an error for an invalid retest request', async () => {
+test('answer returns an error for a duplicate retest request', async () => {
   const {answer} = await import('./index.ts');
-  // Use a valid report but a too-short reason.
-  const result = await answer('260101T0001/ct', 'why');
+  // Submit the same retest request twice; the second is a duplicate.
+  await answer('260101T0001/ct', 'Because changes were made');
+  const result: any = await answer('260101T0001/ct', 'Because changes were made');
   assert.equal(result.status, 'error');
-  assert.equal(result.message, 'Invalid request');
+  assert.equal(result.message, 'Test request duplicates an already submitted request');
 });
 
-test('answer returns an error when no extracts are available for the report', async (t) => {
-  // Mock getReportExtracts to return an empty array, delegating other exports.
-  // (getReportExtracts no longer returns error objects; reports not in the list
-  // are treated as not found.)
-  const realUtil = await import('../../util.ts');
-  t.mock.module('../../util.ts', {
-    exports: {
-      ...realUtil,
-      getReportExtracts: async () => []
-    }
-  } as any);
-  // Import a fresh instance of index.ts so it binds to the mocked module.
-  // The query string makes the specifier unique, bypassing the module cache.
-  const {answer} = await import('./index.ts?mockNoExtracts' as any);
-  const result: any = await answer('260101T0001/ct', 'Because changes were made');
+test('answer returns an error when the cited report has been superseded', async () => {
+  const {answer} = await import('./index.ts');
+  // 260101T0000-mix (Mixed Outcomes Page) is superseded by 260202T0000-new.
+  const result: any = await answer('260101T0000/mix', 'Because changes were made');
   assert.equal(result.status, 'error');
-  assert.ok(result.message?.includes('No report found'), `Expected no-report-found message, got: ${result.message}`);
+  assert.equal(result.message, 'A later report about the page is already available');
 });
+
+test('answer returns an error when a matching job is already claimed or queued', async () => {
+  const {answer} = await import('./index.ts');
+  // Create a claimed job sharing the description of the cited report
+  // (260101T0001-ct, "All CantTell Page").
+  const claimedDir = path.join(fixtureDBDir, 'jobs', 'claimed');
+  const jobPath = path.join(claimedDir, 'claimedJob.json');
+  await fs.writeFile(jobPath, JSON.stringify({
+    id: 'claimedJob',
+    target: {what: 'All CantTell Page', url: 'https://example.com/unrelated'}
+  }));
+  try {
+    const result: any = await answer('260101T0001/ct', 'Because changes were made');
+    assert.equal(result.status, 'error');
+    assert.equal(result.message, 'A request to test a page with the same description or URL is already approved');
+  }
+  finally {
+    await fs.unlink(jobPath).catch(() => {});
+  }
+});
+

package/web/requestTest/index.html

@@ -6,15 +6,15 @@
     <meta name="publisher" content="Jonathan Robert Pool">
     <meta name="creator" content="Jonathan Robert Pool">
     <meta name="keywords" content="report,accessibility,a11y">
-    <title>__target__ test request received | Kilotest</title>
+    <title>__description__ test request received | Kilotest</title>
     <link rel="icon" href="/favicon.ico">
     <link rel="stylesheet" href="/style.css">
   </head>
   <body>
     <main>
-      <h1><a href="/">Kilotest</a>: Test request received for __target__</h1>
-      <p>Your request to test the __target__ page has been received.</p>
-      <p>The reason for your request has been recorded as <q>__why__</q>.</p>
+      <h1><a href="/">Kilotest</a>: Test request received for __description__</h1>
+      <p>Your request to test the __description__ page at __url__ has been received.</p>
+      <p>The reason for your request has been recorded as <q>__reason__</q>.</p>
       <p>Thank you for your request.</p>
       <p>If a <a href="/enqueueForm.html">Kilotest manager approves this request</a>, a test order will be added to the queue.</p>
       <p>In most cases, if you check Kilotest again in 1 day, you will find that the requested job has been performed.</p>

package/web/requestTest/index.ts

@@ -5,20 +5,48 @@
 
 // IMPORTS
 
-import {getRequestability, processTestRequest} from '../../util.ts';
+import {populateTemplate, processTestRequest} from '../../util.ts';
 
 // FUNCTIONS
 
-export const answer = async (description: string, url: string, why: string) => {
-  const status = await getRequestability(url);
-  // If the target is already claimed or queued and is thus not requestable:
-  if (status) {
-    // Return an answer reporting this.
+export const answer = async (description: string, url: string, reason: string) => {
+  // Process the request.
+  const {result} = await processTestRequest(reason, {description, url});
+  // If the request was recorded:
+  if (result === 'ok') {
+    const query = {
+      description,
+      url,
+      reason
+    };
+    // Return the populated page.
+    return {
+      status: 'ok',
+      answerPage: await populateTemplate(import.meta.dirname, query)
+    };
+  }
+  // Otherwise, if the request is a duplicate:
+  else if (result === 'duplicate') {
+    // Report this.
     return {
       status: 'error',
-      message: `Page is already ${status}`
+      message: 'Test request duplicates an already submitted request'
     };
   }
-  // Otherwise, i.e. if it is requestable, process the request.
-  return await processTestRequest('test', import.meta.dirname, description, url, why);
+  // Otherwise, if a report is available about a page with the same description and URL:
+  else if (result === 'retest') {
+    // Report this.
+    return {
+      status: 'error',
+      message: 'A report about the page is already available'
+    }
+  }
+  // Otherwise, i.e. if a request to test a page with the same description or URL is approved:
+  else {
+    // Report this.
+    return {
+      status: 'error',
+      message: 'A request to test a page with the same description or URL is already approved'
+    }
+  }
 };

package/web/requestTest/requestTest.test.ts

@@ -72,8 +72,9 @@ test('answer returns ok with a populated answer page for a valid test request',
   // Verify the placeholders were replaced.
   assert.ok(result.answerPage.includes('Test Page'));
   assert.ok(result.answerPage.includes('Because accessibility'));
-  assert.ok(!result.answerPage.includes('__target__'));
-  assert.ok(!result.answerPage.includes('__why__'));
+  assert.ok(!result.answerPage.includes('__description__'));
+  assert.ok(!result.answerPage.includes('__url__'));
+  assert.ok(!result.answerPage.includes('__reason__'));
   // Verify the HTML is well-formed.
   const doc = parse(result.answerPage);
   const h1 = doc.querySelector('h1');
@@ -95,7 +96,7 @@ test('answer returns an error when the URL is already queued', {timeout: 500}, a
       'Queued Page', 'https://example.com/queued', 'Because accessibility'
     );
     assert.equal(result.status, 'error');
-    assert.ok(result.message.includes('queued'));
+    assert.equal(result.message, 'A request to test a page with the same description or URL is already approved');
   }
   finally {
     try {
@@ -107,9 +108,23 @@ test('answer returns an error when the URL is already queued', {timeout: 500}, a
   }
 });
 
-test('answer returns an error for an invalid request', {timeout: 500}, async () => {
+test('answer returns an error for a duplicate request', {timeout: 500}, async () => {
   const {answer} = await import('./index.ts');
-  const result: any = await answer('', 'not-a-url', 'why');
+  // Submit the same request twice; the second is a duplicate.
+  await answer('Duplicate Page', 'https://example.com/duplicate', 'Because accessibility');
+  const result: any = await answer(
+    'Duplicate Page', 'https://example.com/duplicate', 'Because accessibility'
+  );
+  assert.equal(result.status, 'error');
+  assert.equal(result.message, 'Test request duplicates an already submitted request');
+});
+
+test('answer returns an error when a report already exists for the page', {timeout: 500}, async () => {
+  const {answer} = await import('./index.ts');
+  // The fixture database already has a report for this description and URL.
+  const result: any = await answer(
+    'Mixed Outcomes Page', 'https://example.com/mixed', 'Because accessibility'
+  );
   assert.equal(result.status, 'error');
-  assert.equal(result.message, 'Invalid request');
+  assert.equal(result.message, 'A report about the page is already available');
 });

package/web/unhideReportForm/index.ts

@@ -5,7 +5,7 @@
 
 // IMPORTS
 
-import {hiddenReportsPath, populateTemplate, reportsPath} from '../../util.ts';
+import {hiddenReportsPath, populateTemplate, readdirOrCreate, reportsPath} from '../../util.ts';
 import fs from 'node:fs/promises';
 import path from 'node:path';
 
@@ -45,7 +45,7 @@ export const answer = async (_: any, search: string) => {
   // Initialize an array of data on reports to be unhidden.
   const reportsData: any[] = [];
   // Get the names of the hidden report files.
-  const hiddenReportFileNames = await fs.readdir(hiddenReportsPath());
+  const hiddenReportFileNames = await readdirOrCreate(hiddenReportsPath(), 'Hidden reports directory');
   // For each hidden report:
   for (const reportFileName of hiddenReportFileNames) {
     // Get its file.