@saasquatch/program-boilerplate 3.6.1-1 → 3.6.1-3

package/README.md

@@ -177,10 +177,13 @@ export const program: Program = {
 `<my-program>.ts`
 ```typescript
 import {program} from './program';
-import {webtask} from '@saasquatch/program-boilerplate';
+import {webtask, getLogger} from '@saasquatch/program-boilerplate';
 
-webtask(program).listen(process.env.PORT, () => {
-  console.log(`My program running on port ${process.env.PORT}`);
+const logger = getLogger();
+const port = process.env.PORT ?? 3000;
+
+webtask(program).listen(port, () => {
+  logger.notice(`My program running on port ${port}`);
 });
 ```
 

package/dist/index.js

@@ -37,6 +37,7 @@ Object.defineProperty(exports, "triggerProgram", { enumerable: true, get: functi
 const logger_1 = require("./logger");
 Object.defineProperty(exports, "getLogger", { enumerable: true, get: function () { return logger_1.getLogger; } });
 Object.defineProperty(exports, "setLogLevel", { enumerable: true, get: function () { return logger_1.setLogLevel; } });
+const logger_2 = require("@saasquatch/logger");
 const types = __importStar(require("./types"));
 exports.types = types;
 const jsonata_1 = require("./jsonata");
@@ -50,6 +51,7 @@ Object.defineProperty(exports, "setRewardSchedule", { enumerable: true, get: fun
 Object.defineProperty(exports, "numToEquality", { enumerable: true, get: function () { return utils_1.numToEquality; } });
 Object.defineProperty(exports, "getTriggerSchema", { enumerable: true, get: function () { return utils_1.getTriggerSchema; } });
 Object.defineProperty(exports, "getUserCustomFieldsFromJsonata", { enumerable: true, get: function () { return utils_1.getUserCustomFieldsFromJsonata; } });
+const logger_3 = require("@saasquatch/logger");
 /**
  * Returns an express server that serves the provided handlers
  * as a program
@@ -61,8 +63,10 @@ Object.defineProperty(exports, "getUserCustomFieldsFromJsonata", { enumerable: t
 function webtask(program = {}) {
     const compression = require("compression");
     const app = express_1.default();
+    const logger = logger_2.getLogger("program-boilerplate");
     app.use(express_1.default.json({ limit: process.env.MAX_PAYLOAD_SIZE || "1mb" }));
     app.use(compression());
+    app.use(logger_3.httpLogMiddleware(logger));
     // Enforce HTTPS. The server does not redirect http -> https
     // because OWASP advises not to
     app.use((req, res, next) => {

package/dist/jsonata.js

@@ -5,10 +5,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.timeboxedJsonata = exports.safeJsonata = exports.timeboxExpression = void 0;
 const jsonata_1 = __importDefault(require("jsonata"));
-const logger_1 = require("./logger");
+const logger_1 = require("@saasquatch/logger");
 const TIMEOUT = 5000;
 const MAXDEPTH = 1000;
-const logger = logger_1.getLogger(process.env.PROGRAM_LOG_LEVEL || "debug");
 /**
  * Protect the process/browser from a runnaway expression
  * i.e. Infinite loop (tail recursion), or excessive stack growth
@@ -61,7 +60,7 @@ function safeJsonata(expression, inputData) {
         return jsonataQuery.evaluate(inputData);
     }
     catch (e) {
-        logger.warn(`Failed to evaluate JSONata expression: ${e.message}`);
+        logger_1.getLogger("program-boilerplate").warn(`Failed to evaluate JSONata expression: ${e.message}`);
     }
 }
 exports.safeJsonata = safeJsonata;
@@ -74,7 +73,7 @@ function timeboxedJsonata(expression, inputData, timeout, maxDepth) {
     }
     catch (e) {
         if (e instanceof Error) {
-            logger.warn(`Failed to evaluate JSONata expression: ${e.message}`);
+            logger_1.getLogger("program-boilerplate").warn(`Failed to evaluate JSONata expression: ${e.message}`);
         }
         return { success: false, result: undefined };
     }

package/dist/trigger.js

@@ -5,6 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.triggerProgram = void 0;
 const transaction_1 = __importDefault(require("./transaction"));
+const logger_1 = require("@saasquatch/logger");
 /**
  * Triggers the program and returns the result (JSON + HTTP code)
  *
@@ -38,12 +39,10 @@ function triggerProgram(body, program = {}) {
             body = body;
             return handleProgramVariableSchemaRequest(body, program);
         default:
-            // use winston logger instead
-            console.log("UNREACHABLE CODE REACHED!!");
+            const message = `Unrecognized messageType ${body.messageType}`;
+            logger_1.getLogger("program-boilerplate").warn(message);
             return {
-                json: {
-                    message: `Unrecognized messageType ${body.messageType}`,
-                },
+                json: { message },
                 code: 501,
             };
     }
@@ -76,8 +75,11 @@ function handleProgramTrigger(body, program) {
             // consider not returning stack trace for security reasons
             message: e.stack,
         };
-        // use winston logger instead
-        console.log(errorMes);
+        logger_1.getLogger("program-boilerplate").error({
+            message: errorMes.error,
+            ["error.message"]: e.message,
+            ["error.stack"]: e.stack,
+        });
         return {
             json: errorMes,
             code: 500,
@@ -115,8 +117,11 @@ function handleProgramIntrospection(body, program) {
             // consider not returning stack trace for security reasons
             message: e.stack,
         };
-        // use winston logger instead
-        console.log(errorMes);
+        logger_1.getLogger("program-boilerplate").error({
+            message: "Error ocurred in a webtask",
+            ["error.message"]: e.message,
+            ["error.stack"]: e.stack,
+        });
         return {
             json: errorMes,
             code: 500,
@@ -179,11 +184,19 @@ function handleProgramVariableSchemaRequest(body, program) {
         catch (e) {
             const errorMes = {
                 error: "An error occurred in a webtask (PROGRAM_TRIGGER_VARIABLES_SCHEMA_REQUEST)",
-                // consider not returning stack trace for security reasons
                 message: e.stack,
             };
-            // use winston logger instead
-            console.log(errorMes);
+            logger_1.getLogger("program-boilerplate").error({
+                message: errorMes.error,
+                ["error.message"]: e.message,
+                ["error.stack"]: e.stack,
+            });
+            // FIXME: This code wasn't actually returning a 500 before this, was that meant to be the case
+            // or did we just forget?
+            return {
+                json: errorMes,
+                code: 500,
+            };
         }
         if (!newSchema) {
             return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@saasquatch/program-boilerplate",
-  "version": "3.6.1-1",
+  "version": "3.6.1-3",
   "description": "Boilerplate for writing programs",
   "main": "dist/index.js",
   "files": [
@@ -33,7 +33,7 @@
   },
   "dependencies": {
     "@saasquatch/jsonata-paths-extractor": "^1.0.1",
-    "@saasquatch/logger": "^1.0.0-2",
+    "@saasquatch/logger": "^1.0.0-3",
     "bson-objectid": "^1.3.1",
     "compression": "^1.7.4",
     "express": "^4.17.1",