@things-factory/edge-client 7.0.0-alpha.18

package/helps/edge-client/edge-client.md

@@ -0,0 +1,160 @@
+# EdgeClient
+
+Paragraphs are separated by a blank line.
+
+2nd paragraph. _Italic_, **bold**, and `monospace`. Itemized lists
+look like:
+
+- this one
+- that one
+- the other one
+
+Note that --- not considering the asterisk --- the actual text
+content starts at 4-columns in.
+
+> Block quotes are
+> written like so.
+>
+> They can span multiple paragraphs,
+> if you like.
+
+Use 3 dashes for an em-dash. Use 2 dashes for ranges (ex., "it's all
+in chapters 12--14"). Three dots ... will be converted to an ellipsis.
+Unicode is supported. ☺
+
+## An h2 header
+
+Here's a numbered list:
+
+1. first item
+2. second item
+3. third item
+
+Note again how the actual text starts at 4 columns in (4 characters
+from the left side). Here's a code sample:
+
+# Let me re-iterate ...
+
+for i in 1 .. 10 { do-something(i) }
+
+As you probably guessed, indented 4 spaces. By the way, instead of
+indenting the block, you can use delimited blocks, if you like:
+
+```
+define foobar() {
+print "Welcome to flavor country!";
+}
+```
+
+(which makes copying & pasting easier). You can optionally mark the
+delimited block for Pandoc to syntax highlight it:
+
+```python
+import time
+# Quick, count to ten!
+for i in range(10):
+# (but not *too* quick)
+time.sleep(0.5)
+print(i)
+```
+
+### An h3 header
+
+Now a nested list:
+
+1. First, get these ingredients:
+
+- carrots
+- celery
+- lentils
+
+2. Boil some water.
+
+3. Dump everything in the pot and follow
+   this algorithm:
+
+find wooden spoon
+uncover pot
+stir
+cover pot
+balance wooden spoon precariously on pot handle
+wait 10 minutes
+goto first step (or shut off burner when done)
+
+Do not bump wooden spoon or it will fall.
+
+Notice again how text always lines up on 4-space indents (including
+that last line which continues item 3 above).
+
+Here's a link to [a website](http://foo.bar), to a [local
+doc](local-doc.html), and to a [section heading in the current
+doc](#an-h2-header). Here's a footnote [^1].
+
+[^1]: Some footnote text.
+
+Tables can look like this:
+
+Name Size Material Color
+
+---
+
+All Business 9 leather brown
+Roundabout 10 hemp canvas natural
+Cinderella 11 glass transparent
+
+Table: Shoes sizes, materials, and colors.
+
+(The above is the caption for the table.) Pandoc also supports
+multi-line tables:
+
+---
+
+Keyword Text
+
+---
+
+red Sunsets, apples, and
+other red or reddish
+things.
+
+green Leaves, grass, frogs
+and other things it's
+not easy being.
+
+---
+
+A horizontal rule follows.
+
+---
+
+Here's a definition list:
+
+apples
+: Good for making applesauce.
+
+oranges
+: Citrus!
+
+tomatoes
+: There's no "e" in tomatoe.
+
+Again, text is indented 4 spaces. (Put a blank line between each
+term and its definition to spread things out more.)
+
+Here's a "line block" (note how whitespace is honored):
+
+| Line one
+| Line too
+| Line tree
+
+and images can be specified like so:
+
+![example image](example-image.jpg 'An exemplary image')
+
+Inline math equation: $\omega = d\phi / dt$. Display
+math should get its own line like so:
+
+$$I = \int \rho R^{2} dV$$
+
+And note that you can backslash-escape any punctuation characters
+which you wish to be displayed literally, ex.: \`foo\`, \*bar\*, etc.

package/helps/integration/connector/edge-connector.ja.md

@@ -0,0 +1,9 @@
+# エッジコネクタ
+
+シナリオは複数のステップで構成され、各ステップは接続、その接続に基づいて実行されるタスク、およびタスクの実行のためのパラメータによって定義されます。
+
+これらのステップは、接続が設定されたサーバー（エッジサーバー）で実行されますが、特にエッジサーバーに設定されていない接続は、シナリオが定義されたサーバー自体に設定され、関連するシナリオステップも同じサーバーで実行されます。
+
+接続なしでタスクをエッジサーバーで実行したい場合は、ステップの接続としてエッジコネクタを使用できます。
+
+エッジコネクタはこの目的のみに使用され、実際には実装された機能がない、タグ付け専用のコネクタです。

package/helps/integration/connector/edge-connector.ko.md

@@ -0,0 +1,9 @@
+# Edge Connector
+
+시나리오는 여러개의 스텝으로 구성되며, 각 스텝은 커넥션과 해당 커넥션을 기반으로 실행되는 태스크 그리고 태스크 실행을 위한 파라미터들로 정의된다.
+
+그 스텝은 커넥션이 설정된 (에지)서버에서 실행되게 되는데, 특별히 에지서버가 설정되지 않은 커넥션은 시나리오가 정의된 서버 자신에 설정되고 관련된 시나리오 스텝도 동일한 서버에서 실행된다.
+
+그런데, 커넥션이 없이 실행되는 태스크들을 에지서버에서 실행하고자 할 때는 Edge Connector라는 커넥터를 이용해서 그 스텝의 커넥션으로 설정할 수 있도록 한다.
+
+Edge Connector는 이런 목적으로만 사용되기 때문에, 실질적으로 구현된 기능은 없는 태깅 전용 커넥터이다.

package/helps/integration/connector/edge-connector.md

@@ -0,0 +1,9 @@
+# Edge Connector
+
+Scenario consists of multiple steps, each defined by a connection, tasks based on that connection, and parameters for executing the tasks.
+
+These steps are executed on the server where the connection is set (edge server), but connections not specifically set to an edge server will have the scenario defined on the server itself, and related scenario steps will also be executed on the same server.
+
+When you want to execute tasks without a connection on an edge server, you can use the Edge Connector as the step's connection.
+
+The Edge Connector is used only for this purpose and is essentially a tagging-only connector without any implemented features.

package/helps/integration/connector/edge-connector.ms.md

@@ -0,0 +1,9 @@
+# Penyambung Tepi
+
+Skenario terdiri daripada beberapa langkah, setiap langkah didefinisikan oleh sambungan, tugas berdasarkan sambungan tersebut, dan parameter untuk melaksanakan tugas.
+
+Langkah-langkah ini dilaksanakan pada pelayan di mana sambungan ditetapkan (pelayan tepi), tetapi sambungan yang tidak khusus ditetapkan kepada pelayan tepi akan memiliki skenario yang didefinisikan pada pelayan itu sendiri, dan langkah skenario yang berkaitan juga akan dilaksanakan pada pelayan yang sama.
+
+Apabila anda ingin melaksanakan tugas tanpa sambungan pada pelayan tepi, anda boleh menggunakan Penyambung Tepi sebagai sambungan langkah.
+
+Penyambung Tepi hanya digunakan untuk tujuan ini dan pada dasarnya adalah penyambung hanya penandaan tanpa ciri yang dilaksanakan.

package/helps/integration/connector/edge-connector.zh.md

@@ -0,0 +1,9 @@
+# 边缘连接器
+
+场景由多个步骤组成，每个步骤由连接、基于该连接的任务以及执行任务的参数定义。
+
+这些步骤在设置连接的服务器（边缘服务器）上执行，但没有特别设置为边缘服务器的连接将在定义场景的服务器本身上设置，相关的场景步骤也将在同一服务器上执行。
+
+当您想在边缘服务器上执行没有连接的任务时，可以使用边缘连接器作为步骤的连接。
+
+边缘连接器仅用于此目的，本质上是一个没有实现功能的仅标记用途的连接器。

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@things-factory/edge-client",
+  "version": "7.0.0-alpha.18",
+  "main": "dist-server/index.js",
+  "things-factory": true,
+  "license": "MIT",
+  "author": "heartyoh <heartyoh@hatiolab.com>",
+  "description": "edge client module",
+  "publishConfig": {
+    "access": "public",
+    "@things-factory:registry": "https://registry.npmjs.org"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hatiolab/things-factory.git",
+    "directory": "packages/edge-client"
+  },
+  "scripts": {
+    "build": "npm run build:server",
+    "build:server": "npx tsc --p ./server/tsconfig.json",
+    "clean:server": "npx rimraf dist-server",
+    "clean": "npm run clean:server"
+  },
+  "dependencies": {
+    "@things-factory/auth-base": "^7.0.0-alpha.18",
+    "@things-factory/integration-base": "^7.0.0-alpha.18",
+    "@things-factory/lock-client": "^7.0.0-alpha.18",
+    "@things-factory/shell": "^7.0.0-alpha.18"
+  },
+  "gitHead": "f695ce9c0e3a8f2d715d27a2e7674c9b9c6b1ee1"
+}

package/server/controllers/connect-connections.ts

@@ -0,0 +1,6 @@
+import { pubsub } from '@things-factory/shell'
+import { Connection } from '@things-factory/integration-base'
+
+export async function connectConnections(connections: Connection[], context: ResolverContext): Promise<any> {
+  pubsub.publish('connect-connections', connections)
+}

package/server/controllers/disconnect-connections.ts

@@ -0,0 +1,6 @@
+import { pubsub } from '@things-factory/shell'
+import { Connection } from '@things-factory/integration-base'
+
+export async function disconnectConnections(connections: Connection[], context: ResolverContext): Promise<any> {
+  pubsub.publish('disconnect-connections', connections)
+}

package/server/controllers/index.ts

@@ -0,0 +1,2 @@
+export * from './run-task'
+export * from './sync-connections'

package/server/controllers/run-task.ts

@@ -0,0 +1,33 @@
+import { pubsub } from '@things-factory/shell'
+import { Context, Step, TaskHandler } from '@things-factory/integration-base'
+import { requestLock, tryLock } from '@things-factory/lock-client'
+
+export const runTask: TaskHandler = async (step: Step, scenarioContext: Context) => {
+  const { logger }: { logger: any } = scenarioContext
+
+  try {
+    const id = await requestLock()
+
+    pubsub.publish('run-task', {
+      id,
+      step,
+      context: scenarioContext
+    })
+
+    const result = await tryLock({ id })
+    const { out, logs, error } = result || {}
+
+    if (logger.transports?.length > 0) {
+      /* 강제로 시나리오 인스턴스가 종료된 경우에는 logger도 닫힌 상태가 된다. 이 경우에는 transports가 설정되지 않게된다. */
+      logs && logs.map(log => logger.log(log))
+    }
+
+    if (error) {
+      throw new Error(error)
+    }
+
+    return out
+  } catch (err) {
+    throw new Error(err)
+  }
+}

package/server/controllers/sync-connections.ts

@@ -0,0 +1,6 @@
+import { pubsub } from '@things-factory/shell'
+import { Connection } from '@things-factory/integration-base'
+
+export async function syncConnections(connections: Connection[], context: ResolverContext): Promise<any> {
+  pubsub.publish('sync-connections', connections)
+}

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

@@ -0,0 +1,45 @@
+import { Connector, ConnectionManager, InputConnection } from '@things-factory/integration-base'
+
+/**
+ * This connector only serves the role of a tag specifying that a particular step of the task will be performed on the Edge Server,
+ * and therefore, contains no special logic.
+ */
+export class EdgeConnector implements Connector {
+  async ready(connectionConfigs: InputConnection[]) {
+    await Promise.all(connectionConfigs.map(this.connect.bind(this)))
+
+    ConnectionManager.logger.info('edge-connector connections are ready')
+  }
+
+  async connect(connection: InputConnection) {
+    const edge = {}
+
+    ConnectionManager.addConnectionInstance(connection, edge)
+
+    ConnectionManager.logger.info(`edge-connector connection(${connection.name}:${connection.endpoint}) is connected`)
+  }
+
+  async disconnect(connection: InputConnection) {
+    ConnectionManager.removeConnectionInstance(connection)
+
+    ConnectionManager.logger.info(`edge-connector connection(${connection.name}) is disconnected`)
+  }
+
+  get parameterSpec() {
+    return []
+  }
+
+  get taskPrefixes() {
+    return [] // intentionally empty
+  }
+
+  get help() {
+    return 'integration/connector/edge-connector'
+  }
+
+  get description() {
+    return 'Operato Edge Connector'
+  }
+}
+
+ConnectionManager.registerConnector('edge-connector', new EdgeConnector())

package/server/engine/index.ts

@@ -0,0 +1 @@
+import './connector/edge-connector'

package/server/index.ts

@@ -0,0 +1,17 @@
+export * from './service'
+
+import { setEdgeClient } from '@things-factory/integration-base'
+import { runTask } from './controllers/run-task'
+import { syncConnections } from './controllers/sync-connections'
+import { connectConnections } from './controllers/connect-connections'
+import { disconnectConnections } from './controllers/disconnect-connections'
+import './engine' // for registering edge-connector
+
+process.on('bootstrap-module-start' as any, async ({ app, config, client }: any) => {
+  setEdgeClient({
+    handler: runTask,
+    syncConnections,
+    connectConnections,
+    disconnectConnections
+  })
+})

package/server/service/appliance/edge-client-mutation.ts

@@ -0,0 +1,18 @@
+import { Resolver, Mutation, Arg, Ctx, Directive } from 'type-graphql'
+
+import { Appliance } from '@things-factory/auth-base'
+import { releaseLock } from '@things-factory/lock-client'
+
+import { RunTaskCallbackInput } from './edge-client-type'
+
+@Resolver(Appliance)
+export class EdgeClientMutation {
+  @Mutation(returns => Boolean, { description: 'To receive the result of runTask' })
+  async runTaskCallback(@Arg('result', type => RunTaskCallbackInput) result: RunTaskCallbackInput, @Ctx() context: ResolverContext): Promise<boolean> {
+    const { id, out, logs, error } = result
+
+    await releaseLock({ id, payload: { out, logs, error } })
+
+    return true
+  }
+}

package/server/service/appliance/edge-client-subscription.ts

@@ -0,0 +1,239 @@
+import { filter, pipe } from 'graphql-yoga'
+import { Resolver, Subscription, Root, Arg } from 'type-graphql'
+
+import { pubsub, getRepository, Domain } from '@things-factory/shell'
+import { Appliance, User } from '@things-factory/auth-base'
+import { ConnectionManager, Connection, Step } from '@things-factory/integration-base'
+
+import { EdgeContext, RunTaskPayload } from './edge-client-type'
+
+@Resolver(Appliance)
+export class EdgeClientSubscription {
+  @Subscription(type => [Connection], {
+    subscribe: async ({ args, context, info }) => {
+      const { domain, user }: { domain: Domain; user: User } = context.state
+      const subdomain = domain?.subdomain
+
+      if (!domain) {
+        throw new Error('domain required')
+      }
+
+      if (!user.domains?.find(d => d.subdomain === subdomain) && !process.superUserGranted(domain, user)) {
+        throw new Error(`domain(${subdomain}) is not working for user(${user.email}).`)
+      }
+
+      const appliance =
+        user.reference &&
+        (await getRepository(Appliance).findOne({
+          where: {
+            id: user.reference
+          }
+        }))
+
+      if (!appliance) {
+        throw new Error('Appliance not found')
+      }
+
+      process.nextTick(async () => {
+        const connections = Object.values(ConnectionManager.getConnectionInstanceEntities(domain)).filter(({ edgeId }) => edgeId == appliance.id)
+
+        if (connections.length > 0) {
+          pubsub.publish('sync-connections', connections)
+        }
+      })
+
+      return pipe(
+        pubsub.subscribe('sync-connections'),
+        filter(async (payload: Connection[]) => {
+          const connections = payload
+          const { edgeId } = connections[0]
+
+          if (connections.find(connection => connection.domain?.subdomain !== subdomain)) {
+            return false
+          }
+
+          if (!edgeId || appliance?.id !== edgeId) {
+            return false
+          }
+
+          return true
+        })
+      )
+    }
+  })
+  syncConnections(@Root() payload: Connection[]): Connection[] {
+    return payload.map(connection => {
+      return {
+        ...connection,
+        params: JSON.stringify(connection.params)
+      }
+    })
+  }
+
+  @Subscription(type => [Connection], {
+    subscribe: async ({ args, context, info }) => {
+      const { domain, user }: { domain: Domain; user: User } = context.state
+      const subdomain = domain?.subdomain
+
+      if (!domain) {
+        throw new Error('domain required')
+      }
+
+      if (!user.domains?.find(d => d.subdomain === subdomain) && !process.superUserGranted(domain, user)) {
+        throw new Error(`domain(${subdomain}) is not working for user(${user.email}).`)
+      }
+
+      const appliance =
+        user.reference &&
+        (await getRepository(Appliance).findOne({
+          where: {
+            id: user.reference
+          }
+        }))
+
+      if (!appliance) {
+        throw new Error('Appliance not found')
+      }
+
+      return pipe(
+        pubsub.subscribe('connect-connections'),
+        filter(async (payload: Connection[]) => {
+          const connections = payload
+          const { edgeId } = connections[0]
+
+          if (connections.find(connection => connection.domain?.subdomain !== subdomain)) {
+            return false
+          }
+
+          if (!edgeId || appliance?.id !== edgeId) {
+            return false
+          }
+
+          return true
+        })
+      )
+    }
+  })
+  connectConnections(@Root() payload: Connection[]): Connection[] {
+    return payload.map(connection => {
+      return {
+        ...connection,
+        params: JSON.stringify(connection.params)
+      }
+    })
+  }
+
+  @Subscription(type => [Connection], {
+    subscribe: async ({ args, context, info }) => {
+      const { domain, user }: { domain: Domain; user: User } = context.state
+      const subdomain = domain?.subdomain
+
+      if (!domain) {
+        throw new Error('domain required')
+      }
+
+      if (!user.domains?.find(d => d.subdomain === subdomain) && !process.superUserGranted(domain, user)) {
+        throw new Error(`domain(${subdomain}) is not working for user(${user.email}).`)
+      }
+
+      const appliance =
+        user.reference &&
+        (await getRepository(Appliance).findOne({
+          where: {
+            id: user.reference
+          }
+        }))
+
+      if (!appliance) {
+        throw new Error('Appliance not found')
+      }
+
+      return pipe(
+        pubsub.subscribe('disconnect-connections'),
+        filter(async (payload: Connection[]) => {
+          const connections = payload
+          const { edgeId } = connections[0]
+
+          if (connections.find(connection => connection.domain?.subdomain !== subdomain)) {
+            return false
+          }
+
+          if (!edgeId || appliance?.id !== edgeId) {
+            return false
+          }
+
+          return true
+        })
+      )
+    }
+  })
+  disconnectConnections(@Root() payload: Connection): Connection[] {
+    return payload.map(connection => {
+      return {
+        ...connection,
+        params: JSON.stringify(connection.params)
+      }
+    })
+  }
+
+  @Subscription({
+    subscribe: async ({ args, context, info }) => {
+      const { domain, user }: { domain: Domain; user: User } = context.state
+
+      const subdomain = domain?.subdomain
+      if (!domain) {
+        throw new Error('domain required')
+      }
+
+      if (!user.domains?.find(d => d.subdomain === subdomain) && !process.superUserGranted(domain, user)) {
+        throw new Error(`domain(${subdomain}) is not working for user(${user.email}).`)
+      }
+
+      const appliance =
+        user.reference &&
+        (await getRepository(Appliance).findOne({
+          where: {
+            id: user.reference
+          }
+        }))
+
+      if (!appliance) {
+        throw new Error('Appliance not found')
+      }
+      return pipe(
+        pubsub.subscribe('run-task'),
+        filter(async (payload: { id: string; step: Step; context: EdgeContext }) => {
+          const { domainId, connection } = payload.step
+
+          if (domainId !== domain.id) {
+            return false
+          }
+
+          const { edgeId } = connection && ConnectionManager.getConnectionInstanceEntityByName(domain, connection)
+
+          if (!edgeId || appliance?.id !== edgeId) {
+            return false
+          }
+
+          return true
+        })
+      )
+    }
+  })
+  runTask(@Root() payload: RunTaskPayload): RunTaskPayload {
+    const { id, step, context } = payload
+    const { name, task, description, connection, params } = step
+
+    return {
+      id, // requestId
+      step: {
+        name,
+        task,
+        description,
+        connection,
+        params: JSON.stringify(params)
+      },
+      context
+    }
+  }
+}

package/server/service/appliance/edge-client-type.ts

@@ -0,0 +1,46 @@
+import { InputType, ObjectType, Field } from 'type-graphql'
+
+import { Domain, ScalarObject } from '@things-factory/shell'
+import { Step } from '@things-factory/integration-base'
+
+@ObjectType()
+export class EdgeContext {
+  @Field(type => Domain, { nullable: true })
+  domain: any
+
+  @Field(type => ScalarObject, { nullable: true })
+  data: any
+
+  @Field(type => ScalarObject, { nullable: true })
+  variables: any
+
+  @Field({ nullable: true })
+  lng: string
+}
+
+@ObjectType()
+export class RunTaskPayload {
+  @Field()
+  id: string
+
+  @Field()
+  step: Step
+
+  @Field()
+  context: EdgeContext
+}
+
+@InputType()
+export class RunTaskCallbackInput {
+  @Field({ nullable: true })
+  id: string
+
+  @Field(type => ScalarObject, { nullable: true })
+  out: any
+
+  @Field(type => ScalarObject, { nullable: true })
+  logs: any
+
+  @Field(type => ScalarObject, { nullable: true })
+  error: any
+}

package/server/service/appliance/index.ts

@@ -0,0 +1,6 @@
+import { EdgeClientMutation } from './edge-client-mutation'
+import { EdgeClientSubscription } from './edge-client-subscription'
+
+export const entities = []
+export const resolvers = [EdgeClientMutation, EdgeClientSubscription]
+export const subscribers = []