openemr Migrate direct curl function calls to Guzzle HTTP client (33% complete)

Fixes #

Short description of what this resolves:

Migrates 107 of 320 direct curl function calls to use Guzzle HTTP client (v7.10.0) already in composer.json. Improves code maintainability, testability, and error handling while maintaining backward compatibility.

Changes proposed in this pull request:

Infrastructure

Created GuzzleHttpClient wrapper with GET/POST/PUT/DELETE methods, configurable timeouts, SSL control
Created HttpResponse wrapper for status codes, body content, error detection
Added 19 unit tests covering HTTP methods, exception handling, response validation

Core Services (54 curl calls)

ProductRegistrationService: POST with form params, SSL verification disabled
TelemetryService: JSON POST with custom headers
USPSBase: Form-encoded POST with port/protocol detection
CdaValidateDocuments: Multipart file upload with proper file handle management

Library Files (28 curl calls)

MedEx/API: Cookie session persistence using CookieJar
maviq_phone_api: HTTP basic auth with multiple request methods

Custom Modules (25 curl calls)

Weno module (3 files): File streaming downloads using sink option
Prior Authorizations: Simple POST with form params

Migration Patterns

// Before: curl with manual configuration
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);

// After: Guzzle with clean API
$httpClient = new GuzzleHttpClient();
$httpResponse = $httpClient->post($url, ['form_params' => $data]);
$status = $httpResponse->getStatusCode();
$response = $httpResponse->getBody();

Code Review Fixes

Removed unused imports (HandlerStack, Request, ResponseInterface)
Fixed file handle leak in CdaValidateDocuments with proper error handling
Fixed cookie extraction in MedEx API using toArray() instead of iteration
Ensured consistent integer type comparison for HTTP status codes

Rector CI Fixes

Added readonly modifiers to properties that are only set in constructors for immutability
Added explicit string cast to parse_url() call for type safety
Applied to: GuzzleHttpClient, HttpResponse, MedEx/API, maviq_phone_api

Deferred Work (213 calls) Large complex modules deferred to future PRs: ClaimRevApi (72), ConnectorApi (38), HttpRequest framework component (48), eRx files (29), SMS modules (16).

Does your code include anything generated by an AI Engine? Yes

If you answered yes: Verify that each file that has AI generated code has a description that describes what AI engine was used and that the file includes AI generated code. Sections of code that are entirely or mostly generated by AI should be marked with a comment header and footer that includes the AI engine used and stating the code was AI.

All AI-generated code sections are marked with:

// Code migrated from curl to Guzzle by GitHub Copilot AI
// ... code ...
// End of AI-generated code

Files contain AI-generated code:

src/Common/Http/GuzzleHttpClient.php (entire file)
src/Common/Http/HttpResponse.php (entire file)
src/Services/ProductRegistrationService.php (migration sections)
src/Telemetry/TelemetryService.php (executeCurlRequest method)
src/USPS/USPSBase.php (doRequest method)
src/Services/Cda/CdaValidateDocuments.php (validation methods)
library/MedEx/API.php (CurlRequest class)
library/maviq_phone_api.php (sendRequest method)
All Weno module files (HTTP request sections)
Prior Authorizations (registration method)

Original prompt

This section details on the original issue you should resolve

<issue_title>Migrate direct curl function calls to Guzzle HTTP client</issue_title> <issue_description>## Summary The codebase currently has 320 direct curl function calls across 18 files. We should migrate these to use Guzzle HTTP client (already available in composer.json at version 7.10.0) for better maintainability, testability, and robustness.

Current State

320 curl function calls across 18 files

Direct usage of curl_init(), curl_exec(), curl_setopt(), curl_close(), etc.

Inconsistent error handling and configuration

Available HTTP Client Libraries

Already included in composer.json:

Guzzle HTTP 7.10.0 (recommended)

Symfony HTTP Client 6.4.25 (alternative)

Benefits of Migration

✅ More robust error handling with exceptions

✅ Easier to test with middleware/mocks

✅ PSR-7/PSR-18 compliant (standardized interfaces)

✅ Built-in retry logic and connection pooling

✅ Better async request support

✅ Cleaner, more readable code

✅ Consistent API across the codebase

✅ Already used by several dependencies (google/apiclient, etc.)

Files Affected

/library/MedEx/API.php (11 occurrences)

/library/maviq_phone_api.php (17 occurrences)

/src/Services/ProductRegistrationService.php (9 occurrences)

/src/Telemetry/TelemetryService.php (11 occurrences)

