@things-factory/integration-base 7.0.0-alpha.4 → 7.0.0-alpha.7

package/openapi/unstable/scenario.yaml

@@ -2,9 +2,9 @@ paths:
   /scenario/{scenarioId}:
     get:
       tags:
-        - 'integration'
-      description: 'Use this call to get information for single integration scenario.'
-      operationId: 'scenario'
+        - integration
+      description: Use this call to get information for single integration scenario.
+      operationId: scenario
       parameters:
         - in: header
           name: x-things-factory-domain
@@ -12,28 +12,28 @@ paths:
             type: string
           required: false
           description: things-factory subdomain name
-        - in: 'path'
-          name: 'scenarioId'
+        - in: path
+          name: scenarioId
           required: true
-          type: 'string'
+          type: string
       responses:
         '200':
-          description: 'OK'
+          description: OK
         '400':
-          description: 'Bad request is sent'
+          description: Bad request is sent
         '401':
-          description: 'Authentication Error'
+          description: Authentication Error
         '404':
-          description: 'Resource not found'
+          description: Resource not found
         '500':
-          description: 'Server error'
+          description: Server error
 
   /scenarios:
     get:
       tags:
-        - 'integration'
-      description: 'Use this API to get a list of integration scenarios.'
-      operationId: 'scenarios'
+        - integration
+      description: Use this API to get a list of integration scenarios.
+      operationId: scenarios
       parameters:
         - in: header
           name: x-things-factory-domain
@@ -41,34 +41,34 @@ paths:
             type: string
           required: false
           description: things-factory subdomain name
-        - in: 'query'
-          name: 'page'
-          description: 'This integer value is used to specify the maximum number of entries to return in a single "page" of data. Max entries per page is 100.'
-          type: 'integer'
-          format: 'uint32'
-        - in: 'query'
-          name: 'offset'
-          description: 'Specifies the starting entry of data to return in the current call. Default is 1. if data is more than one page, the offset can be some entry to start next call.'
-          type: 'integer'
-          format: 'uint32'
+        - in: query
+          name: page
+          description: This integer value is used to specify the maximum number of entries to return in a single "page" of data. Max entries per page is 100.
+          type: integer
+          format: uint32
+        - in: query
+          name: offset
+          description: Specifies the starting entry of data to return in the current call. Default is 1. if data is more than one page, the offset can be some entry to start next call.
+          type: integer
+          format: uint32
       responses:
         '200':
-          description: 'OK'
+          description: OK
         '400':
-          description: 'Bad request is sent'
+          description: Bad request is sent
         '401':
-          description: 'Authentication Error'
+          description: Authentication Error
         '404':
-          description: 'Resource not found'
+          description: Resource not found
         '500':
-          description: 'Server error'
+          description: Server error
 
   /scenario-instance/{instanceName}:
     get:
       tags:
-        - 'integration'
-      description: 'Use this call to get information for single integration scenario instance.'
-      operationId: 'scenarioInstance'
+        - integration
+      description: Use this call to get information for single integration scenario instance.
+      operationId: scenarioInstance
       parameters:
         - in: header
           name: x-things-factory-domain
@@ -76,28 +76,28 @@ paths:
             type: string
           required: false
           description: things-factory subdomain name
-        - in: 'path'
-          name: 'instanceName'
+        - in: path
+          name: instanceName
           required: true
-          type: 'string'
+          type: string
       responses:
         '200':
-          description: 'OK'
+          description: OK
         '400':
-          description: 'Bad request is sent'
+          description: Bad request is sent
         '401':
-          description: 'Authentication Error'
+          description: Authentication Error
         '404':
-          description: 'Resource not found'
+          description: Resource not found
         '500':
-          description: 'Server error'
+          description: Server error
 
   /scenario-instances:
     get:
       tags:
-        - 'integration'
-      description: 'Use this API to get a list of integration scenario instances.'
-      operationId: 'scenarioInstances'
+        - integration
+      description: Use this API to get a list of integration scenario instances.
+      operationId: scenarioInstances
       parameters:
         - in: header
           name: x-things-factory-domain
@@ -105,34 +105,34 @@ paths:
             type: string
           required: false
           description: things-factory subdomain name
-        - in: 'query'
-          name: 'page'
-          description: 'This integer value is used to specify the maximum number of entries to return in a single "page" of data. Max entries per page is 100.'
-          type: 'integer'
-          format: 'uint32'
-        - in: 'query'
-          name: 'offset'
-          description: 'Specifies the starting entry of data to return in the current call. Default is 1. if data is more than one page, the offset can be some entry to start next call.'
-          type: 'integer'
-          format: 'uint32'
+        - in: query
+          name: page
+          description: This integer value is used to specify the maximum number of entries to return in a single "page" of data. Max entries per page is 100.
+          type: integer
+          format: uint32
+        - in: query
+          name: offset
+          description: Specifies the starting entry of data to return in the current call. Default is 1. if data is more than one page, the offset can be some entry to start next call.
+          type: integer
+          format: uint32
       responses:
         '200':
-          description: 'OK'
+          description: OK
         '400':
