# 機能設計書 3-ワークスペース更新

## 概要

本ドキュメントは、Giselleにおけるワークスペース更新機能の設計を定義する。ワークフローエディタでの編集内容（ノードの追加・削除・変更、接続の変更、UI状態の変更）をストレージに永続化する機能である。

### 本機能の処理概要

ワークスペース更新機能は、クライアント側で編集されたワークスペースの状態（ノード配列、接続配列、UI状態）を受け取り、ストレージに保存することでワークフローの変更を永続化する機能である。

**業務上の目的・背景**：Giselleのワークフローエディタでは、ユーザーがノードの追加・移動・削除、接続の作成・削除、プロパティの変更など様々な編集操作を行う。これらの変更をリアルタイムまたは明示的な保存操作でストレージに反映し、セッション間でワークフローの状態を維持する必要がある。本機能により、ユーザーの編集作業が失われることなく保存され、後続のセッションや他のユーザーとの共有が可能となる。

**機能の利用シーン**：ワークフローエディタ画面でノードを追加・削除した時、ノード間の接続を変更した時、ノードのプロパティを編集した時、ビューポートの位置やズームを変更した時など、編集操作が発生するたびに利用される。

**主要な処理内容**：
1. 更新されたWorkspaceオブジェクトを受け取る
2. setWorkspace関数を呼び出してストレージに保存
3. 更新後のWorkspaceオブジェクトを返却

**関連システム・外部連携**：GiselleStorageインターフェースを通じてファイルシステムまたはクラウドストレージと連携する。

**権限による制御**：呼び出し元のAPIエンドポイントでワークスペースへの編集権限確認が行われる。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 17 | ワークフローエディタ画面 | 主機能 | ノード、接続、UI状態の更新保存処理 |

## 機能種別

CRUD操作（Update）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| context | GiselleContext | Yes | Giselleの実行コンテキスト | 型チェック |
| workspace | Workspace | Yes | 更新後のワークスペースオブジェクト | Zodスキーマ検証 |

### 入力データソース

- クライアント（ワークフローエディタ）から送信されたWorkspaceオブジェクト

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| workspace | Workspace | 保存されたワークスペースオブジェクト（入力と同一） |

### 出力先

- ストレージ: `workspaces/{workspaceId}/workspace.json` パスにJSON形式で保存
- 戻り値: 呼び出し元に保存されたWorkspaceオブジェクトを返却

## 処理フロー

### 処理シーケンス

```
1. 更新されたWorkspaceオブジェクトを受け取る
   └─ 入力パラメータから取得

2. setWorkspace()でストレージに保存
   └─ workspace.idからストレージパスを構築
   └─ context.storage.setJson()でJSON形式で永続化

3. 保存されたWorkspaceオブジェクトを返却
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[Workspaceオブジェクト受け取り]
    B --> C[setWorkspace呼び出し]
    C --> D[ストレージパス構築]
    D --> E[JSON形式で保存]
    E --> F{保存成功?}
    F -->|Yes| G[Workspaceオブジェクト返却]
    F -->|No| H[エラー終了]
    G --> I[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | 上書き保存 | 同一ワークスペースIDのデータは上書きされる | 常に適用 |
| BR-002 | ID不変 | ワークスペースIDは更新処理で変更されない | 常に適用 |
| BR-003 | 完全置換 | ノード・接続・UI状態は全体が置換される（差分更新ではない） | 常に適用 |

### 計算ロジック

特になし

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| ワークスペース保存 | ストレージ（Blob/ファイル） | UPDATE | workspace.jsonを上書き保存 |

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

#### ストレージ操作

| 操作 | パス | 内容 |
|-----|------|------|
| 上書き | workspaces/{workspaceId}/workspace.json | Workspaceオブジェクト全体をJSON形式で保存 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| VALIDATION_ERROR | バリデーションエラー | Workspaceスキーマ不適合 | 入力データの確認 |
| STORAGE_ERROR | ストレージエラー | ストレージ書き込み失敗 | リトライ、接続確認 |

### リトライ仕様

ストレージ書き込み失敗時は呼び出し元でリトライを検討する。

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

ファイルベースストレージのため、RDBトランザクションは発生しない。単一ファイルの書き込み操作として完了する。

## パフォーマンス要件

- レスポンス時間: 100ms以内（ストレージ書き込み含む）
- 頻度: ユーザーの編集操作に応じてリアルタイムまたはデバウンス処理後に実行

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

- ワークスペースIDによるアクセス制御
- 認証・認可は呼び出し元のAPIレイヤーで実施

## 備考

- 更新処理は完全置換のため、部分更新が必要な場合は呼び出し元で現在の状態を取得してマージする必要がある
- エディタUIでは楽観的更新（Optimistic Update）パターンを採用し、ユーザー体験を向上させている

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | index.ts | `packages/protocol/src/workspace/index.ts` | Workspaceスキーマの全体構造 |

**読解のコツ**: 更新対象となるフィールド（nodes, connections, ui）の型定義を確認する。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | update-workspace.ts | `packages/giselle/src/workspaces/update-workspace.ts` | メイン関数の全体フロー |

**主要処理フロー**:
1. **5-8行目**: 入力パラメータの型定義（context, workspace）
2. **9-13行目**: setWorkspace関数を呼び出してストレージに保存
3. **14行目**: 保存されたワークスペースを返却

#### Step 3: ストレージ保存処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | utils.ts | `packages/giselle/src/workspaces/utils.ts` | setWorkspace関数（20-33行目） |

**主要処理フロー**:
- **16-18行目**: ストレージパスの生成
- **29-32行目**: `context.storage.setJson()`でJSON形式で保存

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

```
updateWorkspace (update-workspace.ts)
    │
    └─ setWorkspace (utils.ts)
           └─ context.storage.setJson (GiselleStorage interface)
```

### データフロー図

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

Workspace Object ───▶ setWorkspace ───▶ Storage (Blob/File)
     │                       │            workspaces/{id}/workspace.json
     │                       │
     │                       ▼
     └─────────────────▶ return ───▶ Workspace Object (same as input)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| update-workspace.ts | `packages/giselle/src/workspaces/update-workspace.ts` | ソース | メイン機能実装 |
| utils.ts | `packages/giselle/src/workspaces/utils.ts` | ソース | ストレージ操作ユーティリティ |
| index.ts | `packages/protocol/src/workspace/index.ts` | ソース | Workspaceスキーマ定義 |
