Improvements in profiler host processors #3114

josesimoes · 2025-02-19T17:11:53Z

Description

Fix implementation of disposable pattern.
Now on dispose the file paths are output.
Message processor now flushes the file to ensure that message is written immediately.
Add missing set of clean-up steps in nanoCLR host.

Motivation and Context

Improvements suggested from code analysis.
Need to see the path of the profiler files following a run. As they are output at the beginning of the execution, upon a long run, they are not available in console anymore.
The clean-up steps weren't being executed.

How Has This Been Tested?

Screenshots

Types of changes

Improvement (non-breaking change that improves a feature, code or algorithm)
Bug fix (non-breaking change which fixes an issue with code or algorithm)
New feature (non-breaking change which adds functionality to code)
Breaking change (fix or feature that would cause existing functionality to change)
Config and build (change in the configuration and build system, has no impact on code or features)
Dev Containers (changes related with Dev Containers, has no impact on code or features)
Dependencies/declarations (update dependencies or assembly declarations and changes associated, has no impact on code or features)
Documentation (changes or updates in the documentation, has no impact on code or features)

Checklist

My code follows the code style of this project (only if there are changes in source code).
My changes require an update to the documentation (there are changes that require the docs website to be updated).
I have updated the documentation accordingly (the changes require an update on the docs in this repo).
I have read the CONTRIBUTING document.
I have tested everything locally and all new and existing tests passed (only if there are changes in source code).

Summary by CodeRabbit

New Features
- Enhanced the application shutdown process to ensure that cleanup operations are executed reliably.
- Updated logging output with a consistent, clear file format for improved traceability.
Refactor
- Streamlined resource management and disposal patterns for profiling components to boost overall reliability and clarity in error messages.

- Fix implementation of disposable pattern. - Now on dispose the file paths are output. - Message processor now flushes the file to ensure that message is written immediately. - Add missing set of clean-up steps in nanoCLR host.

coderabbitai · 2025-02-19T17:12:01Z

Walkthrough

This pull request updates multiple components in the nanoFramework.nanoCLR.Host project. In the NanoClrHostBuilder class, the Build method now appends configured cleanup steps to the nanoCLRHost instance. Both the ProfilerLogFileProcessor and ProfilerMessageProcessor classes have been updated to include new private fields for storing the log file path and tracking disposal status. Their constructors, error handling, and disposal patterns have been refactored to use a protected virtual Dispose(bool disposing) method, with the message processor also updating its logging behavior to flush data immediately.

Changes

File(s)	Change Summary
`targets/netcore/.../NanoClrHostBuilder.cs`	Updated the `Build()` method to append `_cleanupSteps` to the nanoCLRHost instance, ensuring cleanup operations are incorporated.
`targets/netcore/.../Profiler/ProfilerLogFileProcessor.cs` `targets/netcore/.../Profiler/ProfilerMessageProcessor.cs`	Added private fields `_logFilePath` and `_disposedValue`; updated constructors and error messages to utilize `_logFilePath`; refactored the public `Dispose()` method by introducing a protected virtual `Dispose(bool disposing)` method. The MessageProcessor additionally updates its `MessageHandler` to flush its log writer.

Sequence Diagram(s)

sequenceDiagram
    participant Builder as nanoCLRHostBuilder
    participant Host as nanoCLRHost instance
    Builder->>Host: Build()
    Note right of Host: Append configured _cleanupSteps
    Host-->>Builder: Return built nanoCLRHost

sequenceDiagram
    participant Client as Caller
    participant Processor as Profiler Processor
    Client->>Processor: Dispose()
    Processor->>Processor: Call Dispose(true)
    alt Conditional cleanup
        Processor->>Processor: Flush log writer (if applicable)
        Processor->>Processor: Dispose sub-resources
    end
    Processor-->>Client: Disposal complete

Possibly related PRs

Minor improvements in virtual device #2990: Modifies methods in the NanoClrHostBuilder class to improve configuration and cleanup, aligning with the changes in the Build process.
Add profiler to virtual device #3113: Introduces profiling and cleanup enhancements in the NanoClrHostBuilder class, relating to the updated cleanup step management in this PR.

Suggested labels

Area: Common libs

📜 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 2fa1092 and 6f8e439.

📒 Files selected for processing (3)

targets/netcore/nanoFramework.nanoCLR.Host/NanoClrHostBuilder.cs (1 hunks)
targets/netcore/nanoFramework.nanoCLR.Host/Profiler/ProfilerLogFileProcessor.cs (2 hunks)
targets/netcore/nanoFramework.nanoCLR.Host/Profiler/ProfilerMessageProcessor.cs (1 hunks)

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

GitHub Check: nf-interpreter (Check_Code_Style)
GitHub Check: nf-interpreter (Nightly build) (Check_Build_Options)
GitHub Check: nf-interpreter (Check_Build_Options)

🔇 Additional comments (7)

targets/netcore/nanoFramework.nanoCLR.Host/Profiler/ProfilerMessageProcessor.cs (3)

17-18: LGTM! Field declarations and constructor changes improve state management.

The addition of _logFilePath and _disposedValue fields, along with the constructor changes, properly implement state tracking for the disposable pattern. The file extension change to .txt is appropriate for text-based log files.

Also applies to: 23-26, 28-28

44-45: LGTM! Immediate message writing ensures data persistence.

Adding Flush() after writing ensures messages are immediately persisted to disk, which is crucial for logging reliability.

50-70: LGTM! Proper implementation of the disposable pattern.

The implementation follows best practices by:

Using a protected virtual Dispose(bool) method

Properly tracking disposal state

Outputting file path on dispose for visibility

Suppressing finalization
targets/netcore/nanoFramework.nanoCLR.Host/Profiler/ProfilerLogFileProcessor.cs (3)

16-17: LGTM! Consistent implementation with ProfilerMessageProcessor.

The field declarations and constructor changes mirror the improvements made in ProfilerMessageProcessor, maintaining consistency across the codebase.

Also applies to: 24-25, 27-27

41-47: Verify the implementation of MessageHandler.

The method decodes the profiler packet but doesn't appear to write or store it. This might be an oversight that could lead to data loss.

Consider writing the decoded packet to _profilerDumpWriter:
 internal void MessageHandler(byte[] data, int length)
 {
     BitStream stream = new BitStream(data, 0, length);
     Tools.NanoProfiler.Packets.ProfilerPacket pp = ProfilerPacketFactory.Decode(stream, null);
+    _profilerDumpWriter.WriteLine(pp.ToString());
+    _profilerDumpWriter.Flush();
 }
51-71: LGTM! Consistent dispose pattern implementation.

The dispose implementation follows the same best practices as ProfilerMessageProcessor, ensuring consistent resource cleanup across the codebase.
targets/netcore/nanoFramework.nanoCLR.Host/NanoClrHostBuilder.cs (1)

146-146: LGTM! Proper integration of cleanup steps.

The addition of cleanup steps to the nanoCLRHost ensures that resources are properly cleaned up when the host is disposed, completing the disposable pattern implementation across the codebase.

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.

***NO_CI*** (cherry picked from commit 4d74775)

Improvements in profiler host processors

6f8e439

- Fix implementation of disposable pattern. - Now on dispose the file paths are output. - Message processor now flushes the file to ensure that message is written immediately. - Add missing set of clean-up steps in nanoCLR host.

josesimoes added the Platform: Virtual Device & WIN32 Everything related specifically with WIN32 and .NET tool builds label Feb 19, 2025

nfbot added Type: bug Type: enhancement labels Feb 19, 2025

josesimoes merged commit 4d74775 into nanoframework:main Feb 19, 2025
10 checks passed

josesimoes deleted the improvements-in-host branch February 19, 2025 17:57

josesimoes added a commit that referenced this pull request Mar 17, 2025

Improvements in profiler host processors (#3114)

edf0a5f

***NO_CI*** (cherry picked from commit 4d74775)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Improvements in profiler host processors #3114

Improvements in profiler host processors #3114

Uh oh!

josesimoes commented Feb 19, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Feb 19, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Improvements in profiler host processors #3114

Improvements in profiler host processors #3114

Uh oh!

Conversation

josesimoes commented Feb 19, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Motivation and Context

How Has This Been Tested?

Screenshots

Types of changes

Checklist

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Feb 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Possibly related PRs

Suggested labels

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

josesimoes commented Feb 19, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Feb 19, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)