declarativex icon indicating copy to clipboard operation
declarativex copied to clipboard

Allow consumption of preconfigured httpx client

Open Apxdono opened this issue 2 years ago • 0 comments

Description

Today's approach for declarativex executors (both sync and async) creates new clients under the hood. This works fine as long as you are fine with basic httpx settings. Use Case section lists a number of additional features that can be unlocked if declarativex API can consume pre-configured httpx (and other) clients.

Use Case

  • Support for cookie retention between API calls
  • Support for self-signed certificates added at runtime (not via OS certificate chains)
  • Support for httpx event hooks. This is a big one since declarativex Middleware consumes transformed responses, while httpx event hook can access raw request.
  • Advanced transport usage
  • Other httpx benefits
  • Async settings

Proposed Solution

Introduce new base_client (or client) BaseClient property (similar to base_url, timeout and others) / @http argument. When supplied respective Executor uses supplied client inside _execute method instead of creating new one during each _execute call.

The drawback is that follow_redirects, http2 and proxies settings will be ignored. Users must set those inside the client, but if they opt for custom client, they kinda know what they're doing.

Alternatives

Custom executor can be used instead, but this implies creation of custom @http annotation, which is kinda ugly.

Will try to file a PR once I get spare time to work on this.

Apxdono avatar Mar 29 '24 10:03 Apxdono