fix: don't leak internal class

docs/docs/api/DiagnosticsChannel.md

@@ -20,8 +20,6 @@ diagnosticsChannel.channel('undici:request:create').subscribe(({ request }) => {
   console.log('method', request.method)
   console.log('path', request.path)
   console.log('headers') // array of strings, e.g: ['foo', 'bar']
-  request.addHeader('hello', 'world')
-  console.log('headers', request.headers) // e.g. ['foo', 'bar', 'hello', 'world']
 })
 ```
 

lib/core/request.js

@@ -25,6 +25,8 @@ const { headerNameLowerCasedRecord } = require('./constants')
 const invalidPathRegex = /[^\u0021-\u00ff]/
 
 const kHandler = Symbol('handler')
+const kRequest = Symbol('request')
+const kResponse = Symbol('response')
 
 class Request {
   constructor (origin, {
@@ -152,6 +154,20 @@ class Request {
 
     this.headers = []
 
+    this[kRequest] = {
+      method: this.method,
+      origin: this.origin,
+      path: this.path,
+      headers: this.headers,
+      completed: false
+    }
+    this[kResponse] = {
+      headers: null,
+      statusCode: 0,
+      statusText: '',
+      trailers: null
+    }
+
     // Only for H2
     this.expectContinue = expectContinue != null ? expectContinue : false
 
@@ -187,7 +203,9 @@ class Request {
     this[kHandler] = handler
 
     if (channels.create.hasSubscribers) {
-      channels.create.publish({ request: this })
+      channels.create.publish({
+        request: this[kRequest]
+      })
     }
   }
 
@@ -203,7 +221,9 @@ class Request {
 
   onRequestSent () {
     if (channels.bodySent.hasSubscribers) {
-      channels.bodySent.publish({ request: this })
+      channels.bodySent.publish({
+        request: this[kRequest]
+      })
     }
 
     if (this[kHandler].onRequestSent) {
@@ -235,8 +255,15 @@ class Request {
     assert(!this.aborted)
     assert(!this.completed)
 
+    this[kResponse].statusCode = statusCode
+    this[kResponse].headers = headers
+    this[kResponse].statusText = statusText
+
     if (channels.headers.hasSubscribers) {
-      channels.headers.publish({ request: this, response: { statusCode, headers, statusText } })
+      channels.headers.publish({
+        request: this[kRequest],
+        response: this[kResponse]
+      })
     }
 
     try {
@@ -270,9 +297,15 @@ class Request {
 
     assert(!this.aborted)
 
+    this[kResponse].trailers = trailers
+    this[kRequest].completed = true
+
     this.completed = true
     if (channels.trailers.hasSubscribers) {
-      channels.trailers.publish({ request: this, trailers })
+      channels.trailers.publish({
+        request: this[kRequest],
+        response: this[kResponse]
+      })
     }
 
     try {
@@ -287,7 +320,10 @@ class Request {
     this.onFinally()
 
     if (channels.error.hasSubscribers) {
-      channels.error.publish({ request: this, error })
+      channels.error.publish({
+        request: this[kRequest],
+        error
+      })
     }
 
     if (this.aborted) {
@@ -309,11 +345,6 @@ class Request {
       this.endHandler = null
     }
   }
-
-  addHeader (key, value) {
-    processHeader(this, key, value)
-    return this
-  }
 }
 
 function processHeader (request, key, val) {

test/node-test/diagnostics-channel/get.js

@@ -7,7 +7,7 @@ const { Client } = require('../../..')
 const { createServer } = require('node:http')
 
 test('Diagnostics channel - get', (t) => {
-  const assert = tspl(t, { plan: 32 })
+  const assert = tspl(t, { plan: 31 })
   const server = createServer((req, res) => {
     res.setHeader('Content-Type', 'text/plain')
     res.setHeader('trailer', 'foo')
@@ -33,8 +33,6 @@ test('Diagnostics channel - get', (t) => {
     assert.equal(request.method, 'GET')
     assert.equal(request.path, '/')
     assert.deepStrictEqual(request.headers, ['bar', 'bar'])
-    request.addHeader('hello', 'world')
-    assert.deepStrictEqual(request.headers, ['bar', 'bar', 'hello', 'world'])
   })
 
   let _connector
@@ -108,13 +106,13 @@ test('Diagnostics channel - get', (t) => {
   let endEmitted = false
 
   return new Promise((resolve) => {
-    diagnosticsChannel.channel('undici:request:trailers').subscribe(({ request, trailers }) => {
+    diagnosticsChannel.channel('undici:request:trailers').subscribe(({ request, response }) => {
       assert.equal(request.completed, true)
       assert.equal(_req, request)
       // This event is emitted after the last chunk has been added to the body stream,
       // not when it was consumed by the application
       assert.equal(endEmitted, false)
-      assert.deepStrictEqual(trailers, [Buffer.from('foo'), Buffer.from('oof')])
+      assert.deepStrictEqual(response.trailers, [Buffer.from('foo'), Buffer.from('oof')])
       resolve()
     })
 

test/node-test/diagnostics-channel/post-stream.js

@@ -8,7 +8,7 @@ const { Client } = require('../../..')
 const { createServer } = require('node:http')
 
 test('Diagnostics channel - post stream', (t) => {
-  const assert = tspl(t, { plan: 33 })
+  const assert = tspl(t, { plan: 31 })
   const server = createServer((req, res) => {
     req.resume()
     res.setHeader('Content-Type', 'text/plain')
@@ -34,9 +34,6 @@ test('Diagnostics channel - post stream', (t) => {
     assert.equal(request.method, 'POST')
     assert.equal(request.path, '/')
     assert.deepStrictEqual(request.headers, ['bar', 'bar'])
-    request.addHeader('hello', 'world')
-    assert.deepStrictEqual(request.headers, ['bar', 'bar', 'hello', 'world'])
-    assert.deepStrictEqual(request.body, body)
   })
 
   let _connector

test/node-test/diagnostics-channel/post.js

@@ -7,7 +7,7 @@ const { Client } = require('../../../')
 const { createServer } = require('node:http')
 
 test('Diagnostics channel - post', (t) => {
-  const assert = tspl(t, { plan: 33 })
+  const assert = tspl(t, { plan: 31 })
   const server = createServer((req, res) => {
     req.resume()
     res.setHeader('Content-Type', 'text/plain')
@@ -32,9 +32,6 @@ test('Diagnostics channel - post', (t) => {
     assert.equal(request.method, 'POST')
     assert.equal(request.path, '/')
     assert.deepStrictEqual(request.headers, ['bar', 'bar'])
-    request.addHeader('hello', 'world')
-    assert.deepStrictEqual(request.headers, ['bar', 'bar', 'hello', 'world'])
-    assert.deepStrictEqual(request.body, Buffer.from('hello world'))
   })
 
   let _connector

test/types/diagnostics-channel.test-d.ts

@@ -8,9 +8,6 @@ const request = {
   method: "GET" as const,
   path: "",
   headers: "",
-  addHeader: (key: string, value: string) => {
-    return request;
-  },
 };
 
 const response = {

types/diagnostics-channel.d.ts

@@ -10,7 +10,6 @@ declare namespace DiagnosticsChannel {
     method?: Dispatcher.HttpMethod;
     path: string;
     headers: string;
-    addHeader(key: string, value: string): Request;
   }
   interface Response {
     statusCode: number;