# 機能設計書 64-ファイルコピー

## 概要

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

### 本機能の処理概要

ファイルコピー機能は、ワークスペース内の既存ファイルを新しいファイルIDで複製する機能である。ワークスペースの複製やファイルの再利用時に使用される。

**業務上の目的・背景**：ワークスペースをコピーする際、関連するファイルも一緒にコピーする必要がある。また、既存ファイルを基に新しいバージョンを作成する場合にも本機能が利用される。これにより、ユーザーは効率的にワークフローのテンプレートを複製・再利用できる。

**機能の利用シーン**：
- ワークスペースコピー時の関連ファイル複製
- テンプレートワークスペースからの新規作成
- ファイルのバックアップコピー作成

**主要な処理内容**：
1. 入力としてWorkspaceId、ソースFileId、コピー先FileIdを受け取る
2. ソースファイルのパスを生成
3. コピー先ファイルのパスを生成
4. ストレージのcopy機能を使用してファイルを複製

**関連システム・外部連携**：
- `@giselles-ai/storage`パッケージによるストレージ抽象化レイヤー
- ワークスペースコピー機能からの呼び出し

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

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | （直接的な画面関連なし） | - | ワークスペースコピー機能の内部処理として使用 |

## 機能種別

データコピー（CREATE）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| storage | `GiselleStorage` | Yes | ストレージインスタンス | - |
| workspaceId | `WorkspaceId` | Yes | ファイルが存在するワークスペースID | `wks_`プレフィックスで始まる文字列 |
| sourceFileId | `FileId` | Yes | コピー元ファイルのID | `fl_`プレフィックスで始まる文字列 |
| destinationFileId | `FileId` | Yes | コピー先ファイルのID | `fl_`プレフィックスで始まる文字列 |

### 入力データソース

- ワークスペースコピー処理からの内部呼び出し
- 各IDはGiselleシステム内で生成されたID

## 出力仕様

### 出力データ

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

### 出力先

- ストレージに新しいファイルとして複製

## 処理フロー

### 処理シーケンス

```
1. ソースパス生成
   └─ filePath関数でworkspaces/{workspaceId}/files/{sourceFileId}/{sourceFileId}パスを生成

2. コピー先パス生成
   └─ filePath関数でworkspaces/{workspaceId}/files/{destinationFileId}/{destinationFileId}パスを生成

3. ストレージコピー実行
   └─ storage.copy()でファイルを複製

4. エラーハンドリング
   └─ 失敗時は詳細なエラーメッセージを含むエラーをスロー
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[ソースパス生成]
    B --> C[コピー先パス生成]
    C --> D[storage.copy実行]
    D --> E{コピー成功?}
    E -->|Yes| F[終了]
    E -->|No| G[エラーログ出力]
    G --> H[カスタムエラーをスロー]
    H --> I[終了（異常）]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-64-01 | 同一ワークスペース | コピー元とコピー先は同一ワークスペース内である | 常時 |
| BR-64-02 | パス形式 | ファイルパスは`workspaces/{workspaceId}/files/{fileId}/{fileId}`形式 | 常時 |
| BR-64-03 | エラー詳細 | エラー時はソースパスとコピー先パスを含む詳細メッセージを返す | エラー発生時 |

### 計算ロジック

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

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

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

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

| 操作 | 対象ストレージ | 操作種別 | 概要 |
|-----|-------------|---------|------|
| ファイルコピー | Blob Storage | COPY | ソースファイルをコピー先に複製 |

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

#### Blobストレージ

| 操作 | ソースパス | コピー先パス | 備考 |
|-----|----------|------------|------|
| COPY | workspaces/{workspaceId}/files/{sourceFileId}/{sourceFileId} | workspaces/{workspaceId}/files/{destinationFileId}/{destinationFileId} | ストレージドライバのcopyメソッド使用 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | Error | ソースファイルが存在しない | 存在するファイルIDを指定 |
| - | Error | ストレージコピー失敗 | ストレージ接続を確認 |

### エラーメッセージ形式

```
File copy failed: {原因} (Source: {sourcePath}, Destination: {destinationPath})
```

または

```
An unknown error occurred during file copy (Source: {sourcePath}, Destination: {destinationPath})
```

### リトライ仕様

本機能ではリトライを行わない。エラー発生時は即座にエラーをスローする。

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

コピー操作はアトミックではない。コピー途中で失敗した場合、部分的なファイルが残る可能性がある。

## パフォーマンス要件

- レスポンス時間: ファイルサイズに依存
- 同時リクエスト: ストレージの制限に依存

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

- 認証・認可: API呼び出し元で実装（本機能では未実装）
- データ保護: ストレージレベルでの暗号化に依存

## 備考

- メタデータのコピーは含まれない（ファイル本体のみ）
- 別ワークスペースへのコピーは現状サポートされていない

---

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

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

### 推奨読解順序

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

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

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

**読解のコツ**:
- `FileId`は`fl_`プレフィックス
- `WorkspaceId`は`wks_`プレフィックス

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

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

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

**主要処理フロー**:
1. **14-19行目**: 関数シグネチャと引数定義
2. **20行目**: 引数の分割代入
3. **22-26行目**: ソースパスの生成
4. **27-31行目**: コピー先パスの生成
5. **33-35行目**: storage.copyの実行
6. **36-48行目**: エラーハンドリング

#### 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インターフェースのcopyメソッド |

**主要処理フロー**:
- **36行目**: `Copy = (source: string, destination: string) => Promise<void>`の型定義
- **70行目**: GiselleStorageインターフェースにcopyが含まれる

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

```
Giselle.copyFile (giselle.ts:169-180)
    │
    └─ copyFile (copy-file.ts:14-50)
           │
           ├─ filePath({type, workspaceId, fileId: sourceFileId}) (utils.ts:3-17)
           │
           ├─ filePath({type, workspaceId, fileId: destinationFileId}) (utils.ts:3-17)
           │
           └─ storage.copy(sourcePath, destinationPath)
                  │
                  └─ ストレージドライバ
```

### データフロー図

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

WorkspaceId ─────┐
                 │
SourceFileId ────┼──▶ filePath() ───▶ SourcePath
                 │    filePath() ───▶ DestinationPath
DestinationFileId┘          │
                            ▼
                     storage.copy(src, dest)
                            │
                            ▼
                     New file at DestinationPath
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| copy-file.ts | `packages/giselle/src/files/copy-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クラスのエントリーポイント |
