proteum 2.2.0 → 2.2.2-1

package/server/services/router/index.ts

@@ -132,7 +132,13 @@ export type Config<
 // Set it as a function, so when we instanciate the services, we can callthis.router to pass the router instance in roiuter services
 type TRouterServicesList = { [serviceName: string]: AnyRouterService };
 
-export type Hooks = {};
+export type Hooks = {
+    request: { args: [request: ServerRequest<TServerRouter>] };
+    'request.finished': { args: [request: ServerRequest<TServerRouter>] };
+    resolve: { args: [request: ServerRequest<TServerRouter>] };
+    resolved: { args: [route: TMatchedRoute, request: ServerRequest<TServerRouter>, response: ServerResponse<TServerRouter>] };
+    render: { args: [page: Page<TServerRouter>] };
+};
 
 export type TControllerDefinition = {
     path?: string;
@@ -607,6 +613,32 @@ export default class ServerRouter<
     /*----------------------------------
     - RESOLUTION
     ----------------------------------*/
+    private async finalizeRequest(
+        request: ServerRequest<this>,
+        output: {
+            statusCode: number;
+            user?: string;
+            errorMessage?: string;
+        },
+    ) {
+        this.app.container.Trace.finishRequest(request.id, output);
+
+        try {
+            await this.runHook('request.finished', request);
+        } catch (error) {
+            const typedError =
+                error instanceof Error ? error : new Error(typeof error === 'string' ? error : 'Unknown request.finished hook error');
+
+            try {
+                await this.app.runHook('error', typedError, request);
+            } catch (hookError) {
+                console.error('request.finished hook error', typedError, 'Error hook failure', hookError);
+            }
+        } finally {
+            this.app.container.Trace.releaseRequest(request.id);
+        }
+    }
+
     public async middleware(req: express.Request, res: express.Response) {
         // Create request
         let requestId = uuid();
@@ -629,7 +661,7 @@ export default class ServerRouter<
             this,
         );
 
-        this.app.container.Trace.startRequest({
+        request.profiling = this.app.container.Trace.startRequest({
             id: request.id,
             method: request.method,
             path: request.path,
@@ -640,7 +672,7 @@ export default class ServerRouter<
             profilerOrigin: request.headers[profilerOriginHeader] || undefined,
             profilerParentRequestId: request.headers[profilerParentRequestIdHeader] || undefined,
         });
-        if (this.app.container.Trace.isEnabled()) res.setHeader(profilerTraceRequestIdHeader, request.id);
+        if (this.app.container.Trace.isDevTraceEnabled()) res.setHeader(profilerTraceRequestIdHeader, request.id);
         if (cachedPage) {
             this.app.container.Trace.record(
                 request.id,
@@ -659,7 +691,7 @@ export default class ServerRouter<
             // Bulk API Requests
             if (request.path === '/api' && typeof request.data.fetchers === 'object') {
                 await this.resolveApiBatch(request.data.fetchers, request);
-                this.app.container.Trace.finishRequest(request.id, {
+                await this.finalizeRequest(request, {
                     statusCode: request.res.statusCode || 200,
                     user: request.user?.email,
                 });
@@ -696,7 +728,7 @@ export default class ServerRouter<
                         },
                         'summary',
                     );
-                    this.app.container.Trace.finishRequest(request.id, {
+                    await this.finalizeRequest(request, {
                         statusCode: response.statusCode,
                         user: request.user?.email,
                     });
@@ -715,7 +747,7 @@ export default class ServerRouter<
                     'summary',
                 );
                 res.send(cachedPage.rendered);
-                this.app.container.Trace.finishRequest(request.id, {
+                await this.finalizeRequest(request, {
                     statusCode: response.statusCode,
                     user: request.user?.email,
                 });
@@ -739,19 +771,19 @@ export default class ServerRouter<
                 'summary',
             );
             res.send(response.data);
-            this.app.container.Trace.finishRequest(request.id, {
+            await this.finalizeRequest(request, {
                 statusCode: response.statusCode,
                 user: request.user?.email,
             });
         } else if (response.data !== 'true') {
-            this.app.container.Trace.finishRequest(request.id, {
+            await this.finalizeRequest(request, {
                 statusCode: res.statusCode || response.statusCode,
                 user: request.user?.email,
                 errorMessage: "Can't return data from the controller since response has already been sent via express.",
             });
             throw new Error("Can't return data from the controller since response has already been sent via express.");
         } else {
-            this.app.container.Trace.finishRequest(request.id, {
+            await this.finalizeRequest(request, {
                 statusCode: res.statusCode || response.statusCode,
                 user: request.user?.email,
             });

package/server/services/router/request/index.ts

@@ -10,7 +10,7 @@ import Bowser from 'bowser';
 
 // Core
 import BaseRequest from '@common/router/request';
-import type { TTraceCallOrigin } from '@common/dev/requestTrace';
+import type { TRequestProfiling, TTraceCallOrigin } from '@common/dev/requestTrace';
 
 // Specific
 import type { HttpMethod, HttpHeaders } from '..';
@@ -42,6 +42,24 @@ type TRequestTraceCallContext = {
     label: string;
     origin: TTraceCallOrigin;
 };
+type THeaderValue = string | string[] | undefined;
+
+const readHeader = (headers: Record<string, THeaderValue>, name: string): string | null => {
+    const exact = headers[name];
+    const alternate = exact === undefined ? headers[name.toLowerCase()] : exact;
+    const value = alternate === undefined ? headers[name.toUpperCase()] : alternate;
+
+    if (Array.isArray(value)) {
+        const firstValue = value.find((entry) => typeof entry === 'string' && entry.trim());
+        return typeof firstValue === 'string' ? firstValue.trim() : null;
+    }
+
+    return typeof value === 'string' && value.trim() ? value.trim() : null;
+};
+
+const resolveRequestIp = (req: express.Request): string | undefined => {
+    return readHeader(req.headers as Record<string, THeaderValue>, 'cf-connecting-ip') || req.ip;
+};
 
 /*----------------------------------
 - CONTEXTE
@@ -74,6 +92,7 @@ export default class ServerRequest<TRouter extends TAnyRouter = TAnyRouter> exte
     // Services
     public api: ApiClient;
     public traceCall?: TRequestTraceCallContext;
+    public profiling!: TRequestProfiling;
 
     /*----------------------------------
     - INITIALISATION
@@ -107,7 +126,7 @@ export default class ServerRequest<TRouter extends TAnyRouter = TAnyRouter> exte
         this.domain = res.req.hostname;
         this.cookies = res.req.cookies;
 
-        this.ip = res.req.ip;
+        this.ip = resolveRequestIp(res.req);
 
         this.data = data || {};
     }