@things-factory/integration-base 7.0.1-rc.1 → 7.0.1-rc.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@things-factory/integration-base",
-  "version": "7.0.1-rc.1",
+  "version": "7.0.1-rc.7",
   "main": "dist-server/index.js",
   "browser": "client/index.js",
   "things-factory": true,
@@ -27,14 +27,14 @@
   "dependencies": {
     "@apollo/client": "^3.6.9",
     "@operato/moment-timezone-es": "^7.0.0-rc",
-    "@things-factory/api": "^7.0.1-rc.1",
-    "@things-factory/auth-base": "^7.0.1-rc.1",
-    "@things-factory/cache-service": "^7.0.1-rc.1",
-    "@things-factory/env": "^7.0.1-rc.0",
-    "@things-factory/oauth2-client": "^7.0.1-rc.1",
-    "@things-factory/scheduler-client": "^7.0.1-rc.1",
-    "@things-factory/shell": "^7.0.1-rc.1",
-    "@things-factory/utils": "^7.0.1-rc.0",
+    "@things-factory/api": "^7.0.1-rc.7",
+    "@things-factory/auth-base": "^7.0.1-rc.7",
+    "@things-factory/cache-service": "^7.0.1-rc.7",
+    "@things-factory/env": "^7.0.1-rc.7",
+    "@things-factory/oauth2-client": "^7.0.1-rc.7",
+    "@things-factory/scheduler-client": "^7.0.1-rc.7",
+    "@things-factory/shell": "^7.0.1-rc.7",
+    "@things-factory/utils": "^7.0.1-rc.7",
     "async-mqtt": "^2.5.0",
     "chance": "^1.1.11",
     "cross-fetch": "^3.0.4",
@@ -42,7 +42,7 @@
     "node-fetch": "^2.6.0",
     "promise-socket": "^7.0.0",
     "readline": "^1.3.0",
-    "vm2": "^3.9.11"
+    "ses": "^1.5.0"
   },
-  "gitHead": "fa52d291483c4aa913a9c6a9a4463a73058b1b0d"
+  "gitHead": "0e8c627f3fbb83cc1c3fadac3ec342cb8f3f0149"
 }

package/server/engine/connection-manager.ts

@@ -7,7 +7,7 @@ import { Connection, ConnectionStatus } from '../service'
 import { Connector } from './types'
 import { ProxyConnector } from './connector/proxy-connector'
 
-const { combine, timestamp, splat, printf } = format
+const { combine, splat, printf, errors } = format
 const debug = require('debug')('things-factory:integration-base:connections')
 
 const SYSTEM_TZ = Intl.DateTimeFormat().resolvedOptions().timeZone
