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

Update orbit builds, eclipse plugins, jna plugins etc #1111

Merged
merged 1 commit into from
Jan 11, 2025

Conversation

kolipakakondal
Copy link
Collaborator

@kolipakakondal kolipakakondal commented Jan 11, 2025

Description

Please include a summary of the change and which issue is fixed.

Fixes # (IEP-XXX)

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How has this been tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • Test A
  • Test B

Test Configuration:

  • ESP-IDF Version:
  • OS (Windows,Linux and macOS):

Dependent components impacted by this PR:

  • Component 1
  • Component 2

Checklist

  • PR Self Reviewed
  • Applied Code formatting
  • Added Documentation
  • Added Unit Test
  • Verified on all platforms - Windows,Linux and macOS

Summary by CodeRabbit

  • Dependency Updates

    • Updated Eclipse repository locations from version 4.32 to 4.33
    • Updated release repositories from 2024-06 to 2024-09
    • Updated Orbit, EGit, LSP4E, and TM4E repository references
  • Dependency Cleanup

    • Removed several testing, logging, and XML-related dependencies
    • Reset versions of multiple units to 0.0.0
    • Added new Apache Batik and LSP4J related units
  • Bundle Removals

    • Removed Mylyn WikiText and Jsoup bundles from the update configuration

Copy link

coderabbitai bot commented Jan 11, 2025

Walkthrough

This pull request involves significant updates to the Eclipse plugin configuration for the Espressif IDF target. The changes primarily focus on updating repository locations from older versions (4.32, 2024-06) to newer versions (4.33, 2024-09). Multiple units and bundles have been removed, including testing frameworks, logging libraries, and XML-related dependencies. New units like Apache Batik and LSP4J have been added, and many unit versions have been reset to 0.0.0. The modifications suggest a comprehensive restructuring of the plugin's dependency management.

Changes

File Change Summary
releng/com.espressif.idf.target/com.espressif.idf.target.target - Updated repository locations from 4.32 to 4.33 and 2024-06 to 2024-09
- Removed multiple units: XML, testing, and logging dependencies
- Added Apache Batik and LSP4J related units
- Reset many unit versions to 0.0.0
releng/com.espressif.idf.update/category.xml - Removed bundles: org.eclipse.mylyn.wikitext, org.eclipse.mylyn.wikitext.markdown, org.jsoup

Possibly related PRs

Suggested reviewers

  • AndreiFilippov
  • sigmaaa

Poem

🐰 Dependency dance, a rabbit's delight,
Versions reset, repositories take flight
Batik and LSP4J now join the scene
Old units vanish, configuration clean
Eclipse plugin evolves with each byte! 🔧


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

🧹 Nitpick comments (1)
releng/com.espressif.idf.target/com.espressif.idf.target.target (1)

41-42: Review version management strategy

Using version "0.0.0" for multiple dependencies (JNA, TM4E, etc.) can lead to build reproducibility issues.

Consider:

  1. Using specific versions for critical dependencies
  2. Documenting the version resolution strategy
  3. Implementing a version catalog or BOM (Bill of Materials) to manage versions centrally

For example:

-			<unit id="com.sun.jna" version="0.0.0"/>
+			<unit id="com.sun.jna" version="5.13.0"/>

Also applies to: 92-93

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between fc3ab91 and e8b3353.

📒 Files selected for processing (2)
  • releng/com.espressif.idf.target/com.espressif.idf.target.target (5 hunks)
  • releng/com.espressif.idf.update/category.xml (0 hunks)
💤 Files with no reviewable changes (1)
  • releng/com.espressif.idf.update/category.xml
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: build_macos
  • GitHub Check: build
🔇 Additional comments (2)
releng/com.espressif.idf.target/com.espressif.idf.target.target (2)

43-46: Clarify the requirement for Apache Batik dependencies

The addition of Apache Batik components suggests new SVG-related functionality. Please clarify:

  1. The specific use case requiring SVG support
  2. Which parts of the plugin will use these components

Consider:

  • If SVG support is only needed for specific features, consider moving these dependencies to a separate feature to reduce the core plugin's footprint
  • Document any SVG-related APIs that will be exposed to other plugins

6-6: Verify compatibility with Eclipse platform updates

The updates to Eclipse 4.33 and 2024-09 release are significant platform changes that could impact plugin functionality.

Please ensure:

  1. All UI components work correctly with Eclipse 4.33
  2. No regressions in CDT integration
  3. Plugin activation and extension points are compatible

Run this verification script:

Also applies to: 22-22

✅ Verification successful

Eclipse 4.33 compatibility update appears safe to proceed

The codebase shows minimal risk for the Eclipse 4.33 platform update:

  • Limited deprecated API usage (only 4 instances)
  • Uses stable, standard Eclipse extension points
  • Relies on core Eclipse APIs that maintain backward compatibility
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for potential compatibility issues with Eclipse 4.33
# Look for deprecated API usage and extension point changes

# Search for deprecated API usage
rg -l "org\.eclipse\.(ui|core|equinox)" | xargs ast-grep --pattern 'Deprecated|@deprecated'

# Check extension point usage
rg -A 5 "extension\s+point=\"org\.eclipse" plugin.xml

Length of output: 199


Script:

#!/bin/bash
# First, let's find all plugin.xml files and Java source files
echo "=== Plugin manifests ==="
fd -g "plugin.xml"

echo -e "\n=== Checking Java files for deprecated API usage ==="
fd -e java | xargs ast-grep --pattern '@Deprecated'

echo -e "\n=== Checking extension point declarations ==="
fd -g "plugin.xml" -x rg -A 5 'extension\s+point="org\.eclipse'

echo -e "\n=== Checking imports of Eclipse packages ==="
fd -e java | xargs rg "import\s+org\.eclipse\.(ui|core|equinox)"

Length of output: 69209

Comment on lines +84 to +88
<repository location="https://download.eclipse.org/lsp4e/snapshots/"/>
<unit id="org.eclipse.lsp4j" version="0.0.0"/>
<unit id="org.eclipse.lsp4j.debug" version="0.0.0"/>
<unit id="org.eclipse.lsp4j.jsonrpc" version="0.0.0"/>
<unit id="org.eclipse.lsp4j.jsonrpc.debug" version="0.0.0"/>
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Reconsider using LSP4E snapshot dependencies

Using snapshot versions (download.eclipse.org/lsp4e/snapshots/) in a production environment can lead to instability and unpredictable behavior.

Consider:

  1. Using a stable release version instead of snapshots
  2. If snapshots are necessary, document the specific features requiring them
  3. Implement version monitoring to track breaking changes in snapshots
-			<repository location="https://download.eclipse.org/lsp4e/snapshots/"/>
+			<repository location="https://download.eclipse.org/lsp4e/releases/latest/"/>
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
<repository location="https://download.eclipse.org/lsp4e/snapshots/"/>
<unit id="org.eclipse.lsp4j" version="0.0.0"/>
<unit id="org.eclipse.lsp4j.debug" version="0.0.0"/>
<unit id="org.eclipse.lsp4j.jsonrpc" version="0.0.0"/>
<unit id="org.eclipse.lsp4j.jsonrpc.debug" version="0.0.0"/>
<repository location="https://download.eclipse.org/lsp4e/releases/latest/"/>
<unit id="org.eclipse.lsp4j" version="0.0.0"/>
<unit id="org.eclipse.lsp4j.debug" version="0.0.0"/>
<unit id="org.eclipse.lsp4j.jsonrpc" version="0.0.0"/>
<unit id="org.eclipse.lsp4j.jsonrpc.debug" version="0.0.0"/>

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.

4 participants