Skip to content

fix(core): Resolve clang-tidy violations and compilation errors in GlobalMetadataDBConfig.hpp (fixes #643).#770

Merged
Bill-hbrhbr merged 5 commits into
y-scope:mainfrom
Bill-hbrhbr:clang-tidy-GlobalMetadataDBConfig
Mar 15, 2025
Merged

fix(core): Resolve clang-tidy violations and compilation errors in GlobalMetadataDBConfig.hpp (fixes #643).#770
Bill-hbrhbr merged 5 commits into
y-scope:mainfrom
Bill-hbrhbr:clang-tidy-GlobalMetadataDBConfig

Conversation

@Bill-hbrhbr

@Bill-hbrhbr Bill-hbrhbr commented Mar 15, 2025

Copy link
Copy Markdown
Contributor

Description

Currently, the two files listed in the PR title create compilation issues (missing headers) in the following environment:

  • WSL 1
  • Ubuntu-Focal 20.04
  • gcc13
  • g++13

Hence, this PR clang-tidies the problematic files and removes them from the clang-tidy exclude list.

image

This PR fixes #643 and contributes to #764

Checklist

  • The PR satisfies the contribution guidelines.
  • This is a breaking change and that has been indicated in the PR title, OR this isn't a
    breaking change.
  • Necessary docs have been updated, OR no docs need to be updated.

Validation performed

  • Refactor PR. Unit tests still pass.

Summary by CodeRabbit

Summary by CodeRabbit

  • Refactor

    • Modernised configuration handling with updated default settings and enhanced return value assurance for getter methods, improving consistency and reliability.
  • Chore

    • Streamlined code quality tasks by removing outdated components from automated checks, contributing to smoother project maintenance.

@coderabbitai

coderabbitai Bot commented Mar 15, 2025

Copy link
Copy Markdown
Contributor

Walkthrough

The changes update the GlobalMetadataDBConfig class in both the clp and glt directories. The updates simplify the default constructor by using = default and enhance getter methods by applying the [[nodiscard]] attribute along with trailing return types. Member variables now include default initializations with specific default values. Additionally, references to the GlobalMetadataDBConfig.hpp header have been removed from linting tasks specified in the lint-tasks.yml file. These modifications streamline the code’s interface without altering its underlying logic.

Changes

File(s) Change Summary
components/core/src/clp/GlobalMetadataDBConfig.hpp
components/core/src/glt/GlobalMetadataDBConfig.hpp
Updated default constructor to = default, refactored getter methods to use [[nodiscard]] with trailing return type syntax, and added inline default initializations for member variables.
lint-tasks.yml Removed references to GlobalMetadataDBConfig.hpp from the linting tasks.

Possibly related PRs

Suggested reviewers

  • kirkrodrigues

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a22803a and cbe8d75.

📒 Files selected for processing (2)
  • components/core/src/clp/GlobalMetadataDBConfig.hpp (2 hunks)
  • components/core/src/glt/GlobalMetadataDBConfig.hpp (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • components/core/src/clp/GlobalMetadataDBConfig.hpp
  • components/core/src/glt/GlobalMetadataDBConfig.hpp
⏰ Context from checks skipped due to timeout of 90000ms (11)
  • GitHub Check: ubuntu-jammy-dynamic-linked-bins
  • GitHub Check: ubuntu-jammy-static-linked-bins
  • GitHub Check: centos-stream-9-dynamic-linked-bins
  • GitHub Check: centos-stream-9-static-linked-bins
  • GitHub Check: ubuntu-jammy-lint
  • GitHub Check: build-macos (macos-13, false)
  • GitHub Check: build-macos (macos-15, true)
  • GitHub Check: build-macos (macos-13, true)
  • GitHub Check: build-macos (macos-14, false)
  • GitHub Check: build-macos (macos-14, true)
  • GitHub Check: lint-check (ubuntu-latest)

🪧 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 generate docstrings to generate docstrings 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.

@Bill-hbrhbr Bill-hbrhbr changed the title Add missing headers Refactor(core): Clang-tidy GlobalMetadataDBConfig.hpp in clp and glt to resolve compilation issues. Mar 15, 2025
@Bill-hbrhbr Bill-hbrhbr changed the title Refactor(core): Clang-tidy GlobalMetadataDBConfig.hpp in clp and glt to resolve compilation issues. refactor(core): Clang-tidy GlobalMetadataDBConfig.hpp in clp and glt to resolve compilation issues. Mar 15, 2025
@Bill-hbrhbr Bill-hbrhbr marked this pull request as ready for review March 15, 2025 02:45
@Bill-hbrhbr Bill-hbrhbr requested a review from a team as a code owner March 15, 2025 02:45

@kirkrodrigues kirkrodrigues left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

For the PR title, how about:

fix(core): Resolve clang-tidy violations and compilation errors in GlobalMetadataConfig.hpp (fixes #643).

private:
// Variables
MetadataDBType m_metadata_db_type;
static constexpr int cDefaultMetadataDbPort = 3306;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
static constexpr int cDefaultMetadataDbPort = 3306;
constexpr int cDefaultMetadataDbPort{3306};

Don't think the static is necessary, right?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@kirkrodrigues It's necessary to resolve the following compile error
error: non-static data member ‘cDefaultMetadataDbPort’ declared ‘constexpr’

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I've undone the suggested fixes

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

It's necessary to resolve the following compile error

Gotcha, my mistake.

I've undone the suggested fixes

Why undo the brace init?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

right my bad. updated just now

Comment thread components/core/src/glt/GlobalMetadataDBConfig.hpp Outdated
@Bill-hbrhbr Bill-hbrhbr changed the title refactor(core): Clang-tidy GlobalMetadataDBConfig.hpp in clp and glt to resolve compilation issues. fix(core): Resolve clang-tidy violations and compilation errors in GlobalMetadataConfig.hpp (fixes #643). Mar 15, 2025
Co-authored-by: kirkrodrigues <2454684+kirkrodrigues@users.noreply.github.com>
@Bill-hbrhbr Bill-hbrhbr changed the title fix(core): Resolve clang-tidy violations and compilation errors in GlobalMetadataConfig.hpp (fixes #643). fix(core): Resolve clang-tidy violations and compilation errors in GlobalMetadataConfig.hpp (fixes #643). Mar 15, 2025
@kirkrodrigues kirkrodrigues changed the title fix(core): Resolve clang-tidy violations and compilation errors in GlobalMetadataConfig.hpp (fixes #643). fix(core): Resolve clang-tidy violations and compilation errors in GlobalMetadataDBConfig.hpp (fixes #643). Mar 15, 2025
@Bill-hbrhbr Bill-hbrhbr merged commit e2ef004 into y-scope:main Mar 15, 2025
@Bill-hbrhbr Bill-hbrhbr deleted the clang-tidy-GlobalMetadataDBConfig branch March 15, 2025 17:47
junhaoliao pushed a commit to junhaoliao/clp that referenced this pull request May 17, 2026
…lobalMetadataDBConfig.hpp` (fixes y-scope#643). (y-scope#770)

Co-authored-by: kirkrodrigues <2454684+kirkrodrigues@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

GlobalMetadataDBConfig.hpp fails to compile with GCC 13.

2 participants