From 487dd349088ed5a3c8bd246f980b6feafb711fbb Mon Sep 17 00:00:00 2001
From: Patrick Dawkins <patrick@platform.sh>
Date: Wed, 18 Dec 2024 09:50:20 +0000
Subject: [PATCH] Clarify getCurrentDeployment type

---
 src/Service/Api.php | 15 +++------------
 1 file changed, 3 insertions(+), 12 deletions(-)

diff --git a/src/Service/Api.php b/src/Service/Api.php
index 0a1832b6e..5b3d86c17 100644
--- a/src/Service/Api.php
+++ b/src/Service/Api.php
@@ -1246,15 +1246,8 @@ public function getExternalHttpClient(): ClientInterface
 
     /**
      * Get the current deployment for an environment.
-     *
-     * @param Environment $environment
-     * @param bool        $refresh
-     * @param bool        $required
-     *
-     * @return EnvironmentDeployment|false
-     *   The current deployment, or false if $required is false and there is no current deployment.
      */
-    public function getCurrentDeployment(Environment $environment, bool $refresh = false, bool $required = true): EnvironmentDeployment|false
+    public function getCurrentDeployment(Environment $environment, bool $refresh = false): EnvironmentDeployment
     {
         $cacheKey = implode(':', ['current-deployment', $environment->project, $environment->id, $environment->head_commit]);
         if (!$refresh && isset(self::$deploymentsCache[$cacheKey])) {
@@ -1263,16 +1256,14 @@ public function getCurrentDeployment(Environment $environment, bool $refresh = f
         $data = $this->cache->fetch($cacheKey);
         if ($data === false || $refresh) {
             try {
-                $deployment = $environment->getCurrentDeployment($required);
+                /** @var EnvironmentDeployment $deployment */
+                $deployment = $environment->getCurrentDeployment();
             } catch (EnvironmentStateException $e) {
                 if ($e->getEnvironment()->status === 'inactive') {
                     throw new EnvironmentStateException('The environment is inactive', $e->getEnvironment());
                 }
                 throw $e;
             }
-            if (!$required && $deployment === false) {
-                return self::$deploymentsCache[$cacheKey] = false;
-            }
             $data = $deployment->getData();
             $data['_uri'] = $deployment->getUri();
             $this->cache->save($cacheKey, $data);