# 機能設計書 63-ファイルアップロード

## 概要

本ドキュメントは、Giselleシステムにおける「ファイルアップロード」機能の設計仕様を定義する。

### 本機能の処理概要

ファイルアップロード機能は、ユーザーがワークスペースにファイルをアップロードし、ワークフロー内で利用可能にする機能である。ファイル本体とメタデータの両方をストレージに保存する。

**業務上の目的・背景**：AIワークフローでは、テキストファイル、PDFドキュメント、画像などの外部ファイルを入力データとして使用することが多い。本機能により、ユーザーはローカルファイルをワークスペースにアップロードし、ファイルノードを通じてワークフロー内で参照・処理できるようになる。

**機能の利用シーン**：
- ワークフローエディタ画面でのファイルノードへのファイル添付
- RAG（Retrieval-Augmented Generation）用のドキュメントアップロード
- 画像生成ワークフローへの参照画像のアップロード

**主要な処理内容**：
1. 入力としてFile、WorkspaceId、FileId、FileNameを受け取る
2. ファイルデータをBufferに変換
3. ファイル本体をストレージのBlobとして保存
4. ファイルメタデータ（ID、名前、タイプ、サイズ、ステータス、アップロード日時）をJSONとして保存

**関連システム・外部連携**：
- `@giselles-ai/storage`パッケージによるストレージ抽象化レイヤー
- Web File API（ブラウザ側でのファイル選択）

**権限による制御**：本機能自体には認証・認可チェックは含まれない。呼び出し元のAPIレイヤーにて適切な認可制御が行われることを前提とする。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 17 | ワークフローエディタ画面 | API連携 | ワークスペースへのファイルアップロード処理 |

## 機能種別

データ登録（CREATE）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| storage | `GiselleStorage` | Yes | ストレージインスタンス | - |
| file | `File` | Yes | アップロードするファイル | Web File API準拠 |
| workspaceId | `WorkspaceId` | Yes | 保存先のワークスペースID | `wks_`プレフィックスで始まる文字列 |
| fileId | `FileId` | Yes | ファイルの一意識別子 | `fl_`プレフィックスで始まる文字列 |
| fileName | `string` | Yes | ファイルの表示名 | - |

### 入力データソース

- ブラウザのFile APIから取得したFileオブジェクト
- ワークスペースIDはセッションコンテキストから取得
- ファイルIDはクライアント側で生成（`createIdGenerator("fl")`）

## 出力仕様

### 出力データ

本機能は戻り値を持たない（`void`）。

### 出力先

- ストレージにファイル本体を保存（Blob形式）
- ストレージにメタデータを保存（JSON形式）

## 処理フロー

### 処理シーケンス

