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

Itermediate layer data_init crash fix #627

Merged
merged 1 commit into from
Jan 20, 2025

Conversation

Zelberor
Copy link
Collaborator

@Zelberor Zelberor commented Jan 19, 2025

Description

Fixes a crash of the mapping_data_init node inside the publish_new_map function.
It happened when self.lidar_cluster_entities_data or self.self.radar_cluster_entities_data is None.

Fixes #626

Type of change

  • Bug fix (non-breaking change which fixes an issue)

Does this PR introduce a breaking change?

Nope

Most important changes

  • mapping_data_init.py

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works (might be obsolete with CI later on)
  • New and existing unit tests pass locally with my changes (might be obsolete with CI later on)

Summary by CodeRabbit

  • Bug Fixes
    • Improved handling of potential None values when processing LiDAR and radar cluster entity data
    • Enhanced robustness of data integration logic to prevent potential runtime errors

@Zelberor Zelberor added bug Something isn't working perception system System Engineering labels Jan 19, 2025
@Zelberor Zelberor added this to the Sprint 05 2025-01-27 milestone Jan 19, 2025
@Zelberor Zelberor linked an issue Jan 19, 2025 that may be closed by this pull request
Copy link
Contributor

coderabbitai bot commented Jan 19, 2025

Walkthrough

The pull request addresses a bug in the MappingDataIntegrationNode class within the mapping_data_integration.py file. The changes focus on improving the handling of lidar_cluster_entities_data and radar_cluster_entities_data attributes in the publish_new_map method. The modification introduces a more robust approach to handling None values, preventing potential crashes when these attributes are not yet initialized.

Changes

File Change Summary
code/mapping/src/mapping_data_integration.py Modified publish_new_map method to explicitly handle None values for lidar_cluster_entities_data and radar_cluster_entities_data

Assessment against linked issues

Objective Addressed Explanation
Prevent crash when cluster entities data is None [#626]

Possibly related PRs

Suggested reviewers

  • Ralf524

Poem

🐰 In the realm of mapping's dance,
Where data flows with rabbit's glance,
No more shall None bring fear or fright,
Our code now handles data's might!
A graceful fix, both swift and light 🌟

Finishing Touches

  • 📝 Generate Docstrings (Beta)

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.

@Zelberor Zelberor changed the title Crash fix Itermediate layer data_init crash fix Jan 19, 2025
Copy link
Contributor

@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)
code/mapping/src/mapping_data_integration.py (1)

269-276: Consider adding debug logs for missing data.

While the None handling is correct, adding debug logs when cluster data is missing would help with monitoring and debugging:

         lidar_cluster_entities = (
             []
-            if self.lidar_cluster_entities_data is None
+            if self.lidar_cluster_entities_data is None and not rospy.logdebug_throttle(1, "Lidar cluster entities data is None")
             else Map.from_ros_msg(self.lidar_cluster_entities_data).entities
         )
         radar_cluster_entities = (
             []
-            if self.radar_cluster_entities_data is None
+            if self.radar_cluster_entities_data is None and not rospy.logdebug_throttle(1, "Radar cluster entities data is None")
             else Map.from_ros_msg(self.radar_cluster_entities_data).entities
         )

The logdebug_throttle will limit logging to once per second to avoid spam while still providing visibility into missing data.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f633c20 and ab7d55b.

📒 Files selected for processing (1)
  • code/mapping/src/mapping_data_integration.py (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Build and push image
🔇 Additional comments (2)
code/mapping/src/mapping_data_integration.py (2)

269-271: LGTM! Clean fix for handling None lidar cluster entities.

The implementation effectively prevents crashes by returning an empty list when lidar_cluster_entities_data is None, while maintaining the existing behavior for valid data.


274-276: LGTM! Clean fix for handling None radar cluster entities.

The implementation effectively prevents crashes by returning an empty list when radar_cluster_entities_data is None, while maintaining the existing behavior for valid data.

@Zelberor Zelberor requested review from michalal7 and Ralf524 January 19, 2025 19:21
@Zelberor Zelberor merged commit 6187137 into main Jan 20, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working perception system System Engineering
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

[Bug]: Itermediate layer data_init crash
2 participants