Merge pull request #57491 from nextcloud/fix/taskprocessing-userfacingerrormessage-responsedef

nickvergessen · web-flow · commit 408f9e825679 · 2026-01-13T10:27:01.000+01:00
fix(TaskProcessing): Expose userFacingErrorMessage on ResponseDefinitions#CoreTaskProcessingTask
diff --git a/core/ResponseDefinitions.php b/core/ResponseDefinitions.php
@@ -212,6 +212,7 @@
  *     endedAt: ?int,
  *     allowCleanup: bool,
  *     includeWatermark: bool,
+ *     userFacingErrorMessage: ?string,
  * }
  *
  * @psalm-type CoreProfileAction = array{
diff --git a/core/openapi-ex_app.json b/core/openapi-ex_app.json
@@ -203,7 +203,8 @@
                     "startedAt",
                     "endedAt",
                     "allowCleanup",
-                    "includeWatermark"
+                    "includeWatermark",
+                    "userFacingErrorMessage"
                 ],
                 "properties": {
                     "id": {
@@ -280,6 +281,10 @@
                     },
                     "includeWatermark": {
                         "type": "boolean"
+                    },
+                    "userFacingErrorMessage": {
+                        "type": "string",
+                        "nullable": true
                     }
                 }
             },
diff --git a/core/openapi-full.json b/core/openapi-full.json
@@ -663,7 +663,8 @@
                     "startedAt",
                     "endedAt",
                     "allowCleanup",
-                    "includeWatermark"
+                    "includeWatermark",
+                    "userFacingErrorMessage"
                 ],
                 "properties": {
                     "id": {
@@ -740,6 +741,10 @@
                     },
                     "includeWatermark": {
                         "type": "boolean"
+                    },
+                    "userFacingErrorMessage": {
+                        "type": "string",
+                        "nullable": true
                     }
                 }
             },
diff --git a/core/openapi.json b/core/openapi.json
@@ -663,7 +663,8 @@
                     "startedAt",
                     "endedAt",
                     "allowCleanup",
-                    "includeWatermark"
+                    "includeWatermark",
+                    "userFacingErrorMessage"
                 ],
                 "properties": {
                     "id": {
@@ -740,6 +741,10 @@
                     },
                     "includeWatermark": {
                         "type": "boolean"
+                    },
+                    "userFacingErrorMessage": {
+                        "type": "string",
+                        "nullable": true
                     }
                 }
             },
diff --git a/lib/public/TaskProcessing/Task.php b/lib/public/TaskProcessing/Task.php
@@ -295,7 +295,7 @@ final public function setIncludeWatermark(bool $includeWatermark): void {
 	}
 
 	/**
-	 * @psalm-return array{id: int, lastUpdated: int, type: string, status: 'STATUS_CANCELLED'|'STATUS_FAILED'|'STATUS_SUCCESSFUL'|'STATUS_RUNNING'|'STATUS_SCHEDULED'|'STATUS_UNKNOWN', userId: ?string, appId: string, input: array<string, list<numeric|string>|numeric|string>, output: ?array<string, list<numeric|string>|numeric|string>, customId: ?string, completionExpectedAt: ?int, progress: ?float, scheduledAt: ?int, startedAt: ?int, endedAt: ?int, allowCleanup: bool, includeWatermark: bool}
+	 * @psalm-return array{id: int, lastUpdated: int, type: string, status: 'STATUS_CANCELLED'|'STATUS_FAILED'|'STATUS_SUCCESSFUL'|'STATUS_RUNNING'|'STATUS_SCHEDULED'|'STATUS_UNKNOWN', userId: ?string, appId: string, input: array<string, list<numeric|string>|numeric|string>, output: ?array<string, list<numeric|string>|numeric|string>, customId: ?string, completionExpectedAt: ?int, progress: ?float, scheduledAt: ?int, startedAt: ?int, endedAt: ?int, allowCleanup: bool, includeWatermark: bool, userFacingErrorMessage: ?string}
 	 * @since 30.0.0
 	 */
 	final public function jsonSerialize(): array {
@@ -316,6 +316,7 @@ final public function jsonSerialize(): array {
 			'endedAt' => $this->getEndedAt(),
 			'allowCleanup' => $this->getAllowCleanup(),
 			'includeWatermark' => $this->getIncludeWatermark(),
+			'userFacingErrorMessage' => $this->getUserFacingErrorMessage(),
 		];
 	}
 
diff --git a/openapi.json b/openapi.json
@@ -709,7 +709,8 @@
                     "startedAt",
                     "endedAt",
                     "allowCleanup",
-                    "includeWatermark"
+                    "includeWatermark",
+                    "userFacingErrorMessage"
                 ],
                 "properties": {
                     "id": {
@@ -786,6 +787,10 @@
                     },
                     "includeWatermark": {
                         "type": "boolean"
+                    },
+                    "userFacingErrorMessage": {
+                        "type": "string",
+                        "nullable": true
                     }
                 }
             },

Original file line number	Diff line number	Diff line change
`@@ -212,6 +212,7 @@`
`212`	`212`	`* endedAt: ?int,`
`213`	`213`	`* allowCleanup: bool,`
`214`	`214`	`* includeWatermark: bool,`
	`215`	`+ * userFacingErrorMessage: ?string,`
`215`	`216`	`* }`
`216`	`217`	`*`
`217`	`218`	`* @psalm-type CoreProfileAction = array{`
Original file line number	Diff line number	Diff line change
`@@ -295,7 +295,7 @@ final public function setIncludeWatermark(bool $includeWatermark): void {`
`295`	`295`	`}`
`296`	`296`
`297`	`297`	`/**`
`298`		`- * @psalm-return array{id: int, lastUpdated: int, type: string, status: 'STATUS_CANCELLED'\|'STATUS_FAILED'\|'STATUS_SUCCESSFUL'\|'STATUS_RUNNING'\|'STATUS_SCHEDULED'\|'STATUS_UNKNOWN', userId: ?string, appId: string, input: array<string, list<numeric\|string>\|numeric\|string>, output: ?array<string, list<numeric\|string>\|numeric\|string>, customId: ?string, completionExpectedAt: ?int, progress: ?float, scheduledAt: ?int, startedAt: ?int, endedAt: ?int, allowCleanup: bool, includeWatermark: bool}`
	`298`	+ * @psalm-return array{id: int, lastUpdated: int, type: string, status: 'STATUS_CANCELLED'\|'STATUS_FAILED'\|'STATUS_SUCCESSFUL'\|'STATUS_RUNNING'\|'STATUS_SCHEDULED'\|'STATUS_UNKNOWN', userId: ?string, appId: string, input: array<string, list<numeric\|string>\|numeric\|string>, output: ?array<string, list<numeric\|string>\|numeric\|string>, customId: ?string, completionExpectedAt: ?int, progress: ?float, scheduledAt: ?int, startedAt: ?int, endedAt: ?int, allowCleanup: bool, includeWatermark: bool, userFacingErrorMessage: ?string}
`299`	`299`	`* @since 30.0.0`
`300`	`300`	`*/`
`301`	`301`	`final public function jsonSerialize(): array {`
`@@ -316,6 +316,7 @@ final public function jsonSerialize(): array {`
`316`	`316`	`'endedAt' => $this->getEndedAt(),`
`317`	`317`	`'allowCleanup' => $this->getAllowCleanup(),`
`318`	`318`	`'includeWatermark' => $this->getIncludeWatermark(),`
	`319`	`+ 'userFacingErrorMessage' => $this->getUserFacingErrorMessage(),`
`319`	`320`	`];`
`320`	`321`	`}`
`321`	`322`