feat(workflowengine): add name, description and collapsible UI to flow rules

apps/workflowengine/composer/composer/autoload_classmap.php

@@ -34,6 +34,7 @@
     '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\\Migration\\Version3000Date20260531150003' => $baseDir . '/../lib/Migration/Version3000Date20260531150003.php',
     'OCA\\WorkflowEngine\\ResponseDefinitions' => $baseDir . '/../lib/ResponseDefinitions.php',
     'OCA\\WorkflowEngine\\Service\\Logger' => $baseDir . '/../lib/Service/Logger.php',
     'OCA\\WorkflowEngine\\Service\\RuleMatcher' => $baseDir . '/../lib/Service/RuleMatcher.php',

apps/workflowengine/composer/composer/autoload_static.php

@@ -49,6 +49,7 @@ class ComposerStaticInitWorkflowEngine
         '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\\Migration\\Version3000Date20260531150003' => __DIR__ . '/..' . '/../lib/Migration/Version3000Date20260531150003.php',
         'OCA\\WorkflowEngine\\ResponseDefinitions' => __DIR__ . '/..' . '/../lib/ResponseDefinitions.php',
         'OCA\\WorkflowEngine\\Service\\Logger' => __DIR__ . '/..' . '/../lib/Service/Logger.php',
         'OCA\\WorkflowEngine\\Service\\RuleMatcher' => __DIR__ . '/..' . '/../lib/Service/RuleMatcher.php',

apps/workflowengine/lib/Controller/AWorkflowOCSController.php

@@ -95,6 +95,7 @@ public function show(string $id): DataResponse {
 	 * @param string $operation Operation class to execute on match
 	 * @param string $entity The matched entity
 	 * @param list<class-string<IEntityEvent>> $events The list of events on which the rule should be validated
+	 * @param string $description Optional free-text description of the workflow rule
 	 * @return DataResponse<Http::STATUS_OK, WorkflowEngineRule, array{}>
 	 *
 	 * 200: Workflow created
@@ -109,10 +110,11 @@ public function create(
 		string $operation,
 		string $entity,
 		array $events,
+		string $description = '',
 	): DataResponse {
 		$context = $this->getScopeContext();
 		try {
-			$operation = $this->manager->addOperation($class, $name, $checks, $operation, $context, $entity, $events);
+			$operation = $this->manager->addOperation($class, $name, $checks, $operation, $context, $entity, $events, $description);
 			$operation = $this->manager->formatOperation($operation);
 			return new DataResponse($operation);
 		} catch (\UnexpectedValueException $e) {
@@ -134,6 +136,7 @@ public function create(
 	 * @param string $operation Operation action to execute on match
 	 * @param string $entity The matched entity
 	 * @param list<class-string<IEntityEvent>> $events The list of events on which the rule should be validated
+	 * @param string $description Optional free-text description of the workflow rule
 	 * @return DataResponse<Http::STATUS_OK, WorkflowEngineRule, array{}>
 	 *
 	 * 200: Workflow updated
@@ -149,10 +152,11 @@ public function update(
 		string $operation,
 		string $entity,
 		array $events,
+		string $description = '',
 	): DataResponse {
 		try {
 			$context = $this->getScopeContext();
-			$operation = $this->manager->updateOperation($id, $name, $checks, $operation, $context, $entity, $events);
+			$operation = $this->manager->updateOperation($id, $name, $checks, $operation, $context, $entity, $events, $description);
 			$operation = $this->manager->formatOperation($operation);
 			return new DataResponse($operation);
 		} catch (\UnexpectedValueException $e) {

apps/workflowengine/lib/Controller/GlobalWorkflowsController.php

@@ -65,6 +65,7 @@ public function show(string $id): DataResponse {
 	 * @param string $operation Operation class to execute on match
 	 * @param string $entity The matched entity
 	 * @param list<class-string<IEntityEvent>> $events The list of events on which the rule should be validated
+	 * @param string $description Optional free-text description of the workflow rule
 	 * @return DataResponse<Http::STATUS_OK, WorkflowEngineRule, array{}>
 	 *
 	 * 200: Workflow created
@@ -74,8 +75,8 @@ public function show(string $id): DataResponse {
 	#[\Override]
 	#[PasswordConfirmationRequired]
 	#[ApiRoute(verb: 'POST', url: '/api/v1/workflows/global')]
-	public function create(string $class, string $name, array $checks, string $operation, string $entity, array $events): DataResponse {
-		return parent::create($class, $name, $checks, $operation, $entity, $events);
+	public function create(string $class, string $name, array $checks, string $operation, string $entity, array $events, string $description = ''): DataResponse {
+		return parent::create($class, $name, $checks, $operation, $entity, $events, $description);
 	}
 
 	/**
@@ -87,6 +88,7 @@ public function create(string $class, string $name, array $checks, string $opera
 	 * @param string $operation Operation action to execute on match
 	 * @param string $entity The matched entity
 	 * @param list<class-string<IEntityEvent>> $events The list of events on which the rule should be validated
+	 * @param string $description Optional free-text description of the workflow rule
 	 * @return DataResponse<Http::STATUS_OK, WorkflowEngineRule, array{}>
 	 *
 	 * 200: Workflow updated
@@ -97,8 +99,8 @@ public function create(string $class, string $name, array $checks, string $opera
 	#[\Override]
 	#[PasswordConfirmationRequired]
 	#[ApiRoute(verb: 'PUT', url: '/api/v1/workflows/global/{id}')]
-	public function update(int $id, string $name, array $checks, string $operation, string $entity, array $events): DataResponse {
-		return parent::update($id, $name, $checks, $operation, $entity, $events);
+	public function update(int $id, string $name, array $checks, string $operation, string $entity, array $events, string $description = ''): DataResponse {
+		return parent::update($id, $name, $checks, $operation, $entity, $events, $description);
 	}
 
 	/**

apps/workflowengine/lib/Controller/UserWorkflowsController.php

@@ -83,6 +83,7 @@ public function show(string $id): DataResponse {
 	 * @param string $operation Operation class to execute on match
 	 * @param string $entity The matched entity
 	 * @param list<class-string<IEntityEvent>> $events The list of events on which the rule should be validated
+	 * @param string $description Optional free-text description of the workflow rule
 	 * @return DataResponse<Http::STATUS_OK, WorkflowEngineRule, array{}>
 	 *
 	 * 200: Workflow created
@@ -93,8 +94,8 @@ public function show(string $id): DataResponse {
 	#[NoAdminRequired]
 	#[PasswordConfirmationRequired]
 	#[ApiRoute(verb: 'POST', url: '/api/v1/workflows/user')]
-	public function create(string $class, string $name, array $checks, string $operation, string $entity, array $events): DataResponse {
-		return parent::create($class, $name, $checks, $operation, $entity, $events);
+	public function create(string $class, string $name, array $checks, string $operation, string $entity, array $events, string $description = ''): DataResponse {
+		return parent::create($class, $name, $checks, $operation, $entity, $events, $description);
 	}
 
 	/**
@@ -106,6 +107,7 @@ public function create(string $class, string $name, array $checks, string $opera
 	 * @param string $operation Operation action to execute on match
 	 * @param string $entity The matched entity
 	 * @param list<class-string<IEntityEvent>> $events The list of events on which the rule should be validated
+	 * @param string $description Optional free-text description of the workflow rule
 	 * @return DataResponse<Http::STATUS_OK, WorkflowEngineRule, array{}>
 	 *
 	 * 200: Workflow updated
@@ -117,8 +119,8 @@ public function create(string $class, string $name, array $checks, string $opera
 	#[NoAdminRequired]
 	#[PasswordConfirmationRequired]
 	#[ApiRoute(verb: 'PUT', url: '/api/v1/workflows/user/{id}')]
-	public function update(int $id, string $name, array $checks, string $operation, string $entity, array $events): DataResponse {
-		return parent::update($id, $name, $checks, $operation, $entity, $events);
+	public function update(int $id, string $name, array $checks, string $operation, string $entity, array $events, string $description = ''): DataResponse {
+		return parent::update($id, $name, $checks, $operation, $entity, $events, $description);
 	}
 
 	/**

apps/workflowengine/lib/Manager.php

@@ -52,6 +52,8 @@
  * @psalm-import-type WorkflowEngineRule from ResponseDefinitions
  */
 class Manager implements IManager {
+	public const MAX_NAME_BYTES = 256;
+
 	/** @var array<string, array<string, array<int, WorkflowEngineCheck>>> */
 	protected array $operations = [];
 
@@ -320,12 +322,14 @@
 		string $operation,
 		string $entity,
 		array $events,
+		string $description = '',
 	): int {
 		$query = $this->connection->getQueryBuilder();
 		$query->insert('flow_operations')
 			->values([
 				'class' => $query->createNamedParameter($class),
 				'name' => $query->createNamedParameter($name),
+				'description' => $query->createNamedParameter($description),
 				'checks' => $query->createNamedParameter(json_encode(array_unique($checkIds))),
 				'operation' => $query->createNamedParameter($operation),
 				'entity' => $query->createNamedParameter($entity),
@@ -452,6 +456,7 @@
 	 * @param string $name
 	 * @param list<WorkflowEngineCheck> $checks
 	 * @param string $operation
+	 * @param string $description optional free-text description shown in the UI
 	 * @return array The added operation
 	 * @throws \UnexpectedValueException
 	 * @throws Exception
@@ -464,8 +469,9 @@
 		ScopeContext $scope,
 		string $entity,
 		array $events,
+		string $description = '',
 	) {
-		$this->validateOperation($class, $name, $checks, $operation, $scope, $entity, $events);
+		$this->validateOperation($class, $name, $checks, $operation, $scope, $entity, $events, $description);
 
 		$this->connection->beginTransaction();
 
@@ -475,7 +481,7 @@
 				$checkIds[] = $this->addCheck($check['class'], $check['operator'], $check['value']);
 			}
 
-			$id = $this->insertOperation($class, $name, $checkIds, $operation, $entity, $events);
+			$id = $this->insertOperation($class, $name, $checkIds, $operation, $entity, $events, $description);
 			$this->addScope($id, $scope);
 
 			$this->connection->commit();
@@ -520,6 +526,7 @@
 	 * @param string $name
 	 * @param list<WorkflowEngineCheck> $checks
 	 * @param string $operation
+	 * @param string $description optional free-text description shown in the UI
 	 * @return array The updated operation
 	 * @throws \UnexpectedValueException
 	 * @throws \DomainException
@@ -533,12 +540,13 @@
 		ScopeContext $scopeContext,
 		string $entity,
 		array $events,
+		string $description = '',
 	): array {
 		if (!$this->canModify($id, $scopeContext)) {
 			throw new \DomainException('Target operation not within scope');
 		};
 		$row = $this->getOperation($id);
-		$this->validateOperation($row['class'], $name, $checks, $operation, $scopeContext, $entity, $events);
+		$this->validateOperation($row['class'], $name, $checks, $operation, $scopeContext, $entity, $events, $description);
 
 		$checkIds = [];
 		try {
@@ -550,6 +558,7 @@
 			$query = $this->connection->getQueryBuilder();
 			$query->update('flow_operations')
 				->set('name', $query->createNamedParameter($name))
+				->set('description', $query->createNamedParameter($description))
 				->set('checks', $query->createNamedParameter(json_encode(array_unique($checkIds))))
 				->set('operation', $query->createNamedParameter($operation))
 				->set('entity', $query->createNamedParameter($entity))
@@ -609,7 +618,7 @@
 	 */
 	protected function validateEvents(string $entity, array $events, IOperation $operation): void {
 		/** @psalm-suppress TaintedCallable newInstance is not called */
 		$reflection = new \ReflectionClass($entity);
 		if ($entity !== IEntity::class && !in_array(IEntity::class, $reflection->getInterfaceNames())) {
 			throw new \UnexpectedValueException($this->l->t('Entity %s is invalid', [$entity]));
 		}
@@ -645,13 +654,17 @@
 	 * @param array $events
 	 * @throws \UnexpectedValueException
 	 */
-	public function validateOperation(string $class, string $name, array $checks, string $operation, ScopeContext $scope, string $entity, array $events): void {
+	public function validateOperation(string $class, string $name, array $checks, string $operation, ScopeContext $scope, string $entity, array $events, string $description = ''): void {
 		if (strlen($operation) > IManager::MAX_OPERATION_VALUE_BYTES) {
 			throw new \UnexpectedValueException($this->l->t('The provided operation data is too long'));
 		}
 
+		if (strlen($name) > self::MAX_NAME_BYTES) {
+			throw new \UnexpectedValueException($this->l->t('The provided name is too long'));
+		}
+
 		/** @psalm-suppress TaintedCallable newInstance is not called */
 		$reflection = new \ReflectionClass($class);
 		if ($class !== IOperation::class && !in_array(IOperation::class, $reflection->getInterfaceNames())) {
 			throw new \UnexpectedValueException($this->l->t('Operation %s is invalid', [$class]) . join(', ', $reflection->getInterfaceNames()));
 		}
@@ -684,7 +697,7 @@
 				throw new \UnexpectedValueException($this->l->t('The provided check value is too long'));
 			}
 
 			$reflection = new \ReflectionClass($check['class']);
 			if ($check['class'] !== ICheck::class && !in_array(ICheck::class, $reflection->getInterfaceNames())) {
 				throw new \UnexpectedValueException($this->l->t('Check %s is invalid', [$class]));
 			}
@@ -810,7 +823,7 @@
 	}
 
 	/**
-	 * @param array{class: class-string<\OCP\WorkflowEngine\IOperation>, entity: class-string<\OCP\WorkflowEngine\IEntity>, checks: string, events: string, id: int, name: string, operation: string} $operation
+	 * @param array{class: class-string<\OCP\WorkflowEngine\IOperation>, entity: class-string<\OCP\WorkflowEngine\IEntity>, checks: string, events: string, id: int, name: string, description: ?string, operation: string} $operation
 	 * @return WorkflowEngineRule
 	 */
 	public function formatOperation(array $operation): array {
@@ -823,6 +836,9 @@
 		$events = json_decode($operation['events'], true) ?? [];
 		$operation['events'] = $events;
 
+		$operation['name'] = (string)($operation['name'] ?? '');
+		$operation['description'] = (string)($operation['description'] ?? '');
+
 		return $operation;
 	}
 

apps/workflowengine/lib/Migration/Version3000Date20260531150003.php

@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2026 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\WorkflowEngine\Migration;
+
+use Closure;
+use OCP\DB\ISchemaWrapper;
+use OCP\DB\Types;
+use OCP\Migration\IOutput;
+use OCP\Migration\SimpleMigrationStep;
+use Override;
+
+/**
+ * Adds an optional description column to flow_operations
+ */
+class Version3000Date20260531150003 extends SimpleMigrationStep {
+	/**
+	 * @param IOutput $output
+	 * @param Closure(): ISchemaWrapper $schemaClosure
+	 * @param array $options
+	 * @return null|ISchemaWrapper
+	 */
+	#[Override]
+	public function changeSchema(IOutput $output, Closure $schemaClosure, array $options): ?ISchemaWrapper {
+		$schema = $schemaClosure();
+
+		if (!$schema->hasTable('flow_operations')) {
+			return null;
+		}
+
+		$table = $schema->getTable('flow_operations');
+		if (!$table->hasColumn('description')) {
+			$table->addColumn('description', Types::TEXT, [
+				'notnull' => false,
+				'default' => null,
+			]);
+		}
+
+		return $schema;
+	}
+}

apps/workflowengine/lib/ResponseDefinitions.php

@@ -27,6 +27,7 @@
  *   id: int,
  *   class: class-string<IOperation>,
  *   name: string,
+ *   description: string,
  *   checks: list<WorkflowEngineCheck>,
  *   operation: string,
  *   entity: class-string<IEntity>,

apps/workflowengine/openapi-administration.json

@@ -89,6 +89,7 @@
                     "id",
                     "class",
                     "name",
+                    "description",
                     "checks",
                     "operation",
                     "entity",
@@ -106,6 +107,9 @@
                     "name": {
                         "type": "string"
                     },
+                    "description": {
+                        "type": "string"
+                    },
                     "checks": {
                         "type": "array",
                         "items": {
@@ -315,6 +319,11 @@
                                             "type": "string",
                                             "minLength": 1
                                         }
+                                    },
+                                    "description": {
+                                        "type": "string",
+                                        "default": "",
+                                        "description": "Optional free-text description of the workflow rule"
                                     }
                                 }
                             }
@@ -640,6 +649,11 @@
                                             "type": "string",
                                             "minLength": 1
                                         }
+                                    },
+                                    "description": {
+                                        "type": "string",
+                                        "default": "",
+                                        "description": "Optional free-text description of the workflow rule"
                                     }
                                 }
                             }