-          description: 'Bad request is sent'
+          description: Bad request is sent
         '401':
-          description: 'Authentication Error'
+          description: Authentication Error
         '404':
-          description: 'Resource not found'
+          description: Resource not found
         '500':
-          description: 'Server error'
+          description: Server error
 
   /run-scenario/{scenarioName}:
     post:
       tags:
-        - 'integration'
-      description: 'Use this call to run scenario as standalone.'
-      operationId: 'runScenario'
+        - integration
+      description: Use this call to run scenario as standalone.
+      operationId: runScenario
       requestBody:
         content:
           application/json:
@@ -140,11 +140,11 @@ paths:
               type: object
               properties:
                 instanceName:
-                  type: 'string'
-                  description: 'Scenario Instance Name to identify new scenario instance to run'
+                  type: string
+                  description: Scenario Instance Name to identify new scenario instance to run
                 variables:
-                  type: 'object'
-                  description: 'Input parameters for the new scenario instance to run'
+                  type: object
+                  description: Input parameters for the new scenario instance to run
       parameters:
         - in: header
           name: x-things-factory-domain
@@ -152,28 +152,28 @@ paths:
             type: string
           required: false
           description: things-factory subdomain name
-        - in: 'path'
-          name: 'scenarioName'
+        - in: path
+          name: scenarioName
           required: true
-          type: 'string'
+          type: string
       responses:
         '200':
-          description: 'OK'
+          description: OK
         '400':
-          description: 'Bad request is sent'
+          description: Bad request is sent
         '401':
-          description: 'Authentication Error'
+          description: Authentication Error
         '404':
-          description: 'Resource not found'
+          description: Resource not found
         '500':
-          description: 'Server error'
+          description: Server error
 
   /start-scenario/{scenarioName}:
     post:
       tags:
-        - 'integration'
-      description: 'Use this call to start scenario as a given instance name.'
-      operationId: 'startScenario'
+        - integration
+      description: Use this call to start scenario as a given instance name.
+      operationId: startScenario
       requestBody:
         content:
           application/json:
@@ -181,11 +181,11 @@ paths:
               type: object
               properties:
                 instanceName:
-                  type: 'string'
-                  description: 'Scenario Instance Name to identify new scenario instance to start'
+                  type: string
+                  description: Scenario Instance Name to identify new scenario instance to start
                 variables:
-                  type: 'object'
-                  description: 'Input parameters for the new scenario instance to start'
+                  type: object
+                  description: Input parameters for the new scenario instance to start
       parameters:
         - in: header
           name: x-things-factory-domain
@@ -193,28 +193,28 @@ paths:
             type: string
           required: false
           description: things-factory subdomain name
-        - in: 'path'
-          name: 'scenarioName'
+        - in: path
+          name: scenarioName
           required: true
-          type: 'string'
+          type: string
       responses:
         '200':
-          description: 'OK'
+          description: OK
         '400':
-          description: 'Bad request is sent'
+          description: Bad request is sent
         '401':
-          description: 'Authentication Error'
+          description: Authentication Error
         '404':
-          description: 'Resource not found'
+          description: Resource not found
         '500':
-          description: 'Server error'
+          description: Server error
 
   /stop-scenario/{instanceName}:
     post:
       tags:
-        - 'integration'
-      description: 'Use this call to stop scenario running as a given instance name.'
-      operationId: 'stopScenario'
+        - integration
+      description: Use this call to stop scenario running as a given instance name.
+      operationId: stopScenario
       parameters:
         - in: header
           name: x-things-factory-domain
@@ -222,19 +222,19 @@ paths:
             type: string
           required: false
           description: things-factory subdomain name
-        - in: 'path'
-          name: 'instanceName'
+        - in: path
+          name: instanceName
           required: true
-          type: 'string'
-          description: 'scenario instance name to be stopped'
+          type: string
+          description: scenario instance name to be stopped
       responses:
         '200':
-          description: 'OK'
+          description: OK
         '400':
-          description: 'Bad request is sent'
+          description: Bad request is sent
         '401':
-          description: 'Authentication Error'
+          description: Authentication Error
         '404':
-          description: 'Resource not found'
+          description: Resource not found
         '500':
-          description: 'Server error'
+          description: Server error

package/openapi/unstable.yaml

