feat: retain bounded failed-request reproduction context

This commit is contained in:
Thomas Durieux committed 2026-11-14 21:44:48 +00:00
1 parent 3a1d013b11
commit 5dbf3e7829
22 files changed
+198 -67

No files matched your search

+21
View File
@@ -6,12 +6,33 @@ const {errorDiagnostics,safeDiagnosticFields}=require('../src/core/log-diagnosti
const {serializeError}=require('../src/core/logger');
const {logRecord}=require('../src/core/log-record');
const {logContext}=require('../src/core/log-context');
const {requestReproduction,safeReproductionPath}=require('../src/core/log-reproduction');
const {requestRoute}=require('../src/core/request-monitoring');
const {safeRedisLog,investigateLogs,logOptions}=require('../src/server/admin-log-investigation');
const secret='PRIVATE_TOKEN_owner_filename';
const frame='at printError (src/server/routes/route-utils.ts:200:7)';
function failure(){ const error=new TypeError('https://user:'+secret+'@github.com/private/repo?token='+secret); error.stack=error.message+'\n at printError ('+path.resolve('src/server/routes/route-utils.ts')+':200:7)\n at '+secret+' ('+path.resolve('src/server/routes/route-utils.ts')+':201:9)\n at secret (/home/private/'+secret+':1:2)\n at fn (https://private/'+secret+':1:2)';return error; }
describe('safe actionable exception diagnostics',()=>{
it('keeps bounded anonymous file request context for failures without queries or unsafe paths',()=>{
const requestPath='/api/repo/demo-123/file/docs/reproduce%20issue.md';
expect(requestReproduction(requestPath+'?token=SECRET')).deep.equal({requestPath,repoId:'demo-123'});
for(const value of ['/api/repo/owner/name/readme','https://example.test'+requestPath,requestPath+'?token=SECRET','/api/repo/demo-123/file/%0aSECRET','/api/repo/demo-123/file/../secret','/api/repo/demo-123/file/%252e%252e/secret','/api/repo/demo-123/file/https%3a%2f%2fuser:token@example.test','/api/repo/demo-123/file/'+ 'x'.repeat(2048)]) expect(safeReproductionPath(value),value).equal(undefined);
expect(logContext.run({requestPath},()=>logRecord('info','route',['request',{status:200}]))).not.have.property('requestPath');
const record=logContext.run({requestPath},()=>logRecord('error','route',['failure',{httpStatus:500}]));
expect(record).include({requestPath,repoId:'demo-123'});
expect(safeRedisLog({ts:record.timestamp,level:'error',module:'route',raw:[record]}).raw[0]).include({requestPath,repoId:'demo-123'});
});
it('preserves dotted allowlisted source files and anonymous/named async frames',()=>{
const error=new Error(secret);
error.stack='Error: '+secret+'\n at async '+path.resolve('src/server/routes/repository-public.ts')+':224:23\n at async printError ('+path.resolve('src/server/routes/route-utils.ts')+':200:7)\n at '+path.resolve('src/core/model/owner-alert-lifecycle.schema.ts')+':12:3\n at async https://'+secret+':1:2';
const record=logRecord('error','route',['',serializeError(error)]);
expect(record.errorStack).include('at <anonymous> (src/server/routes/repository-public.ts:224:23)').and.include(frame).and.include('at <anonymous> (src/core/model/owner-alert-lifecycle.schema.ts:12:3)');
const redis=safeRedisLog({ts:record.timestamp,level:'error',module:'route',raw:[record]});expect(redis.raw[0].errorStack).equal(record.errorStack);
expect(safeDiagnosticFields({errorStack:'at <anonymous> (src/core/model/not-allowlisted.schema.ts:12:3)'})).deep.equal({});
expect(JSON.stringify(record)).not.include(secret);
error.stack='Error: '+secret+'\n at external ('+path.resolve('node_modules/dependency/index.js')+':1:2)\n at async '+path.resolve('src/server/routes/repository-public.ts')+':224:23';
expect(errorDiagnostics(error).errorStack).equal('at <anonymous> (src/server/routes/repository-public.ts:224:23)');
});
it('retains only recognized source frames and types, never messages, URLs or roots',()=>{
const result=errorDiagnostics(failure());
expect(result.errorType).equal('TypeError'); expect(result.errorStack).include(frame).and.include('at <anonymous>');
+12
View File
@@ -35,6 +35,18 @@ describe("bounded request monitoring", function () {
});
async function listen() { server = await new Promise(resolve => { const s = app.listen(0, "127.0.0.1", () => resolve(s)); }); }
it("captures failed file reproduction context without changing metric labels or retaining queries", async function () {
const {logRecord}=require('../src/core/log-record');
const records=[];
app.get('/api/repo/:repoId/file/*path',(req,res)=>{
records.push(logRecord('error','route',['failure',{httpStatus:500}]));res.status(500).end();
});
await listen(); await fetch(server,'/api/repo/demo-123/file/docs/reproduce%20issue.md?token=NEVER_CAPTURE');
expect(records[0]).include({repoId:'demo-123',requestPath:'/api/repo/demo-123/file/docs/reproduce%20issue.md',route:'/api/repo/:repoId/file/:path'});
expect(JSON.stringify(records)).not.include('NEVER_CAPTURE');
expect(metrics.drain().every(row=>!JSON.stringify(row).includes('demo-123'))).equal(true);
});
it("keeps labels bounded and removes source identities and query values", function () {
expect(requestRoute("/api/repo/private-name/file/secret.txt?token=abc", "api")).to.equal("/api/repo/:repoId/file/:path");
expect(requestRoute("/api/repo/secret-owner/secret-repo/readme?branch=secret", "api")).to.equal("/api/repo/:owner/:repo/readme");
+13
View File
@@ -98,6 +98,19 @@ describe('structured logging privacy and context', function () {
`], {env: {...process.env, LOG_REDIS_MIRROR: 'on'}, encoding: 'utf8', timeout: 10000});
expect(child.status, child.stderr).to.equal(0);
});
it('keeps exact reproduction and a frame when Redis payload clamping reduces diagnostics', () => {
const child = spawnSync(process.execPath, ['-r','ts-node/register/transpile-only','-e', `
const assert=require('node:assert/strict'),redis=require('redis');let payload;
const tx={lPush(key,value){payload=value;return tx;},lTrim(){return tx;},hIncrBy(){return tx;},expire(){return tx;},exec(){return Promise.resolve([]);}};
redis.createClient=()=>({isReady:true,isOpen:true,on(){},connect(){return Promise.resolve();},multi(){return tx;}});
const requestPath='/api/repo/demo-123/file/'+ 'a'.repeat(1950);
const frame='at <anonymous> (src/core/model/owner-alert-lifecycle.schema.ts:123456:12345)';
const stack=Array(8).fill(frame).join('\\n');
require('./src/core/logger').createLogger('route').error('failure',{...Object.fromEntries(['ms','firstByteMs','responseMs','bytes','bytesPerSecond','attempt','rss','memoryLimitBytes','memoryRatio','uptime','activeRequests','waiting','active','delayed','failed','oldestWaitingMs','droppedLogs','loopP95Ms','upstreamStatus'].map(key=>[key,Number.MAX_VALUE])),requestPath,errorType:'TypeError',errorStack:stack,causeType:'Error',causeStack:stack,httpStatus:500});
assert(payload.length<=4096);const row=JSON.parse(payload).raw[0];assert.equal(row.requestPath,requestPath);assert.equal(row.repoId,'demo-123');assert.equal(row.errorStack,frame);
`],{env:{...process.env,LOG_REDIS_MIRROR:'on'},encoding:'utf8',timeout:10000});
expect(child.status,child.stderr).equal(0);
});
it('writes JSON without Redis and bounds a blocked stdout pipe', () => {
const child = spawnSync(process.execPath, ['-r', 'ts-node/register/transpile-only', '-e', `
const { createLogger, getDroppedOutput } = require('./src/core/logger');
+5 -2
View File
@@ -101,7 +101,7 @@ describe("Vue 3 UI", function () {
it("shows normalized request routes and exception frames in both admin sources", async () => {
const now=new Date().toISOString(), requestId='aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa';
const sample={event:'application_log',service:'api',module:'route',severity:'error',httpStatus:500,method:'GET',route:'/api/repo/:repoId/file/:path',errorType:'TypeError',errorStack:'at printError (build/server/routes/route-utils.js:200:7)',causeType:'RangeError',causeStack:'at <anonymous> (build/core/repository.js:410:9)',requestId};
const sample={event:'application_log',service:'api',module:'route',severity:'error',httpStatus:500,method:'GET',route:'/api/repo/:repoId/file/:path',repoId:'demo-123',requestPath:'/api/repo/demo-123/file/docs/reproduce%20issue.md',errorType:'TypeError',errorStack:'at printError (build/server/routes/route-utils.js:200:7)',causeType:'RangeError',causeStack:'at <anonymous> (build/core/repository.js:410:9)',requestId};
ui=await browser('/',{
'/api/user':{username:'admin',isAdmin:true,status:'ready'},
'/api/admin/errors/investigation':{state:'ready',window:'1h',groups:[{fingerprint:'diagnostic',count:1,sample,first:now,last:now}]},
@@ -111,7 +111,10 @@ describe("Vue 3 UI", function () {
await ui.go('/admin/errors');const doc=ui.window.document;
doc.querySelector('.log-event-button').click();await delay(30);
expect(doc.querySelector('#log-detail-title').textContent).equal('TypeError');
expect(doc.querySelector('.log-timeline .log-request-route').textContent).include('GET /api/repo/:repoId/file/:path');
expect(doc.querySelector('.log-timeline .log-request-route').textContent).include('GET '+sample.requestPath);
expect(doc.querySelector('.log-reproduction').textContent).include('demo-123').and.include(sample.requestPath);
let copiedPath;Object.defineProperty(ui.window.navigator,'clipboard',{configurable:true,value:{writeText:async value=>{copiedPath=value;}}});
doc.querySelector('.log-reproduction button').click();await delay(10);expect(copiedPath).equal(sample.requestPath);
const frames=doc.querySelector('.log-timeline .log-error-stack');expect(frames.open).equal(false);
frames.querySelector('summary').click();expect(frames.open).equal(true);
expect(frames.textContent).include(sample.errorStack).and.include('RangeError').and.include(sample.causeStack);