5htp-core 0.5.0 → 0.5.1-2

package/src/server/services/database/index.ts

@@ -143,7 +143,7 @@ export default class SQL extends Service<Config, Hooks, Application, Services> {
         query.then = (cb: (data: any) => void) => query().then(cb);
 
         query.first = <TRowData extends TObjetDonnees = {}>(opts: TSelectQueryOptions = {}) => this.first<TRowData>(string, opts);
-        query.firstOrFail = (message?: string, opts: TQueryOptions = {}) => this.firstOrFail<TRowData>(string, message, opts);
+        query.firstOrFail = (message: string, opts: TQueryOptions = {}) => this.firstOrFail<TRowData>(string, message, opts);
 
         query.value = <TValue extends any = number>(opts: TQueryOptions = {}) => this.selectVal<TValue>(string, opts);
         
@@ -283,7 +283,7 @@ export default class SQL extends Service<Config, Hooks, Application, Services> {
             return resultatRequetes[0] || null;
         });
 
-    public firstOrFail = <TRowData extends TObjetDonnees = {}>(query: string, message?: string, opts: TSelectQueryOptions = {}): Promise<TRowData> =>
+    public firstOrFail = <TRowData extends TObjetDonnees = {}>(query: string, message: string, opts: TSelectQueryOptions = {}): Promise<TRowData> =>
         this.select(query, opts).then((resultatRequetes: any) => {
 
             if (resultatRequetes.length === 0)

package/src/server/services/router/http/index.ts

@@ -49,7 +49,8 @@ export type Config = {
         images?: string[],
         scripts: string[],
     },
-    cors?: CorsOptions
+    cors?: CorsOptions,
+    helmet?: Parameters<typeof helmet>[0]
 }
 
 export type Hooks = {
@@ -100,7 +101,7 @@ export default class HttpServer {
         // Config
         routes.set('trust proxy', 1); // Indique qu'on est sous le proxy apache
         // Diverses protections (dont le disable x-powered-by)
-        routes.use(helmet());
+        routes.use( helmet(this.config.helmet) );
 
         /*----------------------------------
         - FICHIERS STATIQUES
@@ -162,16 +163,12 @@ export default class HttpServer {
 
             // Décodage des données post
             express.json({
-
-                // NOTE: Encore nécessaire ? Les webhooks stripe & bitgo n'étant plus utilisés
-                // Because Stripe needs the raw body, we compute it but only when hitting the Stripe callback URL.
-                /*verify: function (req: Request, res: Response, buf: Buffer) {
-                    if (req.originalUrl.startsWith('/api/paiement/impact/stripe'))
-                        //req.rawBody = buf.toString();
-                },*/
-
                 // TODO: prendre en considération les upload de fichiers
-                limit: '2mb'
+                limit: '2mb',
+                verify: (req, res, buf, encoding) => {
+                    // Store the raw request body so we can access it later
+                    req.rawBody = buf;
+                }
             }),
 
             // Permet de receptionner les données multipart (req.body + req.files)

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

@@ -12,6 +12,7 @@
 // Node
 // Npm
 import type express from 'express';
+import type { Request, Response, NextFunction } from 'express';
 import { v4 as uuid } from 'uuid';
 import type { GlobImportedWithMetas } from 'babel-plugin-glob-import';
 
@@ -265,7 +266,31 @@ export default class ServerRouter<
     public post = (...args: TApiRegisterArgs<this>) => this.registerApi('POST', ...args);
     public put = (...args: TApiRegisterArgs<this>) => this.registerApi('PUT', ...args);
     public patch = (...args: TApiRegisterArgs<this>) => this.registerApi('PATCH', ...args);
-    public delete = (...args: TApiRegisterArgs<this>) => this.registerApi('DELETE', ...args)
+    public delete = (...args: TApiRegisterArgs<this>) => this.registerApi('DELETE', ...args);
+
+    public express( 
+        middleware: (
+            req: Request,
+            res: Response,
+            next: NextFunction,
+            requestContext: TRouterContext
+        ) => void
+    ) {
+        return (context: TRouterContext) => new Promise((resolve) => {
+            
+            context.request.res.on('finish', function() {
+                //console.log('the response has been sent', request.res.statusCode);
+                resolve(true);
+            });
+    
+            middleware(
+                context.request.req, 
+                context.request.res, 
+                () => { resolve(true); }, 
+                context
+            )
+        })
+    }
 
     protected registerApi(method: TRouteHttpMethod, ...args: TApiRegisterArgs<this>): this {
 
@@ -414,22 +439,6 @@ declare type Routes = {
         // Hook
         await this.runHook('request', request);
 
-        // TODO: move to tracking
-        /*const now = new Date;
-
-        // Identify Guest & create log entry
-        const username = request.user?.name;
-        let clientId: string = request.cookies.clientId;
-        const newClient = !(typeof clientId === 'string' && clientId.length <= 39)
-        if (newClient) {
-            clientId = uuid();
-            res.cookie('clientId', clientId, { expires: new Date(253402300000000) }); // Never expires
-        }
-
-        const keepLogs = request.ip !== '86.76.176.80';
-        if (!keepLogs)  
-            requestId = 'admin';*/
-
         // Create request context so we can access request context across all the request-triggered libs
         context.run({ channelType: 'request', channelId: requestId }, async () => {
 
@@ -448,40 +457,17 @@ declare type Routes = {
                 response = await this.handleError(e, request);
             }
 
-            // Status
-            res.status(response.statusCode);
-            // Headers
-            res.header(response.headers);
-            // Data
-            res.send(response.data);
-
-            // TODO: move to tracking
-            /*if (newClient)
-                console.client({
-                    id: clientId,
-                    ip: request.ip,
-                    user: username,
-                    device: request.deviceString(),
-                    meet: now,
-                    activity: now,
-                });
-
-            console.request({
-
-                id: requestId,
-                date: now,
-
-                method: request.method,
-                url: request.path,
-                data: request.data,
-
-                ip: request.ip,
-                user: request.user?.name,
-                clientId,
+            if (!res.headersSent) {
+                // Status
+                res.status(response.statusCode);
+                // Headers
+                res.header(response.headers);
+                // Data
+                res.send(response.data);
+            } else if (response.data !== 'true') {
+                throw new Error("Can't return data from the controller since response has already been sent via express.");
+            }
 
-                statusCode: response.statusCode,
-                time: Date.now() - now.valueOf()
-            });*/
         });
     }
 
@@ -502,12 +488,15 @@ declare type Routes = {
 
     public async resolve(request: ServerRequest<this>): Promise<ServerResponse<this>> {
 
-        console.info(LogPrefix, request.ip, request.method, request.domain, request.path);
+        const logId = LogPrefix + ' ' + (request.isVirtual ? ' ---- ' : '') + request.ip + ' ' + request.method + ' ' + request.domain + ' ' + request.path;
+        console.info(logId);
+        const timeStart = Date.now();
 
         if (this.status === 'starting') {
             console.log(LogPrefix, `Waiting for servert to be resdy before resolving request`);
             await this.started;
         }
+
         try {
 
             const response = new ServerResponse<this>(request);
@@ -530,12 +519,14 @@ declare type Routes = {
 
                 // Run on resolution hooks. Ex: authentication check
                 await this.runHook('resolved', route);
+                const timeEndResolving = Date.now();
 
                 // Create response
                 await response.runController(route);
-                if (response.wasProvided)
-                    // On continue l'itération des routes, sauf si des données ont été fournie dans la réponse (.json(), .html(), ...)
+                if (response.wasProvided) {
+                    this.printTakenTime(logId, timeStart, timeEndResolving);
                     return response;
+                }
             }
 
             throw new NotFound();
@@ -551,10 +542,20 @@ declare type Routes = {
                     error.details.origin = errOrigin;
             }
 
+            this.printTakenTime(logId, timeStart);
             throw error;
         }
     }
 
+    private printTakenTime = (logId: string, timeStart: number, timeEndResolving?: number) => {
+
+        if (this.app.env.name === 'server') return;
+
+        console.log(logId + ' ' + Math.round(Date.now() - timeStart) + 'ms' + 
+            (timeEndResolving === undefined ? '' : ' | Routing: ' + Math.round(timeEndResolving - timeStart))
+        );
+    }
+
     private async resolveApiBatch( fetchers: TFetcherList, request: ServerRequest<this> ) {
 
         // TODO: use api.fetchSync instead
@@ -601,9 +602,14 @@ declare type Routes = {
             if (this.app.env.profile === 'prod')
                 e.message = "We encountered an internal error, and our team has just been notified. Sorry for the inconvenience.";
 
-        // Pour déboguer les erreurs HTTP
-        } else if (code !== 404 && this.app.env.profile === "dev")
-            console.warn(e);
+        } else {
+
+            // For debugging HTTP errors
+            if (this.app.env.profile === "dev")
+                console.warn(e);
+
+            await this.app.runHook('error.' + code, e, request);
+        }
 
         // Return error based on the request format
         if (request.accepts("html")) {

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

@@ -135,6 +135,17 @@ export default class ServerRequest<
         return locale ? locale.toUpperCase() : 'EN'
     }
 
+    public cookie( key: string, consume: boolean = false ) {
+
+        const value = this.req.cookies[ key ];
+
+        if (consume)
+            this.res.clearCookie(key);
+
+        return value;
+
+    }
+
     /*----------------------------------
    - TESTS
    ----------------------------------*/

package/src/server/services/router/response/index.ts

@@ -81,6 +81,8 @@ export default class ServerResponse<
     public statusCode: number = 200;
     public headers: {[cle: string]: string} = {}
     public cookie: express.Response["cookie"];
+    public clearCookie: express.Response["clearCookie"];
+    public canonicalUrl: URL;
 
     // If data was provided by at lead one controller
     public wasProvided = false;
@@ -90,15 +92,22 @@ export default class ServerResponse<
         super(request);
 
         this.cookie = this.request.res.cookie.bind(this.request.res);
+        this.clearCookie = this.request.res.clearCookie.bind(this.request.res);
 
         this.router = request.router;
         this.app = this.router.app;
+
+        this.canonicalUrl = new URL(request.url);
+        this.canonicalUrl.search = '';
     }
 
     public async runController( route: TAnyRoute, additionnalData: {} = {} ) {
 
         this.route = route;
 
+        // Update canonical url
+        this.updateCanonicalUrl(route);
+
         // Create response context for controllers
         const context = await this.createContext(route);
 
@@ -138,6 +147,18 @@ export default class ServerResponse<
             this.router.cache[ chunkId ] = this.data;
     }
 
+    private updateCanonicalUrl( route: TAnyRoute ) {
+
+        if (!route.options.canonicalParams)
+            return;
+
+        for (const key of route.options.canonicalParams) {
+            const paramValue = this.request.data[ key ];
+            if (paramValue !== undefined)
+                this.canonicalUrl.searchParams.set(key, paramValue);
+        }
+    }
+
     /*----------------------------------
     - INTERNAL
     ----------------------------------*/

package/src/server/services/router/response/page/document.tsx

@@ -57,9 +57,6 @@ export default class DocumentRenderer<TRouter extends Router> {
 
     public async page( html: string, page: Page, response: ServerResponse<TRouter> ) {
 
-        // TODO: can be customized via page / route config
-        const canonicalUrl = response.request.req.url;
-
         let attrsBody = {
             className: [...page.bodyClass].join(' '),
         };
@@ -94,7 +91,7 @@ export default class DocumentRenderer<TRouter extends Router> {
                     {/* Page */}
                     <title>{page.title}</title>
                     <meta content={page.description} name="description" />
-                    <link rel="canonical" href={canonicalUrl} />
+                    <link rel="canonical" href={response.canonicalUrl} />
 
                     {/* SEO, social medias, OG tags, ...  */}
                     {page.head.map(({ $, ...attrs }) => (

package/src/server/services/router/response/page/index.tsx

@@ -120,8 +120,12 @@ export default class ServerPage<TRouter extends Router = Router> extends PageRes
 
     private buildMetas() {
 
+        const shouldIndex = this.context.response.statusCode < 300;
+
         const metas = {
 
+            robots: shouldIndex ? 'index' : 'noindex',
+
             'og:type': 'website',
             'og:locale': this.app.identity.locale,
             'og:site_name': this.app.identity.web.title,