@@ -3,22 +3,22 @@ info:
   description: >
     For the latest release information please check our [release notes](https://developer.myoperato.com/release_notes).
     The Integration API exposes integrations endpoint and related functions.
-  version: 'unstable'
-  title: 'Integration'
-  termsOfService: 'https://myoperato.com/terms/'
+  version: unstable
+  title: Integration
+  termsOfService: https://myoperato.com/terms/
   contact:
-    email: 'heartyoh@hatiolab.com'
+    email: heartyoh@hatiolab.com
   license:
     name: MIT
     url: http://mit-license.org/
 tags:
-  - name: 'integration'
-    description: 'API to integrate with other systems'
+  - name: integration
+    description: API to integrate with other systems
 schemes:
-  - 'https'
-  - 'http'
+  - https
+  - http
 servers:
-  - url: '/api/unstable/'
+  - url: /api/unstable/
 
 components:
   securitySchemes:
@@ -37,5 +37,5 @@ responses:
     description: Unauthorized
 
 externalDocs:
-  description: 'Find out about our release notes'
-  url: 'https://developer.myoperato.com/release_notes'
+  description: Find out about our release notes
+  url: https://developer.myoperato.com/release_notes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@things-factory/integration-base",
-  "version": "7.0.0-alpha.4",
+  "version": "7.0.0-alpha.7",
   "main": "dist-server/index.js",
   "browser": "client/index.js",
   "things-factory": true,
@@ -26,12 +26,12 @@
   },
   "dependencies": {
     "@apollo/client": "^3.6.9",
-    "@things-factory/api": "^7.0.0-alpha.1",
-    "@things-factory/auth-base": "^7.0.0-alpha.1",
+    "@things-factory/api": "^7.0.0-alpha.7",
+    "@things-factory/auth-base": "^7.0.0-alpha.7",
     "@things-factory/env": "^7.0.0-alpha.0",
-    "@things-factory/oauth2-client": "^7.0.0-alpha.1",
-    "@things-factory/scheduler-client": "^7.0.0-alpha.1",
-    "@things-factory/shell": "^7.0.0-alpha.1",
+    "@things-factory/oauth2-client": "^7.0.0-alpha.7",
+    "@things-factory/scheduler-client": "^7.0.0-alpha.7",
+    "@things-factory/shell": "^7.0.0-alpha.7",
     "@things-factory/utils": "^7.0.0-alpha.0",
     "async-mqtt": "^2.5.0",
     "chance": "^1.1.11",
@@ -47,5 +47,5 @@
   "devDependencies": {
     "@types/cron": "^2.0.1"
   },
-  "gitHead": "883a6587ba785dae17e4e3cef2954bd08b3a3e01"
+  "gitHead": "85c46b9027d6188ddbd5104215a2256ff5331c19"
 }

package/server/controllers/index.ts

@@ -0,0 +1 @@
+export * from './scenario-controller'

package/server/controllers/scenario-controller.ts

@@ -0,0 +1,116 @@
+import { getRepository, Domain, GraphqlLocalClient } from '@things-factory/shell'
+import { PrivilegeObject, checkPermission } from '@things-factory/auth-base'
+
+import { ScenarioEngine } from '../engine/scenario-engine'
+import { Scenario } from '../service/scenario/scenario'
+import { ScenarioInstance } 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 }> {
+  var repository = getRepository(Scenario)
+
+  var scenario = await repository.findOne({
+    where: { domain: { id: domain.id }, name: scenarioName },
+    relations: ['domain', 'steps', 'creator', 'updater']
+  })
+
+  if (!scenario && domain.parentId) {
+    scenario = await repository.findOne({
+      where: { domain: { id: domain.parentId }, name: scenarioName },
+      relations: ['domain', 'steps', 'creator', 'updater']
+    })
+  }
+
+  return scenario as any
+}
+
+export async function runScenario(instanceName: string, scenarioName: string, variables: any, context: ResolverContext): Promise<ScenarioInstance> {
+  const { domain, user, lng, unsafeIP, prohibitedPrivileges } = context.state
+
+  debug('runScenario', scenarioName, instanceName, variables)
+
+  var scenario = await findScenario(scenarioName, domain)
+
+  if (!scenario) {
+    throw new Error(
+      context.t('error.scenario not found', {
+        scenario: scenarioName
+      })
+    )
+  }
+
+  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`)
+  }
+
+  /* 시나리오 인스턴스를 생성한다. */
+  instanceName = instanceName || scenarioName + '-' + String(Date.now())
+  var instance = new ScenarioInstance(instanceName, scenario, {
+    domain,
+    user,
+    lng,
+    variables,
+    client: GraphqlLocalClient.client
+  })
+
+  await instance.run()
+
+  return instance
+}
+
+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)
+
+  var scenario = await findScenario(scenarioName, domain)
+
+  if (!scenario) {
+    throw new Error(
+      context.t('error.scenario not found', {
+        scenario: scenarioName
+      })
+    )
+  }
+
+  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`)
+  }
+
+  instanceName = instanceName || scenarioName
+  return await ScenarioEngine.load(instanceName, scenario, { domain, user, lng, variables })
+}
+
+export async function stopScenario(instanceName: string, context: ResolverContext): Promise<ScenarioInstance | undefined> {
+  const { domain, user, unsafeIP, prohibitedPrivileges } = context.state
+
+  debug('stopScenario', instanceName)
+
+  runScenario
+
+  var scenarioInstance = ScenarioEngine.getScenarioInstance(domain, instanceName)
+
+  if (!scenarioInstance) {
+    debug('stopScenario', `ScenarioInstance(${instanceName}) Not Found.`)
+    throw new Error(
+      context.t('error.scenario instance not found', {
+        instance: instanceName
+      })
+    )
+  }
+
+  var scenario = await findScenario(scenarioInstance.scenarioName, domain)
+
+  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`)
+  }
+
+  await ScenarioEngine.unload(domain, instanceName)
+
+  return scenarioInstance
+}