# 機能設計書 22-タスク作成・開始

## 概要

本ドキュメントは、Giselleシステムにおける「タスク作成・開始」機能の設計仕様を定義する。この機能は、タスクの作成と実行開始を一度の呼び出しで行う便利な複合機能である。

### 本機能の処理概要

**業務上の目的・背景**：多くのユースケースでは、タスクを作成した直後に実行を開始したいという要件がある。この機能により、タスク作成と開始の2ステップを1つのAPIコールで完結でき、クライアント側の実装を簡素化し、ネットワークラウンドトリップを削減できる。特にUI操作（Runボタン押下）やAPI経由でのワークフロー実行において、シンプルなインターフェースを提供する。

**機能の利用シーン**：
- ワークフローエディタでRunボタンを押下してワークフローを即座に実行する場合
- プレイグラウンド画面でアプリをテスト実行する場合
- GitHub Webhookイベントを受信し、対応するワークフローを即座に実行する場合
- 外部APIからワークフローをトリガー実行する場合

**主要な処理内容**：
1. createTask関数を呼び出してタスクを作成する
2. タスク作成完了時のコールバック（taskCreate）を実行する
3. runTask関数を呼び出してタスクを最後まで実行する
4. 各生成ステップの完了/エラー時にコールバックを呼び出す

**関連システム・外部連携**：
- Storage: タスクデータと生成データの永続化
- AI Provider APIs: Anthropic, Google, OpenAI, Perplexity等
- GitHub App: Webhookイベントからの実行トリガー

**権限による制御**：
- ワークスペースへのアクセス権限を持つユーザーのみが実行可能
- API経由の場合は、適切なAPIキーによる認証が必要

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 17 | ワークフローエディタ画面 | 主画面 | Runボタン押下によるワークフロー実行 |
| 18 | プレイグラウンド画面 | 主画面 | アプリの実行テスト、タスクの作成と開始処理 |
| 20 | タスク詳細画面 | 補助機能 | 同じアプリで新規タスクを作成・開始する処理 |

## 機能種別

CRUD操作（Create） / 非同期処理実行

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| workspaceId | WorkspaceId | No* | 対象ワークスペースID | `wks_`で始まる有効なID形式 |
| workspace | Workspace | No* | ワークスペースオブジェクト | Zodスキーマによる検証 |
| connectionIds | ConnectionId[] | No** | 実行対象の接続ID配列 | `con_`で始まる有効なID形式の配列 |
| nodeId | NodeId | No** | 実行対象のノードID | `nd_`で始まる有効なID形式 |
| inputs | GenerationContextInput[] | Yes | 生成コンテキストの入力データ | 配列形式 |
| generationOriginType | string（enum） | Yes | 生成元タイプ | "studio" / "github-app" / "api" / "stage" |
| callbacks | CreateAndStartTaskCallbacks | No | 各種コールバック関数 | - |

*workspaceIdまたはworkspaceのいずれかが必須
**connectionIdsまたはnodeIdのいずれかが必須

### 入力データソース

- Storage: ワークスペースデータの取得（workspaceIdが指定された場合）
- 画面入力: ワークフローエディタからのノード選択とRunボタン操作

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| - | void | 戻り値なし（タスクはコールバックで通知） |

### 出力先

- Storage: タスクデータと生成データの永続化
- コールバック: taskCreate, generationComplete, generationError

## 処理フロー

### 処理シーケンス

