feat(taskprocessing): add option for user-facing error message

[kyteinsky]

Corresponding API in the server: https://github.com/nextcloud/server/blob/72b89abd47512e9cc337401133d9487996e6f119/core/Controller/TaskProcessingApiController.php#L637

Changes proposed in this pull request:

• add option for user-facing error messagein report_result

Summary by CodeRabbit

• New Features
  • Added support for including a user-facing error message when reporting task processing results.
  • Available for both synchronous and asynchronous task processing APIs.
  • The message is submitted alongside task output and technical error details.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 097032db-766c-458a-a8cb-1a31a292e75b

📥 Commits

Reviewing files that changed from the base of the PR and between a343e7f and 1882d66.

📒 Files selected for processing (1)

• nc_py_api/ex_app/providers/task_processing.py

---

📝 Walkthrough

Walkthrough

Task processing result reporting now accepts an optional user-facing error message in both synchronous and asynchronous APIs and sends it to Nextcloud as userFacingErrorMessage.

Changes

Task result reporting

Layer / File(s)	Summary
Extend synchronous and asynchronous result submission nc_py_api/ex_app/providers/task_processing.py	Both report_result methods accept user_facing_error_message, document it, and include userFacingErrorMessage in the result POST payload.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

• cloud-py-api/nc_py_api#450: Adds the same parameter and payload field to the synchronous and asynchronous task result reporting APIs.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the main API change: adding an optional user-facing error message to task processing result reporting.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch feat/user-facing-error

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[lukasdotcom]

I actually created the exact same pr 🤣, but feel free to use yours its the exact same code anyway (#450)

[kyteinsky]

ah damn, missed that one.
great minds think alike or something :)

let's merge yours, it came first 🥇
can you adjust the docs to use :param user_facing_error_message: format and add a note about NC 33? It would be good to merge then.

[lukasdotcom]

ah damn, missed that one. great minds think alike or something :)

let's merge yours, it came first 🥇 can you adjust the docs to use :param user_facing_error_message: format and add a note about NC 33? It would be good to merge then.

I just pushed that, but as I don't have any access to this repo you might need to merge it yourself.