Skip to content

CHANGELOG.md

Latest commit

 

History

History
461 lines (294 loc) · 19.7 KB

CHANGELOG.md

File metadata and controls

461 lines (294 loc) · 19.7 KB

Release Notes

Unreleased

v3.4.1 - 2025-12-14

Added

  • Introduced CODE_MAP.md as an internal reference of every public helper, trait, interface, and subsystem so docs/tests can stay aligned with the codebase.
  • Added a FetchWatch-style “health monitor” example demonstrating retries, pooling, caching, async batching, and debug snapshots in docs/examples/api-integration.md.

Changed

  • Expanded the API docs for fetch(), ClientHandler, and Response to cover the full option surface (cache/debug/profiler/async) and newly exposed helpers (debug snapshots, pooling controls, cache methods).
  • Clarified retry monitoring guidance to rely on PSR-3 logs or explicit counters instead of the debug() array, and documented sync-only caching behaviour for async requests.

Fixed

  • Removed references to the non-existent Fetch\Exceptions\TimeoutException across guides and examples, explaining how timeouts bubble up via NetworkException or Matrix’s TimeoutException.
  • Updated error-handling documentation to disambiguate timeout handling and ensure users catch the correct exception classes.

v3.4.0 - 2025-12-07

Added

  • RFC 7234 HTTP Caching Support with intelligent cache control:

    • MemoryCache for fast in-memory caching
    • FileCache for persistent disk-based caching with TTL support
    • CacheControl parser for RFC 7234 compliant cache directive handling
    • CacheKeyGenerator with collision-resistant SHA-256 hashing
    • CachedResponse wrapper with metadata and validation support
    • ManagesCache trait integrated into ClientHandler for transparent caching
    • Automatic cache revalidation with If-None-Match and If-Modified-Since headers
    • Support for Cache-Control, ETag, Last-Modified, Expires, Age, and Vary headers
    • Configurable cache TTL, stale responses, and revalidation strategies
    • 802 new test assertions for caching functionality

  • Connection Pooling & HTTP/2 Support for improved performance:

    • ConnectionPool for managing persistent connections across hosts
    • HostConnectionPool for per-host connection management with limits
    • DnsCache for caching DNS lookups to reduce resolution overhead
    • Connection class for tracking connection state and reuse
    • PoolConfiguration for customizable pool settings (max connections, idle timeout, TTL)
    • Http2Configuration for HTTP/2 multiplexing and push support
    • ManagesConnectionPool trait with connection pool lifecycle management
    • Automatic connection recycling and health monitoring
    • 558 new test assertions for connection pooling

  • Debugging & Profiling Tools for request analysis:

    • DebugInfo class capturing detailed request/response information
    • FetchProfiler for comprehensive performance metrics and bottleneck detection
    • ManagesDebugAndProfiling trait for debug mode support
    • Sensitive header redaction and sanitization methods (Authorization, API keys, tokens)
    • Timing breakdown: DNS lookup, connection, TLS handshake, TTFB, transfer times
    • Memory usage tracking and cURL transfer statistics
    • Debug mode with detailed logging and inspection capabilities
    • 570 new test assertions for debugging/profiling features

  • New interfaces for extensibility:

    • CacheableHandler for cache manager access
    • CacheableRequestHandler for cache operations
    • DebuggableHandler for debug/profiling support
    • PoolAwareHandler for connection pool management

Changed

  • Refactored ClientHandler interface to extend multiple focused interfaces for better separation of concerns
  • Enhanced PerformsHttpRequests trait with integrated caching support
  • Improved PHPDoc comments with detailed parameter types for better IDE support and static analysis
  • Updated method signatures in RequestConfigurator to return specific types instead of self
  • Streamlined pre-commit script to use Composer commands instead of shell commands
  • Enhanced type hints across CacheManager, ManagesDebugAndProfiling, ManagesRetries, and PerformsHttpRequests traits

