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.

Sign up for GitHub

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

Jump to bottom

Psr interfaces #233

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Psr interfaces #233

wants to merge 1 commit into from
+5,071 −4,857

Conversation

kimpepper
Copy link

@kimpepper kimpepper commented Oct 22, 2024 •
edited
Loading

Fixes #199

Description

This PR removes the dependency on a specific HTTP client implementation and introduces PSR-7, PSR-17 and PSR-18 interfaces.

Issues Resolved

It greatly simplifies the volume and complexity of the library codebase and removes the need to manage:

  • client configuration: it can be now done directly on the implementing HTTP client, e.g. SSL, Basic Auth, Retries
  • connection pools/host round-robin: this can be done with HTTP client middleware

Users of this library can choose from a number of synchronous and asynchronous HTTP clients including:

  • Guzzle 7
  • Symfony HTTP client

It greatly simplifies the volume and complexity of the library codebase. Specifically, it:

  • removes a number of transient dependencies including ezimuel/ringphp which is not longer getting updates

Breaking changes

  • We no longer json_decode the response body into an array.
  • We leave that to the client to decide how they want to do that, e.g. deserialize into an object
  • Clients can make use of \Psr\Http\Message\StreamInterface to decode the response in a memory efficient way

Tasks:

  • Replace Guzzle specific code with PSR interfaces
  • Remove unused code including Connection, ConnectionPool and CllientBuilder
  • Ensure test coverage

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.

@kimpepper kimpepper mentioned this pull request Oct 22, 2024
Open
dblock
dblock requested changes Oct 22, 2024
View reviewed changes
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.

I love this change, thank you! Let's iterate till we get this to green. I think it's a lot simpler than #228, what do you think @shyim?

@dblock
Copy link
Member

dblock commented Oct 22, 2024

I noticed you tried to fix DCO?

"Kim Pepper [[email protected]](mailto:[email protected])", but got "Kim Pepper [[email protected]](mailto:[email protected])".

Something is not adding up between your settings and the commit signature.

@kimpepper
Copy link
Author

I noticed you tried to fix DCO?

"Kim Pepper [[email protected]](mailto:[email protected])", but got "Kim Pepper [[email protected]](mailto:[email protected])".

Something is not adding up between your settings and the commit signature.

I think I fixed that now? Let me know if it's still not rigt.

I've updated the ClientBuilder and refactored the endpoints callable into it's own factory class. I think this makes it easier to understand, and also allows clients to swap out an implementation or use a dependency injection container if they want.

I updated the client and namespace templates also. I regenerated afterwards and it looks like there are a lot of new API methods added. Should I use something other than https://github.com/opensearch-project/opensearch-api-specification/releases/download/main-latest/opensearch-openapi.yaml ?

@shyim
Copy link
Collaborator

shyim commented Oct 23, 2024

I think setHandler are not working anymore right? So aws sig v4 needs to be adjusted?

@kimpepper
Copy link
Author

I think setHandler are not working anymore right? So aws sig v4 needs to be adjusted?

Yes, I think we'd need to rewrite the guzzle middleware/handler without the ring dependency to make it easier for people who use AWS OpenSearch service to use signed requests.

@dblock
Copy link
Member

dblock commented Oct 23, 2024

Something is not adding up between your settings and the commit signature.

I think I fixed that now? Let me know if it's still not rigt.

Yep looks good.

I've updated the ClientBuilder and refactored the endpoints callable into it's own factory class. I think this makes it easier to understand, and also allows clients to swap out an implementation or use a dependency injection container if they want.

👍

I updated the client and namespace templates also. I regenerated afterwards and it looks like there are a lot of new API methods added. Should I use something other than https://github.com/opensearch-project/opensearch-api-specification/releases/download/main-latest/opensearch-openapi.yaml ?

Let's work on merging #223 separately from this not to mix in the PSR changes. It needs some attention to tests. If nobody picks it up here I can do it soon.

@kimpepper
Switch to PSR interfaces
df01728 
Signed-off-by: Kim Pepper <[email protected]>
@dblock
Copy link
Member

dblock commented Oct 24, 2024

Fixed CI in #234. Will merge and make a release with #223 next.

@kimpepper
Copy link
Author

Thinking about this more, returning HTTP Response might not be the best DX.

We should introduce a Response object that contains the body of the HTTP Response and any meta-data. We can add a toArray method to return the deserialized JSON. We can have 2 sub-classes ErrorResponse and OKResponse. The error response can have getErrorCode() and getErrorMessage() methods.

The Promise would also return this too.

Thoughts?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dblock dblock dblock requested changes

@VachaShah VachaShah Awaiting requested review from VachaShah VachaShah is a code owner

@harshavamsi harshavamsi Awaiting requested review from harshavamsi harshavamsi is a code owner

@shyim shyim Awaiting requested review from shyim shyim is a code owner

@saimedhi saimedhi Awaiting requested review from saimedhi saimedhi is a code owner

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[PROPOSAL] Request feedback on replacing ezimuel/ringphp
3 participants
@kimpepper @dblock @shyim