Remove deprecated `httplug_client` option from providers #371

norkunas · 2025-12-11T13:05:48Z

Summary by CodeRabbit

Release Notes

Refactor
- Removed deprecated httplug_client configuration option support across all geocoding providers. Users must update configurations to use http_client instead.
Documentation
- Updated HTTP client configuration guides with PSR-18 implementation examples and composer installation commands for Symfony and Guzzle.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

coderabbitai · 2025-12-11T13:05:58Z

Walkthrough

Systematic deprecation removal: HTTPlug-based httplug_client configuration option is completely eliminated across 23 provider factories, replaced with PSR-18-based http_client. Documentation updated to reflect new HTTP client configuration guidance; legacy test removed.

Changes

Cohort / File(s)	Summary
Documentation `doc/index.md`, `doc/services.md`	Updated HTTP client configuration guidance from HTTPlug to PSR-18 approach; replaced `httplug_client` with `http_client` in example configurations and factory documentation; removed Doctrine test documentation.
Provider Factories `src/ProviderFactory/AlgoliaPlaceFactory.php`, `src/ProviderFactory/ArcGISOnlineFactory.php`, `src/ProviderFactory/BingMapsFactory.php`, `src/ProviderFactory/FreeGeoIpFactory.php`, `src/ProviderFactory/GeoPluginFactory.php`, `src/ProviderFactory/GeonamesFactory.php`, `src/ProviderFactory/GoogleMapsFactory.php`, `src/ProviderFactory/GoogleMapsPlacesFactory.php`, `src/ProviderFactory/HereFactory.php`, `src/ProviderFactory/HostIpFactory.php`, `src/ProviderFactory/IpInfoFactory.php`, `src/ProviderFactory/IpInfoDbFactory.php`, `src/ProviderFactory/IpstackFactory.php`, `src/ProviderFactory/LocationIQFactory.php`, `src/ProviderFactory/MapboxFactory.php`, `src/ProviderFactory/MapQuestFactory.php`, `src/ProviderFactory/MaxMindFactory.php`, `src/ProviderFactory/NominatimFactory.php`, `src/ProviderFactory/OpenCageFactory.php`, `src/ProviderFactory/OpenRouteServiceFactory.php`, `src/ProviderFactory/PickPointFactory.php`, `src/ProviderFactory/TomTomFactory.php`, `src/ProviderFactory/YandexFactory.php`	Removed deprecated `httplug_client` option and fallback paths across all factories. Simplified HTTP client resolution to prioritize `http_client` config option, then factory default, then PSR-18 discovery. Removed `httplug_client` defaults, type constraints, and deprecation notices from option resolvers. Updated docblock parameter annotations to exclude `httplug_client` from config shapes.
Tests `tests/Functional/ProviderFactoryTest.php`	Removed `testProviderConfigurationWithDeprecatedHttplugClientOption()` test method that validated deprecated HTTPlug client configuration behavior.
Test Configuration `tests/Functional/config/deprecated_httplug_client_option.yml`	Deleted entire configuration file containing HTTPlug-based client setup; removed profiling settings and provider configuration using `httplug_client`.
Baseline Configuration `tests/baseline-ignore`	Removed deprecation note line referencing Nyholm\Psr7\Factory\HttplugFactory.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~35 minutes

Consistency verification across factories: Ensure the identical pattern (removal of httplug_client fallback, defaults, type constraints, deprecation notices) is applied uniformly across all 23 factories
Configuration resolution flow: Verify the simplified HTTP client resolution chain (config['http_client'] ?? $this->httpClient ?? Psr18ClientDiscovery::find()) is correct in each factory
Docblock accuracy: Check that all updated parameter annotations correctly reflect the new config shapes without httplug_client
Documentation alignment: Confirm that doc/index.md and doc/services.md examples match the actual implementation changes
Test removal validity: Verify that testProviderConfigurationWithDeprecatedHttplugClientOption() removal is safe given the configuration file deletion

