feat: Adapt a bit the snowflake ids API

CarlSchwan · CarlSchwan · commit 7c1a8a406041 · 2026-01-06T12:57:17.000+01:00
- Rename setId() -&gt; generateId() in SnowflakeAwareEntity

Signed-off-by: Carl Schwan &lt;carlschwan@kde.org&gt;
diff --git a/apps/federatedfilesharing/lib/OCM/CloudFederationProviderFiles.php b/apps/federatedfilesharing/lib/OCM/CloudFederationProviderFiles.php
@@ -143,7 +143,7 @@ public function shareReceived(ICloudFederationShare $share): string {
 			}
 
 			$externalShare = new ExternalShare();
-			$externalShare->setId();
+			$externalShare->generateId();
 			$externalShare->setRemote($remote);
 			$externalShare->setRemoteId($remoteId);
 			$externalShare->setShareToken($token);
diff --git a/apps/files_sharing/lib/External/ExternalShare.php b/apps/files_sharing/lib/External/ExternalShare.php
@@ -105,6 +105,13 @@ public function jsonSerialize(): array {
 			'user' => $this->getUser(),
 			'mountpoint' => $this->getMountpoint(),
 			'accepted' => $this->getAccepted(),
+
+			// Added later on
+			'file_id' => null,
+			'mimetype' => null,
+			'permissions' => null,
+			'mtime' => null,
+			'type' => null,
 		];
 	}
 