```
1. タスク作成
   └─ createTask関数でワークスペースからタスクを生成
      └─ ノード、接続、シーケンスの構築
      └─ 生成オブジェクトの作成
      └─ ストレージへの保存

2. タスク作成コールバック
   └─ callbacks.taskCreate?.({ task })を実行

3. タスク実行
   └─ runTask関数でタスクを最後まで実行
      └─ シーケンスごとの順次実行
      └─ 各ステップの並列実行
      └─ 生成完了/エラーコールバックの呼び出し
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[createTask実行]
    B --> C{タスク作成成功?}
    C -->|No| D[エラー処理]
    C -->|Yes| E[taskCreateコールバック実行]
    E --> F[runTask実行]
    F --> G{シーケンス処理}
    G --> H[各ステップを並列実行]
    H --> I{全ステップ完了?}
    I -->|No| J{エラー発生?}
    J -->|Yes| K[generationErrorコールバック]
    J -->|No| H
    I -->|Yes| L[generationCompleteコールバック]
    K --> M[次シーケンスをスキップ]
    L --> N{次シーケンスあり?}
    M --> N
    N -->|Yes| G
    N -->|No| O[終了]
    D --> P[例外スロー]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-22-01 | ワークスペース指定 | workspaceIdまたはworkspaceのいずれかを指定 | 常時 |
| BR-22-02 | 実行範囲指定 | connectionIdsまたはnodeIdで実行範囲を決定 | 常時 |
| BR-22-03 | シーケンス順次実行 | シーケンスは定義順に実行される | タスク実行時 |
| BR-22-04 | ステップ並列実行 | 同一シーケンス内のステップは並列実行 | シーケンス実行時 |
| BR-22-05 | エラー時スキップ | シーケンスでエラー発生時、後続シーケンスはスキップ | エラー発生時 |

### 計算ロジック

**シーケンス構築ロジック**：
1. buildLevels関数でノードの依存関係からレベルを算出
2. 同一レベルのノードは同一シーケンスにグループ化
3. レベル順にシーケンスを配列として構築

## データベース操作仕様

### 操作別データベース影響一覧

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| ワークスペース取得 | Storage (workspaces/) | SELECT | ワークスペースデータの読み取り |
| タスク作成 | Storage (tasks/{taskId}.json) | INSERT | タスクデータの新規作成 |
| タスクインデックス追加 | Storage (tasks/byWorkspace/) | UPDATE | ワークスペース別インデックスへの追加 |
| 生成データ作成 | Storage (generations/) | INSERT | 各ステップの生成データ作成 |
| タスク更新 | Storage (tasks/{taskId}.json) | UPDATE | ステータスと統計の更新 |

### テーブル別操作詳細

#### Storage: tasks/{taskId}.json

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| INSERT | 全フィールド | createTaskで生成された値 | 新規作成時 |
| UPDATE | status | "created" -> "inProgress" -> "completed"/"failed" | 実行進行中 |
| UPDATE | steps | 各ステータスのカウント更新 | ステップ完了時 |
| UPDATE | duration | wallClock, totalTask | 実行完了時 |
| UPDATE | usage | inputTokens, outputTokens, totalTokens | 生成完了時 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| WORKSPACE_NOT_FOUND | NotFoundError | ワークスペースが存在しない | 有効なワークスペースIDを指定 |
| NODE_NOT_FOUND | NotFoundError | 指定ノードが存在しない | 有効なノードIDを指定 |
| INVALID_START_NODE | ValidationError | スタートノードが未設定 | ノードを設定する |
| MULTIPLE_END_NODES | ValidationError | 複数の終了ノードが存在 | 終了ノードを1つにする |
| AI_PROVIDER_ERROR | ExternalError | AI APIの呼び出しに失敗 | リトライまたはプロバイダ確認 |

### リトライ仕様

- AI API呼び出しエラー: 自動リトライなし（呼び出し側で制御）
- ストレージエラー: 自動リトライなし

## トランザクション仕様

- タスク作成と生成データ作成はPromise.allで並列実行
- 実行中のステータス更新はパッチキューでバッチ処理
- 部分的な失敗は許容（failedステータスで記録）

## パフォーマンス要件

- タスク作成: 200ms以内
- 各ステップ実行: AIモデルのレスポンス時間に依存
- タスク全体: ノード数 × 平均生成時間

## セキュリティ考慮事項

- ワークスペースへのアクセス権限チェックは呼び出し側で実施
- APIキーやシークレットはVaultで暗号化して管理
- 生成結果には機密情報が含まれる可能性があるため、適切なアクセス制御が必要

## 備考

- この関数は`createTask`と`runTask`を内部的に呼び出す便利関数
- テレメトリ機能は今後追加予定（@todoコメントあり）

---

## コードリーディングガイド

本機能を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: データ構造を理解する

タスクと生成の基本構造を把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | task.ts | `packages/protocol/src/task/task.ts` | Task型、Sequence型、Step型の構造 |
| 1-2 | index.ts | `packages/protocol/src/generation/index.ts` | Generation型とそのステータス遷移 |

**読解のコツ**: Zodのdiscriminated unionパターン（`z.discriminatedUnion`）で複数のステータスを持つ型が定義されている。

#### Step 2: エントリーポイントを理解する

createAndStartTask関数の全体構造を把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | create-and-start-task.ts | `packages/giselle/src/tasks/create-and-start-task.ts` | 関数シグネチャとコールバック構造 |

**主要処理フロー**:
1. **9-13行目**: CreateAndStartTaskCallbacks型定義（taskCreate, generationComplete, generationError）
2. **15-22行目**: CreateAndStartTaskInputsスキーマ（CreateTaskInputsとStartTaskInputsの合成）
3. **25-29行目**: 関数シグネチャ
4. **30行目**: createTask呼び出し
5. **31行目**: taskCreateコールバック呼び出し
6. **32-38行目**: runTask呼び出し（コールバック付き）

#### Step 3: タスク作成処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | create-task.ts | `packages/giselle/src/tasks/create-task.ts` | タスク作成のコアロジック |

**主要処理フロー**:
- **35-45行目**: CreateTaskInputsスキーマ定義
- **52-62行目**: ワークスペースの取得または受け入れ
- **64-80行目**: connectionIdsの決定ロジック
- **82-122行目**: ノードと接続のフィルタリング
- **136-228行目**: シーケンスと生成オブジェクトの構築
- **296-325行目**: Taskオブジェクトの構築
- **327-347行目**: ストレージへの保存とコールバック実行

#### Step 4: タスク実行処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | run-task.ts | `packages/giselle/src/tasks/run-task.ts` | タスク実行のコアロジック |
| 4-2 | task-execution-utils.ts | `packages/giselle/src/tasks/shared/task-execution-utils.ts` | シーケンス/ステップ実行ユーティリティ |

**主要処理フロー**:
- **139-145行目**: runTask関数シグネチャ
- **148-150行目**: パッチキューの作成
- **154-212行目**: executeTask呼び出しとコールバック設定

#### Step 5: レベル構築ロジックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 5-1 | build-levels.ts | `packages/giselle/src/utils/build-levels.ts` | ノードの依存関係からレベルを算出 |

### プログラム呼び出し階層図

```
createAndStartTask (create-and-start-task.ts)
    │
    ├─ createTask (create-task.ts)
    │      │
    │      ├─ getWorkspace (workspaceId指定時)
    │      │
    │      ├─ findNodeGroupByNodeId (nodeId指定時)
    │      │
    │      ├─ buildLevels
    │      │      └─ ノードの依存関係解析
    │      │
    │      ├─ storage.setJson (タスク保存)
    │      │
    │      ├─ addWorkspaceIndexItem
    │      │
    │      └─ setGeneration (各生成データ保存)
    │
    ├─ callbacks.taskCreate
    │
    └─ runTask (run-task.ts)
           │
           ├─ getTask
           │
           ├─ createPatchQueue
           │
           └─ executeTask (task-execution-utils.ts)
                  │
                  ├─ executeSequence (各シーケンス)
                  │      │
                  │      └─ startGeneration (各ステップ)
                  │             │
                  │             └─ executeStep
                  │                    │
                  │                    ├─ generateContent
                  │                    ├─ generateImage
                  │                    ├─ executeAction
                  │                    └─ executeQuery
                  │
                  └─ applyPatches (状態更新)
