From 15d24981998eee7b966d7ec4042a7d79c88b4536 Mon Sep 17 00:00:00 2001 From: Louis Chemineau Date: Wed, 14 Feb 2024 17:36:08 +0100 Subject: [PATCH] Move oc_file_metadata.metadata migration to a background job Signed-off-by: Louis Chemineau --- core/BackgroundJobs/MetadataMigrationJob.php | 102 ++++++++++++++++++ .../Version27000Date20230309104325.php | 26 ++--- .../Version27000Date20230309104802.php | 14 +-- lib/private/Repair.php | 18 ++-- .../Repair/AddMetadataMigrationJob.php | 70 ++++++++++++ 5 files changed, 202 insertions(+), 28 deletions(-) create mode 100644 core/BackgroundJobs/MetadataMigrationJob.php create mode 100644 lib/private/Repair/AddMetadataMigrationJob.php diff --git a/core/BackgroundJobs/MetadataMigrationJob.php b/core/BackgroundJobs/MetadataMigrationJob.php new file mode 100644 index 0000000000000..7411ed7b33e30 --- /dev/null +++ b/core/BackgroundJobs/MetadataMigrationJob.php @@ -0,0 +1,102 @@ + + * + * @author Louis Chemineau + * + * @license AGPL-3.0-or-later + * + * 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 . + * + */ + +namespace OC\Core\BackgroundJobs; + +use OCP\AppFramework\Utility\ITimeFactory; +use OCP\BackgroundJob\IJobList; +use OCP\BackgroundJob\TimedJob; +use OCP\DB\QueryBuilder\IQueryBuilder; +use OCP\IDBConnection; + +// Migrate oc_file_metadata.metadata to oc_file_metadata.value. +// This was previously done in a migration, but it is taking to much time in large instances. +// This job will progressively migrate the data 1 hour per night every night. +// Once done, it will remove itself from the job list and drop oc_file_metadata.metadata. +class MetadataMigrationJob extends TimedJob { + public function __construct( + ITimeFactory $time, + private IDBConnection $db, + private IJobList $jobList, + ) { + parent::__construct($time); + + $this->setTimeSensitivity(\OCP\BackgroundJob\IJob::TIME_INSENSITIVE); + $this->setInterval(24 * 3600); + } + + protected function run(mixed $argument): void { + if (!$this->db->createSchema()->getTable('oc_file_metadata')->hasColumn('metadata')) { + return; + } + + $updateQuery = $this->db->getQueryBuilder(); + $updateQuery->update('file_metadata') + ->set('value', $updateQuery->createParameter('value')) + ->set('metadata', $updateQuery->createParameter('metadata')) + ->where($updateQuery->expr()->eq('id', $updateQuery->createParameter('id'))) + ->andWhere($updateQuery->expr()->eq('group_name', $updateQuery->createParameter('group_name'))); + + $selectQuery = $this->db->getQueryBuilder(); + $selectQuery->select('id', 'group_name', 'metadata') + ->from('file_metadata') + ->where($selectQuery->expr()->neq('metadata', $selectQuery->createNamedParameter(''), IQueryBuilder::PARAM_STR)) + ->setMaxResults(1000); + + $movedRows = 0; + $startTime = time(); + + do { + // Stop if execution time is more than one hour. + if (time() - $startTime > 3600) { + return; + } + $movedRows = $this->chunkedCopying($updateQuery, $selectQuery); + } while ($movedRows !== 0); + + + $this->jobList->remove(MetadataMigrationJob::class); + } + + protected function chunkedCopying(IQueryBuilder $updateQuery, IQueryBuilder $selectQuery): int { + $this->db->beginTransaction(); + + $results = $selectQuery->executeQuery(); + + while ($row = $results->fetch()) { + $updateQuery + ->setParameter('id', (int)$row['id']) + ->setParameter('group_name', $row['group_name']) + ->setParameter('value', $row['metadata']) + ->setParameter('metadata', '') + ->executeStatement(); + } + + $results->closeCursor(); + $this->db->commit(); + + return $results->rowCount(); + } +} diff --git a/core/Migrations/Version27000Date20230309104325.php b/core/Migrations/Version27000Date20230309104325.php index e11b37b4b2988..0ecaa4a73a71d 100644 --- a/core/Migrations/Version27000Date20230309104325.php +++ b/core/Migrations/Version27000Date20230309104325.php @@ -72,19 +72,19 @@ public function changeSchema(IOutput $output, Closure $schemaClosure, array $opt * @param array $options * @return void */ - public function postSchemaChange(IOutput $output, Closure $schemaClosure, array $options) { - /** @var ISchemaWrapper $schema */ - $schema = $schemaClosure(); - $metadataTable = $schema->getTable('file_metadata'); + // public function postSchemaChange(IOutput $output, Closure $schemaClosure, array $options) { + // /** @var ISchemaWrapper $schema */ + // $schema = $schemaClosure(); + // $metadataTable = $schema->getTable('file_metadata'); - if (!$metadataTable->hasColumn('metadata')) { - return; - } + // if (!$metadataTable->hasColumn('metadata')) { + // return; + // } - $this->connection - ->getQueryBuilder() - ->update('file_metadata') - ->set('value', 'metadata') - ->executeStatement(); - } + // $this->connection + // ->getQueryBuilder() + // ->update('file_metadata') + // ->set('value', 'metadata') + // ->executeStatement(); + // } } diff --git a/core/Migrations/Version27000Date20230309104802.php b/core/Migrations/Version27000Date20230309104802.php index 4bd50fe03962c..260ae83d9708b 100644 --- a/core/Migrations/Version27000Date20230309104802.php +++ b/core/Migrations/Version27000Date20230309104802.php @@ -43,14 +43,14 @@ class Version27000Date20230309104802 extends SimpleMigrationStep { * @return null|ISchemaWrapper */ public function changeSchema(IOutput $output, Closure $schemaClosure, array $options): ?ISchemaWrapper { - /** @var ISchemaWrapper $schema */ - $schema = $schemaClosure(); - $metadataTable = $schema->getTable('file_metadata'); + // /** @var ISchemaWrapper $schema */ + // $schema = $schemaClosure(); + // $metadataTable = $schema->getTable('file_metadata'); - if ($metadataTable->hasColumn('metadata')) { - $metadataTable->dropColumn('metadata'); - return $schema; - } + // if ($metadataTable->hasColumn('metadata')) { + // $metadataTable->dropColumn('metadata'); + // return $schema; + // } return null; } diff --git a/lib/private/Repair.php b/lib/private/Repair.php index 541073de1eeda..99af19ddb79f4 100644 --- a/lib/private/Repair.php +++ b/lib/private/Repair.php @@ -34,19 +34,14 @@ */ namespace OC; -use OC\Repair\AddRemoveOldTasksBackgroundJob; -use OC\Repair\CleanUpAbandonedApps; -use OCP\AppFramework\QueryException; -use OCP\AppFramework\Utility\ITimeFactory; -use OCP\Collaboration\Resources\IManager; -use OCP\EventDispatcher\IEventDispatcher; -use OCP\Migration\IOutput; -use OCP\Migration\IRepairStep; use OC\DB\Connection; use OC\DB\ConnectionAdapter; use OC\Repair\AddBruteForceCleanupJob; use OC\Repair\AddCleanupUpdaterBackupsJob; +use OC\Repair\AddMetadataMigrationJob; +use OC\Repair\AddRemoveOldTasksBackgroundJob; use OC\Repair\CleanTags; +use OC\Repair\CleanUpAbandonedApps; use OC\Repair\ClearFrontendCaches; use OC\Repair\ClearGeneratedAvatarCache; use OC\Repair\Collation; @@ -86,6 +81,12 @@ use OC\Repair\RepairMimeTypes; use OC\Repair\SqliteAutoincrement; use OC\Template\JSCombiner; +use OCP\AppFramework\QueryException; +use OCP\AppFramework\Utility\ITimeFactory; +use OCP\Collaboration\Resources\IManager; +use OCP\EventDispatcher\IEventDispatcher; +use OCP\Migration\IOutput; +use OCP\Migration\IRepairStep; use Psr\Log\LoggerInterface; use Throwable; @@ -212,6 +213,7 @@ public static function getRepairSteps(): array { \OCP\Server::get(CleanUpAbandonedApps::class), \OCP\Server::get(AddMissingSecretJob::class), \OCP\Server::get(AddRemoveOldTasksBackgroundJob::class), + \OCP\Server::get(AddMetadataMigrationJob::class), ]; } diff --git a/lib/private/Repair/AddMetadataMigrationJob.php b/lib/private/Repair/AddMetadataMigrationJob.php new file mode 100644 index 0000000000000..06156338ae826 --- /dev/null +++ b/lib/private/Repair/AddMetadataMigrationJob.php @@ -0,0 +1,70 @@ + + * + * @author Louis Chmn + * + * @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 . + * + */ +namespace OC\Repair; + +use OC\Core\BackgroundJobs\MetadataMigrationJob; +use OCP\BackgroundJob\IJobList; +use OCP\DB\QueryBuilder\IQueryBuilder; +use OCP\IDBConnection; +use OCP\Migration\IOutput; +use OCP\Migration\IRepairStep; + +class AddMetadataMigrationJob implements IRepairStep { + public function __construct( + private IJobList $jobList, + private IDBConnection $db, + ) { + } + + public function getName() { + return 'Queue a job to migrate the file_metadata table or delete the metadata column'; + } + + public function run(IOutput $output) { + $schema = $this->db->createSchema(); + $metadataTable = $schema->getTable('oc_file_metadata'); + + if (!$metadataTable->hasColumn('metadata')) { + return; + } + + $selectQuery = $this->db->getQueryBuilder(); + $result = $selectQuery->select('id', 'group_name', 'metadata') + ->from('file_metadata') + ->where($selectQuery->expr()->neq('metadata', $selectQuery->createNamedParameter(''), IQueryBuilder::PARAM_STR)) + ->setMaxResults(1) + ->executeQuery(); + + if ($result->rowCount() === 0) { + $metadataTable->dropColumn('metadata'); + $this->db->migrateToSchema($schema); + return; + } + + if ($this->jobList->has(MetadataMigrationJob::class, null)) { + return; + } + + $this->jobList->add(MetadataMigrationJob::class); + } +}