Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix MySQL commands #354

Merged
merged 1 commit into from
Dec 7, 2024
Merged

Fix MySQL commands #354

merged 1 commit into from
Dec 7, 2024

Conversation

frenck
Copy link
Member

@frenck frenck commented Dec 7, 2024

Proposed Changes

Fixes the MySQL/MariaDB commands.

With the latest MariaDB CLI, SSL is enabled by default. Additionally, calling the CLI using mysql is now deprecated.

Summary by CodeRabbit

  • New Features

    • Enhanced error handling for remote MySQL configurations.
    • Automatic creation of necessary directories for uploads, files, and images.
  • Bug Fixes

    • Improved validation for database connection parameters.
  • Chores

    • Updated database command from mysql to mariadb with new options.

@frenck frenck added the bugfix Inconsistencies or issues which will cause a problem for users or implementors. label Dec 7, 2024
Copy link

coderabbitai bot commented Dec 7, 2024

Walkthrough

The changes in the bookstack.sh script focus on improving database connection management and error handling. The database creation command has been updated from mysql to mariadb with the addition of the --skip-ssl option. Enhanced error checks ensure that remote MySQL configurations are validated, and appropriate fatal error logging occurs if required parameters are missing. The script also verifies the availability of the MariaDB service for local access, creates necessary directories, and manages symbolic links for uploads. Overall, these modifications enhance robustness and reliability in database interactions.

Changes

File Path Change Summary
bookstack/rootfs/etc/cont-init.d/bookstack.sh Updated database command from mysql to mariadb with --skip-ssl; enhanced error handling for remote MySQL configurations; added checks for MariaDB service availability; ensured creation of necessary directories and ownership assignment; managed symbolic links for uploads; maintained application key logic.

Poem

🐰 In the garden where changes bloom,
The rabbit hops with joy, dispelling gloom.
With mariadb now in play,
Errors logged, come what may!
Directories sprout, links align,
A script so fine, it’s truly divine! 🌼


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • 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 generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

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 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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
bookstack/rootfs/etc/cont-init.d/bookstack.sh (2)

50-54: Consider security implications of disabling SSL

While the change from mysql to mariadb command is appropriate, disabling SSL (--skip-ssl) for local connections might need reconsideration:

  1. Even for local connections, SSL provides an additional security layer.
  2. Instead of disabling SSL completely, consider using proper SSL certificates.

Consider these alternatives:

  1. Use SSL certificates provided by the MariaDB addon
  2. If SSL must be disabled, add a comment explaining why it's safe in this context (e.g., if the connection is guaranteed to be local only)

50-54: Enhance database creation command

The database creation command could be improved for better security and clarity.

Consider this enhanced version:

 mariadb \
   -u "${username}" -p"${password}" \
   -h "${host}" -P "${port}" \
   --skip-ssl \
-  -e "CREATE DATABASE IF NOT EXISTS \`bookstack\` ;"
+  -e "CREATE DATABASE IF NOT EXISTS \`bookstack\` CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;"

This change:

  1. Explicitly sets the character set to utf8mb4 for full Unicode support
  2. Sets a proper collation for consistent string comparisons
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 3232d70 and f042a7b.

📒 Files selected for processing (1)
  • bookstack/rootfs/etc/cont-init.d/bookstack.sh (1 hunks)
🔇 Additional comments (1)
bookstack/rootfs/etc/cont-init.d/bookstack.sh (1)

50-54: Verify other MySQL command usage

Let's ensure all MySQL commands in the codebase are updated consistently.

✅ Verification successful

MySQL command usage is consistent

Based on the search results, there is only one MySQL/MariaDB command execution in the codebase, which is the one being reviewed. The --skip-ssl flag addition is isolated to this single database creation command. The rest of the database connectivity is handled through environment variables and PHP database drivers, which manage their own SSL settings separately.

  • The only direct database command is in bookstack/rootfs/etc/cont-init.d/bookstack.sh for database creation
  • Database connection settings for the application are managed via environment variables in bookstack/rootfs/etc/services.d/php-fpm/run
  • No other MySQL/MariaDB command executions were found that would need similar updates
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for any remaining mysql commands that might need updates
rg -i "mysql\s+[^-]|mysql$" --type sh

# Search for database connection configurations that might need SSL settings
rg -i "DB_|database|mysql|mariadb" --type php --type env

Length of output: 126


Script:

#!/bin/bash
# Search for any remaining mysql/mariadb commands in shell scripts
rg -i "mysql|mariadb" --type sh -A 3

# Search for database configuration files and environment templates
fd -e php -e env.example -e env.sample -e env.template | xargs rg -i "DB_|database|mysql|mariadb"

# Search specifically in the bookstack directory for any database related files
fd . bookstack/ -t f | xargs rg -i "mysql|mariadb|database"

Length of output: 13133

@frenck frenck merged commit e20d1de into main Dec 7, 2024
22 checks passed
@frenck frenck deleted the frenck-2024-0591 branch December 7, 2024 14:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bugfix Inconsistencies or issues which will cause a problem for users or implementors.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant