fix: use onFinished replace patch res.end, close getsentry#8848

Author: jiangbo0216

packages/node/src/handlers.ts

@@ -172,20 +172,6 @@ export function requestHandler(
     res: http.ServerResponse,
     next: (error?: any) => void,
   ): void {
-    if (options && options.flushTimeout && options.flushTimeout > 0) {
-      // eslint-disable-next-line @typescript-eslint/unbound-method
-      const _end = res.end;
-      res.end = function (chunk?: any | (() => void), encoding?: string | (() => void), cb?: () => void): void {
-        void flush(options.flushTimeout)
-          .then(() => {
-            _end.call(this, chunk, encoding, cb);
-          })
-          .then(null, e => {
-            __DEBUG_BUILD__ && logger.error(e);
-            _end.call(this, chunk, encoding, cb);
-          });
-      };
-    }
     runWithAsyncContext(() => {
       const currentHub = getCurrentHub();
       currentHub.configureScope(scope => {
@@ -216,6 +202,12 @@ export function requestHandler(
             }
           });
         }
+
+        if (options && options.flushTimeout && options.flushTimeout > 0) {
+          void flush(options.flushTimeout).then(null, e => {
+            __DEBUG_BUILD__ && logger.error(e);
+          });
+        }
       });
       next();
     });

packages/node/test/handlers.test.ts

@@ -132,6 +132,7 @@ describe('requestHandler', () => {
     const sentryRequestMiddleware = requestHandler({ flushTimeout: 1337 });
     sentryRequestMiddleware(req, res, next);
     res.end('ok');
+    res.emit('finish');
 
     setImmediate(() => {
       expect(flush).toHaveBeenCalledWith(1337);
@@ -146,6 +147,7 @@ describe('requestHandler', () => {
     const sentryRequestMiddleware = requestHandler({ flushTimeout: 1337 });
     sentryRequestMiddleware(req, res, next);
     res.end('ok');
+    res.emit('finish');
 
     setImmediate(() => {
       expect(res.finished).toBe(true);

packages/serverless/src/gcpfunction/http.ts

@@ -102,21 +102,13 @@ function _wrapHttpFunction(fn: HttpFunction, wrapOptions: Partial<HttpFunctionWr
     // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-member-access
     (res as any).__sentry_transaction = transaction;
 
-    // eslint-disable-next-line @typescript-eslint/unbound-method
-    const _end = res.end;
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    res.end = function (chunk?: any | (() => void), encoding?: string | (() => void), cb?: () => void): any {
+    res.once('finish', (): void => {
       transaction?.setHttpStatus(res.statusCode);
       transaction?.finish();
-
-      void flush(options.flushTimeout)
-        .then(null, e => {
-          __DEBUG_BUILD__ && logger.error(e);
-        })
-        .then(() => {
-          _end.call(this, chunk, encoding, cb);
-        });
-    };
+      void flush(options.flushTimeout).then(null, (e: unknown) => {
+        __DEBUG_BUILD__ && logger.error(e);
+      });
+    });
 
     let fnResult;
     try {

packages/serverless/test/gcpfunction.test.ts

@@ -1,6 +1,7 @@
 import * as SentryNode from '@sentry/node';
 import type { Event } from '@sentry/types';
 import * as domain from 'domain';
+import * as http from 'http';
 
 import * as Sentry from '../src';
 import { wrapCloudEventFunction, wrapEventFunction, wrapHttpFunction } from '../src/gcpfunction';
@@ -39,9 +40,23 @@ describe('GCPFunction', () => {
         headers: headers,
         body: { foo: 'bar' },
       } as Request;
-      const res = { end: resolve } as Response;
-      d.on('error', () => res.end());
-      d.run(() => process.nextTick(fn, req, res));
+      const res = new http.ServerResponse(req);
+      d.on('error', () => {
+        res.end();
+        res.emit('finish');
+        resolve();
+      });
+      d.run(() =>
+        process.nextTick(
+          (req: Request, res: Response) =>
+            Promise.resolve(fn(req, res)).then(() => {
+              res.emit('finish');
+              resolve();
+            }),
+          req,
+          res as Response,
+        ),
+      );
     });
   }
 
@@ -211,21 +226,13 @@ describe('GCPFunction', () => {
 
       const wrappedHandler = wrapHttpFunction(handler);
 
-      const request = {
-        method: 'POST',
-        url: '/path?q=query',
-        headers: { host: 'hostname', 'content-type': 'application/json' },
-        body: { foo: 'bar' },
-      } as Request;
-
       const mockEnd = jest.fn();
-      const response = { end: mockEnd } as unknown as Response;
 
       jest.spyOn(Sentry, 'flush').mockImplementationOnce(async () => {
         throw new Error();
       });
 
-      await expect(wrappedHandler(request, response)).resolves.toBeUndefined();
+      await expect(handleHttp(wrappedHandler).then(mockEnd)).resolves.toBeUndefined();
       expect(mockEnd).toHaveBeenCalledTimes(1);
     });
   });