Poem

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 50.00% which is insufficient. The required threshold is 80.00%.	You can run `@coderabbitai generate docstrings` to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main change: removing the deprecated httplug_client option from all provider factories, which is reflected across 20+ modified factory files and documentation updates.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (2)

src/ProviderFactory/MapboxFactory.php (1)

doc/services.md (1)

11-41: Fix markdown table formatting to add trailing pipes and ensure column consistency.

The markdown table is missing trailing pipes on all data rows, and line 19 (GeoipFactory) is missing the options column. To comply with markdown lint rules (MD055, MD056) and maintain visual consistency, all table rows should have leading and trailing pipes.

Additionally, verify whether GeoipFactory truly has no configuration options, as it appears unique among the provider factories listed.

Apply this diff to fix the table formatting:

-| `Bazinga\GeocoderBundle\ProviderFactory\AlgoliaPlaceFactory` | http_client, api_key, app_id
-| `Bazinga\GeocoderBundle\ProviderFactory\ArcGISOnlineFactory` | http_client, source_country
-| `Bazinga\GeocoderBundle\ProviderFactory\BingMapsFactory` | http_client, api_key
+| `Bazinga\GeocoderBundle\ProviderFactory\AlgoliaPlaceFactory` | http_client, api_key, app_id |
+| `Bazinga\GeocoderBundle\ProviderFactory\ArcGISOnlineFactory` | http_client, source_country |
+| `Bazinga\GeocoderBundle\ProviderFactory\BingMapsFactory` | http_client, api_key |
 | `Bazinga\GeocoderBundle\ProviderFactory\ChainFactory` | services
-| `Bazinga\GeocoderBundle\ProviderFactory\FreeGeoIpFactory` | http_client, base_url
+| `Bazinga\GeocoderBundle\ProviderFactory\FreeGeoIpFactory` | http_client, base_url |
 | `Bazinga\GeocoderBundle\ProviderFactory\GeoIP2Factory` | provider, database_filename, user_id, license_key, webservice_options, locales, provider_service
-| `Bazinga\GeocoderBundle\ProviderFactory\GeoipFactory` |
-| `Bazinga\GeocoderBundle\ProviderFactory\GeoIPsFactory` | http_client, api_key
-| `Bazinga\GeocoderBundle\ProviderFactory\GeonamesFactory` | http_client, username
-| `Bazinga\GeocoderBundle\ProviderFactory\GeoPluginFactory` | http_client
-| `Bazinga\GeocoderBundle\ProviderFactory\GoogleMapsFactory` | http_client, api_key, region
-| `Bazinga\GeocoderBundle\ProviderFactory\GoogleMapsPlacesFactory` | http_client, api_key
-| `Bazinga\GeocoderBundle\ProviderFactory\HereFactory` | http_client, app_id, app_code, use_cit
-| `Bazinga\GeocoderBundle\ProviderFactory\HostIpFactory` | http_client
-| `Bazinga\GeocoderBundle\ProviderFactory\IpInfoFactory` | http_client
-| `Bazinga\GeocoderBundle\ProviderFactory\IpInfoDbFactory` | http_client, api_key, precision
-| `Bazinga\GeocoderBundle\ProviderFactory\IpstackFactory` | http_client, api_key
-| `Bazinga\GeocoderBundle\ProviderFactory\LocationIQFactory` | http_client, api_key
-| `Bazinga\GeocoderBundle\ProviderFactory\MapboxFactory` | http_client, api_key, country, mode
-| `Bazinga\GeocoderBundle\ProviderFactory\MapQuestFactory` | http_client, api_key, licensed
-| `Bazinga\GeocoderBundle\ProviderFactory\MapzenFactory` | http_client, api_key
+| `Bazinga\GeocoderBundle\ProviderFactory\GeoipFactory` | |
+| `Bazinga\GeocoderBundle\ProviderFactory\GeoIPsFactory` | http_client, api_key |
+| `Bazinga\GeocoderBundle\ProviderFactory\GeonamesFactory` | http_client, username |
+| `Bazinga\GeocoderBundle\ProviderFactory\GeoPluginFactory` | http_client |
+| `Bazinga\GeocoderBundle\ProviderFactory\GoogleMapsFactory` | http_client, api_key, region |
+| `Bazinga\GeocoderBundle\ProviderFactory\GoogleMapsPlacesFactory` | http_client, api_key |
+| `Bazinga\GeocoderBundle\ProviderFactory\HereFactory` | http_client, app_id, app_code, use_cit |
+| `Bazinga\GeocoderBundle\ProviderFactory\HostIpFactory` | http_client |
+| `Bazinga\GeocoderBundle\ProviderFactory\IpInfoFactory` | http_client |
+| `Bazinga\GeocoderBundle\ProviderFactory\IpInfoDbFactory` | http_client, api_key, precision |
+| `Bazinga\GeocoderBundle\ProviderFactory\IpstackFactory` | http_client, api_key |
+| `Bazinga\GeocoderBundle\ProviderFactory\LocationIQFactory` | http_client, api_key |
+| `Bazinga\GeocoderBundle\ProviderFactory\MapboxFactory` | http_client, api_key, country, mode |
+| `Bazinga\GeocoderBundle\ProviderFactory\MapQuestFactory` | http_client, api_key, licensed |
+| `Bazinga\GeocoderBundle\ProviderFactory\MapzenFactory` | http_client, api_key |
 | `Bazinga\GeocoderBundle\ProviderFactory\MaxMindBinaryFactory` | dat_file, open_flag