```
1. ファイルをBufferに変換
   └─ File.arrayBuffer()でArrayBufferを取得
   └─ Buffer.from()でNodejs Bufferに変換

2. Blobパス生成
   └─ filePath関数でworkspaces/{workspaceId}/files/{fileId}/{fileId}パスを生成

3. ファイル本体をストレージに保存
   └─ storage.setBlob()でBlobデータを保存

4. メタデータ作成
   └─ UploadedFileData構造でメタデータを生成

5. メタデータをストレージに保存
   └─ storage.setBlob()でmetadata.jsonを保存
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[ファイルをBufferに変換]
    B --> C[ファイルパス生成]
    C --> D[ファイル本体をsetBlobで保存]
    D --> E[メタデータ構造を作成]
    E --> F[メタデータパス生成]
    F --> G[メタデータをsetBlobで保存]
    G --> H[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-63-01 | パス形式 | ファイルは`workspaces/{workspaceId}/files/{fileId}/{fileId}`に保存される | 常時 |
| BR-63-02 | メタデータ | メタデータは同ディレクトリの`metadata.json`に保存される | 常時 |
| BR-63-03 | ステータス | アップロード直後のステータスは`uploaded`となる | 常時 |
| BR-63-04 | タイムスタンプ | uploadedAtにはDate.now()のミリ秒タイムスタンプが設定される | 常時 |

### 計算ロジック

本機能に特別な計算ロジックは存在しない。

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

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

本機能はBlobストレージのみを使用し、リレーショナルデータベースへの直接アクセスは行わない。

| 操作 | 対象ストレージ | 操作種別 | 概要 |
|-----|-------------|---------|------|
| ファイル保存 | Blob Storage | SET | ファイル本体をBlobとして保存 |
| メタデータ保存 | Blob Storage | SET | metadata.jsonをBlobとして保存 |

### ストレージ操作詳細

#### Blobストレージ

| 操作 | パス | データ形式 | 備考 |
|-----|------|----------|------|
| SET | workspaces/{workspaceId}/files/{fileId}/{fileId} | Binary | ファイル本体 |
| SET | workspaces/{workspaceId}/files/{fileId}/metadata.json | JSON | メタデータ |

#### メタデータ構造（UploadedFileData）

```typescript
{
  id: FileId;         // ファイルID
  name: string;       // ファイル名
  type: string;       // MIMEタイプ
  size: number;       // ファイルサイズ（バイト）
  status: "uploaded"; // ステータス
  uploadedAt: number; // アップロード日時（ミリ秒）
}
```

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | StorageError | ストレージへの書き込み失敗 | ストレージ接続を確認 |
| - | TypeError | 無効なFileオブジェクト | 正しいFileオブジェクトを渡す |

### リトライ仕様

ストレージアクセス失敗時のリトライは、ストレージドライバ層で実装される。アプリケーション層でのリトライは行わない。

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

ファイル本体とメタデータの保存はアトミックではない。一方が失敗した場合、もう一方はロールバックされない。

## パフォーマンス要件

- ファイルサイズ: ストレージプロバイダの制限に依存
- レスポンス時間: ファイルサイズとネットワーク帯域に依存

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

- 認証・認可: API呼び出し元で実装（本機能では未実装）
- データ保護: ストレージレベルでの暗号化に依存
- ファイル検証: MIMEタイプチェック等は呼び出し元で実施を推奨

## 備考

- ファイルIDは呼び出し元で生成される
- 同じFileIdで再アップロードすると上書きされる

---

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

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

### 推奨読解順序

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

まず、ファイル関連の型定義を理解することが重要である。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | protocol/index.ts | `packages/protocol/src/index.ts` | FileId, UploadedFileData等の型エクスポートを確認 |

**読解のコツ**:
- `FileId`は`createIdGenerator("fl")`で生成される
- `UploadedFileData`はメタデータの型定義

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

処理の起点となるファイル・関数を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | upload-file.ts | `packages/giselle/src/files/upload-file.ts` | uploadFile関数の実装 |

**主要処理フロー**:
1. **10-16行目**: 関数シグネチャと引数定義
2. **17行目**: `fileToBuffer()`でファイルをBufferに変換
3. **18-22行目**: `filePath()`でストレージパスを生成
4. **23行目**: `storage.setBlob()`でファイル本体を保存
5. **25行目**: メタデータパスを生成
6. **26-33行目**: `UploadedFileData`オブジェクトを作成
7. **34-37行目**: メタデータをJSON形式で保存

#### Step 3: ユーティリティ関数を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | utils.ts | `packages/giselle/src/files/utils.ts` | filePath関数によるストレージパス生成ロジック |

**主要処理フロー**:
- **3-17行目**: GenerationOriginに応じたパス生成
- **6行目**: `workspaces/${params.workspaceId}/files/${params.fileId}/${params.fileId}`形式

#### Step 4: ストレージ抽象化を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | types.ts | `packages/storage/src/types.ts` | GiselleStorageインターフェースのsetBlobメソッド |

**主要処理フロー**:
- **27-34行目**: SetBlob型定義（path, data, options）
- **69行目**: GiselleStorageインターフェースにsetBlobが含まれる

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

```
Giselle.uploadFile (giselle.ts:181-194)
    │
    └─ uploadFile (upload-file.ts:10-38)
           │
           ├─ fileToBuffer(file) (upload-file.ts:40-43)
           │      └─ file.arrayBuffer() → Buffer.from()
           │
           ├─ filePath({type, workspaceId, fileId}) (utils.ts:3-17)
           │
           ├─ storage.setBlob(blobPath, fileBuffer)
           │      │
           │      └─ ストレージドライバ
           │
           └─ storage.setBlob(metadataPath, metadataBuffer)
```

### データフロー図

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

File Object  ───▶ fileToBuffer() ───▶ Buffer
                          │
                          ▼
                   filePath() ───▶ Storage Path
                          │        "workspaces/.../files/..."
                          ▼
                   storage.setBlob(path, buffer)
                          │
                          ▼
                   Create UploadedFileData
                   {id, name, type, size, status, uploadedAt}
                          │
                          ▼
                   storage.setBlob(metadataPath, JSON)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| upload-file.ts | `packages/giselle/src/files/upload-file.ts` | ソース | メイン処理の実装 |
| utils.ts | `packages/giselle/src/files/utils.ts` | ソース | ファイルパス生成ユーティリティ |
| types.ts | `packages/storage/src/types.ts` | ソース | ストレージインターフェース定義 |
| giselle.ts | `packages/giselle/src/giselle.ts` | ソース | Giselleクラスのエントリーポイント |
