enh(syn): log first recovery attempt as error in the server

Signed-off-by: Jonas <jonas@freesources.org>

Author: mejo-

lib/Controller/PublicSessionController.php

@@ -78,8 +78,8 @@ public function close(int $documentId, int $sessionId, string $sessionToken): Da
 	#[PublicPage]
 	#[RequireDocumentBaseVersionEtag]
 	#[RequireDocumentSession]
-	public function push(int $documentId, int $sessionId, string $sessionToken, int $version, array $steps, string $awareness, string $token): DataResponse {
-		return $this->apiService->push($this->getSession(), $this->getDocument(), $version, $steps, $awareness, $token);
+	public function push(int $documentId, int $sessionId, string $sessionToken, int $version, array $steps, string $awareness, string $token, ?int $recoveryAttempt = null): DataResponse {
+		return $this->apiService->push($this->getSession(), $this->getDocument(), $version, $steps, $awareness, $recoveryAttempt, $token);
 	}
 
 	#[NoAdminRequired]

lib/Controller/SessionController.php

@@ -56,10 +56,10 @@ public function close(int $documentId, int $sessionId, string $sessionToken): Da
 	#[PublicPage]
 	#[RequireDocumentBaseVersionEtag]
 	#[RequireDocumentSession]
-	public function push(int $version, array $steps, string $awareness): DataResponse {
+	public function push(int $version, array $steps, string $awareness, ?int $recoveryAttempt = null): DataResponse {
 		try {
 			$this->loginSessionUser();
-			return $this->apiService->push($this->getSession(), $this->getDocument(), $version, $steps, $awareness);
+			return $this->apiService->push($this->getSession(), $this->getDocument(), $version, $steps, $awareness, $recoveryAttempt);
 		} finally {
 			$this->restoreSessionUser();
 		}

lib/Service/ApiService.php

@@ -174,15 +174,15 @@ public function close(int $documentId, int $sessionId, string $sessionToken): Da
 	/**
 	 * @throws NotFoundException
 	 */
-	public function push(Session $session, Document $document, int $version, array $steps, string $awareness, ?string $token = null): DataResponse {
+	public function push(Session $session, Document $document, int $version, array $steps, string $awareness, ?int $recoveryAttempt, ?string $token = null): DataResponse {
 		try {
 			$session = $this->sessionService->updateSessionAwareness($session, $awareness);
 		} catch (DoesNotExistException $e) {
 			// Session was removed in the meantime. #3875
 			return new DataResponse(['error' => $this->l10n->t('Editing session has expired. Please reload the page.')], Http::STATUS_PRECONDITION_FAILED);
 		}
 		try {
-			$result = $this->documentService->addStep($document, $session, $steps, $version, $token);
+			$result = $this->documentService->addStep($document, $session, $steps, $version, $recoveryAttempt, $token);
 			$this->addToPushQueue($document, [$awareness, ...array_values($steps)]);
 		} catch (InvalidArgumentException $e) {
 			return new DataResponse(['error' => $e->getMessage()], Http::STATUS_UNPROCESSABLE_ENTITY);

lib/Service/DocumentService.php

@@ -205,7 +205,7 @@ public function writeDocumentState(int $documentId, string $content): void {
 	 * @throws NotPermittedException
 	 * @throws DoesNotExistException
 	 */
-	public function addStep(Document $document, Session $session, array $steps, int $version, ?string $shareToken): array {
+	public function addStep(Document $document, Session $session, array $steps, int $version, ?int $recoveryAttempt, ?string $shareToken): array {
 		$documentId = $session->getDocumentId();
 		$readOnly = $this->isReadOnlyCached($session, $shareToken);
 		$stepsToInsert = [];
@@ -234,6 +234,11 @@ public function addStep(Document $document, Session $session, array $steps, int
 		// By default, send all steps the user has not received yet.
 		$getStepsSinceVersion = $version;
 		if ($stepsIncludeQuery) {
+			if ($recoveryAttempt === 1) {
+				$this->logger->error('Recovery attempt #' . $recoveryAttempt . ' from ' . $session->getId() . ' for ' . $documentId);
+			} elseif ($recoveryAttempt > 1) {
+				$this->logger->debug('Recovery attempt #' . $recoveryAttempt . ' from ' . $session->getId() . ' for ' . $documentId);
+			}
 			$this->logger->debug('Loading document state for ' . $documentId);
 			try {
 				$stateFile = $this->getStateFile($documentId);

src/apis/sync.ts

@@ -13,6 +13,7 @@ interface PushData {
 	version: number
 	steps: string[]
 	awareness: string
+	recoveryAttempt?: number
 }
 
 interface PushResponse {
@@ -44,6 +45,7 @@ export function push(
 		version: data.version,
 		steps: data.steps.filter((s) => s),
 		awareness: data.awareness,
+		recoveryAttempt: data.recoveryAttempt,
 	})
 }
 

src/helpers/yjs.ts

@@ -71,7 +71,7 @@ function documentStateToUpdateMessage(documentState: string): Uint8Array {
  * Only used in tests right now.
  * @param ydoc - encode state of this doc
  * @param step - step data
- * @param step.step - base64 encoded yjs sync update message
+ * @param step.data - array of base64 encoded yjs sync update messages
  * @param origin - initiator object e.g. WebsocketProvider
  */
 export function applyStep(ydoc: Y.Doc, step: Step, origin = 'origin') {