@things-factory/integration-base 7.0.1-beta.14 → 7.0.1-beta.19

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@things-factory/integration-base",
-  "version": "7.0.1-beta.14",
+  "version": "7.0.1-beta.19",
   "main": "dist-server/index.js",
   "browser": "client/index.js",
   "things-factory": true,
@@ -27,12 +27,13 @@
   "dependencies": {
     "@apollo/client": "^3.6.9",
     "@operato/moment-timezone-es": "^2.0.0-beta.0",
-    "@things-factory/api": "^7.0.1-beta.14",
-    "@things-factory/auth-base": "^7.0.1-beta.14",
-    "@things-factory/env": "^7.0.1-beta.6",
-    "@things-factory/oauth2-client": "^7.0.1-beta.14",
-    "@things-factory/scheduler-client": "^7.0.1-beta.14",
-    "@things-factory/shell": "^7.0.1-beta.14",
+    "@things-factory/api": "^7.0.1-beta.18",
+    "@things-factory/auth-base": "^7.0.1-beta.18",
+    "@things-factory/cache-service": "^7.0.1-beta.19",
+    "@things-factory/env": "^7.0.1-beta.18",
+    "@things-factory/oauth2-client": "^7.0.1-beta.18",
+    "@things-factory/scheduler-client": "^7.0.1-beta.18",
+    "@things-factory/shell": "^7.0.1-beta.18",
     "@things-factory/utils": "^7.0.1-beta.10",
     "async-mqtt": "^2.5.0",
     "chance": "^1.1.11",
@@ -43,5 +44,5 @@
     "readline": "^1.3.0",
     "vm2": "^3.9.11"
   },
-  "gitHead": "f98cf5cb94295657c43465d39cf55162f5566c59"
+  "gitHead": "bc939e291a4489432fb0fa0707e9c7594517ce94"
 }

package/server/controllers/scenario-controller.ts

@@ -1,14 +1,22 @@
 import { getRepository, Domain, GraphqlLocalClient } from '@things-factory/shell'
-import { PrivilegeObject, checkPermission } from '@things-factory/auth-base'
+import { PrivilegeObject, User, checkPermission } from '@things-factory/auth-base'
+import { cacheService } from '@things-factory/cache-service'
 
 import { ScenarioEngine } from '../engine/scenario-engine'
 import { Scenario } from '../service/scenario/scenario'
-import { ScenarioInstance } from '../service/scenario-instance/scenario-instance-type'
+import {
+  ScenarioInstance,
+  ScenarioInstanceRunResult,
+  ScenarioInstanceStatus
+} from '../service/scenario-instance/scenario-instance-type'
 import { Step } from '../service/step/step-type'
 
 const debug = require('debug')('things-factory:integration-base:controller:run-scenario')
 