@@ -20,12 +20,12 @@ export class ConnectionManager {
   private static connectors: { [propName: string]: Connector } = {}
   private static connections: { [domainId: string]: { [name: string]: any } } = {}
   private static entities = {}
-  private static logFormat = printf(({ level, message, timestamp }) => {
-    return `${timestamp} ${level}: ${message}`
+  private static logFormat = printf(({ level, message, timestamp, stack }) => {
+    return `${timestamp} ${level}: ${stack || message}`
   })
 
   public static logger = createLogger({
-    format: combine(systemTimestamp({ tz: SYSTEM_TZ }), splat(), ConnectionManager.logFormat),
+    format: combine(errors({ stack: true }), systemTimestamp({ tz: SYSTEM_TZ }), splat(), ConnectionManager.logFormat),
     transports: [
       new (transports as any).DailyRotateFile({
         filename: `logs/connections-%DATE%.log`,
@@ -52,8 +52,7 @@ export class ConnectionManager {
       try {
         params = JSON.parse(connection.params || '{}')
       } catch (ex) {
-        ConnectionManager.logger.error(`connection '${connection.name}' params should be JSON format`)
-        ConnectionManager.logger.error(ex)
+        ConnectionManager.logger.error(`connection '${connection.name}' params should be JSON format`, ex)
       }
 
       return {
@@ -66,7 +65,7 @@ export class ConnectionManager {
 
     return await Promise.all(
       [...Object.keys(ConnectionManager.connectors), 'proxy-connector'].map(type => {
-        const connector = 'proxy-connector' ? ProxyConnector.instance : ConnectionManager.getConnector(type)
+        const connector = type == 'proxy-connector' ? ProxyConnector.instance : ConnectionManager.getConnector(type)
 
         ConnectionManager.logger.info(`Connector '${type}' started to ready`)
 
@@ -81,7 +80,7 @@ export class ConnectionManager {
             }) as any
           )
           .catch(error => {
-            ConnectionManager.logger.error(error.message)
+            ConnectionManager.logger.error(error)
           })
           .then(() => {
             ConnectionManager.logger.info(`All connector for '${type}' ready`)

package/server/engine/connector/echo-back-connector.ts

@@ -25,7 +25,8 @@ export class EchoBack implements Connector {
       )
     } catch (e) {
       ConnectionManager.logger.error(
-        `echo-back-connector connection(${connection.name}:${connection.endpoint}) is not connected.\ncause: ${e}`
+        `echo-back-connector connection(${connection.name}:${connection.endpoint}) is not connected.`,
+        e
       )
     }
   }

package/server/engine/connector/graphql-connector.ts

@@ -39,11 +39,14 @@ export class GraphqlConnector implements Connector {
     const ERROR_HANDLER: any = ({ graphQLErrors, networkError }) => {
       if (graphQLErrors)
         graphQLErrors.map(({ message, locations, path }) => {
-          ConnectionManager.logger.error(`[GraphQL error] Message: ${message}, Location: ${locations}, Path: ${path}`)
+          ConnectionManager.logger.error(
+            `[GraphQL error] Message: ${message}, Location: ${locations}, Path: ${path}`,
+            graphQLErrors
+          )
         })
 
       if (networkError) {
-        ConnectionManager.logger.error(`[Network error - ${networkError.statusCode}] ${networkError}`)
+        ConnectionManager.logger.error(`[Network error - ${networkError.statusCode}]`, networkError)
       }
     }
 
@@ -81,7 +84,9 @@ export class GraphqlConnector implements Connector {
       })
     )
 
-    ConnectionManager.logger.info(`graphql-connector connection(${connection.name}:${connection.endpoint}) is connected`)
+    ConnectionManager.logger.info(
+      `graphql-connector connection(${connection.name}:${connection.endpoint}) is connected`
+    )
   }
 
   async disconnect(connection: InputConnection) {

package/server/engine/connector/mqtt-connector.ts

@@ -39,7 +39,8 @@ export class MqttConnector implements Connector {
       ConnectionManager.logger.info(`mqtt-connector connection(${connection.name}:${connection.endpoint}) is connected`)
     } catch (err) {
       ConnectionManager.logger.error(
-        `mqtt-connector connection(${connection.name}:${connection.endpoint}) is failed.\ncause: ${err}`
+        `mqtt-connector connection(${connection.name}:${connection.endpoint}) is failed.`,
+        err
       )
     }
   }

package/server/engine/connector/mssql-connector.ts

@@ -7,7 +7,7 @@ import { InputConnection } from '../../service/connection/connection-type'
 try {
   var Client = require('mssql')
 } catch (err) {
-  logger.error('mssql module loading failed')
+  logger.error('mssql module loading failed', err)
 }
 
 export class MssqlConnector implements Connector {

package/server/engine/connector/operato-connector.ts

@@ -160,14 +160,16 @@ export class OperatoConnector implements Connector {
           await this.runScenario(subscriptions, data?.data?.data)
         },
         error: error => {
-          ConnectionManager.logger.error(`(${connection.name}:${connection.endpoint}) subscription error: ${error}`)
+          ConnectionManager.logger.error(`(${connection.name}:${connection.endpoint}) subscription error`, error)
         },
         complete: () => {
           ConnectionManager.logger.info(`(${connection.name}:${connection.endpoint}) subscription complete`)
         }
       })
 
-      ConnectionManager.logger.info(`(${connection.name}:${connection.endpoint}) subscription closed flag: ${subscriptionObserver.closed}`)
+      ConnectionManager.logger.info(
+        `(${connection.name}:${connection.endpoint}) subscription closed flag: ${subscriptionObserver.closed}`
+      )
 
       subscriptions.push({
         tag,
@@ -180,7 +182,9 @@ export class OperatoConnector implements Connector {
     client['subscriptions'] = subscriptions
     ConnectionManager.addConnectionInstance(connection, client)
 
-    ConnectionManager.logger.info(`operato-connector connection(${connection.name}:${connection.endpoint}) is connected`)
+    ConnectionManager.logger.info(
+      `operato-connector connection(${connection.name}:${connection.endpoint}) is connected`
+    )
   }
 
   async disconnect(connection: InputConnection) {
@@ -208,7 +212,9 @@ export class OperatoConnector implements Connector {
 
     if (!(await checkPermission(scenario.privilege, user, domain, unsafeIP, prohibitedPrivileges))) {
       const { category, privilege } = scenario.privilege || {}
-      throw new Error(`Unauthorized! ${category && privilege ? category + ':' + privilege + ' privilege' : 'ownership granted'} required`)
+      throw new Error(
+        `Unauthorized! ${category && privilege ? category + ':' + privilege + ' privilege' : 'ownership granted'} required`
+      )
     }
 
     /* create a scenario instance */

package/server/engine/connector/oracle-connector.ts

@@ -7,7 +7,7 @@ import { InputConnection } from '../../service/connection/connection-type'
 try {
   var oracledb = require('oracledb')
 } catch (err) {
-  logger.error('oracledb module loading failed')
+  logger.error('oracledb module loading failed', err)
 }
 
 export class OracleConnector implements Connector {
@@ -71,7 +71,7 @@ export class OracleConnector implements Connector {
       poolAlias,
       enableStatistics
     })
-    
+
     ConnectionManager.addConnectionInstance(connection, {
       query: async (query, params) => {
         let dbConnection: any = {}
@@ -89,12 +89,10 @@ export class OracleConnector implements Connector {
             await this.recreatePool(connection)
           }
           throw e
-        }
-        finally {
+        } finally {
           await dbConnection.close()
         }
         return taskResult
-        
       },
       execute: async (procedure, params) => {
         let dbConnection: any = {}
@@ -105,7 +103,7 @@ export class OracleConnector implements Connector {
             ${procedure}
           END;`
           dbConnection = await oracledb.getConnection(poolAlias)
-          
+
           // console.log('\n************* stat after get ****************')
           // await oracledb.getPool(poolAlias).logStatistics()
 
@@ -131,8 +129,7 @@ export class OracleConnector implements Connector {
             await this.recreatePool(connection)
           }
           throw e
-        }
-        finally {
+        } finally {
           await dbConnection.close()
 
           // console.log('\n************* stat after close ****************')

package/server/engine/connector/postgresql-connector.ts

@@ -7,7 +7,7 @@ import { InputConnection } from '../../service/connection/connection-type'
 try {
   var { Client } = require('pg')
 } catch (err) {
-  logger.error('postgresql module loading failed')
+  logger.error('postgresql module loading failed', err)
 }
 
 export class PostgresqlConnector implements Connector {
@@ -55,7 +55,8 @@ export class PostgresqlConnector implements Connector {
       ConnectionManager.logger.info(`PostgresSQL Database(${connection.name}:${database}) at ${endpoint} connected.`)
     } catch (e) {
       ConnectionManager.logger.error(
-        `PostgresSQL Database(${connection.name}:${database}) at ${endpoint} not connected.\ncause: ${e}`
+        `PostgresSQL Database(${connection.name}:${database}) at ${endpoint} not connected.`,
+        e
       )
     }
   }

package/server/engine/connector/socket-server.ts

@@ -40,7 +40,7 @@ export class SocketServer implements Connector {
           var logger = ConnectionManager.logger
           let message = ex.stack ? ex.stack : ex
           let msg = typeof message == 'object' ? JSON.stringify(message, null, 2) : message
-          logger.error(msg)
+          logger.error(msg, ex)
           reject(ex)
         })
       })

package/server/engine/connector/sqlite-connector.ts

@@ -6,11 +6,10 @@ import { ConnectionManager } from '../connection-manager'
 import { Connector } from '../types'
 import { InputConnection } from '../../service/connection/connection-type'
 
-
 try {
   var sqlite3 = require('sqlite3').verbose()
 } catch (err) {
-  logger.error('sqlite3 module loading failed')
+  logger.error('sqlite3 module loading failed', err)
 }
 
 export class SqliteConnector implements Connector {
@@ -29,9 +28,7 @@ export class SqliteConnector implements Connector {
 
     var database = new sqlite3.Database(endpoint, sqlite3.OPEN_READWRITE, err => {
       if (err) {
-        ConnectionManager.logger.error(
-          `SQLite Database(${connection.name}) at ${endpoint} not connected.\ncause: ${err}`
-        )
+        ConnectionManager.logger.error(`SQLite Database(${connection.name}) at ${endpoint} not connected.`, err)
         return
       }
 

package/server/engine/task/database-query.ts

@@ -1,8 +1,8 @@
-import { VM } from 'vm2'
 import { ConnectionManager } from '../connection-manager'
 import { TaskRegistry } from '../task-registry'
 import { InputStep } from '../../service/step/step-type'
 import { Context } from '../types'
+import 'ses'
 
 async function DatabaseQuery(step: InputStep, context: Context) {
   var { domain, user, data, variables, lng } = context
@@ -13,18 +13,23 @@ async function DatabaseQuery(step: InputStep, context: Context) {
 
   var dbconnection = ConnectionManager.getConnectionInstanceByName(domain, connectionName)
 
-  const vm = new VM({
-    sandbox: {
-      domain,
-      user,
-      lng,
-      data,
-      variables
-    }
+  const compartment = new Compartment({
+    domain,
+    user,
+    lng,
+    data,
+    variables,
+    console
   })
 
-  query = vm.run('`' + query + '`')
-  var queryResult = await dbconnection.query(query, [])
+  let evalQuery
+  try {
+    evalQuery = compartment.evaluate('`' + query + '`')
+  } catch (err) {
+    throw new Error(`Failed to evaluate query: ${err.message}`)
+  }
+
+  var queryResult = await dbconnection.query(evalQuery, [])
 
   return {
     data: queryResult

package/server/engine/task/graphql-mutate.ts

@@ -1,8 +1,7 @@
 import gql from 'graphql-tag'
-import { VM } from 'vm2'
+import 'ses'
 
 import { access } from '@things-factory/utils'
-
 import { ConnectionManager } from '../connection-manager'
 import { TaskRegistry } from '../task-registry'
 import { InputStep } from '../../service/step/step-type'
@@ -14,17 +13,21 @@ async function GraphqlMutate(step: InputStep, context: Context) {
 
   var { domain, user, data, variables, lng } = context
 
-  const vm = new VM({
-    sandbox: {
-      domain,
-      user,
-      lng,
-      data,
-      variables
-    }
+  const compartment = new Compartment({
+    domain,
+    user,
+    lng,
+    data,
+    variables,
+    console
   })
 
-  mutation = vm.run('`' + mutation + '`')
+  let evalMutation
+  try {
+    evalMutation = compartment.evaluate('`' + mutation + '`')
+  } catch (err) {
+    throw new Error(`Failed to evaluate mutation: ${err.message}`)
+  }
 
   var client = ConnectionManager.getConnectionInstanceByName(context.domain, connectionName)
 
@@ -36,7 +39,7 @@ async function GraphqlMutate(step: InputStep, context: Context) {
 
   var { data: mutateResult } = await client.mutate({
     mutation: gql`
-      ${mutation}
+      ${evalMutation}
     `,
     variables: queryVariables,
     headers
@@ -70,6 +73,7 @@ GraphqlMutate.parameterSpec = [
     label: 'headers'
   }
 ]
+
 GraphqlMutate.help = 'integration/task/graphql-mutate'
 
 TaskRegistry.registerTaskHandler('graphql-mutate', GraphqlMutate)

package/server/engine/task/graphql-query.ts

@@ -1,8 +1,7 @@
 import gql from 'graphql-tag'
-import { VM } from 'vm2'
+import 'ses'
 
 import { access } from '@things-factory/utils'
-
 import { ConnectionManager } from '../connection-manager'
 import { TaskRegistry } from '../task-registry'
 import { InputStep } from '../../service/step/step-type'
@@ -13,17 +12,21 @@ async function GraphqlQuery(step: InputStep, context: Context) {
   var { query, variables: variablesAccessorMap, headers } = stepOptions || {}
   var { domain, user, data, variables, lng } = context
 
-  const vm = new VM({
-    sandbox: {
-      domain,
-      user,
-      lng,
-      data,
-      variables
-    }
+  const compartment = new Compartment({
+    domain,
+    user,
+    lng,
+    data,
+    variables,
+    console
   })
 
-  query = vm.run('`' + query + '`')
+  let evalQuery
+  try {
+    evalQuery = compartment.evaluate('`' + query + '`')
+  } catch (err) {
+    throw new Error(`Failed to evaluate query: ${err.message}`)
+  }
 
   var client = ConnectionManager.getConnectionInstanceByName(domain, connectionName)
 
@@ -35,7 +38,7 @@ async function GraphqlQuery(step: InputStep, context: Context) {
 
   var { data: queryResult } = await client.query({
     query: gql`
-      ${query}
+      ${evalQuery}
     `,
     variables: queryVariables,
     headers

package/server/engine/task/http-get.ts

@@ -1,5 +1,5 @@
 import fetch from 'node-fetch'
-import { VM } from 'vm2'
+import 'ses'
 import { URL } from 'url'
 import https from 'https'
 import { TaskRegistry } from '../task-registry'
@@ -19,29 +19,43 @@ async function HttpGet(step: InputStep, { logger, data, domain, user, variables,
 
   var { endpoint, params: connectionParams, authHeaders = {} } = connection
 
-  const vm = new VM({
-    sandbox: {
-      domain,
-      user,
-      lng,
-      data,
-      variables
-    }
+  const compartment = new Compartment({
+    domain,
+    user,
+    lng,
+    data,
+    variables,
+    console
   })
 
-  path = vm.run('`' + path + '`')
+  let evalPath
+  try {
+    evalPath = compartment.evaluate('`' + path + '`')
+  } catch (err) {
+    throw new Error(`Failed to evaluate path: ${err.message}`)
+  }
+
+  path = evalPath
 
   requestHeaders =
     requestHeaders &&
     Object.entries(requestHeaders as { [key: string]: string }).reduce((sum, [key, value]) => {
-      sum[key] = vm.run('`' + value + '`')
+      try {
+        sum[key] = compartment.evaluate('`' + value + '`')
+      } catch (err) {
+        throw new Error(`Failed to evaluate header value: ${err.message}`)
+      }
       return sum
     }, {})
 
   searchParams =
     searchParams &&
     Object.entries(searchParams as { [key: string]: string }).reduce((sum, [key, value]) => {
-      sum[key] = vm.run('`' + value + '`')
+      try {
+        sum[key] = compartment.evaluate('`' + value + '`')
+      } catch (err) {
+        throw new Error(`Failed to evaluate search param value: ${err.message}`)
+      }
       return sum
     }, {})
 

package/server/engine/task/http-post.ts

@@ -1,6 +1,6 @@
 import fetch from 'node-fetch'
 import { URL } from 'url'
-import { VM } from 'vm2'
+import 'ses'
 import { access } from '@things-factory/utils'
 import { TaskRegistry } from '../task-registry'
 import { ConnectionManager } from '../connection-manager'
@@ -20,21 +20,32 @@ async function HttpPost(step: InputStep, { logger, data, domain, user, variables
 
   var { endpoint, params: connectionParams, authHeaders = {} } = connection
 
-  const vm = new VM({
-    sandbox: {
-      domain,
-      user,
-      lng,
-      data,
-      variables
-    }
+  const compartment = new Compartment({
+    domain,
+    user,
+    lng,
+    data,
+    variables,
+    console
   })
 
-  path = vm.run('`' + path + '`')
+  let evalPath
+  try {
+    evalPath = compartment.evaluate('`' + path + '`')
+  } catch (err) {
+    throw new Error(`Failed to evaluate path: ${err.message}`)
+  }
+
+  path = evalPath
+
   requestHeaders =
     requestHeaders &&
     Object.entries(requestHeaders as { [key: string]: string }).reduce((sum, [key, value]) => {
-      sum[key] = vm.run('`' + value + '`')
+      try {
+        sum[key] = compartment.evaluate('`' + value + '`')
+      } catch (err) {
+        throw new Error(`Failed to evaluate header value: ${err.message}`)
+      }
       return sum
     }, {})
 

package/server/engine/task/local-graphql-mutate.ts

@@ -1,5 +1,5 @@
 import gql from 'graphql-tag'
-import { VM } from 'vm2'
+import 'ses'
 
 import { User } from '@things-factory/auth-base'
 import { getRepository } from '@things-factory/shell'
@@ -21,17 +21,23 @@ async function LocalGraphqlMutate(step: InputStep, context: Context) {
       relations: ['domains']
     }))
 
-  const vm = new VM({
-    sandbox: {
-      domain,
-      user,
-      lng,
-      data,
-      variables
-    }
+  const compartment = new Compartment({
+    domain,
+    user,
+    lng,
+    data,
+    variables,
+    console
   })
 
-  mutation = vm.run('`' + mutation + '`')
+  let evalMutation
+  try {
+    evalMutation = compartment.evaluate('`' + mutation + '`')
+  } catch (err) {
+    throw new Error(`Failed to evaluate mutation: ${err.message}`)
+  }
+
+  mutation = evalMutation
 
   const queryVariables = Object.keys(variablesAccessorMap || {}).reduce((variables, key) => {
     const accessor = variablesAccessorMap[key]

package/server/engine/task/local-graphql-query.ts

@@ -1,5 +1,5 @@
 import gql from 'graphql-tag'
-import { VM } from 'vm2'
+import 'ses'
 
 import { User } from '@things-factory/auth-base'
 import { getRepository } from '@things-factory/shell'
@@ -21,17 +21,23 @@ async function LocalGraphqlQuery(step: InputStep, context: Context) {
       relations: ['domains']
     }))
 
-  const vm = new VM({
-    sandbox: {
-      domain,
-      user,
-      lng,
-      data,
-      variables
-    }
+  const compartment = new Compartment({
+    domain,
+    user,
+    lng,
+    data,
+    variables,
+    console
   })
 
-  query = vm.run('`' + query + '`')
+  let evalQuery
+  try {
+    evalQuery = compartment.evaluate('`' + query + '`')
+  } catch (err) {
+    throw new Error(`Failed to evaluate query: ${err.message}`)
+  }
+
+  query = evalQuery
 
   const queryVariables = Object.keys(variablesAccessorMap || {}).reduce((variables, key) => {
     const accessor = variablesAccessorMap[key]