v8.0.0 Roadmap

[picandocodigo]

We've started working on the next major version of the client, so we want to share this issue with information on what's coming up. This issue outlines ideas, concepts and features that we hope to include in the v8.0.0 client release. Some items may change, be removed or new ones added as we investigate and work on them, but we'll update this issue as we do.

General

• Write a Rubocop settings file for generated code (linting).

Transport

• Extract transport - Extract Elasticsearch specific code in elasticsearch-transport to elasticsearch gem. Rename to elastic-transport.
  • See The elasticsearch-transport gem will be promoted to its own repository #1344.
  • Pull Request: Transport #1528
• Re-architect transport's perform_request and sniffer functionality to avoid infinite loops - Infinite loop caused in transport gem when reload_on_failure is true and more than 1 host is provided. #695
• Simplify ways that hosts are specified when a client is instantiated. - https://github.com/elastic/elasticsearch-ruby/issues/671 (this would be a breaking change)

API

• Merge elasticsearch-xpack gem into elasticsearch-api gem. See X-Pack is being deprecated in 8.0.0 #1274
• Remove parameter-checking in API endpoints for more forwards and backwards compatibility in the client.
  • Issue: [API] Remove parameter-checking in API endpoints #581
  • Pull Request: Generator update: Removes checking for valid parameters in API endpoints #1529
• Rethink example support in method documentation. Manual docs were dropped with the generator, so we need to add documentation examples and build them into the generator so API can have examples in rubydoc.
• Change API response from body to Response object from transport with the .body, .status and .headers method like we have on the Enterprise Search Client.
  • New Response object from API #1558

Testing

Quality of life improvements in testing: This is an ongoing task together with migrating tests from mini-test, but there are a few improvements that have been made and will continue to be made to the way we run tests to improve the developer experience. We plan to migrate to RSpec and also work on automatically generating unit tests for generated code.