@jrpool/kilotest 46.1.0 → 47.0.1

package/web/enqueue/index.js

@@ -1,67 +0,0 @@
-/*
-  index.js
-  Implements a test request approval.
-*/
-
-// IMPORTS
-
-const {
-  getJSON, getNowStamp, getRandomString, getRecs, isURL, jobsPath, recsLock
-} = require('../../util');
-const fs = require('fs/promises');
-const path = require('path');
-
-// FUNCTIONS
-
-// Implements a test request approval and returns a revised request page.
-exports.answer = async (url, what, authCode) => {
-  // If the arguments are valid:
-  if (isURL(url) && what && authCode === process.env.AUTH_CODE) {
-    // Get the job template.
-    const jobTemplateJSON = await fs.readFile(path.join(__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 = what;
-    job.target.url = url;
-    const query = {
-      target: what,
-      jobName
-    };
-    // Save the job in the queue.
-    await fs.writeFile(
-      path.join(jobsPath(), 'queue', `${jobName}.json`), getJSON(job)
-    );
-    console.log(`Retest queued for ${what} as job ${jobName}`);
-    // Isolate this revision.
-    await recsLock(async () => {
-      // Get the recommendations.
-      const recs = await getRecs();
-      // Delete the recommendations to test the target.
-      delete recs[url];
-      // Save the revised recommendations.
-      await fs.writeFile(path.join(jobsPath(), 'recs.json'), getJSON(recs));
-    });
-    // Get the answer 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]);
-    });
-    // 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.js

@@ -1,49 +0,0 @@
-/*
-  index.js
-  Serves a form for approving or rejecting a test request.
-*/
-
-// IMPORTS
-
-const {getRecs} = require('../../util');
-const fs = require('fs/promises');
-const path = require('path');
-
-// FUNCTIONS
-
-// Returns a test order form.
-exports.answer = async () => {
-  const recs = await getRecs();
-  const urls = Object.keys(recs);
-  const margin = ' '.repeat(12);
-  const lines = [];
-  // For each page with any recommendations:
-  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 recommended target names for the page.
-    const targetNames = new Set(recs[url].map(rec => rec.what));
-    // For each recommended target name:
-    targetNames.forEach(what => {
-      const radio = `<input type="radio" name="target" value="${url}\t${what}" required>`;
-      // Add a radio button and the recommended page name to the lines.
-      lines.push(`${margin}    <p>${radio} ${what}</p>`);
-    });
-  });
-  const query = {
-    recs: lines.join('\n'),
-    noRecs: urls.length ? '' : 'No recommendations exist now.',
-    disabled: urls.length ? '' : ' disabled'
-  };
-  // 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]);
-  });
-  // Return the populated page.
-  return {
-    status: 'ok',
-    answerPage
-  };
-};

package/web/manage/index.js

@@ -1,22 +0,0 @@
-/*
-  index.js
-  Lists the actions that managers can take.
-*/
-
-// IMPORTS
-
-const fs = require('fs/promises');
-const path = require('path');
-
-// FUNCTIONS
-
-// Returns the answer page.
-exports.answer = async () => {
-  // Get the answer page.
-  let answerPage = await fs.readFile(path.join(__dirname, 'index.html'), 'utf8');
-  // Return it.
-  return {
-    status: 'ok',
-    answerPage
-  };
-};

package/web/pruneReportsForm/index.js