diff --git a/apps/files_sharing/lib/External/Manager.php b/apps/files_sharing/lib/External/Manager.php
@@ -184,7 +184,7 @@ private function updateSubShare(ExternalShare $externalShare, IUser $user, ?stri
 				$subShare = $this->externalShareMapper->getUserShare($externalShare, $user);
 			} catch (DoesNotExistException) {
 				$subShare = new ExternalShare();
-				$subShare->setId();
+				$subShare->generateId();
 				$subShare->setRemote($externalShare->getRemote());
 				$subShare->setPassword($externalShare->getPassword());
 				$subShare->setName($externalShare->getName());
diff --git a/apps/files_sharing/lib/ResponseDefinitions.php b/apps/files_sharing/lib/ResponseDefinitions.php
@@ -82,21 +82,21 @@
  *
  * @psalm-type Files_SharingRemoteShare = array{
  *     accepted: int,
+ *     file_id: int|null,
  *     id: string,
+ *     mimetype: string|null,
  *     mountpoint: string,
+ *     mtime: int|null,
  *     name: string,
  *     owner: string,
  *     parent: string|null,
+ *     permissions: int|null,
  *     remote: string,
  *     remote_id: string,
  *     share_token: string,
  *     share_type: int,
+ *     type: string|null,
  *     user: string,
- *     file_id?: int,
- *     mimetype?: string,
- *     permissions?: int,
- *     mtime?: int,
- *     type?: string,
  * }
  *
  * @psalm-type Files_SharingSharee = array{
diff --git a/apps/files_sharing/tests/Command/CleanupRemoteStoragesTest.php b/apps/files_sharing/tests/Command/CleanupRemoteStoragesTest.php
@@ -63,7 +63,7 @@ protected function setUp(): void {
 
 			if (isset($storage['share_token'])) {
 				$externalShare = new ExternalShare();
-				$externalShare->setId();
+				$externalShare->generateId();
 				$externalShare->setShareToken($storage['share_token']);
 				$externalShare->setRemote($storage['remote']);
 				$externalShare->setName('irrelevant');
diff --git a/apps/files_sharing/tests/External/ManagerTest.php b/apps/files_sharing/tests/External/ManagerTest.php
@@ -188,7 +188,7 @@ private function clearMounts(): void {
 
 	public function testAddUserShare(): void {
 		$userShare = new ExternalShare();
-		$userShare->setId();
+		$userShare->generateId();
 		$userShare->setRemote('http://localhost');
 		$userShare->setShareToken('token1');
 		$userShare->setPassword('');
@@ -203,7 +203,7 @@ public function testAddUserShare(): void {
 
 	public function testAddGroupShare(): void {
 		$groupShare = new ExternalShare();
-		$groupShare->setId();
+		$groupShare->generateId();
 		$groupShare->setRemote('http://localhost');
 		$groupShare->setOwner('foobar');
 		$groupShare->setShareType(IShare::TYPE_GROUP);
@@ -235,10 +235,10 @@ public function doTestAddShare(ExternalShare $shareData1, IUser|IGroup $userOrGr
 
 		$shareData2 = $shareData1->clone();
 		$shareData2->setShareToken('token2');
-		$shareData2->setId();
+		$shareData2->generateId();
 		$shareData3 = $shareData1->clone();
 		$shareData3->setShareToken('token3');
-		$shareData3->setId();
+		$shareData3->generateId();
 
 		$this->setupMounts();
 		$this->assertNotMount('SharedFolder');
@@ -438,7 +438,7 @@ private function createTestUserShare(string $userId = 'user1'): ExternalShare {
 		$user = $this->createMock(IUser::class);
 		$user->expects($this->any())->method('getUID')->willReturn($userId);
 		$share = new ExternalShare();
-		$share->setId();
+		$share->generateId();
 		$share->setRemote('http://localhost');
 		$share->setShareToken('token1');
 		$share->setPassword('');
@@ -458,7 +458,7 @@ private function createTestUserShare(string $userId = 'user1'): ExternalShare {
 	 */
 	private function createTestGroupShare(string $groupId = 'group1'): array {
 		$share = new ExternalShare();
-		$share->setId();
+		$share->generateId();
 		$share->setRemote('http://localhost');
 		$share->setShareToken('token1');
 		$share->setPassword('');
@@ -644,7 +644,7 @@ public function testDeleteUserShares(): void {
 		// user 2 shares
 		$manager2 = $this->createManagerForUser($user2);
 		$share = new ExternalShare();
-		$share->setId();
+		$share->generateId();
 		$share->setRemote('http://localhost');
 		$share->setShareToken('token1');
 		$share->setPassword('');
@@ -694,7 +694,7 @@ public function testDeleteGroupShares(): void {
 		$manager2 = $this->createManagerForUser($user);
 
 		$share = new ExternalShare();
-		$share->setId();
+		$share->generateId();
 		$share->setRemote('http://localhost');
 		$share->setShareToken('token1');
 		$share->setPassword('');
diff --git a/core/BackgroundJobs/MovePreviewJob.php b/core/BackgroundJobs/MovePreviewJob.php
@@ -136,7 +136,7 @@ private function processPreviews(int $fileId, bool $flatPath): void {
 			$path = $fileId . '/' . $previewFile->getName();
 			/** @var SimpleFile $previewFile */
 			$preview = Preview::fromPath($path, $this->mimeTypeDetector);
-			$preview->setId();
+			$preview->generateId();
 			if (!$preview) {
 				$this->logger->error('Unable to import old preview at path.');
 				continue;
@@ -170,7 +170,7 @@ private function processPreviews(int $fileId, bool $flatPath): void {
 				$preview->setStorageId($result[0]['storage']);
 				$preview->setEtag($result[0]['etag']);
 				$preview->setSourceMimeType($this->mimeTypeLoader->getMimetypeById((int)$result[0]['mimetype']));
-				$preview->setId();
+				$preview->generateId();
 				try {
 					$preview = $this->previewMapper->insert($preview);
 				} catch (Exception) {
diff --git a/lib/private/Authentication/Token/PublicKeyToken.php b/lib/private/Authentication/Token/PublicKeyToken.php
@@ -101,6 +101,10 @@ public function __construct() {
 		$this->addType('passwordInvalid', Types::BOOLEAN);
 	}
 
+	public function getId(): int {
+		return (int)$this->id;
+	}
+
 	public function getUID(): string {
 		return $this->uid;
 	}
@@ -123,7 +127,7 @@ public function getPassword(): ?string {
 
 	public function jsonSerialize(): array {
 		return [
-			'id' => $this->getId(),
+			'id' => $this->id,
 			'name' => $this->name,
 			'lastActivity' => $this->lastActivity,
 			'type' => $this->type,
diff --git a/lib/private/Preview/Generator.php b/lib/private/Preview/Generator.php
@@ -348,7 +348,7 @@ private function generateProviderPreview(File $file, int $width, int $height, bo
 
 				try {
 					$previewEntry = new Preview();
-					$previewEntry->setId();
+					$previewEntry->generateId();
 					$previewEntry->setFileId($file->getId());
 					$previewEntry->setStorageId($file->getMountPoint()->getNumericStorageId());
 					$previewEntry->setSourceMimeType($file->getMimeType());
@@ -502,7 +502,7 @@ private function generatePreview(
 		}
 
 		$previewEntry = new Preview();
-		$previewEntry->setId();
+		$previewEntry->generateId();
 		$previewEntry->setFileId($file->getId());
 		$previewEntry->setStorageId($file->getMountPoint()->getNumericStorageId());
 		$previewEntry->setWidth($width);
@@ -543,7 +543,7 @@ public function savePreview(Preview $previewEntry, IImage $preview): Preview {
 			throw new \RuntimeException('Unable to write preview file');
 		}
 		$previewEntry->setSize($size);
-		$previewEntry->setId();
+		$previewEntry->generateId();
 		return $this->previewMapper->insert($previewEntry);
 	}
 }
diff --git a/lib/private/Preview/Storage/LocalPreviewStorage.php b/lib/private/Preview/Storage/LocalPreviewStorage.php
@@ -120,7 +120,7 @@ public function scan(): int {
 					$this->logger->error('Unable to parse preview information for ' . $file->getRealPath());
 					continue;
 				}
-				$preview->setId();
+				$preview->generateId();
 				try {
 					$preview->setSize($file->getSize());
 					$preview->setMtime($file->getMtime());
@@ -154,7 +154,7 @@ public function scan(): int {
 					$preview->setStorageId($result[0]['storage']);
 					$preview->setEtag($result[0]['etag']);
 					$preview->setSourceMimetype($result[0]['mimetype']);
-					$preview->setId();
+					$preview->generateId();
 					// try to insert, if that fails the preview is already in the DB
 					$this->previewMapper->insert($preview);
 
diff --git a/lib/public/AppFramework/Db/Entity.php b/lib/public/AppFramework/Db/Entity.php
@@ -13,23 +13,17 @@
 use function substr;
 
 /**
+ * @method int getId()
+ * @method void setId(int $id)
  * @since 7.0.0
  * @psalm-consistent-constructor
  */
 abstract class Entity {
-	private ?int $id = null;
+	public int|string|null $id = null;
 	private array $_updatedFields = [];
 	/** @psalm-param $_fieldTypes array<string, Types::*> */
 	private array $_fieldTypes = ['id' => 'integer'];
 
-	public function setId($id): void {
-		$this->id = $id;
-	}
-
-	public function getId(): ?int {
-		return $this->id;
-	}
-
 	/**
 	 * Simple alternative constructor for building entities from a request
 	 * @param array $params the array which was obtained via $this->params('key')
@@ -47,7 +41,6 @@ public static function fromParams(array $params): static {
 		return $instance;
 	}
 
-
 	/**
 	 * Maps the keys of the row array to the attributes
 	 * @param array $row the row to map onto the entity
diff --git a/lib/public/AppFramework/Db/QBMapper.php b/lib/public/AppFramework/Db/QBMapper.php
@@ -114,7 +114,7 @@ public function insert(Entity $entity): Entity {
 
 		if ($entity instanceof SnowflakeAwareEntity) {
 			/** @psalm-suppress DocblockTypeContradiction */
-			$entity->setId();
+			$entity->generateId();
 			$qb->executeStatement();
 		} elseif ($entity->getId() === null) {
 			$qb->executeStatement();
diff --git a/lib/public/AppFramework/Db/SnowflakeAwareEntity.php b/lib/public/AppFramework/Db/SnowflakeAwareEntity.php
@@ -16,22 +16,24 @@
 
 /**
  * Entity with snowflake support
- *
+ * @method string getId()
  * @since 33.0.0
  */
 #[Consumable(since: '33.0.0')]
 abstract class SnowflakeAwareEntity extends Entity {
-	private ?string $id = null;
 	protected ?Snowflake $snowflake = null;
 
 	/** @psalm-param $_fieldTypes array<string, Types::*> */
 	private array $_fieldTypes = ['id' => Types::STRING];
 
+	public function setId($id): void {
+		throw new \LogicException('Use generated id to set a new id to the Snowflake aware entity.');
+	}
+
 	/**
 	 * Automatically creates a snowflake ID
 	 */
-	#[\Override]
-	public function setId($id = null): void {
+	public function generateId(): void {
 		if ($this->id === null) {
 			$this->id = Server::get(ISnowflakeGenerator::class)->nextId();
 			$this->markFieldUpdated('id');
diff --git a/lib/public/Authentication/Token/IToken.php b/lib/public/Authentication/Token/IToken.php
@@ -47,7 +47,7 @@ interface IToken extends JsonSerializable {
 	 * Get the token ID
 	 * @since 28.0.0
 	 */
-	public function getId(): ?int;
+	public function getId(): int;
 
 	/**
 	 * Get the user UID
diff --git a/tests/lib/Preview/MovePreviewJobTest.php b/tests/lib/Preview/MovePreviewJobTest.php
@@ -24,7 +24,6 @@
 use OCP\IConfig;
 use OCP\IDBConnection;
 use OCP\Server;
-use OCP\Snowflake\ISnowflakeGenerator;
 use PHPUnit\Framework\Attributes\TestDox;
 use PHPUnit\Framework\MockObject\MockObject;
 use Psr\Log\LoggerInterface;
@@ -124,7 +123,6 @@ public function testMigrationLegacyPath(): void {
 			$this->mimeTypeDetector,
 			$this->mimeTypeLoader,
 			$this->logger,
-			Server::get(ISnowflakeGenerator::class),
 			Server::get(IAppDataFactory::class),
 		);
 		$this->invokePrivate($job, 'run', [[]]);
@@ -157,7 +155,6 @@ public function testMigrationPath(): void {
 			$this->mimeTypeDetector,
 			$this->mimeTypeLoader,
 			$this->logger,
-			Server::get(ISnowflakeGenerator::class),
 			Server::get(IAppDataFactory::class)
 		);
 		$this->invokePrivate($job, 'run', [[]]);
@@ -198,7 +195,6 @@ public function testMigrationPathWithVersion(): void {
 			$this->mimeTypeDetector,
 			$this->mimeTypeLoader,
 			$this->logger,
-			Server::get(ISnowflakeGenerator::class),
 			Server::get(IAppDataFactory::class)
 		);
 		$this->invokePrivate($job, 'run', [[]]);
diff --git a/tests/lib/Preview/PreviewMapperTest.php b/tests/lib/Preview/PreviewMapperTest.php
@@ -79,7 +79,7 @@ private function createPreviewForFileId(int $fileId, ?int $bucket = null): void
 			$qb->executeStatement();
 		}
 		$preview = new Preview();
-		$preview->setId();
+		$preview->generateId();
 		$preview->setFileId($fileId);
 		$preview->setStorageId(1);
 		$preview->setCropped(true);
diff --git a/tests/lib/Preview/PreviewServiceTest.php b/tests/lib/Preview/PreviewServiceTest.php
@@ -37,6 +37,7 @@ public function tearDown(): void {
 	public function testGetAvailableFileIds(): void {
 		foreach (range(1, 20) as $i) {
 			$preview = new Preview();
+			$preview->generateId();
 			$preview->setFileId($i % 10);
 			$preview->setStorageId(1);
 			$preview->setWidth($i);

Original file line number	Diff line number	Diff line change
`@@ -143,7 +143,7 @@ public function shareReceived(ICloudFederationShare $share): string {`
`143`	`143`	`}`
`144`	`144`
`145`	`145`	`$externalShare = new ExternalShare();`
`146`		`- $externalShare->setId();`
	`146`	`+ $externalShare->generateId();`
`147`	`147`	`$externalShare->setRemote($remote);`
`148`	`148`	`$externalShare->setRemoteId($remoteId);`
`149`	`149`	`$externalShare->setShareToken($token);`
Original file line number	Diff line number	Diff line change
`@@ -348,7 +348,7 @@ private function generateProviderPreview(File $file, int $width, int $height, bo`
`348`	`348`
`349`	`349`	`try {`
`350`	`350`	`$previewEntry = new Preview();`
`351`		`- $previewEntry->setId();`
	`351`	`+ $previewEntry->generateId();`
`352`	`352`	`$previewEntry->setFileId($file->getId());`
`353`	`353`	`$previewEntry->setStorageId($file->getMountPoint()->getNumericStorageId());`
`354`	`354`	`$previewEntry->setSourceMimeType($file->getMimeType());`
`@@ -502,7 +502,7 @@ private function generatePreview(`
`502`	`502`	`}`
`503`	`503`
`504`	`504`	`$previewEntry = new Preview();`
`505`		`- $previewEntry->setId();`
	`505`	`+ $previewEntry->generateId();`
`506`	`506`	`$previewEntry->setFileId($file->getId());`
`507`	`507`	`$previewEntry->setStorageId($file->getMountPoint()->getNumericStorageId());`
`508`	`508`	`$previewEntry->setWidth($width);`
`@@ -543,7 +543,7 @@ public function savePreview(Preview $previewEntry, IImage $preview): Preview {`
`543`	`543`	`throw new \RuntimeException('Unable to write preview file');`
`544`	`544`	`}`
`545`	`545`	`$previewEntry->setSize($size);`
`546`		`- $previewEntry->setId();`
	`546`	`+ $previewEntry->generateId();`
`547`	`547`	`return $this->previewMapper->insert($previewEntry);`
`548`	`548`	`}`
`549`	`549`	`}`