```

### データフロー図

```
[入力]                      [処理]                           [出力]

workspaceId/workspace ──▶ createTask
                              │
inputs ─────────────────────┤
                              │
generationOriginType ────────┤
                              │
connectionIds/nodeId ────────┤
                              │
                              ├──▶ Task生成 ─────────────────▶ tasks/{taskId}.json
                              │
                              ├──▶ Generation生成 ──────────▶ generations/
                              │
                              └──▶ taskCreateコールバック
                                       │
                                       ▼
                              runTask
                                │
                                ├──▶ シーケンス実行
                                │        │
                                │        ├──▶ AI API呼び出し
                                │        │
                                │        └──▶ 結果保存
                                │
                                ├──▶ generationComplete/Errorコールバック
                                │
                                └──▶ Task更新 ─────────────▶ tasks/{taskId}.json
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| create-and-start-task.ts | `packages/giselle/src/tasks/create-and-start-task.ts` | ソース | エントリーポイント |
| create-task.ts | `packages/giselle/src/tasks/create-task.ts` | ソース | タスク作成処理 |
| run-task.ts | `packages/giselle/src/tasks/run-task.ts` | ソース | タスク実行処理 |
| task-execution-utils.ts | `packages/giselle/src/tasks/shared/task-execution-utils.ts` | ソース | 実行ユーティリティ |
| task.ts | `packages/protocol/src/task/task.ts` | ソース | Task型定義 |
| index.ts | `packages/protocol/src/generation/index.ts` | ソース | Generation型定義 |
| build-levels.ts | `packages/giselle/src/utils/build-levels.ts` | ソース | レベル構築ロジック |
| giselle.ts | `packages/giselle/src/giselle.ts` | ソース | Giselleクラス定義 |
| index.ts | `packages/giselle/src/tasks/index.ts` | ソース | モジュールエクスポート |
