> ## Documentation Index
> Fetch the complete documentation index at: https://ayakaleaf-pro.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Project History Sync State コレクション

`projectHistorySyncState` には再同期されたプロジェクトごとに 1 つのドキュメントがあり、現在または直近の再同期の状態を保持します。再同期とは、project-history が web と docstore の内容からプロジェクトの履歴を再構築することです。project-history が所有し、Mongoose スキーマはありません。コードは `services/project-history/app/js/SyncManager.js` の `SyncState` クラスとそのヘルパーです。

#### フィールド

| フィールド | 型 | 意味 | 出典 |
| - | - | - | - |
| `_id` | ObjectId | upsert によって作成されます。 | `SyncManager.js:233-237` |
| `project_id` | ObjectId | プロジェクト。 | `SyncManager.js:233-237` |
| `resyncProjectStructure` | Boolean | project-history が web からのプロジェクト構造（ファイルツリー）を待っている間は `true` です。 | `SyncManager.js:457`, `536-543` |
| `resyncDocContents` | Array of String | まだ内容を待っている doc のパス。 | `SyncManager.js:458`, `482`, `545-546` |
| `origin` | Object | 再同期を要求したもの。たとえばデフォルトの `{ kind: 'history-resync' }` です。 | `SyncManager.js:150`, `459` |
| `hardResync` | Boolean | ハード再同期では `true` です。ハード再同期はまずキュー内の更新と古い同期状態を破棄します。 | `SyncManager.js:81-100`, `152`, `460` |
| `recoverCorruptedFiles` | Boolean | 再同期リクエストのオプション（`HttpController.js:963-964`）。ハード再同期では、履歴の内容が破損した doc を削除し、docstore から再度追加します（`SyncManager.js:942-951`）。 | `SyncManager.js:153`, `461` |
| `history` | Array of Object | 直近 100 件の状態で、新しい順に並び、それぞれ `{ syncState, timestamp }` です。`syncState` には上の 5 つのフィールドが入ります。 | `SyncManager.js:41`, `202-208` |
| `lastUpdated` | Date | 最後の書き込み時刻。 | `SyncManager.js:209` |
| `resyncCount` | Number | 開始された再同期の回数。 | `SyncManager.js:215` |
| `resyncPendingSince` | Date | 実行中の再同期の開始時刻。完了すると削除されます。 | `SyncManager.js:217`, `224-225` |
| `expiresAt` | Date | 再同期完了の 90 日後に設定され、再同期の実行中は削除されます。TTL インデックスがこの時刻にドキュメントを削除します。 | `SyncManager.js:42`, `216`, `221-223` |
| `stuckClearCount` | Number | 停止した再同期がクリアされて再開された回数。再同期が完了すると削除されます。 | `SyncManager.js:261`, `226` |
| `lastStuckClearAt` | Date | 直近のそのようなクリアの時刻。 | `SyncManager.js:262`, `227` |
| `lastStuckDocPaths` | Array of String | 直近のクリア時点でまだ保留中だった doc のパス。 | `SyncManager.js:262`, `228` |

#### 書き込み元

| コード | 処理内容 |
| - | - |
| `services/project-history/app/js/SyncManager.js:195-249` | `setResyncState`：状態を upsert します。再同期の開始時（`SyncManager.js:163`）と、project-history が再同期の更新を処理している間（`services/project-history/app/js/UpdatesProcessor.js:637`, `784`）に呼び出されます。 |
| `SyncManager.js:257-266` | `_recordStuckClearInSyncState`：クリアされた停止中の再同期を数えます。 |
| `SyncManager.js:251-255` | `clearResyncState`：ドキュメントを削除します。ハード再同期の開始時（`SyncManager.js:87`）、project-history の `DELETE /project/:project_id`（`services/project-history/app/js/HttpController.js:1363-1396`）、構造のみの再同期をやり直す必要があるとき（`SyncManager.js:705-716`）に実行されます。 |
| `SyncManager.js:273-289` | `clearResyncStateIfAllAfter`：履歴がすべてある日付より新しい完了済みの状態を削除します。`app/js` でこれを呼ぶものはありません。 |
| `SyncManager.js:171-181` | `cloneResyncState`：project-history の `POST /project/:project_id/clone`（`HttpController.js:57`, `124`）のために状態を別のプロジェクトにコピーします。web でこれを呼ぶものはありません。 |

再同期は、project-history の `POST /project/:project_id/resync`（`HttpController.js:950-994`）、リトライ用の cron ジョブ（`services/project-history/app/js/RetryManager.js:156-179`, `server-ce/config/crontab-history`）、および更新の処理で必要になったときの project-history 自身（`UpdatesProcessor.js:75`, `224`）によって開始されます。

#### 読み取り元

| コード | 処理内容 |
| - | - |
| `SyncManager.js:187-193` | `getResyncState`：状態を読み込みます。新しい再同期を始める前に実行中かどうかを判断するため（`SyncManager.js:106-149`）、実行中に通常の更新をスキップするため（`SyncManager.js:291-300`）、フラッシュ後に実行中の再同期を報告するため（`UpdatesProcessor.js:463-466`）に使われます。 |
| `HttpController.js:533-545` | `GET /project/:project_id/resync-pending`：再同期が実行中か停止しているか。 |
| `HttpController.js:563-585` | `GET /project/:project_id/debug-info`：同期状態と失敗レコード。 |

#### インデックス

| 名前 | キー | オプション | マイグレーション |
| - | - | - | - |
| `project_id_1` | `{ project_id: 1 }` | | `tools/migrations/20190912145021_create_projectHistorySyncState_indexes.mjs` |
| `expiresAt_1` | `{ expiresAt: 1 }` | TTL、`expireAfterSeconds: 0` | `tools/migrations/20190912145021_create_projectHistorySyncState_indexes.mjs` |

#### 補足

* `resyncProjectStructure` が `true` であるか、`resyncDocContents` が空でない間は、再同期が実行中です（`SyncManager.js:565-567`）。4 時間を過ぎると停止とみなされ、5 回クリアされると恒久的に停止とみなされます（`SyncManager.js:43-44`, `569-585`）。
* 再同期が完了すると、project-history はプロジェクトに `overleaf.history.lastResyncedAt` も設定します（`SyncManager.js:239-248`）。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.