@jrpool/kilotest 46.1.2 → 48.0.0

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

@@ -1,17 +1,17 @@
 /*
-  unhideReportForm.test.js
-  Unit tests for web/unhideReportForm/index.js.
+  unhideReportForm.test.ts
+  Unit tests for web/unhideReportForm/index.ts.
 */
 
 // IMPORTS
 
-const {test, before, after, beforeEach} = 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, beforeEach} 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';
 
 // CONSTANTS
 
@@ -21,7 +21,7 @@ const hiddenFile = '260101T0007-hid.json';
 
 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';
 
 const getPaths = () => ({
   hidden: path.join(hiddenReportsPath(), hiddenFile),
@@ -64,7 +64,7 @@ after(async () => {
 // TESTS
 
 test('unhideReportForm displays a list of hidden 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);
@@ -73,21 +73,21 @@ test('unhideReportForm displays a list of hidden reports when no submission', as
 });
 
 test('unhideReportForm returns an error for an invalid auth code', async () => {
-  const result = await answer(null, 'authCode=wrong&report=260101T0007-hid');
+  const result: any = await answer(null, 'authCode=wrong&report=260101T0007-hid');
   assert.equal(result.status, 'error');
   assert.equal(result.message, 'Invalid authorization code');
 });
 
 test('unhideReportForm unhides a report with valid auth code', async () => {
   const {report} = getPaths();
-  const result = await answer(null, 'authCode=test-auth-code&report=260101T0007-hid');
+  const result: any = await answer(null, 'authCode=test-auth-code&report=260101T0007-hid');
   assert.equal(result.status, 'ok');
   // The report should now be in the reports directory.
   await fs.access(report);
 });
 
 test('unhideReportForm returns an error when unhiding 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('Unhiding report'));
 });
@@ -102,7 +102,7 @@ test('unhideReportForm sorts hidden reports with the same page name by timeStamp
   const copyPath = path.join(hiddenReportsPath(), '260101T0010-hid2.json');
   await fs.writeFile(copyPath, JSON.stringify(copy));
   try {
-    const result = await answer(null, '');
+    const result: any = await answer(null, '');
     assert.equal(result.status, 'ok');
     // Both reports should appear in the form.
     assert.ok(result.answerPage.includes('260101T0007-hid'));
@@ -123,7 +123,7 @@ test('unhideReportForm sorts hidden reports with different page names alphabetic
   const copyPath = path.join(hiddenReportsPath(), '260101T0011-hid3.json');
   await fs.writeFile(copyPath, JSON.stringify(copy));
   try {
-    const result = await answer(null, '');
+    const result: any = await answer(null, '');
     assert.equal(result.status, 'ok');
     // Both reports should appear in the form.
     assert.ok(result.answerPage.includes('260101T0007-hid'));

package/aceconfig.js

@@ -1,28 +0,0 @@
-/*
-  © 2021–2025 CVS Health and/or one of its affiliates. All rights reserved.
-  © 2025 Jonathan Robert Pool.
-
-  Licensed under the MIT License. See LICENSE file at the project root or
-  https://opensource.org/license/mit/ for details.
-
-  SPDX-License-Identifier: MIT
-*/
-
-/*
-  aceconfig
-  Configuration for the ibm rule engine.
-*/
-
-const os = require('os');
-
-const tmpDir = os.tmpdir();
-
-module.exports = {
-  reportLevels: [
-    'violation',
-    'recommendation'
-  ],
-  cacheFolder: tmpDir,
-  outputFolder: tmpDir,
-  puppeteerArgs: ['--no-sandbox', '--disable-setuid-sandbox']
-};

package/api/listReports.js

@@ -1,89 +0,0 @@
-/*
-  listReports.js
-  Returns basics about all the available reports.
-*/
-
-// IMPORTS
-
-const {getReportBasics, getResponseMetadata, getToolsFacts, thisHost} = require('./util');
-const {getLatestReportExtracts, getReportExtracts} = require('../util');
-
-// FUNCTIONS
-
-// Returns the response body.
-exports.response = async () => {
-  // Initialize the response content.
-  const responseContent = {
-    'basics about all available reports': null,
-    'how to request that a page with no report be tested': null,
-    'how a web user can request that the page be tested': null
-  };
-  // Initialize an array of basics about the reports.
-  const reportsBasics = [];
-  // Get extracts of all available reports.
-  const reportExtracts = await getReportExtracts();
-  // Get the latest report extracts once, to avoid recomputing them for every report.
-  const latestReportExtracts = await getLatestReportExtracts();
-  // For each report:
-  for (const extract of reportExtracts) {
-    const {error, jobID, timeStamp} = extract;
-    // Get the basics about it (which may be only an error message).
-    const reportBasics = await getReportBasics(timeStamp, jobID, extract, latestReportExtracts);
-    // If this succeeded:
-    if (!error) {
-      // Add instructions for getting details to the basics.
-      reportBasics['how to get details about the report'] = {
-        method: 'GET',
-        URL: `${thisHost}/api/listIssues/${timeStamp}/${jobID}`
-      };
-      reportBasics['web users can get details about the report at'] = `${thisHost}/listIssues.html/${timeStamp}/${jobID}`;
-      // Add the basics to the array.
-      reportsBasics.push(reportBasics);
-    }
-  }
-  // Sort the array by page description and secondarily by completion recency.
-  reportsBasics.sort((a, b) => {
-    if (a['tested web page'].description !== b['tested web page'].description) {
-      return a['tested web page']
-      .description
-      .localeCompare(b['tested web page'].description, 'en', {sensitivity: 'base'});
-    }
-    return a['completion date and time'].localeCompare(b['completion date and time']);
-  });
-  // Add the sorted basics about the reports to the response content.
-  responseContent['basics about all available reports'] = reportsBasics;
-  // Add instructions for requesting a test to the response content.
-  responseContent['how to request that a page with no report be tested'] = {
-    method: 'POST',
-    URL: `${thisHost}/api/requestTest`,
-    'request body': {
-      description: '10- to 100-character description of the page conforming to the naming convention used in this list of reports',
-      URL: '12- to 300-character URL of the page, including the https:// scheme and any query',
-      reason: '20- to 100-character reason why the page should be tested'
-    },
-    'how to check whether the request has been fulfilled': 'use this listReports tool to determine whether a report about the page has become available (typical wait time: 1 hour to 1 day)'
-  };
-  // Add instructions for a web user to request a test to the response content.
-  responseContent['how a web user can request that the page be tested'] = {
-    URL: `${thisHost}/requestTestForm.html`
-  };
-  // Create a response body.
-  const body = {
-    'tool collection': getToolsFacts(),
-    'tool name': 'listReports',
-    'this request': {
-      description: 'Provide basics about all available reports.',
-      method: 'GET',
-      URL: `${thisHost}/api/listReports`,
-      'closest ancestor request': null
-    },
-    'URLs of similar requests for web users': {
-      'this request': `${thisHost}/listReports.html`,
-      'closest ancestor request': null
-    },
-    'response metadata': getResponseMetadata(),
-    'response content': responseContent
-  };
-  // Return it.
-  return body;
-};

package/api/requestFeature.test.js

@@ -1,58 +0,0 @@
-/*
-  requestFeature.test.js
-  Tests for api/requestFeature.js with mocked side effects.
-*/
-
-// IMPORTS
-
-const {test, before, beforeEach, after} = require('node:test');
-const assert = require('node:assert/strict');
-const alerts = require('../alerts');
-
-// SETUP AND TEARDOWN
-
-let sendAlertCalls = [];
-
-before(() => {
-  // @ts-expect-error: Replacing the real function with a mock for testing.
-  alerts.sendAlert = async (subject, body) => {
-    sendAlertCalls.push({subject, body});
-  };
-});
-
-// Reset the call log before each test, so tests do not depend on execution order.
-beforeEach(() => {
-  sendAlertCalls = [];
-});
-
-// Require requestFeature after the mock is in place, so it captures the mocked sendAlert.
-const {response} = require('./requestFeature');
-
-after(() => {
-});
-
-// TESTS
-
-test('requestFeature rejects an empty feature request', async () => {
-  const body = await response(['']);
-  const details = body['response content']['details about your request'];
-  assert.ok(details.error);
-  assert.equal(sendAlertCalls.length, 0);
-});
-
-test('requestFeature accepts a non-empty feature request and notifies the manager', async () => {
-  const body = await response(['Add a dark mode toggle']);
-  const details = body['response content']['details about your request'];
-  assert.equal(details.error, undefined);
-  assert.ok(details['date and time received']);
-  assert.equal(details.disposition, 'received and logged; manager notified');
-  assert.equal(sendAlertCalls.length, 1);
-  assert.equal(sendAlertCalls[0].subject, 'MCP feature request received');
-  assert.equal(sendAlertCalls[0].body, 'Add a dark mode toggle');
-});
-
-test('requestFeature includes tool name and metadata', async () => {
-  const body = await response(['Some feature']);
-  assert.equal(body['tool name'], 'requestFeature');
-  assert.ok(body['response metadata'].identifier);
-});

package/api/requestRetest.js

@@ -1,96 +0,0 @@
-/*
-  requestRetest.js
-  Processes a request to retest a page and returns an acknowledgement.
-*/
-
-// IMPORTS
-
-const {getResponseMetadata, getToolsFacts, processTestRequest, thisHost} = require('./util');
-const {getLatestReportExtracts, getReportExtract} = require('../util');
-
-// FUNCTIONS
-
-// Returns the response body.
-exports.response = async args => {
-  const [timeStamp = '', jobID = '', reason = ''] = args;
-  // Initialize the response content.
-  const responseContent = {
-    'details about your request': {},
-    'disposition of your request': null
-  };
-  const reasonLength = reason.length;
-  // Get data on the report.
-  const reportExtract = await getReportExtract(timeStamp, jobID);
-  const {what, url} = reportExtract.error ? {} : reportExtract;
-  // If this failed:
-  if (reportExtract.error) {
-    // Add this to the response content.
-    responseContent['details about your request'] = {
-      error: 'request invalid: the specified existing report is not an available report'
-    };
-  }
-  // Otherwise, if the report has been superseded:
-  else if (
-    (await getLatestReportExtracts())
-    .every(extract => extract.timeStamp !== timeStamp || extract.jobID !== jobID)
-  ) {
-    // Add this to the response content.
-    responseContent['details about your request'] = {
-      error: 'request invalid: a later report about the page exists'
-    };
-  }
-  // Otherwise, if the encoded reason is too short or too long:
-  else if (reasonLength < 20 || reasonLength > 100) {
-    // Add this to the response content.
-    responseContent['details about your request'] = {
-      error: 'request invalid: your reason is not between 20 and 100 characters long'
-    }
-  }
-  // Otherwise, i.e. if getting the report succeeded and the request is valid:
-  else {
-    // Process the request.
-    await processTestRequest('retest', what, url, reason);
-    // Add details about the request to the response content.
-    responseContent['details about your request'] = {
-      'date and time received': new Date().toISOString(),
-      'page to be retested': {
-        'description': what,
-        'URL': url
-      },
-      'reason why the page should be retested': reason
-    };
-    // Add information about the disposition of the request to the response content.
-    responseContent['disposition of your request'] = {
-      'what happens next': 'Your request is likely to be approved and processed within 1 hour to 1 day.',
-      'how you can check for completion': 'You can call the listReports tool to learn whether the page has been retested and a new report is available.',
-      'how a web user can check for completion': `A web user can visit ${thisHost}/listReports.html to learn whether the page has been retested and a new report is available.`
-    };
-  }
-  // Create a response body.
-  const body = {
-    'tool collection': getToolsFacts(),
-    'tool name': 'requestRetest',
-    'this request': {
-      description: 'Process my request to retest a page. The timeStamp and jobID parameters identify the latest available report about the page. Those parameters were in the response to my earlier listIssues request. The reason property of the request body is the reason why the page should be retested.',
-      method: 'POST',
-      URL: `${thisHost}/api/requestRetest/${timeStamp}/${jobID}`,
-      body: {
-        reason
-      },
-      'closest ancestor request': {
-        'tool name': 'listIssues',
-        description: 'Provide details about one report, including basics about the issues reported in it.',
-        method: 'GET',
-        URL: `${thisHost}/api/listIssues/${timeStamp}/${jobID}`
-      }
-    },
-    'URLs of similar requests for web users': {
-      'this request': `${thisHost}/requestRetestForm.html/${timeStamp}/${jobID}`,
-      'closest ancestor request': `${thisHost}/listIssues.html/${timeStamp}/${jobID}`
-    },
-    'response metadata': getResponseMetadata(),
-    'response content': responseContent
-  };
-  // Return it.
-  return body;
-};

package/api/requestRetest.test.js

@@ -1,80 +0,0 @@
-/*
-  requestRetest.test.js
-  Tests for api/requestRetest.js using the fixture corpus, with mocked side effects.
-*/
-
-// IMPORTS
-
-const {test, before, beforeEach, after} = require('node:test');
-const assert = require('node:assert/strict');
-const path = require('node:path');
-const apiUtil = require('./util');
-
-// SETUP AND TEARDOWN
-
-const savedDBDir = process.env.DB_DIR;
-let processTestRequestCalls = [];
-
-before(() => {
-  process.env.DB_DIR = path.join(__dirname, '..', 'test', 'fixtures', 'db');
-  // @ts-expect-error: Replacing the real function with a mock for testing.
-  apiUtil.processTestRequest = async (testType, what, url, reason) => {
-    processTestRequestCalls.push({testType, what, url, reason});
-  };
-});
-
-// Reset the call log before each test, so tests do not depend on execution order.
-beforeEach(() => {
-  processTestRequestCalls = [];
-});
-
-// Require requestRetest after the mock is in place, so it captures the mocked processTestRequest.
-const {response} = require('./requestRetest');
-
-after(() => {
-  if (savedDBDir !== undefined) {
-    process.env.DB_DIR = savedDBDir;
-  }
-  else {
-    delete process.env.DB_DIR;
-  }
-});
-
-// TESTS
-
-test('requestRetest rejects a nonexistent report', async () => {
-  const body = await response(['999999T9999', 'xyz', 'A reason that is long enough.']);
-  assert.ok(body['response content']['details about your request'].error);
-  assert.equal(processTestRequestCalls.length, 0);
-});
-
-test('requestRetest rejects a superseded report', async () => {
-  const body = await response(['260101T0000', 'mix', 'A reason that is long enough.']);
-  const details = body['response content']['details about your request'];
-  assert.ok(details.error.includes('later report'));
-  assert.equal(processTestRequestCalls.length, 0);
-});
-
-test('requestRetest rejects a reason shorter than 20 characters', async () => {
-  const body = await response(['260101T0001', 'ct', 'short']);
-  const details = body['response content']['details about your request'];
-  assert.ok(details.error.includes('reason'));
-  assert.equal(processTestRequestCalls.length, 0);
-});
-
-test('requestRetest rejects a reason longer than 100 characters', async () => {
-  const longReason = 'x'.repeat(101);
-  const body = await response(['260101T0001', 'ct', longReason]);
-  const details = body['response content']['details about your request'];
-  assert.ok(details.error.includes('reason'));
-  assert.equal(processTestRequestCalls.length, 0);
-});
-
-test('requestRetest accepts a valid retest request for the latest report of a page', async () => {
-  const body = await response(['260202T0000', 'new', 'A reason that is long enough.']);
-  const details = body['response content']['details about your request'];
-  assert.equal(details.error, undefined);
-  assert.equal(details['page to be retested'].description, 'Mixed Outcomes Page');
-  assert.equal(processTestRequestCalls.length, 1);
-  assert.equal(processTestRequestCalls[0].testType, 'retest');
-});

package/api/requestTest.js

@@ -1,106 +0,0 @@
-/*
-  requestTest.js
-  Processes a request to test an untested page and returns an acknowledgement.
-*/
-
-// IMPORTS
-
-const {getResponseMetadata, getToolsFacts, processTestRequest, thisHost} = require('./util');
-const {getReportExtracts, isURL} = require('../util');
-
-// FUNCTIONS
-
-// Returns the response body.
-exports.response = async args => {
-  const [what = '', url = '', reason = ''] = args;
-  // Initialize the response content.
-  const responseContent = {
-    'details about your request': {},
-    'disposition of your request': null
-  };
-  const whatLength = what.length;
-  // If the description is empty or too long:
-  if (!whatLength || whatLength > 100) {
-    // Add this to the response content.
-    responseContent['details about your request'] = {
-      error: 'request invalid: your description of the page is not between 1 and 100 characters long'
-    };
-  }
-  // Otherwise, i.e. if the URL is too short or too long::
-  else if (url.length < 12 || url.length > 300) {
-    // Add this to the response content.
-    responseContent['details about your request'] = {
-      error: 'request invalid: you specified a URL for the page that is not between 12 and 300 characters long'
-    };
-  }
-  // Otherwise, i.e. if the URL is invalid:
-  else if (!isURL(url)) {
-    // Add this to the response content.
-    responseContent['details about your request'] = {
-      error: 'request invalid: you specified an invalid URL for the page'
-    };
-  }
-  // Otherwise, i.e. if the description and URL are valid:
-  else {
-    // Get an extract of the available reports.
-    const reportExtracts = await getReportExtracts();
-    // If any report is on a page with the specified description and URL:
-    if (
-      reportExtracts.some(extract => extract.what === what && extract.url === url)
-    ) {
-      // Add this to the response content.
-      responseContent['details about your request'] = {
-        error: 'request invalid: the page has already been tested and its report is available'
-      };
-    }
-    // Otherwise, i.e. if none is on the page:
-    else {
-      // Process the request.
-      await processTestRequest('test', what, url, reason);
-      // Add details about the request to the response content.
-      responseContent['details about your request'] = {
-        'date and time received': new Date().toISOString(),
-        'page to be tested': {
-          description: what,
-          URL: url
-        },
-        'reason why the page should be tested': reason
-      };
-      // Add information about the disposition of the request to the response content.
-      responseContent['disposition of your request'] = {
-        'what happens next': 'Your request is likely to be approved and processed within 1 hour to 1 day.',
-        'how you can check for completion': 'You can call the listReports tool to learn whether the page has been tested and a report is available.',
-        'how a web user can check for completion': `A web user can visit ${thisHost}/listReports.html to learn whether the page has been tested and a report is available.`
-      };
-    }
-  }
-  // Create a response body.
-  const body = {
-    'tool collection': getToolsFacts(),
-    'tool name': 'requestTest',
-    'this request': {
-      description: 'Process my request to test a page about which no report is available yet. I have provided a description and the URL of the page and a reason why it should be tested.',
-      method: 'POST',
-      URL: `${thisHost}/api/requestTest`,
-      body: {
-        description: what,
-        URL: url,
-        reason
-      },
-      'closest ancestor request': {
-        'tool name': 'listReports',
-        description: 'Provide basics about all available reports.',
-        method: 'GET',
-        URL: `${thisHost}/api/listReports`
-      }
-    },
-    'URLs of similar requests for web users': {
-      'this request': `${thisHost}/requestTestForm.html`,
-      'closest ancestor request': `${thisHost}/listReports.html`
-    },
-    'response metadata': getResponseMetadata(),
-    'response content': responseContent
-  };
-  // Return it.
-  return body;
-};

package/api/requestTest.test.js

@@ -1,92 +0,0 @@
-/*
-  requestTest.test.js
-  Tests for api/requestTest.js using the fixture corpus, with mocked side effects.
-*/
-
-// IMPORTS
-
-const {test, before, beforeEach, after} = require('node:test');
-const assert = require('node:assert/strict');
-const path = require('node:path');
-const apiUtil = require('./util');
-
-// SETUP AND TEARDOWN
-
-const savedDBDir = process.env.DB_DIR;
-let processTestRequestCalls = [];
-
-before(() => {
-  process.env.DB_DIR = path.join(__dirname, '..', 'test', 'fixtures', 'db');
-  // @ts-expect-error: Replacing the real function with a mock for testing.
-  apiUtil.processTestRequest = async (testType, what, url, reason) => {
-    processTestRequestCalls.push({testType, what, url, reason});
-  };
-});
-
-// Reset the call log before each test, so tests do not depend on execution order.
-beforeEach(() => {
-  processTestRequestCalls = [];
-});
-
-// Require requestTest after the mock is in place, so it captures the mocked processTestRequest.
-const {response} = require('./requestTest');
-
-after(() => {
-  if (savedDBDir !== undefined) {
-    process.env.DB_DIR = savedDBDir;
-  }
-  else {
-    delete process.env.DB_DIR;
-  }
-});
-
-// TESTS
-
-test('requestTest rejects an empty description', async () => {
-  const body = await response(['', 'https://example.com/test', 'A reason that is long enough.']);
-  assert.ok(body['response content']['details about your request'].error);
-  assert.equal(processTestRequestCalls.length, 0);
-});
-
-test('requestTest rejects a description longer than 100 characters', async () => {
-  const longWhat = 'x'.repeat(101);
-  const body = await response([longWhat, 'https://example.com/test', 'A reason that is long enough.']);
-  assert.ok(body['response content']['details about your request'].error);
-  assert.equal(processTestRequestCalls.length, 0);
-});
-
-test('requestTest rejects a URL shorter than 12 characters', async () => {
-  const body = await response(['Test Page', 'short', 'A reason that is long enough.']);
-  assert.ok(body['response content']['details about your request'].error);
-  assert.equal(processTestRequestCalls.length, 0);
-});
-
-test('requestTest rejects a syntactically invalid URL with the correct length', async () => {
-  const body = await response(['Test Page', 'not-a-valid-url', 'A reason that is long enough.']);
-  const details = body['response content']['details about your request'];
-  assert.ok(details.error.includes('invalid URL'));
-  assert.equal(processTestRequestCalls.length, 0);
-});
-
-test('requestTest rejects an already-tested page', async () => {
-  const body = await response(['Mixed Outcomes Page', 'https://example.com/mixed', 'A reason that is long enough.']);
-  const details = body['response content']['details about your request'];
-  assert.ok(details.error.includes('already been tested'));
-  assert.equal(processTestRequestCalls.length, 0);
-});
-
-test('requestTest accepts a valid new page request', async () => {
-  const body = await response(['Brand New Page', 'https://example.com/brandnew', 'A reason that is long enough.']);
-  const details = body['response content']['details about your request'];
-  assert.equal(details.error, undefined);
-  assert.equal(details['page to be tested'].description, 'Brand New Page');
-  assert.equal(processTestRequestCalls.length, 1);
-  assert.equal(processTestRequestCalls[0].testType, 'test');
-});
-
-test('requestTest includes disposition information for a valid request', async () => {
-  const body = await response(['Brand New Page', 'https://example.com/brandnew', 'A reason that is long enough.']);
-  const disposition = body['response content']['disposition of your request'];
-  assert.ok(disposition);
-  assert.ok(disposition['what happens next']);
-});

package/api/version.js

@@ -1,8 +0,0 @@
-/*
-  version.js
-  Single source of truth for the version of the Kilotest API and MCP tool contract, consumed by mcp.js and scripts/generate-openapi.js.
-*/
-
-// CONSTANTS
-
-exports.version = '2.1.0';