anote-server-libs 0.5.3 → 0.6.1

package/package.json

@@ -1,36 +1,36 @@
-{
-  "name": "anote-server-libs",
-  "version": "0.5.3",
-  "description": "Helpers for express-TS servers",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "build": "tsc -p tsconfig.json"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://gitlab.anotemusic.com/anote/anote-server-libs.git"
-  },
-  "keywords": [
-    "Express"
-  ],
-  "author": "Mathonet Gregoire",
-  "license": "MIT",
-  "dependencies": {
-    "@types/memcached": "2.2.9",
-    "@types/mssql": "9.1.2",
-    "@types/pg": "8.10.7",
-    "ajv": "8.12.0",
-    "memcached": "2.2.2",
-    "mssql": "10.0.1",
-    "pg": "8.11.3"
-  },
-  "peerDependencies": {
-    "express": "4.18.2",
-    "winston": "3.11.0"
-  },
-  "devDependencies": {
-    "@types/express": "4.17.20",
-    "@types/node": "18.15.0",
-    "typescript": "5.2.2"
-  }
-}
+{
+  "name": "anote-server-libs",
+  "version": "0.6.1",
+  "description": "Helpers for express-TS servers",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "tsc -p tsconfig.json"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://gitlab.anotemusic.com/anote/anote-server-libs.git"
+  },
+  "keywords": [
+    "Express"
+  ],
+  "author": "Mathonet Gregoire",
+  "license": "MIT",
+  "dependencies": {
+    "@types/memcached": "2.2.10",
+    "@types/mssql": "9.1.5",
+    "@types/pg": "8.11.6",
+    "ajv": "8.13.0",
+    "memcached": "2.2.2",
+    "mssql": "10.0.2",
+    "pg": "8.11.5"
+  },
+  "peerDependencies": {
+    "express": "4.19.2",
+    "winston": "3.13.0"
+  },
+  "devDependencies": {
+    "@types/express": "4.17.21",
+    "@types/node": "18.15.0",
+    "typescript": "5.4.5"
+  }
+}

package/services/WithBody.ts

@@ -1,60 +1,60 @@
-import {Request, Response} from 'express';
-import Ajv, {_} from 'ajv';
-
-export const ajv = new Ajv();
-ajv.addKeyword({
-    keyword: 'maxDigits',
-    type: 'number',
-    schemaType: 'number',
-    validate: (schema: number, data: any) => typeof data === 'number' && Math.round(data * 10 ** schema) / (10 ** schema) === data
-});
-
-export function WithBody(schema: any) {
-    if(schema.type === 'object') {
-        const required: string[] = [];
-        const keys = Object.getOwnPropertyNames(schema.properties);
-        keys.forEach(key => {
-            if(schema.properties[key].required === true) {
-                required.push(key);
-            }
-            if(schema.properties[key].required === true || schema.properties[key].required === false) {
-                delete schema.properties[key].required;
-            }
-        });
-        schema.required = required;
-    }
-    const validate = ajv.compile(schema);
-    return function(_: any, __: string, descriptor: PropertyDescriptor) {
-        if(typeof descriptor.value === 'function') {
-            const previousMethod = descriptor.value;
-            descriptor.value = function(this: any, req: Request, res: Response) {
-                if(req.method.toUpperCase() !== 'POST' && req.method.toUpperCase() !== 'PUT') {
-                    return previousMethod.call(this, req, res);
-                }
-                if(!req.body) {
-                    res.status(400).json({
-                        error: {
-                            errorKey: 'client.body.missing',
-                            additionalInfo: 'client.extended.badPayload'
-                        }
-                    });
-                } else {
-                    const valid = validate(req.body);
-                    if(valid) {
-                        return previousMethod.call(this, req, res);
-                    } else {
-                        res.status(400).json({
-                            error: {
-                                errorKey: 'client.body.missing',
-                                additionalInfo: 'client.extended.badPayload',
-                                detailedInfo: validate.errors
-                            }
-                        });
-                    }
-                }
-            };
-            return descriptor;
-        }
-        return undefined;
-    };
-}
+import {Request, Response} from 'express';
+import Ajv, {_} from 'ajv';
+
+export const ajv = new Ajv();
+ajv.addKeyword({
+    keyword: 'maxDigits',
+    type: 'number',
+    schemaType: 'number',
+    validate: (schema: number, data: any) => typeof data === 'number' && Math.round(data * 10 ** schema) / (10 ** schema) === data
+});
+
+export function WithBody(schema: any) {
+    if(schema.type === 'object') {
+        const required: string[] = [];
+        const keys = Object.getOwnPropertyNames(schema.properties);
+        keys.forEach(key => {
+            if(schema.properties[key].required === true) {
+                required.push(key);
+            }
+            if(schema.properties[key].required === true || schema.properties[key].required === false) {
+                delete schema.properties[key].required;
+            }
+        });
+        schema.required = required;
+    }
+    const validate = ajv.compile(schema);
+    return function(_: any, __: string, descriptor: PropertyDescriptor) {
+        if(typeof descriptor.value === 'function') {
+            const previousMethod = descriptor.value;
+            descriptor.value = function(this: any, req: Request, res: Response) {
+                if(req.method.toUpperCase() !== 'POST' && req.method.toUpperCase() !== 'PUT') {
+                    return previousMethod.call(this, req, res);
+                }
+                if(!req.body) {
+                    res.status(400).json({
+                        error: {
+                            errorKey: 'client.body.missing',
+                            additionalInfo: 'client.extended.badPayload'
+                        }
+                    });
+                } else {
+                    const valid = validate(req.body);
+                    if(valid) {
+                        return previousMethod.call(this, req, res);
+                    } else {
+                        res.status(400).json({
+                            error: {
+                                errorKey: 'client.body.missing',
+                                additionalInfo: 'client.extended.badPayload',
+                                detailedInfo: validate.errors
+                            }
+                        });
+                    }
+                }
+            };
+            return descriptor;
+        }
+        return undefined;
+    };
+}

