[stable29] Migration Attributes

core/Command/Db/Migrations/PreviewCommand.php

@@ -0,0 +1,111 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OC\Core\Command\Db\Migrations;
+
+use OC\Migration\MetadataManager;
+use OC\Updater\ReleaseMetadata;
+use OCP\Migration\Attributes\MigrationAttribute;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Helper\Table;
+use Symfony\Component\Console\Helper\TableCell;
+use Symfony\Component\Console\Helper\TableCellStyle;
+use Symfony\Component\Console\Helper\TableSeparator;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+/**
+ * @since 30.0.0
+ */
+class PreviewCommand extends Command {
+	private bool $initiated = false;
+	public function __construct(
+		private MetadataManager $metadataManager,
+		private ReleaseMetadata $releaseMetadata,
+	) {
+		parent::__construct();
+	}
+
+	protected function configure(): void {
+		$this
+			->setName('migrations:preview')
+			->setDescription('Get preview of available DB migrations in case of initiating an upgrade')
+			->addArgument('version', InputArgument::REQUIRED, 'The destination version number');
+
+		parent::configure();
+	}
+
+	public function execute(InputInterface $input, OutputInterface $output): int {
+		$version = $input->getArgument('version');
+		if (filter_var($version, FILTER_VALIDATE_URL)) {
+			$metadata = $this->releaseMetadata->downloadMetadata($version);
+		} elseif (str_starts_with($version, '/')) {
+			$metadata = json_decode(file_get_contents($version), true, flags: JSON_THROW_ON_ERROR);
+		} else {
+			$metadata = $this->releaseMetadata->getMetadata($version);
+		}
+
+		$parsed = $this->metadataManager->getMigrationsAttributesFromReleaseMetadata($metadata['migrations'] ?? [], true);
+
+		$table = new Table($output);
+		$this->displayMigrations($table, 'core', $parsed['core'] ?? []);
+		foreach ($parsed['apps'] as $appId => $migrations) {
+			if (!empty($migrations)) {
+				$this->displayMigrations($table, $appId, $migrations);
+			}
+		}
+		$table->render();
+
+		$unsupportedApps = $this->metadataManager->getUnsupportedApps($metadata['migrations']);
+		if (!empty($unsupportedApps)) {
+			$output->writeln('');
+			$output->writeln('Those apps are not supporting metadata yet and might initiate migrations on upgrade: <info>' . implode(', ', $unsupportedApps) . '</info>');
+		}
+
+		return 0;
+	}
+
+	private function displayMigrations(Table $table, string $appId, array $data): void {
+		if (empty($data)) {
+			return;
+		}
+
+		if ($this->initiated) {
+			$table->addRow(new TableSeparator());
+		}
+		$this->initiated = true;
+
+		$table->addRow(
+			[
+				new TableCell(
+					$appId,
+					[
+						'colspan' => 2,
+						'style' => new TableCellStyle(['cellFormat' => '<info>%s</info>'])
+					]
+				)
+			]
+		)->addRow(new TableSeparator());
+
+		/** @var MigrationAttribute[] $attributes */
+		foreach($data as $migration => $attributes) {
+			$attributesStr = [];
+			if (empty($attributes)) {
+				$attributesStr[] = '<comment>(metadata not set)</comment>';
+			}
+			foreach($attributes as $attribute) {
+				$definition = '<info>' . $attribute->definition() . "</info>";
+				$definition .= empty($attribute->getDescription()) ? '' : "\n  " . $attribute->getDescription();
+				$definition .= empty($attribute->getNotes()) ? '' : "\n  <comment>" . implode("</comment>\n  <comment>", $attribute->getNotes()) . '</comment>';
+				$attributesStr[] = $definition;
+			}
+			$table->addRow([$migration, implode("\n", $attributesStr)]);
+		}
+	}
+}

core/register_command.php

@@ -110,6 +110,7 @@
 	$application->add(Server::get(Command\Db\AddMissingIndices::class));
 	$application->add(Server::get(Command\Db\AddMissingPrimaryKeys::class));
 
