# 通知設計書 64-warnObservableStores

## 概要

本ドキュメントは、Nimコンパイラの警告メッセージ `warnObservableStores` の設計仕様を定義する。この警告は、例外が発生する可能性のあるコード実行後に、変数への書き込みが外部から観測可能である場合に出力される。

### 本通知の処理概要

この警告は、Cコード生成フェーズにおいて、関数呼び出しの結果を変数に格納する際、その関数が例外を発生させる可能性があり、かつ格納先の変数が外部から観測可能な位置にある場合に、開発者に通知する機能を提供する。

**業務上の目的・背景**：例外安全性の観点から、例外が発生する可能性のある関数呼び出しの結果を、try-except/finally外で参照される変数に直接格納することは危険である。例外発生時に変数が中間状態になり、後続のエラーハンドリングやファイナリゼーションコードで不正な値を参照する可能性がある。この警告により、開発者は例外安全性を損なう可能性のあるコードを認識し、適切なエラーハンドリング戦略を検討できる。

**通知の送信タイミング**：コンパイラのCコード生成フェーズ（`ccgcalls.nim`）で、関数呼び出しを含む代入が検出され、関数が例外を発生させる可能性があり、かつ代入先の変数が「エスケープ」する位置にある場合に警告が発生する。

**通知の受信者**：Nimコンパイラを使用してソースコードをコンパイルしている開発者。コンパイル時の警告メッセージとして標準エラー出力またはビルドログに表示される。

**通知内容の概要**：「observable stores to '変数名'」（'変数名'への観測可能なストア）というメッセージが出力される。

**期待されるアクション**：開発者は、一時変数を使用して結果を受け取り、成功確認後に目的の変数に代入するか、try-exceptブロックで適切にエラーハンドリングを行うことを検討する。

## 通知種別

コンパイラ警告メッセージ（stderr/ビルドログ出力）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（コンパイル処理中に即座に出力） |
| 優先度 | 中（Warning） |
| リトライ | 無（コンパイル時の一度きりの出力） |

### 送信先決定ロジック

警告は、コンパイラオプションで `warnObservableStores`（短縮形: `ObservableStores`）が有効になっている場合に出力される。ただし、**デフォルトでは無効**であり、明示的に有効化する必要がある（verbosity level 3でも除外される）。

## 通知テンプレート

### コンパイラ警告出力の場合

| 項目 | 内容 |
|-----|------|
| 出力先 | stderr |
| メッセージ種別 | Warning |
| 形式 | テキスト |

### 本文テンプレート

```
{ファイルパス}({行番号}, {カラム番号}) Warning: observable stores to '{変数名}' [ObservableStores]
```

### 添付ファイル

なし（コンパイラ出力のため）

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | 観測可能なストアの対象変数 | PNode（代入先） | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル処理 | 関数呼び出し結果の代入 | canRaise(ri[0])かつlocationEscapes | 例外発生可能な関数の結果を観測可能な変数に代入 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| --warning:ObservableStores:off | コマンドラインオプションで無効化（デフォルト状態） |
| {.warning[ObservableStores]:off.} | プラグマで無効化 |
| !canRaise(ri[0]) | 関数が例外を発生させない |
| !locationEscapes | 変数が外部から観測可能でない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[関数呼び出しの代入処理] --> B[potentialAlias関数呼び出し]
    B --> C{le != nil?}
    C -->|No| D[処理終了]
    C -->|Yes| E{canRaise(ri[0])?}
    E -->|No| D
    E -->|Yes| F{locationEscapes?}
    F -->|No| D
    F -->|Yes| G[message - warnObservableStores]
    G --> H[処理継続]
```

## データベース参照・更新仕様

本警告はコンパイラ内部処理であり、データベースは使用しない。

### 参照テーブル一覧

なし

### 更新テーブル一覧

なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 該当なし | 警告メッセージのため、エラーは発生しない | - |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | 制限なし |
| 1日あたり上限 | 制限なし |

### 配信時間帯

制限なし（コンパイル実行時に即座に出力）

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

この警告は、例外安全性に関わる潜在的な問題を開発者に通知するもの。観測可能なストアが原因で、例外発生時に不正なデータがエラーハンドリングコードに渡される可能性があり、セキュリティ上の脆弱性につながる場合がある。

## 備考

- この警告はデフォルトで無効であり、`--warning:ObservableStores:on`で明示的に有効化が必要
- verbosity level 3（最大詳細度）でも自動的には有効化されない
- 例外安全性を重視するプロジェクトでは有効化を検討すること
- `locationEscapes`は、変数がtry-except/finallyブロックの外部から参照可能かどうかを判定する

---

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

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

### 推奨読解順序

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

まず、警告メッセージの種別と関連する概念を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lineinfos.nim | `compiler/lineinfos.nim` | TMsgKind列挙型でwarnObservableStoresの定義（77行目）とメッセージテンプレート（186行目）を確認 |
| 1-2 | lineinfos.nim | `compiler/lineinfos.nim` | NotesVerbosity定義（265行目）でデフォルト無効であることを確認 |

**読解のコツ**: NotesVerbosityの計算ロジックで、`warnObservableStores`がverbosity level 3でも除外されていることに注目。

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

Cコード生成における警告出力の起点を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | ccgcalls.nim | `compiler/ccgcalls.nim` | potentialAlias関数（30-65行目付近）でエイリアス検出と警告出力を確認 |

**主要処理フロー**:
1. **51-54行目**: `if le != nil:`から条件チェック開始
2. **57-58行目**: `if canRaise(ri[0]) and locationEscapes(...)` - 例外発生可能性とエスケープチェック
3. **59行目**: `message(p.config, le.info, warnObservableStores, $le)` - 警告出力

#### Step 3: 補助関数を理解する

警告条件の判定に使用される補助関数を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | ccgcalls.nim | `compiler/ccgcalls.nim` | locationEscapes関数の実装を確認 |
| 3-2 | ccgcalls.nim | `compiler/ccgcalls.nim` | isHarmlessStore関数（69-77行目）を確認 |

**主要処理フロー**:
- **70-71行目**: `if d.k in {locTemp, locNone} or not canRaise:` - 一時変数または例外なしの場合は安全
- **72-73行目**: `elif d.k == locLocalVar and p.withinTryWithExcept == 0:` - ローカル変数でtry内でない場合も安全

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

```
ccgcalls.nim::genCall（関数呼び出し生成）
    │
    ├─ ccgcalls.nim::potentialAlias（エイリアス・観測可能ストア検出）
    │      │
    │      ├─ ast.nim::canRaise（例外発生可能性チェック）
    │      │
    │      ├─ ccgcalls.nim::locationEscapes（エスケープ判定）
    │      │
    │      └─ msgs.nim::message（警告出力 - warnObservableStores）
    │
    └─ 呼び出しコード生成継続
```

### データフロー図

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

関数呼び出しAST ───▶ potentialAlias
                          │
                          ▼
                 ┌─────────────────┐
                 │ canRaise検査     │
                 └────────┬────────┘
                          │Yes
                          ▼
                 ┌─────────────────────┐
                 │ locationEscapes検査  │
                 └──────────┬──────────┘
                            │Yes
                            ▼
                      message ───▶ stderr（警告出力）
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | TMsgKind定義とメッセージテンプレート、NotesVerbosity |
| ccgcalls.nim | `compiler/ccgcalls.nim` | ソース | 関数呼び出しCコード生成、potentialAlias関数 |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力関数 |
| ast.nim | `compiler/ast.nim` | ソース | canRaise関数 |