-| `Bazinga\GeocoderBundle\ProviderFactory\MaxMindFactory` | http_client, api_key, endpoint
-| `Bazinga\GeocoderBundle\ProviderFactory\NominatimFactory` | http_client, root_url
-| `Bazinga\GeocoderBundle\ProviderFactory\OpenCageFactory` | http_client, api_key
-| `Bazinga\GeocoderBundle\ProviderFactory\OpenRouteServiceFactory` | http_client, api_key
-| `Bazinga\GeocoderBundle\ProviderFactory\PickPointFactory` | http_client, api_key
-| `Bazinga\GeocoderBundle\ProviderFactory\TomTomFactory` | http_client, api_key
-| `Bazinga\GeocoderBundle\ProviderFactory\YandexFactory` | http_client, toponym
+| `Bazinga\GeocoderBundle\ProviderFactory\MaxMindFactory` | http_client, api_key, endpoint |
+| `Bazinga\GeocoderBundle\ProviderFactory\NominatimFactory` | http_client, root_url |
+| `Bazinga\GeocoderBundle\ProviderFactory\OpenCageFactory` | http_client, api_key |
+| `Bazinga\GeocoderBundle\ProviderFactory\OpenRouteServiceFactory` | http_client, api_key |
+| `Bazinga\GeocoderBundle\ProviderFactory\PickPointFactory` | http_client, api_key |
+| `Bazinga\GeocoderBundle\ProviderFactory\TomTomFactory` | http_client, api_key |
+| `Bazinga\GeocoderBundle\ProviderFactory\YandexFactory` | http_client, toponym |

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9f3069c and 3cd1b1c.

📒 Files selected for processing (28)

doc/index.md (3 hunks)
doc/services.md (1 hunks)
src/ProviderFactory/AlgoliaFactory.php (1 hunks)
src/ProviderFactory/ArcGISOnlineFactory.php (1 hunks)
src/ProviderFactory/BingMapsFactory.php (1 hunks)
src/ProviderFactory/FreeGeoIpFactory.php (1 hunks)
src/ProviderFactory/GeoPluginFactory.php (1 hunks)
src/ProviderFactory/GeonamesFactory.php (1 hunks)
src/ProviderFactory/GoogleMapsFactory.php (1 hunks)
src/ProviderFactory/GoogleMapsPlacesFactory.php (1 hunks)
src/ProviderFactory/HereFactory.php (1 hunks)
src/ProviderFactory/HostIpFactory.php (1 hunks)
src/ProviderFactory/IpInfoDbFactory.php (1 hunks)
src/ProviderFactory/IpInfoFactory.php (1 hunks)
src/ProviderFactory/IpstackFactory.php (1 hunks)
src/ProviderFactory/LocationIQFactory.php (1 hunks)
src/ProviderFactory/MapQuestFactory.php (1 hunks)
src/ProviderFactory/MapboxFactory.php (1 hunks)
src/ProviderFactory/MaxMindFactory.php (1 hunks)
src/ProviderFactory/NominatimFactory.php (1 hunks)
src/ProviderFactory/OpenCageFactory.php (1 hunks)
src/ProviderFactory/OpenRouteServiceFactory.php (1 hunks)
src/ProviderFactory/PickPointFactory.php (1 hunks)
src/ProviderFactory/TomTomFactory.php (1 hunks)
src/ProviderFactory/YandexFactory.php (1 hunks)
tests/Functional/ProviderFactoryTest.php (0 hunks)
tests/Functional/config/deprecated_httplug_client_option.yml (0 hunks)
tests/baseline-ignore (0 hunks)

