Skip to content

Improve assembly dump #178

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

Merged
merged 1 commit into from
Feb 21, 2025
Merged

Conversation

josesimoes
Copy link
Member

@josesimoes josesimoes commented Feb 21, 2025

Description

  • Output of locals, calls, strings, files and types now includes full names.
  • Update and improve unit tests as needed.
  • Minor code style and fixes.

Motivation and Context

  • Needed clearer output. Metadata tokens only is not human readable.

How Has This Been Tested?

  • Compiling included test apps locally.

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)
  • Dependencies (update dependencies and changes associated, has no impact on code or features)
  • Unit Tests (add new Unit Test(s) or improved existing one(s), 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).
  • I have added new tests to cover my changes.

Summary by CodeRabbit

  • Chores
    • Enhanced the automated build pipeline to conditionally manage test artifacts for improved reliability during deployments.
    • Introduced additional checks to ensure only available test outcome files are processed, streamlining the release pipeline.

@nfbot nfbot added the Type: enhancement New feature or request label Feb 21, 2025
Copy link

coderabbitai bot commented Feb 21, 2025

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (7)
  • MetadataProcessor.Shared/Extensions/TypeReferenceExtensions.cs is excluded by none and included by none
  • MetadataProcessor.Shared/nanoDumperGenerator.cs is excluded by none and included by none
  • MetadataProcessor.Tests/Core/ClrIntegrationTests.cs is excluded by none and included by none
  • MetadataProcessor.Tests/Core/Extensions/TypeReferenceExtensionsTests.cs is excluded by none and included by none
  • MetadataProcessor.Tests/Core/Utility/DumperTests.cs is excluded by none and included by none
  • MetadataProcessor.Tests/MdpNFTestApp/MdpNFTestApp.sln is excluded by none and included by none
  • MetadataProcessor.Tests/TestNFApp/Program.cs is excluded by none and included by none

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The change introduces a new task sequence in the Azure Pipelines YAML file. It adds tasks that first copy Visual Studio test dump files from a temporary location to the artifact staging directory. A PowerShell script then checks for the existence of these files and sets a variable accordingly. Finally, a publishing task conditionally runs based on whether dump files are present. This adds conditional control flow to the pipeline, ensuring dump files are only published when available.

Changes

File Change Summary
azure-pipelines.yml Added a CopyFiles@2 task to copy dump files from D:\a\_temp\ to $(Build.ArtifactStagingDirectory)/vstest_dumps, a PowerShell script to check for files existence and set a variable, and a PublishPipelineArtifact@1 task that conditionally publishes dump files if they exist.

Sequence Diagram(s)

sequenceDiagram
    participant Pipeline as Pipeline
    participant Copy as CopyFiles@2
    participant PS as PowerShell Script
    participant Pub as PublishPipelineArtifact@1

    Pipeline->>Copy: Execute file copy (from D:\a\_temp\ to $(Build.ArtifactStagingDirectory)/vstest_dumps)
    Copy->>PS: Trigger PowerShell script (on succeededOrFailed())
    PS->>PS: Inspect directory for dump files and set "hasFiles"
    alt Dump files found
        PS->>Pub: Initiate artifact publish
    else No dump files
        PS-->>Pub: Skip artifact publish
    end
Loading

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.

@josesimoes josesimoes force-pushed the improve-assembly-dump branch from 9abd79a to d261f5e Compare February 21, 2025 14:25
@josesimoes josesimoes force-pushed the improve-assembly-dump branch 5 times, most recently from 61dcd98 to bef2c78 Compare February 21, 2025 16:35
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 (2)
azure-pipelines.yml (2)

219-227: Clarify Task Configuration for VSTest Dump File Copy.
The new CopyFiles@2 task is configured to copy Visual Studio test dump files from a hard-coded temporary folder (D:\a\_temp\). Please verify that this path is consistent across all build agents and environments. Consider parameterizing the source folder if the location might change in the future, and confirm that flattening the folder structure (via flattenFolders: true) meets your artifact organization requirements.


228-239: Normalize the Dump File Check Output.
In the PowerShell task that checks for dump files, the variable hasFiles is set as a boolean but is echoed directly. To ensure that the downstream condition (eq(variables['hasFiles'], 'true')) works correctly, it’s advisable to output a normalized lower-case string (for example, using $hasFiles.ToString().ToLower()). This will avoid potential mismatches between True/true or False/false.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8592c8c and bef2c78.

⛔ Files ignored due to path filters (7)
  • MetadataProcessor.Shared/Extensions/TypeReferenceExtensions.cs is excluded by none and included by none
  • MetadataProcessor.Shared/nanoDumperGenerator.cs is excluded by none and included by none
  • MetadataProcessor.Tests/Core/ClrIntegrationTests.cs is excluded by none and included by none
  • MetadataProcessor.Tests/Core/Extensions/TypeReferenceExtensionsTests.cs is excluded by none and included by none
  • MetadataProcessor.Tests/Core/Utility/DumperTests.cs is excluded by none and included by none
  • MetadataProcessor.Tests/MdpNFTestApp/MdpNFTestApp.sln is excluded by none and included by none
  • MetadataProcessor.Tests/TestNFApp/Program.cs is excluded by none and included by none
📒 Files selected for processing (1)
  • azure-pipelines.yml (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: nanoframework.metadata-processor (Build_MDP)
  • GitHub Check: nanoframework.metadata-processor (Get_Build_Flags)
🔇 Additional comments (1)
azure-pipelines.yml (1)

240-247: Validate the Artifact Publishing Condition and Inputs.
The PublishPipelineArtifact@1 task uses the condition eq(variables['hasFiles'], 'true') to determine whether to publish dump files. Please ensure that the output from the previous PowerShell task matches this expected lower-case string. Additionally, verify that the target path aligns with the output from the file copy task and that publishing under the artifact name VsTestCrashDumps is intentional.

- Output of locals, calls, strings, files and types now includes full names.
- Update and improve unit tests as needed.
- Replace Debug.Writeline with Console for NF test app.
- Minor code style and fixes.
@josesimoes josesimoes force-pushed the improve-assembly-dump branch from bef2c78 to 0cc2ae9 Compare February 21, 2025 16:46
@josesimoes josesimoes merged commit 4df9a34 into nanoframework:main Feb 21, 2025
5 checks passed
@josesimoes josesimoes deleted the improve-assembly-dump branch February 21, 2025 16:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants