feat: implement database creation status check with retries

[konradmichalik]

Summary by CodeRabbit

• Bug Fixes

  • Improved database creation reliability by adding an asynchronous readiness check that polls until the database user is ready; configurable wait/retry limits and a clear exception if readiness isn't reached.

• Documentation

  • Expanded API documentation to list possible exceptions for database management methods.

[coderabbitai]

Warning

Rate limit exceeded

@konradmichalik has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 18 minutes and 42 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📝 Walkthrough

Walkthrough

Adds a post-creation readiness check to MittwaldApi that polls the Mittwald API for MySQL user status after database creation; updates docblocks to declare possible Guzzle/response/exception throws. Also adjusts whitespace/formatting in composer-require-checker.json.

Changes

Cohort / File(s)	Summary
Database Readiness Polling src/Database/Manager/MittwaldApi.php	Added private checkForDatabaseReadyStatus() polling helper; integrated into create() to wait for MySQL user readiness and throw if timeout; added/extended docblock @throws annotations for create(), exists(), and several private helpers (GuzzleException, UnexpectedResponseException, \Exception).
Formatting Only composer-require-checker.json	Whitespace/formatting adjustments around symbol-whitelist array; no functional changes to contents or order.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant MittwaldApi
    participant MittwaldAPI_Service
    participant MySQL_User

    Caller->>MittwaldApi: request create(databaseConfig)
    MittwaldApi->>MittwaldAPI_Service: POST /databases (create)
    MittwaldAPI_Service-->>MittwaldApi: 201 Created + response
    MittwaldApi->>MittwaldAPI_Service: GET /databases/{id}/users (poll status) (repeat)
    MittwaldAPI_Service-->>MittwaldApi: user.status = initializing|ready
    alt status == ready
        MittwaldApi-->>Caller: return success
    else retries exhausted or error
        MittwaldApi-->>Caller: throw RuntimeException / propagate exceptions
    end

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

• feat: add character settings to MySQL database creation #3: Modifies the same MittwaldApi::create() method with CharacterSettings functionality for database creation, creating a direct code-level intersection.

Poem

🐰 I hopped to launch a database bright,

I polled the clouds through day and night,
Retry by retry, patient and steady,
Till the MySQL user said, "I'm ready!"
Exceptions noted — now everything's right. 🥕✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 77.78% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main change: implementing a database creation status check with retries. This directly reflects the core functionality added in the PR (checkForDatabaseReadyStatus polling logic with retry limits).

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch mittwald-database-creation-status-retries

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In `@src/Database/Manager/MittwaldApi.php`:
- Around line 216-242: In checkForDatabaseReadyStatus, the loop always calls
sleep($waitingTime) even after the final retry, which adds an unnecessary delay;
fix it by only sleeping when another attempt will follow (e.g., decrement
$maxRetries or check $maxRetries > 1 before calling sleep), ensuring the call to
sleep($waitingTime) happens only if there are remaining retries, and keep the
existing try/catch and return true behavior in the same method.