5htp-core 0.1.2-3 → 0.2.0

package/src/server/services/console/bugReporter.ts

@@ -6,8 +6,8 @@
 import { v4 as uuid } from 'uuid';
 
 // Core
-import app, { $ } from '@server/app';
-import type { Console } from '.';
+import { SqlError } from '@server/error';
+import type Console from '.';
 
 // Types
 import type ServerRequest from '@server/services/router/request';
@@ -72,8 +72,6 @@ export type ApplicationBug = {
     stacktrace: string
 }
 
-const config = app.config.console;
-
 /*----------------------------------
 - CONFIG
 ----------------------------------*/
@@ -110,7 +108,8 @@ export default class BugReporter {
     private sentBugs: {[bugId: string]: number} = {};
 
     public constructor(
-        private console: Console
+        private console: Console,
+        public app = console.app,
     ) {
 
     }
@@ -133,7 +132,16 @@ export default class BugReporter {
 
     public async server( error: Error, request?: ServerRequest ) {
 
-        // error should be printed in the console, so they're acccessible from logs
+        // Print the error so it's accessible via logs
+        if (error instanceof SqlError)  {
+            let printedQuery: string;
+            try {
+                printedQuery = this.console.printSql( error.query );
+            } catch (error) {
+                printedQuery = 'Failed to print query:' + (error || 'unknown error');
+            }
+            console.error(`Error caused by this query:`, printedQuery);
+        }
         console.error(LogPrefix, `Sending bug report for the following error:`, error);
 
         // Prevent duplicates
@@ -172,6 +180,7 @@ export default class BugReporter {
 
         await this.sendToTransporters(bugReport);
 
+        // TODO: Move on App side
         /*if (app.isLoaded('sql'))
             // Memorize
             $.sql.insert('BugServer', {
@@ -192,7 +201,7 @@ export default class BugReporter {
         error.message = "A bug report has been sent to my personal mailbox. Sorry for the inconvenience.";
     }
 
-    public async app( report: AppBugInfos ) {
+    public async application( report: AppBugInfos ) {
 
         // Prevent duplicates
         if (!this.shouldSendReport(report.side, report.user, report.action, report.message))
@@ -224,17 +233,12 @@ export default class BugReporter {
             stacktrace: report.stacktrace,
         }
 
-        await this.sendToTransporters(bugReport);
-
-        /* // Send notification
-        $.email.send({
-            to: app.identity.author.email,
-            subject: "Bug app: " + report.message,
-            html: report
-        });
 
+        // TODO: 
         // Memorize
-        $.sql.insert('BugApp', );*/
+        //$.sql.insert('BugApp', );
+
+        await this.sendToTransporters(bugReport);
     }
 
     private async sendToTransporters( bugReport: Bug, error?: Error ) {
@@ -245,6 +249,12 @@ export default class BugReporter {
             return false;
         }
 
+        // Don't send if we're in local (avoid to use credits: ex: email, sms)
+        if (this.app.env.name === 'local'){
+            console.warn(LogPrefix, `Error report sending aborted since we're local.`);
+            return false;
+        }
+
         // Send report to trabporters
         await Promise.all( 
             this.transporters.map( transport => {

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

@@ -8,20 +8,21 @@ import { format as formatSql } from 'sql-formatter';
 import highlight from 'cli-highlight';
 
 // Core libs
-import app, { $ } from '@server/app';
-import logToHTML from './html';
+import Application, { Service, TPriority } from '@server/app';
 import context from '@server/context';
+import type ServerRequest from '@server/services/router/request';
+
+// Specific
+import logToHTML from './html';
 import BugReporter from "./bugReporter";
 
 /*----------------------------------
 - SERVICE CONFIG
 ----------------------------------*/
 
-export type TReportTransport = keyof typeof $
-
 type TLogProfile = 'silly' | 'info' | 'warn' | 'error'
 
-export type ConsoleConfig = {
+export type Config = {
     dev: {
         level: TLogProfile,
     },
@@ -30,15 +31,8 @@ export type ConsoleConfig = {
     }
 }
 
-declare global {
-    namespace Core {
-        interface EmailTransporters { }
-        namespace Config {
-            interface Services {
-                console: ConsoleConfig
-            }
-        }
-    }
+export type Hooks = {
+
 }
 
 /*----------------------------------
@@ -110,7 +104,10 @@ const logFields = [
 /*----------------------------------
 - LOGGER
 ----------------------------------*/
-export class Console {
+export default class Console extends Service<Config, Hooks, Application> {
+
+    // Load before all
+    public priority: TPriority = 2;
 
     // Services
     public logger!: Logger;
@@ -122,36 +119,50 @@ export class Console {
     public requests: TRequestLogs[] = [];
     public sqlQueries: TQueryLogs[] = [];
 
+    // Adapters
+    public log = console.log;
+    public warn = console.warn;
+    public info = console.info;
+    public error = console.error;
+
     /*----------------------------------
-   - INSTANCE
-   ----------------------------------*/
-    public load() {
+    - INSTANCE
+    ----------------------------------*/
+    public async register() {
 
-        const envConfig = app.config.console[ app.env.profile ];
+    }
+
+    public async start() {
+
+        const envConfig = this.config[ this.app.env.profile ];
 
         this.logger = new Logger({
             overwriteConsole: true,
-            //type: app.env.profile === 'dev' ? 'pretty' : 'hidden',
+            //type: this.app.env.profile === 'dev' ? 'pretty' : 'hidden',
             requestId: (): string => {
                 const { channelType, channelId } = this.getChannel();
                 return channelId === undefined ? channelType : channelType + ':' + channelId;
             },
             displayRequestId: false,
+            prettyInspectOptions: {
+                depth: 2
+            }
         });
 
         this.logger.attachTransport({
-            silly: this.log.bind(this),
-            debug: this.log.bind(this),
-            trace: this.log.bind(this),
-            info: this.log.bind(this),
-            warn: this.log.bind(this),
-            error: this.log.bind(this),
-            fatal: this.log.bind(this),
+            silly: this.logEntry.bind(this),
+            debug: this.logEntry.bind(this),
+            trace: this.logEntry.bind(this),
+            info: this.logEntry.bind(this),
+            warn: this.logEntry.bind(this),
+            error: this.logEntry.bind(this),
+            fatal: this.logEntry.bind(this),
         }, envConfig.level);
 
         setInterval(() => this.clean(), 60000);
 
-        return this.logger;
+        // Send email report
+        this.app.on('error', (error: Error, request?: ServerRequest) => this.bugReport.server(error, request));
     }
 
     private clean() {
@@ -169,7 +180,7 @@ export class Console {
         }
     }
 
-    private log(entry: ILogObject) {
+    private logEntry(entry: ILogObject) {
 
         const [channelType, channelId] = entry.requestId?.split(':') || ['master'];
         if (entry.requestId === 'admin')
@@ -184,10 +195,10 @@ export class Console {
         // remove webpack path
         if (miniLog.filePath !== undefined) {
 
-            const appPrefix = '/webpack:/' + app.pkg.name + '/src/';
+            const appPrefix = '/webpack:/' + this.app.pkg.name + '/src/';
             const appPrefixIndex = miniLog.filePath.indexOf(appPrefix);
 
-            const corePrefix = '/webpack:/' + app.pkg.name + '/node_modules/5htp-core/src/';
+            const corePrefix = '/webpack:/' + this.app.pkg.name + '/node_modules/5htp-core/src/';
             const corePrefixIndex = miniLog.filePath.indexOf(corePrefix);
 
             if (appPrefixIndex !== -1)
@@ -216,8 +227,8 @@ export class Console {
     - READ
     ----------------------------------*/
 
-    public getClients() {
-        return $.sql`
+    /*public getClients() {
+        return sql`
             SELECT * FROM logs.Clients
             ORDER BY activity DESC
             LIMIT 100
@@ -228,7 +239,7 @@ export class Console {
         return (
             this.clients.find(c => c.id === clientId)
             ||
-            await $.sql`
+            await sql`
                 SELECT * FROM logs.Clients
                 WHERE id = ${clientId}
             `.first()
@@ -236,7 +247,7 @@ export class Console {
     }
 
     public getRequests(clientId?: string) {
-        return $.sql`
+        return sql`
             SELECT * FROM logs.Requests
             ORDER BY date DESC
             LIMIT 100
@@ -247,7 +258,7 @@ export class Console {
         return (
             this.requests.find(r => r.id === requestId)
             ||
-            await $.sql`
+            await sql`
                 SELECT * FROM logs.Requests
                 WHERE id = ${requestId}
             `.first()
@@ -260,13 +271,13 @@ export class Console {
         if (channelId !== undefined)
             filters.channelId = channelId;
 
-        return $.sql`
+        return sql`
             SELECT * FROM logs.Queries
             WHERE :${filters} 
             ORDER BY date DESC
             LIMIT 100
         `.all();
-    }
+    }*/
 
     public async getLogs( channelType: ChannelInfos["channelType"], channelId?: string ) {
 
@@ -283,7 +294,7 @@ export class Console {
  
     public printHtml(logs: TLog[], full: boolean = false): string {
 
-        let html = logs.map( log => logToHTML( log, this )).join('\n');
+        let html = logs.map( logEntry => logToHTML( logEntry, this )).join('\n');
 
         if (full) {
             const consoleCss = `background: #000; padding: 20px; font-family: 'Fira Mono', 'monospace', 'Monaco'; font-size: 12px; line-height: 20px;`
@@ -298,16 +309,4 @@ export class Console {
         { language: 'sql', ignoreIllegals: true }
     )
 
-}
-
-/*----------------------------------
-- REGISTER SERVICE
-----------------------------------*/
-app.register('console', Console);
-declare global {
-    namespace Core {
-        interface Services {
-            console: Console;
-        }
-    }
 }

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

@@ -3,8 +3,8 @@
 ----------------------------------*/
 
 // Core
+import Application, { Service } from '@server/app';
 import { NotFound } from '@common/errors';
-import app from '@server/app';
 import context from '@server/context';
 
 /*----------------------------------
@@ -19,25 +19,19 @@ export { default as CronTask } from './CronTask';
 - SERVICE CONFIG
 ----------------------------------*/
 
-export type CronServiceConfig = {
+export type Config = {
    
 }
 
-declare global {
-    namespace Core {
-        namespace Config {
-            interface Services {
-                cron: CronServiceConfig
-            }
-        }
-    }
+export type Hooks = {
+
 }
 
 /*----------------------------------
 - CLASSE
 ----------------------------------*/
 
-export class CronManager {
+export default class CronManager extends Service<Config, Hooks, Application> {
 
     public static taches: { [nom: string]: CronTask } = {}
     public static timer: NodeJS.Timeout;
@@ -45,11 +39,15 @@ export class CronManager {
     /*----------------------------------
     - HOOKS
     ----------------------------------*/
-    public constructor() {
-        app.on('cleanup', () => this.cleanup());
+
+    public async register() {
+
     }
 
-    public async load() {
+    public async start() {
+        
+        this.app.on('cleanup', () => this.cleanup());
+
         clearInterval(CronManager.timer);
         CronManager.timer = setInterval(() => {
 
@@ -116,16 +114,4 @@ export class CronManager {
             throw new Error(`L'instance de la tâche cron ${name} n'a pas été trouvée`);
         return cron;
     }
-}
-
-/*----------------------------------
-- REGISTER SERVICE
-----------------------------------*/
-app.register('cron', CronManager);
-declare global {
-    namespace Core {
-        interface Services {
-            cron: CronManager;
-        }
-    }
 }

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

@@ -0,0 +1,40 @@
+/*----------------------------------
+- DEPENDANCES
+----------------------------------*/
+
+// Core
+import { TQueryOptions } from './connection';
+
+/*----------------------------------
+- TYPES
+----------------------------------*/
+
+const LogPrefix = '[database][bucket]';
+
+/*----------------------------------
+- CLASS
+----------------------------------*/
+export default class Queriesbucket {
+
+    public queries: Set<string>;
+
+    public constructor( 
+        private queryOptions: TQueryOptions<'bucket'> = {},
+        queriesList: string[] = [],  
+    ) {
+        this.queries = new Set<string>(queriesList);
+    }
+
+    public add( query: string ) {
+        this.queries.add(query);
+        return this;
+    }
+
+    public delete( query: string ) {
+        this.queries.delete(query);
+    }
+
+    public run() {
+        this.queryOptions.log && console.log(LogPrefix, `Run queries bucket`, ...this.queries);
+    }
+}