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

better guards for compile command logging #112

Merged
merged 1 commit into from
Feb 20, 2025
Merged

better guards for compile command logging #112

merged 1 commit into from
Feb 20, 2025

Conversation

PhilipDeegan
Copy link
Owner

@PhilipDeegan PhilipDeegan commented Feb 20, 2025

Summary by CodeRabbit

  • Chores
    • Updated an internal configuration setting to reflect a new date value.
  • Refactor
    • Enhanced logging and cleanup processes so that resource allocation and directory management now occur only when a specific option is enabled, reducing unnecessary system activity.

Copy link

coderabbitai bot commented Feb 20, 2025

Walkthrough

This pull request updates the configuration date in mkn.yaml from "19-FEB-2025" to "20-FEB-2025" and refines logging management in the build modules. In several source files, the instantiation and deletion of logging directories are now guarded by a conditional check on AppVars::INSTANCE().dump(). This change ensures that log directory objects are created and cleaned up only when the dump option is enabled, streamlining resource usage without altering external behaviors.

Changes

File(s) Change Summary
mkn.yaml Updated the DATE property from "19-FEB-2025" to "20-FEB-2025".
src/maiken/build/... Modified control flow in build.cpp, bin.cpp, and obj.cpp to instantiate and clean up log directories (and delete empty directories) only when AppVars::INSTANCE().dump() is true.

Sequence Diagram(s)

sequenceDiagram
    participant App as Application/Executioner
    participant Vars as AppVars::INSTANCE()
    participant Log as Log Manager

    App->>Vars: Check dump() condition
    alt dump() is true
        App->>Log: Instantiate log directories (cmd, out, err)
        App->>Log: Call mk() to create directories
        App->>Log: Execute deletion of empty directories (delEmpty)
    else dump() is false
        App-->>Log: Skip log directory operations
    end
Loading

Possibly related PRs

Poem

I'm a coding rabbit, hopping with delight,
A tweak in the date and logs set just right,
Conditional hops keep the code so neat,
Skipping unnecessary work with every beat,
I nibble on bugs, crunching code with flair,
Carrots and code, a perfect pair!
Happy to jump through these changes in the digital air!


📜 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 1e1a296 and c933b9d.

📒 Files selected for processing (4)
  • mkn.yaml (1 hunks)
  • src/maiken/build.cpp (1 hunks)
  • src/maiken/build/bin.cpp (1 hunks)
  • src/maiken/build/obj.cpp (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (4)
  • mkn.yaml
  • src/maiken/build/bin.cpp
  • src/maiken/build/obj.cpp
  • src/maiken/build.cpp
⏰ Context from checks skipped due to timeout of 90000ms (7)
  • GitHub Check: build (macos-latest)
  • GitHub Check: build (macos-14)
  • GitHub Check: build
  • GitHub Check: Python 3.12
  • GitHub Check: build
  • GitHub Check: Python 3.11
  • GitHub Check: build

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.

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

🧹 Nitpick comments (1)
src/maiken/build/obj.cpp (1)

196-213: Consider keeping directory declarations consistent with bin.cpp.

While the changes improve directory handling by moving creation inside the dump condition, the approach differs from bin.cpp:

  • Here: Directories are declared outside and created inside the dump condition
  • In bin.cpp: Both declaration and creation are inside the dump condition

Also, the 1 argument for parent directory creation is missing here but present in bin.cpp.

Consider applying this diff to maintain consistency:

-mkn::kul::Dir cmdLogDir(".mkn/log/" + buildDir().name() + "/obj/cmd");
-mkn::kul::Dir outLogDir(".mkn/log/" + buildDir().name() + "/obj/out");
-mkn::kul::Dir errLogDir(".mkn/log/" + buildDir().name() + "/obj/err");

 if (AppVars::INSTANCE().dump()) {
-  cmdLogDir.mk();
-  outLogDir.mk();
-  errLogDir.mk();
+  mkn::kul::Dir cmdLogDir(".mkn/log/" + buildDir().name() + "/obj/cmd", 1);
+  mkn::kul::Dir outLogDir(".mkn/log/" + buildDir().name() + "/obj/out", 1);
+  mkn::kul::Dir errLogDir(".mkn/log/" + buildDir().name() + "/obj/err", 1);
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 72a6dc3 and 1e1a296.

📒 Files selected for processing (4)
  • mkn.yaml (1 hunks)
  • src/maiken/build.cpp (1 hunks)
  • src/maiken/build/bin.cpp (1 hunks)
  • src/maiken/build/obj.cpp (3 hunks)
✅ Files skipped from review due to trivial changes (1)
  • mkn.yaml
⏰ Context from checks skipped due to timeout of 90000ms (7)
  • GitHub Check: build (macos-latest)
  • GitHub Check: Python 3.12
  • GitHub Check: build
  • GitHub Check: Python 3.11
  • GitHub Check: build (macos-14)
  • GitHub Check: build
  • GitHub Check: build
🔇 Additional comments (3)
src/maiken/build.cpp (1)

52-60: LGTM! Improved directory cleanup with proper guards.

The changes correctly guard the directory cleanup logic with AppVars::INSTANCE().dump() check, ensuring that cleanup only occurs when dumping is enabled. The lambda function provides a clean abstraction for the cleanup logic.

src/maiken/build/bin.cpp (1)

95-97: LGTM! Improved directory creation with proper guards.

The changes correctly move directory creation inside the AppVars::INSTANCE().dump() block, ensuring directories are only created when dumping is enabled. The use of 1 as the second argument ensures parent directories are created if needed.

src/maiken/build/obj.cpp (1)

244-252: LGTM! Clean directory cleanup implementation.

The directory cleanup logic is well-implemented:

  • Properly guarded by AppVars::INSTANCE().dump()
  • Uses a lambda function for cleanup, consistent with build.cpp
  • Correctly removes empty directories

@PhilipDeegan PhilipDeegan merged commit aea3964 into master Feb 20, 2025
8 checks passed
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.

1 participant