fixup! feat(snowflake): extend Entity class to support snowflakes

Author: miaulalala

core/BackgroundJobs/MovePreviewJob.php

@@ -26,7 +26,7 @@
 use OCP\IAppConfig;
 use OCP\IConfig;
 use OCP\IDBConnection;
-use OCP\Snowflake\IGenerator;
+use OCP\Snowflake\ISnowflakeGenerator;
 use Override;
 use Psr\Log\LoggerInterface;
 
@@ -45,7 +45,7 @@ public function __construct(
 		private readonly IMimeTypeDetector $mimeTypeDetector,
 		private readonly IMimeTypeLoader $mimeTypeLoader,
 		private readonly LoggerInterface $logger,
-		private readonly IGenerator $generator,
+		private readonly ISnowflakeGenerator $generator,
 		IAppDataFactory $appDataFactory,
 	) {
 		parent::__construct($time);

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();
 	}

lib/private/Preview/Db/PreviewMapper.php

@@ -15,7 +15,7 @@
 use OCP\DB\QueryBuilder\IQueryBuilder;
 use OCP\Files\IMimeTypeLoader;
 use OCP\IDBConnection;
-use OCP\Snowflake\IGenerator;
+use OCP\Snowflake\ISnowflakeGenerator;
 use Override;
 
 /**
@@ -30,7 +30,7 @@ class PreviewMapper extends QBMapper {
 	public function __construct(
 		IDBConnection $db,
 		private readonly IMimeTypeLoader $mimeTypeLoader,
-		private readonly IGenerator $snowflake,
+		private readonly ISnowflakeGenerator $snowflake,
 	) {
 		parent::__construct($db, self::TABLE_NAME, Preview::class);
 	}

lib/private/Preview/Generator.php

@@ -23,7 +23,7 @@
 use OCP\IStreamImage;
 use OCP\Preview\BeforePreviewFetchedEvent;
 use OCP\Preview\IVersionedPreviewFile;
-use OCP\Snowflake\IGenerator;
+use OCP\Snowflake\ISnowflakeGenerator;
 use Psr\Log\LoggerInterface;
 
 class Generator {
@@ -38,7 +38,7 @@ public function __construct(
 		private LoggerInterface $logger,
 		private PreviewMapper $previewMapper,
 		private StorageFactory $storageFactory,
-		private IGenerator $snowflakeGenerator,
+		private ISnowflakeGenerator $snowflakeGenerator,
 	) {
 	}
 

lib/private/Preview/Storage/LocalPreviewStorage.php

@@ -22,7 +22,7 @@
 use OCP\IAppConfig;
 use OCP\IConfig;
 use OCP\IDBConnection;
-use OCP\Snowflake\IGenerator;
+use OCP\Snowflake\ISnowflakeGenerator;
 use Override;
 use Psr\Log\LoggerInterface;
 use RecursiveDirectoryIterator;
@@ -39,7 +39,7 @@ public function __construct(
 		private readonly IDBConnection $connection,
 		private readonly IMimeTypeDetector $mimeTypeDetector,
 		private readonly LoggerInterface $logger,
-		private readonly IGenerator $generator,
+		private readonly ISnowflakeGenerator $generator,
 	) {
 		$this->instanceId = $this->config->getSystemValueString('instanceid');
 		$this->rootFolder = $this->config->getSystemValue('datadirectory', OC::$SERVERROOT . '/data');

lib/private/PreviewManager.php

@@ -23,7 +23,7 @@
 use OCP\IConfig;
 use OCP\IPreview;
 use OCP\Preview\IProviderV2;
-use OCP\Snowflake\IGenerator;
+use OCP\Snowflake\ISnowflakeGenerator;
 use Psr\Container\ContainerInterface;
 use Psr\Container\NotFoundExceptionInterface;
 use Psr\Log\LoggerInterface;
@@ -142,7 +142,7 @@ private function getGenerator(): Generator {
 				$this->container->get(LoggerInterface::class),
 				$this->container->get(PreviewMapper::class),
 				$this->container->get(StorageFactory::class),
-				$this->container->get(IGenerator::class),
+				$this->container->get(ISnowflakeGenerator::class),
 			);
 		}
 		return $this->generator;

lib/private/Server.php

@@ -117,10 +117,10 @@
 use OC\Share20\ProviderFactory;
 use OC\Share20\ShareHelper;
 use OC\Snowflake\APCuSequence;
-use OC\Snowflake\Decoder;
 use OC\Snowflake\FileSequence;
-use OC\Snowflake\Generator;
 use OC\Snowflake\ISequence;
+use OC\Snowflake\SnowflakeDecoder;
+use OC\Snowflake\SnowflakeGenerator;
 use OC\SpeechToText\SpeechToTextManager;
 use OC\SystemTag\ManagerFactory as SystemTagManagerFactory;
 use OC\Talk\Broker;
@@ -230,8 +230,8 @@
 use OCP\SetupCheck\ISetupCheckManager;
 use OCP\Share\IProviderFactory;
 use OCP\Share\IShareHelper;
-use OCP\Snowflake\IDecoder;
-use OCP\Snowflake\IGenerator;
+use OCP\Snowflake\ISnowflakeDecoder;
+use OCP\Snowflake\ISnowflakeGenerator;
 use OCP\SpeechToText\ISpeechToTextManager;
 use OCP\SystemTag\ISystemTagManager;
 use OCP\SystemTag\ISystemTagObjectMapper;
@@ -1266,7 +1266,7 @@ public function __construct($webRoot, \OC\Config $config) {
 
 		$this->registerAlias(ISignatureManager::class, SignatureManager::class);
 
-		$this->registerAlias(IGenerator::class, Generator::class);
+		$this->registerAlias(ISnowflakeGenerator::class, SnowflakeGenerator::class);
 		$this->registerService(ISequence::class, function (ContainerInterface $c): ISequence {
 			if (PHP_SAPI !== 'cli') {
 				$sequence = $c->get(APCuSequence::class);
@@ -1277,7 +1277,7 @@ public function __construct($webRoot, \OC\Config $config) {
 
 			return $c->get(FileSequence::class);
 		}, false);
-		$this->registerAlias(IDecoder::class, Decoder::class);
+		$this->registerAlias(ISnowflakeDecoder::class, SnowflakeDecoder::class);
 
 		$this->connectDispatcher();
 	}

lib/private/Snowflake/Decoder.php …b/private/Snowflake/SnowflakeDecoder.phplib/private/Snowflake/Decoder.php renamed to lib/private/Snowflake/SnowflakeDecoder.php lib/private/Snowflake/Decoder.php renamed to lib/private/Snowflake/SnowflakeDecoder.php

@@ -9,8 +9,9 @@
 
 namespace OC\Snowflake;
 
-use OCP\Snowflake\IDecoder;
-use OCP\Snowflake\IGenerator;
+use OCP\Snowflake\ISnowflakeDecoder;
+use OCP\Snowflake\ISnowflakeGenerator;
+use OCP\Snowflake\Snowflake;
 use Override;
 
 /**
@@ -20,7 +21,7 @@
  *
  * @since 33.0.0
  */