package/services/WithTransaction.ts

@@ -1,139 +1,139 @@
-import {NextFunction, Request, Response} from 'express';
-import {Logger} from 'winston';
-import {BaseModelRepository} from '../models/repository/BaseModelRepository';
-import {jsonStringify, utils} from './utils';
-
-export const enum SystemLock {
-    CHECK_CROSSING = 1,
-    FLUSH_CALLS = 2,
-    TX_CHECK = 3
-}
-
-export const withTransactionConfig = {
-    timeoutMillis: 15000
-};
-
-export function withTransaction(repo: BaseModelRepository, logger: Logger, previousMethod: (req: Request, res: Response, next: NextFunction) => void, lock?: SystemLock) {
-    return function(req: Request, res: Response, next: NextFunction) {
-        const endTerminator = res.end.bind(res);
-        const jsonTerminator = (obj: any) => {
-            res.write(jsonStringify(obj) || '{}');
-            endTerminator();
-        };
-        const connectTimeoutHandler = setTimeout(() => {
-            // Timed out getting a client, restart worker or process...
-            logger.error('Error timed out getting a client, exiting...');
-            process.exit(22);
-        }, withTransactionConfig.timeoutMillis);
-        Promise.all([
-            repo.db ? repo.db.connect() : Promise.resolve(undefined),
-            repo.dbMssql ? Promise.resolve(repo.dbMssql.transaction()) : Promise.resolve(undefined)
-        ]).then(([c1, c2]) => {
-            const dbClient = c1 || c2;
-            clearTimeout(connectTimeoutHandler);
-            // On error, will rollback...
-            utils.logger = logger;
-            dbClient.removeListener('error', utils.clientErrorHandler);
-            dbClient.on('error', utils.clientErrorHandler);
-
-            res.locals.dbClient = dbClient;
-            res.locals.dbClientCommited = false;
-            res.locals.dbClientCommit = (cb: (err: any) => any) => {
-                if(!res.locals.dbClientCommited) {
-                    res.locals.dbClientCommited = true;
-                    (repo.db ? dbClient.query('COMMIT') : dbClient.commit()).catch((err: any) => err).then((err: any) => {
-                        if(repo.db) dbClient.release();
-                        if(!(err instanceof Error)) {
-                            for(let i = 0; i < res.locals.dbClientOnCommit.length; i++) {
-                                res.locals.dbClientOnCommit[i]();
-                            }
-                        }
-                        cb(err instanceof Error ? err : undefined);
-                    });
-                } else {
-                    cb(undefined);
-                }
-            };
-            res.locals.dbClientOnCommit = [];
-            return (repo.db ? dbClient.query('BEGIN') : dbClient.begin()).then(() => {
-                const finish = () => {
-                    res.json = (obj: any) => {
-                        if(res.statusCode > 303 && res.statusCode !== 412) {
-                            if(logger) {
-                                if(res.statusCode > 499) {
-                                    logger.error('Uncaught 500: %j', obj.error.additionalInfo);
-                                } else {
-                                    logger.warn('Client error 4XX: %j', obj.error);
-                                }
-                            }
-                            (repo.db ? dbClient.query('ROLLBACK') : dbClient.rollback()).catch((err: any) => obj.error.additionalInfo2 = {message: err.message}).then(() => {
-                                if(repo.db) dbClient.release();
-                                jsonTerminator(obj);
-                            });
-                        } else {
-                            res.locals.dbClientCommit((err: any) => {
-                                if(err) {
-                                    res.status(500);
-                                    jsonTerminator({
-                                        error: {
-                                            errorKey: 'internal.db',
-                                            additionalInfo: {message: err.message}
-                                        }
-                                    });
-                                } else jsonTerminator(obj);
-                            });
-                        }
-                        return res;
-                    };
-                    res.end = () => {
-                        if(res.statusCode > 303 && res.statusCode !== 412) {
-                            if(logger && res.statusCode > 499) {
-                                logger.error('Uncaught 500 with no details...');
-                            }
-                            (repo.db ? dbClient.query('ROLLBACK') : dbClient.rollback()).catch((): any => undefined).then(() => {
-                                if(repo.db) dbClient.release();
-                                endTerminator();
-                            });
-                        } else {
-                            res.locals.dbClientCommit((err: any) => {
-                                if(err) {
-                                    res.status(500);
-                                    jsonTerminator({
-                                        error: {
-                                            errorKey: 'internal.db',
-                                            additionalInfo: {message: err.message}
-                                        }
-                                    });
-                                } else endTerminator();
-                            });
-                        }
-                        return res;
-                    };
-                    return previousMethod.call(this, req, res, next);
-                };
-
-                if(lock) {
-                    dbClient.query('SELECT pg_advisory_xact_lock(' + lock + ')').then(() => finish()).catch((err: any) => {
-                        res.status(500).json({
-                            error: {
-                                errorKey: 'internal.db',
-                                additionalInfo: {message: err.message}
-                            }
-                        });
-                        dbClient.release();
-                    });
-                } else {
-                    finish();
-                }
-            });
-        }).catch(err => {
-            // Error connecting to database or acquiring transaction, restarting worker after the timeout as well...
-            res.status(500).json({
-                error: {
-                    errorKey: 'internal.db',
-                    additionalInfo: {message: err.message}
-                }
-            });
-        });
-    };
-}
+import {NextFunction, Request, Response} from 'express';
+import {Logger} from 'winston';
+import {BaseModelRepository} from '../models/repository/BaseModelRepository';
+import {jsonStringify, utils} from './utils';
+
+export const enum SystemLock {
+    CHECK_CROSSING = 1,
+    FLUSH_CALLS = 2,
+    TX_CHECK = 3
+}
+
+export const withTransactionConfig = {
+    timeoutMillis: 15000
+};
+
+export function withTransaction(repo: BaseModelRepository, logger: Logger, previousMethod: (req: Request, res: Response, next: NextFunction) => void, lock?: SystemLock) {
+    return function(req: Request, res: Response, next: NextFunction) {
+        const endTerminator = res.end.bind(res);
+        const jsonTerminator = (obj: any) => {
+            res.write(jsonStringify(obj) || '{}');
+            endTerminator();
+        };
+        const connectTimeoutHandler = setTimeout(() => {
+            // Timed out getting a client, restart worker or process...
+            logger.error('Error timed out getting a client, exiting...');
+            process.exit(22);
+        }, withTransactionConfig.timeoutMillis);
+        Promise.all([
+            repo.db ? repo.db.connect() : Promise.resolve(undefined),
+            repo.dbMssql ? Promise.resolve(repo.dbMssql.transaction()) : Promise.resolve(undefined)
+        ]).then(([c1, c2]) => {
+            const dbClient = c1 || c2;
+            clearTimeout(connectTimeoutHandler);
+            // On error, will rollback...
+            utils.logger = logger;
+            dbClient.removeListener('error', utils.clientErrorHandler);
+            dbClient.on('error', utils.clientErrorHandler);
+
+            res.locals.dbClient = dbClient;
+            res.locals.dbClientCommited = false;
+            res.locals.dbClientCommit = (cb: (err: any) => any) => {
+                if(!res.locals.dbClientCommited) {
+                    res.locals.dbClientCommited = true;
+                    (repo.db ? dbClient.query('COMMIT') : dbClient.commit()).catch((err: any) => err).then((err: any) => {
+                        if(repo.db) dbClient.release();
+                        if(!(err instanceof Error)) {
+                            for(let i = 0; i < res.locals.dbClientOnCommit.length; i++) {
+                                res.locals.dbClientOnCommit[i]();
+                            }
+                        }
+                        cb(err instanceof Error ? err : undefined);
+                    });
+                } else {
+                    cb(undefined);
+                }
+            };
+            res.locals.dbClientOnCommit = [];
+            return (repo.db ? dbClient.query('BEGIN') : dbClient.begin()).then(() => {
+                const finish = () => {
+                    res.json = (obj: any) => {
+                        if(res.statusCode > 303 && res.statusCode !== 412) {
+                            if(logger) {
+                                if(res.statusCode > 499) {
+                                    logger.error('Uncaught 500: %j', obj.error.additionalInfo);
+                                } else {
+                                    logger.warn('Client error 4XX: %j', obj.error);
+                                }
+                            }
+                            (repo.db ? dbClient.query('ROLLBACK') : dbClient.rollback()).catch((err: any) => obj.error.additionalInfo2 = {message: err.message}).then(() => {
+                                if(repo.db) dbClient.release();
+                                jsonTerminator(obj);
+                            });
+                        } else {
+                            res.locals.dbClientCommit((err: any) => {
+                                if(err) {
+                                    res.status(500);
+                                    jsonTerminator({
+                                        error: {
+                                            errorKey: 'internal.db',
+                                            additionalInfo: {message: err.message}
+                                        }
+                                    });
+                                } else jsonTerminator(obj);
+                            });
+                        }
+                        return res;
+                    };
+                    res.end = () => {
+                        if(res.statusCode > 303 && res.statusCode !== 412) {
+                            if(logger && res.statusCode > 499) {
+                                logger.error('Uncaught 500 with no details...');
+                            }
+                            (repo.db ? dbClient.query('ROLLBACK') : dbClient.rollback()).catch((): any => undefined).then(() => {
+                                if(repo.db) dbClient.release();
+                                endTerminator();
+                            });
+                        } else {
+                            res.locals.dbClientCommit((err: any) => {
+                                if(err) {
+                                    res.status(500);
+                                    jsonTerminator({
+                                        error: {
+                                            errorKey: 'internal.db',
+                                            additionalInfo: {message: err.message}
+                                        }
+                                    });
+                                } else endTerminator();
+                            });
+                        }
+                        return res;
+                    };
+                    return previousMethod.call(this, req, res, next);
+                };
+
+                if(lock) {
+                    dbClient.query('SELECT pg_advisory_xact_lock(' + lock + ')').then(() => finish()).catch((err: any) => {
+                        res.status(500).json({
+                            error: {
+                                errorKey: 'internal.db',
+                                additionalInfo: {message: err.message}
+                            }
+                        });
+                        dbClient.release();
+                    });
+                } else {
+                    finish();
+                }
+            });
+        }).catch(err => {
+            // Error connecting to database or acquiring transaction, restarting worker after the timeout as well...
+            res.status(500).json({
+                error: {
+                    errorKey: 'internal.db',
+                    additionalInfo: {message: err.message}
+                }
+            });
+        });
+    };
+}

package/services/utils.js

@@ -140,22 +140,22 @@ function idempotent(repo, debug, logger) {
 }
 exports.idempotent = idempotent;
 function sendSelfPostableMessage(res, code, messageType, err) {
-    res.type('text/html').status(code).write(`
-<!DOCTYPE HTML>
-<html>
-<head>
-    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
-</head>
-<body>
-<script type="text/javascript">
-    window.parent.postMessage({
-        type: '${messageType}',
-        confirm: ${!err},
-        error: JSON.parse('${JSON.stringify(err) || 'null'}')
-    }, '*');
-</script>
-</body>
-</html>
+    res.type('text/html').status(code).write(`
+<!DOCTYPE HTML>
+<html>
+<head>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
+</head>
+<body>
+<script type="text/javascript">
+    window.parent.postMessage({
+        type: '${messageType}',
+        confirm: ${!err},
+        error: JSON.parse('${JSON.stringify(err) || 'null'}')
+    }, '*');
+</script>
+</body>
+</html>
     `);
     res.end();
 }