fixup! feat(jobs): introduce background job classes register

Author: Altahrim

core/Migrations/Version34000Date20260518163022.php

@@ -25,7 +25,7 @@ public function changeSchema(IOutput $output, Closure $schemaClosure, array $opt
 		$changed = false;
 		if (!$schema->hasTable('job_classes_registry')) {
 			$table = $schema->createTable('job_classes_registry');
-			$table->addColumn('class_id', Types::SMALLINT, [
+			$table->addColumn('class_id', Types::BIGINT, [
 				'autoincrement' => true,
 				'notnull' => true,
 				'unsigned' => true,

lib/private/BackgroundJob/JobClassesRegistry.php

@@ -12,40 +12,42 @@
 use InvalidArgumentException;
 use OCP\BackgroundJob\IJob;
 use OCP\IDBConnection;
+use OCP\Snowflake\ISnowflakeGenerator;
 
 /**
  * Map background job classes and their ID in database
  *
  * Uses a rapid hash to speed-up lookups
  */
 final class JobClassesRegistry {
-	private array $register = [];
+	private array $registry = [];
 
 	private const TABLE = 'job_classes_registry';
 
 	public function __construct(
 		private readonly IDBConnection $connection,
+		private readonly ISnowflakeGenerator $snowflakeGenerator,
 	) {
 	}
 
 	private function loadRegistry(): void {
-		if ($this->register !== []) {
+		if ($this->registry !== []) {
 			return;
 		}
 		$qb = $this->connection->getQueryBuilder();
 		$result = $qb->select('class_id', 'class_name')->from(self::TABLE)->executeQuery();
 		foreach ($result->iterateAssociative() as $row) {
-			$this->register[$row['class_name']] = (int)$row['class_id'];
+			$this->registry[$row['class_name']] = (string)$row['class_id'];
 		}
 	}
 
 	/**
 	 * Resolve current ID or generates a new one
 	 */
-	public function getId(string $className): int {
+	public function getId(string $className): string {
 		$this->loadRegistry();
-		if (isset($this->register[$className])) {
-			return $this->register[$className];
+		if (isset($this->registry[$className])) {
+			return $this->registry[$className];
 		}
 
 		if (!class_exists($className)) {
@@ -58,12 +60,18 @@ public function getId(string $className): int {
 		$qb = $this->connection->getQueryBuilder();
 		$hashedName = $this->hashName($className);
 		try {
+			$classId = $this->snowflakeGenerator->nextId();
 			$qb
 				->insert(self::TABLE)
-				->setValue('class_name', $qb->expr()->literal($className))
-				->setValue('class_hash', $qb->expr()->literal($hashedName))
+				->values([
+					'class_id' => $qb->createNamedParameter($classId),
+					'class_name' => $qb->createNamedParameter($className),
+					'class_hash' => $qb->createNamedParameter($hashedName),
+				])
 				->executeStatement();
-			return $qb->getLastInsertId();
+			$this->registry[$className] = $classId;
+
+			return $classId;
 		} catch (UniqueConstraintViolationException) {
 			// Class was probably added by a concurrent process
 			// Try to load it
@@ -74,16 +82,20 @@ public function getId(string $className): int {
 				->andWhere($qb->expr()->eq('class_name', $className))
 				->executeQuery();
 			if ($classId = $result->fetchOne()) {
-				return (int)$classId;
+				$classId = (string)$classId;
+				$this->registry[$className] = $classId;
+
+				return $classId;
 			}
 		}
 
 		throw new \Exception('Fail to retrieve ' . $className . ' ID');
 	}
 
-	public function getName(int $classId): string {
+	public function getName(string|int $classId): string {
 		$this->loadRegistry();
-		$className = array_search($classId, $this->register, true);
+		$classId = (string)$classId;
+		$className = array_search($classId, $this->registry, true);
 		if ($className === false) {
 			throw new InvalidArgumentException('Class ID ' . $classId . ' doesn’t match any class name');
 		}

tests/lib/BackgroundJob/JobClassesRegistryTest.php

@@ -13,6 +13,7 @@
 use OC\BackgroundJob\JobClassesRegistry;
 use OCP\IDBConnection;
 use OCP\Server;
+use OCP\Snowflake\ISnowflakeGenerator;
 use Override;
 use Test\TestCase;
 
@@ -21,51 +22,53 @@
  */
 #[\PHPUnit\Framework\Attributes\Group('DB')]
 class JobClassesRegistryTest extends TestCase {
-	private IDBConnection $connection;
-	private JobClassesRegistry $register;
+	private readonly IDBConnection $connection;
+	private readonly ISnowflakeGenerator $snowflakeGenerator;
+	private JobClassesRegistry $registry;
 
 	#[Override]
 	protected function setUp(): void {
 		parent::setUp();
 
 		$this->connection = Server::get(IDBConnection::class);
-		$this->register = new JobClassesRegistry($this->connection);
+		$this->snowflakeGenerator = Server::get(ISnowflakeGenerator::class);
+		$this->registry = new JobClassesRegistry($this->connection, $this->snowflakeGenerator);
 	}
 
 	public function testResolveNonExistingClass() {
 		$className = 'invalid_class_name_122278';
 
 		$this->expectException(InvalidArgumentException::class);
 		$this->expectExceptionMessage('Class ' . $className . ' doesn’t exists');
-		$this->register->getId($className);
+		$this->registry->getId($className);
 	}
 
 	public function testResolveInvalidClass() {
 		$className = self::class;
 
 		$this->expectException(InvalidArgumentException::class);
 		$this->expectExceptionMessage('Class ' . $className . ' isn’t an instance of OCP\BackgroundJob\IJob');
-		$this->register->getId($className);
+		$this->registry->getId($className);
 	}
 
 	public function testResolveValidClass() {
 		$className = DummyJob::class;
 
-		$classId = $this->register->getId($className);
-		$this->assertIsInt($classId);
+		$classId = $this->registry->getId($className);
+		$this->assertIsString($classId);
 		$this->assertGreaterThan(0, $classId);
 
 		// Renew register. ID should stay the same
-		$this->register = new JobClassesRegistry($this->connection);
-		$newId = $this->register->getId($className);
+		$this->registry = new JobClassesRegistry($this->connection, $this->snowflakeGenerator);
+		$newId = $this->registry->getId($className);
 		$this->assertEquals($classId, $newId);
 	}
 
 	public function testResolveValidId() {
 		$className = DummyJob::class;
 
-		$classId = $this->register->getId($className);
-		$resolvedClass = $this->register->getName($classId);
+		$classId = $this->registry->getId($className);
+		$resolvedClass = $this->registry->getName($classId);
 
 		$this->assertEquals($className, $resolvedClass);
 	}
@@ -74,6 +77,6 @@ public function testResolveInvalidId() {
 		$classId = PHP_INT_MAX;
 		$this->expectException(InvalidArgumentException::class);
 		$this->expectExceptionMessage('Class ID ' . $classId . ' doesn’t match any class name');
-		$this->register->getName($classId);
+		$this->registry->getName($classId);
 	}
 }