Story #12917
open
Support ?include=container_uuid for container request lists and group contents
0%
Description
Users should be able to see the exit code or state=[“Queued”, “Locked”, “Running”, “Cancelled” and “Complete”] from the container_request api method, rather than having to go another layer deeper to the container api method.
Proposed solution¶
Add a general "include" option to the index (list) method.
include=container includes the contents of the record associated with container_uuid
Can only be used on fields ending in _uuid
A query like this would return:
?include=container
{
"items": [
{
"kind": "arvados#container_request",
"uuid": "abc-123",
"container_uuid": "xyz-123"
...
}
],
"includes": [
{
"uuid": "xyz-123",
"state": "Completed",
"exit_code": 0,
...
}
]
}
Initially we will only adopt this syntax but initially limiting the implementation to only container requests. This should be implemented on the controller side.
If used for anything other than include=container on container_request it should return an API error.
Discussion points for future:
- selecting fields in the includes
- Permission enforcement. Permission to read a container is based on permission to read the container_request, but this is not true generally. For example, permission to read a container request doesn't grant permission to read output_uuid.
- Straightforward to set up a join when the _uuid field points to exactly one record type (only collections, only containers, etc) but more complex when it can point to multiple (owner_uuid, head/tail_uuid on links)
Related issues
Updated by Peter Amstutz over 5 years ago
Suggest adding virtual fields container_state and container_exit_code which have the value of the corresponding fields of the record with container_uuid, or null if no container is assigned.
Alternately, we could add a query parameter which specifies that we want the entire container record embedded in the response.
Updated by Tom Morris about 5 years ago
- Subject changed from Users should be able to see if a CR failed from the CR method to Users should be able to see if a container failed from the container_request method
Updated by Tom Clegg about 5 years ago
IMO, these aren't container_request fields so they shouldn't appear as container_request fields.
Suggest we support an "include container record" flag in container_requests#index and #show requests, and return the whole container record.
Since we're not (yet?) using jsonapi, we need to choose a response format for this. We should use something that can extend to other similar situations, like "include created_by_user record".
Updated by Tom Clegg about 5 years ago
Updated by Tom Morris about 5 years ago
- Related to Story #13327: More responsive page loads with API ?include=container_uuid added
Updated by Peter Amstutz about 5 years ago
- Description updated (diff)
- Story points set to 2.0
Updated by Peter Amstutz about 5 years ago
Just one thought, we have wandered a little bit from the original goal of making the API easier for getting container status from container_request. Returing a separate "includes" section takes a similar amount of Python code to interpret as the current approach that requires making a second API call. Embedding the record in each item so that one can can write items0[container][state] is much simpler for the user (ie Bryan).
That said, "includes" is a more general solution that is better suited for other use cases like optimizing Workbench queries and so probably still the one we go with.
Updated by Tom Clegg about 5 years ago
Perhaps the client library could offer a "join response items" convenience function that assigns includes[x] to items[y][f] for all items[y][f+'_uuid']==includes[x]['uuid']...?
Updated by Tom Morris about 5 years ago
- Target version changed from To Be Groomed to 2018-04-25 Sprint
Updated by Peter Amstutz about 5 years ago
- Has duplicate Story #13145: Include container status & exit code in container request response added
Updated by Peter Amstutz about 5 years ago
- Target version changed from 2018-04-25 Sprint to 2018-05-09 Sprint
Updated by Tom Morris about 5 years ago
- Assigned To deleted (
Peter Amstutz) - Target version changed from 2018-05-09 Sprint to Arvados Future Sprints
Updated by Tom Morris over 3 years ago
- Related to Bug #15672: List of subprocesses limited in process view added
Updated by Peter Amstutz over 3 years ago
- Target version changed from Arvados Future Sprints to 2020-02-12 Sprint
Updated by Lucas Di Pentima over 3 years ago
- Assigned To set to Lucas Di Pentima
Updated by Lucas Di Pentima over 3 years ago
- Related to deleted (Story #13327: More responsive page loads with API ?include=container_uuid)
Updated by Lucas Di Pentima over 3 years ago
- Blocks Story #13327: More responsive page loads with API ?include=container_uuid added
Updated by Lucas Di Pentima over 3 years ago
- Status changed from New to In Progress
Updated by Lucas Di Pentima over 3 years ago
- Target version changed from 2020-02-12 Sprint to 2020-02-26 Sprint
Updated by Lucas Di Pentima over 3 years ago
- Target version deleted (
2020-02-26 Sprint) - Status changed from In Progress to New
Updated by Lucas Di Pentima over 3 years ago
- Assigned To deleted (
Lucas Di Pentima) - Category set to API
Updated by Stanislaw Adaszewski about 3 years ago
Again speaking privately here. This seems important. Workbenches are slow because of small API issues like this one. [uuid, in, [...]] filter to retrieve corresponding containers seems always a bit on the slow side. Thank you in advance.
Updated by Peter Amstutz about 1 month ago
- Release deleted (
60) - Story points deleted (
2.0) - Target version set to To be groomed
- Subject changed from Users should be able to see if a container failed from the container_request method to Support ?include=container_uuid for container request lists and group contents