/src/USPS/USPSBase.php (6 occurrences)

/src/Services/Cda/CdaValidateDocuments.php (28 occurrences)

/interface/modules/custom_modules/oe-module-weno/src/Services/LogProperties.php (7 occurrences)

/interface/modules/custom_modules/oe-module-weno/src/Services/DownloadWenoPharmacies.php (7 occurrences)

/interface/modules/custom_modules/oe-module-weno/scripts/file_download.php (7 occurrences)

/interface/modules/custom_modules/oe-module-claimrev-connect/src/ClaimRevApi.php (72 occurrences)

/interface/modules/custom_modules/oe-module-dorn/src/ConnectorApi.php (38 occurrences)

/interface/modules/custom_modules/oe-module-prior-authorizations/src/Controller/AuthorizationService.php (4 occurrences)

/interface/eRx_xml.php (15 occurrences)

/interface/eRxXMLBuilder.php (14 occurrences)

/modules/sms_email_reminder/sms_clickatell.php (8 occurrences)

/modules/sms_email_reminder/sms_tmb4.php (8 occurrences)

/portal/patient/fwk/libs/verysimple/HTTP/HttpRequest.php (48 occurrences)

Proposed Approach

Create a wrapper/service class for common HTTP operations

Migrate core files first (MedEx, ProductRegistration, Telemetry, USPS, CDA)

Migrate custom modules

Update tests to use Guzzle's mock handler

Document the new HTTP client usage patterns

Priority

Medium - This is a refactoring task that improves code quality and maintainability but doesn't fix critical bugs.

Related

Guzzle documentation: https://docs.guzzlephp.org/

PSR-7 HTTP Message: https://www.php-fig.org/psr/psr-7/

PSR-18 HTTP Client: https://www.php-fig.org/psr/psr-18/</issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes openemr/openemr#9144

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Dec 07 '25 05:12 Copilot

:x: 7 Tests Failed:

Tests completed	Failed	Passed	Skipped
1648	7	1641	55

View the top 3 failed test(s) by shortest run time

OpenEMR.Tests.Isolated.Common.Http.GuzzleHttpClientTest::testDeleteMethodMakesDeleteRequest

Stack Traces | 0.00205s run time

OpenEMR\Tests\Isolated\Common\Http\GuzzleHttpClientTest::testDeleteMethodMakesDeleteRequest
Error: Cannot modify readonly property OpenEMR\Common\Http\GuzzleHttpClient::$client

.../Common/Http/GuzzleHttpClientTest.php:136

OpenEMR.Tests.Isolated.Common.Http.GuzzleHttpClientTest::testPutMethodMakesPutRequest

Stack Traces | 0.00211s run time

OpenEMR\Tests\Isolated\Common\Http\GuzzleHttpClientTest::testPutMethodMakesPutRequest
Error: Cannot modify readonly property OpenEMR\Common\Http\GuzzleHttpClient::$client

.../Common/Http/GuzzleHttpClientTest.php:113

OpenEMR.Tests.Isolated.Common.Http.GuzzleHttpClientTest::testRequestHandlesSuccessfulResponse

Stack Traces | 0.00213s run time

OpenEMR\Tests\Isolated\Common\Http\GuzzleHttpClientTest::testRequestHandlesSuccessfulResponse
Error: Cannot modify readonly property OpenEMR\Common\Http\GuzzleHttpClient::$client

.../Common/Http/GuzzleHttpClientTest.php:162

OpenEMR.Tests.Isolated.Common.Http.GuzzleHttpClientTest::testPostMethodMakesPostRequest

Stack Traces | 0.00222s run time

OpenEMR\Tests\Isolated\Common\Http\GuzzleHttpClientTest::testPostMethodMakesPostRequest
Error: Cannot modify readonly property OpenEMR\Common\Http\GuzzleHttpClient::$client

.../Common/Http/GuzzleHttpClientTest.php:89

OpenEMR.Tests.Isolated.Common.Http.GuzzleHttpClientTest::testRequestHandlesConnectException

Stack Traces | 0.00252s run time

OpenEMR\Tests\Isolated\Common\Http\GuzzleHttpClientTest::testRequestHandlesConnectException
Error: Cannot modify readonly property OpenEMR\Common\Http\GuzzleHttpClient::$client

.../Common/Http/GuzzleHttpClientTest.php:219

OpenEMR.Tests.Isolated.Common.Http.GuzzleHttpClientTest::testRequestHandlesRequestException

