@jrpool/kilotest 46.1.2 → 47.0.1

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/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';

package/indexFallback.test.js

@@ -1,33 +0,0 @@
-/*
-  indexFallback.test.js
-  Tests that index.js loads successfully when PROTOCOL and TESTARO_WORKERS
-  are not set, exercising the || fallback branches at module load time.
-  This must be a separate file because index.js reads these env vars
-  at module load time, and each test file runs in its own process.
-*/
-
-// ENVIRONMENT (must be set before requiring index.js)
-
-const path = require('node:path');
-const fixtureDBDir = path.join(__dirname, 'test', 'fixtures', 'db');
-
-process.env.DB_DIR = fixtureDBDir;
-process.env.AUTH_CODE = 'test-auth-code';
-// Set PROTOCOL and TESTARO_WORKERS to empty strings (falsy) so that
-// the || fallbacks in index.js are exercised. dotenv does not override
-// existing env vars, so .env will not replace these.
-process.env.PROTOCOL = '';
-process.env.TESTARO_WORKERS = '';
-
-// IMPORTS
-
-const {test} = require('node:test');
-const assert = require('node:assert/strict');
-const {requestHandler} = require('./index');
-
-// TESTS
-
-test('index.js loads with empty PROTOCOL and TESTARO_WORKERS using fallbacks', () => {
-  // If index.js loaded successfully, requestHandler is a function.
-  assert.equal(typeof requestHandler, 'function');
-});

package/indexWorkers.test.js

@@ -1,79 +0,0 @@
-/*
-  indexWorkers.test.js
-  Tests for index.js when TESTARO_WORKERS is invalid JSON.
-  This must be a separate file because index.js reads TESTARO_WORKERS
-  at module load time.
-*/
-
-// ENVIRONMENT (must be set before requiring index.js)
-
-const path = require('node:path');
-const fixtureDBDir = path.join(__dirname, 'test', 'fixtures', 'db');
-
-process.env.DB_DIR = fixtureDBDir;
-process.env.AUTH_CODE = 'test-auth-code';
-process.env.TESTARO_WORKERS = 'not valid json';
-
-// IMPORTS
-
-const {test} = require('node:test');
-const assert = require('node:assert/strict');
-const http = require('node:http');
-const {requestHandler} = require('./index');
-
-// CONSTANTS
-
-const port = 3993;
-
-// HELPERS
-
-const request = (method, requestPath, body = null, headers = {}) => new Promise((resolve, reject) => {
-  const options = {method, host: 'localhost', port, path: requestPath, headers: {...headers}};
-  let bodyData = '';
-  if (body) {
-    bodyData = JSON.stringify(body);
-    options.headers['content-type'] = 'application/json';
-    options.headers['content-length'] = Buffer.byteLength(bodyData);
-  }
-  const req = http.request(options, response => {
-    const chunks = [];
-    response.on('data', chunk => chunks.push(chunk));
-    response.on('end', () => {
-      resolve({statusCode: response.statusCode, headers: response.headers, body: Buffer.concat(chunks).toString()});
-    });
-  });
-  req.on('error', reject);
-  req.end(bodyData || '');
-});
-
-// TESTS
-
-test('index.js loads with invalid TESTARO_WORKERS and treats workers as empty', () => {
-  // If index.js loaded successfully, requestHandler is a function.
-  assert.equal(typeof requestHandler, 'function');
-});
-
-test('POST /worker/job with invalid TESTARO_WORKERS returns 401 for any credentials', async () => {
-  const server = http.createServer(requestHandler);
-  await new Promise(resolve => server.listen(port, () => resolve()));
-  try {
-    const auth = Buffer.from('worker1:secret1').toString('base64');
-    const res = await request('POST', '/worker/job', {}, {
-      authorization: `Basic ${auth}`
-    });
-    assert.equal(res.statusCode, 401);
-  }
-  finally {
-    server.closeAllConnections?.();
-    await new Promise(resolve => {
-      const timer = setTimeout(() => {
-        server.closeAllConnections?.();
-        resolve();
-      }, 1000);
-      server.close(() => {
-        clearTimeout(timer);
-        resolve();
-      });
-    });
-  }
-});

package/jsconfig.json

@@ -1,8 +0,0 @@
-{
-  "compilerOptions": {
-    "allowJs": true,
-    "checkJs": true,
-    "noEmit": true,
-    "strict": false
-  }
-}

package/pm2.config.js

@@ -1,18 +0,0 @@
-module.exports = {
-  apps: [
-    {
-      name: 'kilotest',
-      script: 'index.js',
-      instances: 1,
-      autorestart: true,
-      watch: false,
-      max_memory_restart: '500M',
-      time: true,
-      env: {
-        NODE_ENV: 'production',
-        BASE_PATH: '/',
-        DEMO_SSE_DELAY_MS: '100'
-      }
-    }
-  ]
-};

package/smokeTest.js

