New API endpoint to back UI jobs index page uplift #20130
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gulducat
force-pushed
the
bff-accurate-jobs-summaries
branch
from
b86c394 to
6218d2a
Compare
tgross
reviewed
Mar 19, 2024
gulducat
force-pushed
the
bff-accurate-jobs-summaries
branch
from
03fcc80 to
7afc007
Compare
gulducat
force-pushed
the
bff-accurate-jobs-summaries
branch
from
01f7d8c to
b681e8b
Compare
example usage:
```
$ cat jobs.json
{
"jobs": [
{"id": "clients", "namespace": "default"},
{"id": "fail"}
]
}
$ cat jobs.json | nomad operator api -X POST /v1/jobs/statuses | jq .
```
with ?index= query param e.g. ``` $ cat jobs.json | nomad operator api -X POST /v1/jobs/statuses?index=1681 | jq . ```
will need to read response headers for index, next_token
This reverts commit 3e0ab67.
in favor of LatestDeployment which has more info
* add ability to include them at all: ?include_children=true * add ParentID to UIJob response, so they can be associated with the parent job * for parent jobs, ChildStatuses should always be an array, rather than nil (null)
gulducat
force-pushed
the
bff-accurate-jobs-summaries
branch
from
7d819dd to
cb8a211
Compare
gulducat
commented
May 3, 2024
philrenaud
approved these changes
May 3, 2024
tgross
approved these changes
May 3, 2024
There was a problem hiding this comment.
This looks great @gulducat!
I've left a few minor comments, but the only one that really raises an eyebrow is the flaky test warning. I'd be open to fixing that in a separate PR though. Also, we'll need to add API docs. That can be a separate PR as well.
Comment on lines
+36
to
+37
| // ostensibly GETs should not accept structured body, but the HTTP spec | ||
| // on this is more what you'd call "guidelines" than actual rules. |
Comment on lines
+105
to
+108
| // this little cutie sets the latest state index to a predictable value, | ||
| // to ensure the below jobs span the boundary from 999->1000 which would | ||
| // break pagination without proper uint64 NextToken (ModifyIndex) comparison | ||
| must.NoError(t, s.State().UpsertNamespaces(996, nil)) |
There was a problem hiding this comment.
Very clever, and good explanatory comment! 👍
my own subtest naming inconsistency was making me twitchy
gulducat
added
theme/api
|
I'm going to lock this pull request because it has been closed for 120 days ⏳. This helps our maintainers find and focus on the active contributions. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Introduce a new API
/v1/jobs/statuses, primarily for use in the UI, that collates info about jobs, their allocations, and latest deployment.Closes #19339 ; UI changes that use it for
/ui/jobspage: #20452Some of noteworthy tidbits:
?filter=s apply tostructs.Job(i.e. one can not filter based on allocs or such)/v1/jobs, then sorts client-side, but we're introducing pagination here, so less efficient in one sense, but more efficient in anotherHopefully tests and code comments cover the rest of the nuances.
I'm leaving the whole messy commit history for posterity, but will squash on merge!