fix(task): show boost download progress during compilation (fixes #56). #57

Henry8192 · 2025-02-04T08:58:07Z

Description

Add set(FETCHCONTENT_QUIET OFF) when fetching boost, which shows download progress. set(FETCHCONTENT_QUIET ON) after download is finished so that no more verbose logs are outputed to the console.

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

Run task clean.
Run task, notice the new boost download progress logs are printed:

-- Fetching Boost.
-- Populating boost
-- Configuring done (0.0s)
-- Generating done (0.0s)
-- Build files have been written to: /home/deck/CLionProjects/clp-ffi-js/build/clp-ffi-js/_deps/boost-subbuild
[ 11%] Creating directories for 'boost-populate'
[ 22%] Performing download step (download, verify and extract) for 'boost-populate'
-- Downloading...
   dst='/home/deck/CLionProjects/clp-ffi-js/build/clp-ffi-js/_deps/boost-subbuild/boost-populate-prefix/src/boost_1_85_0.tar.gz'
   timeout='none'
   inactivity timeout='none'
-- Using src='https://archives.boost.io/release/1.85.0/source/boost_1_85_0.tar.gz'
-- [download 0% complete]
-- [download 1% complete]
-- [download 2% complete]
...
-- [download 99% complete]
-- [download 100% complete]
...
Boost sources successfully fetched into /home/deck/CLionProjects/clp-ffi-js/build/clp-ffi-js/_deps/boost-src

Summary by CodeRabbit

Chore
- Enhanced the build process to provide additional logging during dependency retrieval, improving monitoring without altering end-user functionality.

coderabbitai · 2025-02-04T08:58:16Z

Walkthrough

The pull request adds two commands in the CMakeLists.txt file to control the verbosity of the Boost download process. It enables verbose output by setting FETCHCONTENT_QUIET to OFF before calling FetchContent_MakeAvailable(Boost) and then reverts to quiet mode immediately afterward. No changes have been made to the declarations of public entities.

Changes

File	Change Summary
`CMakeLists.txt`	Added commands to temporarily disable quiet mode (`FETCHCONTENT_QUIET OFF`) before fetching Boost and then re-enabled quiet mode (`FETCHCONTENT_QUIET ON`) afterwards.

Sequence Diagram(s)

sequenceDiagram
    participant CMake as "CMake Process"
    participant Lists as "CMakeLists.txt"
    participant Boost as "Boost Download"
    
    CMake->>Lists: Parse file
    Lists->>CMake: Execute `set(FETCHCONTENT_QUIET OFF)`
    CMake->>Boost: Call `FetchContent_MakeAvailable(Boost)`
    Boost-->>CMake: Provide download feedback
    CMake->>Lists: Execute `set(FETCHCONTENT_QUIET ON)`

Suggested reviewers

junhaoliao
kirkrodrigues

Tip

🌐 Web search-backed reviews and chat

We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
You can disable this feature by setting web_search: false in the knowledge_base settings.
Please share any feedback in the Discord discussion.

📜 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 b4a6791 and a52e896.

📒 Files selected for processing (1)

CMakeLists.txt (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (2)

GitHub Check: lint (ubuntu-latest)
GitHub Check: lint (macos-latest)

🔇 Additional comments (1)

CMakeLists.txt (1)

75-78: Enhancement: Temporary Verbose Mode with a Consideration for Exception Safety
The changes correctly enable verbose output for the Boost download process by toggling FETCHCONTENT_QUIET off before fetching and then back on afterwards. This directly addresses the PR objective to display the Boost download progress.
One potential improvement to consider is how the state is restored if an error occurs during FetchContent_MakeAvailable(Boost). If the fetch fails or triggers an early exit, FETCHCONTENT_QUIET might remain off, which could lead to unexpectedly verbose outputs later in the configuration.
It may be worthwhile to encapsulate this behaviour in a macro or helper function to ensure the quiet state is always restored, regardless of the outcome of the fetch operation.

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 generate docstrings to generate docstrings for this PR. (Beta)
@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.

kirkrodrigues · 2025-02-11T21:09:10Z

CMakeLists.txt

@@ -72,7 +72,10 @@ boost_${CLP_FFI_JS_BOOST_ARCHIVE_VERSION_PART}.tar.gz"
    URL_MD5 "53aeccc3167909ee770e34469f8dd592"
 )
 message(STATUS "Fetching Boost.")
+# Temporarily enable verbose output for boost download progress
+set(FETCHCONTENT_QUIET OFF)


Since someone who's having download issues would need this for any library we download using FetchContent, I feel like we should just disable FETCHCONTENT_QUIET entirely rather than only for Boost.

Shall we place the line somewhere near Line 5 then?

Yeah, perhaps just after include(FetchContent).

show boost download progress

a52e896

Henry8192 requested review from kirkrodrigues and junhaoliao February 4, 2025 08:59

kirkrodrigues reviewed Feb 11, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(task): show boost download progress during compilation (fixes #56). #57

fix(task): show boost download progress during compilation (fixes #56). #57

Henry8192 commented Feb 4, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Feb 4, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

kirkrodrigues Feb 11, 2025

junhaoliao Feb 12, 2025

kirkrodrigues Feb 14, 2025

fix(task): show boost download progress during compilation (fixes #56). #57

Are you sure you want to change the base?

fix(task): show boost download progress during compilation (fixes #56). #57

Conversation

Henry8192 commented Feb 4, 2025 • edited by coderabbitai bot Loading

Description

Checklist

Validation performed

Summary by CodeRabbit

coderabbitai bot commented Feb 4, 2025 • edited Loading

Walkthrough

Changes

Sequence Diagram(s)

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

kirkrodrigues Feb 11, 2025

Choose a reason for hiding this comment

junhaoliao Feb 12, 2025

Choose a reason for hiding this comment

kirkrodrigues Feb 14, 2025

Choose a reason for hiding this comment

Henry8192 commented Feb 4, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Feb 4, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)