Ignore far away vehicles locations

[mmathieum]

• Ignore far away vehicles in maps (POI and RDS route screens) mtransit-for-android#388

Summary by CodeRabbit

• New Features
  • Added coordinate clamping and “nearest point” calculation within an agency’s service-area bounds.
  • Introduced proximity checks to decide whether real-time vehicles are inside or sufficiently near the service area.
  • Exposed agency geographic boundary values for wider reuse.
• Bug Fixes
  • Real-time vehicle positions are now filtered out when they are outside the relevant agency area or not near enough.
• Tests
  • Added unit tests covering missing inputs plus inside, near, and outside scenarios.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: ba734add-5fca-47af-9fe2-c7ba8985c370

📥 Commits

Reviewing files that changed from the base of the PR and between d3100e9 and c282483.

📒 Files selected for processing (6)

• src/main/java/org/mtransit/android/commons/data/Area.kt
• src/main/java/org/mtransit/android/commons/provider/GTFSProvider.java
• src/main/java/org/mtransit/android/commons/provider/vehiclelocations/GTFSRealTimeVehiclePositionsProvider.kt
• src/main/java/org/mtransit/android/commons/provider/vehiclelocations/NextBusVehicleLocationsProvider.kt
• src/main/java/org/mtransit/android/commons/provider/vehiclelocations/VehicleLocationProviderUtils.kt
• src/test/java/org/mtransit/android/commons/provider/vehiclelocations/VehicleLocationProviderUtilsTest.kt

---

📝 Walkthrough

Walkthrough

Adds agency-area coordinate clamping and public GTFS bounds access, introduces nearby vehicle validation with tests, and filters GTFS-RT and NextBus vehicle positions using that validation before creating VehicleLocation objects.

Changes

Nearby vehicle filtering

Layer / File(s)	Summary
Area bounds and coordinate contract src/main/java/org/mtransit/android/commons/data/Area.kt, src/main/java/org/mtransit/android/commons/provider/GTFSProvider.java	Area clamps coordinates to its bounds, and GTFS area-bound getters are made public.
Nearby-area validation src/main/java/org/mtransit/android/commons/provider/vehiclelocations/VehicleLocationProviderUtils.kt, src/test/java/org/mtransit/android/commons/provider/vehiclelocations/VehicleLocationProviderUtilsTest.kt	Adds nullable-input validation, nearest-point distance checks, warning/error logging, and tests for missing, inside, and outside coordinates.
Real-time position filtering src/main/java/org/mtransit/android/commons/provider/vehiclelocations/GTFSRealTimeVehiclePositionsProvider.kt, src/main/java/org/mtransit/android/commons/provider/vehiclelocations/NextBusVehicleLocationsProvider.kt	Passes context into position processing, filters positions that are not nearby, and reuses extracted coordinates when constructing vehicle locations.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Sequence Diagram(s)

sequenceDiagram
  participant VehiclePositionFeed
  participant VehicleLocationProvider
  participant VehicleLocationProviderUtils
  participant GTFSProvider
  participant VehicleLocation
  VehiclePositionFeed->>VehicleLocationProvider: provide vehicle positions
  VehicleLocationProvider->>VehicleLocationProviderUtils: validate vehicle coordinates
  VehicleLocationProviderUtils->>GTFSProvider: read agency bounds
  GTFSProvider-->>VehicleLocationProviderUtils: return min/max latitude and longitude
  VehicleLocationProviderUtils-->>VehicleLocationProvider: return nearby result
  VehicleLocationProvider->>VehicleLocation: create accepted location

Loading

Suggested reviewers: copilot

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title matches the main change: filtering out far-away vehicle locations.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch mm/gtfs_rt_vehicle_ignore_vehicle_far_away

---

_{Comment @coderabbitai help to get the list of available commands.}

[Copilot]

Pull request overview

Adds a reusable filter to drop GTFS-RT vehicle positions that are too far from the agency coverage area (addressing “far away vehicles” in some feeds), and wires it into the GTFS real-time vehicle positions provider.

Changes:

• Introduces VehicleLocationProviderUtils.vehicleNearbyAgencyLocation(...) and a unit test suite for the core logic.
• Adds Area.getNearestLatLng(...) to compute the closest point on an agency bounding box for distance checks.
• Filters out far-away GTFS-RT vehicle positions before building VehicleLocation objects; exposes GTFS area bounds accessors needed by the utility.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
src/test/java/org/mtransit/android/commons/provider/vehiclelocations/VehicleLocationProviderUtilsTest.kt	Adds unit tests for “nearby agency area” vehicle filtering logic.
src/main/java/org/mtransit/android/commons/provider/vehiclelocations/VehicleLocationProviderUtils.kt	Adds the shared utility that validates vehicle coordinates against agency bounds and distance threshold.
src/main/java/org/mtransit/android/commons/provider/vehiclelocations/GTFSRealTimeVehiclePositionsProvider.kt	Applies the new “nearby agency area” filter to GTFS-RT vehicle positions.
src/main/java/org/mtransit/android/commons/provider/GTFSProvider.java	Makes area bound getters public so they can be read from other packages (utility).
src/main/java/org/mtransit/android/commons/data/Area.kt	Adds helper to clamp a point to the nearest lat/lng on the area bounds.

[coderabbitai]

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@src/main/java/org/mtransit/android/commons/data/Area.kt`:
- Around line 74-87: Update Area.isInside and getNearestLatLng to recognize
longitude intervals where minLng exceeds maxLng, treating them as wrapping
across the antimeridian; preserve normal interval behavior otherwise. Ensure
points inside the wrapped interval remain unchanged while outside points clamp
to the nearest wrapped boundary, and add a dateline-crossing test before vehicle
filtering relies on these bounds.

In
`@src/test/java/org/mtransit/android/commons/provider/vehiclelocations/VehicleLocationProviderUtilsTest.kt`:
- Around line 14-31: Update the distance calculation in distanceToInMeters to
return metres rather than kilometres, while preserving the existing haversine
calculation and callback contract. Convert the earth-radius value or final
result consistently so the returned Float is expressed in metres.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: e39d2c36-e9d7-43fb-87c3-68ff4863c5d3

📥 Commits

Reviewing files that changed from the base of the PR and between d3100e9 and d544700.

📒 Files selected for processing (5)

• src/main/java/org/mtransit/android/commons/data/Area.kt
• src/main/java/org/mtransit/android/commons/provider/GTFSProvider.java
• src/main/java/org/mtransit/android/commons/provider/vehiclelocations/GTFSRealTimeVehiclePositionsProvider.kt
• src/main/java/org/mtransit/android/commons/provider/vehiclelocations/VehicleLocationProviderUtils.kt
• src/test/java/org/mtransit/android/commons/provider/vehiclelocations/VehicleLocationProviderUtilsTest.kt

[mmathieum]

@coderabbitai full review

[coderabbitai]

✅ Action performed

Full review finished.

[Copilot]

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated no new comments.

Comments suppressed due to low confidence (1)

src/main/java/org/mtransit/android/commons/provider/vehiclelocations/VehicleLocationProviderUtils.kt:25

• Avoid converting Float -> String -> Double for vehicleLat/vehicleLng. This allocates strings for every vehicle and adds unnecessary parsing work in a hot path (called per-vehicle). Converting directly to Double preserves NaN/Infinity handling and is more efficient.

            vehicleLat = vehicleLat.toString().toDoubleOrNull()?.takeIf { it.isFinite() },
            vehicleLng = vehicleLng.toString().toDoubleOrNull()?.takeIf { it.isFinite() },