feat: Check version of Elasticsearch server and add support for Elasticsearch <= 7.5 #5320
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
bogdankostic
changed the title
Pull Request Test Coverage Report for Build 5543058076
💛 - Coveralls |
vblagoje
requested changes
Jul 13, 2023
| @@ -106,6 +106,8 @@ def __init__( | |||
| raise DocumentStoreError( | |||
| f"Invalid value {similarity} for similarity, choose between 'cosine', 'l2' and 'dot_product'" | |||
| ) | |||
| client_info = self.client.info() | |||
| self.server_version = tuple(int(num) for num in client_info["version"]["number"].split(".")) | |||
There was a problem hiding this comment.
Nice touch, tuple to make it immutable, eh?
There was a problem hiding this comment.
Yes, also to make it consistent with the type of VERSION from the elasticsearch client.
| @@ -376,6 +382,22 @@ def test_write_documents_req_for_each_batch(self, mocked_document_store, documen | |||
| mocked_document_store.write_documents(documents) | |||
| assert mocked_bulk.call_count == 5 | |||
|
|
|||
| @pytest.mark.unit | |||
| def test_get_vector_similarity_query(self, mocked_document_store): | |||
| vec_sim_query = mocked_document_store._get_vector_similarity_query(np.random.rand(3).astype(np.float32), 10) | |||
There was a problem hiding this comment.
Is this some smoke test? What's the motivation behind it? Perhaps a comment or two would help a lot :-)
There was a problem hiding this comment.
I added some doc strings to the new tests.
|
|
||
| @pytest.mark.unit | ||
| def test_get_vector_similarity_query_es_7_5_and_below(self, mocked_document_store): | ||
| # Patch server version to be 7.5.0 |
There was a problem hiding this comment.
Yeah here too, just a bit more motivation for why are we testing this, short comment?
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.
Related Issues
Proposed Changes:
This PR adds a check to
elasticsearch/es7.pyandelasticsearch/es8.pythat checks the version of the connected Elasticsearch server and logs a warning if the server version is not consistent with the version of the usedElasticsearchDocumentStore.Also, this PR adds support for Elasticsearch versions <= 7.5 by using a different vector similarity query for Elasticsearch servers with versions <= 7.5.
How did you test it?
I added two unit tests to test that the
"source"field of the ES query is formatted according to the used version.Notes for the reviewer
Checklist
fix:,feat:,build:,chore:,ci:,docs:,style:,refactor:,perf:,test:.