search

y-scope / clp

Compressed Log Processor (CLP) is a free log management tool capable of compressing logs and searching the compressed logs without decompression.
https://yscope.com
Apache License 2.0
871 stars 70 forks source link

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

Closed LinZhihao-723 closed 1 week ago

LinZhihao-723 commented 1 week ago

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

Summary by CodeRabbit

coderabbitai[bot] commented 1 week ago

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

📜 Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
📥 Commits Reviewing files that changed from the base of the PR and between e882a4924bebc8bcf1c8348c6d5075330f9f687f and a0fcffecc1ef934bcd406d09138ed38774562a88.
📒 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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.