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

Fix install of IDF components #3034

Merged
merged 1 commit into from
Nov 6, 2024

Conversation

josesimoes
Copy link
Member

@josesimoes josesimoes commented Nov 6, 2024

Description

  • Migrate component guids.
  • Fix extract path.
  • Fix URL of component manager download API.

Motivation and Context

  • Fixed several breaking changes in Espressif ESP Component Registry.

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
    • Improved component installation process with updated URLs and identifiers for better accuracy.
  • Bug Fixes
    • Corrected the endpoint for downloading components to ensure successful retrieval.
  • Documentation
    • Enhanced comments for clarity regarding the installation and configuration of components.

- Migrate component guids.
- Fix extract path.
- Fix URL of component manager download API.
@josesimoes josesimoes added the Platform: ESP32 Everything related specifically with ESP32 platform label Nov 6, 2024
Copy link

coderabbitai bot commented Nov 6, 2024

Walkthrough

The pull request introduces modifications to the CMake/binutils.ESP32.cmake file, focusing on the installation and configuration of components from the component registry. Key changes include an updated URL for component downloads, adjustments to extraction paths, and updated identifiers for specific components. Additionally, function signatures related to component installation have been modified, although the parameters remain unchanged. Comments in the code have been retained to provide context for these updates.

Changes

File Change Summary
CMake/binutils.ESP32.cmake - Updated download URL for components.
- Changed extraction path from ${destinationPath} to ${extractPath}.
- Updated component identifiers for tinyusb, esp_tinyusb, and littlefs.
- Modified function signatures for nf_install_idf_component_from_registry and nf_add_idf_as_library (internal logic changed, parameters unchanged).

Possibly related PRs

  • Fix ESP IDF path to fix Dev Container #2999: The changes in this PR involve updating paths related to the ESP32 build process, which may be relevant to the modifications in the main PR that also focus on component installation and path adjustments in the CMake configuration.

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 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

🧹 Outside diff range and nitpick comments (1)
CMake/binutils.ESP32.cmake (1)

Line range hint 574-586: Consider adding hash verification for downloaded components.

While the implementation correctly handles the download and extraction of components, consider adding hash verification for the downloaded archives to ensure integrity and prevent potential security issues.

Example approach:

 if(NOT EXISTS ${destinationPath})
     file(DOWNLOAD ${downloadUrl} ${archiveName})
+    
+    # Verify archive hash
+    file(SHA256 ${archiveName} DOWNLOADED_HASH)
+    if(NOT DOWNLOADED_HASH STREQUAL EXPECTED_HASH)
+        message(FATAL_ERROR "Hash mismatch for ${component_name} archive")
+    endif()
+    
     message(STATUS "Component archive '" ${component_name} "' downloaded")
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 0516bd1 and a77dc23.

📒 Files selected for processing (1)
  • CMake/binutils.ESP32.cmake (2 hunks)
🔇 Additional comments (3)
CMake/binutils.ESP32.cmake (3)

569-572: LGTM! Clear separation of download and extraction paths.

The path handling has been improved by clearly separating the download destination from the extraction path. This makes the code more maintainable and follows CMake best practices.


580-580: LGTM! Fixed extraction path.

The extraction path now correctly points to the IDF components directory, which aligns with the PR objective of fixing the extraction path.


597-598: LGTM! Updated component GUIDs.

The component GUIDs have been updated to the correct values from the Espressif ESP Component Registry:

  • tinyusb: 55142eec-a3a4-47a5-ad01-4ba3ef44444b
  • esp_tinyusb: 8115ffc9-366a-4340-94ab-e327aed20831
  • littlefs: 4831aa41-8b72-48ac-a534-910a985a5519

Also applies to: 601-601

@josesimoes josesimoes merged commit 017601a into nanoframework:main Nov 6, 2024
29 checks passed
@josesimoes josesimoes deleted the fix-idf-component-install branch November 6, 2024 11:41
@coderabbitai coderabbitai bot mentioned this pull request Nov 8, 2024
13 tasks
TerryFogg pushed a commit to TerryFogg/nf-interpreter that referenced this pull request Dec 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Config-and-Build Platform: ESP32 Everything related specifically with ESP32 platform
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants