@saasquatch/program-boilerplate 3.6.0-0 → 3.6.0

package/dist/conversion.js

@@ -5,7 +5,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.meetEventTriggerRules = exports.meetCustomFieldRules = exports.meetEdgeTriggerConditions = void 0;
 const assert = require("assert");
-const jsonata = require("jsonata");
+const jsonata_1 = require("./jsonata");
 //functions
 /**
  * Turns a string scalar into a Number, Boolean or String
@@ -40,11 +40,20 @@ function meetEdgeTriggerConditions(fields, activeTrigger) {
     }
     for (const field of fields) {
         if (!field.startsWith("user.")) {
-            // TODO: what to do here? this is probably some kind of error case
-            continue;
+            // we consider a malformed edge field to be "not passing"
+            return false;
+        }
+        // a simple query to retrieve the value of a field from the user should
+        // not take more than a few milliseconds. if it takes longer than 500ms
+        // something is definitely wrong with the query
+        const jsonataTimeoutMs = 500;
+        const { success: prevSuccess, result: previousValue } = jsonata_1.timeboxedJsonata(field.replace("user.", "previous."), activeTrigger, jsonataTimeoutMs);
+        const { success: currentSuccess, result: currentValue } = jsonata_1.timeboxedJsonata(field, activeTrigger, jsonataTimeoutMs);
+        // one of the JSONata expressions failed to evaluate -- edge field is considered
+        // "not passing"
+        if (!prevSuccess || !currentSuccess) {
+            return false;
         }
-        const previousValue = jsonata(field.replace("user.", "previous.")).evaluate(activeTrigger);
-        const currentValue = jsonata(field).evaluate(activeTrigger);
         try {
             assert.deepStrictEqual(currentValue, previousValue);
             // assertion passed -- field did not change

package/dist/index.d.ts

@@ -6,11 +6,11 @@ import { triggerProgram } from "./trigger";
 import { getLogger, setLogLevel } from "./logger";
 import * as types from "./types";
 import { Program, ProgramRequirement, RequirementValidationResult, ValidationProgramField, ProgramTriggerBody } from "./types/rpc";
-import { timeboxExpression, safeJsonata } from "./jsonata";
+import { timeboxExpression, timeboxedJsonata, safeJsonata } from "./jsonata";
 import { ProgramType } from "./types/saasquatch";
 import { inferType, getGoalAnalyticTimestamp, setRewardSchedule, numToEquality, getTriggerSchema, getUserCustomFieldsFromJsonata } from "./utils";
 export { types };
-export { Transaction, ProgramTriggerBody, Program, ProgramType, RequirementValidationResult, ProgramRequirement, ValidationProgramField, meetEventTriggerRules, meetCustomFieldRules, meetEdgeTriggerConditions, rewardEmailQuery, setRewardSchedule, getGoalAnalyticTimestamp, triggerProgram, inferType, numToEquality, getTriggerSchema, getUserCustomFieldsFromJsonata, timeboxExpression, safeJsonata, getLogger, setLogLevel, };
+export { Transaction, ProgramTriggerBody, Program, ProgramType, RequirementValidationResult, ProgramRequirement, ValidationProgramField, meetEventTriggerRules, meetCustomFieldRules, meetEdgeTriggerConditions, rewardEmailQuery, setRewardSchedule, getGoalAnalyticTimestamp, triggerProgram, inferType, numToEquality, getTriggerSchema, getUserCustomFieldsFromJsonata, timeboxExpression, timeboxedJsonata, safeJsonata, getLogger, setLogLevel, };
 /**
  * Returns an express server that serves the provided handlers
  * as a program

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.webtask = exports.setLogLevel = exports.getLogger = exports.safeJsonata = exports.timeboxExpression = exports.getUserCustomFieldsFromJsonata = exports.getTriggerSchema = exports.numToEquality = exports.inferType = exports.triggerProgram = exports.getGoalAnalyticTimestamp = exports.setRewardSchedule = exports.rewardEmailQuery = exports.meetEdgeTriggerConditions = exports.meetCustomFieldRules = exports.meetEventTriggerRules = exports.Transaction = exports.types = void 0;
+exports.webtask = exports.setLogLevel = exports.getLogger = exports.safeJsonata = exports.timeboxedJsonata = exports.timeboxExpression = exports.getUserCustomFieldsFromJsonata = exports.getTriggerSchema = exports.numToEquality = exports.inferType = exports.triggerProgram = exports.getGoalAnalyticTimestamp = exports.setRewardSchedule = exports.rewardEmailQuery = exports.meetEdgeTriggerConditions = exports.meetCustomFieldRules = exports.meetEventTriggerRules = exports.Transaction = exports.types = void 0;
 const express = require("express");
 const conversion_1 = require("./conversion");
 Object.defineProperty(exports, "meetCustomFieldRules", { enumerable: true, get: function () { return conversion_1.meetCustomFieldRules; } });
@@ -19,6 +19,7 @@ const types = require("./types");
 exports.types = types;
 const jsonata_1 = require("./jsonata");
 Object.defineProperty(exports, "timeboxExpression", { enumerable: true, get: function () { return jsonata_1.timeboxExpression; } });
+Object.defineProperty(exports, "timeboxedJsonata", { enumerable: true, get: function () { return jsonata_1.timeboxedJsonata; } });
 Object.defineProperty(exports, "safeJsonata", { enumerable: true, get: function () { return jsonata_1.safeJsonata; } });
 const utils_1 = require("./utils");
 Object.defineProperty(exports, "inferType", { enumerable: true, get: function () { return utils_1.inferType; } });

package/dist/jsonata.d.ts

@@ -7,5 +7,12 @@ import * as jsonata from "jsonata";
  * @param {Number} timeout - max time in ms
  * @param {Number} maxDepth - max stack depth
  */
