@jrpool/kilotest 58.2.4 → 59.0.0

package/web/listReports/index.ts

@@ -1,182 +0,0 @@
-/*
-  index.ts
-  Lists all available reports.
-*/
-
-// IMPORTS
-
-import {
-  getJobNames,
-  getObject,
-  getReport,
-  getReportExtracts,
-  getTestRequests,
-  isReportError,
-  jobsPath,
-  objectSort,
-  populateTemplate
-} from '../../util.ts';
-import {
-  getMultiReportWhats,
-  getPageDataStrings,
-  getPageFactsLines,
-  getReportData
-} from '../util.ts';
-import path from 'node:path';
-
-// FUNCTIONS
-
-// Adds parameters to a query for the answer page.
-const populateQuery = async (query: Record<string, any>) => {
-  const margin = ' '.repeat(8);
-  // Initialize the classes of lines.
-  const lines: {requests: string[], queue: string[], claimed: string[], tested: string[]} = {
-    requests: [],
-    queue: [],
-    claimed: [],
-    tested: []
-  };
-  // Get the test requests.
-  const testRequests = await getTestRequests();
-  // For each requested URL:
-  Object.keys(testRequests).forEach(url => {
-    // For each of its requests:
-    testRequests[url]!.forEach((req: any) => {
-      const {description, reason} = req;
-      // Add a line.
-      lines.requests.push(`${margin}<li><code>${url}</code> (${description}): ${reason}</li>`);
-    });
-  });
-  // Sort the lines in alphabetical order by URL and secondarily by proposed name.
-  lines.requests.sort();
-  // Add the lines to the query.
-  query.requests = lines.requests.join('\n');
-  // Add a no-requests message, if applicable, to the query.
-  query.noRequests = lines.requests.length
-  ? 'Kilotest managers can <a href="enqueueForm.html">approve or reject a request</a>.'
-  : 'No requests await approval now.';
-  // Get the file names of all queued and claimed jobs.
-  const jobFileNames = await getJobNames();
-  // Initialize sets of the page descriptions and URLs of jobs in both categories.
-  const jobsData = {
-    queue: {
-      descriptions: new Set(),
-      urls: new Set()
-    },
-    claimed: {
-      descriptions: new Set(),
-      urls: new Set()
-    }
-  };
-  // For each job category:
-  for (const category of ['queue', 'claimed'] as const) {
-    // For each job in the category:
-    for (const fileName of jobFileNames[category]) {
-      // Get the job.
-      const job = await getObject(path.join(jobsPath(), category, fileName)) as {target: {url: string, what: string}};
-      // Get the description and URL of its page.
-      const {target} = job;
-      const {what, url} = target;
-      // Ensure they are in the sets of properties of the category.
-      jobsData[category].descriptions.add(what);
-      jobsData[category].urls.add(url);
-      // Add a line.
-      lines[category].push(`${margin}<li><code>${job.target.url}</code> (${job.target.what})</li>`);
-    }
-    // Add the lines to the query.
-    query[category] = lines[category].join('\n');
-  }
-  // Add a no-queued message, if applicable, to the query.
-  query.noQueued = lines.queue.length ? '' : 'No pages are queued for testing.';
-  // Add a no-claimed message, if applicable, to the query.
-  query.noClaimed = lines.claimed.length ? '' : 'No pages are being tested now.';
-  // Get extracts of all available reports.
-  const reportExtracts = await getReportExtracts();
-  const reportCount = reportExtracts.length;
-  query.which = reportCount ? 'the following' : 'no';
-  query.some = (reportCount || jobFileNames.queue.length || jobFileNames.claimed.length)
-  ? 'another'
-  : 'a';
-  const multiReportWhats = await getMultiReportWhats(reportExtracts);
-  // Sort them primarily by page description and secondarily by completion time.
-  let sortedExtracts = objectSort(reportExtracts, 'reportTime', 'alpha');
-  sortedExtracts = objectSort(sortedExtracts, 'description', 'alpha');
-  // For each report:
-  for (const extract of sortedExtracts) {
-    const {jobID, timeStamp, url, description, superseded} = extract;
-    // Get the report.
-    const report = await getReport(timeStamp, jobID);
-    // If this failed:
-    if (isReportError(report)) {
-      console.error(report.error);
-      // Populate the query with the reason.
-      query.error = report.error;
-      // Stop populating the query.
-      return;
-    }
-    // Otherwise, i.e. if it succeeded, get data about the report.
-    const reportData = getReportData(report);
-    const pageDataStrings = getPageDataStrings(report);
-    const {issueCount} = reportData;
-    const {testInfo} = pageDataStrings;
-    // Add lines about the report.
-    lines.tested.push(`${margin}<details>`);
-    const testText = multiReportWhats.includes(description) ? ` (${testInfo.toLowerCase()})` : '';
-    lines.tested.push(`${margin}  <summary>${description}${testText}</summary>`);
-    // Add the page facts to the lines.
-    lines.tested.push(...getPageFactsLines(pageDataStrings, reportData, `${margin}  `));
-    lines.tested.push(`${margin}  <ul class="nav">`);
-    // If any issues were reported:
-    if (issueCount) {
-      // Add a link to issue details to the lines.
-      const href = `href="listIssues.html/${timeStamp}/${jobID}"`;
-      const label = `aria-label="issue details for the ${description} page"`;
-      const link = `<a ${href} ${label}>Issue details</a>`;
-      lines.tested.push(`${margin}    <li>${link}</li>`);
-    }
-    let retestString: string = '';
-    // If a page with the same description or URL is being tested:
-    if (jobsData.claimed.descriptions.has(description) || jobsData.claimed.urls.has(url)) {
-      // Report this.
-      retestString = 'Currently being retested';
-    }
-    // Otherwise, if such a page is queued:
-    else if (jobsData.queue.descriptions.has(description) || jobsData.queue.urls.has(url)) {
-      retestString = 'Currently in the queue for retesting';
-    }
-    // Otherwise, if no such page is being tested or queued and the report is not superseded:
-    else if (!superseded) {
-      // Make the page available for retesting.
-      const href = `/requestRetestForm.html/${timeStamp}/${jobID}`;
-      const retestContent = 'Should Kilotest retest the page?';
-      retestString = `<a href="${href}">${retestContent}</a>`;
-    }
-    if (retestString) {
-      lines.tested.push(`${margin}    <li>${retestString}</li>`);
-    }
-    lines.tested.push(`${margin}  </ul>`);
-    lines.tested.push(`${margin}</details>`);
-  }
-  query.testedPages = lines.tested.join('\n');
-};
-// Returns a page answering the targets question.
-export const answer = async () => {
-  const query: Record<string, any> = {};
-  // Create a query to replace placeholders.
-  await populateQuery(query);
-  // 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.
-  const answerPage = await populateTemplate(import.meta.dirname, query);
-  // Return the populated page.
-  return {
-    status: 'ok',
-    answerPage
-  };
-};