-async function findScenario(scenarioName: string, domain: Domain): Promise<{ name: string; steps: Step[]; domain: Domain; privilege?: PrivilegeObject }> {
+async function findScenario(
+  scenarioName: string,
+  domain: Domain
+): Promise<{ id: string; name: string; steps: Step[]; domain: Domain; privilege?: PrivilegeObject; ttl?: number }> {
   var repository = getRepository(Scenario)
 
   var scenario = await repository.findOne({
@@ -26,7 +34,12 @@ async function findScenario(scenarioName: string, domain: Domain): Promise<{ nam
   return scenario as any
 }
 
-export async function runScenario(instanceName: string, scenarioName: string, variables: any, context: ResolverContext): Promise<ScenarioInstance> {
+export async function runScenario(
+  instanceName: string,
+  scenarioName: string,
+  variables: any,
+  context: ResolverContext
+): Promise<ScenarioInstanceRunResult> {
   const { domain, user, lng, unsafeIP, prohibitedPrivileges } = context.state
 
   debug('runScenario', scenarioName, instanceName, variables)
@@ -44,11 +57,22 @@ export async function runScenario(instanceName: string, scenarioName: string, va
   if (!(await checkPermission(scenario.privilege, user, domain, unsafeIP, prohibitedPrivileges))) {
     const { category, privilege } = scenario.privilege || {}
 
-    console.error(`Unauthorized! ${category && privilege ? category + ':' + privilege + ' privilege' : 'ownership granted'} required`)
+    console.error(
+      `Unauthorized! ${category && privilege ? category + ':' + privilege + ' privilege' : 'ownership granted'} required`
+    )
+
+    throw new Error(
+      context.t('error.scenario run unauthorized', {
+        scenario: scenarioName
+      })
+    )
+  }
 
-    throw new Error(context.t('error.scenario run unauthorized', {
-      scenario: scenarioName
-    }))
+  if (scenario.ttl > 0) {
+    const cachedValue = await cacheService.getFromCache(scenario.id, variables || {})
+    if (cachedValue) {
+      return cachedValue.value
+    }
   }
 
   /* 시나리오 인스턴스를 생성한다. */
@@ -62,19 +86,24 @@ export async function runScenario(instanceName: string, scenarioName: string, va
   })
 
   try {
-    await instance.run()
-  } catch(err) {
+    return await instance.run()
+  } catch (err) {
     console.error(err)
 
-    throw new Error(context.t('error.scenario run error', {
-      scenario: scenarioName
-    }))
+    throw new Error(
+      context.t('error.scenario run error', {
+        scenario: scenarioName
+      })
+    )
   }
-
-  return instance
 }
 
-export async function startScenario(instanceName: string, scenarioName: string, variables: any, context: ResolverContext): Promise<ScenarioInstance> {
+export async function startScenario(
+  instanceName: string,
+  scenarioName: string,
+  variables: any,
+  context: ResolverContext
+): Promise<ScenarioInstance> {
   const { domain, user, lng, unsafeIP, prohibitedPrivileges } = context.state
 
   debug('startScenario', instanceName, scenarioName, variables)
@@ -91,14 +120,19 @@ export async function startScenario(instanceName: string, scenarioName: string,
 
   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`
+    )
   }
 
   instanceName = instanceName || scenarioName
   return await ScenarioEngine.load(instanceName, scenario, { domain, user, lng, variables })
 }
 
-export async function stopScenario(instanceName: string, context: ResolverContext): Promise<ScenarioInstance | undefined> {
+export async function stopScenario(
+  instanceName: string,
+  context: ResolverContext
+): Promise<ScenarioInstance | undefined> {
   const { domain, user, unsafeIP, prohibitedPrivileges } = context.state
 
   debug('stopScenario', instanceName)
@@ -120,7 +154,9 @@ export async function stopScenario(instanceName: string, context: ResolverContex
 
   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`
+    )
   }
 
   await ScenarioEngine.unload(domain, instanceName)

package/server/engine/types.ts

@@ -1,4 +1,4 @@
-import { Connection, PropertySpec, ScenarioInstanceStatus, Step } from '../service'
+import { Connection, PropertySpec, ScenarioInstance, ScenarioInstanceStatus, Step } from '../service'
 import { Domain } from '@things-factory/shell'
 import { User } from '@things-factory/auth-base'
 
@@ -76,7 +76,7 @@ export type Context = {
   /**
    * Root object, can be used for various purposes.
    */
-  root: Object
+  root?: ScenarioInstance
 
   /**
    * Array of function closures.

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

@@ -21,7 +21,6 @@ router.post('/unstable/run-scenario/:scenarioName', async (context, next) => {
         runScenario(instanceName: $instanceName, scenarioName: $scenarioName, variables: $variables) {
           instanceName
           scenarioName
-          state
           data
           result
           message

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

@@ -19,12 +19,17 @@ export class ConnectionQuery {
 
     return {
       ...connection,
-      state: ConnectionManager.getConnectionInstance(connection) ? ConnectionStatus.CONNECTED : ConnectionStatus.DISCONNECTED
+      state: ConnectionManager.getConnectionInstance(connection)
+        ? ConnectionStatus.CONNECTED
+        : ConnectionStatus.DISCONNECTED
     } as Connection
   }
 
   @Query(returns => ConnectionList, { description: 'To fetch multiple connections' })
-  async connections(@Args() params: ListParam, @Ctx() context: ResolverContext): Promise<ConnectionList> {
+  async connections(
+    @Args(type => ListParam) params: ListParam,
+    @Ctx() context: ResolverContext
+  ): Promise<ConnectionList> {
     const { domain } = context.state
 
     const queryBuilder = getQueryBuilderFromListParams({
@@ -38,7 +43,9 @@ 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 }
@@ -63,7 +70,9 @@ export class ConnectionQuery {
 
   @FieldResolver(type => Domain)
   async domain(@Root() connection: Connection) {
-    return connection.domain || (connection.domainId && (await getRepository(Domain).findOneBy({ id: connection.domainId })))
+    return (
+      connection.domain || (connection.domainId && (await getRepository(Domain).findOneBy({ id: connection.domainId })))
+    )
   }
 
   @FieldResolver(type => User)

package/server/service/payload-log/payload-log-query.ts

@@ -18,7 +18,10 @@ export class PayloadLogQuery {
   }
 
   @Query(returns => PayloadLogList, { description: 'To fetch multiple PayloadLogs' })
-  async payloadLogs(@Args() params: ListParam, @Ctx() context: ResolverContext): Promise<PayloadLogList> {
+  async payloadLogs(
+    @Args(type => ListParam) params: ListParam,
+    @Ctx() context: ResolverContext
+  ): Promise<PayloadLogList> {
     const { domain } = context.state
 
     const convertedParams = convertListParams(params, {

package/server/service/payload-log/payload-log.ts

@@ -81,14 +81,14 @@ export class PayloadLog {
   updatedAt?: Date
 
   @ManyToOne(type => User, { nullable: true })
-  @Field({ nullable: true })
+  @Field(type => User, { nullable: true })
   creator?: User
 
   @RelationId((payloadLog: PayloadLog) => payloadLog.creator)
   creatorId?: string
 
   @ManyToOne(type => User, { nullable: true })
-  @Field({ nullable: true })
+  @Field(type => User, { nullable: true })
   updater?: User
 
   @RelationId((payloadLog: PayloadLog) => payloadLog.updater)

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

@@ -26,7 +26,7 @@ export class ScenarioQuery {
 
   @Directive('@privilege(category: "scenario", privilege: "query", domainOwnerGranted: true)')
   @Query(returns => ScenarioList, { description: 'To fetch multiple scenarios' })
-  async scenarios(@Args() params: ListParam, @Ctx() context: ResolverContext): Promise<ScenarioList> {
+  async scenarios(@Args(type => ListParam) params: ListParam, @Ctx() context: ResolverContext): Promise<ScenarioList> {
     const { domain } = context.state
 
     const queryBuilder = getQueryBuilderFromListParams({

package/server/service/scenario/scenario-type.ts

@@ -22,6 +22,9 @@ export class NewScenario {
   @Field({ nullable: true })
   timezone?: string
 
+  @Field({ nullable: true })
+  ttl?: number
+
   @Field({ nullable: true })
   active?: boolean
 
@@ -49,6 +52,9 @@ export class ScenarioPatch {
   @Field({ nullable: true })
   timezone?: string
 
+  @Field({ nullable: true })
+  ttl?: number
+
   @Field({ nullable: true })
   active?: boolean
 

package/server/service/scenario/scenario.ts

@@ -64,6 +64,10 @@ export class Scenario {
   @Field({ nullable: true })
   timezone?: string
 
+  @Column({ nullable: true })
+  @Field({ nullable: true })
+  ttl?: number
+
   @OneToMany(type => Step, step => step.scenario)
   @Field(type => [Step], { nullable: true })
   steps?: Step[]
@@ -81,14 +85,14 @@ export class Scenario {
   updatedAt?: Date
 
   @ManyToOne(type => User, { nullable: true })
-  @Field({ nullable: true })
+  @Field(type => User, { nullable: true })
   creator?: User
 
   @RelationId((scenario: Scenario) => scenario.creator)
   creatorId?: string
 
   @ManyToOne(type => User, { nullable: true })
-  @Field({ nullable: true })
+  @Field(type => User, { nullable: true })
   updater?: User
 
   @RelationId((scenario: Scenario) => scenario.updater)

package/server/service/scenario-instance/scenario-instance-mutation.ts

@@ -2,7 +2,7 @@ import { Arg, Ctx, Mutation, Resolver } from 'type-graphql'
 
 import { ScalarObject } from '@things-factory/shell'
 
-import { ScenarioInstance } from './scenario-instance-type'
+import { ScenarioInstance, ScenarioInstanceRunResult } from './scenario-instance-type'
 
 import {
   runScenario as controllerRunScenario,
@@ -12,7 +12,7 @@ import {
 
 @Resolver(ScenarioInstance)
 export class ScenarioInstanceMutation {
-  @Mutation(returns => ScenarioInstance, {
+  @Mutation(returns => ScenarioInstanceRunResult, {
     description: 'To run new scenario instance and will return the result after the scenario stop.'
   })
   async runScenario(
@@ -20,7 +20,7 @@ export class ScenarioInstanceMutation {
     @Arg('scenarioName') scenarioName: string,
     @Arg('variables', type => ScalarObject, { nullable: true }) variables: any,
     @Ctx() context: ResolverContext
-  ): Promise<ScenarioInstance> {
+  ): Promise<ScenarioInstanceRunResult> {
     return await controllerRunScenario(instanceName, scenarioName, variables, context)
   }
 
@@ -35,7 +35,10 @@ export class ScenarioInstanceMutation {
   }
 
   @Mutation(returns => ScenarioInstance, { nullable: true, description: 'To start new scenario instance' })
-  async stopScenario(@Arg('instanceName', { nullable: true }) instanceName: string, @Ctx() context: ResolverContext): Promise<ScenarioInstance | undefined> {
+  async stopScenario(
+    @Arg('instanceName', { nullable: true }) instanceName: string,
+    @Ctx() context: ResolverContext
+  ): Promise<ScenarioInstance | undefined> {
     return await controllerStopScenario(instanceName, context)
   }
 }

package/server/service/scenario-instance/scenario-instance-query.ts

@@ -23,7 +23,10 @@ export class ScenarioInstanceQuery {
   }
 
   @Query(returns => ScenarioInstanceList, { description: 'To fetch multiple scenario instances' })
-  async scenarioInstances(@Args() params: ListParam, @Ctx() context: ResolverContext): Promise<ScenarioInstanceList> {
+  async scenarioInstances(
+    @Args(type => ListParam) params: ListParam,
+    @Ctx() context: ResolverContext
+  ): Promise<ScenarioInstanceList> {
     const { domain } = context.state
 
     var scenarioInstances = ScenarioEngine.getScenarioInstances(domain)
@@ -36,33 +39,4 @@ export class ScenarioInstanceQuery {
       total: items.length
     }
   }
-
-  @FieldResolver(type => ScenarioInstance)
-  async root(@Root() scenarioInstance: ScenarioInstance): Promise<ScenarioInstance> {
-    return scenarioInstance.context?.root as ScenarioInstance
-  }
-
-  @FieldResolver(type => ScenarioInstanceStatus)
-  async state(@Root() scenarioInstance: ScenarioInstance): Promise<ScenarioInstanceStatus> {
-    return scenarioInstance.context?.state
-  }
-
-  @FieldResolver(type => ScenarioInstanceProgress)
-  progress(@Root() scenarioInstance: ScenarioInstance): ScenarioInstanceProgress {
-    return scenarioInstance.calcProgress()
-  }
-  @FieldResolver(type => ScalarObject)
-  async variables(@Root() scenarioInstance: ScenarioInstance): Promise<Object> {
-    return scenarioInstance.context?.variables
-  }
-
-  @FieldResolver(type => ScalarObject)
-  async data(@Root() scenarioInstance: ScenarioInstance): Promise<Object> {
-    return scenarioInstance.context?.data
-  }
-
-  @FieldResolver()
-  async timestamp(@Root() scenarioInstance: ScenarioInstance): Promise<Date> {
-    return new Date()
-  }
 }

package/server/service/scenario-instance/scenario-instance-type.ts

@@ -7,6 +7,7 @@ import util from 'util'
 import { createLogger, format, transports } from 'winston'
 
 import { Domain, pubsub, PubSubLogTransport, ScalarObject } from '@things-factory/shell'
+import { cacheService } from '@things-factory/cache-service'
 import { User } from '@things-factory/auth-base'
 import { sleep } from '@things-factory/utils'
 
@@ -87,6 +88,33 @@ export class ScenarioInstanceState {
   public timestamp: Date
 }
 
+@ObjectType()
+export class ScenarioInstanceRunResult {
+  @Field({ nullable: true })
+  public scenarioName: string
+
+  @Field({ nullable: true })
+  public instanceName: string
+
+  @Field(type => ScalarObject, { nullable: true })
+  public variables: any
+
+  @Field(type => ScalarObject, { nullable: true })
+  public data: any
+
+  @Field(type => ScalarObject, { nullable: true })
+  public result: any
+
+  @Field({ nullable: true })
+  public timestamp: Date
+
+  @Field({ nullable: true })
+  public message: string
+
+  @Field({ nullable: true })
+  public state: ScenarioInstanceStatus
+}
+
 @ObjectType()
 export class ScenarioInstance {
   private subScenarioInstances: ScenarioInstance[] = [] // TODO Imple by WeakSet
@@ -106,29 +134,43 @@ export class ScenarioInstance {
   public instanceName: string
 
   @Field({ nullable: true })
-  root: ScenarioInstance
+  get root(): ScenarioInstance {
+    return this.context?.root
+  }
 
   @Field({ nullable: true })
-  state: ScenarioInstanceStatus
+  get state(): ScenarioInstanceStatus {
+    return this.context?.state
+  }
 
   @Field(type => ScenarioInstanceProgress, { nullable: true })
-  progress: ScenarioInstanceProgress
+  get progress(): ScenarioInstanceProgress {
+    return this.calcProgress()
+  }
 
   @Field(type => ScalarObject, { nullable: true })
-  variables: any
+  get variables(): any {
+    return this.context?.variables
+  }
 
   @Field(type => ScalarObject, { nullable: true })
-  data: any
+  get data(): any {
+    return this.context?.data
+  }
 
   @Field(type => ScalarObject, { nullable: true })
   result: any
 
   @Field({ nullable: true })
-  timestamp: Date
+  get timestamp(): Date {
+    return new Date()
+  }
 
   @Field({ nullable: true })
   public message: string
 
+  private scenarioId: string
+  private scenarioTtl: number
   private steps: Step[]
   private rounds: number = 0
 
@@ -154,10 +196,22 @@ export class ScenarioInstance {
     }
   }
 
-  constructor(instanceName, { name: scenarioName, steps, domain: scenarioDomain }, context?) {
+  constructor(
+    instanceName,
+    {
+      id: scenarioId,
+      ttl: scenarioTtl,
+      name: scenarioName,
+      steps,
+      domain: scenarioDomain
+    }: { id: string; ttl?: number; name: string; steps: Step[]; domain: Domain },
+    context?
+  ) {
     var { domain, user, lng, unsafeIP, prohibitedPrivileges } = context || {}
     domain ||= scenarioDomain
 
+    this.scenarioId = scenarioId
+    this.scenarioTtl = scenarioTtl
     this.instanceName = instanceName
     this.scenarioName = scenarioName
     this.steps = orderBy(steps || [], step => step.sequence)
@@ -269,7 +323,10 @@ export class ScenarioInstance {
       this.context.logger.error(ex.message ? ex.message : ex)
 
       debug('failed to run ', `[ Domain: ${domain.name}, Scenario: ${scenarioName} ]\n`, ex)
-      this.setState(ScenarioInstanceStatus.HALTED, typeof message == 'object' ? JSON.stringify(message, null, 2) : message)
+      this.setState(
+        ScenarioInstanceStatus.HALTED,
+        typeof message == 'object' ? JSON.stringify(message, null, 2) : message
+      )
 
       throw ex
     }
@@ -280,6 +337,26 @@ export class ScenarioInstance {
         sum[step.name] = this.context.data[step.name]
         return sum
       }, {})
+
+    const { scenarioId, scenarioTtl, variables, message, scenarioName, instanceName, result } = this
+    const obj = {
+      scenarioName,
+      instanceName,
+      variables,
+      data: this.data,
+      result,
+      timestamp: new Date(),
+      message,
+      state: ScenarioInstanceStatus.STOPPED /* redundent, no meaning */
+    }
+
+    if (this.scenarioTtl && this.scenarioId) {
+      setTimeout(() => {
+        cacheService.setInCache(scenarioId, variables || {}, obj, scenarioTtl)
+      })
+    }
+
+    return obj
   }
 
   async loadSubscenario(step, scenarioConfig, context) {
@@ -442,7 +519,8 @@ export class ScenarioInstance {
     }
     step.params = step.params || {}
 
-    const connection = step.connection && ConnectionManager.getConnectionInstanceEntityByName(this.domain, step.connection)
+    const connection =
+      step.connection && ConnectionManager.getConnectionInstanceEntityByName(this.domain, step.connection)
 
     if (!connection || !connection.edgeId) {
       var handler = TaskRegistry.getTaskHandler(step.task)

package/server/service/state-register/state-register-query.ts

@@ -28,7 +28,10 @@ export class StateRegisterQuery {
 
   @Directive('@privilege(category: "state-register", privilege: "query", domainOwnerGranted: true)')
   @Query(returns => StateRegisterList, { description: 'To fetch multiple StateRegisters' })
-  async stateRegisters(@Args() params: ListParam, @Ctx() context: ResolverContext): Promise<StateRegisterList> {
+  async stateRegisters(
+    @Args(type => ListParam) params: ListParam,
+    @Ctx() context: ResolverContext
+  ): Promise<StateRegisterList> {
     const { domain } = context.state
 
     const queryBuilder = getQueryBuilderFromListParams({

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

@@ -18,7 +18,7 @@ export class StepQuery {
   }
 
   @Query(returns => StepList, { description: 'To fetch multiple steps' })
-  async steps(@Args() params: ListParam, @Ctx() context: ResolverContext): Promise<StepList> {
+  async steps(@Args(type => ListParam) params: ListParam, @Ctx() context: ResolverContext): Promise<StepList> {
     const { domain } = context.state
 
     const queryBuilder = getQueryBuilderFromListParams({

package/server/service/step/step-type.ts

@@ -137,7 +137,7 @@ export class Step {
    * The user who created this step.
    */
   @ManyToOne(type => User, { nullable: true })
-  @Field({ nullable: true })
+  @Field(type => User, { nullable: true })
   creator?: User
 
   /**
@@ -150,7 +150,7 @@ export class Step {
    * The user who last updated this step.
    */
   @ManyToOne(type => User, { nullable: true })
-  @Field({ nullable: true })
+  @Field(type => User, { nullable: true })
   updater?: User
 
   /**