# 機能設計書 3-シャットダウン (shutdown)

## 概要

本ドキュメントは、lua-language-serverにおけるLSPシャットダウン機能の設計を記載したものである。クライアントからの`shutdown`リクエストを受信し、サーバーの終了準備を行う。

### 本機能の処理概要

**業務上の目的・背景**：LSPプロトコルでは、サーバーの終了前に`shutdown`リクエストと`exit`通知の2段階の手順が定義されている。`shutdown`リクエストはサーバーに終了準備を指示し、リソースのクリーンアップを行う機会を提供する。このプロトコルにより、サーバーは安全に終了でき、データの損失やリソースリークを防止する。

**機能の利用シーン**：エディタを閉じる時、またはLSPサーバーを明示的に停止する時に自動的に呼び出される。ユーザーがエディタを閉じる操作を行った際にバックグラウンドで実行される。

**主要な処理内容**：
1. シャットダウンリクエストの受信
2. ログ出力（"Server shutdown."）
3. 成功レスポンス（true）の返却
4. 以降のリクエストに対しては`InvalidRequest`エラーを返却（LSP仕様）

**関連システム・外部連携**：LSPクライアント（VSCode、Neovim等）

**権限による制御**：特になし

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | - | - | 本機能は直接的な画面表示を持たない |

## 機能種別

サーバーライフサイクル管理 / 終了準備

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| - | - | - | パラメータなし | - |

### 入力データソース

LSPクライアントからのJSON-RPCリクエスト

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| (戻り値) | null | LSP仕様ではnullを返却（実装ではtrue） |

### 出力先

LSPクライアントへのJSON-RPCレスポンス

## 処理フロー

### 処理シーケンス

```
1. shutdownリクエストの受信
   └─ JSON-RPCでクライアントからリクエストを受信

2. ログ出力
   └─ log.info('Server shutdown.')を実行

3. レスポンスの返却
   └─ trueを返却
```

### フローチャート

```mermaid
flowchart TD
    A[shutdownリクエスト受信] --> B[ログ出力]
    B --> C[trueを返却]
    C --> D[exitを待機]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | shutdown後の動作 | shutdown後はexit通知のみ受け付ける | shutdown実行後 |
| BR-002 | 終了順序 | shutdownの後にexitを呼び出す必要がある | サーバー終了時 |

### 計算ロジック

特になし

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

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

本機能はデータベースを使用しない

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| -32600 | InvalidRequest | shutdown後に他のリクエストを受信 | エラーレスポンスを返却 |

### リトライ仕様

リトライ不要

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

トランザクション管理なし

## パフォーマンス要件

即座に応答すること

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

特になし

## 備考

- LSP仕様では`shutdown`後は`exit`通知のみ受け付ける
- 現在の実装は最小限のログ出力のみ

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | provider.lua | `script/provider/provider.lua` | `m.register 'shutdown'`でハンドラを登録 |

**主要処理フロー**:
1. **174-179行目**: `shutdown`ハンドラの定義
2. **176行目**: `log.info('Server shutdown.')`でログ出力
3. **177行目**: `return true`で成功レスポンス返却

**読解のコツ**: この実装は非常にシンプルで、主にログ出力とレスポンス返却のみ。LSP仕様に従い、shutdown後の状態管理は別途実装されている。

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

```
m.register 'shutdown' (provider.lua:174-179)
    |
    +-- log.info('Server shutdown.')
    |       └─ ログファイルに出力
    |
    +-- return true
            └─ クライアントにレスポンス返却
```

### データフロー図

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

(パラメータなし) ──────> provider.lua                      true (null)
                         m.register 'shutdown'
                         |
                         +-- log.info()
                         |     (ログ出力)
                         |
                         +-- return true
                               (レスポンス返却)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| provider.lua | `script/provider/provider.lua` | ソース | LSPリクエストハンドラの登録・実行 |
| proto.lua | `script/proto/proto.lua` | ソース | LSPプロトコル通信処理 |
| log.lua | `script/log.lua` | ソース | ログ出力機能 |
