Bugfix/reload stability

[maerki]

Summary by CodeRabbit

• New Features

  • Enhanced map loading synchronization with additional thread safety measures.

• Bug Fixes

  • Improved reliability of vector layer updates and collision state handling.

[coderabbitai]

Walkthrough

The updates to the Tiled2dMapVectorLayer involve adding synchronization mechanisms, such as a mutex, condition variable, and a readiness flag, to manage setup and updates more effectively. There's enhanced checking for the mapInterface and improvements to the handling of tile updates and collision states, ensuring thread safety and data integrity during map interactions.

Changes

Files	Change Summary
shared/public/Tiled2dMapVectorLayer.h	Added std::mutex, std::condition_variable, and bool flag for setup synchronization.
shared/.../Tiled2dMapVectorLayer.cpp	Implemented synchronization in initializeVectorLayer, added checks and conditions in various functions for thread safety and data integrity.
shared/.../symbol/Tiled2dMapVectorSourceSymbolDataManager.cpp	Added calls to invalidateCollisionState for better collision state management.

Poem

In the realm of code, where layers intertwine,
A rabbit hops through, making threads align.
Mutex locks and conditions set just right,
Ensuring the map's data shines ever bright. 🌟🐇

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

• X
• Mastodon
• Reddit
• LinkedIn

---

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>.
  • Generate unit-tests for this file.
• 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 tests 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 generate interesting stats about this repository from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 88d6458 and 3601619.

Files selected for processing (3)

• shared/public/Tiled2dMapVectorLayer.h (1 hunks)
• shared/src/map/layers/tiled/vector/Tiled2dMapVectorLayer.cpp (8 hunks)
• shared/src/map/layers/tiled/vector/symbol/Tiled2dMapVectorSourceSymbolDataManager.cpp (2 hunks)

Additional comments: 11

shared/public/Tiled2dMapVectorLayer.h (1)

• 285-287: The addition of synchronization primitives std::mutex setupMutex, std::condition_variable setupCV, and the boolean flag setupReady to the Tiled2dMapVectorLayer class is a good practice to ensure thread safety during the initialization process. However, ensure that these are used correctly in the implementation to prevent deadlocks or race conditions.

shared/src/map/layers/tiled/vector/symbol/Tiled2dMapVectorSourceSymbolDataManager.cpp (2)

• 442-442: The call to invalidateCollisionState within the onVectorTilesUpdated function is appropriate to ensure that the collision state is invalidated when the vector tiles are updated. This aligns with the PR objectives to manage collision state more effectively.
• 588-588: The call to invalidateCollisionState within the updateSymbolGroups function is consistent with the changes made in the onVectorTilesUpdated function and serves the same purpose of ensuring the collision state is invalidated when symbol groups are updated.

shared/src/map/layers/tiled/vector/Tiled2dMapVectorLayer.cpp (8)

• 476-481: The addition of a mutex lock and condition variable notification is a good practice for thread synchronization. However, ensure that all other methods that depend on setupReady being true are also properly synchronized to prevent race conditions.
• 501-504: Returning early if mapInterface is not available is a good defensive programming practice.
• 525-525: Clearing prevCollisionStillValid without any conditional checks might be risky if there are scenarios where this flag should be preserved. Verify that this behavior is intended and correct.
• 558-558: The change in the condition for updating the data manager from timeDiff > 2000 to timeDiff > 1000 seems to make the update more frequent. Ensure this change does not introduce performance issues due to more frequent updates.
• 573-573: The reduction of the collision check interval from 3000 to 1000 milliseconds will make collision checks more frequent. Confirm that this change is in line with the desired behavior and does not negatively impact performance.
• 769-771: The use of a mutex lock and condition variable wait is correct for synchronization. However, ensure that the setupReady flag is always set to true before this method is called to avoid deadlocks.
• 781-783: Similar to the previous comment, the synchronization mechanism is appropriate. Confirm that there are no scenarios where setupReady could be false indefinitely, leading to a deadlock.
• 1258-1261: Clearing tilesStillValid and invalidating the map interface when mapInterface is available is a good practice to ensure the state is consistent. However, ensure that this method is called in the correct context to avoid unnecessary invalidations.