Merge pull request #13012 from Budibase/chore/allow-logging-js-execution-errors

Add environment variable to log JS errors in bindings

packages/server/src/environment.ts

@@ -97,6 +97,7 @@ const environment = {
   APP_MIGRATION_TIMEOUT: parseIntSafe(process.env.APP_MIGRATION_TIMEOUT),
   JS_RUNNER_MEMORY_LIMIT:
     parseIntSafe(process.env.JS_RUNNER_MEMORY_LIMIT) || 64,
+  LOG_JS_ERRORS: process.env.LOG_JS_ERRORS,
 }
 
 // threading can cause memory issues with node-ts in development

packages/server/src/jsRunner/index.ts

@@ -1,7 +1,7 @@
 import vm from "vm"
 import env from "../environment"
-import { setJSRunner } from "@budibase/string-templates"
+import { setJSRunner, setOnErrorLog } from "@budibase/string-templates"
-import { context, timers } from "@budibase/backend-core"
+import { context, logging, timers } from "@budibase/backend-core"
 import tracer from "dd-trace"
 
 type TrackerFn = <T>(f: () => T) => T
@@ -58,4 +58,10 @@ export function init() {
       )
     })
   })
+
+  if (env.LOG_JS_ERRORS) {
+    setOnErrorLog((error: Error) => {
+      logging.logWarn(JSON.stringify(error))
+    })
+  }
 }

packages/string-templates/src/helpers/javascript.js

@@ -8,6 +8,9 @@ const { getJsHelperList } = require("./list")
 let runJS
 module.exports.setJSRunner = runner => (runJS = runner)
 
+let onErrorLog
+module.exports.setOnErrorLog = delegate => (onErrorLog = delegate)
+
 // Helper utility to strip square brackets from a value
 const removeSquareBrackets = value => {
   if (!value || typeof value !== "string") {
@@ -56,6 +59,8 @@ module.exports.processJS = (handlebars, context) => {
     const res = { data: runJS(js, sandboxContext) }
     return `{{${LITERAL_MARKER} js_result-${JSON.stringify(res)}}}`
   } catch (error) {
+    onErrorLog && onErrorLog(error)
+
     if (error.code === "ERR_SCRIPT_EXECUTION_TIMEOUT") {
       return "Timed out while executing JS"
     }

packages/string-templates/src/index.js

@@ -365,6 +365,7 @@ module.exports.doesContainString = (template, string) => {
 }
 
 module.exports.setJSRunner = javascript.setJSRunner
+module.exports.setOnErrorLog = javascript.setOnErrorLog
 
 module.exports.convertToJS = hbs => {
   const blocks = exports.findHBSBlocks(hbs)

packages/string-templates/src/index.mjs

@@ -20,6 +20,7 @@ export const disableEscaping = templates.disableEscaping
 export const findHBSBlocks = templates.findHBSBlocks
 export const convertToJS = templates.convertToJS
 export const setJSRunner = templates.setJSRunner
+export const setOnErrorLog = templates.setOnErrorLog
 export const FIND_ANY_HBS_REGEX = templates.FIND_ANY_HBS_REGEX
 export const helpersToRemoveForJs = templates.helpersToRemoveForJs