@saasquatch/program-boilerplate 3.7.4 → 3.10.0-0

package/dist/buh.d.ts

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

package/dist/buh.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const jsonata_1 = require("./jsonata");
+function main() {
+    console.log(jsonata_1.safeJsonata("", {}));
+}
+main();

package/dist/index.d.ts

@@ -8,9 +8,9 @@ import * as types from "./types";
 import { Program, ProgramRequirement, RequirementValidationResult, ValidationProgramField, ProgramTriggerBody } from "./types/rpc";
 import { timeboxExpression, timeboxedJsonata, safeJsonata } from "./jsonata";
 import { ProgramType } from "./types/saasquatch";
-import { inferType, getGoalAnalyticTimestamp, setRewardSchedule, numToEquality, getTriggerSchema, getUserCustomFieldsFromJsonata, getRewardUnitsFromJsonata } from "./utils";
+import { inferType, getGoalAnalyticTimestamp, setRewardSchedule, numToEquality, getTriggerSchema, getUserCustomFieldsFromJsonata, getRewardUnitsFromJsonata, loadStandardWebtaskConfig, WebtaskConfig } from "./utils";
 export { types };
-export { Transaction, ProgramTriggerBody, Program, ProgramType, RequirementValidationResult, ProgramRequirement, ValidationProgramField, meetEventTriggerRules, meetCustomFieldRules, meetEdgeTriggerConditions, rewardEmailQuery, setRewardSchedule, getGoalAnalyticTimestamp, triggerProgram, inferType, numToEquality, getTriggerSchema, getUserCustomFieldsFromJsonata, getRewardUnitsFromJsonata, timeboxExpression, timeboxedJsonata, safeJsonata, getLogger, setLogLevel, };
+export { Transaction, ProgramTriggerBody, Program, ProgramType, RequirementValidationResult, ProgramRequirement, ValidationProgramField, meetEventTriggerRules, meetCustomFieldRules, meetEdgeTriggerConditions, rewardEmailQuery, setRewardSchedule, getGoalAnalyticTimestamp, triggerProgram, inferType, numToEquality, getTriggerSchema, getUserCustomFieldsFromJsonata, getRewardUnitsFromJsonata, timeboxExpression, timeboxedJsonata, safeJsonata, getLogger, setLogLevel, loadStandardWebtaskConfig, };
 /**
  * Returns an express server that serves the provided handlers
  * as a program
@@ -20,3 +20,4 @@ export { Transaction, ProgramTriggerBody, Program, ProgramType, RequirementValid
  * @return {Object} The express server
  */
 export declare function webtask(program?: Program): express.Application;
+export declare function runWebtask(webtask: express.Application, config: WebtaskConfig): void;

package/dist/index.js

@@ -22,7 +22,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.webtask = exports.setLogLevel = exports.getLogger = exports.safeJsonata = exports.timeboxedJsonata = exports.timeboxExpression = exports.getRewardUnitsFromJsonata = 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.runWebtask = exports.webtask = exports.loadStandardWebtaskConfig = exports.setLogLevel = exports.getLogger = exports.safeJsonata = exports.timeboxedJsonata = exports.timeboxExpression = exports.getRewardUnitsFromJsonata = 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_1 = __importDefault(require("express"));
 const conversion_1 = require("./conversion");
 Object.defineProperty(exports, "meetCustomFieldRules", { enumerable: true, get: function () { return conversion_1.meetCustomFieldRules; } });
@@ -52,6 +52,7 @@ Object.defineProperty(exports, "numToEquality", { enumerable: true, get: functio
 Object.defineProperty(exports, "getTriggerSchema", { enumerable: true, get: function () { return utils_1.getTriggerSchema; } });
 Object.defineProperty(exports, "getUserCustomFieldsFromJsonata", { enumerable: true, get: function () { return utils_1.getUserCustomFieldsFromJsonata; } });
 Object.defineProperty(exports, "getRewardUnitsFromJsonata", { enumerable: true, get: function () { return utils_1.getRewardUnitsFromJsonata; } });
+Object.defineProperty(exports, "loadStandardWebtaskConfig", { enumerable: true, get: function () { return utils_1.loadStandardWebtaskConfig; } });
 const logger_3 = require("@saasquatch/logger");
 /**
  * Returns an express server that serves the provided handlers
@@ -67,21 +68,59 @@ function webtask(program = {}) {
     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));
+    app.use(logger_3.httpLogMiddleware(logger, { logNonErrorResponses: false }));
     // Enforce HTTPS. The server does not redirect http -> https
     // because OWASP advises not to
     app.use((req, res, next) => {
         if (process.env.NODE_ENV === "production" &&
-            req.header("X-Forwarded-Proto") !== "https") {
+            req.header("X-Forwarded-Proto") !== "https" &&
+            !["/healthz", "/livez", "/readyz"].includes(req.path)) {
             return res.status(403).send({ message: "SSL required" });
         }
         // allow the request to continue if https is used
         next();
     });
-    app.post("/*", (context, res) => {
-        const { json, code } = trigger_1.triggerProgram(context.body, program);
-        res.status(code).json(json);
+    const healthCheck = (_req, res) => {
+        const terminating = app.locals["terminating"];
+        if (typeof terminating === "boolean" && terminating) {
+            logger.info("App is in TERMINATING state, sending health check failure");
+            return res.status(503).json({ status: "TERMINATING" });
+        }
+        return res.status(200).json({ status: "OK" });
+    };
+    app.get("/healthz", healthCheck);
+    app.get("/livez", healthCheck);
+    app.get("/readyz", healthCheck);
+    app.post("/*", (req, res) => {
+        const { json, code } = trigger_1.triggerProgram(req.body, program);
+        return res.status(code).json(json);
     });
     return app;
 }
 exports.webtask = webtask;
+function runWebtask(webtask, config) {
+    const logger = logger_2.getLogger("program-boilerplate");
+    const server = webtask.listen(config.port, () => logger.notice(`${config.webtaskName} running on port ${config.port}`));
+    if (config.keepAliveTimeoutSeconds !== undefined) {
+        // https://cloud.google.com/load-balancing/docs/https/https-logging-monitoring#failure-messages
+        // (see the section on backend_connection_closed_before_data_sent_to_client)
+        server.keepAliveTimeout = config.keepAliveTimeoutSeconds * 1000;
+        server.headersTimeout = (config.keepAliveTimeoutSeconds + 1) * 1000;
+    }
+    const gracefulShutdown = (signal) => () => {
+        var _a;
+        const isTerminating = webtask.locals["terminating"];
+        if (typeof isTerminating === "boolean" && isTerminating) {
+            logger.warn("Server is already in TERMINATING state, not starting shutdown procedure again");
+            return;
+        }
+        webtask.locals["terminating"] = true;
+        logger.notice(`Received ${signal} signal, starting shutdown procedure`);
+        setTimeout(() => {
+            server.close(() => logger.notice("Server closed"));
+        }, ((_a = config.terminationDelaySeconds) !== null && _a !== void 0 ? _a : 1) * 1000);
+    };
+    process.on("SIGTERM", gracefulShutdown("SIGTERM"));
+    process.on("SIGINT", gracefulShutdown("SIGINT"));
+}
+exports.runWebtask = runWebtask;

package/dist/trigger.js

@@ -103,8 +103,7 @@ function handleProgramIntrospection(body, program) {
     const handleIntrospection = program["PROGRAM_INTROSPECTION"];
     try {
         const newTemplate = (handleIntrospection &&
-            (handleIntrospection(template, rules, bodyProgram, tenant) ||
-                handleIntrospection(template, rules))) ||
+            handleIntrospection(template, rules, bodyProgram, tenant)) ||
             template;
         return {
             json: newTemplate,

package/dist/types/rpc.d.ts

@@ -1,3 +1,4 @@
+import { ProgramTemplateBuilder } from "@saasquatch/schema/types/ProgramTemplate";
 import Transaction from "../transaction";
 /********************************************************/
 /********************************************************/
@@ -29,12 +30,18 @@ export declare type ProgramTriggerBody = {
     activeTrigger: any;
     program: any;
     tenant: {
+        impactBrandId: number | undefined | null;
         settings: {
             suspectedFraudModerationState: string;
         };
     };
     ids: string[];
 };
+declare type TenantInfo = {
+    tenantAlias: string;
+    featureFlags?: string[] | null;
+    isLiveMode: boolean;
+};
 /**
  * A JSON request body for the PROGRAM_INTROSPECTION case
  */
@@ -43,10 +50,7 @@ export declare type ProgramIntrospectionBody = {
     template: any;
     rules: any;
     program: any;
-    tenant: {
-        tenantAlias: string;
-        isLiveMode: boolean;
-    };
+    tenant: TenantInfo;
 };
 /**
  * The program validation request contains the requirement key
@@ -90,13 +94,21 @@ export declare type ProgramVariableSchemaRequestBody = {
  * Handler for the default program trigger cases
  */
 export declare type ProgramTriggerHandler = (transaction: Transaction) => void;
+/**
+ * Output of program introspection
+ */
+export declare type ProgramIntrospectionResponse = ProgramTemplateBuilder | {
+    template: ProgramTemplateBuilder;
+    errors?: {
+        key: string;
+        jsonPointer: string;
+        description: string;
+    }[];
+};
 /**
  * Introspection handler
  */
-export declare type ProgramIntrospectionHandler = (template: any, rules: any, program?: any, tenant?: {
-    tenantAlias: string;
-    isLiveMode: boolean;
-}) => any;
+export declare type ProgramIntrospectionHandler = (template: ProgramTemplateBuilder, rules: any, program: any, tenant: TenantInfo) => ProgramIntrospectionResponse;
 /**
  * Handler for an individual program requirement validation.
  * Handlers will be exported as key-value pairs in the

package/dist/utils.d.ts

@@ -1,5 +1,12 @@
 import { ProgramTriggerBody } from "./types/rpc";
 import jsonata from "jsonata";
+export declare type WebtaskConfig = {
+    port: number;
+    webtaskName: string;
+    keepAliveTimeoutSeconds: number;
+    terminationDelaySeconds: number;
+};
+export declare function loadStandardWebtaskConfig(): WebtaskConfig;
 /**
  * Append a reward schedule to the template and return the new template
  *

package/dist/utils.js

@@ -3,9 +3,33 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getRewardUnitsFromJsonata = exports.getUserCustomFieldsFromJsonata = exports.getTriggerSchema = exports.numToEquality = exports.inferType = exports.getGoalAnalyticTimestamp = exports.setRewardSchedule = void 0;
+exports.getRewardUnitsFromJsonata = exports.getUserCustomFieldsFromJsonata = exports.getTriggerSchema = exports.numToEquality = exports.inferType = exports.getGoalAnalyticTimestamp = exports.setRewardSchedule = exports.loadStandardWebtaskConfig = void 0;
 const queries_1 = require("./queries");
 const jsonata_paths_extractor_1 = __importDefault(require("@saasquatch/jsonata-paths-extractor"));
+function loadStandardWebtaskConfig() {
+    const optionalInt = (key, defaultVal) => {
+        const env = process.env[key];
+        if (!env) {
+            return defaultVal;
+        }
+        const parsedEnv = parseInt(env, 10);
+        if (Number.isNaN(parsedEnv)) {
+            throw new Error(`Environment variable "${key}" is not an integer`);
+        }
+        return parsedEnv;
+    };
+    const port = optionalInt("PORT", 3000);
+    const keepAliveTimeoutSeconds = optionalInt("HTTP_KEEP_ALIVE_SECONDS", 60);
+    const terminationDelaySeconds = optionalInt("TERMINATION_DELAY_SECONDS", 0);
+    const webtaskName = process.env["PROGRAM_NAME"] || "Unknown Program";
+    return {
+        port,
+        webtaskName,
+        keepAliveTimeoutSeconds,
+        terminationDelaySeconds,
+    };
+}
+exports.loadStandardWebtaskConfig = loadStandardWebtaskConfig;
 /**
  * Append a reward schedule to the template and return the new template
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@saasquatch/program-boilerplate",
-  "version": "3.7.4",
+  "version": "3.10.0-0",
   "description": "Boilerplate for writing programs",
   "main": "dist/index.js",
   "files": [
@@ -17,14 +17,17 @@
   },
   "author": "ReferralSaaSquatch.com, Inc.",
   "license": "MIT",
+  "resolutions": {
+    "source-map": "^0.7.4"
+  },
   "devDependencies": {
     "@types/express": "^4.17.11",
     "@types/node": "^13.13.50",
     "@types/supertest": "^2.0.11",
     "jest": "^26.6.3",
     "jest-cucumber": "^3.0.1",
-    "np": "^7.7.0",
     "prettier": "^2.2.1",
+    "source-map": "^0.7.4",
     "supertest": "^6.1.3",
     "ts-jest": "^26.5.5",
     "ts-node": "^9.1.1",
@@ -33,7 +36,8 @@
   },
   "dependencies": {
     "@saasquatch/jsonata-paths-extractor": "^1.0.1",
-    "@saasquatch/logger": "^1.0.0",
+    "@saasquatch/logger": "^1.5.1",
+    "@saasquatch/schema": "^1.28.2",
     "bson-objectid": "^1.3.1",
     "compression": "^1.7.4",
     "express": "^4.17.1",