feat(db): Add timestamp field to steps database

This should help with debugging document session issues in the future.

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

appinfo/info.xml

@@ -11,7 +11,7 @@
 - **💾 Open format:** Files are saved as [Markdown](https://en.wikipedia.org/wiki/Markdown), so you can edit them from any other text app too.
 - **✊ Strong foundation:** We use [🐈 tiptap](https://tiptap.scrumpy.io) which is based on [🦉 ProseMirror](https://prosemirror.net) – huge thanks to them!
 	]]></description>
-	<version>4.0.0</version>
+	<version>4.1.0</version>
 	<licence>agpl</licence>
 	<author mail="jus@bitgrid.net">Julius Härtl</author>
 	<namespace>Text</namespace>

composer/composer/autoload_classmap.php

@@ -59,6 +59,7 @@
     'OCA\\Text\\Migration\\Version030501Date20220202101853' => $baseDir . '/../lib/Migration/Version030501Date20220202101853.php',
     'OCA\\Text\\Migration\\Version030701Date20230207131313' => $baseDir . '/../lib/Migration/Version030701Date20230207131313.php',
     'OCA\\Text\\Migration\\Version030901Date20231114150437' => $baseDir . '/../lib/Migration/Version030901Date20231114150437.php',
+    'OCA\\Text\\Migration\\Version040100Date20240611165300' => $baseDir . '/../lib/Migration/Version040100Date20240611165300.php',
     'OCA\\Text\\Notification\\Notifier' => $baseDir . '/../lib/Notification/Notifier.php',
     'OCA\\Text\\Service\\ApiService' => $baseDir . '/../lib/Service/ApiService.php',
     'OCA\\Text\\Service\\AttachmentService' => $baseDir . '/../lib/Service/AttachmentService.php',

composer/composer/autoload_static.php

@@ -74,6 +74,7 @@ class ComposerStaticInitText
         'OCA\\Text\\Migration\\Version030501Date20220202101853' => __DIR__ . '/..' . '/../lib/Migration/Version030501Date20220202101853.php',
         'OCA\\Text\\Migration\\Version030701Date20230207131313' => __DIR__ . '/..' . '/../lib/Migration/Version030701Date20230207131313.php',
         'OCA\\Text\\Migration\\Version030901Date20231114150437' => __DIR__ . '/..' . '/../lib/Migration/Version030901Date20231114150437.php',
+        'OCA\\Text\\Migration\\Version040100Date20240611165300' => __DIR__ . '/..' . '/../lib/Migration/Version040100Date20240611165300.php',
         'OCA\\Text\\Notification\\Notifier' => __DIR__ . '/..' . '/../lib/Notification/Notifier.php',
         'OCA\\Text\\Service\\ApiService' => __DIR__ . '/..' . '/../lib/Service/ApiService.php',
         'OCA\\Text\\Service\\AttachmentService' => __DIR__ . '/..' . '/../lib/Service/AttachmentService.php',

lib/Db/Step.php

@@ -35,6 +35,8 @@
  * @method setSessionId(int $sessionId): void
  * @method getDocumentId(): int
  * @method setDocumentId(int $documentId): void
+ * @method getTimestamp(): int
+ * @method setTimestamp(int $timestam): void
  */
 class Step extends Entity implements JsonSerializable {
 
@@ -50,12 +52,14 @@ class Step extends Entity implements JsonSerializable {
 	protected int $version = 0;
 	protected int $sessionId = 0;
 	protected int $documentId = 0;
+	protected int $timestamp = 0;
 
 	public function __construct() {
 		$this->addType('id', 'integer');
 		$this->addType('version', 'integer');
 		$this->addType('documentId', 'integer');
 		$this->addType('sessionId', 'integer');
+		$this->addType('timestamp', 'integer');
 	}
 
 	public function jsonSerialize(): array {
@@ -70,7 +74,8 @@ public function jsonSerialize(): array {
 			'id' => $this->getId(),
 			'data' => $jsonData,
 			'version' => $version,
-			'sessionId' => $this->getSessionId()
+			'sessionId' => $this->getSessionId(),
+			'timestamp' => $this->getTimestamp(),
 		];
 	}
 }

lib/Migration/Version040100Date20240611165300.php

@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2024 Jonas <jonas@freesources.org>
+ *
+ * @author Jonas <jonas@freesources.org>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCA\Text\Migration;
+
+use Closure;
+use OCP\DB\ISchemaWrapper;
+use OCP\DB\Types;
+use OCP\Migration\IOutput;
+use OCP\Migration\SimpleMigrationStep;
+
+class Version040100Date20240611165300 extends SimpleMigrationStep {
+	public function changeSchema(IOutput $output, Closure $schemaClosure, array $options): ?ISchemaWrapper {
+		/** @var ISchemaWrapper $schema */
+		$schema = $schemaClosure();
+
+		if ($schema->hasTable('text_steps')) {
+			$table = $schema->getTable('text_steps');
+			if (!$table->hasColumn('timestamp')) {
+				$table->addColumn('timestamp', Types::BIGINT, [
+					'notnull' => true,
+					'length' => 6,
+					'default' => 0,
+				]);
+				return $schema;
+			}
+		}
+		return null;
+	}
+}

lib/Service/DocumentService.php

@@ -276,6 +276,7 @@ private function insertSteps(Document $document, Session $session, array $steps)
 			$step->setSessionId($session->getId());
 			$step->setDocumentId($document->getId());
 			$step->setVersion(Step::VERSION_STORED_IN_ID);
+			$step->setTimestamp(time());
 			$step = $this->stepMapper->insert($step);
 			$newVersion = $step->getId();
 			$this->logger->debug("Adding steps to " . $document->getId() . ": bumping version from $stepsVersion to $newVersion");