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

Asynchronous search namespace #525

Merged
merged 19 commits into from
Aug 24, 2024

Conversation

Tokesh
Copy link
Collaborator

@Tokesh Tokesh commented Aug 22, 2024

Description

asynchronous_search namespace

Issues Resolved

[#223]

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Copy link

github-actions bot commented Aug 22, 2024

Changes Analysis

Commit SHA: afadb06
Comparing To SHA: b28c1cf

API Changes

Summary

├─┬Paths
│ ├──[➕] path (11095:3)
│ ├──[➕] path (3534:3)
│ ├──[➕] path (3499:3)
│ ├──[➕] path (11114:3)
│ ├──[➕] path (11070:3)
│ └──[➕] path (3476:3)
└─┬Components
  ├──[➕] requestBodies (23539:7)
  ├──[➕] responses (25058:7)
  ├──[➕] responses (25053:7)
  ├──[➕] responses (25045:7)
  ├──[➕] responses (25063:7)
  ├──[➕] parameters (13096:7)
  ├──[➕] parameters (13084:7)
  ├──[➕] parameters (13078:7)
  ├──[➕] parameters (13068:7)
  ├──[➕] parameters (13073:7)
  ├──[➕] parameters (13090:7)
  ├──[➕] schemas (40490:7)
  ├──[➕] schemas (40516:7)
  ├──[➕] schemas (40659:7)
  ├──[➕] schemas (40511:7)
  └──[➕] schemas (40531:7)

Document Element Total Changes Breaking Changes
paths 6 0
components 16 0
  • Total Changes: 22
  • Additions: 22

Report

The full API changes report is available at: https://github.com/opensearch-project/opensearch-api-specification/actions/runs/10531306481/artifacts/1848624149

API Coverage

Before After Δ
Covered (%) 524 (51.32 %) 532 (52.11 %) 8 (0.79 %)
Uncovered (%) 497 (48.68 %) 489 (47.89 %) -8 (-0.79 %)
Unknown 26 26 0

@Tokesh Tokesh marked this pull request as ready for review August 22, 2024 18:25
Copy link
Member

@dblock dblock left a comment

Choose a reason for hiding this comment

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

Looks good, I have a few nits.

.github/workflows/test-spec.yml Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
tests/default/asynchronous_search/search.yaml Outdated Show resolved Hide resolved
id: payload.id
response:
status: 200
- synopsis: Get partial response from asynchronous search.
Copy link
Member

Choose a reason for hiding this comment

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

So is it possible it hasn't completed yet (are we introducing a flaky test)?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This is a little interesting thing I read. You can save the query with the parameter I used above, it is keep_on_completion. In general, this method is aimed at getting a partial answer, as it is written in the documentation. But for more reliability, adding that parameter, I am sure that the query will work

@Tokesh
Copy link
Collaborator Author

Tokesh commented Aug 22, 2024

Hello everyone!
I added asynchronous search to the specs, wrote a couple of tests. I noticed that in OS 3.0 they do not pass the tests, can you tell me why this might be. With other versions these tests pass successfully
I didn't find a word about removing asynchronous search in OS 3.0.
@dblock @nhtruong

@dblock
Copy link
Member

dblock commented Aug 22, 2024

Hello everyone! I added asynchronous search to the specs, wrote a couple of tests. I noticed that in OS 3.0 they do not pass the tests, can you tell me why this might be. With other versions these tests pass successfully I didn't find a word about removing asynchronous search in OS 3.0. @dblock @nhtruong

It looks like asynchronous search tests failed with the following:


[INFO] => POST /_plugins/_asynchronous_search ({
  "index": "books",
  "keep_on_completion": true
}) [application/json] {
  "query": {
    "match": {
      "author": {
        "query": "Bennett Miller"
      }
    }
  }
}
[INFO] <= 400 (application/json) | "no handler found for uri [/_plugins/_asynchronous_search] and method [POST]"
[INFO] => DELETE /books ({}) [application/json] 
[INFO] <= 200 (application/json; charset=UTF-8) | {
  "acknowledged": true
}

This means that the plugin is not in this 3.0 build (3.0 builds can be partial). Look for a newer tag on https://hub.docker.com/r/opensearchstaging/opensearch/tags that includes the asynchronous-search plugin as well and replace it in CI (might need to try locally).

@Tokesh
Copy link
Collaborator Author

Tokesh commented Aug 23, 2024

This means that the plugin is not in this 3.0 build (3.0 builds can be partial). Look for a newer tag on https://hub.docker.com/r/opensearchstaging/opensearch/tags that includes the asynchronous-search plugin as well and replace it in CI (might need to try locally).

I tried to use newer tag in 3.0 build, still same error. Can you check it? I guess I made a mistake somewhere
image

@dblock
Copy link
Member

dblock commented Aug 23, 2024

@Tokesh I don't think it's a mistake, this likely means that asynchronous-search doesn't build in 3.0, and isn't included in any of these builds on docker hub

@peterzhuamazon Can you help? How can one know which 3.0 build has asynchronous-search?

@dblock
Copy link
Member

dblock commented Aug 23, 2024

@Tokesh For now add < 3.0 to skip this test so we can merge this code?

Copy link

Spec Test Coverage Analysis

Total Tested
558 365 (65.41 %)

@Tokesh Tokesh requested a review from dblock August 23, 2024 19:36
@Tokesh
Copy link
Collaborator Author

Tokesh commented Aug 23, 2024

@Tokesh I don't think it's a mistake, this likely means that asynchronous-search doesn't build in 3.0, and isn't included in any of these builds on docker hub

@peterzhuamazon Can you help? How can one know which 3.0 build has asynchronous-search?

Actually, i made a quick research about this situation.
I found async_search in OS 3.0 build here
But I don't know why it doesn't work now.
I have hypothesis, that it shouldn't work like this

@Tokesh
Copy link
Collaborator Author

Tokesh commented Aug 23, 2024

@Tokesh For now add < 3.0 to skip this test so we can merge this code?

Ready for your review :)

@dblock
Copy link
Member

dblock commented Aug 24, 2024

Actually, i made a quick research about this situation. I found async_search in OS 3.0 build here But I don't know why it doesn't work now. I have hypothesis, that it shouldn't work like this

Will you please take a look at this? At least open a bug. It should work in 3.0 the same as in 2.x, or it's a bug.

@dblock dblock merged commit ec66e24 into opensearch-project:main Aug 24, 2024
16 checks passed
@Tokesh
Copy link
Collaborator Author

Tokesh commented Aug 25, 2024

Actually, i made a quick research about this situation. I found async_search in OS 3.0 build here But I don't know why it doesn't work now. I have hypothesis, that it shouldn't work like this

Will you please take a look at this? At least open a bug. It should work in 3.0 the same as in 2.x, or it's a bug.

Yeap sure! I'm already opened issue in async-search repo.

@dblock
Copy link
Member

dblock commented Aug 25, 2024

Yeap sure! I'm already opened issue in async-search repo.

Thanks. That repo could use help if you want to try fixing it!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants