Implement coditional execution "result" field retrieval for the "/v1/executions/<id>" (get one execution) API endpoint #5197
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
API endpoint. With this query parameter, user can decide to exclude execution.result field from the response in case it exceeds this size. This allows us to implement efficient execution retrieval in the client (st2web) side and avoid additional queries / API operations on the client side - aka win-win situation (reduce the load on the client and the server).
pull-request-size
bot
added
the
size/L
Kami
added a commit
to StackStorm/st2web
that referenced
this pull request
Mar 20, 2021
This allows us to simplify the code and make it even more efficient by only always performing single "get one" execution API operation.
|
Alright, I also updated the st2web changes in StackStorm/st2web#868 (which are very simple now). |
winem
reviewed
Mar 30, 2021
…exclude_result_if_size_greater
result_size == max_result_size, clarify query parameter value represents bytes.
|
LGTM now! |
winem
approved these changes
Mar 31, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
As per my comment in #4846 (#4846 (comment)), I couldn't live with that one additional query on the st2web side to implement "only retrieve execution result if it's smaller than X" functionality even though that with the additional query overall end user experience and performance was already much, much better than previous status quo, but I'm kinda OCD and wanted to get rid of that additional API operation in st2web (StackStorm/st2web#868).
So to do that, I implemented conditional "get one execution" API operation where the
resultfield is only returned if it's smaller than the provided value.Imo, this implementation is a win-win since it allow us to get rid of additional API operation on the st2web side, we can even simplify st2web code a lot and other clients can also utilize this new API operation / query parameter. In addition to that it's also a win-win for the server - in case client won't actually render the result if it's too large it also makes no sense for the server to return it (so this way we reduce load a bit on the server as well).
We also have fall back in st2web so it's fully backward compatible and even works with old executions which may not contain
result_sizefield (in that case we calculate result size on the client which takes some time, but it's still very, very fast compared to actually rendering and displaying large results).Implementation Details
If you check the code and comments, you will see the operation is implemented by utilizing two MongoDB queries.
One to check if corresponding execution with result_size smaller than the specified threshold exists and one to then retrieve that execution (and only including the result field size is smaller than specified threshold).
I experimented with a couple of different approaches (always retrieve execution result and do filtering and result field removal in the Python code, etc.), but it turns out this two query approach is actually the fastest.
To some extent that's expected because the first query we run already performs first filtering on the primary key (object id) which is an index lookup and it's very fast and we also do a projection operation where only 2 tiny indexed fields are retrieved and returned.
I will make necessary changes to st2web PR (StackStorm/st2web#868) to utilize this new query param filter shortly.