feat(task-service)!: add spec compliant task service support by jayzhudev · Pull Request #107 · NVIDIA/nv-redfish

jayzhudev · 2026-05-23T04:28:38Z

Adding this support for RMS firmware upload status checks.

Breaking change:

When the task-service feature is enabled, the redfish::Error now has 2 new variants.

Adding this support for RMS firmware upload status checks. Signed-off-by: Jay Zhu <jayzhu@nvidia.com>

Signed-off-by: Jay Zhu <jayzhu@nvidia.com>

poroh · 2026-05-23T18:17:22Z

+    /// # Errors
+    ///
+    /// Returns error if retrieving task data fails.
+    pub async fn task(&self, task_path: impl ToString) -> Result<Arc<Task>, Error<B>> {


If I understand correctly then it is from Location header from the result of the operation. It would be nice to:

Introduce type for a Location header value

Use it here and task service should check that Location header value corresponds to its own odata.id.

This will express additional knowledge trough type system and better errors if somebody by mistake will use task service for non-task values (I think some vendors may have their own async job services, see Dell OEM jobs for example).

Maybe we also should add separate function that can check that Location is valid Task resource.

This is a very good and thoughtful call, thanks!

After some thinking, I see two options here:

add a Location type. The intent is clearer to the caller but it wouldn't prevent caller mistakes of calling a wrong task service instance - we would still need validation in task calling.

keep the API simple and only add validation inside TaskService::task(). The caller passes the task path, and TaskService checks it is under the BMC's Tasks collection before polling.

Option 2 seems to have the right tradeoff to me because the validation is task-specific, and TaskService already has the Tasks collection needed to do it.

Signed-off-by: Jay Zhu <jayzhu@nvidia.com>

poroh · 2026-05-25T16:40:40Z

+/// ```
+pub struct TaskService<B: Bmc> {
+    data: Arc<TaskServiceSchema>,
+    task_collection: TaskCollectionPath,


Think we should not keep this information inside TaskService. All information is in data (odata.id). Just add method to ODataId type that can check that one OdataId is_path_prefix for another. No need to trim_end_matheces etc. Just add one method here and use it is needed.

nv-redfish/core/src/odata.rs

Line 51 in b5dc784

impl ODataId {

Agreed, I've updated the implementation.

poroh · 2026-05-25T16:46:15Z

+use crate::schema::task_service::TaskService as TaskServiceSchema;
+
+#[doc(inline)]
+pub use crate::schema::task::Task;


nv-redfish has two concept:

Full wrapper like Chassis where you have different custom methods

Link that internally contains just odata-id reference for the object.

It seems that Task should be a link here:

Suggested change

pub use crate::schema::task::Task;

use crate::entity_link::EntityLink;

use crate::schema::task::Task as TaskSchema;

/// Link for accessing task.

pub type TaskLink<B> = EntityLink<B, TaskSchema>;

poroh · 2026-05-25T17:04:09Z

+    ///
+    /// Returns error if the service does not expose a Tasks collection, if the
+    /// path is outside that collection, or if retrieving task data fails.
+    pub async fn task(&self, task_path: impl AsRef<str>) -> Result<Arc<Task>, Error<B>> {


use crate::core::AsyncTask;

Suggested change

pub async fn task(&self, task_path: impl AsRef<str>) -> Result<Arc<Task>, Error<B>> {

pub fn task_link(&self, async_task: AsyncTask) -> Result<TaskLink, Error<B>> {

Internally task_link should check that task service odata id is parent path for AsyncTask::id and constructs link only if this is true.

Note that this method doesn't retrieve any data, just creates handle that can be used to retrieve data. See:

nv-redfish/redfish/src/entity_link.rs

Line 94 in b5dc784

pub async fn fetch(&self) -> Result<Arc<T>, Error<B>> {

Thanks for sharing this! This utility seems to be the right pattern to use. I've updated the implementation.

…taId Add ODataId prefix checks and use them to validate async task links without caching path prefixes. Signed-off-by: Jay Zhu <jayzhu@nvidia.com>

poroh · 2026-05-25T18:19:52Z

 pub struct TaskService<B: Bmc> {
    data: Arc<TaskServiceSchema>,
-    task_collection: TaskCollectionPath,
+    task_collection: ODataId,


This copy of odata_id is redundant. You can use data.odata_id() when this value is needed.

Replaced it with data.tasks.odata_id.

poroh · 2026-05-25T18:20:28Z

-        if !task_path.starts_with(self.task_collection.prefix.as_str()) {
+    /// Returns error if the task ID is not a child of this service's Tasks
+    /// collection.
+    pub fn task_link(&self, task: &AsyncTask) -> Result<TaskLink<B>, Error<B>> {


To avoid "clones" just use task: AsyncTask.

The tradeoff is around consuming the task versus cloning just the id (current implementation). I chose the latter in case the caller still needs the task (for the retry_after_secs field).

Signed-off-by: Jay Zhu <jayzhu@nvidia.com>

If a caller needs other fields in the AsyncTask, it can choose to clone other fields or the entire AsyncTask before it's consumed by task_link. The idea is that task_link doesn't implicitly clone the ID string within the method - cloning happens based on the choice of the caller. Signed-off-by: Jay Zhu <jayzhu@nvidia.com>

Rename async task IDs to task locations, convert retry_after_secs to std::time::Duration, align TaskService errors, docs, examples, and tests with the new naming. Signed-off-by: Jay Zhu <jayzhu@nvidia.com>

jayzhudev requested a review from yoks May 23, 2026 04:28

jayzhudev marked this pull request as draft May 23, 2026 04:40

feat(task-service): add spec compliant task service support

8843eb4

Adding this support for RMS firmware upload status checks. Signed-off-by: Jay Zhu <jayzhu@nvidia.com>

jayzhudev force-pushed the feat/task-service branch from dbf067b to 8843eb4 Compare May 23, 2026 05:37

jayzhudev marked this pull request as ready for review May 23, 2026 05:37

jayzhudev marked this pull request as draft May 23, 2026 05:40

tests(task-service): move tests out so redfish does not need dev-deps

815cfe1

Signed-off-by: Jay Zhu <jayzhu@nvidia.com>

jayzhudev force-pushed the feat/task-service branch from 7d49e50 to 815cfe1 Compare May 23, 2026 05:47

jayzhudev marked this pull request as ready for review May 23, 2026 05:57

jayzhudev requested a review from poroh May 23, 2026 06:12

poroh reviewed May 23, 2026

View reviewed changes

feat(task-service)!: add task_path validation against task collection

e32f1e5

Signed-off-by: Jay Zhu <jayzhu@nvidia.com>

jayzhudev requested a review from poroh May 23, 2026 21:14

chore(task-service): let..else instead of if let for readability

80b752e

Signed-off-by: Jay Zhu <jayzhu@nvidia.com>

jayzhudev changed the title ~~feat(task-service): add spec compliant task service support~~ feat(task-service)!: add spec compliant task service support May 23, 2026

poroh requested changes May 25, 2026

View reviewed changes

refactor(task-service): use task link and move path validation to ODa…

c198b00

…taId Add ODataId prefix checks and use them to validate async task links without caching path prefixes. Signed-off-by: Jay Zhu <jayzhu@nvidia.com>

jayzhudev requested a review from poroh May 25, 2026 18:20

poroh reviewed May 25, 2026

View reviewed changes

chore(task-service): remove redundant task_collection field

0030619

Signed-off-by: Jay Zhu <jayzhu@nvidia.com>

jayzhudev requested a review from poroh May 25, 2026 18:34

jayzhudev added 2 commits May 25, 2026 12:53

refactor(task-service): make async task locations explicit

79d1c27

Rename async task IDs to task locations, convert retry_after_secs to std::time::Duration, align TaskService errors, docs, examples, and tests with the new naming. Signed-off-by: Jay Zhu <jayzhu@nvidia.com>

jayzhudev force-pushed the feat/task-service branch from 8784288 to 79d1c27 Compare May 25, 2026 20:18

poroh approved these changes May 25, 2026

View reviewed changes

jayzhudev merged commit 8bd4ebd into NVIDIA:main May 25, 2026
4 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(task-service)!: add spec compliant task service support#107

feat(task-service)!: add spec compliant task service support#107
jayzhudev merged 8 commits into
NVIDIA:mainfrom
jayzhudev:feat/task-service

jayzhudev commented May 23, 2026 •

edited

Loading

Uh oh!

poroh May 23, 2026

Uh oh!

poroh May 23, 2026

Uh oh!

jayzhudev May 23, 2026

Uh oh!

poroh May 25, 2026

Uh oh!

jayzhudev May 25, 2026

Uh oh!

poroh May 25, 2026

Uh oh!

poroh May 25, 2026

Uh oh!

jayzhudev May 25, 2026

Uh oh!

poroh May 25, 2026

Uh oh!

jayzhudev May 25, 2026

Uh oh!

poroh May 25, 2026

Uh oh!

jayzhudev May 25, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

-pub use crate::schema::task::Task;
+use crate::entity_link::EntityLink;
+use crate::schema::task::Task as TaskSchema;
+/// Link for accessing task.
+pub type TaskLink<B> = EntityLink<B, TaskSchema>;

	pub async fn task(&self, task_path: impl AsRef<str>) -> Result<Arc<Task>, Error<B>> {
	pub fn task_link(&self, async_task: AsyncTask) -> Result<TaskLink, Error<B>> {

Conversation

jayzhudev commented May 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

jayzhudev commented May 23, 2026 •

edited

Loading