@things-factory/integration-base 7.0.0-alpha.0 → 7.0.0-alpha.18

package/server/engine/task/socket-listener.ts

@@ -1,6 +1,8 @@
 import { sleep } from '@things-factory/utils'
 import { TaskRegistry } from '../task-registry'
 import { ConnectionManager } from '../connection-manager'
+import { InputStep } from '../../service/step/step-type'
+import { Context } from '../types'
 
 function convertDataFormat(data, format) {
   try {
@@ -16,7 +18,7 @@ function convertDataFormat(data, format) {
   return data
 }
 
-async function SocketListener(step, context) {
+async function SocketListener(step: InputStep, context: Context) {
   //get connection data
   const {
     connection: connectionName,

package/server/engine/task/state-read.ts

@@ -1,7 +1,9 @@
 import gql from 'graphql-tag'
 import { TaskRegistry } from '../task-registry'
+import { InputStep } from '../../service/step/step-type'
+import { Context } from '../types'
 
-async function StateRead(step, { logger, publish, data, domain, user, client }) {
+async function StateRead(step: InputStep, { logger, publish, data, domain, user, client }: Context) {
   var {
     params: { name }
   } = step

package/server/engine/task/state-write.ts

@@ -1,8 +1,10 @@
 import gql from 'graphql-tag'
 import { access } from '@things-factory/utils'
 import { TaskRegistry } from '../task-registry'
+import { InputStep } from '../../service/step/step-type'
+import { Context } from '../types'
 
-async function StateWrite(step, { logger, publish, data, domain, user, client }) {
+async function StateWrite(step: InputStep, { logger, publish, data, domain, user, client }: Context) {
   var {
     params: { name, accessor }
   } = step

package/server/engine/task/stop-scenario.ts

@@ -3,8 +3,10 @@ import { getRepository } from '@things-factory/shell'
 import { Scenario } from '../../service/scenario/scenario'
 import { ScenarioEngine } from '../../engine'
 import { TaskRegistry } from '../task-registry'
+import { InputStep } from '../../service/step/step-type'
+import { Context } from '../types'
 
-async function StopScenario(step, context) {
+async function StopScenario(step: InputStep, context: Context) {
   var { logger, domain } = context
   var {
     params: { scenario }

package/server/engine/task/sub-scenario.ts

@@ -3,8 +3,10 @@ import { access, deepClone } from '@things-factory/utils'
 
 import { Scenario } from '../../service/scenario/scenario'
 import { TaskRegistry } from '../task-registry'
+import { InputStep } from '../../service/step/step-type'
+import { Context } from '../types'
 
-async function SubScenario(step, context) {
+async function SubScenario(step: InputStep, context: Context) {
   var { logger, load, data } = context
   var {
     params: { scenario, variables }

package/server/engine/task/switch-goto.ts

@@ -2,7 +2,10 @@ import { access } from '@things-factory/utils'
 
 import { TaskRegistry } from '../task-registry'
 
-async function SwitchGoTo(step, { logger, data }) {
+import { InputStep } from '../../service/step/step-type'
+import { Context } from '../types'
+
+async function SwitchGoTo(step: InputStep, { logger, data }: Context) {
   var {
     params: { accessor, cases }
   } = step

package/server/engine/task/switch-range-goto.ts

@@ -1,8 +1,10 @@
 import { access } from '@things-factory/utils'
 
 import { TaskRegistry } from '../task-registry'
+import { InputStep } from '../../service/step/step-type'
+import { Context } from '../types'
 
-async function SwitchRangeGoTo(step, { logger, data }) {
+async function SwitchRangeGoTo(step: InputStep, { logger, data }: Context) {
   var {
     params: { accessor, cases }
   } = step

package/server/engine/task/switch-range-scenario.ts

@@ -3,8 +3,10 @@ import { access, deepClone } from '@things-factory/utils'
 
 import { Scenario } from '../../service/scenario/scenario'
 import { TaskRegistry } from '../task-registry'
+import { InputStep } from '../../service/step/step-type'
+import { Context } from '../types'
 
-async function SwitchRangeScenario(step, context) {
+async function SwitchRangeScenario(step: InputStep, context: Context) {
   var { logger, data, load } = context
   var {
     params: { accessor, cases, variables }

package/server/engine/task/switch-range-set.ts

@@ -1,7 +1,9 @@
 import { access } from '@things-factory/utils'
 import { TaskRegistry } from '../task-registry'
+import { InputStep } from '../../service/step/step-type'
+import { Context } from '../types'
 
-async function SwitchRangeSet(step, { logger, data }) {
+async function SwitchRangeSet(step: InputStep, { logger, data }: Context) {
   var {
     params: { accessor, cases }
   } = step

package/server/engine/task/switch-scenario.ts

@@ -3,8 +3,10 @@ import { access, deepClone } from '@things-factory/utils'
 
 import { Scenario } from '../../service/scenario/scenario'
 import { TaskRegistry } from '../task-registry'
+import { InputStep } from '../../service/step/step-type'
+import { Context } from '../types'
 
-async function SwitchScenario(step, context) {
+async function SwitchScenario(step: InputStep, context: Context) {
   var { logger, data, load } = context
   var {
     params: { accessor, cases, variables }

package/server/engine/task/switch-set.ts

@@ -1,7 +1,9 @@
 import { access } from '@things-factory/utils'
 import { TaskRegistry } from '../task-registry'
+import { InputStep } from '../../service/step/step-type'
+import { Context } from '../types'
 
-async function SwitchSet(step, { logger, data }) {
+async function SwitchSet(step: InputStep, { logger, data }: Context) {
   var {
     params: { accessor, cases }
   } = step

package/server/engine/task/throw.ts

@@ -1,6 +1,8 @@
 import { TaskRegistry } from '../task-registry'
+import { InputStep } from '../../service/step/step-type'
+import { Context } from '../types'
 
-async function Throw(step, { logger }) {
+async function Throw(step: InputStep, { logger }: Context) {
   var {
     name,
     params: { message }

package/server/engine/task/utils/headless-pool-for-scenario.ts

@@ -55,7 +55,7 @@ async function initializeChromium() {
 
     var launchSetting = {
       args: ['--mute-audio', '--no-sandbox'],
-      headless: 'new'
+      headless: 'shell'
     }
 
     if (CHROMIUM_PATH) {

package/server/engine/task/variables.ts

@@ -1,6 +1,8 @@
 import { TaskRegistry } from '../task-registry'
+import { InputStep } from '../../service/step/step-type'
+import { Context } from '../types'
 
-async function Variables(step, { variables }) {
+async function Variables(step: InputStep, { variables }: Context) {
   return {
     data: variables instanceof Array ? [...variables] : typeof variables == 'object' ? { ...variables } : variables
   }

package/server/engine/types.ts

@@ -1,4 +1,6 @@
 import { Connection, PropertySpec, ScenarioInstanceStatus, Step } from '../service'
+import { Domain } from '@things-factory/shell'
+import { User } from '@things-factory/auth-base'
 
 export interface Connector {
   ready(connections: Connection[]): Promise<any>
@@ -11,21 +13,95 @@ export interface Connector {
 }
 
 export type Context = {
-  domain: Object
-  user: Object
+  /**
+   * Represents the domain context.
+   */
+  domain: Domain
+
+  /**
+   * User information.
+   */
+  user: User
+
+  /**
+   * Language code, for example 'en', 'ko'.
+   */
   lng: string
+
+  /**
+   * Flag to indicate if the IP is unsafe, can be undefined.
+   */
   unsafeIP: boolean | undefined
+
+  /**
+   * List of prohibited privileges, can be undefined.
+   */
   prohibitedPrivileges: { category: string; privilege: string }[] | undefined
+
+  /**
+   * Logger for logging purposes.
+   */
   logger: any
+
+  /**
+   * Function to publish events or messages.
+   */
   publish: Function
+
+  /**
+   * Function to load resources or data.
+   */
   load: Function
+
+  /**
+   * Current status of the scenario instance.
+   */
   state: ScenarioInstanceStatus
-  data: Object
+
+  /**
+   * General data storage object.
+   */
+  data: any
+
+  /**
+   * Variables related to the context.
+   */
   variables: Object
-  client: Object /* graphql local client */
+
+  /**
+   * Local GraphQL client object.
+   */
+  client: any /* graphql local client */
+
+  /**
+   * Root object, can be used for various purposes.
+   */
   root: Object
+
+  /**
+   * Array of function closures.
+   */
   closures: Function[]
+
+  /**
+   * Function to check the state.
+   */
   checkState: Function
+
+  /**
+   * MQTT subscriber context object.
+   */
+  __mqtt_subscriber?: any
+
+  /**
+   * socket listener context object.
+   */
+  __socket_listener?: any
+
+  /**
+   * csv readline context object.
+   */
+  __csv_resources?: any
 }
 
 export type TaskHandler = (

package/server/index.ts

@@ -1,5 +1,6 @@
 export * from './migrations'
 export * from './engine'
+export * from './controllers'
 export * from './service'
 
 import './routes'

package/server/restful/unstable/run-scenario.ts

@@ -1,7 +1,6 @@
 import gql from 'graphql-tag'
 
 import { restfulApiRouter as router } from '@things-factory/api'
-import { ScenarioInstanceStatus } from '../../service/scenario-instance/scenario-instance-type'
 
 const debug = require('debug')('things-factory:integration-base:restful:unstable:run-scenario')
 

package/server/restful/unstable/start-scenario.ts

@@ -12,7 +12,7 @@ router.post('/unstable/start-scenario/:scenarioName', async (context, next) => {
 
   context.body = await client.mutate({
     mutation: gql`
-      mutation($instanceName: String, $scenarioName: String!, $variables: Object) {
+      mutation ($instanceName: String, $scenarioName: String!, $variables: Object) {
         startScenario(instanceName: $instanceName, scenarioName: $scenarioName, variables: $variables) {
           instanceName
           scenarioName

package/server/restful/unstable/stop-scenario.ts

@@ -11,7 +11,7 @@ router.post('/unstable/stop-scenario/:instanceName', async (context, next) => {
 
   context.body = await client.mutate({
     mutation: gql`
-      mutation($instanceName: String!) {
+      mutation ($instanceName: String!) {
         stopScenario(instanceName: $instanceName) {
           instanceName
           scenarioName

package/server/service/connection/connection-mutation.ts

@@ -10,10 +10,7 @@ import { Connection, ConnectionPatch, ConnectionStatus, NewConnection } from './
 export class ConnectionMutation {
   @Directive('@transaction')
   @Mutation(returns => Connection, { description: 'To create new connection' })
-  async createConnection(
-    @Arg('connection') connection: NewConnection,
-    @Ctx() context: ResolverContext
-  ): Promise<Connection> {
+  async createConnection(@Arg('connection') connection: NewConnection, @Ctx() context: ResolverContext): Promise<Connection> {
     const { domain, user, tx } = context.state
 
     return await tx.getRepository(Connection).save({
@@ -26,11 +23,7 @@ export class ConnectionMutation {
 
   @Directive('@transaction')
   @Mutation(returns => Connection, { description: 'To modify connection information' })
-  async updateConnection(
-    @Arg('name') name: string,
-    @Arg('patch') patch: ConnectionPatch,
-    @Ctx() context: ResolverContext
-  ): Promise<Connection> {
+  async updateConnection(@Arg('name') name: string, @Arg('patch') patch: ConnectionPatch, @Ctx() context: ResolverContext): Promise<Connection> {
     const { domain, user, tx } = context.state
 
     const repository = tx.getRepository(Connection)
@@ -47,10 +40,7 @@ export class ConnectionMutation {
 
   @Directive('@transaction')
   @Mutation(returns => [Connection], { description: "To modify multiple connections' information" })
-  async updateMultipleConnection(
-    @Arg('patches', type => [ConnectionPatch]) patches: ConnectionPatch[],
-    @Ctx() context: ResolverContext
-  ): Promise<Connection[]> {
+  async updateMultipleConnection(@Arg('patches', type => [ConnectionPatch]) patches: ConnectionPatch[], @Ctx() context: ResolverContext): Promise<Connection[]> {
     const { domain, user, tx } = context.state
 
     let results = []
@@ -102,10 +92,7 @@ export class ConnectionMutation {
 
   @Directive('@transaction')
   @Mutation(returns => Boolean, { description: 'To delete multiple connections' })
-  async deleteConnections(
-    @Arg('names', type => [String]) names: string[],
-    @Ctx() context: ResolverContext
-  ): Promise<boolean> {
+  async deleteConnections(@Arg('names', type => [String]) names: string[], @Ctx() context: ResolverContext): Promise<boolean> {
     const { domain, tx } = context.state
 
     await tx.getRepository(Connection).delete({
@@ -122,7 +109,7 @@ export class ConnectionMutation {
     var repository = getRepository(Connection)
     var connection = await repository.findOne({
       where: { domain: { id: domain.id }, name },
-      relations: ['domain']
+      relations: ['domain', 'edge']
     })
 
     await connection.connect()
@@ -130,9 +117,7 @@ export class ConnectionMutation {
 
     return {
       ...connection,
-      state: ConnectionManager.getConnectionInstance(connection)
-        ? ConnectionStatus.CONNECTED
-        : ConnectionStatus.DISCONNECTED
+      state: ConnectionManager.getConnectionInstance(connection) ? ConnectionStatus.CONNECTED : ConnectionStatus.DISCONNECTED
     } as Connection
   }
 
@@ -143,7 +128,7 @@ export class ConnectionMutation {
     var repository = getRepository(Connection)
     var connection = await repository.findOne({
       where: { domain: { id: domain.id }, name },
-      relations: ['domain']
+      relations: ['domain', 'edge']
     })
 
     await connection.disconnect()
@@ -151,19 +136,14 @@ export class ConnectionMutation {
 
     return {
       ...connection,
-      state: ConnectionManager.getConnectionInstance(connection)
-        ? ConnectionStatus.CONNECTED
-        : ConnectionStatus.DISCONNECTED
+      state: ConnectionManager.getConnectionInstance(connection) ? ConnectionStatus.CONNECTED : ConnectionStatus.DISCONNECTED
     }
   }
 
   @Directive('@transaction')
   // @Directive('@privilege(category: "connection", privilege: "mutation", domainOwnerGranted: true)')
   @Mutation(returns => Boolean, { description: 'To import multiple connections' })
-  async importConnections(
-    @Arg('connections', type => [ConnectionPatch]) connections: Connection[],
-    @Ctx() context: ResolverContext
-  ): Promise<boolean> {
+  async importConnections(@Arg('connections', type => [ConnectionPatch]) connections: Connection[], @Ctx() context: ResolverContext): Promise<boolean> {
     const { tx, domain, user } = context.state
 
     const repository = tx.getRepository(Connection)

package/server/service/connection/connection-query.ts

@@ -1,6 +1,6 @@
 import { Arg, Args, Ctx, FieldResolver, Query, Resolver, Root } from 'type-graphql'
 
-import { User } from '@things-factory/auth-base'
+import { Appliance, User } from '@things-factory/auth-base'
 import { Domain, getQueryBuilderFromListParams, getRepository, ListParam } from '@things-factory/shell'
 
 import { ConnectionManager } from '../../engine/connection-manager'
@@ -19,9 +19,7 @@ export class ConnectionQuery {
 
     return {
       ...connection,
-      state: ConnectionManager.getConnectionInstance(connection)
-        ? ConnectionStatus.CONNECTED
-        : ConnectionStatus.DISCONNECTED
+      state: ConnectionManager.getConnectionInstance(connection) ? ConnectionStatus.CONNECTED : ConnectionStatus.DISCONNECTED
     } as Connection
   }
 
@@ -40,9 +38,7 @@ export class ConnectionQuery {
     const [items, total] = await queryBuilder.leftJoinAndSelect('connection.domain', 'domain').getManyAndCount()
 
     items.forEach(connection => {
-      connection['state'] = ConnectionManager.getConnectionInstance(connection)
-        ? ConnectionStatus.CONNECTED
-        : ConnectionStatus.DISCONNECTED
+      connection['state'] = ConnectionManager.getConnectionInstance(connection) ? ConnectionStatus.CONNECTED : ConnectionStatus.DISCONNECTED
     })
 
     return { items, total }
@@ -52,26 +48,31 @@ export class ConnectionQuery {
   fetchConnectionState(@Arg('name') name: string, @Ctx() context: ResolverContext): ConnectionState {
     const { domain } = context.state
 
-    var connection = ConnectionManager.getConnectionInstanceByName(domain, name)
+    const connection = ConnectionManager.getConnectionInstanceEntityByName(domain, name)
 
     return {
-      name,
+      ...connection,
       state: connection ? ConnectionStatus.CONNECTED : ConnectionStatus.DISCONNECTED
     }
   }
 
+  @FieldResolver(type => Domain)
+  async edge(@Root() connection: Connection) {
+    return connection.edgeId && (await getRepository(Appliance).findOneBy({ id: connection.edgeId }))
+  }
+
   @FieldResolver(type => Domain)
   async domain(@Root() connection: Connection) {
-    return connection.domain || (await getRepository(Domain).findOneBy({ id: connection.domainId }))
+    return connection.domain || (connection.domainId && (await getRepository(Domain).findOneBy({ id: connection.domainId })))
   }
 
   @FieldResolver(type => User)
   async updater(@Root() connection: Connection): Promise<User> {
-    return await getRepository(User).findOneBy({ id: connection.updaterId })
+    return connection.updaterId && (await getRepository(User).findOneBy({ id: connection.updaterId }))
   }
 
   @FieldResolver(type => User)
   async creator(@Root() connection: Connection): Promise<User> {
-    return await getRepository(User).findOneBy({ id: connection.creatorId })
+    return connection.creatorId && (await getRepository(User).findOneBy({ id: connection.creatorId }))
   }
 }

package/server/service/connection/connection-subscription.ts

@@ -1,4 +1,4 @@
-import { withFilter } from 'graphql-subscriptions'
+import { filter, pipe } from 'graphql-yoga'
 import { Arg, Resolver, Root, Subscription } from 'type-graphql'
 
 import { getRepository, Log, pubsub } from '@things-factory/shell'
@@ -11,7 +11,7 @@ const debug = require('debug')('things-factory:integration:connection-subscripti
 @Resolver(Connection)
 export class ConnectionSubscription {
   @Subscription({
-    subscribe: (_, args, context, info) => {
+    subscribe: ({ args, context, info }) => {
       const { domain, user } = context.state
       const { name } = args
       const subdomain = domain?.subdomain
@@ -26,49 +26,43 @@ export class ConnectionSubscription {
       }
 
       process.nextTick(async () => {
-        var where = { domain }
+        var where = { domain: { id: domain.id } }
         if (name) {
           where['name'] = name
         }
 
         var connections = await getRepository(Connection).find({
           where,
-          relations: ['domain']
+          relations: ['domain', 'edge']
         })
 
         connections.forEach(connection => {
           pubsub.publish('connection-state', {
             connectionState: {
               ...connection,
-              state: ConnectionManager.getConnectionInstance(connection)
-                ? ConnectionStatus.CONNECTED
-                : ConnectionStatus.DISCONNECTED,
+              state: ConnectionManager.getConnectionInstance(connection) ? ConnectionStatus.CONNECTED : ConnectionStatus.DISCONNECTED,
               timestamp: new Date()
             }
           })
         })
       })
 
-      return withFilter(
-        () => pubsub.asyncIterator('connection-state'),
-        (payload, variables, context, info) => {
+      return pipe(
+        pubsub.subscribe('connection-state'),
+        filter(async (payload: { connectionState: ConnectionState }) => {
           const { domain: pdomain, name: pname } = payload.connectionState
-          const { name } = variables
 
           return (!name || name === pname) && subdomain === pdomain?.subdomain
-        }
-      )(_, args, context, info)
+        })
+      )
     }
   })
-  connectionState(
-    @Root() payload: { connectionState: ConnectionState },
-    @Arg('name', { nullable: true }) name: string
-  ): ConnectionState {
+  connectionState(@Root() payload: { connectionState: ConnectionState }, @Arg('name', { nullable: true }) name: string): ConnectionState {
     return payload.connectionState
   }
 
   @Subscription({
-    subscribe: (_, args, context, info) => {
+    subscribe: ({ args, context, info }) => {
       const { domain, user } = context.state
       const { level } = args
 
@@ -84,11 +78,11 @@ export class ConnectionSubscription {
         throw new Error(`domain(${subdomain}) is not working for user(${user.email}).`)
       }
 
-      return withFilter(
-        () => pubsub.asyncIterator('connection-log'),
-        (payload, variables, context, info) => {
+      return pipe(
+        pubsub.subscribe('connection-log'),
+        filter(async (payload: { log: Log }) => {
           // TODO support domain filtering
-          const { /* source, */ level: plevel } = payload.connectionLog
+          const { /* source, */ level: plevel } = payload.log
           // const { domain: pdomain } = source
 
           // if (subdomain !== pdomain?.subdomain) {
@@ -100,8 +94,8 @@ export class ConnectionSubscription {
           }
 
           return true
-        }
-      )(_, args, context, info)
+        })
+      )
     }
   })
   connectionLog(@Root() payload: { log: Log }, @Arg('level', { nullable: true }) level: string): Log {