-final class Decoder implements IDecoder {
+final class SnowflakeDecoder implements ISnowflakeDecoder {
 	#[Override]
 	public function decode(string $snowflakeId): array {
 		if (!ctype_digit($snowflakeId)) {
@@ -35,7 +36,7 @@ public function decode(string $snowflakeId): array {
 		$data['createdAt'] = new \DateTimeImmutable(
 			sprintf(
 				'@%d.%03d',
-				$data['seconds'] + IGenerator::TS_OFFSET + intdiv($data['milliseconds'], 1000),
+				$data['seconds'] + ISnowflakeGenerator::TS_OFFSET + intdiv($data['milliseconds'], 1000),
 				$data['milliseconds'] % 1000,
 			)
 		);
@@ -51,11 +52,11 @@ private function decode64bits(int $snowflakeId): array {
 		$milliseconds = $secondHalf >> 22;
 
 		return [
-			'seconds' => $seconds,
-			'milliseconds' => $milliseconds,
 			'serverId' => ($secondHalf >> 13) & 0x1FF,
 			'sequenceId' => $secondHalf & 0xFFF,
 			'isCli' => (bool)(($secondHalf >> 12) & 0x1),
+			'seconds' => $seconds,
+			'milliseconds' => $milliseconds,
 		];
 	}
 
@@ -88,12 +89,12 @@ private function convertBase16(string $decimal): string {
 		$hex = '';
 		$digits = '0123456789ABCDEF';
 
-		while (strlen($decimal) > 0 && $decimal !== '0') {
+		while ($decimal !== '' && $decimal !== '0') {
 			$remainder = 0;
 			$newDecimal = '';
 
 			// Perform division by 16 manually for arbitrary precision
-			for ($i = 0; $i < strlen($decimal); $i++) {
+			for ($i = 0, $iMax = strlen($decimal); $i < $iMax; $i++) {
 				$digit = (int)$decimal[$i];
 				$current = $remainder * 10 + $digit;
 
@@ -104,7 +105,7 @@ private function convertBase16(string $decimal): string {
 				} else {
 					$remainder = $current;
 					// Only add quotient digit if we already have some digits in result
-					if (strlen($newDecimal) > 0) {
+					if ($newDecimal !== '') {
 						$newDecimal .= '0';
 					}
 				}
@@ -119,4 +120,9 @@ private function convertBase16(string $decimal): string {
 
 		return str_pad($hex, 16, '0', STR_PAD_LEFT);
 	}
+
+	public function decodeToSnowflake(string $snowflakeId): Snowflake {
+		$data = $this->decode($snowflakeId);
+		return Snowflake::fromArray($data);
+	}
 }

lib/private/Snowflake/Generator.php …private/Snowflake/SnowflakeGenerator.phplib/private/Snowflake/Generator.php renamed to lib/private/Snowflake/SnowflakeGenerator.php lib/private/Snowflake/Generator.php renamed to lib/private/Snowflake/SnowflakeGenerator.php

@@ -11,7 +11,7 @@
 
 use OCP\AppFramework\Utility\ITimeFactory;
 use OCP\IConfig;
-use OCP\Snowflake\IGenerator;
+use OCP\Snowflake\ISnowflakeGenerator;
 use Override;
 
 /**
@@ -21,7 +21,7 @@
  *
  * @since 33.0.0
  */
-final class Generator implements IGenerator {
+final class SnowflakeGenerator implements ISnowflakeGenerator {
 	public function __construct(
 		private readonly ITimeFactory $timeFactory,
 		private readonly IConfig $config,

lib/public/AppFramework/Db/SnowflakeAwareEntity.php

@@ -2,14 +2,17 @@
 
 namespace OCP\AppFramework\Db;
 
+use OCP\AppFramework\Attribute\Consumable;
 use OCP\Server;
-use OCP\Snowflake\IDecoder;
-use OCP\Snowflake\IGenerator;
+use OCP\Snowflake\ISnowflakeDecoder;
+use OCP\Snowflake\ISnowflakeGenerator;
+use OCP\Snowflake\Snowflake;
 
 /**
- * @method string getId()
+ * @since 33.0.0
  */
-class SnowflakeAwareEntity extends Entity {
+#[Consumable(since: '33.0.0')]
+abstract class SnowflakeAwareEntity extends Entity {
 	/** @var string $id */
 	public $id;
 
@@ -19,24 +22,27 @@ class SnowflakeAwareEntity extends Entity {
 	#[\Override]
 	public function setId(): void {
 		if (empty($this->id)) {
-			$generator = Server::get(IGenerator::class);
-			$this->id = $generator->nextId();
+			$this->id = Server::get(ISnowflakeGenerator::class)->nextId();
 			$this->markFieldUpdated('id');
 		}
 	}
 
+	#[\Override]
+	public function getId(): string {
+		return $this->id;
+	}
+
 	public function getCreatedAt(): ?\DateTimeImmutable {
 		if (empty($this->id)) {
 			return null;
 		}
-		$decoder = Server::get(IDecoder::class);
-		return $decoder->decode($this->id)['created_at'];
+		return Server::get(ISnowflakeDecoder::class)->decodeToSnowflake($this->id)->getCreatedAt();
 	}
 
-	public function getDecodedId(): array {
+	public function getSnowflake(): ?Snowflake {
 		if (empty($this->id)) {
-			return [];
+			return null;
 		}
-		return Server::get(IDecoder::class)->decode($this->id);
+		return Server::get(ISnowflakeDecoder::class)->decodeToSnowflake($this->id);
 	}
 }