workflow triggers #4

happy-tanuki · 2023-09-02T03:12:40Z

github actions の on のように、イベントに応じてワークフローを動かすトリガーを定義できるようにしています。

on:
  - workflow_dispatch
  - join
  - text:
      match: hello

on 省略時は、workflow_dispatch が設定されているものとします。
workflow_dispatch は /list で表示される対象になります。

krdlab · 2023-09-05T06:40:09Z

src/engine.ts

@@ -47,7 +56,7 @@ export class Workflows {

    const docs = new Map<string, Workflow>();
    filenames.forEach((fn) => {
-      const w = yaml.load(fs.readFileSync(fn, 'utf8'));
+      const w = this.parse(yaml.load(fs.readFileSync(fn, 'utf8')));


このタイミングで parse (の中でやっている処理を) するのではなく，validate 後の方が良さそうに思いました．
(Workflow 型であることは type guard 後に決定するため)

krdlab · 2023-09-05T06:45:32Z

src/engine.ts

-    return typeof obj === 'object' && obj.version && obj.name && Array.isArray(obj.steps);
+  static parse(w: any): Workflow {
+    if (w) {
+      w.on = parseTrigger(w.on);


validate を type guard 関数へ戻すことを前提に，60 行目付近で以下のように呼び出す想定です．

if (this.validate(w)) { w.on = parseTrigger(w.on); // ← ここでは on がエラーにならない docs.set(w.name, w); } else {

(※ parse 関数は削除します)

krdlab · 2023-09-05T06:47:30Z

src/engine.ts

+    return w;
+  }
+
+  static validate(obj: Workflow): boolean {


こちらは type guard 関数に戻したいです．

Suggested change

static validate(obj: Workflow): boolean {

static validate(obj: any): obj is Workflow

krdlab · 2023-09-05T06:48:19Z

src/engine.ts

+  static validate(obj: Workflow): boolean {
+    return (
+      typeof obj === 'object' &&
+      typeof obj.version === 'number' &&


(元々 'string' を想定していましたが，しばらくは 'number' でも困らないのでここままで OK です)

krdlab · 2023-09-05T10:59:14Z

example/workflows/join.yml

+  - workflow_dispatch
+  - join
+  - text:
+      match: hello


基本的に項目の重複はないと思いますので，リストよりはハッシュ構造の方が良さそうです．
(text 等は複数発生するかもしれませんが，それは text フィールド以下の属性で表現するイメージです)

krdlab · 2023-09-06T00:38:28Z

src/engine.ts

@@ -148,6 +192,7 @@ export class WorkflowContext {
  private valid = true;
  private stepIndex = 0;
  private data: WorkflowStepData = {};
+  private readonly firstStep = { id: 'on' } as WorkflowStep;


firstStep を内部生成するのではなく，トリガーで発生した情報を this.data に保存するのみにした方が良さそうに思います．
(resetByEvent 側の調整も必要)

krdlab · 2023-09-06T00:41:31Z

src/engine.ts

+    if (current.id) {
+      this.data[current.id] = {
+        responder: res.message.user,
+        ...res.json,


res.json の中身を制限なく展開してしまうことは避けたいです．response.note の方のみを使うようにできないでしょうか？

krdlab · 2023-09-06T00:45:18Z

src/index.ts

+    const newContext = workflows.createWorkflowContextByEvent(type, res);
+    if (newContext) {
+      await newContext.triggerWorkflow(type);
+      return newContext;
+    }


find の中で create は避けたいため，ここだけ別関数に切り出せないでしょうか？findCurrentWorkflowContext の戻り値に基づいて create を呼び出すようなイメージです．

例えば startWorkflow に移してしまうとか．find でみつからなければ新規にワークフローを開始するイメージです．

krdlab · 2023-09-06T00:56:06Z

src/triggers.ts

+  }
+  switch (type) {
+    case 'text': {
+      const res = e as Response<TextMessage>;


WorkflowEventWith から Response<*> へのダウンキャストは少し大きすぎる感じがしました．

バイトデータならばバリデーションを経て特定の型にキャストすることは妥当なのですが，WorkflowEventWith を用意したということはアクセス出来るフィールドに制限をかけたいはずなので，WorkflowEventWith の定義をもう少し厳密よりにしてキャストを無くせると良さそうです．

現状の WorkflowEventWith は実質任意のオブジェクトみたいな感じなので，こちらを先に調整した方が良いかも知れません．

設計方針として，初期は制限を強くし，必要に応じて制限を緩める，が良いかなという印象です．

krdlab · 2023-09-06T00:59:05Z

src/workflow.ts

+  NoteUpdated: 'note_updated',
+  NoteDeleted: 'note_deleted',
+} as const;
+export type WorkflowEventType = (typeof WorkflowEvent)[keyof typeof WorkflowEvent];


Suggested change

export type WorkflowEventType = (typeof WorkflowEvent)[keyof typeof WorkflowEvent];

export type WorkflowEventType = typeof WorkflowEvent[keyof typeof WorkflowEvent];

happy-tanuki added 7 commits September 2, 2023 11:17

github action のように on でトリガーを定義する

68c170e

github actions の on と同じような yaml を読み込めるようにする

ee287b1

/list で表示されるワークフローは on なしと workflow_dispatch に限定する

909e2a3

on: text でテキストイベントに反応するようにする

bec0d28

on:note_created などでノートイベントに反応するようにする

b62d843

on:join で参加イベントに反応するようにする

752caa0

サンプルの追加

b09b901

krdlab reviewed Sep 6, 2023

View reviewed changes

複数のトリガーをオブジェクト形式で指定できなかったので修正

b98edc9

happy-tanuki force-pushed the feature/workflow-triggers branch from 8e709b8 to b98edc9 Compare September 10, 2023 13:55

happy-tanuki added 3 commits September 11, 2023 06:23

join のときはボットのuserIdになるので、相手のuserId に変換する

0321889

トークから退出した場合にワークフローを停止する

cee0865

セレクトスタンプに反応する

ec91b79

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

workflow triggers #4

workflow triggers #4

happy-tanuki commented Sep 2, 2023

krdlab Sep 5, 2023

krdlab Sep 5, 2023

krdlab Sep 5, 2023

krdlab Sep 5, 2023

krdlab Sep 5, 2023 •

edited

Loading

krdlab Sep 6, 2023

krdlab Sep 6, 2023

krdlab Sep 6, 2023

krdlab Sep 6, 2023

krdlab Sep 6, 2023

krdlab Sep 6, 2023

krdlab Sep 6, 2023

	static validate(obj: Workflow): boolean {
	static validate(obj: any): obj is Workflow

	export type WorkflowEventType = (typeof WorkflowEvent)[keyof typeof WorkflowEvent];
	export type WorkflowEventType = typeof WorkflowEvent[keyof typeof WorkflowEvent];

workflow triggers #4

Are you sure you want to change the base?

workflow triggers #4

Conversation

happy-tanuki commented Sep 2, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

krdlab Sep 5, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

krdlab Sep 5, 2023 •

edited

Loading