package/web/listReports/listReports.test.ts

@@ -1,300 +0,0 @@
-/*
-  listReports.test.ts
-  UI tests for web/listReports/index.ts using the fixture corpus.
-*/
-
-// IMPORTS
-
-import {test, before, after} from 'node:test';
-import assert from 'node:assert/strict';
-import path from 'node:path';
-import fs from 'node:fs/promises';
-import {parse} from 'node-html-parser';
-import {answer} from './index.ts';
-
-// SETUP AND TEARDOWN
-
-const savedDBDir = process.env.DB_DIR;
-
-before(async () => {
-  process.env.DB_DIR = (await import('../../test/dbFixture.ts')).fixtureDBDir;
-  // Ensure job subdirectories exist (they are empty and not tracked by Git).
-  for (const sub of ['queue', 'claimed', 'failed']) {
-    await fs.mkdir(path.join(process.env.DB_DIR, 'jobs', sub), {recursive: true});
-  }
-});
-
-after(() => {
-  if (savedDBDir !== undefined) {
-    process.env.DB_DIR = savedDBDir;
-  }
-  else {
-    delete process.env.DB_DIR;
-  }
-});
-
-// TESTS
-
-test('listReports returns an ok status with valid HTML', async () => {
-  const result: any = await answer();
-  assert.equal(result.status, 'ok');
-  assert.ok(result.answerPage);
-  const html = parse(result.answerPage);
-  assert.equal(html.querySelector('title')?.text, 'Pages tested | Kilotest');
-});
-
-test('listReports includes the 8 non-hidden fixture reports as details elements', async () => {
-  const result: any = await answer();
-  const html = parse(result.answerPage);
-  const details = html.querySelectorAll('details');
-  assert.equal(details.length, 8);
-});
-
-test('listReports includes the page descriptions in summary elements', async () => {
-  const result: any = await answer();
-  const html = parse(result.answerPage);
-  const summaries = html.querySelectorAll('details > summary').map(s => s.text);
-  assert.ok(summaries.some(s => s.startsWith('Mixed Outcomes Page')));
-  assert.ok(summaries.some(s => s.startsWith('All CantTell Page')));
-  assert.ok(summaries.some(s => s.startsWith('No Outcomes Page')));
-  assert.ok(summaries.some(s => s.startsWith('Empty Results Page')));
-  assert.ok(summaries.some(s => s.startsWith('Prevented Page')));
-});
-
-test('listReports does not include the hidden report', async () => {
-  const result: any = await answer();
-  assert.ok(!result.answerPage.includes('Hidden Page'));
-});
-
-test('listReports includes links to listIssues for reports with issues', async () => {
-  const result: any = await answer();
-  const html = parse(result.answerPage);
-  const issueLinks = html.querySelectorAll('a[href*="listIssues.html"]');
-  assert.ok(issueLinks.length > 0);
-  const hrefs = issueLinks.map(a => a.getAttribute('href'));
-  assert.ok(hrefs.some(href => href?.includes('260101T0000/mix')));
-});
-
-test('listReports includes the page URLs in the report details', async () => {
-  const result: any = await answer();
-  assert.ok(result.answerPage.includes('https://example.com/mixed'));
-  assert.ok(result.answerPage.includes('https://example.com/canttell'));
-});
-
-test('listReports includes a link to request testing a new page', async () => {
-  const result: any = await answer();
-  const html = parse(result.answerPage);
-  const testLink = html.querySelector('a[href="requestNewTestForm.html"]');
-  assert.ok(testLink);
-});
-
-test('listReports shows requests when testRequests.json has entries', {timeout: 500}, async () => {
-  const dbDir = (await import('../../test/dbFixture.ts')).fixtureDBDir;
-  const testRequestsPath = path.join(dbDir, 'jobs', 'testRequests.json');
-  const originalTestRequests = await fs.readFile(testRequestsPath, 'utf8');
-  try {
-    const testRequests = {
-      'https://example.com/mixed': [
-        {description: 'Mixed Outcomes Page', reason: 'Needs retesting for accessibility'}
-      ]
-    };
-    await fs.writeFile(testRequestsPath, JSON.stringify(testRequests, null, 2));
-    const result: any = await answer();
-    assert.equal(result.status, 'ok');
-    assert.ok(result.answerPage.includes('https://example.com/mixed'));
-    assert.ok(result.answerPage.includes('Needs retesting for accessibility'));
-  }
-  finally {
-    await fs.writeFile(testRequestsPath, originalTestRequests);
-  }
-});
-
-test('listReports shows queued and claimed jobs when they exist', async () => {
-  const dbDir = (await import('../../test/dbFixture.ts')).fixtureDBDir;
-  const queueDir = path.join(dbDir, 'jobs', 'queue');
-  const claimedDir = path.join(dbDir, 'jobs', 'claimed');
-  const queueFile = path.join(queueDir, 'queuedJob.json');
-  const claimedFile = path.join(claimedDir, 'claimedJob.json');
-  try {
-    const queuedJob = {
-      target: {url: 'https://example.com/queued', what: 'Queued Page'}
-    };
-    const claimedJob = {
-      target: {url: 'https://example.com/claimed', what: 'Claimed Page'}
-    };
-    await fs.writeFile(queueFile, JSON.stringify(queuedJob, null, 2));
-    await fs.writeFile(claimedFile, JSON.stringify(claimedJob, null, 2));
-    const result: any = await answer();
-    assert.equal(result.status, 'ok');
-    assert.ok(result.answerPage.includes('https://example.com/queued'));
-    assert.ok(result.answerPage.includes('Queued Page'));
-    assert.ok(result.answerPage.includes('https://example.com/claimed'));
-    assert.ok(result.answerPage.includes('Claimed Page'));
-  }
-  finally {
-    await fs.unlink(queueFile).catch(() => {});
-    await fs.unlink(claimedFile).catch(() => {});
-  }
-});
-
-test('listReports shows claimed retest status for a report with a matching claimed job', async () => {
-  const dbDir = (await import('../../test/dbFixture.ts')).fixtureDBDir;
-  const claimedDir = path.join(dbDir, 'jobs', 'claimed');
-  const claimedFile = path.join(claimedDir, 'claimedRetest.json');
-  try {
-    const claimedJob = {
-      target: {url: 'https://example.com/mixed', what: 'Mixed Outcomes Page'}
-    };
-    await fs.writeFile(claimedFile, JSON.stringify(claimedJob, null, 2));
-    const result: any = await answer();
-    assert.equal(result.status, 'ok');
-    assert.ok(result.answerPage.includes('Currently being retested'));
-  }
-  finally {
-    await fs.unlink(claimedFile).catch(() => {});
-  }
-});
-
-test('listReports shows queued retest status for a report with a matching queued job', async () => {
-  const dbDir = (await import('../../test/dbFixture.ts')).fixtureDBDir;
-  const queueDir = path.join(dbDir, 'jobs', 'queue');
-  const queueFile = path.join(queueDir, 'queuedRetest.json');
-  try {
-    const queuedJob = {
-      target: {url: 'https://example.com/mixed', what: 'Mixed Outcomes Page'}
-    };
-    await fs.writeFile(queueFile, JSON.stringify(queuedJob, null, 2));
-    const result: any = await answer();
-    assert.equal(result.status, 'ok');
-    assert.ok(result.answerPage.includes('Currently in the queue for retesting'));
-  }
-  finally {
-    await fs.unlink(queueFile).catch(() => {});
-  }
-});
-
-test('listReports returns an error when a report file is invalid', {timeout: 500}, async () => {
-  const dbDir = (await import('../../test/dbFixture.ts')).fixtureDBDir;
-  const reportsDir = path.join(dbDir, 'reports');
-  const invalidReportPath = path.join(reportsDir, '260101T9999-bad.json');
-  try {
-    // Valid for getReportExtract (has target and jobData.endTime) but not usable by isUsableReport (no acts or catalog).
-    const invalidReport = {
-      target: {what: 'Invalid Report', url: 'https://example.com/invalid'},
-      jobData: {endTime: '26-01-01T00:10'}
-    };
-    await fs.writeFile(invalidReportPath, JSON.stringify(invalidReport, null, 2));
-    const result: any = await answer();
-    assert.equal(result.status, 'error');
-    assert.ok(result.message);
-  }
-  finally {
-    await fs.unlink(invalidReportPath).catch(() => {});
-  }
-});
-
-test('listReports shows no-reports message when the database is empty', async () => {
-  // Create a temp DB with empty reports and jobs directories.
-  const os = await import('node:os');
-  const tmpDir = await fs.mkdtemp(path.join(os.tmpdir(), 'listreports-empty-'));
-  await fs.mkdir(path.join(tmpDir, 'reports'), {recursive: true});
-  await fs.mkdir(path.join(tmpDir, 'jobs', 'queue'), {recursive: true});
-  await fs.mkdir(path.join(tmpDir, 'jobs', 'claimed'), {recursive: true});
-  await fs.mkdir(path.join(tmpDir, 'jobs', 'failed'), {recursive: true});
-  await fs.writeFile(path.join(tmpDir, 'jobs', 'testRequests.json'), '{}\n');
-  const savedDBDir = process.env.DB_DIR;
-  process.env.DB_DIR = tmpDir;
-  try {
-    const {answer} = await import('./index.ts');
-    const result: any = await answer();
-    assert.equal(result.status, 'ok');
-    assert.ok(result.answerPage.includes('no'));
-    assert.ok(result.answerPage.includes(' a '));
-  }
-  finally {
-    process.env.DB_DIR = savedDBDir;
-    await fs.rm(tmpDir, {recursive: true}).catch(() => {});
-  }
-});
-
-// Returns the details element of the report whose summary starts with a description and whose issue link, if required, contains a fragment.
-const getReportDetails = (html: any, description: string, hrefFragment?: string) => {
-  const matches = html.querySelectorAll('details').filter((d: any) => {
-    const summary = d.querySelector('summary')?.text ?? '';
-    if (!summary.startsWith(description)) {
-      return false;
-    }
-    return hrefFragment === undefined
-    || d.querySelectorAll('a').some((a: any) => a.getAttribute('href')?.includes(hrefFragment));
-  });
-  assert.equal(matches.length, 1, `exactly one report matches ${description} ${hrefFragment ?? ''}`);
-  return matches[0];
-};
-
-// Returns the 3 rule-engine amounts and the 3 summary amounts of a details element.
-const getResultFacts = (details: any) => {
-  const items = details.querySelectorAll('li');
-  const itemTexts: string[] = items.map((li: any) => li.text.trim());
-  const getAmount = (label: string) => {
-    const text = itemTexts.find(t => t.startsWith(`${label}: `));
-    assert.ok(text, `${label} item exists`);
-    return Number(text.slice(label.length + 2));
-  };
-  // The summary item is the parent of the rule-engine item and the 3 amount items.
-  const summaryItem = items.find((li: any) => li.text.trim().startsWith('Summary of results:'));
-  assert.ok(summaryItem, 'Summary of results item exists');
-  const summaryList = summaryItem.querySelector('ul');
-  const amountLabels = summaryList.childNodes
-  .filter((node: any) => node.tagName === 'LI')
-  .map((li: any) => li.text.trim().split(':')[0]);
-  return {
-    called: getAmount('Called'),
-    tested: getAmount('Were able to test'),
-    reporters: getAmount('Reported any rule violations'),
-    amountLabels,
-    violations: getAmount('Violations'),
-    violators: getAmount('Violators'),
-    issues: getAmount('Issues')
-  };
-};
-
-// Expected facts, hand-computed from the fixtures.
-const expectedFacts: [string, string | undefined, number, number, number, number, number, number][] = [
-  // Description, issue-link fragment, engines called, engines able to test, reporting engines, violations, violators, issues.
-  ['Mixed Outcomes Page', '260101T0000/mix', 2, 2, 2, 3, 2, 2],
-  ['Mixed Outcomes Page', '260202T0000/new', 1, 1, 1, 1, 1, 1],
-  ['All CantTell Page', undefined, 1, 1, 0, 0, 0, 0],
-  ['No Outcomes Page', undefined, 1, 1, 1, 1, 1, 1],
-  ['Empty Results Page', undefined, 1, 1, 0, 0, 0, 0],
-  ['Prevented Page', undefined, 2, 1, 1, 1, 1, 1],
-  ['Multi Violator Page', undefined, 2, 2, 2, 4, 3, 1],
-  ['Branch Coverage Page', undefined, 3, 3, 1, 4, 4, 1]
-];
-
-for (const [description, fragment, called, tested, reporters, violations, violators, issues] of expectedFacts) {
-  test(`listReports gives correct rule-engine and summary amounts for ${description}${fragment ? ` (${fragment})` : ''}`, async () => {
-    const result: any = await answer();
-    const html = parse(result.answerPage);
-    const facts = getResultFacts(getReportDetails(html, description, fragment));
-    assert.equal(facts.called, called);
-    assert.equal(facts.tested, tested);
-    assert.equal(facts.reporters, reporters);
-    assert.deepEqual(facts.amountLabels, ['Rule engines', 'Violations', 'Violators', 'Issues']);
-    assert.equal(facts.violations, violations);
-    assert.equal(facts.violators, violators);
-    assert.equal(facts.issues, issues);
-  });
-}
-
-test('listReports counts a prevented rule engine as called but not able to test', async () => {
-  const result: any = await answer();
-  const html = parse(result.answerPage);
-  const prevented = getResultFacts(getReportDetails(html, 'Prevented Page'));
-  assert.equal(prevented.called - prevented.tested, 1);
-  const others = html.querySelectorAll('details').filter((d: any) => !d.text.includes('Prevented Page'));
-  assert.equal(others.length, 7);
-  assert.ok(others.every((d: any) => {
-    const facts = getResultFacts(d);
-    return facts.called === facts.tested;
-  }));
-});