fix(cmake): Add Homebrew path detection for mariadb-connector-c to fix macOS build failure.

[LinZhihao-723]

Description

Recent macOS build workflow failed due to the version bump of mariadb-connector-c: https://github.com/y-scope/clp/actions/runs/11760063129
The detailed log message:

==> Installing mariadb-connector-c
==> Pouring mariadb-connector-c--3.4.1_1.arm64_sonoma.bottle.tar.gz
==> Caveats
mariadb-connector-c is keg-only, which means it was not symlinked into /opt/homebrew,
because it conflicts with mariadb.

If you need to have mariadb-connector-c first in your PATH, run:
  echo 'export PATH="/opt/homebrew/opt/mariadb-connector-c/bin:$PATH"' >> /Users/runner/.bash_profile

For compilers to find mariadb-connector-c you may need to set:
  export LDFLAGS="-L/opt/homebrew/opt/mariadb-connector-c/lib"
  export CPPFLAGS="-I/opt/homebrew/opt/mariadb-connector-c/include"

For pkg-config to find mariadb-connector-c you may need to set:
  export PKG_CONFIG_PATH="/opt/homebrew/opt/mariadb-connector-c/lib/pkgconfig"

This PR fixes the issue by changing the cmake file to detect mariadb-connector-c's homebrew path on macOS if PkgConfig failed to locate mariadb client.

Validation performed

• Tested locally to ensure the built successes with the new cmake and newly installed mariadb-connector-c
• Ensure macOS workflow passed: https://github.com/LinZhihao-723/clp/actions/runs/11761344531

Summary by CodeRabbit

• New Features

  • Improved detection of the MariaDB client library on macOS systems.
  • Enhanced error handling with clearer feedback if the library is not found.

• Bug Fixes

  • Resolved issues with package configuration checks for the MariaDB client library.

[coderabbitai]

Walkthrough

The changes introduce enhancements to the FindMariaDBClient.cmake module, specifically to improve the detection of the MariaDB client library on macOS systems. A new conditional block has been added to check for the mariadbclient_PKGCONF_FOUND variable and, if it is not set, to retrieve the installation prefix using Homebrew. The script updates the CMAKE_PREFIX_PATH and attempts to check for the package configuration again. If the library is still not found, a fatal error message is generated to improve error handling.

Changes

File Path	Change Summary
components/core/cmake/Modules/FindMariaDBClient.cmake	Enhanced detection logic for the MariaDB client library on macOS, including checks for mariadbclient_PKGCONF_FOUND and retrieval of installation prefix via Homebrew. Improved error handling with a fatal error message if the library is not found.

Suggested reviewers

• kirkrodrigues

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between e882a49 and a0fcffe.

📒 Files selected for processing (1)

• components/core/cmake/Modules/FindMariaDBClient.cmake (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• components/core/cmake/Modules/FindMariaDBClient.cmake

---

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

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

[LinZhihao-723]

This is a placeholder error message. May need a more meaningful fatal log

[LinZhihao-723]

We might not need QUIET here

Suggested change

	pkg_check_modules(mariadbclient_PKGCONF QUIET "lib${mariadbclient_LIBNAME}")
	pkg_check_modules(mariadbclient_PKGCONF "lib${mariadbclient_LIBNAME}")

[coderabbitai]

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)

components/core/cmake/Modules/FindMariaDBClient.cmake (1)

30-32: Enhance error message with platform-specific guidance

The error message should provide platform-specific installation instructions to help users resolve the issue.

Consider this improved implementation:

 if(NOT mariadbclient_PKGCONF_FOUND)
-    message(FATAL_ERROR "pkg_config cannot find mariadb")
+    if(APPLE)
+        message(FATAL_ERROR "pkg_config cannot find mariadb. Please ensure mariadb-connector-c is installed via Homebrew: brew install mariadb-connector-c")
+    else()
+        message(FATAL_ERROR "pkg_config cannot find mariadb. Please ensure mariadb-connector-c development package is installed on your system")
+    endif()
 endif()

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 7ea3941 and e882a49.

📒 Files selected for processing (1)

• components/core/cmake/Modules/FindMariaDBClient.cmake (1 hunks)

🔇 Additional comments (1)

components/core/cmake/Modules/FindMariaDBClient.cmake (1)

23-32: Verify the fix resolves the macOS workflow failure

The implementation looks correct for handling keg-only Homebrew formulae. Let's verify the changes resolve the specific workflow failure.

✅ Verification successful

Implementation correctly handles keg-only MariaDB Connector/C on macOS

The changes are well-implemented and follow established patterns in the codebase. The solution:

• Properly handles keg-only Homebrew formulae by using brew --prefix
• Follows the same approach used for other dependencies (e.g., libarchive) in the codebase
• Maintains the pkg-config workflow while adding macOS-specific handling
• Preserves compatibility with other platforms through conditional execution

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the CMake configuration works with the Homebrew-installed mariadb-connector-c

# Test: Check if the error message appears in recent workflow runs
gh run list --workflow ".github/workflows/macos.yml" --limit 5 --json conclusion,databaseId | \
  jq -r '.[] | select(.conclusion=="failure") | .databaseId' | \
  while read -r run_id; do
    gh run view "$run_id" --log | grep -A 5 "pkg_config cannot find mariadb"
  done

Length of output: 282

---

Script:

#!/bin/bash
# Let's verify the CMake configuration and MariaDB client handling

# Check for any existing MariaDB client configurations
fd -e cmake -e txt "MariaDB" -X cat {}

# Look for pkg-config related configurations
rg -A 5 "pkg_check_modules" 

# Check for any other Homebrew-related configurations
rg -A 5 "brew.*prefix"

Length of output: 10699