# バッチ設計書 29-update-vsintegration.cmd

## 概要

本ドキュメントは、F#コンパイラプロジェクトにおけるVisual Studio統合のF# SDK更新を行うバッチスクリプト（update-vsintegration.cmd）の設計を記述するものです。

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

このバッチはローカルでビルドしたF#コンパイラおよび関連ツールをシステム全体のVisual Studio SDK共有ディレクトリにデプロイします。これにより、Visual Studio 2017以降のすべてのインストールが更新されたF#コンパイラを使用するようになります。

**業務上の目的・背景**：F#コンパイラの開発中、変更したコンパイラをVisual Studio環境でテストする必要があります。このスクリプトは、ローカルビルドのデバッグ版またはリリース版のF#バイナリをシステムのSDKディレクトリにデプロイし、開発者が実際のVisual Studio環境で変更をテストできるようにします。また、バックアップと復元機能により、元の状態に戻すことも可能です。

**バッチの実行タイミング**：開発者がローカルでF#コンパイラをビルドした後、Visual Studioでテストする際に手動で実行します。管理者権限が必要な操作（強力な名前検証の無効化、レジストリキーの追加、NGEN）が含まれます。

**主要な処理内容**：
1. モードの選択（debug/release/restore/backup）
2. 対象ディレクトリの作成
3. FSC、FSI、FSharp.Core等の主要バイナリのコピー
4. 強力な名前検証の無効化（管理者権限必要）
5. レジストリキーの追加（管理者権限必要）
6. NGENによるネイティブイメージ生成キュー登録（管理者権限必要）
7. バックアップからの復元（restoreモード）

**前後の処理との関連**：build.cmdまたはbuild vs/build vs debugでビルドが完了している必要があります。VSIX更新は別途VSIXInstaller.exeで行う必要があります。

**影響範囲**：システム全体のF# SDK共有ディレクトリ（Program Files配下）、レジストリ、強力な名前検証設定に影響します。すべてのVisual Studio 2017+インストールに影響があります。

## バッチ種別

開発環境セットアップ / デプロイメント

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（手動実行） |
| 実行時刻 | N/A |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | 手動実行（開発者による） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| F#コンパイラのビルド完了 | debug/releaseビルドが完了していること |
| Windows環境 | Visual Studio統合のためWindows必須 |
| 管理者権限（推奨） | 強力な名前検証、レジストリ、NGENに必要 |
| Windows SDK（sn.exe） | 強力な名前検証操作に必要 |

### 実行可否判定

ビルドディレクトリが存在しない場合、警告を出力してスキップします。管理者権限がない場合、一部の操作がスキップされます。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| mode | string | Yes | なし | debug/release/restore/backup のいずれか |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| debug/net40/bin | ディレクトリ | デバッグビルドのバイナリ |
| release/net40/bin | ディレクトリ | リリースビルドのバイナリ |
| vsintegration/src/SupportedRuntimes | ディレクトリ | SupportedRuntimes.xmlの格納場所 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| %ProgramFiles(x86)%\Microsoft SDKs\F#\4.3\Framework\v4.0 | ディレクトリ | コンパイラSDKデプロイ先 |
| %ProgramFiles(x86)%\Reference Assemblies\Microsoft\FSharp\.NETFramework\v4.0\4.4.3.0 | ディレクトリ | FSharp.Coreデプロイ先 |
| vsintegration\restore | ディレクトリ | バックアップ保存先 |
| 標準出力 | テキスト | 操作ログ |
| 終了コード | 整数 | 0:成功、1:失敗 |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | fsc.exe, fsi.exe, FSharp.Core.dll等 |
| 出力先 | システムSDKディレクトリ |
| 文字コード | N/A（バイナリ） |
| 区切り文字 | N/A |

## 処理フロー

### 処理シーケンス

```
1. モード判定
   └─ debug/release/restore/backupを判定
2. パス初期化
   └─ 各種ディレクトリパスを設定
3. 前提条件チェック
   └─ 管理者権限、Windows SDKの確認
4. ターゲットディレクトリ作成
   └─ SDK/参照アセンブリディレクトリを作成
5. compiler_sdkファイル処理
   └─ fsc.exe, fsi.exe, FSharp.Build.dll等をコピー
6. main_assembliesファイル処理
   └─ FSharp.Core.dll, FSharp.Core.xmlをコピー
7. 管理者権限操作（deploy時）
   └─ 7.1. レジストリキー追加
   └─ 7.2. 強力な名前検証無効化
   └─ 7.3. NGENキュー登録
8. 管理者権限操作（restore時）
   └─ 8.1. 強力な名前検証再有効化
   └─ 8.2. NGENキュー登録
9. サマリー表示
   └─ コピー数、エラー数、警告数を表示
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B{モード判定}
    B -->|debug/release| C[deploy=yes設定]
    B -->|restore| D[deploy=no、restore設定]
    B -->|backup| E[deploy=no、backup設定]
    B -->|その他| F[ヘルプ表示]
    C --> G[ディレクトリ作成]
    D --> G
    E --> G
    G --> H[compiler_sdkファイル処理]
    H --> I[main_assembliesファイル処理]
    I --> J{管理者権限?}
    J -->|あり| K[レジストリ/強力な名前/NGEN操作]
    J -->|なし| L[警告出力・スキップ]
    K --> M[サマリー表示]
    L --> M
    M --> N[バッチ終了]
```

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

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

このバッチはデータベース操作を行いませんが、レジストリ操作を行います。

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| N/A | N/A | N/A | データベース操作なし |

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

データベース操作はありません。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | ディレクトリ作成失敗 | 権限不足またはファイル名競合 | 管理者権限で実行 |
| 1 | ファイルコピー失敗 | ファイルが使用中または読み取り専用 | Visual Studioを終了して再実行 |
| N/A | 警告 | 管理者権限なし | 管理者として実行を推奨 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし（自動リトライなし） |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

### 障害時対応

1. Visual Studioを含む関連プロセスを終了
2. 管理者権限で再実行
3. backupモードで元の状態を確認
4. restoreモードで元の状態に復元

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | N/A（ファイルシステム操作） |
| コミットタイミング | N/A |
| ロールバック条件 | restoreモードで手動復元 |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 約15ファイル |
| 目標処理時間 | 1分以内 |
| メモリ使用量上限 | 最小限 |

## 排他制御

同時実行は推奨されません。同一ファイルへの同時書き込みで破損の可能性があります。Visual Studioが実行中の場合、ファイルがロックされている可能性があります。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | モード判定後 | "Starting deployment of {mode} bits" |
| 進捗ログ | 各ファイル処理時 | "[{mode}] source: {path}" |
| 結果ログ | 各ファイル処理後 | "1 file copied" または エラーメッセージ |
| 終了ログ | バッチ終了時 | コピー数、エラー数、警告数 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 終了コード | 1 | 手動確認（開発者） |
| エラー数 | 0より大 | 手動確認（開発者） |

## 備考

- このスクリプトはVisual Studio 2017のF# 4.3/4.5ターゲットを更新します
- VSIXの更新は別途VSIXInstaller.exeで行う必要があります
- 強力な名前検証の無効化は、Microsoft署名キーで署名されていないローカルビルドをシステムに登録するために必要です
- gitリポジトリのクリーンアップでバックアップディレクトリが削除される可能性があるため、重要なバックアップは外部に保存することを推奨します
- colorEcho関数でカラー出力を実現していますが、findstrを使用した特殊なテクニックです
- F#が複数のサイドバイサイドインストールをサポートした際には、この手順を変更する必要があります
