Lab 5: Routing Dashboard Feature

[mrzzy]

Motivation

Part of Lab 5

Task

Implement Routing Dashboard Feature in 2.4.1.1- 2.1.4.4 of the SRS

Proposal

Extend current system design to support routing:

---
title: Flowmotion System Architecture Diagram
---
flowchart
    app(Flutter App) <-->|user data| db
    app <-->|authenticate| auth
    app -->|congestion rating\n & route| backend

    subgraph gcp[Google Cloud]
        subgraph Firebase
            db[(Firestore)] 
            auth[Firebase\n Authentication]
        end

        subgraph cr[GCP Cloud Run]
            backend[Backend]
            backend <-->|routing| gsrm[GSRM]
            backend <-->|cache| db
        end
    end
    backend -->|geocoding| geocode
    geocode((Nominatim))

    api((Data.gov.sg)) -->|traffic images| m
    subgraph Github Actions
        direction LR
        m[[ML Pipeline]] -->|rating| db
        m -->|custom profile| gsrm["GSRM\n(custom)"]
        m <-->|rating| ml[Model]
    end

Routing Service

Routing Service will run on GCP Cloud Run and offer APIs to the Mobile App.

Backend API: OpenAPI spec @F-R-YEO @Inscrutablydistinct @mrzzy @devlinwaluja

• CI pipeline @mrzzy: lint, test, publish container, deploy to GCP cloud run.
• /congestion: @F-R-YEO
  • query Firebase based on params and aggregate Congestion.rating (if specified).
• /route:
  • geocode https://nominatim.openstreetmap.org/search?q=changi+airport&format=jsonv2 fetch with node-fetch-cache with custom firestore caching backend. @Inscrutablydistinct & @devlinwaluja
  • call osrm api to perform routing. https://osrm-congestion-210524342027.asia-southeast1.run.app/route/v1/driving/103.6849923,1.3437504;103.858528,1.282302?steps=true&alternatives=true
  • extract fields from osrm api
  • build and return response.
• /congested/{camera_id}
  • nontrival, might not implement TBC.

ML Pipeline: @mrzzy @devlinwaluja OSRM API: @mrzzy @devlinwaluja

• self-hosted deployment of https://project-osrm.org/
• uses custom profile generated by ML pipeline to perform routing.

Plan B: Replace ORSM & ML Pipeline extension with Mapbox API to perform routing.

Mobile

Routing Dashboard Feature in 2.4.1.1- 2.1.4.4 of the SRS with the assistance of the Backend API. @ZhiXin18 @thesmolbeann

[mrzzy]

@devlinwaluja & @Inscrutablydistinct Please implement: https://github.com/ZhiXin18/flowmotion/blob/18c622ba61b6fdcf7bbff096394a293eb54f14f1/backend/index.ts#L51-L52

with caching to Firebase.

@F-R-YEO Please implement: https://github.com/ZhiXin18/flowmotion/blob/70df29bfbc53c4191d97b576aecfd3d45d8684ef/backend/services/congestion.ts#L79