Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update spec for ESQL async query stop #3643

Merged
merged 4 commits into from
Jan 29, 2025
Merged

Update spec for ESQL async query stop #3643

merged 4 commits into from
Jan 29, 2025

Conversation

smalyshev
Copy link
Contributor

Update spec for:

  • ESQL async POST query/stop API
  • is_partial in ESQL query response

Copy link
Contributor

Following you can find the validation results for the APIs you have changed.

API Status Request Response
esql.async_query_get Missing test Missing test
esql.async_query_stop Missing test Missing test

You can validate these APIs yourself by using the make validate target.

Copy link
Contributor

Following you can find the validation results for the APIs you have changed.

API Status Request Response
esql.async_query_get Missing test Missing test
esql.async_query_stop Missing test Missing test

You can validate these APIs yourself by using the make validate target.

Copy link
Member

@JoshMock JoshMock left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These changes look good to me!

@JoshMock
Copy link
Member

Pausing before merging to verify with @pquentin about what the missing tests indicates. I'm pretty sure it's fine, but I want to make sure.

@smalyshev
Copy link
Contributor Author

It will probably be non-trivial to test async requests within the context of the spec, since they require some special timing, so I am not surprised the spec does not test them. That said, please tell me if anything needs to be added here.

Copy link
Member

@pquentin pquentin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we please make the body binary as done in #3639? The current representation isn't usable for typed client. (The current behavior of "return structured response, unless it's ready, then you get binary data" is unfortunate.)

Copy link
Contributor

Following you can find the validation results for the APIs you have changed.

API Status Request Response
esql.async_query_stop Missing test Missing test

You can validate these APIs yourself by using the make validate target.

Copy link
Contributor

Following you can find the validation results for the APIs you have changed.

API Status Request Response
esql.async_query_stop Missing test Missing test

You can validate these APIs yourself by using the make validate target.

@smalyshev
Copy link
Contributor Author

@pquentin updated, please review

Copy link
Contributor

Following you can find the validation results for the APIs you have changed.

API Status Request Response
esql.async_query_stop Missing test Missing test

You can validate these APIs yourself by using the make validate target.

Copy link
Member

@pquentin pquentin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! LGTM.

@smalyshev smalyshev merged commit 585f697 into main Jan 29, 2025
8 checks passed
@smalyshev smalyshev deleted the async-query-stop branch January 29, 2025 16:43
Copy link
Contributor

The backport to 8.x failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-8.x 8.x
# Navigate to the new working tree
cd .worktrees/backport-8.x
# Create a new branch
git switch --create backport-3643-to-8.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 585f69729291cfda4acb5c47a7466abe6c42e9c0
# Push it to GitHub
git push --set-upstream origin backport-3643-to-8.x
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-8.x

Then, create a pull request where the base branch is 8.x and the compare/head branch is backport-3643-to-8.x.

smalyshev added a commit to smalyshev/elasticsearch-specification that referenced this pull request Jan 29, 2025
* Update spec for ESQL async query stop

(cherry picked from commit 585f697)
smalyshev added a commit that referenced this pull request Jan 29, 2025
* Update spec for ESQL async query stop

(cherry picked from commit 585f697)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants