Merge pull request #56795 from nextcloud/feat/noid/extend-entity-to-be-snoflake-aware

feat(snowflake): extend Entity class to support snowflakes

Author: nickvergessen

apps/federatedfilesharing/lib/OCM/CloudFederationProviderFiles.php

@@ -44,7 +44,6 @@
 use OCP\Share\IManager;
 use OCP\Share\IProviderFactory;
 use OCP\Share\IShare;
-use OCP\Snowflake\IGenerator;
 use OCP\Util;
 use Override;
 use Psr\Log\LoggerInterface;
@@ -70,7 +69,6 @@ public function __construct(
 		private readonly IFilenameValidator $filenameValidator,
 		private readonly IProviderFactory $shareProviderFactory,
 		private readonly SetupManager $setupManager,
-		private readonly IGenerator $snowflakeGenerator,
 		private readonly ExternalShareMapper $externalShareMapper,
 	) {
 	}
@@ -145,7 +143,7 @@ public function shareReceived(ICloudFederationShare $share): string {
 			}
 
 			$externalShare = new ExternalShare();
-			$externalShare->setId($this->snowflakeGenerator->nextId());
+			$externalShare->generateId();
 			$externalShare->setRemote($remote);
 			$externalShare->setRemoteId($remoteId);
 			$externalShare->setShareToken($token);