@@ -1,128 +0,0 @@
-/*
-  smokeTest.js
-  Sends requests to all valid GET and POST paths on the deployed server and verifies that Caddy forwards them to Kilotest (i.e., the response is not a bare Caddy 404).
-*/
-
-// IMPORTS
-
-const https = require('https');
-const {routes} = require('./index');
-
-// CONSTANTS
-
-const host = process.env.SMOKE_HOST || 'kilotest.com';
-// Concrete paths matching each wildcard pattern in the routes table, for smoke testing.
-const concretePaths = {
-  GET: {
-    '*.html*': '/listReports.html',
-    '/': '/',
-    '/api-docs': '/api-docs',
-    '/api/*': '/api/listReports',
-    '/capability.md': '/capability.md',
-    '/favicon.*': '/favicon.ico',
-    '/fullReport.json/*': '/fullReport.json/260101T0000/mix',
-    '/index.html': '/index.html',
-    '/llms-full.txt': '/llms-full.txt',
-    '/llms.txt': '/llms.txt',
-    '/mcp': '/mcp',
-    '/openapi.json': '/openapi.json',
-    '/openapi.yaml': '/openapi.yaml',
-    '/robots.txt': '/robots.txt',
-    '/sitemap.xml': '/sitemap.xml',
-    '/style.css': '/style.css',
-    '/swagger.json': '/swagger.json',
-    '/swagger.yaml': '/swagger.yaml',
-    '/tutorial/images/*': '/tutorial/images/diagram.png'
-  },
-  POST: {
-    '/api/*': '/api/requestFeature',
-    '/mcp': '/mcp',
-    '/reannotate.html': '/reannotate.html',
-    '/recAction.html': '/recAction.html',
-    '/renewWCAG.html': '/renewWCAG.html',
-    '/requestRetest.html/*': '/requestRetest.html/260101T0001/ct',
-    '/requestTest.html': '/requestTest.html',
-    '/tutorialComment.html': '/tutorialComment.html',
-    '/worker/job': '/worker/job',
-    '/worker/report': '/worker/report'
-  }
-};
-// Minimal POST bodies for paths that require them.
-const postBodies = {
-  '/api/requestFeature': {feature: 'smoke test'},
-  '/mcp': {},
-  '/reannotate.html': {authCode: 'invalid'},
-  '/recAction.html': {
-    target: 'https://smoketest.example.com\tSmoke Test Page', authCode: 'invalid'
-  },
-  '/renewWCAG.html': {authCode: 'invalid'},
-  '/requestRetest.html/260101T0001/ct': {why: 'smoke test'},
-  '/requestTest.html': {what: 'Smoke Test Page', url: 'https://smoketest.example.com', why: 'smoke test'},
-  '/tutorialComment.html': {content: 'smoke test'},
-  '/worker/job': {},
-  '/worker/report': {}
-};
-
-// FUNCTIONS
-
-// Sends an HTTPS request and returns the status code and body length.
-const sendRequest = (method, requestPath) => new Promise((resolve, reject) => {
-  const body = method === 'POST' ? JSON.stringify(postBodies[requestPath] || {}) : null;
-  const headers = {'x-kilotest-smoke': '1'};
-  if (body) {
-    headers['content-type'] = 'application/json; charset=utf-8';
-    headers['content-length'] = Buffer.byteLength(body);
-  }
-  const options = {
-    method,
-    host,
-    path: requestPath,
-    headers
-  };
-  const req = https.request(options, response => {
-    const chunks = [];
-    response.on('data', chunk => chunks.push(chunk));
-    response.on('end', () => {
-      const responseBody = chunks.join('');
-      resolve({statusCode: response.statusCode, bodyLength: responseBody.length});
-    });
-  });
-  req.on('error', reject);
-  req.end(body || '');
-});
-
-// Returns whether a response is a bare Caddy 404 (the failure this test detects).
-const isCaddy404 = result => result.statusCode === 404 && result.bodyLength === 0;
-
-// EXECUTION
-
-(async () => {
-  let failures = 0;
-  for (const method of ['GET', 'POST']) {
-    console.log(`\n=== ${method} paths ===`);
-    for (const pattern of routes[method]) {
-      const requestPath = concretePaths[method][pattern];
-      if (!requestPath) {
-        console.log(`FAIL: no concrete path defined for pattern ${pattern}`);
-        failures++;
-        continue;
-      }
-      try {
-        const result = await sendRequest(method, requestPath);
-        if (isCaddy404(result)) {
-          console.log(`FAIL: ${method} ${requestPath} -> Caddy 404 (path not forwarded)`);
-          failures++;
-        }
-        else {
-          console.log(`PASS: ${method} ${requestPath} -> ${result.statusCode} (body ${result.bodyLength} bytes)`);
-        }
-      }
-      catch (error) {
-        console.log(`FAIL: ${method} ${requestPath} -> error: ${error.message}`);
-        failures++;
-      }
-    }
-  }
-  console.log(`\n=== ${failures === 0 ? 'All paths forwarded' : `${failures} failure(s)`} ===`);
-  process.exit(failures === 0 ? 0 : 1);
-})();