@@ -1,123 +0,0 @@
-/*
-  index.js
-  Serves a form for deleting superseded reports.
-*/
-
-// IMPORTS
-
-const {getReportData, reportsPath} = require('../../util');
-const fs = require('fs/promises');
-const path = require('path');
-
-// FUNCTIONS
-
-// Returns a form for deleting non-latest reports.
-exports.answer = async (_, search) => {
-  const searchParams = new URLSearchParams(search);
-  const authCode = searchParams?.get('authCode');
-  const jobNames = searchParams?.getAll('report');
-  // If the form has displayed itself after a submission and any reports are to be deleted:
-  if (jobNames?.length) {
-    // If the authorization code is valid:
-    if (authCode === process.env.AUTH_CODE) {
-      try {
-        // For each report to be deleted:
-        for (const jobName of jobNames) {
-          // Delete it.
-          await fs.unlink(path.join(reportsPath(), `${jobName}.json`));
-        }
-      }
-      // If this failed:
-      catch (error) {
-        // Return why.
-        return {
-          status: 'error',
-          message: `Deleting superseded reports failed (${error.message})`
-        }
-      }
-    }
-    // Otherwise, i.e. if the authorization code is invalid:
-    else {
-      // Return this.
-      return {
-        status: 'error',
-        message: 'Invalid authorization code'
-      }
-    }
-  }
-  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 reportFacts = await getReportData(timeStamp, jobID);
-    const {error, issueCount, preventedEngineCount, url} = reportFacts;
-    // If this failed:
-    if (error) {
-      // Return why.
-      return {
-        status: 'error',
-        message: error.message
-      }
-    }
-    // Otherwise, i.e. if it succeeded, add the summary to the array.
-    reportSpecs.push({
-      timeStamp,
-      jobID,
-      issueCount,
-      preventedEngineCount,
-      url
-    });
-  }
-  // Sort the summaries by URL and then by time stamp.
-  reportSpecs.sort((a, b) => {
-    if (a.url === b.url) {
-      return a.timeStamp.localeCompare(b.timeStamp);
-    }
-    return a.url.localeCompare(b.url);
-  });
-  const lines = [];
-  const margin = ' '.repeat(12);
-  let anyDeletable = false;
-  // For each summary:
-  reportSpecs.forEach((spec, index) => {
-    const {timeStamp, jobID, issueCount, preventedEngineCount, url} = spec;
-    const jobName = `${timeStamp}-${jobID}`;
-    const specString = `<code>${url}</code> (<code>${jobName}</code>): preventions ${preventedEngineCount}, issues ${issueCount}`;
-    // If its report is a non-latest report:
-    if (reportSpecs[index + 1]?.url === url) {
-      // Add a line with a deletion checkbox.
-      lines.push(
-        `${margin}<p><input type="checkbox" name="report" value="${jobName}"> ${specString}</p>`
-      );
-      anyDeletable = true;
-    }
-    // Otherwise, i.e. if its report is a latest report:
-    else {
-      // Add a line without a deletion checkbox.
-      lines.push(`${margin}<p>${specString}</p>`);
-    }
-  });
-  const intro = anyDeletable
-  ? 'Choose the superseded reports to delete.'
-  : 'Each target has only 1 report, so there are no superseded reports to delete.';
-  const disabled = anyDeletable ? '' : ' disabled';
-  const query = {
-    reports: lines.join('\n'),
-    intro,
-    disabled
-  };
-  // 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]);
-  });
-  // Return the populated page.
-  return {
-    status: 'ok',
-    answerPage
-  };
-};

package/web/reannotate/index.js

