[10.x] Add global default options feature to HTTP client.

src/Illuminate/Http/Client/Factory.php

@@ -7,6 +7,7 @@
 use GuzzleHttp\Psr7\Response as Psr7Response;
 use GuzzleHttp\TransferStats;
 use Illuminate\Contracts\Events\Dispatcher;
+use Illuminate\Support\Arr;
 use Illuminate\Support\Str;
 use Illuminate\Support\Traits\Macroable;
 use PHPUnit\Framework\Assert as PHPUnit;
@@ -62,6 +63,20 @@ class Factory
      */
     protected $preventStrayRequests = false;
 
+    /**
+     * The default options for the request.
+     *
+     * @var array
+     */
+    protected $defaultOptions = [];
+
+    /**
+     * Whether to ignore the default options for the next request.
+     *
+     * @var bool
+     */
+    protected $ignoreDefaultOptions = false;
+
     /**
      * Create a new factory instance.
      *
@@ -357,6 +372,48 @@ protected function newPendingRequest()
         return new PendingRequest($this);
     }
 
+    /**
+     * Ignore the default options for the next request.
+     *
+     * @return void
+     */
+    public function ignoreDefaultOptions()
+    {
+        $this->ignoreDefaultOptions = true;
+    }
+
+    /**
+     * Set the default options for the request.
+     *
+     * @param  array  $options
+     * @return $this
+     */
+    public function withDefaultOptions(array $options)
+    {
+        $this->defaultOptions = $options;
+
+        return $this;
+    }
+
+    /**
+     * Remove the specified keys from the default options.
+     *
+     * @param  $keys
+     * @return $this
+     */
+    public function withoutDefaultOptions($keys = null)
+    {
+        if (is_null($keys)) {
+            return $this->ignoreDefaultOptions();
+        }
+
+        foreach (Arr::wrap($keys) as $key) {
+            Arr::forget($this->defaultOptions, $key);
+        }
+
+        return $this;
+    }
+
     /**
      * Get the current event dispatcher implementation.
      *
@@ -381,7 +438,11 @@ public function __call($method, $parameters)
         }
 
         return tap($this->newPendingRequest(), function ($request) {
-            $request->stub($this->stubCallbacks)->preventStrayRequests($this->preventStrayRequests);
+            $request->when($this->defaultOptions && ! $this->ignoreDefaultOptions, function ($request) {
+                $request->withOptions($this->defaultOptions);
+            })
+                ->stub($this->stubCallbacks)
+                ->preventStrayRequests($this->preventStrayRequests);
         })->{$method}(...$parameters);
     }
 }

tests/Http/HttpClientTest.php

@@ -2215,4 +2215,112 @@ public function testTheTransferStatsAreCustomizableOnFake(): void
 
         $this->assertTrue($onStatsFunctionCalled);
     }
+
+    public function testDefaultOptionsAreApplied()
+    {
+        $this->factory->fake();
+
+        $this->factory->withDefaultOptions([
+            'headers' => [
+                'X-Custom-Header' => 'custom-value',
+            ],
+        ]);
+
+        $this->factory->get('https://foo.com');
+
+        $this->factory->assertSent(function ($request) {
+            return $request->hasHeader('X-Custom-Header', 'custom-value');
+        });
+    }
+
+    public function testDefaultOptionsWillBeIgnored()
+    {
+        $this->factory->fake();
+
+        $this->factory->withDefaultOptions([
+            'headers' => [
+                'X-Custom-Header' => 'custom-value',
+            ],
+        ]);
+
+        $this->factory->withoutDefaultOptions();
+
+        $this->factory->get('https://foo.com');
+
+        $this->factory->assertNotSent(function ($request) {
+            return $request->hasHeader('X-Custom-Header', 'custom-value');
+        });
+    }
+
+    public function testChainAdditionalOptionsBesideDefaultOptions()
+    {
+        $this->factory->fake();
+
+        $this->factory->withDefaultOptions([
+            'headers' => [
+                'X-Custom-Header' => 'custom-value',
+            ],
+        ]);
+
+        $this->factory->withOptions([
+            'headers' => [
+                'X-Another-Custom-Header' => 'another-custom-value',
+            ],
+        ])->get('https://foo.com');
+
+        $this->factory->assertSent(function ($request) {
+            return $request->hasHeader('X-Custom-Header', 'custom-value') &&
+                $request->hasHeader('X-Another-Custom-Header', 'another-custom-value');
+        });
+    }
+
+    public function testIgnoreSpecificDefaultOption()
+    {
+        $this->factory->fake();
+
+        $this->factory->withDefaultOptions([
+            'headers' => [
+                'X-Custom-Header' => 'custom-value',
+            ],
+        ]);
+
+        $this->factory->withoutDefaultOptions('headers');
+
+        $this->factory->get('https://foo.com');
+
+        $this->factory->assertNotSent(function ($request) {
+            return $request->hasHeader('X-Custom-Header', 'custom-value');
+        });
+    }
+
+    public function testIgnoreSpecificDefaultOptionUsingDotNotation()
+    {
+        $this->factory->fake();
+
+        $this->factory->withDefaultOptions([
+            'headers' => [
+                'X-Custom-Header' => 'custom-value',
+                'X-Another-Custom-Header' => 'another-custom-value',
+            ],
+        ]);
+
+        $this->factory->withoutDefaultOptions('headers.X-Another-Custom-Header');
+
+        $this->factory->get('https://foo.com');
+
+        $this->factory->assertNotSent(function ($request) {
+            return $request->hasHeader('X-Another-Custom-Header', 'another-custom-value');
+        });
+    }
+
+    public function testUsageOfTheClientWithoutDefaultOptionsSet()
+    {
+        $this->factory->fake([
+            '*' => $this->factory->response(),
+        ]);
+
+        $response = $this->factory->get('https://foo.com');
+
+        $this->assertEquals(200, $response->status());
+    }
 }