🍎🚫💰 Surface prediction 'uncertainty' values through v3 API #698

bfauble · 2023-11-03T17:08:33Z

Summary of changes

Asana Ticket: 🍎🚫💰 Surface prediction 'uncertainty' values through v3 API

Parse uncertainty values (if present) from trip updates and add to prediction model.
Add arrival_uncertainty and departure_uncertainty attributes to Prediction resource.
Note: fields currently not present in concentrate feed. Pending: 🧠🚫💰 Surface non-revenue train information through our public-facing data feeds/API

example response:

{
  "data": [
    {
      "attributes": {
        "arrival_time": null,
        "arrival_uncertainty": null,
        "departure_time": "2023-11-03T13:13:00-04:00",
        "departure_uncertainty": null,
        "direction_id": 1,
        "schedule_relationship": null,
        "status": null,
        "stop_sequence": 50
      },
      "id": "prediction-59095632-70094-50",
      "relationships": {
        "route": {
          "data": {
            "id": "Red",
            "type": "route"
          }
        },
        "stop": {
          "data": {
            "id": "70094",
            "type": "stop"
          }
        },
        "trip": {
          "data": {
            "id": "59095632",
            "type": "trip"
          }
        },
        "vehicle": {
          "data": {
            "id": "R-54795DFB",
            "type": "vehicle"
          }
        }
      },
      "type": "prediction"
    },
    ...

github-actions · 2023-11-03T17:15:42Z

Coverage of commit `23a253f`

Summary coverage rate:
  lines......: 89.2% (4135 of 4637 lines)
  functions..: 70.9% (2232 of 3150 functions)
  branches...: no data found

Files changed coverage rate:
                                                                        |Lines       |Functions  |Branches    
  Filename                                                              |Rate     Num|Rate    Num|Rate     Num
  ============================================================================================================
  apps/api_web/lib/api_web/controllers/prediction_controller.ex         |96.0%     75|95.5%    22|    -      0
  apps/api_web/lib/api_web/views/prediction_view.ex                     |94.9%     59|52.9%    51|    -      0
  apps/model/lib/model/prediction.ex                                    | 0.0%      2| 0.0%    10|    -      0
  apps/parse/lib/parse/trip_updates.ex                                  |70.0%     40| 100%     9|    -      0

Download coverage report

paulswartz · 2023-11-03T17:47:11Z

question: is there a reason to ship this before we're providing the data in Concentrate?

bfauble · 2023-11-03T18:30:30Z

question: is there a reason to ship this before we're providing the data in Concentrate?

No particular reason. The concentrate portion is set to be done this sprint and can wait until that is out before merging/deploying this.

nlwstein

A couple of random thoughts but overall this looks good! 🚀

nlwstein · 2023-11-03T21:38:46Z

apps/parse/lib/parse/trip_updates.ex

@@ -54,6 +56,12 @@ defmodule Parse.TripUpdates do
    nil
  end

+  defp parse_uncertainty(%{uncertainty: uncertainty}) when is_integer(uncertainty) do


Since your documentation (nice!) only allows three values, would it make sense to only allow those three values through? I think you can use a guard like when is_integer(uncertainty) and uncertainty in [60, 120, 360] but I haven't tested it.

Does this incorporate the uncertainty values that Swiftly uses?

I could be mistaken, but I think those values are converted into the 60, 120, 360 versions before they make it here. I'll look into that to verify.

Looks like these values are only rail, the swiftly values, which are different, cover bus/CR. Will update docs/types to address.

nlwstein · 2023-11-03T21:41:28Z

apps/api_web/lib/api_web/controllers/prediction_controller.ex

@@ -261,6 +261,34 @@ defmodule ApiWeb.PredictionController do
              example: "2017-08-14T15:38:58-04:00"
            )

+            arrival_uncertainty(


Does this get sucked into Swagger? I can't remember, but if it doesn't, might be worth outputting this to the docs wherever this field shows up.

Yes, these show up in the models section at the bottom of the swagger docs

bfauble · 2023-11-08T17:48:51Z

@nlwstein @paulswartz moved swagger docs into separate PR to include other non-rev documentation here: #700

github-actions · 2023-12-05T15:13:28Z

Coverage of commit `cb8a2c5`

Summary coverage rate:
  lines......: 89.2% (4140 of 4642 lines)
  functions..: 70.9% (2238 of 3155 functions)
  branches...: no data found

Files changed coverage rate:
                                                                        |Lines       |Functions  |Branches    
  Filename                                                              |Rate     Num|Rate    Num|Rate     Num
  ============================================================================================================
  apps/api_web/lib/api_web/views/prediction_view.ex                     |94.9%     59|52.9%    51|    -      0
  apps/model/lib/model/prediction.ex                                    | 0.0%      2| 0.0%    10|    -      0
  apps/parse/lib/parse/trip_updates.ex                                  |70.0%     40| 100%     9|    -      0

Download coverage report

github-actions · 2023-12-18T15:39:22Z

Coverage of commit `02b96cb`

Summary coverage rate:
  lines......: 89.1% (4138 of 4642 lines)
  functions..: 70.9% (2238 of 3155 functions)
  branches...: no data found

Files changed coverage rate:
                                                                        |Lines       |Functions  |Branches    
  Filename                                                              |Rate     Num|Rate    Num|Rate     Num
  ============================================================================================================
  apps/api_web/lib/api_web/views/prediction_view.ex                     |94.9%     59|52.9%    51|    -      0
  apps/model/lib/model/prediction.ex                                    | 0.0%      2| 0.0%    10|    -      0
  apps/parse/lib/parse/trip_updates.ex                                  |70.0%     40| 100%     9|    -      0

Download coverage report

github-actions · 2023-12-21T16:51:49Z

Coverage of commit `688ae59`

Summary coverage rate:
  lines......: 89.2% (4175 of 4680 lines)
  functions..: 71.0% (2251 of 3169 functions)
  branches...: no data found

Files changed coverage rate:
                                                                        |Lines       |Functions  |Branches    
  Filename                                                              |Rate     Num|Rate    Num|Rate     Num
  ============================================================================================================
  apps/api_web/lib/api_web/views/prediction_view.ex                     |95.0%     60|52.8%    53|    -      0
  apps/model/lib/model/prediction.ex                                    | 0.0%      2| 0.0%    10|    -      0
  apps/parse/lib/parse/trip_updates.ex                                  |72.1%     43| 100%    10|    -      0

Download coverage report

publish uncertainty values with predictions

23a253f

bfauble requested review from a team, meagharty and nlwstein November 3, 2023 17:11

nlwstein approved these changes Nov 3, 2023

View reviewed changes

bfauble assigned bfauble and unassigned bfauble Nov 8, 2023

update prediction docs to account for swiftly values

dde4898

Merge branch 'master' into bf-publish-uncertainty-values

f1aae92

paulswartz approved these changes Nov 8, 2023

View reviewed changes

bklebe added the do not merge Do not merge label Nov 22, 2023

Merge branch 'master' into bf-publish-uncertainty-values

cb8a2c5

Merge branch 'master' into bf-publish-uncertainty-values

02b96cb

Merge branch 'master' into bf-publish-uncertainty-values

688ae59

bfauble merged commit d206680 into master Dec 21, 2023
6 checks passed

bfauble deleted the bf-publish-uncertainty-values branch December 21, 2023 17:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🍎🚫💰 Surface prediction 'uncertainty' values through v3 API #698

🍎🚫💰 Surface prediction 'uncertainty' values through v3 API #698

bfauble commented Nov 3, 2023 •

edited

Loading

github-actions bot commented Nov 3, 2023

paulswartz commented Nov 3, 2023

bfauble commented Nov 3, 2023

nlwstein left a comment

nlwstein Nov 3, 2023

paulswartz Nov 6, 2023

bfauble Nov 7, 2023

bfauble Nov 7, 2023 •

edited

Loading

nlwstein Nov 3, 2023

bfauble Nov 7, 2023

bfauble commented Nov 8, 2023

github-actions bot commented Dec 5, 2023

github-actions bot commented Dec 18, 2023

github-actions bot commented Dec 21, 2023

🍎🚫💰 Surface prediction 'uncertainty' values through v3 API #698

🍎🚫💰 Surface prediction 'uncertainty' values through v3 API #698

Conversation

bfauble commented Nov 3, 2023 • edited Loading

Summary of changes

github-actions bot commented Nov 3, 2023

Coverage of commit 23a253f

paulswartz commented Nov 3, 2023

bfauble commented Nov 3, 2023

nlwstein left a comment

Choose a reason for hiding this comment

nlwstein Nov 3, 2023

Choose a reason for hiding this comment

paulswartz Nov 6, 2023

Choose a reason for hiding this comment

bfauble Nov 7, 2023

Choose a reason for hiding this comment

bfauble Nov 7, 2023 • edited Loading

Choose a reason for hiding this comment

nlwstein Nov 3, 2023

Choose a reason for hiding this comment

bfauble Nov 7, 2023

Choose a reason for hiding this comment

bfauble commented Nov 8, 2023

github-actions bot commented Dec 5, 2023

Coverage of commit cb8a2c5

github-actions bot commented Dec 18, 2023

Coverage of commit 02b96cb

github-actions bot commented Dec 21, 2023

Coverage of commit 688ae59

bfauble commented Nov 3, 2023 •

edited

Loading

Coverage of commit `23a253f`

bfauble Nov 7, 2023 •

edited

Loading

Coverage of commit `cb8a2c5`

Coverage of commit `02b96cb`

Coverage of commit `688ae59`