# バッチ設計書 47-New-AppInstallerFromTemplateAndBundle.ps1

## 概要

本ドキュメントは、MSIXバンドルとテンプレートから.appinstallerファイルを生成するPowerShellスクリプト「New-AppInstallerFromTemplateAndBundle.ps1」のバッチ設計書である。

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

MSIXバンドルからパッケージ名とバージョン情報を抽出し、.appinstallerテンプレートファイル内のプレースホルダーを実際の値に置換して.appinstallerファイルを生成する。.appinstallerファイルはWindowsのアプリインストーラー機能で使用されるXMLベースの配布マニフェストである。

**業務上の目的・背景**：Windows Terminalの配布において、.appinstallerファイルはサイドローディングによるインストールと自動更新を可能にする重要なファイルである。MSIXバンドルのURLやバージョン情報を含むこのファイルにより、ユーザーはWebリンクからの直接インストールや自動更新を利用できる。本バッチはリリースごとに正確な.appinstallerファイルを自動生成し、手動編集によるミスを防止する。

**バッチの実行タイミング**：リリースプロセスにおいて、MSIXバンドルの作成後に実行される。CI/CDパイプラインのリリース工程で実行される。

**主要な処理内容**：
1. MSIXバンドルからAppxBundleManifest.xmlをtar.exeで抽出する
2. バンドルマニフェストからパッケージ名（Name）とバージョン（Version）を取得する
3. テンプレートファイルを読み込む
4. プレースホルダー（$$ROOT$$、$$NAME$$、$$VERSION$$、$$PACKAGE$$）を実際の値に置換する
5. 置換結果をUTF-8（BOMなし）で出力ファイルに保存する

**前後の処理との関連**：Create-AppxBundle.ps1（No.45）で作成されたMSIXバンドルを入力として使用する。生成された.appinstallerファイルはリリース配布物に含まれる。

**影響範囲**：.appinstallerファイルの内容に直接影響し、サイドローディングによるインストールとアプリ更新に影響する。

## バッチ種別

パッケージング（配布マニフェスト生成）

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（リリース時） |
| 実行時刻 | リリースプロセス依存 |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | CI/CDパイプライン／手動 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| MSIXバンドルの存在 | BundlePathで指定されたパスに.msixbundleファイルが存在すること |
| テンプレートファイルの存在 | AppInstallerTemplatePathで指定されたパスにテンプレートが存在すること |
| tar.exeの利用可能 | tar.exeがPATH上で利用可能であること（Windows 10標準搭載） |

### 実行可否判定

$ErrorActionPreference = "Stop"が設定されており、いずれかの処理でエラーが発生した場合はスクリプトが停止する。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| BundlePath | string | Yes | なし | .msixbundleファイルのパス |
| AppInstallerTemplatePath | string | Yes | なし | .appinstallerテンプレートファイルのパス |
| AppInstallerRoot | string | No | なし | テンプレート内の$$ROOT$$プレースホルダーの置換値 |
| OutputPath | string | Yes | なし | 出力.appinstallerファイルのパス |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| MSIXバンドル | .msixbundle | AppxMetadata/AppxBundleManifest.xmlを含むバンドルファイル |
| .appinstallerテンプレート | テキスト | $$ROOT$$, $$NAME$$, $$VERSION$$, $$PACKAGE$$プレースホルダーを含むテンプレート |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| OutputPathで指定されたファイル | .appinstaller (XML) | プレースホルダーが置換された.appinstallerファイル |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | OutputPathパラメータで指定 |
| 出力先 | OutputPathパラメータで指定 |
| 文字コード | UTF-8（BOMなし） |
| 区切り文字 | 該当なし（XML形式） |

## 処理フロー

### 処理シーケンス

```
1. 一時ディレクトリの準備
   └─ New-TemporaryFileでセンチネルファイル作成後、ディレクトリに変換
2. MSIXバンドルからマニフェスト抽出
   └─ tar.exe -x -f {バンドル} -C {一時ディレクトリ} AppxMetadata/AppxBundleManifest.xml
3. マニフェスト解析
   └─ XMLとして読み込み、Bundle.Identity.NameとBundle.Identity.Versionを取得
4. テンプレート読み込み
   └─ Get-Content -ReadCount 0 でテンプレートファイルを一括読み込み
5. プレースホルダー置換
   ├─ $$ROOT$$ → AppInstallerRoot
   ├─ $$NAME$$ → バンドルのパッケージ名
   ├─ $$VERSION$$ → バンドルのバージョン
   └─ $$PACKAGE$$ → バンドルのファイル名
6. ファイル出力
   └─ Out-File -Encoding utf8NoBOM で保存
7. 出力ファイルオブジェクト返却
   └─ Get-Item $OutputPath
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[一時ディレクトリ作成]
    B --> C[tar.exeでバンドルマニフェスト抽出]
    C --> D[XML解析: Name/Version取得]
    D --> E[テンプレートファイル読み込み]
    E --> F[$$ROOT$$置換]
    F --> G[$$NAME$$置換]
    G --> H[$$VERSION$$置換]
    H --> I[$$PACKAGE$$置換]
    I --> J[UTF-8 BOMなしで保存]
    J --> K[出力ファイルオブジェクト返却]
    K --> L[バッチ終了]
```

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

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

本バッチはデータベース操作を行わない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| N/A | ファイル読み込みエラー | MSIXバンドルが存在しないまたは読み取り不可 | ファイルパスと権限を確認する |
| N/A | tar.exe実行エラー | バンドルからマニフェスト抽出に失敗 | バンドルファイルの整合性を確認する |
| N/A | XML解析エラー | AppxBundleManifest.xmlが不正 | バンドルの構成を確認する |
| N/A | テンプレート読み込みエラー | テンプレートファイルが存在しない | テンプレートパスを確認する |

### リトライ仕様

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

### 障害時対応

$ErrorActionPreference = "Stop"により、エラー発生時は即座に停止する。入力ファイルの整合性を確認し、再実行する。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 該当なし（ファイル操作のみ） |
| コミットタイミング | Out-Fileでのファイル書き込み時 |
| ロールバック条件 | 該当なし |

## パフォーマンス要件

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

## 排他制御

同一出力パスへの同時実行は想定されていない。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 標準出力 | 処理完了時 | Get-Item $OutputPathの結果（ファイル情報） |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| ビルドエラー | 発生時 | ビルドシステム（CI/CD） |

## 備考

- CmdletBindingが指定されており、共通パラメータ（-Verbose等）が利用可能。
- プレースホルダー置換は正規表現`-Replace`演算子を使用しており、`$$`はリテラルのドル記号としてエスケープされている。
- 一時ディレクトリはセンチネルファイル方式で作成される（New-TemporaryFile後にディレクトリに変換）。
- テンプレート読み込みに`-ReadCount 0`を使用しており、全行を一括で配列として読み込む。
- $$PACKAGE$$にはバンドルの.Nameプロパティ（ファイル名）が使用される。
- ソースファイルパス: `build/scripts/New-AppInstallerFromTemplateAndBundle.ps1`