💤 Files with no reviewable changes (3)

tests/Functional/config/deprecated_httplug_client_option.yml
tests/baseline-ignore
tests/Functional/ProviderFactoryTest.php

🧰 Additional context used

🧬 Code graph analysis (18)

src/ProviderFactory/PickPointFactory.php (16)

src/ProviderFactory/MapboxFactory.php (16)

src/ProviderFactory/OpenRouteServiceFactory.php (16)

src/ProviderFactory/YandexFactory.php (16)

src/ProviderFactory/IpstackFactory.php (16)

src/ProviderFactory/FreeGeoIpFactory.php (16)

src/ProviderFactory/IpInfoDbFactory.php (16)

src/ProviderFactory/AlgoliaFactory.php (16)

src/ProviderFactory/TomTomFactory.php (6)

src/ProviderFactory/MapQuestFactory.php (16)

src/ProviderFactory/BingMapsFactory.php (4)

src/ProviderFactory/GeoPluginFactory.php (16)

src/ProviderFactory/GoogleMapsFactory.php (3)

src/ProviderFactory/HostIpFactory.php (16)

src/ProviderFactory/IpInfoFactory.php (16)

src/ProviderFactory/ArcGISOnlineFactory.php (16)

src/ProviderFactory/NominatimFactory.php (3)

src/ProviderFactory/MaxMindFactory.php (16)

🪛 markdownlint-cli2 (0.18.1)

doc/services.md

13-13: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)

14-14: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)

15-15: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)

16-16: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)

17-17: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)

18-18: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)

19-19: Table column count
Expected: 2; Actual: 1; Too few cells, row will be missing data

(MD056, table-column-count)

20-20: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)

21-21: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)

22-22: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)

23-23: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)

24-24: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)

25-25: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)

26-26: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)

27-27: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)

28-28: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)

29-29: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)

30-30: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)

31-31: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)

32-32: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)

33-33: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)

34-34: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)

35-35: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)

36-36: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)

37-37: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)

38-38: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)

39-39: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)

40-40: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)

41-41: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)

🔇 Additional comments (23)

Remove deprecated httplug_client option from providers

3cd1b1c

coderabbitai bot reviewed Dec 11, 2025

View reviewed changes

norkunas merged commit d797ec8 into geocoder-php:master Dec 11, 2025
35 of 37 checks passed

norkunas deleted the nohttplug branch December 11, 2025 13:21

coderabbitai bot mentioned this pull request Dec 12, 2025

Drop php-http/curl-client dependency #374

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Remove deprecated `httplug_client` option from providers #371

Remove deprecated `httplug_client` option from providers #371

Uh oh!

norkunas commented Dec 11, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Dec 11, 2025 •

edited

Loading

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Remove deprecated httplug_client option from providers #371

Remove deprecated httplug_client option from providers #371

Uh oh!

Conversation

norkunas commented Dec 11, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Release Notes

Uh oh!

coderabbitai bot commented Dec 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Poem

Pre-merge checks and finishing touches

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Remove deprecated `httplug_client` option from providers #371

Remove deprecated `httplug_client` option from providers #371

norkunas commented Dec 11, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Dec 11, 2025 •

edited

Loading