Clarify required error information in lmcontrol API

Open
#511 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Active
Tech stack
cpp
Domain
api

Research direction

Start with the lmcontrol API and the discussion in pull request 478, especially the linked comment, to identify the recovery and StateManager error-information use cases. Done means deciding whether and how the interface should expose failed components, intermediate transitions, and the active RunTarget.

Written by the indexing model from the issue text.

Description

com
What

Currently, the lmcontrol API will only provide an enum value as error information indicating if a RunTarget change happed due to a RecoveryAction or a StateManager request.

It is not possible to identify which components have failed in case the transition is triggered by a RecoveryAction.
It is not possible identify intermediate transitions that lead to the final RunTarget.
Knowing in which active RunTarget the error occurred requires tracking of the active RunTarget by the user of the API.

We shall clarify the use cases that need to be supported and extend the interface with the required information.

See also discussion here:
https://github.com/eclipse-score/lifecycle/pull/478#issuecomment-5365753698

Acceptance Criteria (DoD)
  • Decide if and how to extend the interface with this error information
How

No response

Dominant language
C++
Stars
6
Forks
34
Avg merge
1d 23h
Merged PRs (30d)
83

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from eclipse-score/lifecycle

All issues in eclipse-score/lifecycle

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.