Internally manage trackLocationId

paodb commented 1 month ago

This PR closes issue #133. Location tracking id is now handled internally. trackLocation method was changed to update the internal value and to throw an exception in case an attemp to start a second tracking is done. stopTrackLocation method was also updated to stop the tracking using the internal value and to clear this value when the tracking session is stopped. Demo view was updated to reflect these changes too.

As this refactor is a breaking change a version update is also included. And Vaadin version was also updated to the latest Vaadin 14 version.

Summary by CodeRabbit

New Features
- Enhanced location tracking management with session control in Google Maps integration.
- Added ability to retrieve active location tracking session ID.
Improvements
- Updated artifact versions for google-maps and Vaadin to ensure better compatibility and performance.
Refactor
- Refactored location tracking demo to improve button arrangement and handling of tracking sessions.

coderabbitai[bot] commented 1 month ago

Walkthrough

The recent updates primarily focus on upgrading dependencies and enhancing the location tracking functionality in the GoogleMap class. The pom.xml file sees version upgrades for the google-maps and Vaadin artifacts. The GoogleMap class introduces a new field and methods to manage location tracking sessions more effectively. Corresponding changes in the TrackLocationDemo class improve the UI and handling of location tracking notifications.

Changes

File Path	Change Summary
`pom.xml`	Updated `google-maps` version to `2.0.0-SNAPSHOT` and Vaadin version to `14.11.11`.
`.../googlemaps/GoogleMap.java`	Added `trackLocationId` field, `getTrackLocationId()` method, and modified `trackLocation()` and `stopTrackLocation()` methods.
`.../googlemaps/TrackLocationDemo.java`	Removed `trackLocationId` field, added `HorizontalLayout` import, and modified button handling and notifications.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant TrackLocationDemo
    participant GoogleMap

    User ->> TrackLocationDemo: Click "Start Tracking"
    TrackLocationDemo ->> GoogleMap: trackLocation()
    GoogleMap ->> GoogleMap: Check if tracking session is active
    GoogleMap -->> TrackLocationDemo: Start new tracking session
    TrackLocationDemo -->> User: Notify tracking started

    User ->> TrackLocationDemo: Click "Stop Tracking"
    TrackLocationDemo ->> GoogleMap: stopTrackLocation()
    GoogleMap ->> GoogleMap: Stop current tracking session
    GoogleMap -->> TrackLocationDemo: Confirm tracking stopped
    TrackLocationDemo -->> User: Notify tracking stopped

Poem

In lines of code, we weave a tale,
Of maps and tracks, where features sail.
With buttons bright and sessions clear,
New versions bring the future near.
A rabbit's cheer for changes made,
In software's dance, improvements laid.
🌟🚀

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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. 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. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.