@appsemble/node-utils 0.20.8 → 0.20.11

package/{dist/loggerMiddleware.js → loggerMiddleware.js}

@@ -1,7 +1,10 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.loggerMiddleware = void 0;
-const chalk_1 = require("chalk");
+const chalk_1 = __importDefault(require("chalk"));
 const logger_1 = require("./logger");
 function rangeFormat(value, map) {
     return Object.entries(map).find(([v]) => v === 'default' || value < Number(v))[1];
@@ -15,8 +18,8 @@ function loggerMiddleware() {
     return (ctx, next) => {
         const { href, res } = ctx;
         const start = Date.now();
-        const method = (0, chalk_1.bold)(ctx.method);
-        logger_1.logger.info(`${method} ${href} — ${(0, chalk_1.white)(ctx.ip)}`);
+        const method = chalk_1.default.bold(ctx.method);
+        logger_1.logger.info(`${method} ${href} — ${chalk_1.default.white(ctx.ip)}`);
         function logResponse() {
             res.removeListener('finish', logResponse);
             // eslint-disable-next-line @typescript-eslint/no-use-before-define
@@ -25,16 +28,16 @@ function loggerMiddleware() {
             const s = `${status} ${message}`;
             const duration = Date.now() - start;
             const formatDuration = rangeFormat(duration, {
-                100: chalk_1.green,
-                1000: chalk_1.yellow,
-                default: chalk_1.red,
+                100: chalk_1.default.green,
+                1000: chalk_1.default.yellow,
+                default: chalk_1.default.red,
             });
             const formatStatus = rangeFormat(status, {
-                200: chalk_1.red,
-                300: chalk_1.green,
-                400: chalk_1.cyan,
-                500: chalk_1.yellow,
-                default: chalk_1.red,
+                200: chalk_1.default.red,
+                300: chalk_1.default.green,
+                400: chalk_1.default.cyan,
+                500: chalk_1.default.yellow,
+                default: chalk_1.default.red,
             });
             const level = rangeFormat(status, {
                 200: 'error',
@@ -49,11 +52,11 @@ function loggerMiddleware() {
             res.removeListener('close', logCancel);
             const duration = Date.now() - start;
             const formatDuration = rangeFormat(duration, {
-                100: chalk_1.green,
-                1000: chalk_1.yellow,
-                default: chalk_1.red,
+                100: chalk_1.default.green,
+                1000: chalk_1.default.yellow,
+                default: chalk_1.default.red,
             });
-            logger_1.logger.warn(`${method} ${href} ${(0, chalk_1.grey)('Cancelled')} ${formatDuration(`${duration}ms`)}`);
+            logger_1.logger.warn(`${method} ${href} ${chalk_1.default.grey('Cancelled')} ${formatDuration(`${duration}ms`)}`);
         }
         res.once('finish', logResponse);
         res.once('close', logCancel);

package/loggerMiddleware.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"loggerMiddleware.js","sourceRoot":"","sources":["loggerMiddleware.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAI1B,qCAAkC;AAOlC,SAAS,WAAW,CAAI,KAAa,EAAE,GAAgB;IACrD,OAAO,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,SAAS,IAAI,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACpF,CAAC;AAED;;;;GAIG;AACH,SAAgB,gBAAgB;IAC9B,OAAO,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;QACnB,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,GAAG,CAAC;QAC1B,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACzB,MAAM,MAAM,GAAG,eAAK,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACtC,eAAM,CAAC,IAAI,CAAC,GAAG,MAAM,IAAI,IAAI,MAAM,eAAK,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;QAE1D,SAAS,WAAW;YAClB,GAAG,CAAC,cAAc,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;YAC1C,mEAAmE;YACnE,GAAG,CAAC,cAAc,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;YAEvC,MAAM,EACJ,OAAO,EACP,QAAQ,EAAE,EACR,MAAM,EAAE,EAAE,QAAQ,EAAE,GACrB,EACD,MAAM,GACP,GAAG,GAAG,CAAC;YACR,MAAM,CAAC,GAAG,GAAG,MAAM,IAAI,OAAO,EAAE,CAAC;YACjC,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC;YAEpC,MAAM,cAAc,GAAG,WAAW,CAAC,QAAQ,EAAE;gBAC3C,GAAG,EAAE,eAAK,CAAC,KAAK;gBAChB,IAAI,EAAE,eAAK,CAAC,MAAM;gBAClB,OAAO,EAAE,eAAK,CAAC,GAAG;aACnB,CAAC,CAAC;YAEH,MAAM,YAAY,GAAG,WAAW,CAAC,MAAM,EAAE;gBACvC,GAAG,EAAE,eAAK,CAAC,GAAG;gBACd,GAAG,EAAE,eAAK,CAAC,KAAK;gBAChB,GAAG,EAAE,eAAK,CAAC,IAAI;gBACf,GAAG,EAAE,eAAK,CAAC,MAAM;gBACjB,OAAO,EAAE,eAAK,CAAC,GAAG;aACnB,CAAC,CAAC;YAEH,MAAM,KAAK,GAAG,WAAW,CAAC,MAAM,EAAE;gBAChC,GAAG,EAAE,OAAO;gBACZ,GAAG,EAAE,MAAM;gBACX,GAAG,EAAE,MAAM;gBACX,OAAO,EAAE,OAAO;aACjB,CAAC,CAAC;YAEH,eAAM,CAAC,GAAG,CACR,KAAK,EACL,GAAG,MAAM,IAAI,IAAI,IAAI,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,cAAc,CACtF,GAAG,QAAQ,IAAI,CAChB,EAAE,CACJ,CAAC;QACJ,CAAC;QAED,SAAS,SAAS;YAChB,GAAG,CAAC,cAAc,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;YAC1C,GAAG,CAAC,cAAc,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;YAEvC,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC;YACpC,MAAM,cAAc,GAAG,WAAW,CAAC,QAAQ,EAAE;gBAC3C,GAAG,EAAE,eAAK,CAAC,KAAK;gBAChB,IAAI,EAAE,eAAK,CAAC,MAAM;gBAClB,OAAO,EAAE,eAAK,CAAC,GAAG;aACnB,CAAC,CAAC;YAEH,eAAM,CAAC,IAAI,CACT,GAAG,MAAM,IAAI,IAAI,IAAI,eAAK,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,cAAc,CAAC,GAAG,QAAQ,IAAI,CAAC,EAAE,CAClF,CAAC;QACJ,CAAC;QAED,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;QAChC,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;QAE7B,OAAO,IAAI,EAAE,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC;AAxED,4CAwEC"}

package/loggerMiddleware.test.d.ts

@@ -0,0 +1 @@
+export {};

package/loggerMiddleware.test.js

@@ -0,0 +1,130 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fake_timers_1 = require("@sinonjs/fake-timers");
+const axios_test_instance_1 = require("axios-test-instance");
+const chalk_1 = __importDefault(require("chalk"));
+const koa_1 = __importDefault(require("koa"));
+const logger_1 = require("./logger");
+const loggerMiddleware_1 = require("./loggerMiddleware");
+class TestError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'TestError';
+    }
+}
+let app;
+let clock;
+beforeEach(async () => {
+    jest.spyOn(logger_1.logger, 'info').mockImplementation(() => logger_1.logger);
+    jest.spyOn(logger_1.logger, 'log').mockImplementation(() => logger_1.logger);
+    clock = (0, fake_timers_1.install)();
+    app = new koa_1.default();
+    app.use(async (ctx, next) => {
+        Object.defineProperty(ctx.request, 'origin', {
+            value: 'https://example.com:1337',
+        });
+        try {
+            await next();
+        }
+        catch (error) {
+            if (!(error instanceof TestError)) {
+                throw error;
+            }
+            ctx.status = 400;
+        }
+    });
+    app.use((0, loggerMiddleware_1.loggerMiddleware)());
+    app.silent = true;
+    axios_test_instance_1.request.defaults.maxRedirects = 0;
+    await (0, axios_test_instance_1.setTestApp)(app);
+});
+afterEach(() => {
+    clock.uninstall();
+});
+it('should log requests', async () => {
+    await axios_test_instance_1.request.get('/pizza');
+    expect(logger_1.logger.info).toHaveBeenCalledWith(`${chalk_1.default.bold('GET')} https://example.com:1337/pizza — ${chalk_1.default.white('127.0.0.1')}`);
+});
+it('should log success responses as info', async () => {
+    app.use((ctx) => {
+        clock.tick(1);
+        ctx.status = 200;
+    });
+    await axios_test_instance_1.request.get('/fries');
+    expect(logger_1.logger.log).toHaveBeenCalledWith('info', `${chalk_1.default.bold('GET')} https://example.com:1337/fries ${chalk_1.default.green('200 OK')} ${chalk_1.default.green('1ms')}`);
+});
+it('should log redirect responses as info', async () => {
+    app.use((ctx) => {
+        clock.tick(33);
+        ctx.redirect('/');
+    });
+    await axios_test_instance_1.request.get('/fries');
+    expect(logger_1.logger.log).toHaveBeenCalledWith('info', `${chalk_1.default.bold('GET')} https://example.com:1337/fries ${chalk_1.default.cyan('302 Found → /')} ${chalk_1.default.green('33ms')}`);
+});
+it('should log bad responses as warn', async () => {
+    app.use((ctx) => {
+        clock.tick(3);
+        ctx.status = 400;
+    });
+    await axios_test_instance_1.request.get('/burrito');
+    expect(logger_1.logger.log).toHaveBeenCalledWith('warn', `${chalk_1.default.bold('GET')} https://example.com:1337/burrito ${chalk_1.default.yellow('400 Bad Request')} ${chalk_1.default.green('3ms')}`);
+});
+it('should log error responses as error', async () => {
+    app.use((ctx) => {
+        clock.tick(53);
+        ctx.status = 503;
+    });
+    await axios_test_instance_1.request.get('/wrap');
+    expect(logger_1.logger.log).toHaveBeenCalledWith('error', `${chalk_1.default.bold('GET')} https://example.com:1337/wrap ${chalk_1.default.red('503 Service Unavailable')} ${chalk_1.default.green('53ms')}`);
+});
+it('should log long request lengths yellow', async () => {
+    app.use((ctx) => {
+        clock.tick(400);
+        ctx.status = 200;
+    });
+    await axios_test_instance_1.request.get('/banana');
+    expect(logger_1.logger.log).toHaveBeenCalledWith('info', `${chalk_1.default.bold('GET')} https://example.com:1337/banana ${chalk_1.default.green('200 OK')} ${chalk_1.default.yellow('400ms')}`);
+});
+it('should log extremely long request lengths red', async () => {
+    app.use((ctx) => {
+        clock.tick(1337);
+        ctx.status = 200;
+    });
+    await axios_test_instance_1.request.get('/pepperoni');
+    expect(logger_1.logger.log).toHaveBeenCalledWith('info', `${chalk_1.default.bold('GET')} https://example.com:1337/pepperoni ${chalk_1.default.green('200 OK')} ${chalk_1.default.red('1337ms')}`);
+});
+it('should log errors as internal server errors and rethrow', async () => {
+    const spy = jest.fn();
+    const error = new Error('fail');
+    let context;
+    app.on('error', spy);
+    app.use((ctx) => {
+        clock.tick(86);
+        context = ctx;
+        throw error;
+    });
+    await axios_test_instance_1.request.get('/taco');
+    expect(spy).toHaveBeenCalledWith(error, context);
+    expect(logger_1.logger.log).toHaveBeenCalledWith('error', `${chalk_1.default.bold('GET')} https://example.com:1337/taco ${chalk_1.default.red('500 Internal Server Error')} ${chalk_1.default.green('86ms')}`);
+});
+it('should append the response length if it is defined', async () => {
+    app.use((ctx) => {
+        clock.tick(1);
+        ctx.status = 200;
+        ctx.body = '{}';
+    });
+    await axios_test_instance_1.request.get('/fries');
+    expect(logger_1.logger.log).toHaveBeenCalledWith('info', `${chalk_1.default.bold('GET')} https://example.com:1337/fries ${chalk_1.default.green('200 OK')} ${chalk_1.default.green('1ms')}`);
+});
+it('should log handled errors correctly', async () => {
+    app.use(() => {
+        clock.tick(15);
+        throw new TestError();
+    });
+    await axios_test_instance_1.request.get('potatoes');
+    expect(logger_1.logger.log).toHaveBeenCalledWith('warn', `${chalk_1.default.bold('GET')} https://example.com:1337/potatoes ${chalk_1.default.yellow('400 Bad Request')} ${chalk_1.default.green('15ms')}`);
+});
+//# sourceMappingURL=loggerMiddleware.test.js.map

package/loggerMiddleware.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"loggerMiddleware.test.js","sourceRoot":"","sources":["loggerMiddleware.test.ts"],"names":[],"mappings":";;;;;AAAA,sDAA+D;AAC/D,6DAA0D;AAC1D,kDAA0B;AAC1B,8CAAsB;AAEtB,qCAAkC;AAClC,yDAAsD;AAEtD,MAAM,SAAU,SAAQ,KAAK;IAC3B,YAAY,OAAgB;QAC1B,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC;IAC1B,CAAC;CACF;AAED,IAAI,GAAQ,CAAC;AACb,IAAI,KAAqB,CAAC;AAE1B,UAAU,CAAC,KAAK,IAAI,EAAE;IACpB,IAAI,CAAC,KAAK,CAAC,eAAM,EAAE,MAAM,CAAC,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAAC,eAAM,CAAC,CAAC;IAC5D,IAAI,CAAC,KAAK,CAAC,eAAM,EAAE,KAAK,CAAC,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAAC,eAAM,CAAC,CAAC;IAC3D,KAAK,GAAG,IAAA,qBAAO,GAAE,CAAC;IAClB,GAAG,GAAG,IAAI,aAAG,EAAE,CAAC;IAChB,GAAG,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;QAC1B,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,EAAE,QAAQ,EAAE;YAC3C,KAAK,EAAE,0BAA0B;SAClC,CAAC,CAAC;QACH,IAAI;YACF,MAAM,IAAI,EAAE,CAAC;SACd;QAAC,OAAO,KAAc,EAAE;YACvB,IAAI,CAAC,CAAC,KAAK,YAAY,SAAS,CAAC,EAAE;gBACjC,MAAM,KAAK,CAAC;aACb;YACD,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC;SAClB;IACH,CAAC,CAAC,CAAC;IACH,GAAG,CAAC,GAAG,CAAC,IAAA,mCAAgB,GAAE,CAAC,CAAC;IAC5B,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC;IAClB,6BAAO,CAAC,QAAQ,CAAC,YAAY,GAAG,CAAC,CAAC;IAClC,MAAM,IAAA,gCAAU,EAAC,GAAG,CAAC,CAAC;AACxB,CAAC,CAAC,CAAC;AAEH,SAAS,CAAC,GAAG,EAAE;IACb,KAAK,CAAC,SAAS,EAAE,CAAC;AACpB,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,qBAAqB,EAAE,KAAK,IAAI,EAAE;IACnC,MAAM,6BAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC5B,MAAM,CAAC,eAAM,CAAC,IAAI,CAAC,CAAC,oBAAoB,CACtC,GAAG,eAAK,CAAC,IAAI,CAAC,KAAK,CAAC,qCAAqC,eAAK,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,CACpF,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,sCAAsC,EAAE,KAAK,IAAI,EAAE;IACpD,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACd,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACd,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC;IACnB,CAAC,CAAC,CAAC;IACH,MAAM,6BAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC5B,MAAM,CAAC,eAAM,CAAC,GAAG,CAAC,CAAC,oBAAoB,CACrC,MAAM,EACN,GAAG,eAAK,CAAC,IAAI,CAAC,KAAK,CAAC,mCAAmC,eAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,eAAK,CAAC,KAAK,CACzF,KAAK,CACN,EAAE,CACJ,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,uCAAuC,EAAE,KAAK,IAAI,EAAE;IACrD,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACd,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IACpB,CAAC,CAAC,CAAC;IACH,MAAM,6BAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC5B,MAAM,CAAC,eAAM,CAAC,GAAG,CAAC,CAAC,oBAAoB,CACrC,MAAM,EACN,GAAG,eAAK,CAAC,IAAI,CAAC,KAAK,CAAC,mCAAmC,eAAK,CAAC,IAAI,CAC/D,eAAe,CAChB,IAAI,eAAK,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAC3B,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,kCAAkC,EAAE,KAAK,IAAI,EAAE;IAChD,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACd,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACd,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC;IACnB,CAAC,CAAC,CAAC;IACH,MAAM,6BAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAC9B,MAAM,CAAC,eAAM,CAAC,GAAG,CAAC,CAAC,oBAAoB,CACrC,MAAM,EACN,GAAG,eAAK,CAAC,IAAI,CAAC,KAAK,CAAC,qCAAqC,eAAK,CAAC,MAAM,CACnE,iBAAiB,CAClB,IAAI,eAAK,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAC1B,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE;IACnD,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACd,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC;IACnB,CAAC,CAAC,CAAC;IACH,MAAM,6BAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC3B,MAAM,CAAC,eAAM,CAAC,GAAG,CAAC,CAAC,oBAAoB,CACrC,OAAO,EACP,GAAG,eAAK,CAAC,IAAI,CAAC,KAAK,CAAC,kCAAkC,eAAK,CAAC,GAAG,CAC7D,yBAAyB,CAC1B,IAAI,eAAK,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAC3B,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,wCAAwC,EAAE,KAAK,IAAI,EAAE;IACtD,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACd,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAChB,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC;IACnB,CAAC,CAAC,CAAC;IACH,MAAM,6BAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAC7B,MAAM,CAAC,eAAM,CAAC,GAAG,CAAC,CAAC,oBAAoB,CACrC,MAAM,EACN,GAAG,eAAK,CAAC,IAAI,CAAC,KAAK,CAAC,oCAAoC,eAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,eAAK,CAAC,MAAM,CAC3F,OAAO,CACR,EAAE,CACJ,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,+CAA+C,EAAE,KAAK,IAAI,EAAE;IAC7D,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACd,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjB,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC;IACnB,CAAC,CAAC,CAAC;IACH,MAAM,6BAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;IAChC,MAAM,CAAC,eAAM,CAAC,GAAG,CAAC,CAAC,oBAAoB,CACrC,MAAM,EACN,GAAG,eAAK,CAAC,IAAI,CAAC,KAAK,CAAC,uCAAuC,eAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,eAAK,CAAC,GAAG,CAC3F,QAAQ,CACT,EAAE,CACJ,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,yDAAyD,EAAE,KAAK,IAAI,EAAE;IACvE,MAAM,GAAG,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;IACtB,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC;IAChC,IAAI,OAAO,CAAC;IACZ,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;IACrB,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACd,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,OAAO,GAAG,GAAG,CAAC;QACd,MAAM,KAAK,CAAC;IACd,CAAC,CAAC,CAAC;IACH,MAAM,6BAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC3B,MAAM,CAAC,GAAG,CAAC,CAAC,oBAAoB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACjD,MAAM,CAAC,eAAM,CAAC,GAAG,CAAC,CAAC,oBAAoB,CACrC,OAAO,EACP,GAAG,eAAK,CAAC,IAAI,CAAC,KAAK,CAAC,kCAAkC,eAAK,CAAC,GAAG,CAC7D,2BAA2B,CAC5B,IAAI,eAAK,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAC3B,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,oDAAoD,EAAE,KAAK,IAAI,EAAE;IAClE,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACd,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACd,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC;QACjB,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC;IAClB,CAAC,CAAC,CAAC;IACH,MAAM,6BAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC5B,MAAM,CAAC,eAAM,CAAC,GAAG,CAAC,CAAC,oBAAoB,CACrC,MAAM,EACN,GAAG,eAAK,CAAC,IAAI,CAAC,KAAK,CAAC,mCAAmC,eAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,eAAK,CAAC,KAAK,CACzF,KAAK,CACN,EAAE,CACJ,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE;IACnD,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE;QACX,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,MAAM,IAAI,SAAS,EAAE,CAAC;IACxB,CAAC,CAAC,CAAC;IACH,MAAM,6BAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAC9B,MAAM,CAAC,eAAM,CAAC,GAAG,CAAC,CAAC,oBAAoB,CACrC,MAAM,EACN,GAAG,eAAK,CAAC,IAAI,CAAC,KAAK,CAAC,sCAAsC,eAAK,CAAC,MAAM,CACpE,iBAAiB,CAClB,IAAI,eAAK,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAC3B,CAAC;AACJ,CAAC,CAAC,CAAC"}

package/loggerMiddleware.test.ts

@@ -0,0 +1,185 @@
+import { install, InstalledClock } from '@sinonjs/fake-timers';
+import { request, setTestApp } from 'axios-test-instance';
+import chalk from 'chalk';
+import Koa from 'koa';
+
+import { logger } from './logger';
+import { loggerMiddleware } from './loggerMiddleware';
+
+class TestError extends Error {
+  constructor(message?: string) {
+    super(message);
+    this.name = 'TestError';
+  }
+}
+
+let app: Koa;
+let clock: InstalledClock;
+
+beforeEach(async () => {
+  jest.spyOn(logger, 'info').mockImplementation(() => logger);
+  jest.spyOn(logger, 'log').mockImplementation(() => logger);
+  clock = install();
+  app = new Koa();
+  app.use(async (ctx, next) => {
+    Object.defineProperty(ctx.request, 'origin', {
+      value: 'https://example.com:1337',
+    });
+    try {
+      await next();
+    } catch (error: unknown) {
+      if (!(error instanceof TestError)) {
+        throw error;
+      }
+      ctx.status = 400;
+    }
+  });
+  app.use(loggerMiddleware());
+  app.silent = true;
+  request.defaults.maxRedirects = 0;
+  await setTestApp(app);
+});
+
+afterEach(() => {
+  clock.uninstall();
+});
+
+it('should log requests', async () => {
+  await request.get('/pizza');
+  expect(logger.info).toHaveBeenCalledWith(
+    `${chalk.bold('GET')} https://example.com:1337/pizza — ${chalk.white('127.0.0.1')}`,
+  );
+});
+
+it('should log success responses as info', async () => {
+  app.use((ctx) => {
+    clock.tick(1);
+    ctx.status = 200;
+  });
+  await request.get('/fries');
+  expect(logger.log).toHaveBeenCalledWith(
+    'info',
+    `${chalk.bold('GET')} https://example.com:1337/fries ${chalk.green('200 OK')} ${chalk.green(
+      '1ms',
+    )}`,
+  );
+});
+
+it('should log redirect responses as info', async () => {
+  app.use((ctx) => {
+    clock.tick(33);
+    ctx.redirect('/');
+  });
+  await request.get('/fries');
+  expect(logger.log).toHaveBeenCalledWith(
+    'info',
+    `${chalk.bold('GET')} https://example.com:1337/fries ${chalk.cyan(
+      '302 Found → /',
+    )} ${chalk.green('33ms')}`,
+  );
+});
+
+it('should log bad responses as warn', async () => {
+  app.use((ctx) => {
+    clock.tick(3);
+    ctx.status = 400;
+  });
+  await request.get('/burrito');
+  expect(logger.log).toHaveBeenCalledWith(
+    'warn',
+    `${chalk.bold('GET')} https://example.com:1337/burrito ${chalk.yellow(
+      '400 Bad Request',
+    )} ${chalk.green('3ms')}`,
+  );
+});
+
+it('should log error responses as error', async () => {
+  app.use((ctx) => {
+    clock.tick(53);
+    ctx.status = 503;
+  });
+  await request.get('/wrap');
+  expect(logger.log).toHaveBeenCalledWith(
+    'error',
+    `${chalk.bold('GET')} https://example.com:1337/wrap ${chalk.red(
+      '503 Service Unavailable',
+    )} ${chalk.green('53ms')}`,
+  );
+});
+
+it('should log long request lengths yellow', async () => {
+  app.use((ctx) => {
+    clock.tick(400);
+    ctx.status = 200;
+  });
+  await request.get('/banana');
+  expect(logger.log).toHaveBeenCalledWith(
+    'info',
+    `${chalk.bold('GET')} https://example.com:1337/banana ${chalk.green('200 OK')} ${chalk.yellow(
+      '400ms',
+    )}`,
+  );
+});
+
+it('should log extremely long request lengths red', async () => {
+  app.use((ctx) => {
+    clock.tick(1337);
+    ctx.status = 200;
+  });
+  await request.get('/pepperoni');
+  expect(logger.log).toHaveBeenCalledWith(
+    'info',
+    `${chalk.bold('GET')} https://example.com:1337/pepperoni ${chalk.green('200 OK')} ${chalk.red(
+      '1337ms',
+    )}`,
+  );
+});
+
+it('should log errors as internal server errors and rethrow', async () => {
+  const spy = jest.fn();
+  const error = new Error('fail');
+  let context;
+  app.on('error', spy);
+  app.use((ctx) => {
+    clock.tick(86);
+    context = ctx;
+    throw error;
+  });
+  await request.get('/taco');
+  expect(spy).toHaveBeenCalledWith(error, context);
+  expect(logger.log).toHaveBeenCalledWith(
+    'error',
+    `${chalk.bold('GET')} https://example.com:1337/taco ${chalk.red(
+      '500 Internal Server Error',
+    )} ${chalk.green('86ms')}`,
+  );
+});
+
+it('should append the response length if it is defined', async () => {
+  app.use((ctx) => {
+    clock.tick(1);
+    ctx.status = 200;
+    ctx.body = '{}';
+  });
+  await request.get('/fries');
+  expect(logger.log).toHaveBeenCalledWith(
+    'info',
+    `${chalk.bold('GET')} https://example.com:1337/fries ${chalk.green('200 OK')} ${chalk.green(
+      '1ms',
+    )}`,
+  );
+});
+
+it('should log handled errors correctly', async () => {
+  app.use(() => {
+    clock.tick(15);
+    throw new TestError();
+  });
+  await request.get('potatoes');
+  expect(logger.log).toHaveBeenCalledWith(
+    'warn',
+    `${chalk.bold('GET')} https://example.com:1337/potatoes ${chalk.yellow(
+      '400 Bad Request',
+    )} ${chalk.green('15ms')}`,
+  );
+});

package/loggerMiddleware.ts

@@ -0,0 +1,93 @@
+import chalk from 'chalk';
+import { ParameterizedContext } from 'koa';
+import * as compose from 'koa-compose';
+
+import { logger } from './logger';
+
+interface RangeMap<T> {
+  [key: number]: T;
+  default: T;
+}
+
+function rangeFormat<T>(value: number, map: RangeMap<T>): T {
+  return Object.entries(map).find(([v]) => v === 'default' || value < Number(v))[1];
+}
+
+/**
+ * Koa middleware for logging requests using the Appsemble logger.
+ *
+ * @returns Koa middleware for logging requests using the Appsemble logger.
+ */
+export function loggerMiddleware(): compose.Middleware<ParameterizedContext> {
+  return (ctx, next) => {
+    const { href, res } = ctx;
+    const start = Date.now();
+    const method = chalk.bold(ctx.method);
+    logger.info(`${method} ${href} — ${chalk.white(ctx.ip)}`);
+
+    function logResponse(): void {
+      res.removeListener('finish', logResponse);
+      // eslint-disable-next-line @typescript-eslint/no-use-before-define
+      res.removeListener('close', logCancel);
+
+      const {
+        message,
+        response: {
+          header: { location },
+        },
+        status,
+      } = ctx;
+      const s = `${status} ${message}`;
+      const duration = Date.now() - start;
+
+      const formatDuration = rangeFormat(duration, {
+        100: chalk.green,
+        1000: chalk.yellow,
+        default: chalk.red,
+      });
+
+      const formatStatus = rangeFormat(status, {
+        200: chalk.red,
+        300: chalk.green,
+        400: chalk.cyan,
+        500: chalk.yellow,
+        default: chalk.red,
+      });
+
+      const level = rangeFormat(status, {
+        200: 'error',
+        400: 'info',
+        500: 'warn',
+        default: 'error',
+      });
+
+      logger.log(
+        level,
+        `${method} ${href} ${formatStatus(location ? `${s} → ${location}` : s)} ${formatDuration(
+          `${duration}ms`,
+        )}`,
+      );
+    }
+
+    function logCancel(): void {
+      res.removeListener('finish', logResponse);
+      res.removeListener('close', logCancel);
+
+      const duration = Date.now() - start;
+      const formatDuration = rangeFormat(duration, {
+        100: chalk.green,
+        1000: chalk.yellow,
+        default: chalk.red,
+      });
+
+      logger.warn(
+        `${method} ${href} ${chalk.grey('Cancelled')} ${formatDuration(`${duration}ms`)}`,
+      );
+    }
+
+    res.once('finish', logResponse);
+    res.once('close', logCancel);
+
+    return next();
+  };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/node-utils",
-  "version": "0.20.8",
+  "version": "0.20.11",
   "description": "NodeJS utilities used by Appsemble internally.",
   "keywords": [
     "app",
@@ -20,16 +20,17 @@
   "license": "LGPL-3.0-only",
   "author": "Appsemble <info@appsemble.com> (https://appsemble.com)",
   "sideEffects": false,
-  "main": "dist",
   "files": [
-    "dist"
+    "**/*.d.ts",
+    "**/*.js",
+    "!*.config.js"
   ],
   "scripts": {
-    "prepack": "tsc -p tsconfig.build.json",
+    "prepack": "tsc --noEmit false",
     "test": "jest"
   },
   "dependencies": {
-    "@appsemble/utils": "0.20.8",
+    "@appsemble/utils": "0.20.11",
     "@types/koa": "^2.0.0",
     "axios": "^0.27.0",
     "chalk": "^4.0.0",

package/{dist/readFileOrString.d.ts → readFileOrString.d.ts}

@@ -2,7 +2,7 @@
 /**
  * If the string represents an existing path, read the file. Otherwise, return the string itself.
  *
- * @param string - The string to handle.
+ * @param string The string to handle.
  * @returns The handled string.
  */
 export declare function readFileOrString(string: Buffer | string): Promise<Buffer | string>;

package/{dist/readFileOrString.js → readFileOrString.js}

@@ -1,17 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.readFileOrString = void 0;
-const fs_1 = require("fs");
+const promises_1 = require("fs/promises");
 const _1 = require(".");
 /**
  * If the string represents an existing path, read the file. Otherwise, return the string itself.
  *
- * @param string - The string to handle.
+ * @param string The string to handle.
  * @returns The handled string.
  */
 async function readFileOrString(string) {
     try {
-        return await fs_1.promises.readFile(string);
+        return await (0, promises_1.readFile)(string);
     }
     catch (error) {
         if ((0, _1.isErrno)(error, 'ENOENT')) {

package/readFileOrString.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"readFileOrString.js","sourceRoot":"","sources":["readFileOrString.ts"],"names":[],"mappings":";;;AAAA,0CAAuC;AAEvC,wBAA4B;AAE5B;;;;;GAKG;AACI,KAAK,UAAU,gBAAgB,CAAC,MAAuB;IAC5D,IAAI;QACF,OAAO,MAAM,IAAA,mBAAQ,EAAC,MAAM,CAAC,CAAC;KAC/B;IAAC,OAAO,KAAc,EAAE;QACvB,IAAI,IAAA,UAAO,EAAC,KAAK,EAAE,QAAQ,CAAC,EAAE;YAC5B,OAAO,MAAM,CAAC;SACf;QACD,MAAM,KAAK,CAAC;KACb;AACH,CAAC;AATD,4CASC"}

package/readFileOrString.test.d.ts

@@ -0,0 +1 @@
+export {};

package/readFileOrString.test.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const readFileOrString_1 = require("./readFileOrString");
+const testFixtures_1 = require("./testFixtures");
+it('should return file content if it resolves to a file', async () => {
+    const result = await (0, readFileOrString_1.readFileOrString)((0, testFixtures_1.resolveFixture)('hello.txt'));
+    expect(Buffer.from('Hello world!\n').equals(result)).toBe(true);
+});
+it('should return the input if it doesn’t resolve to a file', async () => {
+    const result = await (0, readFileOrString_1.readFileOrString)('hello.txt');
+    expect(result).toBe('hello.txt');
+});
+//# sourceMappingURL=readFileOrString.test.js.map

package/readFileOrString.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"readFileOrString.test.js","sourceRoot":"","sources":["readFileOrString.test.ts"],"names":[],"mappings":";;AAAA,yDAAsD;AACtD,iDAAgD;AAEhD,EAAE,CAAC,qDAAqD,EAAE,KAAK,IAAI,EAAE;IACnE,MAAM,MAAM,GAAG,MAAM,IAAA,mCAAgB,EAAC,IAAA,6BAAc,EAAC,WAAW,CAAC,CAAC,CAAC;IACnE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,MAAM,CAAC,MAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC5E,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,yDAAyD,EAAE,KAAK,IAAI,EAAE;IACvE,MAAM,MAAM,GAAG,MAAM,IAAA,mCAAgB,EAAC,WAAW,CAAC,CAAC;IACnD,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACnC,CAAC,CAAC,CAAC"}

package/readFileOrString.test.ts

@@ -0,0 +1,12 @@
+import { readFileOrString } from './readFileOrString';
+import { resolveFixture } from './testFixtures';
+
+it('should return file content if it resolves to a file', async () => {
+  const result = await readFileOrString(resolveFixture('hello.txt'));
+  expect(Buffer.from('Hello world!\n').equals(result as Buffer)).toBe(true);
+});
+
+it('should return the input if it doesn’t resolve to a file', async () => {
+  const result = await readFileOrString('hello.txt');
+  expect(result).toBe('hello.txt');
+});

package/readFileOrString.ts

@@ -0,0 +1,20 @@
+import { readFile } from 'fs/promises';
+
+import { isErrno } from '.';
+
+/**
+ * If the string represents an existing path, read the file. Otherwise, return the string itself.
+ *
+ * @param string The string to handle.
+ * @returns The handled string.
+ */
+export async function readFileOrString(string: Buffer | string): Promise<Buffer | string> {
+  try {
+    return await readFile(string);
+  } catch (error: unknown) {
+    if (isErrno(error, 'ENOENT')) {
+      return string;
+    }
+    throw error;
+  }
+}

package/{dist/testFixtures.d.ts → testFixtures.d.ts}

@@ -1,11 +1,12 @@
 /// <reference types="node" />
+/// <reference types="node" />
 import { ReadStream } from 'fs';
 /**
  * Set the test fixture base path. This folder should contain a folder named `__fixtures__`.
  *
  * This is typically called in `jest.setup.ts`.
  *
- * @param dir - The base directory
+ * @param dir The base directory
  * @example
  * ```ts
  * setFixtureBase(__dirname);
@@ -15,7 +16,7 @@ export declare function setFixtureBase(dir: string): void;
 /**
  * Resolve the path to a test fixture.
  *
- * @param path - The path to resolve relative to the fixture base. It will be normalized for the
+ * @param path The path to resolve relative to the fixture base. It will be normalized for the
  * operating system.
  * @returns The full path to the fixture path.
  */
@@ -23,9 +24,9 @@ export declare function resolveFixture(path: string): string;
 /**
  * Read a test fixture.
  *
- * @param path - The path to resolve relative to the fixture base. It will be normalized for the
+ * @param path The path to resolve relative to the fixture base. It will be normalized for the
  * operating system.
- * @param encoding - The text encoding of the file.
+ * @param encoding The text encoding of the file.
  * @returns The file contents as a string or buffer.
  */
 export declare function readFixture(path: string): Promise<Buffer>;
@@ -33,7 +34,7 @@ export declare function readFixture(path: string, encoding: BufferEncoding): Pro
 /**
  * Create a read stream for a fixture.
  *
- * @param path - The path to resolve relative to the fixture base. It will be normalized for the
+ * @param path The path to resolve relative to the fixture base. It will be normalized for the
  * operating system.
  * @returns A filesystem read stream for the fixture.
  */