Merge pull request #10 from move-elevator/mittwald-database-creation-status-retries

feat: implement database creation status check with retries

Author: konradmichalik

composer-require-checker.json

@@ -1,27 +1,27 @@
 {
-  "symbol-whitelist": [
-	"Normalizer",
-	"after",
-	"before",
-	"commandSupportSubcommand",
-	"debug",
-	"Deployer\\askHiddenResponse",
-	"Deployer\\debug",
-	"Deployer\\get",
-	"Deployer\\has",
-	"Deployer\\input",
-	"Deployer\\run",
-	"Deployer\\runExtended",
-	"Deployer\\set",
-	"Deployer\\test",
-	"Deployer\\upload",
-	"get",
-	"parse",
-	"runExtended",
-	"runLocally",
-	"set",
-	"task",
-	"test",
-  	"has"
-  ]
+	"symbol-whitelist": [
+		"Normalizer",
+		"after",
+		"before",
+		"commandSupportSubcommand",
+		"debug",
+		"Deployer\\askHiddenResponse",
+		"Deployer\\debug",
+		"Deployer\\get",
+		"Deployer\\has",
+		"Deployer\\input",
+		"Deployer\\run",
+		"Deployer\\runExtended",
+		"Deployer\\set",
+		"Deployer\\test",
+		"Deployer\\upload",
+		"get",
+		"parse",
+		"runExtended",
+		"runLocally",
+		"set",
+		"task",
+		"test",
+		"has"
+	]
 }

src/Database/Manager/MittwaldApi.php

@@ -2,19 +2,16 @@
 
 namespace MoveElevator\DeployerTools\Database\Manager;
 
+use Deployer\Exception\Exception;
 use GuzzleHttp\Exception\GuzzleException;
-use Mittwald\ApiClient\Client\EmptyResponse;
 use Mittwald\ApiClient\Error\UnexpectedResponseException;
-use Mittwald\ApiClient\Generated\V2\Clients\Database\CreateMysqlDatabase\CreateMysqlDatabaseCreatedResponse;
 use Mittwald\ApiClient\Generated\V2\Clients\Database\DeleteMysqlDatabase\DeleteMysqlDatabaseRequest;
-use Mittwald\ApiClient\Generated\V2\Clients\Database\GetMysqlDatabase\GetMysqlDatabaseOKResponse;
-use Mittwald\ApiClient\Generated\V2\Clients\Database\GetMysqlUser\GetMysqlUserOKResponse;
 use Mittwald\ApiClient\Generated\V2\Clients\Database\GetMysqlUser\GetMysqlUserRequest;
 use Mittwald\ApiClient\Generated\V2\Schemas\Database\CharacterSettings;
+use Mittwald\ApiClient\Generated\V2\Schemas\Database\DatabaseUserStatus;
 use Mittwald\ApiClient\Generated\V2\Schemas\Database\MySqlUser;
 use Mittwald\ApiClient\MittwaldAPIV2Client;
 use Mittwald\ApiClient\Generated\V2\Clients\Database\ListMysqlDatabases\ListMysqlDatabasesRequest;
-use Mittwald\ApiClient\Generated\V2\Clients\Database\ListMysqlDatabases\ListMysqlDatabasesOKResponse;
 use Mittwald\ApiClient\Generated\V2\Schemas\Database\CreateMySqlDatabase;
 use Mittwald\ApiClient\Generated\V2\Schemas\Database\CreateMySqlUserWithDatabase;
 use Mittwald\ApiClient\Generated\V2\Schemas\Database\CreateMySqlUserWithDatabaseAccessLevel;
@@ -42,6 +39,11 @@ class MittwaldApi extends AbstractManager implements ManagerInterface
 {
     private MittwaldAPIV2Client $client;
 
+    /**
+     * @throws GuzzleException
+     * @throws UnexpectedResponseException
+     * @throws \Exception
+     */
     public function create(): void
     {
         debug('Creating database');
@@ -69,8 +71,14 @@ public function create(): void
                 )
             );
 
-
         $responseBody = $response->getBody();
+
+        // The database creation is not immediately available, we need to wait for it.
+        $ready = $this->checkForDatabaseReadyStatus($responseBody->getUserId());
+        if (!$ready) {
+            throw new \RuntimeException('Database is not ready for feature ' . $this->getFeatureName() . ' after waiting period.');
+        }
+
         $database = $this->getDatabase($responseBody->getId());
         $user = $this->getDatabaseUser($responseBody->getUserId());
 
@@ -99,6 +107,10 @@ public function delete(string $feature): void
 
     }
 
+    /**
+     * @throws GuzzleException
+     * @throws UnexpectedResponseException
+     */
     public function exists(?string $feature = null): bool
     {
         debug('Check database exists');
@@ -131,6 +143,10 @@ private function initClient(): MittwaldAPIV2Client
         return $this->client;
     }
 
+    /**
+     * @throws GuzzleException
+     * @throws UnexpectedResponseException
+     */
     private function getDatabaseByFeature(string $feature): ?MySqlDatabase
     {
         $response = $this->initClient()
@@ -150,6 +166,10 @@ private function getDatabaseByFeature(string $feature): ?MySqlDatabase
         return null;
     }
 
+    /**
+     * @throws GuzzleException
+     * @throws UnexpectedResponseException
+     */
     private function getDatabase(string $id): MySqlDatabase
     {
         $response = $this->initClient()
@@ -164,6 +184,10 @@ private function getDatabase(string $id): MySqlDatabase
         return $response->getBody();
     }
 
+    /**
+     * @throws GuzzleException
+     * @throws UnexpectedResponseException
+     */
     private function getDatabaseUser(string $id): MysqlUser
     {
         $response = $this->initClient()
@@ -184,4 +208,34 @@ private function initDatabaseConfiguration(MySqlDatabase $database, MySqlUser $u
         set('database_host', $database->getHostName());
         set('database_password', VarUtility::getDatabasePassword());
     }
+
+    private function checkForDatabaseReadyStatus(string $mysqlUserId, int $waitingTime = 60, int $maxRetries = 10): bool
+    {
+
+        while ($maxRetries > 0) {
+            try {
+                debug("Checking status for MySQL user {$mysqlUserId}, remaining attempts: {$maxRetries}");
+                $response = $this->initClient()
+                    ->database()
+                    ->getMysqlUser(
+                        new GetMysqlUserRequest($mysqlUserId)
+                    );
+
+                if (DatabaseUserStatus::ready === $response->getBody()->getStatus()) {
+                    debug("MySQL user {$mysqlUserId} is ready.");
+                    return true;
+                }
+            } catch (\Throwable $e) {
+                debug("Error while checking status: " . $e->getMessage());
+                // Optionally: break on certain errors
+            }
+
+            if ($maxRetries > 1) {
+                sleep($waitingTime);
+            }
+            $maxRetries--;
+        }
+        debug("MySQL user {$mysqlUserId} is not ready after all attempts.");
+        return false;
+    }
 }