@jrpool/kilotest 59.1.4 → 60.0.0

package/index.test.ts

@@ -341,29 +341,29 @@ test('GET /api/listPages returns JSON with report data and records an API-operat
   assert.equal(await getMetricCount('apiOperations', 'listPages'), countBefore + 1);
 });
 
-test('GET /api/listIssues/260101T0000/mix returns JSON with issue data', async () => {
-  const res = await request('GET', '/api/listIssues/260101T0000/mix');
+test('GET /api/listIssues/260101T0000-mix returns JSON with issue data', async () => {
+  const res = await request('GET', '/api/listIssues/260101T0000-mix');
   assert.equal(res.statusCode, 200);
   const body = jsonBody(res);
   assert.equal(body['tool name'], 'listIssues');
 });
 
-test('GET /api/listViolators/linkNoText/260101T0000/mix returns JSON', async () => {
-  const res = await request('GET', '/api/listViolators/linkNoText/260101T0000/mix');
+test('GET /api/listViolators/linkNoText/260101T0000-mix returns JSON', async () => {
+  const res = await request('GET', '/api/listViolators/linkNoText/260101T0000-mix');
   assert.equal(res.statusCode, 200);
   const body = jsonBody(res);
   assert.equal(body['tool name'], 'listViolators');
 });
 
-test('GET /api/listDiagnoses/0/linkNoText/260101T0000/mix returns JSON', {timeout: 500}, async () => {
-  const res = await request('GET', '/api/listDiagnoses/0/linkNoText/260101T0000/mix');
+test('GET /api/listDiagnoses/0/linkNoText/260101T0000-mix returns JSON', {timeout: 500}, async () => {
+  const res = await request('GET', '/api/listDiagnoses/0/linkNoText/260101T0000-mix');
   assert.equal(res.statusCode, 200);
   const body = jsonBody(res);
   assert.equal(body['tool name'], 'listDiagnoses');
 });
 
-test('GET /api/getReport/260101T0000/mix returns JSON with the report', async () => {
-  const res = await request('GET', '/api/getReport/260101T0000/mix');
+test('GET /api/getReport/260101T0000-mix returns JSON with the report', async () => {
+  const res = await request('GET', '/api/getReport/260101T0000-mix');
   assert.equal(res.statusCode, 200);
   const body = jsonBody(res);
   assert.equal(body['tool name'], 'getReport');
@@ -376,8 +376,8 @@ test('GET /api/invalidService returns an error', {timeout: 500}, async () => {
   assert.ok(body.error);
 });
 
-test('GET /fullReport.json/260101T0000/mix downloads the report as JSON', async () => {
-  const res = await request('GET', '/fullReport.json/260101T0000/mix');
+test('GET /fullReport.json/260101T0000-mix downloads the report as JSON', async () => {
+  const res = await request('GET', '/fullReport.json/260101T0000-mix');
   assert.equal(res.statusCode, 200);
   assert.ok(res.headers['content-type'].includes('application/json'));
   assert.ok(res.headers['content-disposition'].includes('attachment'));
@@ -392,8 +392,8 @@ test('GET /fullReport.json/invalid/invalid returns an error page', {timeout: 500
   assert.ok(res.body.includes('Invalid report request'));
 });
 
-test('GET /fullReport.json/990101T0000/xxx returns an abuse error for a nonexistent report', async () => {
-  const res = await request('GET', '/fullReport.json/990101T0000/xxx');
+test('GET /fullReport.json/990101T0000-xxx returns an abuse error for a nonexistent report', async () => {
+  const res = await request('GET', '/fullReport.json/990101T0000-xxx');
   assert.equal(res.statusCode, 400);
   assert.ok(res.body.includes('Invalid request'));
 });
@@ -495,10 +495,10 @@ test('POST /requestNewTest.html with an unreadable body returns an error', async
   assert.ok(res.body.includes('Unreadable request body'));
 });
 
-test('POST /requestRetest.html/260202T0000/new with valid data returns HTML', async () => {
+test('POST /requestRetest.html/260202T0000-new with valid data returns HTML', async () => {
   // Reset testRequests.json to avoid duplicate-request errors from prior tests.
   await fs.writeFile(testRequestsPath, '{}\n');
-  const res = await formRequest('POST', '/requestRetest.html/260202T0000/new', {
+  const res = await formRequest('POST', '/requestRetest.html/260202T0000-new', {
     why: 'Because the report is obsolete and needs refreshing'
   });
   assert.equal(res.statusCode, 200);
@@ -524,8 +524,8 @@ test('POST /api/requestNewTest with valid JSON returns a JSON response', {timeou
   assert.ok(body['tool name'] || body['response content']);
 });
 
-test('POST /api/requestRetest/260202T0000/new with valid JSON returns a JSON response', async () => {
-  const res = await request('POST', '/api/requestRetest/260202T0000/new', {
+test('POST /api/requestRetest/260202T0000-new with valid JSON returns a JSON response', async () => {
+  const res = await request('POST', '/api/requestRetest/260202T0000-new', {
     reason: 'Because the report is obsolete and needs refreshing'
   });
   assert.equal(res.statusCode, 200);
@@ -557,12 +557,12 @@ test('POST /api/orderNewTest with valid JSON enqueues a job directly and records
   assert.equal(await getMetricCount('apiOperations', 'orderNewTest'), countBefore + 1);
   const reportIdentifier = body['response content']['disposition of your order']['report identifier'];
   assert.ok(reportIdentifier);
-  await fs.unlink(path.join(fixtureDBDir, 'jobs', 'queue', `${reportIdentifier.timeStamp}-${reportIdentifier.jobID}.json`));
+  await fs.unlink(path.join(fixtureDBDir, 'jobs', 'queue', `${reportIdentifier}.json`));
 });
 
-test('POST /api/orderRetest/260202T0000/new with valid JSON enqueues a job directly and records an API-operation metric', async () => {
+test('POST /api/orderRetest/260202T0000-new with valid JSON enqueues a job directly and records an API-operation metric', async () => {
   const countBefore = await getMetricCount('apiOperations', 'orderRetest');
-  const res = await request('POST', '/api/orderRetest/260202T0000/new', {
+  const res = await request('POST', '/api/orderRetest/260202T0000-new', {
     reason: 'Because the report is obsolete and needs refreshing'
   });
   assert.equal(res.statusCode, 200);
@@ -571,12 +571,12 @@ test('POST /api/orderRetest/260202T0000/new with valid JSON enqueues a job direc
   assert.equal(await getMetricCount('apiOperations', 'orderRetest'), countBefore + 1);
   const reportIdentifier = body['response content']['disposition of your order']['report identifier'];
   assert.ok(reportIdentifier);
-  await fs.unlink(path.join(fixtureDBDir, 'jobs', 'queue', `${reportIdentifier.timeStamp}-${reportIdentifier.jobID}.json`));
+  await fs.unlink(path.join(fixtureDBDir, 'jobs', 'queue', `${reportIdentifier}.json`));
 });
 
-test('POST /api/awaitTest/260101T0000/mix with an already-completed report records an API-operation metric', async () => {
+test('POST /api/awaitTest/260101T0000-mix with an already-completed report records an API-operation metric', async () => {
   const countBefore = await getMetricCount('apiOperations', 'awaitTest');
-  const res = await request('POST', '/api/awaitTest/260101T0000/mix', {});
+  const res = await request('POST', '/api/awaitTest/260101T0000-mix', {});
   assert.equal(res.statusCode, 200);
   const body = jsonBody(res);
   assert.equal(body['response content']['disposition of your wait'].outcome, 'completed');
@@ -771,8 +771,8 @@ test('POST /tutorialWebComment.html with content returns JSON', async () => {
 
 // TESTS: additional branch coverage
 
-test('GET /fullReport.json/260101T0007/hid returns an error for an unavailable report', async () => {
-  const res = await request('GET', '/fullReport.json/260101T0007/hid');
+test('GET /fullReport.json/260101T0007-hid returns an error for an unavailable report', async () => {
+  const res = await request('GET', '/fullReport.json/260101T0007-hid');
   assert.equal(res.statusCode, 400);
   assert.ok(res.body.includes('Invalid request'));
 });
@@ -906,24 +906,74 @@ test('GET /qai/comments redirects to /tutorialAI.html', async () => {
 
 test('GET /diagnoses.html/<segments> redirects to the equivalent /listDiagnoses.html/<segments>, preserving the query string', async () => {
   const res = await request(
-    'GET', '/diagnoses.html/duplicateID/260426T1741/77w/718?pathID=/html/body', {}, {followRedirects: false}
+    'GET', '/diagnoses.html/duplicateID/260426T1741-77w/718?pathID=/html/body', {}, {followRedirects: false}
   );
   assert.equal(res.statusCode, 301);
-  assert.equal(res.headers['location'], '/listDiagnoses.html/duplicateID/260426T1741/77w/718?pathID=/html/body');
+  assert.equal(res.headers['location'], '/listDiagnoses.html/duplicateID/260426T1741-77w/718?pathID=/html/body');
 });
 
-test('GET /reportIssues.html/<timeStamp>/<jobID> redirects to the equivalent /listIssues.html/<timeStamp>/<jobID>', async () => {
-  const res = await request('GET', '/reportIssues.html/260101T0000/mix', {}, {followRedirects: false});
+test('GET /reportIssues.html/<reportID> redirects to the equivalent /listIssues.html/<reportID>', async () => {
+  const res = await request('GET', '/reportIssues.html/260101T0000-mix', {}, {followRedirects: false});
   assert.equal(res.statusCode, 301);
-  assert.equal(res.headers['location'], '/listIssues.html/260101T0000/mix');
+  assert.equal(res.headers['location'], '/listIssues.html/260101T0000-mix');
+});
+
+// TESTS: legacy two-segment report-identifier redirects
+// Before the reportID consolidation, report-identifying URL tails used a
+// timeStamp segment and a jobID segment. These verify that each legacy form
+// permanently redirects to the single-reportID form, and that a POST redirect
+// uses 308 to preserve the method and body.
+
+test('GET /listIssues.html/<timeStamp>/<jobID> redirects to the single-reportID URL', async () => {
+  const res = await request('GET', '/listIssues.html/260101T0000/mix', {}, {followRedirects: false});
+  assert.equal(res.statusCode, 301);
+  assert.equal(res.headers['location'], '/listIssues.html/260101T0000-mix');
+});
+
+test('GET /listViolators.html/<issueID>/<timeStamp>/<jobID> redirects to the single-reportID URL', async () => {
+  const res = await request(
+    'GET', '/listViolators.html/linkNoText/260101T0000/mix', {}, {followRedirects: false}
+  );
+  assert.equal(res.statusCode, 301);
+  assert.equal(res.headers['location'], '/listViolators.html/linkNoText/260101T0000-mix');
+});
+
+test('GET /listDiagnoses.html/<issueID>/<timeStamp>/<jobID>/<catalogIndex> redirects to the single-reportID URL, preserving the query string', async () => {
+  const res = await request(
+    'GET', '/listDiagnoses.html/linkNoText/260101T0000/mix/0?pathID=/html/body', {}, {followRedirects: false}
+  );
+  assert.equal(res.statusCode, 301);
+  assert.equal(res.headers['location'], '/listDiagnoses.html/linkNoText/260101T0000-mix/0?pathID=/html/body');
+});
+
+test('GET /requestRetestForm.html/<timeStamp>/<jobID> redirects to the single-reportID URL', async () => {
+  const res = await request(
+    'GET', '/requestRetestForm.html/260202T0000/new', {}, {followRedirects: false}
+  );
+  assert.equal(res.statusCode, 301);
+  assert.equal(res.headers['location'], '/requestRetestForm.html/260202T0000-new');
+});
+
+test('GET /fullReport.json/<timeStamp>/<jobID> redirects to the single-reportID URL', async () => {
+  const res = await request('GET', '/fullReport.json/260101T0000/mix', {}, {followRedirects: false});
+  assert.equal(res.statusCode, 301);
+  assert.equal(res.headers['location'], '/fullReport.json/260101T0000-mix');
+});
+
+test('POST /requestRetest.html/<timeStamp>/<jobID> redirects with 308 to the single-reportID URL', async () => {
+  const res = await formRequest(
+    'POST', '/requestRetest.html/260202T0000/new', {why: 'Because the report is obsolete and needs refreshing'}
+  );
+  assert.equal(res.statusCode, 308);
+  assert.equal(res.headers['location'], '/requestRetest.html/260202T0000-new');
 });
 
 test('GET /reportIssue.html/<segments> redirects to the equivalent /listViolators.html/<segments>', async () => {
   const res = await request(
-    'GET', '/reportIssue.html/duplicateID/260101T0000/mix', {}, {followRedirects: false}
+    'GET', '/reportIssue.html/duplicateID/260101T0000-mix', {}, {followRedirects: false}
   );
   assert.equal(res.statusCode, 301);
-  assert.equal(res.headers['location'], '/listViolators.html/duplicateID/260101T0000/mix');
+  assert.equal(res.headers['location'], '/listViolators.html/duplicateID/260101T0000-mix');
 });
 
 test('GET /rules.html/<segment> redirects to the equivalent /listRules.html/<segment>', async () => {
@@ -1007,8 +1057,8 @@ test('POST /requestNewTest.html with a private-address URL returns an error unle
   }
 });
 
-test('POST /requestRetest.html/260202T0000/new with missing why returns an error', async () => {
-  const res = await formRequest('POST', '/requestRetest.html/260202T0000/new', {
+test('POST /requestRetest.html/260202T0000-new with missing why returns an error', async () => {
+  const res = await formRequest('POST', '/requestRetest.html/260202T0000-new', {
     why: ''
   });
   assert.equal(res.statusCode, 400);
@@ -1464,8 +1514,8 @@ test('GET /requestNewTest.html without arguments is rejected as an invalid GET r
   assert.equal(res.statusCode, 400);
 });
 
-test('GET /requestRetest.html/260202T0000/new is rejected as an invalid GET request', async () => {
-  const res = await request('GET', '/requestRetest.html/260202T0000/new');
+test('GET /requestRetest.html/260202T0000-new is rejected as an invalid GET request', async () => {
+  const res = await request('GET', '/requestRetest.html/260202T0000-new');
   assert.equal(res.statusCode, 400);
 });
 
@@ -1476,8 +1526,8 @@ test('GET /requestRetest.html/260202T0000/new is rejected as an invalid GET requ
 
 const htmlPagePaths = [
   '/listPages.html',
-  '/listViolators.html/linkNoText/260101T0000/mix',
-  '/listDiagnoses.html/linkNoText/260101T0000/mix/0',
+  '/listViolators.html/linkNoText/260101T0000-mix',
+  '/listDiagnoses.html/linkNoText/260101T0000-mix/0',
   '/enqueueForm.html',
   '/manage.html',
   '/tutorialWeb.html',
@@ -1839,11 +1889,11 @@ test('POST /requestRetest.html with valid format but duplicate retest returns an
   // First retest to create the recommendation. As above, the reason must match
   // exactly between the two requests for processTestRequest to treat the second as
   // a duplicate rather than a second, independent (and thus also 'ok') request.
-  await formRequest('POST', '/requestRetest.html/260202T0000/new', {
+  await formRequest('POST', '/requestRetest.html/260202T0000-new', {
     why: 'Because the report is obsolete and needs refreshing'
   });
   // Second, identical retest of the same report should get a duplicate error.
-  const res = await formRequest('POST', '/requestRetest.html/260202T0000/new', {
+  const res = await formRequest('POST', '/requestRetest.html/260202T0000-new', {
     why: 'Because the report is obsolete and needs refreshing'
   });
   assert.equal(res.statusCode, 400);
@@ -1985,7 +2035,7 @@ test('a request logs its path without its query string', async () => {
   const originalLog = console.log;
   console.log = (line: string) => logged.push(line);
   try {
-    await request('GET', '/listIssues.html/260101T0000/mix?authCode=secret');
+    await request('GET', '/listIssues.html/260101T0000-mix?authCode=secret');
   }
   finally {
     console.log = originalLog;
@@ -1994,7 +2044,7 @@ test('a request logs its path without its query string', async () => {
   .map(line => { try {return JSON.parse(line);} catch {return null;} })
   .find(parsed => parsed?.type === 'request');
   assert.ok(record);
-  assert.equal(record.path, '/listIssues.html/260101T0000/mix');
+  assert.equal(record.path, '/listIssues.html/260101T0000-mix');
   assert.ok(!JSON.stringify(record).includes('secret'));
 });
 

package/index.ts

@@ -23,8 +23,7 @@ import {
   isReportError,
   getReportPath,
   hiddenReportsPath,
-  isTimeStamp,
-  isJobID,
+  isReportID,
   isURL,
   isUsableReport,
   isValidAuthCode,
@@ -306,6 +305,17 @@ const renamedPagePrefixes: Record<string, string> = {
   requestTest: 'requestNewTest',
   requestTestForm: 'requestNewTestForm'
 };
+// Pages whose report-identifying path tails once used two segments (a timeStamp
+// segment and a jobID segment) where they now use one reportID segment. Each value
+// gives the index of the first legacy segment within the path tail and the total
+// segment count of the legacy tail.
+// TEMPORARY: retire these redirects after 2027-04-17 once bookmarked links have aged out.
+const legacyReportTails: Record<string, {idIndex: number; segmentCount: number}> = {
+  listDiagnoses: {idIndex: 1, segmentCount: 4},
+  listIssues: {idIndex: 0, segmentCount: 2},
+  listViolators: {idIndex: 1, segmentCount: 3},
+  requestRetestForm: {idIndex: 0, segmentCount: 2}
+};
 const jobLock = createLock();
 
 // FUNCTIONS
@@ -325,6 +335,24 @@ export const isPathAllowed = (method: string, pathname: string): boolean => {
   const patterns = (routes as Record<string, string[]>)[method] || [];
   return patterns.some(pattern => matchPath(pattern, pathname));
 };
+// Returns the single-reportID URL that a legacy two-segment report URL (one whose
+// path tail identifies a report with separate timeStamp and jobID segments)
+// redirects to, or null if the page has no legacy form or the tail lacks its shape.
+const getLegacyReportURL = (topic: string, pathTail: string): string | null => {
+  const legacy = legacyReportTails[topic];
+  if (!legacy) {
+    return null;
+  }
+  const segments = pathTail.split('/');
+  const reportID = `${segments[legacy.idIndex]}-${segments[legacy.idIndex + 1]}`;
+  if (segments.length !== legacy.segmentCount || !isReportID(reportID)) {
+    return null;
+  }
+  const newTail = [
+    ...segments.slice(0, legacy.idIndex), reportID, ...segments.slice(legacy.idIndex + 2)
+  ].join('/');
+  return `/${topic}.html/${newTail}`;
+};
 // Serves or sends an error message.
 export const serveError = async (error: Record<string, unknown>, response: ServerResponse, isHumanUser = true, statusCode = 400): Promise<void> => {
   const errorLines = Object.entries(error).map(pair => `${pair[0]}: ${pair[1]}`);
@@ -711,11 +739,19 @@ const handleRequest = async (request: IncomingMessage, response: ServerResponse)
     }
     // Otherwise, if it is for a full report download:
     else if (pageName === 'fullReport.json') {
-      const [timeStamp, jobID] = pathTail.split('/') as [string, string, ...string[]];
-      // If the request is syntactically valid:
-      if (isTimeStamp(timeStamp) && isJobID(jobID)) {
+      const segments = pathTail.split('/');
+      const legacyID = `${segments[0]}-${segments[1]}`;
+      // If the request identifies the report with the legacy two-segment form (a
+      // timeStamp segment and a jobID segment), redirect the request permanently to
+      // the single-reportID URL, preserving any query string.
+      if (segments.length === 2 && isReportID(legacyID)) {
+        response.writeHead(301, {Location: `/fullReport.json/${legacyID}${search}`});
+        response.end();
+      }
+      // Otherwise, if the request is syntactically valid:
+      else if (isReportID(pathTail)) {
         // Get it.
-        const report = await getReport(timeStamp, jobID);
+        const report = await getReport(pathTail);
         // If this failed:
         if (isReportError(report)) {
           // This is not necessarily abuse: the link may have been generated (e.g. by
@@ -725,11 +761,11 @@ const handleRequest = async (request: IncomingMessage, response: ServerResponse)
           // but alert a manager with the real reason, since a syntactically valid report ID
           // should otherwise always be usable.
           console.error(
-            `Full report ${timeStamp}-${jobID} requested but unavailable (${report.error})`
+            `Full report ${pathTail} requested but unavailable (${report.error})`
           );
           await sendAlert(
             'Kilotest: requested full report unavailable',
-            `Full report ${timeStamp}-${jobID} was requested but could not be retrieved: ${report.error}`
+            `Full report ${pathTail} was requested but could not be retrieved: ${report.error}`
           );
           await serveError({message: 'ERROR: Invalid request'}, response, true);
         }
@@ -738,7 +774,7 @@ const handleRequest = async (request: IncomingMessage, response: ServerResponse)
           // Serve response headers for a JSON download.
           setHeaders('application/json', null, 'low');
           response.setHeader(
-            'content-disposition', `attachment; filename="${timeStamp}-${jobID}.json"`,
+            'content-disposition', `attachment; filename="${pathTail}.json"`,
           );
           // Download the report.
           response.end(getJSON(report));
@@ -753,6 +789,7 @@ const handleRequest = async (request: IncomingMessage, response: ServerResponse)
     // Otherwise, if it is for an HTML page other than the home page:
     else if (pageName.endsWith('.html')) {
       const topic = pageName.slice(0, -5);
+      const legacyReportURL = getLegacyReportURL(topic, pathTail);
       // If it is for a page's old, pre-rename name:
       if (renamedPagePrefixes[topic]) {
         // Redirect the client permanently to the current page name, preserving any
@@ -761,6 +798,13 @@ const handleRequest = async (request: IncomingMessage, response: ServerResponse)
         response.writeHead(301, {Location: newLocation});
         response.end();
       }
+      // Otherwise, if the URL identifies a report with the legacy two-segment form
+      // (a timeStamp segment and a jobID segment), redirect the request permanently
+      // to the URL with the single reportID segment, preserving the query string.
+      else if (legacyReportURL !== null) {
+        response.writeHead(301, {Location: `${legacyReportURL}${search}`});
+        response.end();
+      }
       // Otherwise, if the page can be generated and is not POST-only (a POST-only path also matches
       // the '*.html*' GET pattern, but its handler expects POST's argument list and
       // performs no GET-appropriate rendering; a self-submitting manager page is POST-allowed
@@ -985,9 +1029,17 @@ const handleRequest = async (request: IncomingMessage, response: ServerResponse)
       // Otherwise, if it is a retest request:
       else if (pageName === 'requestRetest.html') {
         const {why} = postData as {why?: string};
-        const [timeStamp, jobID] = pathTail.split('/') as [string, string, ...string[]];
-        // If the request is valid:
-        if (isTimeStamp(timeStamp) && isJobID(jobID) && why) {
+        const segments = pathTail.split('/');
+        const legacyID = `${segments[0]}-${segments[1]}`;
+        // If the request identifies the report with the legacy two-segment form,
+        // redirect it to the single-reportID URL. A 308 (not 301) keeps the POST
+        // method and body, which a 301 could rewrite to a GET with no body.
+        if (segments.length === 2 && isReportID(legacyID)) {
+          response.writeHead(308, {Location: `/requestRetest.html/${legacyID}`});
+          response.end();
+        }
+        // Otherwise, if the request is valid:
+        else if (isReportID(pathTail) && why) {
           // Serve response headers.
           setHeaders('text/html', pathname, 'ultra');
           // Get the answer data.
@@ -1138,9 +1190,8 @@ const handleRequest = async (request: IncomingMessage, response: ServerResponse)
             const reportObj: Partial<Report> = report ?? {};
             const {id, target} = reportObj;
             const {what: description, url} = (target ?? {}) as Partial<NonNullable<Report['target']>>;
-            const [timeStamp, jobID] = (id?.split('-') ?? ['', '']) as [string, string];
             // If the request is syntactically valid:
-            if (id && isTimeStamp(timeStamp) && isJobID(jobID) && description && url) {
+            if (id && isReportID(id) && description && url) {
               // Get the job the report is from. A missing claimed-job file (the job was
               // never claimed, or was already completed) is a normal outcome, handled below
               // as if the job were not assigned to this worker; any other failure to read it
@@ -1186,7 +1237,7 @@ const handleRequest = async (request: IncomingMessage, response: ServerResponse)
                   // could fail even though the just-written report is fine.
                   await annotateReportObject(reportObj);
                   // Save the annotated report.
-                  await fs.writeFile(getReportPath(timeStamp, jobID), getJSON(report));
+                  await fs.writeFile(getReportPath(id), getJSON(report));
                   console.log(`Testaro report ${id} was annotated and saved`);
                   // Check the monetary balances and send alerts if nearing exhaustion.
                   await checkBalancesForAlerts(report!);