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 distance calculation for moving journey #165

Merged
merged 1 commit into from
Jan 22, 2025

Conversation

cp-sneh-s
Copy link
Collaborator

@cp-sneh-s cp-sneh-s commented Jan 17, 2025

Changelog

  • Fix distance calculation saving for moving journey

Bug Fixes

  • Instead of saving the last two routes distance, save the whole route's distance

Summary by CodeRabbit

  • Bug Fixes
    • Improved journey distance tracking accuracy by correctly accumulating total route distance during user movement.

Copy link

coderabbitai bot commented Jan 17, 2025

Walkthrough

The pull request modifies the getJourney function in the JourneyGenerator.kt file, focusing on how route distance is calculated for user journeys. The key change involves accumulating the route distance by adding the current distance to the existing route distance of the last known journey, instead of simply replacing it. This modification ensures a more accurate tracking of the total distance traveled during a journey, while maintaining the existing logic for journey management and duration calculation.

Changes

File Change Summary
data/src/main/java/com/canopas/yourspace/data/repository/JourneyGenerator.kt Modified route distance calculation to accumulate distance when user is moving or likely stopped

Possibly related PRs

Suggested reviewers

  • cp-megh-l

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:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

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

🧹 Nitpick comments (1)
data/src/main/java/com/canopas/yourspace/data/repository/JourneyGenerator.kt (1)

Line range hint 171-177: Consider adding data consistency validation.

The accumulation logic is correctly implemented, matching the behavior when the user stops moving. However, consider adding validation to ensure data consistency between route_distance and routes.

 val updatedJourney = lastKnownJourney.copy(
     to_latitude = newLocation.latitude,
     to_longitude = newLocation.longitude,
-    // Add new distance to previous distance, if you want cumulative
-    route_distance = (lastKnownJourney.route_distance ?: 0.0) + distance,
+    route_distance = when {
+        lastKnownJourney.routes.isEmpty() -> distance
+        lastKnownJourney.route_distance == null -> 
+            // Log potential data inconsistency
+            distance
+        else -> lastKnownJourney.route_distance + distance
+    },
     route_duration = lastKnownJourney.updated_at -
         lastKnownJourney.created_at,
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f7ed458 and 38a0d01.

📒 Files selected for processing (1)
  • data/src/main/java/com/canopas/yourspace/data/repository/JourneyGenerator.kt (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build
🔇 Additional comments (2)
data/src/main/java/com/canopas/yourspace/data/repository/JourneyGenerator.kt (2)

Line range hint 1-190: Add tests for the distance accumulation logic.

The implementation looks good, but please add tests to verify:

  1. Distance accumulation when user stops moving
  2. Distance accumulation during continuous movement
  3. Handling of null route_distance
  4. Edge cases with empty routes list

Would you like me to help create test cases for these scenarios?


145-145: LGTM! Verify the distance accumulation behavior.

The change correctly accumulates the route distance instead of replacing it, fixing the issue of only saving the last two routes' distance. The null-safe operator ensures safe handling of initial null cases.

Let's verify the fix by checking if there are any other places in the codebase where route distance is calculated:

✅ Verification successful

Verified: Distance calculation implementation is consistent across the codebase

The route distance calculation is correctly implemented:

  • Initial journey creation sets the base distance
  • Subsequent updates properly accumulate the distance
  • Other occurrences are just data copying operations during encryption/decryption
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for route_distance assignments to ensure consistent behavior
rg -l "route_distance\s*=" | xargs rg "route_distance\s*="

Length of output: 742


Script:

#!/bin/bash
# Get context around the simple route_distance assignment
rg "route_distance = distance," -B 5 -A 5

# View the methods containing route_distance assignments in JourneyKtx.kt
ast-grep --pattern 'fun $_ {
  $$$
  route_distance = $_
  $$$
}' data/src/main/java/com/canopas/yourspace/data/service/location/JourneyKtx.kt

Length of output: 1594


Script:

#!/bin/bash
# Get broader context around route_distance assignments in JourneyKtx.kt
rg "route_distance = route_distance" -B 5 -A 5 data/src/main/java/com/canopas/yourspace/data/service/location/JourneyKtx.kt

Length of output: 916

@cp-sneh-s cp-sneh-s merged commit d849720 into main Jan 22, 2025
2 checks passed
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.

2 participants