Add reverse query param while fetching job allocations

[Sanskar531]

#17742

Job allocations can now be reverse sorted. I have also updated the docs for it.

[Sanskar531]

I am not sure if this is the right way to do it. Other implementations like the one in DeploymentsByIDPrefix , sort it directly when fetching the data from memdb. Doing so, is a big change though as there are 100 references of where AllocsByJob is used and I will have to add a new sort parameter to the function. If it's okay, I don't mind changing this pr to update all references of AllocsByJob.

[tgross]

Hi @Sanskar531! Thanks for this PR! As you've noted in your PR description, we should be pushing the reverse parameter down into the state query. The reason is because of pagination. For example, suppose I have the following allocations:

• aaaaaaaa-71ba-11ee-950b-bfbf31e28f07
• bbbbbbbb-71ba-11ee-b9ea-af44d029c7fa
• cccccccc-71ba-11ee-80f2-4be2f9fab70e
• dddddddd-71ba-11ee-81a1-db53adff8b79
• eeeeeeee-71ba-11ee-976a-3f503a3105b0

And then I make a query with per_page=3 and reverse=true. The way you've got it here, we'd return the following:

• cccccccc-71ba-11ee-80f2-4be2f9fab70e
• bbbbbbbb-71ba-11ee-b9ea-af44d029c7fa
• aaaaaaaa-71ba-11ee-950b-bfbf31e28f07

But what we really want to return is:

• eeeeeeee-71ba-11ee-976a-3f503a3105b0
• dddddddd-71ba-11ee-81a1-db53adff8b79
• cccccccc-71ba-11ee-80f2-4be2f9fab70e

Once you've got that done I'll be happy to re-review. Also, can you run make cl to add a changelog entry?

[tgross]

Added "by ID", and also we hard-wrap markdown text:

Suggested change

	- `reverse` `(bool: false)` - Specifies the list of returned allocations to be sorted in the reverse lexicographical order. By default, they are lexicographically sorted.
	- `reverse` `(bool: false)` - Specifies the list of returned allocations to be
	sorted in the reverse lexicographical order. By default, they are
	lexicographically sorted by ID.

[Sanskar531]

Hey! Thanks for the guidance. That makes a lot of sense!

So just confirming before I rework this that I can make the change to the function signature of AllocsByJob by adding a new reverse parameter and subsequently updating all the usages of it (I found 100 references) right?

[tgross]

So just confirming before I rework this that I can make the change to the function signature of AllocsByJob by adding a new reverse parameter and subsequently updating all the usages of it (I found 100 references) right?

Yeah, that looks like the right approach. But there's a state.SortOption type you can use for clarity, rather than a simple bool parameter.