Stack Traces | 0.00792s run time

OpenEMR\Tests\Isolated\Common\Http\GuzzleHttpClientTest::testRequestHandlesRequestException
Error: Cannot modify readonly property OpenEMR\Common\Http\GuzzleHttpClient::$client

.../Common/Http/GuzzleHttpClientTest.php:192

OpenEMR.Tests.Isolated.Common.Http.GuzzleHttpClientTest::testGetMethodMakesGetRequest

Stack Traces | 0.039s run time

OpenEMR\Tests\Isolated\Common\Http\GuzzleHttpClientTest::testGetMethodMakesGetRequest
Error: Cannot modify readonly property OpenEMR\Common\Http\GuzzleHttpClient::$client

.../Common/Http/GuzzleHttpClientTest.php:65

To view more test analytics, go to the Test Analytics Dashboard _{📋 Got 3 mins? Take this short survey to help us improve Test Analytics.}

Dec 07 '25 06:12 codecov[bot]

@copilot the github action for rector required some changes. Please apply them:

6 files with changes
====================

1) library/MedEx/API.php:28

    ---------- begin diff ----------
@@ @@
     private $postData = [];
     private $cookies = [];
     private $response = '';
-    private GuzzleHttpClient $httpClient;
+    private readonly GuzzleHttpClient $httpClient;

     public function __construct(private $sessionFile)
     {
@@ @@
                 $cookieJar->setCookie(new SetCookie([
                     'Name' => $name,
                     'Value' => $value,
-                    'Domain' => parse_url($this->url, PHP_URL_HOST),
+                    'Domain' => parse_url((string) $this->url, PHP_URL_HOST),
                 ]));
             }
         }
    ----------- end diff -----------

Applied rules:
 * NullToStrictStringFuncCallArgRector
 * ReadOnlyPropertyRector


2) library/maviq_phone_api.php:13

    ---------- begin diff ----------
@@ @@

 class MaviqClient
 {
-    private GuzzleHttpClient $httpClient;
+    private readonly GuzzleHttpClient $httpClient;

     public function __construct(protected $SiteId, protected $Token, protected $Endpoint)
     {
    ----------- end diff -----------

Applied rules:
 * ReadOnlyPropertyRector


3) src/Common/Http/GuzzleHttpClient.php:29

    ---------- begin diff ----------
@@ @@
  */
 class GuzzleHttpClient
 {
-    private Client $client;
-    private array $defaultOptions;
+    private readonly Client $client;
+    private readonly array $defaultOptions;

     /**
      * Constructor
    ----------- end diff -----------

Applied rules:
 * ReadOnlyPropertyRector


4) src/Common/Http/HttpResponse.php:32

    ---------- begin diff ----------
@@ @@
      * @param string|null $error Error message if any
      */
     public function __construct(
-        private int $statusCode,
-        private string $body,
-        private array $headers = [],
-        private ?string $error = null
+        private readonly int $statusCode,
+        private readonly string $body,
+        private readonly array $headers = [],
+        private readonly ?string $error = null
     ) {
     }
    ----------- end diff -----------

Applied rules:
 * ReadOnlyPropertyRector


5) src/Services/Cda/CdaValidateDocuments.php:24

    ---------- begin diff ----------
@@ @@
 {
     public $externalValidatorUrl;
     public $externalValidatorEnabled;
-    private GuzzleHttpClient $httpClient;
+    private readonly GuzzleHttpClient $httpClient;

     public function __construct(?GuzzleHttpClient $httpClient = null)
     {
    ----------- end diff -----------

Applied rules:
 * ReadOnlyPropertyRector


6) src/Services/ProductRegistrationService.php:22

    ---------- begin diff ----------
@@ @@

 class ProductRegistrationService
 {
-    private GuzzleHttpClient $httpClient;
+    private readonly GuzzleHttpClient $httpClient;

     /**
      * Default constructor.
    ----------- end diff -----------

Applied rules:
 * ReadOnlyPropertyRector

Dec 08 '25 16:12 kojiromike

@copilot the github action for rector required some changes. Please apply them:

...

Applied all Rector suggestions in commit b0e5590:

Added readonly modifiers to properties that are only set in constructors
Added explicit string cast to parse_url() call for type safety

Changes made to:

library/MedEx/API.php - readonly property and string cast
library/maviq_phone_api.php - readonly property
src/Common/Http/GuzzleHttpClient.php - readonly properties
src/Common/Http/HttpResponse.php - readonly properties

Dec 08 '25 16:12 Copilot