Vehicle location report timestamp instant / countdown duration

[mmathieum]

• POI screen > better map camera when far away... mtransit-for-android#118

[gemini-code-assist]

Summary of Changes

Hello @mmathieum, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request refactors the handling of vehicle location timestamps within the application. By transitioning from kotlin.time.Duration to kotlin.time.Instant for reportTimestamp, the changes aim to provide a more precise and unambiguous representation of specific points in time. This update involves introducing new utility functions for time conversions and modifying existing data models and data providers to align with the Instant type, ensuring consistency and accuracy in timestamp management.

Highlights

• New Time Utility Functions: Introduced new utility functions in TimeUtilsK.kt to convert between Long (seconds/milliseconds) and kotlin.time.Instant.
• VehicleLocation Model Update: Refactored the VehicleLocation data model to use kotlin.time.Instant for reportTimestamp instead of kotlin.time.Duration, improving clarity and precision.
• Provider Integration: Updated vehicle location providers (GTFSRealTimeVehiclePositionsProvider and NextBusVehicleLocationsProvider) to correctly handle and store timestamps as Instant objects.
• Derived Property Alignment: Adjusted derived properties (reportTimestampSec, reportTimestampMs, reportTimestampCountdown) in VehicleLocation to work with the new Instant type.

Changelog

• src/main/java/org/mtransit/android/commons/TimeUtilsK.kt
  • Added Long.secsToInstant() extension function to convert seconds to Instant.
  • Added Instant.toSecs() extension function to convert Instant to seconds.
• src/main/java/org/mtransit/android/commons/provider/vehiclelocations/GTFSRealTimeVehiclePositionsProvider.kt
  • Imported secsToInstant extension function.
  • Updated reportTimestamp assignment to use secsToInstant() for converting the timestamp from seconds to Instant.
• src/main/java/org/mtransit/android/commons/provider/vehiclelocations/NextBusVehicleLocationsProvider.kt
  • Imported TimeUtilsK and toMillis extension function.
  • Removed Duration.Companion.milliseconds import.
  • Changed the type of newLastUpdate from Duration to Instant.
  • Updated NextBusStorage.saveVehicleLocationLastUpdateMs to save newLastUpdate.toMillis().
  • Modified processVehiclePositions function signature to accept Instant for newLastUpdate.
  • Updated lastUpdateInMs assignment to use newLastUpdate.toMillis().
• src/main/java/org/mtransit/android/commons/provider/vehiclelocations/model/VehicleLocation.kt
  • Imported TimeUtilsK, secsToInstant, toMillis, and toSecs extension functions.
  • Changed the type of reportTimestamp from Duration? to Instant?.
  • Updated reportTimestampSec getter to use reportTimestamp?.toSecs().
  • Updated reportTimestampMs getter to use reportTimestamp?.toMillis().
  • Updated reportTimestampCountdown getter to use TimeUtilsK.currentInstant() - it.
  • Modified VehicleLocation constructor to parse reportTimestamp using secsToInstant().

Activity

• No specific activity (comments, reviews, progress) was provided in the context.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request refactors the codebase to use kotlin.time.Instant for timestamps instead of kotlin.time.Duration. This is a significant improvement, as Instant is the semantically correct type for representing points in time, which enhances code clarity and type safety. The changes are applied consistently across all relevant files. I have one minor suggestion to further improve the naming consistency of the new utility functions.