feat: share connection in CURLRequest

Author: ddevsr

app/Config/CURLRequest.php

@@ -6,6 +6,22 @@
 
 class CURLRequest extends BaseConfig
 {
+    /**
+     * --------------------------------------------------------------------------
+     * CURLRequest Share Connection
+     * --------------------------------------------------------------------------
+     *
+     * Whether share connection between requests.
+     *
+     * @var list<int>
+     *
+     * @see https://www.php.net/manual/en/curl.constants.php#constant.curl-lock-data-connect
+     */
+    public array $shareConnection = [
+        CURL_LOCK_DATA_CONNECT,
+        CURL_LOCK_DATA_DNS,
+    ];
+
     /**
      * --------------------------------------------------------------------------
      * CURLRequest Share Options

system/HTTP/CURLRequest.php

@@ -108,7 +108,7 @@ class CURLRequest extends OutgoingRequest
      * If true, all the options won't be reset between requests.
      * It may cause an error request with unnecessary headers.
      */
-    private readonly CurlShareHandle $shareConnection;
+    protected ?CurlShareHandle $shareConnection = null;
 
     /**
      * Takes an array of options to set the following possible class properties:
@@ -140,9 +140,18 @@ public function __construct(App $config, URI $uri, ?ResponseInterface $response
         $this->parseOptions($options);
 
         // Share Connection
-        $this->shareConnection = curl_share_init();
-        curl_share_setopt($this->shareConnection, CURLSHOPT_SHARE, CURL_LOCK_DATA_CONNECT);
-        curl_share_setopt($this->shareConnection, CURLSHOPT_SHARE, CURL_LOCK_DATA_DNS);
+        $optShareConnection = config(ConfigCURLRequest::class)->shareConnection ?? [
+            CURL_LOCK_DATA_CONNECT,
+            CURL_LOCK_DATA_DNS,
+        ];
+
+        if ($optShareConnection !== []) {
+            $this->shareConnection = curl_share_init();
+
+            foreach (array_unique($optShareConnection) as $opt) {
+                curl_share_setopt($this->shareConnection, CURLSHOPT_SHARE, $opt);
+            }
+        }
     }
 
     /**
@@ -377,9 +386,13 @@ public function send(string $method, string $url)
         }
 
         $curlOptions[CURLOPT_URL]            = $url;
-        $curlOptions[CURLOPT_SHARE]          = $this->shareConnection;
         $curlOptions[CURLOPT_RETURNTRANSFER] = true;
-        $curlOptions[CURLOPT_HEADER]         = true;
+
+        if ($this->shareConnection instanceof CurlShareHandle) {
+            $curlOptions[CURLOPT_SHARE] = $this->shareConnection;
+        }
+
+        $curlOptions[CURLOPT_HEADER] = true;
         // Disable @file uploads in post data.
         $curlOptions[CURLOPT_SAFE_UPLOAD] = true;
 

tests/system/HTTP/CURLRequestTest.php

@@ -46,13 +46,18 @@ protected function setUp(): void
     /**
      * @param array<string, mixed> $options
      */
-    protected function getRequest(array $options = []): MockCURLRequest
+    protected function getRequest(array $options = [], bool $emptyShareConnection = false): MockCURLRequest
     {
         $uri = isset($options['baseURI']) ? new URI($options['baseURI']) : new URI();
         $app = new App();
 
         $config               = new ConfigCURLRequest();
         $config->shareOptions = false;
+
+        if ($emptyShareConnection) {
+            $config->shareConnection = [];
+        }
+
         Factories::injectMock('config', 'CURLRequest', $config);
 
         return new MockCURLRequest(($app), $uri, new Response($app), $options);
@@ -1235,6 +1240,25 @@ public function testForceResolveIPUnknown(): void
         $this->assertSame(\CURL_IPRESOLVE_WHATEVER, $options[CURLOPT_IPRESOLVE]);
     }
 
+    public function testShareConnectionDefault(): void
+    {
+        $this->request->request('GET', 'http://example.com');
+
+        $options = $this->request->curl_options;
+
+        $this->assertArrayHasKey(CURLOPT_SHARE, $options);
+    }
+
+    public function testShareConnectionEmpty(): void
+    {
+        $request = $this->getRequest(emptyShareConnection: true);
+        $request->request('GET', 'http://example.com');
+
+        $options = $request->curl_options;
+
+        $this->assertArrayNotHasKey(CURLOPT_SHARE, $options);
+    }
+
     /**
      * @return iterable<string, array{input: int|string|null, expectedHasKey: bool, expectedValue?: int}>
      *

user_guide_src/source/changelogs/v4.7.0.rst

@@ -38,6 +38,7 @@ Enhancements
 Libraries
 =========
 
+- **CURLRequest:** Added ``shareConnection`` config item to change default share connection.
 - **CURLRequest:** Added ``dns_cache_timeout`` option to change default DNS cache timeout.
 - **CURLRequest:** Added ``fresh_connect`` options to enable/disabled request fresh connection.
 - **Email:** Added support for choosing the SMTP authorization method. You can change it via ``Config\Email::$SMTPAuthMethod`` option.

user_guide_src/source/libraries/curlrequest.rst

@@ -23,6 +23,21 @@ to change very little to move over to use Guzzle.
 Config for CURLRequest
 **********************
 
+.. _curlrequest-sharing-connection:
+
+Sharing Connection
+==================
+
+.. versionadded:: 4.7.0
+
+If you want to share connection between requests, set ``$shareConnection`` with array constant `CURL_LOCK_DATA_* <https://www.php.net/manual/en/curl.constants.php#constant.curl-lock-data-connect>`_ in **app/Config/CURLRequest.php**:
+
+.. literalinclude:: curlrequest/039.php
+
+or when you want to disable it, just change to empty array:
+
+.. literalinclude:: curlrequest/040.php
+
 .. _curlrequest-sharing-options:
 
 Sharing Options

user_guide_src/source/libraries/curlrequest/039.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Config;
+
+use CodeIgniter\Config\BaseConfig;
+
+class CURLRequest extends BaseConfig
+{
+    // ...
+    public array $shareConnection = [
+        CURL_LOCK_DATA_CONNECT,
+        CURL_LOCK_DATA_DNS,
+    ];
+}

user_guide_src/source/libraries/curlrequest/040.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Config;
+
+use CodeIgniter\Config\BaseConfig;
+
+class CURLRequest extends BaseConfig
+{
+    // ...
+    public array $shareConnection = [];
+}