+	$application->add(Server::get(Command\Db\Migrations\PreviewCommand::class));
 	if ($config->getSystemValueBool('debug', false)) {
 		$application->add(Server::get(Command\Db\Migrations\StatusCommand::class));
 		$application->add(Server::get(Command\Db\Migrations\MigrateCommand::class));

lib/composer/composer/autoload_classmap.php

@@ -555,6 +555,18 @@
     'OCP\\Mail\\IEMailTemplate' => $baseDir . '/lib/public/Mail/IEMailTemplate.php',
     'OCP\\Mail\\IMailer' => $baseDir . '/lib/public/Mail/IMailer.php',
     'OCP\\Mail\\IMessage' => $baseDir . '/lib/public/Mail/IMessage.php',
+    'OCP\\Migration\\Attributes\\AddColumn' => $baseDir . '/lib/public/Migration/Attributes/AddColumn.php',
+    'OCP\\Migration\\Attributes\\AddIndex' => $baseDir . '/lib/public/Migration/Attributes/AddIndex.php',
+    'OCP\\Migration\\Attributes\\ColumnMigrationAttribute' => $baseDir . '/lib/public/Migration/Attributes/ColumnMigrationAttribute.php',
+    'OCP\\Migration\\Attributes\\CreateTable' => $baseDir . '/lib/public/Migration/Attributes/CreateTable.php',
+    'OCP\\Migration\\Attributes\\DropColumn' => $baseDir . '/lib/public/Migration/Attributes/DropColumn.php',
+    'OCP\\Migration\\Attributes\\DropIndex' => $baseDir . '/lib/public/Migration/Attributes/DropIndex.php',
+    'OCP\\Migration\\Attributes\\DropTable' => $baseDir . '/lib/public/Migration/Attributes/DropTable.php',
+    'OCP\\Migration\\Attributes\\GenericMigrationAttribute' => $baseDir . '/lib/public/Migration/Attributes/GenericMigrationAttribute.php',
+    'OCP\\Migration\\Attributes\\IndexMigrationAttribute' => $baseDir . '/lib/public/Migration/Attributes/IndexMigrationAttribute.php',
+    'OCP\\Migration\\Attributes\\MigrationAttribute' => $baseDir . '/lib/public/Migration/Attributes/MigrationAttribute.php',
+    'OCP\\Migration\\Attributes\\ModifyColumn' => $baseDir . '/lib/public/Migration/Attributes/ModifyColumn.php',
+    'OCP\\Migration\\Attributes\\TableMigrationAttribute' => $baseDir . '/lib/public/Migration/Attributes/TableMigrationAttribute.php',
     'OCP\\Migration\\BigIntMigration' => $baseDir . '/lib/public/Migration/BigIntMigration.php',
     'OCP\\Migration\\IMigrationStep' => $baseDir . '/lib/public/Migration/IMigrationStep.php',
     'OCP\\Migration\\IOutput' => $baseDir . '/lib/public/Migration/IOutput.php',
@@ -1071,6 +1083,7 @@
     'OC\\Core\\Command\\Db\\Migrations\\ExecuteCommand' => $baseDir . '/core/Command/Db/Migrations/ExecuteCommand.php',
     'OC\\Core\\Command\\Db\\Migrations\\GenerateCommand' => $baseDir . '/core/Command/Db/Migrations/GenerateCommand.php',
     'OC\\Core\\Command\\Db\\Migrations\\MigrateCommand' => $baseDir . '/core/Command/Db/Migrations/MigrateCommand.php',
+    'OC\\Core\\Command\\Db\\Migrations\\PreviewCommand' => $baseDir . '/core/Command/Db/Migrations/PreviewCommand.php',
     'OC\\Core\\Command\\Db\\Migrations\\StatusCommand' => $baseDir . '/core/Command/Db/Migrations/StatusCommand.php',
     'OC\\Core\\Command\\Encryption\\ChangeKeyStorageRoot' => $baseDir . '/core/Command/Encryption/ChangeKeyStorageRoot.php',
     'OC\\Core\\Command\\Encryption\\DecryptAll' => $baseDir . '/core/Command/Encryption/DecryptAll.php',
@@ -1565,6 +1578,8 @@
     'OC\\MemoryInfo' => $baseDir . '/lib/private/MemoryInfo.php',
     'OC\\Migration\\BackgroundRepair' => $baseDir . '/lib/private/Migration/BackgroundRepair.php',
     'OC\\Migration\\ConsoleOutput' => $baseDir . '/lib/private/Migration/ConsoleOutput.php',
+    'OC\\Migration\\Exceptions\\AttributeException' => $baseDir . '/lib/private/Migration/Exceptions/AttributeException.php',
+    'OC\\Migration\\MetadataManager' => $baseDir . '/lib/private/Migration/MetadataManager.php',
     'OC\\Migration\\NullOutput' => $baseDir . '/lib/private/Migration/NullOutput.php',
     'OC\\Migration\\SimpleOutput' => $baseDir . '/lib/private/Migration/SimpleOutput.php',
     'OC\\NaturalSort' => $baseDir . '/lib/private/NaturalSort.php',
@@ -1844,6 +1859,8 @@
     'OC\\Updater\\Changes' => $baseDir . '/lib/private/Updater/Changes.php',
     'OC\\Updater\\ChangesCheck' => $baseDir . '/lib/private/Updater/ChangesCheck.php',
     'OC\\Updater\\ChangesMapper' => $baseDir . '/lib/private/Updater/ChangesMapper.php',
+    'OC\\Updater\\Exceptions\\ReleaseMetadataException' => $baseDir . '/lib/private/Updater/Exceptions/ReleaseMetadataException.php',
+    'OC\\Updater\\ReleaseMetadata' => $baseDir . '/lib/private/Updater/ReleaseMetadata.php',
     'OC\\Updater\\VersionCheck' => $baseDir . '/lib/private/Updater/VersionCheck.php',
     'OC\\UserStatus\\ISettableProvider' => $baseDir . '/lib/private/UserStatus/ISettableProvider.php',
     'OC\\UserStatus\\Manager' => $baseDir . '/lib/private/UserStatus/Manager.php',

lib/composer/composer/autoload_static.php

@@ -588,6 +588,18 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
         'OCP\\Mail\\IEMailTemplate' => __DIR__ . '/../../..' . '/lib/public/Mail/IEMailTemplate.php',
         'OCP\\Mail\\IMailer' => __DIR__ . '/../../..' . '/lib/public/Mail/IMailer.php',
         'OCP\\Mail\\IMessage' => __DIR__ . '/../../..' . '/lib/public/Mail/IMessage.php',
+        'OCP\\Migration\\Attributes\\AddColumn' => __DIR__ . '/../../..' . '/lib/public/Migration/Attributes/AddColumn.php',
+        'OCP\\Migration\\Attributes\\AddIndex' => __DIR__ . '/../../..' . '/lib/public/Migration/Attributes/AddIndex.php',
+        'OCP\\Migration\\Attributes\\ColumnMigrationAttribute' => __DIR__ . '/../../..' . '/lib/public/Migration/Attributes/ColumnMigrationAttribute.php',
+        'OCP\\Migration\\Attributes\\CreateTable' => __DIR__ . '/../../..' . '/lib/public/Migration/Attributes/CreateTable.php',
+        'OCP\\Migration\\Attributes\\DropColumn' => __DIR__ . '/../../..' . '/lib/public/Migration/Attributes/DropColumn.php',
+        'OCP\\Migration\\Attributes\\DropIndex' => __DIR__ . '/../../..' . '/lib/public/Migration/Attributes/DropIndex.php',
+        'OCP\\Migration\\Attributes\\DropTable' => __DIR__ . '/../../..' . '/lib/public/Migration/Attributes/DropTable.php',
+        'OCP\\Migration\\Attributes\\GenericMigrationAttribute' => __DIR__ . '/../../..' . '/lib/public/Migration/Attributes/GenericMigrationAttribute.php',
+        'OCP\\Migration\\Attributes\\IndexMigrationAttribute' => __DIR__ . '/../../..' . '/lib/public/Migration/Attributes/IndexMigrationAttribute.php',
+        'OCP\\Migration\\Attributes\\MigrationAttribute' => __DIR__ . '/../../..' . '/lib/public/Migration/Attributes/MigrationAttribute.php',
+        'OCP\\Migration\\Attributes\\ModifyColumn' => __DIR__ . '/../../..' . '/lib/public/Migration/Attributes/ModifyColumn.php',
+        'OCP\\Migration\\Attributes\\TableMigrationAttribute' => __DIR__ . '/../../..' . '/lib/public/Migration/Attributes/TableMigrationAttribute.php',
         'OCP\\Migration\\BigIntMigration' => __DIR__ . '/../../..' . '/lib/public/Migration/BigIntMigration.php',
         'OCP\\Migration\\IMigrationStep' => __DIR__ . '/../../..' . '/lib/public/Migration/IMigrationStep.php',
         'OCP\\Migration\\IOutput' => __DIR__ . '/../../..' . '/lib/public/Migration/IOutput.php',
@@ -1104,6 +1116,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
         'OC\\Core\\Command\\Db\\Migrations\\ExecuteCommand' => __DIR__ . '/../../..' . '/core/Command/Db/Migrations/ExecuteCommand.php',
         'OC\\Core\\Command\\Db\\Migrations\\GenerateCommand' => __DIR__ . '/../../..' . '/core/Command/Db/Migrations/GenerateCommand.php',
         'OC\\Core\\Command\\Db\\Migrations\\MigrateCommand' => __DIR__ . '/../../..' . '/core/Command/Db/Migrations/MigrateCommand.php',
+        'OC\\Core\\Command\\Db\\Migrations\\PreviewCommand' => __DIR__ . '/../../..' . '/core/Command/Db/Migrations/PreviewCommand.php',
         'OC\\Core\\Command\\Db\\Migrations\\StatusCommand' => __DIR__ . '/../../..' . '/core/Command/Db/Migrations/StatusCommand.php',
         'OC\\Core\\Command\\Encryption\\ChangeKeyStorageRoot' => __DIR__ . '/../../..' . '/core/Command/Encryption/ChangeKeyStorageRoot.php',
         'OC\\Core\\Command\\Encryption\\DecryptAll' => __DIR__ . '/../../..' . '/core/Command/Encryption/DecryptAll.php',
@@ -1598,6 +1611,8 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
         'OC\\MemoryInfo' => __DIR__ . '/../../..' . '/lib/private/MemoryInfo.php',
         'OC\\Migration\\BackgroundRepair' => __DIR__ . '/../../..' . '/lib/private/Migration/BackgroundRepair.php',
         'OC\\Migration\\ConsoleOutput' => __DIR__ . '/../../..' . '/lib/private/Migration/ConsoleOutput.php',
+        'OC\\Migration\\Exceptions\\AttributeException' => __DIR__ . '/../../..' . '/lib/private/Migration/Exceptions/AttributeException.php',
+        'OC\\Migration\\MetadataManager' => __DIR__ . '/../../..' . '/lib/private/Migration/MetadataManager.php',
         'OC\\Migration\\NullOutput' => __DIR__ . '/../../..' . '/lib/private/Migration/NullOutput.php',
         'OC\\Migration\\SimpleOutput' => __DIR__ . '/../../..' . '/lib/private/Migration/SimpleOutput.php',
         'OC\\NaturalSort' => __DIR__ . '/../../..' . '/lib/private/NaturalSort.php',
@@ -1877,6 +1892,8 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
         'OC\\Updater\\Changes' => __DIR__ . '/../../..' . '/lib/private/Updater/Changes.php',
         'OC\\Updater\\ChangesCheck' => __DIR__ . '/../../..' . '/lib/private/Updater/ChangesCheck.php',
         'OC\\Updater\\ChangesMapper' => __DIR__ . '/../../..' . '/lib/private/Updater/ChangesMapper.php',
+        'OC\\Updater\\Exceptions\\ReleaseMetadataException' => __DIR__ . '/../../..' . '/lib/private/Updater/Exceptions/ReleaseMetadataException.php',
+        'OC\\Updater\\ReleaseMetadata' => __DIR__ . '/../../..' . '/lib/private/Updater/ReleaseMetadata.php',
         'OC\\Updater\\VersionCheck' => __DIR__ . '/../../..' . '/lib/private/Updater/VersionCheck.php',
         'OC\\UserStatus\\ISettableProvider' => __DIR__ . '/../../..' . '/lib/private/UserStatus/ISettableProvider.php',
         'OC\\UserStatus\\Manager' => __DIR__ . '/../../..' . '/lib/private/UserStatus/Manager.php',

lib/private/Migration/Exceptions/AttributeException.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OC\Migration\Exceptions;
+
+use Exception;
+
+/**
+ * @since 30.0.0
+ */
+class AttributeException extends Exception {
+}

lib/private/Migration/MetadataManager.php

@@ -0,0 +1,139 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+namespace OC\Migration;
+
+use OC\DB\Connection;
+use OC\DB\MigrationService;
+use OC\Migration\Exceptions\AttributeException;
+use OCP\App\IAppManager;
+use OCP\Migration\Attributes\GenericMigrationAttribute;
+use OCP\Migration\Attributes\MigrationAttribute;
+use Psr\Log\LoggerInterface;
+
+/**
+ * Helps managing DB Migrations' Metadata
+ *
+ * @since 30.0.0
+ */
+class MetadataManager {
+	public function __construct(
+		private IAppManager $appManager,
+		private Connection $connection,
+		private LoggerInterface $logger,
+	) {
+	}
+
+	/**
+	 * convert direct data from release metadata into a list of Migrations' Attribute
+	 *
+	 * @param array<array-key, array<array-key, array>> $metadata
+	 * @param bool $filterKnownMigrations ignore metadata already done in local instance
+	 *
+	 * @return array{apps: array<array-key, array<string, MigrationAttribute[]>>, core: array<string, MigrationAttribute[]>}
+	 * @since 30.0.0
+	 */
+	public function getMigrationsAttributesFromReleaseMetadata(
+		array $metadata,
+		bool $filterKnownMigrations = false
+	): array {
+		$appsAttributes = [];
+		foreach (array_keys($metadata['apps']) as $appId) {
+			if ($filterKnownMigrations && !$this->appManager->isInstalled($appId)) {
+				continue; // if not interested and app is not installed
+			}
+
+			$done = ($filterKnownMigrations) ? $this->getKnownMigrations($appId) : [];
+			$appsAttributes[$appId] = $this->parseMigrations($metadata['apps'][$appId] ?? [], $done);
+		}
+
+		$done = ($filterKnownMigrations) ? $this->getKnownMigrations('core') : [];
+		return [
+			'core' => $this->parseMigrations($metadata['core'] ?? [], $done),
+			'apps' => $appsAttributes
+		];
+	}
+
+	/**
+	 * returns list of installed apps that does not support migrations metadata (yet)
+	 *
+	 * @param array<array-key, array<array-key, array>> $metadata
+	 *
+	 * @return string[]
+	 * @since 30.0.0
+	 */
+	public function getUnsupportedApps(array $metadata): array {
+		return array_values(array_diff($this->appManager->getInstalledApps(), array_keys($metadata['apps'])));
+	}
+
+	/**
+	 * convert raw data to a list of MigrationAttribute
+	 *
+	 * @param array $migrations
+	 * @param array $ignoreMigrations
+	 *
+	 * @return array<string, MigrationAttribute[]>
+	 */
+	private function parseMigrations(array $migrations, array $ignoreMigrations = []): array {
+		$parsed = [];
+		foreach (array_keys($migrations) as $entry) {
+			if (in_array($entry, $ignoreMigrations)) {
+				continue;
+			}
+
+			$parsed[$entry] = [];
+			foreach ($migrations[$entry] as $item) {
+				try {
+					$parsed[$entry][] = $this->createAttribute($item);
+				} catch (AttributeException $e) {
+					$this->logger->warning('exception while trying to create attribute', ['exception' => $e, 'item' => json_encode($item)]);
+					$parsed[$entry][] = new GenericMigrationAttribute($item);
+				}
+			}
+		}
+
+		return $parsed;
+	}
+
+	/**
+	 * returns migrations already done
+	 *
+	 * @param string $appId
+	 *
+	 * @return array
+	 * @throws \Exception
+	 */
+	private function getKnownMigrations(string $appId): array {
+		$ms = new MigrationService($appId, $this->connection);
+		return $ms->getMigratedVersions();
+	}
+
+	/**
+	 * generate (deserialize) a MigrationAttribute from a serialized version
+	 *
+	 * @param array $item
+	 *
+	 * @return MigrationAttribute
+	 * @throws AttributeException
+	 */
+	private function createAttribute(array $item): MigrationAttribute {
+		$class = $item['class'] ?? '';
+		$namespace = 'OCP\Migration\Attributes\\';
+		if (!str_starts_with($class, $namespace)
+			|| !ctype_alpha(substr($class, strlen($namespace)))) {
+			throw new AttributeException('class name does not looks valid');
+		}
+
+		try {
+			$attribute = new $class($item['table'] ?? '');
+			return $attribute->import($item);
+		} catch (\Error) {
+			throw new AttributeException('cannot import Attribute');
+		}
+	}
+}

lib/private/Updater/Exceptions/ReleaseMetadataException.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OC\Updater\Exceptions;
+
+use Exception;
+
+/**
+ * @since 30.0.0
+ */
+class ReleaseMetadataException extends Exception {
+}