-export declare function timeboxExpression(expr: jsonata.Expression): void;
+export declare function timeboxExpression(expr: jsonata.Expression, timeout?: number, maxDepth?: number): void;
+/**
+ * @deprecated Use timeboxedJsonata instead
+ */
 export declare function safeJsonata(expression: string, inputData: any): any;
+export declare function timeboxedJsonata(expression: string, inputData: any, timeout?: number, maxDepth?: number): {
+    success: boolean;
+    result: any;
+};

package/dist/jsonata.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.safeJsonata = exports.timeboxExpression = void 0;
+exports.timeboxedJsonata = exports.safeJsonata = exports.timeboxExpression = void 0;
 const jsonata = require("jsonata");
 const logger_1 = require("./logger");
 const TIMEOUT = 5000;
@@ -14,19 +14,21 @@ const logger = logger_1.getLogger(process.env.PROGRAM_LOG_LEVEL || "debug");
  * @param {Number} timeout - max time in ms
  * @param {Number} maxDepth - max stack depth
  */
-function timeboxExpression(expr) {
-    let depth = 0;
-    const time = Date.now();
-    let checkRunnaway = function () {
-        if (depth > MAXDEPTH) {
+function timeboxExpression(expr, timeout, maxDepth) {
+    const startTime = Date.now();
+    const actualTimeout = timeout !== null && timeout !== void 0 ? timeout : TIMEOUT;
+    const actualMaxDepth = maxDepth !== null && maxDepth !== void 0 ? maxDepth : MAXDEPTH;
+    let currentDepth = 0;
+    const checkRunnaway = function () {
+        if (currentDepth > actualMaxDepth) {
             // stack too deep
             throw {
                 code: "U1001",
-                message: "Stack overflow error: Check for non-terminating recursive function.  Consider rewriting as tail-recursive.",
+                message: "Stack overflow error: Check for non-terminating recursive function. Consider rewriting as tail-recursive.",
                 stack: new Error().stack,
             };
         }
-        if (Date.now() - time > TIMEOUT) {
+        if (Date.now() - startTime > actualTimeout) {
             // expression has run for too long
             throw {
                 code: "U1002",
@@ -36,16 +38,19 @@ function timeboxExpression(expr) {
         }
     };
     // register callbacks
-    expr.assign("__evaluate_entry", function (expr, input, environment) {
-        depth++;
+    expr.assign("__evaluate_entry", () => {
+        currentDepth++;
         checkRunnaway();
     });
-    expr.assign("__evaluate_exit", function (expr, input, environment, result) {
-        depth--;
+    expr.assign("__evaluate_exit", () => {
+        currentDepth--;
         checkRunnaway();
     });
 }
 exports.timeboxExpression = timeboxExpression;
+/**
+ * @deprecated Use timeboxedJsonata instead
+ */
 function safeJsonata(expression, inputData) {
     try {
         const jsonataQuery = jsonata(expression);
@@ -57,3 +62,18 @@ function safeJsonata(expression, inputData) {
     }
 }
 exports.safeJsonata = safeJsonata;
+function timeboxedJsonata(expression, inputData, timeout, maxDepth) {
+    try {
+        const jsonataQuery = jsonata(expression);
+        timeboxExpression(jsonataQuery, timeout, maxDepth);
+        const result = jsonataQuery.evaluate(inputData);
+        return { success: true, result };
+    }
+    catch (e) {
+        if (e instanceof Error) {
+            logger.warn(`Failed to evaluate JSONata expression: ${e.message}`);
+        }
+        return { success: false, result: undefined };
+    }
+}
+exports.timeboxedJsonata = timeboxedJsonata;

package/package.json

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