Merge pull request #28383 from nextcloud/backport/28318/stable21

[stable21] Make "name" column nullable for workflows

Author: MichaIng

apps/workflowengine/appinfo/info.xml

@@ -5,7 +5,7 @@
 	<name>Nextcloud workflow engine</name>
 	<summary>Nextcloud workflow engine</summary>
 	<description>Nextcloud workflow engine</description>
-	<version>2.3.0</version>
+	<version>2.3.1</version>
 	<licence>agpl</licence>
 	<author>Arthur Schiwon</author>
 	<author>Julius Härtl</author>

apps/workflowengine/composer/composer/autoload_classmap.php

@@ -32,6 +32,7 @@
     'OCA\\WorkflowEngine\\Manager' => $baseDir . '/../lib/Manager.php',
     'OCA\\WorkflowEngine\\Migration\\PopulateNewlyIntroducedDatabaseFields' => $baseDir . '/../lib/Migration/PopulateNewlyIntroducedDatabaseFields.php',
     'OCA\\WorkflowEngine\\Migration\\Version2000Date20190808074233' => $baseDir . '/../lib/Migration/Version2000Date20190808074233.php',
+    'OCA\\WorkflowEngine\\Migration\\Version2200Date20210805101925' => $baseDir . '/../lib/Migration/Version2200Date20210805101925.php',
     'OCA\\WorkflowEngine\\Service\\Logger' => $baseDir . '/../lib/Service/Logger.php',
     'OCA\\WorkflowEngine\\Service\\RuleMatcher' => $baseDir . '/../lib/Service/RuleMatcher.php',
     'OCA\\WorkflowEngine\\Settings\\ASettings' => $baseDir . '/../lib/Settings/ASettings.php',

apps/workflowengine/composer/composer/autoload_static.php

@@ -47,6 +47,7 @@ class ComposerStaticInitWorkflowEngine
         'OCA\\WorkflowEngine\\Manager' => __DIR__ . '/..' . '/../lib/Manager.php',
         'OCA\\WorkflowEngine\\Migration\\PopulateNewlyIntroducedDatabaseFields' => __DIR__ . '/..' . '/../lib/Migration/PopulateNewlyIntroducedDatabaseFields.php',
         'OCA\\WorkflowEngine\\Migration\\Version2000Date20190808074233' => __DIR__ . '/..' . '/../lib/Migration/Version2000Date20190808074233.php',
+        'OCA\\WorkflowEngine\\Migration\\Version2200Date20210805101925' => __DIR__ . '/..' . '/../lib/Migration/Version2200Date20210805101925.php',
         'OCA\\WorkflowEngine\\Service\\Logger' => __DIR__ . '/..' . '/../lib/Service/Logger.php',
         'OCA\\WorkflowEngine\\Service\\RuleMatcher' => __DIR__ . '/..' . '/../lib/Service/RuleMatcher.php',
         'OCA\\WorkflowEngine\\Settings\\ASettings' => __DIR__ . '/..' . '/../lib/Settings/ASettings.php',

apps/workflowengine/lib/Controller/AWorkflowController.php

@@ -34,20 +34,26 @@
 use OCP\AppFramework\OCS\OCSForbiddenException;
 use OCP\AppFramework\OCSController;
 use OCP\IRequest;
+use Psr\Log\LoggerInterface;
 
 abstract class AWorkflowController extends OCSController {
 
 	/** @var Manager */
 	protected $manager;
 
+	/** @var LoggerInterface */
+	private $logger;
+
 	public function __construct(
 		$appName,
 		IRequest $request,
-		Manager $manager
+		Manager $manager,
+		LoggerInterface $logger
 	) {
 		parent::__construct($appName, $request);
 
 		$this->manager = $manager;
+		$this->logger = $logger;
 	}
 
 	/**
@@ -113,6 +119,7 @@ public function create(
 		} catch (\DomainException $e) {
 			throw new OCSForbiddenException($e->getMessage(), $e);
 		} catch (Exception $e) {
+			$this->logger->error('Error when inserting flow', ['exception' => $e]);
 			throw new OCSException('An internal error occurred', $e->getCode(), $e);
 		}
 	}
@@ -140,6 +147,7 @@ public function update(
 		} catch (\DomainException $e) {
 			throw new OCSForbiddenException($e->getMessage(), $e);
 		} catch (Exception $e) {
+			$this->logger->error('Error when updating flow with id ' . $id, ['exception' => $e]);
 			throw new OCSException('An internal error occurred', $e->getCode(), $e);
 		}
 	}
@@ -158,6 +166,7 @@ public function destroy(int $id): DataResponse {
 		} catch (\DomainException $e) {
 			throw new OCSForbiddenException($e->getMessage(), $e);
 		} catch (Exception $e) {
+			$this->logger->error('Error when deleting flow with id ' . $id, ['exception' => $e]);
 			throw new OCSException('An internal error occurred', $e->getCode(), $e);
 		}
 	}

apps/workflowengine/lib/Controller/UserWorkflowsController.php

@@ -33,6 +33,7 @@
 use OCP\IRequest;
 use OCP\IUserSession;
 use OCP\WorkflowEngine\IManager;
+use Psr\Log\LoggerInterface;
 
 class UserWorkflowsController extends AWorkflowController {
 
@@ -46,9 +47,10 @@ public function __construct(
 		$appName,
 		IRequest $request,
 		Manager $manager,
-		IUserSession $session
+		IUserSession $session,
+		LoggerInterface $logger
 	) {
-		parent::__construct($appName, $request, $manager);
+		parent::__construct($appName, $request, $manager, $logger);
 
 		$this->session = $session;
 	}

apps/workflowengine/lib/Migration/Version2000Date20190808074233.php

@@ -66,7 +66,7 @@ public function changeSchema(IOutput $output, Closure $schemaClosure, array $opt
 				'default' => '',
 			]);
 			$table->addColumn('name', Types::STRING, [
-				'notnull' => true,
+				'notnull' => false,
 				'length' => 256,
 				'default' => '',
 			]);

apps/workflowengine/lib/Migration/Version2200Date20210805101925.php

@@ -0,0 +1,54 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2021 Vincent Petry <vincent@nextcloud.com>
+ *
+ * @author Vincent Petry <vincent@nextcloud.com>
+ *
+ * @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 <http://www.gnu.org/licenses/>.
+ *
+ */
+namespace OCA\WorkflowEngine\Migration;
+
+use Closure;
+use OCP\DB\ISchemaWrapper;
+use OCP\Migration\IOutput;
+use OCP\Migration\SimpleMigrationStep;
+
+class Version2200Date20210805101925 extends SimpleMigrationStep {
+
+	/**
+	 * @param IOutput $output
+	 * @param Closure $schemaClosure The `\Closure` returns a `ISchemaWrapper`
+	 * @param array $options
+	 * @return null|ISchemaWrapper
+	 */
+	public function changeSchema(IOutput $output, Closure $schemaClosure, array $options) {
+		/** @var ISchemaWrapper $schema */
+		$schema = $schemaClosure();
+
+		if ($schema->hasTable('flow_operations')) {
+			$table = $schema->getTable('flow_operations');
+			$table->changeColumn('name', [
+				'notnull' => false,
+			]);
+		}
+
+		return $schema;
+	}
+}