diff --git a/src/core/AnonymizedFile.ts b/src/core/AnonymizedFile.ts index 849f662..00f145c 100644 --- a/src/core/AnonymizedFile.ts +++ b/src/core/AnonymizedFile.ts @@ -1,4 +1,4 @@ -import { recordUpstreamFailure } from "./request-evidence"; +import { recordResponseFailure } from "./request-evidence"; import { rejectStreamerRedirects } from "./streamer-response"; import { isResponseCancellation } from "./response-cancellation"; import { canReadCachedRepository } from "./cached-repository-access"; @@ -586,9 +586,9 @@ export default class AnonymizedFile { reject(error); } content - .on("error", error => { if (!res.destroyed) recordUpstreamFailure(res, error); handleStreamError(error); }) + .on("error", error => { if (!res.destroyed) recordResponseFailure(res, "unknown", "local_abort"); handleStreamError(error); }) .pipe(anonymizer) - .on("error", handleStreamError) + .on("error", error => { if (!res.destroyed) recordResponseFailure(res, "api", "local_abort"); handleStreamError(error); }) .pipe(res) .on("error", handleStreamError) .on("finish", () => { diff --git a/src/streamer/route.ts b/src/streamer/route.ts index 8c55ffe..bd9f7c2 100644 --- a/src/streamer/route.ts +++ b/src/streamer/route.ts @@ -1,4 +1,4 @@ -import { recordUpstreamFailure } from "../core/request-evidence"; +import { recordResponseFailure } from "../core/request-evidence"; import { sendSharedContent } from "../core/cached-response"; import * as express from "express"; import GitHubStream from "../core/source/GitHubStream"; @@ -126,9 +126,9 @@ router.post("/", async (req: express.Request, res: express.Response) => { anonymizer.destroy(); } content - .on("error", error => { if (!res.destroyed) recordUpstreamFailure(res, error); handleStreamError(error); }) + .on("error", error => { if (!res.destroyed) recordResponseFailure(res, "unknown", "local_abort"); handleStreamError(error); }) .pipe(anonymizer) - .on("error", handleStreamError) + .on("error", error => { if (!res.destroyed) recordResponseFailure(res, "streamer", "local_abort"); handleStreamError(error); }) .pipe(res) .on("error", handleStreamError) .on("close", () => { diff --git a/test/streamer-failure-evidence.test.js b/test/streamer-failure-evidence.test.js new file mode 100644 index 0000000..e3eb698 --- /dev/null +++ b/test/streamer-failure-evidence.test.js @@ -0,0 +1,38 @@ +const {expect}=require('chai'); +const express=require('express'); +const http=require('node:http'); +const {Readable}=require('node:stream'); +require('ts-node/register/transpile-only'); +const {monitorRequests,RequestMetrics}=require('../src/core/request-monitoring'); +const GitHubStream=require('../src/core/source/GitHubStream').default; +const {AnonymizeTransformer}=require('../src/core/anonymize-utils'); +const streamer=require('../src/streamer/route').default; +const config=require('../src/config').default; +describe('streamer failure provenance',()=>{ + for(const mode of ['cache','transform']) it(`records ${mode} failures before teardown without inventing upstream provenance`,async()=>{ + const originalCache=GitHubStream.prototype.getFileContentCache,originalTransform=AnonymizeTransformer.prototype._transform,shared=config.SHARED_CACHE_ENABLED; + const logs=[];let server; + try{ + config.SHARED_CACHE_ENABLED=false; + GitHubStream.prototype.getFileContentCache=async()=>{ + const input=new Readable({read(){}}); + setTimeout(()=>input.push(Buffer.from('partial')),10); + if(mode==='cache')setTimeout(()=>input.destroy(Object.assign(new Error('PRIVATE cache path'),{code:'EIO'})),30); + else setTimeout(()=>input.push(Buffer.from('fail')),30); + return input; + }; + AnonymizeTransformer.prototype._transform=function(chunk,_encoding,done){ + if(mode==='transform'&&chunk.toString()==='fail')done(new Error('PRIVATE output spool')); + else {this.push(chunk);done();} + }; + const app=express();app.use(monitorRequests('streamer',new RequestMetrics(),{info:(_,r)=>logs.push(r),warn:(_,r)=>logs.push(r)}));app.use(express.json());app.use('/api',streamer); + server=await new Promise(resolve=>{const s=app.listen(0,'127.0.0.1',()=>resolve(s));}); + await new Promise(resolve=>{ + const req=http.request({host:'127.0.0.1',port:server.address().port,path:'/api',method:'POST',headers:{'content-type':'application/json'}},res=>{res.resume();res.on('close',resolve);}); + req.on('error',resolve);req.end(JSON.stringify({token:'',repoFullName:'PRIVATE/repo',repoId:'demo',filePath:'file.txt',anonymizerOptions:{terms:[],filePath:'file.txt'}})); + }); + await new Promise(resolve=>setTimeout(resolve,20)); + expect(logs).length(1);expect(logs[0]).include({status:200,outcome:'interrupted',cancellationOrigin:mode==='transform'?'streamer':'unknown',cancellationEvidence:'local_abort',bytes:7}); + }finally{GitHubStream.prototype.getFileContentCache=originalCache;AnonymizeTransformer.prototype._transform=originalTransform;config.SHARED_CACHE_ENABLED=shared;if(server){server.closeAllConnections();await new Promise(resolve=>server.close(resolve));}} + }); +});