Fixed

  • Fixed timing precision issues in delay tests on Windows (#72)
  • Fixed PHPStan type inference for ClientHandler method chaining
  • Improved TTL behavior consistency in cache implementations
  • Enhanced null handling and race condition prevention in cache operations
  • Fixed status code handling consistency across caching layer
  • Improved URI handling in connection pool exceptions
  • Corrected time-to-first-byte calculation in profiling metrics
  • Enhanced code style consistency: proper namespace imports, class element ordering, and PHPDoc cleanup

Full Changelog: https://github.com/Thavarshan/fetch-php/compare/v3.3.0...v3.4.0

v3.3.0 - 2025-01-17

Added

  • Comprehensive Testing Utilities inspired by Laravel's HTTP client testing:
    • MockServer with URL pattern matching (wildcards, method-specific, callbacks)
    • MockResponse fluent builder with convenience methods for all HTTP status codes
    • MockResponseSequence for testing retry logic and flaky endpoints
    • Recorder for capturing and replaying request/response pairs
    • Comprehensive assertion helpers (assertSent(), assertNotSent(), assertSentCount(), assertNothingSent())
    • Request recording with JSON export/import for test fixtures
    • Stray request prevention with allowlist support
  • HandlesMocking trait integrated into ClientHandler for request interception
  • Request::createFromBase() method for PSR-7 request conversion
  • 117 new tests with 288 assertions for testing utilities
  • Comprehensive testing documentation in docs/guide/testing.md (617 lines)
  • Complete API reference in docs/api/testing.md (539 lines)
  • Testing utilities section in VitePress sidebar navigation

Changed

  • Updated PerformsHttpRequests to support mock request interception
  • Enhanced ClientHandler with HandlesMocking trait for testing support

Fixed

  • Fixed async helper function imports to use correct Matrix\Support\* namespace:
    • Updated imports in ManagesPromises trait (async, await, all, any, race, reject, resolve, timeout)
    • Updated imports in PerformsHttpRequests trait (async)
    • Updated imports in ManagesPromisesTest and AsyncRequestsTest
  • All 282 tests now passing with 841 assertions

Removed

  • Removed Dependabot configuration (dependabot.yml)
  • Removed Dependabot auto-merge workflow

Full Changelog: https://github.com/Thavarshan/fetch-php/compare/v3.2.3...v3.3.0

v3.2.3 - 2025-05-24

Added

  • Comprehensive test coverage for array body handling in ConfiguresRequestsTest
  • Explicit option conflict prevention in request body configuration
  • Better error prevention for Guzzle HTTP client integration

Changed

  • ConfiguresRequests::withBody() method now ensures mutual exclusivity of body-related options
  • Request option handling now explicitly removes conflicting options (json, body, form_params, multipart)
  • Improved reliability of JSON array requests by preventing option conflicts

Fixed

  • BREAKING FIX: Resolved Guzzle InvalidArgumentException when sending POST requests with array bodies
  • Fixed issue where both json and body options were set simultaneously, causing Guzzle to reject requests
  • Eliminated "Passing in the 'body' request option as an array to send a request is not supported" error
  • Restored ability to send structured JSON data using PHP arrays in request bodies
  • Fixed helper functions (post(), put(), patch(), etc.) failing with array payloads

Full Changelog: https://github.com/Thavarshan/fetch-php/compare/3.2.2...3.2.3

v3.2.2 - 2025-05-19

Fixed

  • "Fatal error: Uncaught Error: Interface Psr\Log\LoggerAwareInterface not found" closes #21

v3.2.1 - 2025-05-17

Changed

  • Updated documentation
  • Updated dependencies

v3.2.0 - 2025-05-16

Added

  • Added tests for various HTTP methods (GET, POST, PUT, DELETE, PATCH, OPTIONS) with appropriate assertions.

Changed

  • Simplified ManagesRetriesTest by using a mock class for retry-logic testing.
  • Consolidated tests for retryable status codes and exceptions into a single method.
  • Updated PerformsHttpRequestsTest to use GuzzleHttp client mocks for more accurate request simulation.
  • Enhanced exception-handling tests to verify error messages and retry behaviour.
  • Removed unnecessary reflection methods and streamlined test setup.

Fixed

  • Improved back-off delay calculations in retry tests to ensure correct timing.

Full Changelog: https://github.com/Thavarshan/fetch-php/compare/3.1.1...3.2.0

v3.1.1 - 2025-05-16

Added

  • Implemented the missing finalizeRequest() method in the PerformsHttpRequests trait. This method centralizes request finalization logic, enabling internal shortcut methods like get(), post(), etc., to function correctly.

Changed

  • Internal shortcut HTTP methods (get(), post(), put(), etc.) in PerformsHttpRequests now route through the newly added finalizeRequest() method for consistent request handling.

Fixed

  • Fixed a fatal error caused by calling an undefined finalizeRequest() method in ClientHandler. The missing method has now been properly defined and implemented.

v3.1.0 - 2025-05-10

Added

  • PSR-18 Client: Fetch\Http\Client now implements Psr\Http\Client\ClientInterface for drop-in interoperability.

  • Fluent Request Builder: Chainable helpers on ClientHandler for headers, query params, JSON/form/multipart bodies, bearer token, basic auth, timeouts, redirects, cookies, proxy, certificates.

  • Async/Promise Support: Built-in ReactPHP-style promises (async(), await(), all(), race(), any(), sequence()), with ->async() toggle and wrapAsync()/awaitPromise() helpers.

  • Automatic Retries: Configurable max retries, retry delay, exponential backoff with jitter, and retry-on-status (408, 429, 5xx) or exceptions (ConnectException).

  • PSR-3 Logging: Optional LoggerInterface injection on Client and ClientHandler with info/debug/error logs and sensitive-data masking for retries, requests, and responses.

  • Immutable PSR-7 Extensions:

    • Fetch\Http\Request extends Guzzle’s PSR-7 Request with immutability traits and JSON/form/multipart constructors.
    • Fetch\Http\Response extends Guzzle’s PSR-7 Response with buffered body, array-access to JSON payloads, and helpers: ->json(), ->text(), ->xml(), ->blob(), ->arrayBuffer(), status inspectors, etc.

  • Enums for Safety: Fetch\Enum\Method, ContentType, and Status enums for validating methods, content types, and status codes.

  • Test Helpers: ClientHandler::createMockResponse() and createJsonResponse() to easily stub HTTP responses in unit tests.

Changed

  • Consolidated Handler Traits: Core behavior refactored into six concerns (ConfiguresRequests, HandlesUris, ManagesPromises, ManagesRetries, PerformsHttpRequests, SendsRequests) for clearer separation of URI handling, retries, promises, and request dispatch.
  • Unified Fetch API: Client::fetch() now returns either a ResponseInterface or the handler for method chaining, replacing older ad-hoc patterns.
  • Error-handling Alignment: Top-level Client::sendRequest() now throws standardized NetworkException, RequestException, or ClientException instead of raw RuntimeException.
  • Default Options Management: Moved default method, headers, and timeout into ClientHandler::$defaultOptions with new getDefaultOptions() and setDefaultOptions().
  • Guzzle Configuration: ClientHandler now reuses a single Guzzle client instance with RequestOptions::HTTP_ERRORS disabled (handling errors internally) and CONNECT_TIMEOUT mapped from handler timeout.

Removed

  • None

v3.0.0 - 2025-05-04

Added

  • True Asynchronous Support: Completely reimplemented asynchronous functionality using Matrix’s PHP Fiber-based library.

  • JavaScript-like Syntax: Added support for JavaScript-like async/await patterns with async() and await() functions.

  • Promise-based API: Introduced a clean Promise interface with then(), catch(), and finally() methods.

  • Concurrent Request Helpers: Added support for managing multiple concurrent requests with all(), race(), and any() functions.

  • Task Lifecycle Management: Implemented proper task lifecycle control (start, pause, resume, cancel, retry).

  • Enhanced Error Handling: Added improved error handling with customizable error handlers.

  • New Helper Methods:

    • wrapAsync(): For wrapping callables in async functions
    • awaitPromise(): For awaiting promise resolution

Changed

  • New Matrix Integration: Migrated from legacy AsyncHelper to the new Matrix Fiber-based promises.
  • Return Type Changes: Updated method signatures to use union types (ResponseInterface|PromiseInterface).
  • Simplified API: Streamlined the API to match JavaScript’s fetch pattern more closely.
  • Improved Retry Logic: Enhanced retry mechanisms for both synchronous and asynchronous requests.
  • Updated Documentation: Completely revised documentation to reflect the new async patterns.

Removed

  • AsyncHelper Class: Removed the legacy AsyncHelper class in favor of direct Matrix integration.

Fixed

  • Promise Handling: Fixed various issues with Promise resolution and rejection.
  • Retry Mechanism: Fixed retry logic to properly handle both network and server errors.
  • Error Propagation: Improved how errors are propagated through Promise chains.
  • Event Loop Management: Fixed event loop management for proper async task execution.

v2.0.6 - 2025-05-03

Added

  • Added withQueryParameter() method for adding a single query parameter.
  • Added withJson() method as a convenient way to set JSON request bodies.
  • Added withFormParams() and withMultipart() helper methods for form submissions.
  • Added configurePostableRequest() helper method to standardize request body handling.

Changed

  • Enhanced withBody() method to support multiple content types (JSON, form-encoded, multipart).
  • Improved post() and put() methods to properly handle different content types.
  • Improved retry mechanism with exponential backoff and jitter for better reliability.
  • Enhanced error handling to be more selective about which errors trigger retries.

Fixed

  • Fixed query parameter handling to properly merge with existing parameters instead of overwriting.
  • Fixed URL construction in getFullUri() to correctly append query parameters.
  • Fixed retry logic to perform exactly the specified number of retries (not one extra).
  • Fixed duplicate implementation of isRetryableError() method.
  • Fixed retry failure detection to properly identify the last retry attempt.

v2.0.5 - 2025-03-30

Added

  • getOptions(), getHeaders(), hasHeader(string $header), and hasOption(string $option) methods on ClientHandler.

Full Changelog: https://github.com/Thavarshan/fetch-php/compare/v2.0.4...v2.0.5

v2.0.4 - 2025-03-30

Added

  • Support for setting a single request header via withHeader() in ClientHandler.
  • withToken(string $token): self, withAuth(string $username, string $password): self, and withHeader(string $header, mixed $value): self methods on ClientHandler.
  • Added laravel/pint as a dev dependency.

Changed

  • Bumped composer.json to 2.0.4.
  • Bumped dependabot/fetch-metadata from 2.2.0 to 2.3.0.
  • README syntax fix.

Fixed

  • Restored jerome/matrix and psr/http-message dependencies.

New Contributors

  • @tresbach in #14

Full Changelog: https://github.com/Thavarshan/fetch-php/compare/v2.0.3...v2.0.4

v2.0.3 - 2024-12-06

Added

  • Support for all PHP 8.x versions.

Changed

  • Updated dependencies and dev-dependencies.

Full Changelog: https://github.com/Thavarshan/fetch-php/compare/v2.0.2...v2.0.3

v2.0.2 - 2024-10-19

Added

  • Added Laravel Pint integration.
  • isAsync() method on ClientHandler.

Changed

  • Updated async() method to accept arguments.

New Contributors

  • @patinthehat in #8

Full Changelog: https://github.com/Thavarshan/fetch-php/compare/v2.0.1...v2.0.2

v2.0.1 - 2024-10-03

Changed

  • Refactored withBody() in ClientHandler to accept only arrays and JSON-encode them.
  • Documentation and typo fixes.

v2.0.0 - 2024-09-30

Added

  • VitePress documentation site under ./docs/.
  • PHP-Fiber-powered async() for JavaScript-like async/await.
  • Fluent, chainable HTTP API (headers, body, token, auth, etc.).
  • Task lifecycle control (pause, resume, cancel, retry).
  • Retry logic with exponential backoff.

Changed

  • Refactored core fetch() for seamless sync/async.
  • Enhanced error handling and promise rejection.
  • Overhauled Response class for JSON, text, binary, and streams.
  • Exposed Guzzle options (proxy, cookies, redirects, SSL).

Removed

  • Deprecated fetchAsync method.
  • Symfony Response dependency.

Fixed

  • Laravel 10 / Symfony 6 compatibility.
  • Async error handling.
  • Persistent Guzzle client reuse.

v1.2.0 - 2024-09-27

Added

  • Guzzle PSR-7 support via guzzlehttp/psr7.
  • Improved error handling with Guzzle’s RequestException.
  • Updated README for PSR-7 usage.

Changed

  • Response now extends guzzlehttp/psr7\Response.
  • Refactored HTTP class for PSR-7 compliance.
  • Removed Symfony Response dependency.

Fixed

  • Laravel 10 compatibility.
  • Composer dependency conflicts.
  • Async exception handling.

v1.1.1 - 2024-09-25

Changed

  • Updated symfony/http-foundation to ^6.0 || ^7.0.
  • Expanded GitHub Actions test matrix for Laravel 9–11.

Fixed

  • Resolved Laravel 10 install conflict.

v1.1.0 - 2024-09-24

Changed

  • Abstracted HTTP handling into a new Http class.
  • Guzzle client reused as a singleton.
  • Deprecated fetchAsync in favor of fetch_async.

Fixed

  • Single-instance Guzzle instantiation.

v1.0.0 - 2024-09-14

Initial release.