Skip to content

CHANGELOG.md

Latest commit

 

History

History
77 lines (63 loc) · 2.9 KB

CHANGELOG.md

File metadata and controls

77 lines (63 loc) · 2.9 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[4.1.1] - 2026-07-13

Fixed

- Retry and circuit breaker plugins now detect failures correctly: they previously assumed the HTTP client throws synchronously on error, but a spec-compliant PSR-18 client returns 4xx/5xx responses without throwing, and `ErrorPlugin` (when used) only surfaces failures as a rejected Promise. Both `RetryHandler` and `CircuitBreaker` now inspect the actual resolved outcome (status code or exception) of each attempt, so `configureRetry()`/`configureFixedRetry()`/`enableReliability()` retry on 429/5xx responses as documented.

[4.1.0] - 2026-07-03

Added

- HTTP 429 rate-limit handling: retry strategies now honor the `x-rate-limit-reset` response header (capped by `max_delay_ms`) instead of relying solely on generic backoff.
- `RateLimitExceededException`, thrown once retries are exhausted on a 429, exposing `getRetryAfterSeconds()` and `getResponse()`.

[4.0.0] - 2026-06-28

Added

- Full HTTP observability tools: structured logging with token masking, per-status log levels, and custom logger support.
- Reliability features: retry strategies (exponential and fixed), circuit breaker, and a combined reliability plugin.
- New documentation set under `docs/` with getting started, authentication, configuration, reliability, and domain-by-domain usage examples.

Changed

- Raised minimum supported PHP version to 8.2.

[3.20.0] - 2023-04-27

Added

- isReferenceCode() and isGeocode() methods

[3.19.0] - 2023-02-09

Added

- Compatibility with PHP 8.2 and monolog 3.0

[3.18.0] - 2021-03-24

Added

- Compatibility with PHP 8.1
- New API method added:
    - getUserPrivacySettings
    - getAdventure

[3.16.0] - 2021-08-06

Added

- Better exception management

[3.15.0] - 2021-05-22

Added

- New API method added:
    - searchAdventures
    - getGeocacheLogUpvotes
    - deleteGeocacheLogUpvotes
    - setGeocacheLogUpvotes
    - getUserTrackableLog
- New Enums added:
    - AdditionalWaypointType
    - GeocacheLogUpvoteType
- Improved http errors management

[3.14.0] - 2021-01-19

Added

- Throw an exception if the referenceCode is too short

[3.13.0] - 2021-01-17

Added

- New API method added:
    - getWherigoCartridge
- Compatibility with PHP >= 8.0

[3.12.0] - 2020-09-21

Added

- New API methods added:
    - getGeocacheSizes
    - getGeocacheStatuses
    - getTrackableJourneys
    - getOptedOutUsers

[3.11.0] - 2020-05-22

Added

- http options [from Guzzle](http://docs.guzzlephp.org/en/stable/request-options.html) added to all methods if needed (last argument)