@@ -1,58 +0,0 @@
-/*
-  index.js
-  Reannotates all available latest reports.
-*/
-
-// IMPORTS
-
-const {annotateReport, getReportExtracts} = require('../../util');
-const fs = require('fs/promises');
-const path = require('path');
-
-// FUNCTIONS
-
-// Implements a reannotation order and returns an acknowledgement page.
-exports.answer = async authCode => {
-  // If the authorization code is valid:
-  if (authCode === process.env.AUTH_CODE) {
-    // Get data on the available reports.
-    const reportExtracts = await getReportExtracts();
-    // If any exist:
-    if (reportExtracts.length) {
-      // For each report:
-      for (const reportExtract of reportExtracts) {
-        const {timeStamp, jobID} = reportExtract;
-        // Reannotate it.
-        const annotationError = await annotateReport(timeStamp, jobID);
-        // If this failed:
-        if (annotationError) {
-          // Return an error page.
-          return {
-            status: 'error',
-            message: annotationError
-          };
-        }
-      }
-    }
-    // Otherwis, i.e. if it failed:
-    else {
-      // Return an error page.
-      return {
-        status: 'error',
-        message: 'Got data on no available reports'
-      };
-    }
-    // If every annotation succeeded, get the answer page.
-    let answerPage = await fs.readFile(path.join(__dirname, 'index.html'), 'utf8');
-    // Return it.
-    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/renewWCAGForm/index.js

@@ -1,22 +0,0 @@
-/*
-  index.js
-  Serves a form for renewing the WCAG map.
-*/
-
-// IMPORTS
-
-const fs = require('fs/promises');
-const path = require('path');
-
-// FUNCTIONS
-
-// Returns a form for renewing the WCAG map.
-exports.answer = async () => {
-  // Get the map renewal form.
-  const answerPage = await fs.readFile(path.join(__dirname, 'index.html'), 'utf8');
-  // Return it.
-  return {
-    status: 'ok',
-    answerPage
-  };
-};

package/web/requestRetest/index.js

@@ -1,31 +0,0 @@
-/*
-  index.js
-  Records a retest request.
-*/
-
-// IMPORTS
-
-const {getLatestReportExtracts, processTestRequest} = require('../../util');
-
-// FUNCTIONS
-
-exports.answer = async (pageArgs, why) => {
-  const [timeStamp, jobID] = pageArgs.split('/');
-  // Get data on the latest available reports.
-  const reportExtracts = await getLatestReportExtracts();
-  // Get data on the report whose page is to be retested.
-  const reportExtract = reportExtracts.find(
-    reportExtract => reportExtract.timeStamp === timeStamp && reportExtract.jobID === jobID
-  );
-  const {error, url, what} = reportExtract;
-  // If this failed:
-  if (error) {
-    // Return why.
-    return {
-      status: 'error',
-      message: error
-    };
-  }
-  // Otherwise, i.e. if it succeeded, process the request.
-  return await processTestRequest('retest', __dirname, what, url, why);
-};

package/web/requestRetest/requestRetest.test.js

@@ -1,119 +0,0 @@
-/*
-  requestRetest.test.js
-  Unit tests for web/requestRetest/index.js, covering the success path of answer.
-*/
-
-// IMPORTS
-
-const {test, before, after, beforeEach} = require('node:test');
-const assert = require('node:assert/strict');
-const fs = require('node:fs/promises');
-const path = require('node:path');
-const {parse} = require('node-html-parser');
-
-// CONSTANTS
-
-const fixtureDBDir = path.join(__dirname, '..', '..', 'test', 'fixtures', 'db');
-const recsPath = path.join(fixtureDBDir, 'jobs', 'recs.json');
-
-// SETUP AND TEARDOWN
-
-before(async () => {
-  process.env.DB_DIR = fixtureDBDir;
-  process.env.AUTH_CODE = 'test-auth-code';
-});
-
-beforeEach(async () => {
-  // Reset recs.json and clean job directories before each test.
-  await fs.writeFile(recsPath, '{}\n');
-  for (const sub of ['claimed', 'queue', 'failed']) {
-    const dir = path.join(fixtureDBDir, 'jobs', sub);
-    await fs.mkdir(dir, {recursive: true});
-    const files = await fs.readdir(dir).catch(() => []);
-    for (const file of files) {
-      try {
-        await fs.unlink(path.join(dir, file));
-      }
-      catch {
-        // Ignore cleanup errors for files that may not exist.
-      }
-    }
-  }
-});
-
-after(async () => {
-  // Restore recs.json and clean job directories after all tests.
-  await fs.writeFile(recsPath, '{}\n');
-  for (const sub of ['claimed', 'queue', 'failed']) {
-    const dir = path.join(fixtureDBDir, 'jobs', sub);
-    await fs.mkdir(dir, {recursive: true});
-    const files = await fs.readdir(dir).catch(() => []);
-    for (const file of files) {
-      try {
-        await fs.unlink(path.join(dir, file));
-      }
-      catch {
-        // Ignore cleanup errors for files that may not exist.
-      }
-    }
-  }
-});
-
-// TESTS
-
-test('answer returns ok with a populated answer page for a valid retest request', async () => {
-  // Require the module after DB_DIR is set.
-  const {answer} = require('./index');
-  // Use the 260101T0001-ct report (All CantTell Page, https://example.com/canttell).
-  const result = 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.
-  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__'));
-  // Verify the HTML is well-formed.
-  const doc = parse(result.answerPage);
-  const h1 = doc.querySelector('h1');
-  assert.ok(h1);
-  assert.ok(h1.textContent.includes('All CantTell Page'));
-});
-
-test('answer throws when the report does not exist', async () => {
-  const {answer} = require('./index');
-  // Use a nonexistent report timestamp and jobID.
-  await assert.rejects(
-    () => answer('990101T0000/xxx', 'Because changes were made'),
-    /Cannot destructure property 'error'/
-  );
-});
-
-test('answer returns an error for an invalid retest recommendation', async () => {
-  const {answer} = require('./index');
-  // Use a valid report but a too-short reason.
-  const result = await answer('260101T0001/ct', 'why');
-  assert.equal(result.status, 'error');
-  assert.equal(result.message, 'Invalid recommendation');
-});
-
-test('answer returns an error when the report extract has an error', async () => {
-  // Mock getLatestReportExtracts to return an extract with an error.
-  const util = require('../../util');
-  const original = util.getLatestReportExtracts;
-  util.getLatestReportExtracts = async () => [
-    {timeStamp: '260101T0001', jobID: 'ct', error: 'Report data unavailable'}
-  ];
-  try {
-    // Re-require to pick up the mocked function.
-    delete require.cache[require.resolve('./index')];
-    const {answer} = require('./index');
-    const result = await answer('260101T0001/ct', 'Because changes were made');
-    assert.equal(result.status, 'error');
-    assert.equal(result.message, 'Report data unavailable');
-  }
-  finally {
-    util.getLatestReportExtracts = original;
-    delete require.cache[require.resolve('./index')];
-  }
-});

package/web/requestTestForm/index.js

@@ -1,21 +0,0 @@
-/*
-  index.js
-  Serves a form for requesting a test.
-*/
-
-// IMPORTS
-
-const fs = require('fs/promises');
-const path = require('path');
-
-// FUNCTIONS
-
-exports.answer = async () => {
-  // Get the test request form template.
-  let answerPage = await fs.readFile(path.join(__dirname, 'index.html'), 'utf8');
-  // Return it.
-  return {
-    status: 'ok',
-    answerPage
-  };
-};

package/web/rewindReportsForm/index.js

@@ -1,121 +0,0 @@
-/*
-  index.js
-  Serves a form for deleting latest superseding reports.
-*/
-
-// IMPORTS
-
-const {getReportData, reportsPath} = require('../../util');
-const fs = require('fs/promises');
-const path = require('path');
-
-// FUNCTIONS
-
-// Returns a form for deleting latest superseding reports.
-exports.answer = async (_, search) => {
-  const searchParams = new URLSearchParams(search);
-  const authCode = searchParams?.get('authCode');
-  const jobNames = searchParams?.getAll('report');
-  // If the form has been displayed by itself after a submission and any reports are to be deleted:
-  if (jobNames?.length) {
-    // If the authorization code is valid:
-    if (authCode === process.env.AUTH_CODE) {
-      try {
-        // For each report to be deleted:
-        for (const jobName of jobNames) {
-          // Delete it.
-          await fs.unlink(path.join(reportsPath(), `${jobName}.json`));
-        }
-      }
-      // If this failed:
-      catch (error) {
-        // Return why.
-        return {
-          status: 'error',
-          message: `Deleting latest superseding reports failed (${error.message})`
-        }
-      }
-    }
-    // Otherwise, i.e. if the authorization code is invalid:
-    else {
-      // Report the error.
-      return {
-        status: 'error',
-        message: 'Invalid authorization code'
-      }
-    }
-  }
-  const reportNames = await fs.readdir(reportsPath());
-  const reportSpecs = [];
-  // For each report:
-  for (const reportName of reportNames) {
-    const [timeStamp, jobID] = reportName.slice(0, -5).split('-');
-    // Get a summary of it.
-    const reportFacts = await getReportData(timeStamp, jobID);
-    const {error, issueCount, preventedEngineCount, url} = reportFacts;
-    // If this failed:
-    if (error) {
-      // Return why.
-      return {
-        status: 'error',
-        message: error
-      }
-    }
-    reportSpecs.push({
-      timeStamp,
-      jobID,
-      issueCount,
-      preventedEngineCount,
-      url
-    });
-  }
-  // Sort the summaries by URL and then by time stamp.
-  reportSpecs.sort((a, b) => {
-    if (a.url === b.url) {
-      return a.timeStamp.localeCompare(b.timeStamp);
-    }
-    return a.url.localeCompare(b.url);
-  });
-  const lines = [];
-  const margin = ' '.repeat(12);
-  let anyDeletable = false;
-  // For each summary:
-  reportSpecs.forEach((spec, index) => {
-    const {timeStamp, jobID, issueCount, preventedEngineCount, url} = spec;
-    const jobName = `${timeStamp}-${jobID}`;
-    const specString = `<code>${url}</code> (<code>${jobName}</code>): preventions ${preventedEngineCount}, issues ${issueCount}`;
-    // If its report is the latest report on a target with at least 2 reports:
-    if (reportSpecs[index - 1]?.url === url && reportSpecs[index + 1]?.url !== url) {
-      // Add a line with a deletion checkbox.
-      lines.push(
-        `${margin}<p><input type="checkbox" name="report" value="${jobName}"> ${specString}</p>`
-      );
-      anyDeletable = true;
-    }
-    // Otherwise, i.e. if its report is a superseded report or the only report on its target:
-    else {
-      // Add a line without a deletion checkbox.
-      lines.push(`${margin}<p>${specString}</p>`);
-    }
-  });
-  const intro = anyDeletable
-  ? 'Choose the latest superseding reports to delete.'
-  : 'Each target has only 1 report, so there are no reports to delete.';
-  const disabled = anyDeletable ? '' : ' disabled';
-  const query = {
-    reports: lines.join('\n'),
-    intro,
-    disabled
-  };
-  // 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]);
-  });
-  // Return the populated page.
-  return {
-    status: 'ok',
-    answerPage
-  };
-};