@@ -177,9 +175,9 @@ public function shareReceived(ICloudFederationShare $share): string {
 						->setType('remote_share')
 						->setSubject(RemoteShares::SUBJECT_REMOTE_SHARE_RECEIVED, [$ownerFederatedId, trim($name, '/'), $ownerDisplayName])
 						->setAffectedUser($shareWith)
-						->setObject('remote_share', $externalShare->getId(), $name);
+						->setObject('remote_share', (string)$externalShare->getId(), $name);
 					Server::get(IActivityManager::class)->publish($event);
-					$this->notifyAboutNewShare($shareWith, $externalShare->getId(), $ownerFederatedId, $sharedByFederatedId, $name, $ownerDisplayName);
+					$this->notifyAboutNewShare($shareWith, (string)$externalShare->getId(), $ownerFederatedId, $sharedByFederatedId, $name, $ownerDisplayName);
 
 					// If auto-accept is enabled, accept the share
 					if ($this->federatedShareProvider->isFederatedTrustedShareAutoAccept() && $trustedServers?->isTrustedServer($remote) === true) {
@@ -193,9 +191,9 @@ public function shareReceived(ICloudFederationShare $share): string {
 							->setType('remote_share')
 							->setSubject(RemoteShares::SUBJECT_REMOTE_SHARE_RECEIVED, [$ownerFederatedId, trim($name, '/'), $ownerDisplayName])
 							->setAffectedUser($user->getUID())
-							->setObject('remote_share', $externalShare->getId(), $name);
+							->setObject('remote_share', (string)$externalShare->getId(), $name);
 						Server::get(IActivityManager::class)->publish($event);
-						$this->notifyAboutNewShare($user->getUID(), $externalShare->getId(), $ownerFederatedId, $sharedByFederatedId, $name, $ownerDisplayName);
+						$this->notifyAboutNewShare($user->getUID(), (string)$externalShare->getId(), $ownerFederatedId, $sharedByFederatedId, $name, $ownerDisplayName);
 
 						// If auto-accept is enabled, accept the share
 						if ($this->federatedShareProvider->isFederatedTrustedShareAutoAccept() && $trustedServers?->isTrustedServer($remote) === true) {
@@ -204,7 +202,7 @@ public function shareReceived(ICloudFederationShare $share): string {
 					}
 				}
 
-				return $externalShare->getId();
+				return (string)$externalShare->getId();
 			} catch (\Exception $e) {
 				$this->logger->error('Server can not add remote share.', [
 					'app' => 'files_sharing',
@@ -466,7 +464,7 @@ private function unshare(string $id, array $notification): array {
 				$notification = $this->notificationManager->createNotification();
 				$notification->setApp('files_sharing')
 					->setUser($share->getUser())
-					->setObject('remote_share', $share->getId());
+					->setObject('remote_share', (string)$share->getId());
 				$this->notificationManager->markProcessed($notification);
 
 				$event = $this->activityManager->generateEvent();

apps/files_sharing/lib/External/ExternalShare.php

@@ -12,15 +12,13 @@
 
 use OC\Files\Filesystem;
 use OCA\Files_Sharing\ResponseDefinitions;
-use OCP\AppFramework\Db\Entity;
+use OCP\AppFramework\Db\SnowflakeAwareEntity;
 use OCP\DB\Types;
 use OCP\IGroup;
 use OCP\IUser;
 use OCP\Share\IShare;
 
 /**
- * @method string getId()
- * @method void setId(string $id)
  * @method string getParent()
  * @method void setParent(string $parent)
  * @method int|null getShareType()
@@ -46,7 +44,7 @@
  *
  * @psalm-import-type Files_SharingRemoteShare from ResponseDefinitions
  */
-class ExternalShare extends Entity implements \JsonSerializable {
+class ExternalShare extends SnowflakeAwareEntity implements \JsonSerializable {
 	protected string $parent = '-1';
 	protected ?int $shareType = null;
 	protected ?string $remote = null;
@@ -96,7 +94,7 @@ public function setShareWith(IUser|IGroup $shareWith): void {
 	public function jsonSerialize(): array {
 		$parent = $this->getParent();
 		return [
-			'id' => $this->getId(),
+			'id' => (string)$this->getId(),
 			'parent' => $parent,
 			'share_type' => $this->getShareType() ?? IShare::TYPE_USER, // unfortunately nullable on the DB level, but never null.
 			'remote' => $this->getRemote(),

apps/files_sharing/lib/External/Manager.php

@@ -34,7 +34,6 @@
 use OCP\Notification\IManager;
 use OCP\OCS\IDiscoveryService;
 use OCP\Share\IShare;
-use OCP\Snowflake\IGenerator;
 use Psr\Log\LoggerInterface;
 
 class Manager {
@@ -57,7 +56,6 @@ public function __construct(
 		private SetupManager $setupManager,
 		private ICertificateManager $certificateManager,
 		private ExternalShareMapper $externalShareMapper,
-		private IGenerator $snowflakeGenerator,
 	) {
 		$this->user = $userSession->getUser();
 	}
@@ -186,7 +184,7 @@ private function updateSubShare(ExternalShare $externalShare, IUser $user, ?stri
 				$subShare = $this->externalShareMapper->getUserShare($externalShare, $user);
 			} catch (DoesNotExistException) {
 				$subShare = new ExternalShare();
-				$subShare->setId($this->snowflakeGenerator->nextId());
+				$subShare->generateId();
 				$subShare->setRemote($externalShare->getRemote());
 				$subShare->setPassword($externalShare->getPassword());
 				$subShare->setName($externalShare->getName());
@@ -195,7 +193,7 @@ private function updateSubShare(ExternalShare $externalShare, IUser $user, ?stri
 				$subShare->setMountpoint($mountPoint ?? $externalShare->getMountpoint());
 				$subShare->setAccepted($accepted);
 				$subShare->setRemoteId($externalShare->getRemoteId());
-				$subShare->setParent($externalShare->getId());
+				$subShare->setParent((string)$externalShare->getId());
 				$subShare->setShareType($externalShare->getShareType());
 				$subShare->setShareToken($externalShare->getShareToken());
 				$this->externalShareMapper->insert($subShare);
@@ -317,7 +315,7 @@ public function processNotification(ExternalShare $remoteShare, ?IUser $user = n
 		$filter = $this->notificationManager->createNotification();
 		$filter->setApp('files_sharing')
 			->setUser($user->getUID())
-			->setObject('remote_share', $remoteShare->getId());
+			->setObject('remote_share', (string)$remoteShare->getId());
 		$this->notificationManager->markProcessed($filter);
 	}
 

apps/files_sharing/tests/Command/CleanupRemoteStoragesTest.php

@@ -14,7 +14,6 @@
 use OCP\Federation\ICloudIdManager;
 use OCP\IDBConnection;
 use OCP\Server;
-use OCP\Snowflake\IGenerator;
 use PHPUnit\Framework\Attributes\Group;
 use PHPUnit\Framework\MockObject\MockObject;
 use Symfony\Component\Console\Input\InputInterface;
@@ -64,7 +63,7 @@ protected function setUp(): void {
 
 			if (isset($storage['share_token'])) {
 				$externalShare = new ExternalShare();
-				$externalShare->setId(Server::get(IGenerator::class)->nextId());
+				$externalShare->generateId();
 				$externalShare->setShareToken($storage['share_token']);
 				$externalShare->setRemote($storage['remote']);
 				$externalShare->setName('irrelevant');

apps/files_sharing/tests/External/ManagerTest.php

@@ -40,7 +40,6 @@
 use OCP\OCS\IDiscoveryService;
 use OCP\Server;
 use OCP\Share\IShare;
-use OCP\Snowflake\IGenerator;
 use PHPUnit\Framework\MockObject\MockObject;
 use Psr\Log\LoggerInterface;
 use Test\Traits\UserTrait;
@@ -170,7 +169,6 @@ private function createManagerForUser(IUser $user): Manager&MockObject {
 					$this->setupManager,
 					$this->certificateManager,
 					$this->externalShareMapper,
-					Server::get(IGenerator::class),
 				]
 			)->onlyMethods(['tryOCMEndPoint'])->getMock();
 	}
@@ -190,7 +188,7 @@ private function clearMounts(): void {
 
 	public function testAddUserShare(): void {
 		$userShare = new ExternalShare();
-		$userShare->setId(Server::get(IGenerator::class)->nextId());
+		$userShare->generateId();
 		$userShare->setRemote('http://localhost');
 		$userShare->setShareToken('token1');
 		$userShare->setPassword('');
@@ -205,7 +203,7 @@ public function testAddUserShare(): void {
 
 	public function testAddGroupShare(): void {
 		$groupShare = new ExternalShare();
-		$groupShare->setId(Server::get(IGenerator::class)->nextId());
+		$groupShare->generateId();
 		$groupShare->setRemote('http://localhost');
 		$groupShare->setOwner('foobar');
 		$groupShare->setShareType(IShare::TYPE_GROUP);
@@ -237,10 +235,10 @@ public function doTestAddShare(ExternalShare $shareData1, IUser|IGroup $userOrGr
 
 		$shareData2 = $shareData1->clone();
 		$shareData2->setShareToken('token2');
-		$shareData2->setId(\OCP\Server::get(IGenerator::class)->nextId());
+		$shareData2->generateId();
 		$shareData3 = $shareData1->clone();
 		$shareData3->setShareToken('token3');
-		$shareData3->setId(\OCP\Server::get(IGenerator::class)->nextId());
+		$shareData3->generateId();
 
 		$this->setupMounts();
 		$this->assertNotMount('SharedFolder');
@@ -440,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(Server::get(IGenerator::class)->nextId());
+		$share->generateId();
 		$share->setRemote('http://localhost');
 		$share->setShareToken('token1');
 		$share->setPassword('');
@@ -460,7 +458,7 @@ private function createTestUserShare(string $userId = 'user1'): ExternalShare {
 	 */
 	private function createTestGroupShare(string $groupId = 'group1'): array {
 		$share = new ExternalShare();
-		$share->setId(Server::get(IGenerator::class)->nextId());
+		$share->generateId();
 		$share->setRemote('http://localhost');
 		$share->setShareToken('token1');
 		$share->setPassword('');
@@ -646,7 +644,7 @@ public function testDeleteUserShares(): void {
 		// user 2 shares
 		$manager2 = $this->createManagerForUser($user2);
 		$share = new ExternalShare();
-		$share->setId(Server::get(IGenerator::class)->nextId());
+		$share->generateId();
 		$share->setRemote('http://localhost');
 		$share->setShareToken('token1');
 		$share->setPassword('');
@@ -696,7 +694,7 @@ public function testDeleteGroupShares(): void {
 		$manager2 = $this->createManagerForUser($user);
 
 		$share = new ExternalShare();
-		$share->setId(Server::get(IGenerator::class)->nextId());
+		$share->generateId();
 		$share->setRemote('http://localhost');
 		$share->setShareToken('token1');
 		$share->setPassword('');

apps/files_versions/lib/Db/VersionEntity.php

@@ -44,7 +44,7 @@ public function __construct() {
 
 	public function jsonSerialize(): array {
 		return [
-			'id' => $this->id,
+			'id' => $this->getId(),
 			'file_id' => $this->fileId,
 			'timestamp' => $this->timestamp,
 			'size' => $this->size,

core/BackgroundJobs/MovePreviewJob.php

@@ -26,7 +26,6 @@
 use OCP\IAppConfig;
 use OCP\IConfig;
 use OCP\IDBConnection;
-use OCP\Snowflake\IGenerator;
 use Override;
 use Psr\Log\LoggerInterface;
 
@@ -45,7 +44,6 @@ public function __construct(
 		private readonly IMimeTypeDetector $mimeTypeDetector,
 		private readonly IMimeTypeLoader $mimeTypeLoader,
 		private readonly LoggerInterface $logger,
-		private readonly IGenerator $generator,
 		IAppDataFactory $appDataFactory,
 	) {
 		parent::__construct($time);
@@ -138,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($this->generator->nextId());
+			$preview->generateId();
 			if (!$preview) {
 				$this->logger->error('Unable to import old preview at path.');
 				continue;
@@ -172,6 +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->generateId();
 				try {
 					$preview = $this->previewMapper->insert($preview);
 				} catch (Exception) {

core/Command/SnowflakeDecodeId.php

@@ -8,15 +8,15 @@
  */
 namespace OC\Core\Command;
 
-use OCP\Snowflake\IDecoder;
+use OCP\Snowflake\ISnowflakeDecoder;
 use Symfony\Component\Console\Helper\Table;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
 class SnowflakeDecodeId extends Base {
 	public function __construct(
-		private readonly IDecoder $decoder,
+		private readonly ISnowflakeDecoder $decoder,
 	) {
 		parent::__construct();
 	}
@@ -36,13 +36,13 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
 		$rows = [
 			['Snowflake ID', $snowflakeId],
-			['Seconds', $data['seconds']],
-			['Milliseconds', $data['milliseconds']],
-			['Created from CLI', $data['isCli'] ? 'yes' : 'no'],
-			['Server ID', $data['serverId']],
-			['Sequence ID', $data['sequenceId']],
-			['Creation timestamp', $data['createdAt']->format('U.v')],
-			['Creation date', $data['createdAt']->format('Y-m-d H:i:s.v')],
+			['Seconds', $data->getSeconds()],
+			['Milliseconds', $data->getMilliseconds()],
+			['Created from CLI', $data->isCli() ? 'yes' : 'no'],
+			['Server ID', $data->getServerId()],
+			['Sequence ID', $data->getSequenceId()],
+			['Creation timestamp', $data->getCreatedAt()->format('U.v')],
+			['Creation date', $data->getCreatedAt()->format('Y-m-d H:i:s.v')],
 		];
 
 		$table = new Table($output);

lib/composer/composer/autoload_classmap.php

@@ -78,6 +78,7 @@
     'OCP\\AppFramework\\Db\\IMapperException' => $baseDir . '/lib/public/AppFramework/Db/IMapperException.php',
     'OCP\\AppFramework\\Db\\MultipleObjectsReturnedException' => $baseDir . '/lib/public/AppFramework/Db/MultipleObjectsReturnedException.php',
     'OCP\\AppFramework\\Db\\QBMapper' => $baseDir . '/lib/public/AppFramework/Db/QBMapper.php',
+    'OCP\\AppFramework\\Db\\SnowflakeAwareEntity' => $baseDir . '/lib/public/AppFramework/Db/SnowflakeAwareEntity.php',
     'OCP\\AppFramework\\Db\\TTransactional' => $baseDir . '/lib/public/AppFramework/Db/TTransactional.php',
     'OCP\\AppFramework\\Http' => $baseDir . '/lib/public/AppFramework/Http.php',
     'OCP\\AppFramework\\Http\\Attribute\\ARateLimit' => $baseDir . '/lib/public/AppFramework/Http/Attribute/ARateLimit.php',
@@ -837,8 +838,9 @@
     'OCP\\Share_Backend' => $baseDir . '/lib/public/Share_Backend.php',
     'OCP\\Share_Backend_Collection' => $baseDir . '/lib/public/Share_Backend_Collection.php',
     'OCP\\Share_Backend_File_Dependent' => $baseDir . '/lib/public/Share_Backend_File_Dependent.php',
-    'OCP\\Snowflake\\IDecoder' => $baseDir . '/lib/public/Snowflake/IDecoder.php',
-    'OCP\\Snowflake\\IGenerator' => $baseDir . '/lib/public/Snowflake/IGenerator.php',
+    'OCP\\Snowflake\\ISnowflakeDecoder' => $baseDir . '/lib/public/Snowflake/ISnowflakeDecoder.php',
+    'OCP\\Snowflake\\ISnowflakeGenerator' => $baseDir . '/lib/public/Snowflake/ISnowflakeGenerator.php',
+    'OCP\\Snowflake\\Snowflake' => $baseDir . '/lib/public/Snowflake/Snowflake.php',
     'OCP\\SpeechToText\\Events\\AbstractTranscriptionEvent' => $baseDir . '/lib/public/SpeechToText/Events/AbstractTranscriptionEvent.php',
     'OCP\\SpeechToText\\Events\\TranscriptionFailedEvent' => $baseDir . '/lib/public/SpeechToText/Events/TranscriptionFailedEvent.php',
     'OCP\\SpeechToText\\Events\\TranscriptionSuccessfulEvent' => $baseDir . '/lib/public/SpeechToText/Events/TranscriptionSuccessfulEvent.php',
@@ -2144,10 +2146,10 @@
     'OC\\Share\\Helper' => $baseDir . '/lib/private/Share/Helper.php',
     'OC\\Share\\Share' => $baseDir . '/lib/private/Share/Share.php',
     'OC\\Snowflake\\APCuSequence' => $baseDir . '/lib/private/Snowflake/APCuSequence.php',
-    'OC\\Snowflake\\Decoder' => $baseDir . '/lib/private/Snowflake/Decoder.php',
     'OC\\Snowflake\\FileSequence' => $baseDir . '/lib/private/Snowflake/FileSequence.php',
-    'OC\\Snowflake\\Generator' => $baseDir . '/lib/private/Snowflake/Generator.php',
     'OC\\Snowflake\\ISequence' => $baseDir . '/lib/private/Snowflake/ISequence.php',
+    'OC\\Snowflake\\SnowflakeDecoder' => $baseDir . '/lib/private/Snowflake/SnowflakeDecoder.php',
+    'OC\\Snowflake\\SnowflakeGenerator' => $baseDir . '/lib/private/Snowflake/SnowflakeGenerator.php',
     'OC\\SpeechToText\\SpeechToTextManager' => $baseDir . '/lib/private/SpeechToText/SpeechToTextManager.php',
     'OC\\SpeechToText\\TranscriptionJob' => $baseDir . '/lib/private/SpeechToText/TranscriptionJob.php',
     'OC\\StreamImage' => $baseDir . '/lib/private/StreamImage.php',