> ## 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` содержит один документ на каждый проект, который проходил ресинхронизацию: состояние текущей или последней ресинхронизации, при которой project-history заново строит историю проекта по тому, что хранят web и docstore. Коллекция принадлежит project-history и не имеет схемы Mongoose; код находится в классе `SyncState` и его вспомогательных функциях в `services/project-history/app/js/SyncManager.js`.

#### Поля

| Поле | Тип | Значение | Источник |
| - | - | - | - |
| `_id` | ObjectId | Создаётся при upsert. | `SyncManager.js:233-237` |
| `project_id` | ObjectId | Проект. | `SyncManager.js:233-237` |
| `resyncProjectStructure` | Boolean | `true`, пока project-history ждёт от web структуру проекта (дерево файлов). | `SyncManager.js:457`, `536-543` |
| `resyncDocContents` | Array of String | Пути docs, содержимое которых он ещё ждёт. | `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` содержит пять полей выше. | `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 | Пути docs, которые ещё ожидали обработки при последнем сбросе. | `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`), при `DELETE /project/:project_id` в project-history (`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`: копирует состояние в другой проект для `POST /project/:project_id/clone` в project-history (`HttpController.js:57`, `124`), который ничто в web не вызывает. |

Ресинхронизацию запускают `POST /project/:project_id/resync` в project-history (`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.