# バッチ設計書 1-check-zig-cache.sh

## 概要

本ドキュメントは、Zigキャッシュファイルの整合性チェックと更新を行うビルドサポートスクリプト `check-zig-cache.sh` の設計仕様を記載する。

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

本バッチは、Zigビルドシステムの依存関係管理ファイル群の整合性を検証し、必要に応じて更新を行うスクリプトである。

**業務上の目的・背景**：Ghosttyプロジェクトでは、Zigビルドシステムを使用しており、依存関係の定義ファイル（build.zig.zon）から複数の派生ファイル（Nix用、テキスト形式、JSON形式、Flatpak用）を自動生成している。これらのファイルが不整合な状態でコミットされると、各プラットフォームでのビルドが失敗する可能性がある。本スクリプトは、zon2nixツールを使用して派生ファイルを再生成し、既存ファイルとのハッシュ比較により整合性を検証することで、ビルドの信頼性を確保する。

**バッチの実行タイミング**：CI/CD パイプライン実行時（プッシュ・PR作成時）、および開発者による手動実行時（依存関係更新後）

**主要な処理内容**：
1. 一時作業ディレクトリの作成とクリーンアップ処理の設定
2. 既存の4つのキャッシュファイル（build.zig.zon.nix, build.zig.zon.txt, build.zig.zon.json, flatpak/zig-packages.json）のSHA512ハッシュ取得
3. zon2nixツールによる新しいキャッシュファイルの生成
4. alejandraによるNixファイルのフォーマット、prettierによるJSONファイルのフォーマット
5. 新規生成ファイルのハッシュ値と既存ファイルのハッシュ値の比較
6. --updateフラグ指定時は既存ファイルを新規ファイルで上書き

**前後の処理との関連**：build.zig.zonファイルが更新された場合、本スクリプトを実行して派生ファイルを更新する必要がある。CIでの検証に失敗した場合、開発者は --update オプションで手動更新しコミットする。

**影響範囲**：Nixビルド、Flatpakビルド、および依存関係の取得処理に影響を与える

## バッチ種別

データ整合性チェック / ファイル生成

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（CIトリガー/手動） |
| 実行時刻 | - |
| 実行曜日 | - |
| 実行日 | - |
| トリガー | push/PR/手動 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| zon2nix | zon2nixコマンドが利用可能であること |
| alejandra | Nixフォーマッタalejandraが利用可能であること |
| prettier | prettierが利用可能であること |
| sha512sum | sha512sumコマンドが利用可能であること |
| build.zig.zon | リポジトリルートにbuild.zig.zonが存在すること |

### 実行可否判定

- チェックモード（デフォルト）: 4つのキャッシュファイルがすべて存在すること
- 更新モード（--update指定時）: キャッシュファイルが存在しなくても実行可能

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| --update | フラグ | No | なし | ファイル更新モードを有効化 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| build.zig.zon | Zig依存関係定義 | Zigの依存関係定義ファイル |
| build.zig.zon.nix | Nix式 | Nix用依存関係定義（検証対象） |
| build.zig.zon.txt | テキスト | 依存関係URLリスト（検証対象） |
| build.zig.zon.json | JSON | JSON形式依存関係定義（検証対象） |
| flatpak/zig-packages.json | JSON | Flatpak用パッケージ定義（検証対象） |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| build.zig.zon.nix | Nix式 | --update時に更新 |
| build.zig.zon.txt | テキスト | --update時に更新 |
| build.zig.zon.json | JSON | --update時に更新 |
| flatpak/zig-packages.json | JSON | --update時に更新 |
| 標準出力 | テキスト | 処理結果メッセージ |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | build.zig.zon.nix, build.zig.zon.txt, build.zig.zon.json, flatpak/zig-packages.json |
| 出力先 | リポジトリルート / flatpakディレクトリ |
| 文字コード | UTF-8 |
| 区切り文字 | - |

## 処理フロー

### 処理シーケンス

```
1. 初期化処理
   └─ set -e による厳格モード有効化
2. 一時ディレクトリ作成
   └─ mktemp -d でワークディレクトリ作成、trap でクリーンアップ設定
3. パス変数設定
   └─ スクリプト位置からリポジトリルートを算出し、各ファイルパスを設定
4. 既存ファイルのハッシュ取得
   └─ 4つのファイルそれぞれについてsha512sumでハッシュ値取得
   └─ ファイル不在かつ非updateモードの場合はエラー終了
5. 新規ファイル生成
   └─ zon2nix で4ファイルを一時ディレクトリに生成
   └─ alejandra で .nix ファイルをフォーマット
   └─ prettier で .json ファイルをフォーマット
6. 新規ファイルのハッシュ取得
   └─ 生成した4ファイルのsha512sumハッシュ値を取得
7. ハッシュ比較と処理分岐
   └─ 全ハッシュが一致: 「unchanged」メッセージを出力して正常終了
   └─ ハッシュ不一致かつ非updateモード: エラーメッセージとヘルプを出力して異常終了
   └─ ハッシュ不一致かつupdateモード: ファイルを移動して正常終了
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[一時ディレクトリ作成]
    B --> C[既存ファイルのハッシュ取得]
    C --> D{ファイル存在?}
    D -->|なし & 非update| E[エラー終了]
    D -->|あり or update| F[zon2nixで新規生成]
    F --> G[alejandra/prettierでフォーマット]
    G --> H[新規ファイルのハッシュ取得]
    H --> I{ハッシュ一致?}
    I -->|一致| J[unchanged出力・正常終了]
    I -->|不一致 & 非update| K[エラー・ヘルプ出力・異常終了]
    I -->|不一致 & update| L[ファイル更新・正常終了]
```

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

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

本バッチはデータベースを使用しない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | ファイル不在 | 必須キャッシュファイルが存在しない | --updateで実行してファイルを生成 |
| 1 | ハッシュ不一致 | キャッシュファイルが最新でない | --updateで実行して更新 |
| 1 | 一時ディレクトリ作成失敗 | ディスク容量不足等 | システム状態を確認 |

### リトライ仕様

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

### 障害時対応

1. エラーメッセージを確認し、不足ファイルまたは不整合を特定
2. `./nix/build-support/check-zig-cache.sh --update` を手動実行
3. 生成されたファイルをgit addしてコミット・プッシュ

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 該当なし（ファイル操作） |
| コミットタイミング | 全ファイル更新完了時 |
| ロールバック条件 | 処理中断時は一時ファイルがtrapで削除される |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 4ファイル |
| 目標処理時間 | 30秒以内 |
| メモリ使用量上限 | 特に制限なし |

## 排他制御

同一リポジトリでの同時実行は推奨しない。CIでは単一ジョブとして実行される。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | なし | - |
| 進捗ログ | なし | - |
| 終了ログ | 処理完了時 | OK: xxx unchanged / updated |
| エラーログ | エラー発生時 | ERROR: xxx missing / needs to be updated |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 終了コード | != 0 | CI失敗通知 |

## 備考

- 本スクリプトは `set -e` により、いずれかのコマンドが失敗した場合は即座に終了する
- 一時ディレクトリは `trap cleanup EXIT` により、正常終了・異常終了を問わず必ず削除される
- zon2nixツールは `--15` オプションでZig 0.15互換モードで実行される
