feat: add character settings to MySQL database creation

[konradmichalik]

Summary by CodeRabbit

• New Features
  • Database creation now explicitly sets character set and collation, ensuring consistent encoding for new MySQL databases. Default values are used if not specified.

[coderabbitai]

Walkthrough

The create() method in the MittwaldApi class was updated to explicitly set the character set and collation for new MySQL databases using deployment variables, defaulting to 'utf8mb4' and 'utf8mb4_unicode_ci' if not provided. No other logic or method signatures were changed.

Changes

Cohort / File(s)	Change Summary
Database Character Settings Addition src/Database/Manager/MittwaldApi.php	Modified the database creation process to include explicit character set and collation settings using deployment variables.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant MittwaldApi
    participant CreateMySqlDatabase
    participant CharacterSettings

    Caller->>MittwaldApi: create()
    MittwaldApi->>CreateMySqlDatabase: instantiate
    MittwaldApi->>CharacterSettings: instantiate with charset, collation
    MittwaldApi->>CreateMySqlDatabase: withCharacterSettings(CharacterSettings)
    MittwaldApi->>CreateMySqlDatabase: proceed with creation

Loading

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

A charset here, a collation there,
MySQL databases get extra care.
With utf8mb4, all words can play,
Unicode dreams in fields of gray.
A hop and a skip, the code is tight—
Review is quick, the future bright!
🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch mittwald-database-character-settings

---

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

src/Database/Manager/MittwaldApi.php (1)

54-63: Consider validating & caching charset/collation values before the API call

The inline get() calls work, but:

1. They are evaluated twice (once for each parameter) and make the expression dense.
2. Any invalid or unsupported value will only surface as a runtime API error that is hard to trace.

A small refactor improves readability and allows a future whitelist/validation step:

-                        database: (new CreateMySqlDatabase(
-                            $this->getFeatureName(),
-                            get('mittwald_project_id'),
-                            get('mittwald_database_version', '8.4')
-                        ))->withCharacterSettings(
-                            new CharacterSettings(
-                                characterSet: get('mittwald_database_character_set', 'utf8mb4'),
-                                collation: get('mittwald_database_collation', 'utf8mb4_unicode_ci')
-                            )
-                        ),
+                        $charset   = get('mittwald_database_character_set', 'utf8mb4');
+                        $collation = get('mittwald_database_collation', 'utf8mb4_unicode_ci');
+                        // TODO (optional): validate $charset/$collation against supported lists.
+
+                        database: (new CreateMySqlDatabase(
+                            $this->getFeatureName(),
+                            get('mittwald_project_id'),
+                            get('mittwald_database_version', '8.4')
+                        ))->withCharacterSettings(
+                            new CharacterSettings(
+                                characterSet: $charset,
+                                collation:   $collation,
+                            )
+                        ),

This is a non-breaking, readability-oriented change; feel free to ignore if you prefer the current inline style.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a991337 and 6416545.

📒 Files selected for processing (1)

• src/Database/Manager/MittwaldApi.php (2 hunks)

🔇 Additional comments (1)

src/Database/Manager/MittwaldApi.php (1)

13-14: Import looks correct – no concerns

CharacterSettings is required for the new charset/collation logic and the namespace is correct.