# バッチ設計書 25-credit-workspace.ts

## 概要

本ドキュメントは、ワークスペースにクレジットを付与する管理スクリプトの設計を記載したバッチ設計書です。

### 本バッチの処理概要

credit-workspace.tsは、指定されたワークスペースにドル建てのクレジットを付与する管理スクリプトです。カスタマーサポートや運用チームが、特別なプロモーション、補償、テスト目的でワークスペースの残高を増加させる際に使用されます。

**業務上の目的・背景**：ZEN APIはプリペイド型の課金モデルを採用しており、ユーザーはクレジットを購入してAPIを利用します。しかし、サービス障害時の補償、プロモーションキャンペーン、パートナー向け特典など、運営側から直接クレジットを付与する必要があるケースが発生します。本スクリプトにより、管理者はデータベースを直接操作することなく、安全にクレジットを付与できます。

**バッチの実行タイミング**：管理者による手動実行。カスタマーサポート対応、プロモーション実施、テスト環境セットアップ時に使用されます。

**主要な処理内容**：
1. コマンドライン引数からワークスペースIDと金額を取得
2. ワークスペースの存在確認
3. 金額の妥当性検証（正の数値）
4. Billing.grantCreditでクレジット付与
5. 成功メッセージの出力

**前後の処理との関連**：PaymentTableに支払い記録が追加され、BillingTableの残高が更新されます。付与されたクレジットは即座にZEN API利用に反映されます。

**影響範囲**：対象ワークスペースの課金残高に影響し、ZEN APIの利用可能量が変化します。

## バッチ種別

管理操作 / クレジット付与

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（手動） |
| 実行時刻 | - |
| 実行曜日 | - |
| 実行日 | - |
| トリガー | 管理者による手動実行 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| データベース接続 | Database.useが機能すること |
| ワークスペース存在 | 指定されたworkspaceIDが存在すること |
| 金額有効性 | dollarAmountが正の数値であること |

### 実行可否判定

- workspaceIDが指定されていること
- dollarAmountが指定されていること
- ワークスペースがWorkspaceTableに存在すること
- dollarAmountが正の数値であること

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| workspaceID | string | Yes | - | 対象ワークスペースID（例：wrk_xxxxx） |
| dollarAmount | string | Yes | - | 付与するクレジット金額（ドル） |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| WorkspaceTable | DB | ワークスペース存在確認 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| BillingTable | DB | 残高更新 |
| PaymentTable | DB | 支払い記録追加 |
| console.log/error | Text | 実行結果メッセージ |

### 出力ファイル仕様

ファイル出力なし

| 項目 | 内容 |
|-----|------|
| ファイル名 | - |
| 出力先 | - |
| 文字コード | - |
| 区切り文字 | - |

## 処理フロー

### 処理シーケンス

```
1. 引数検証
   └─ workspaceID、dollarAmountの存在確認
   └─ 不足時はUsageメッセージを表示して終了
2. ワークスペース存在確認
   └─ Database.useでWorkspaceTableを検索
   └─ 未存在時はエラー終了
3. 金額検証
   └─ parseFloatで数値変換
   └─ NaNまたは0以下の場合エラー終了
4. クレジット付与
   └─ Billing.grantCredit(workspaceID, amountInDollars)
5. 成功メッセージ出力
   └─ 付与金額とワークスペースIDを表示
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B{引数あり?}
    B -->|No| C[Usage表示]
    C --> D[process.exit 1]
    B -->|Yes| E[WorkspaceTable検索]
    E --> F{ワークスペース存在?}
    F -->|No| G[Error: Workspace not found]
    G --> D
    F -->|Yes| H[parseFloat金額]
    H --> I{金額有効?}
    I -->|No| J[Error: positive number required]
    J --> D
    I -->|Yes| K[Billing.grantCredit]
    K --> L[成功メッセージ出力]
    L --> M[バッチ終了]
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| ワークスペース確認 | WorkspaceTable | SELECT | 存在確認 |
| 残高更新 | BillingTable | UPDATE | balance加算 |
| 支払い記録 | PaymentTable | INSERT | クレジット付与記録 |

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

#### WorkspaceTable

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | id | WHERE id = workspaceID | 存在確認のみ |

#### BillingTable

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| UPDATE | balance | balance + amountInMicroCents | SQL演算で加算 |

#### PaymentTable

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| INSERT | id | Identifier.create("payment") | 新規ID生成 |
| INSERT | workspaceID | 引数値 | - |
| INSERT | amount | amountInMicroCents | マイクロセント単位 |
| INSERT | enrichment | {type: "credit"} | クレジット付与を示す |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 引数不足 | workspaceIDまたはdollarAmount未指定 | Usageを確認して再実行 |
| - | ワークスペース不存在 | 指定IDが見つからない | 正しいIDを指定 |
| - | 金額不正 | 0以下またはNaN | 正の数値を指定 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0（リトライなし） |
| リトライ間隔 | - |
| リトライ対象エラー | - |

### 障害時対応

- process.exit(1)で異常終了
- トランザクション内で処理されるため、中断時はロールバック

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | BillingTable更新とPaymentTable挿入 |
| コミットタイミング | Billing.grantCredit完了時 |
| ロールバック条件 | トランザクション内エラー発生時 |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1件/実行 |
| 目標処理時間 | 数秒 |
| メモリ使用量上限 | 制限なし |

## 排他制御

- 同一ワークスペースへの同時実行は非推奨
- データベーストランザクションによる整合性保証

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | - | - |
| 進捗ログ | - | - |
| 終了ログ | 成功時 | `Added payment of $X.XX to workspace {workspaceID}` |
| エラーログ | エラー時 | console.errorでメッセージ出力 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| - | - | - |

## 備考

- 金額はドル単位で指定し、内部でマイクロセント（1ドル=100,000,000マイクロセント）に変換される
- PaymentTableのenrichment.typeは"credit"で記録される
- toFixed(2)で小数点以下2桁まで表示
