[mds-metrics] Fix binning bug (#70)

* Fix weird array construction bug in metrics API binning method

* Remove async modifier

* Cleanup and add state_snapshot test

* Cleanup

packages/mds-metrics/request-handlers.ts

@@ -12,8 +12,8 @@ import {
   GetTelemetryCountsResponse,
   GetEventCountsResponse,
   TelemetryCountsResponse,
-  EventSnapshotResponse,
-  StateSnapshotResponse
+  StateSnapshot,
+  EventSnapshot
 } from './types'
 import { getTimeBins } from './utils'
 
@@ -50,15 +50,20 @@ export async function getStateSnapshot(req: MetricsApiRequest, res: GetStateSnap
 
             const incrementedSubAcc = { [type]: inc(acc[type], status) }
 
-            return { ...acc, incrementedSubAcc }
+            return { ...acc, ...incrementedSubAcc }
           }, instantiateStateSnapshotResponse(0))
 
           return statusCounts
         }
       })
-      .filter((e): e is StateSnapshotResponse => e !== undefined)
+      .filter((e): e is StateSnapshot => e !== undefined)
+
+    const resultWithSlices = result.map((snapshot, idx) => {
+      const slice = slices[idx]
+      return { snapshot, slice }
+    })
 
-    res.status(200).send(result)
+    res.status(200).send(resultWithSlices)
   } catch (error) {
     await log.error(error)
     res.status(500).send(new ServerError())
@@ -103,9 +108,14 @@ export async function getEventSnapshot(req: MetricsApiRequest, res: GetEventsSna
           return eventCounts
         }
       })
-      .filter((e): e is EventSnapshotResponse => e !== undefined)
+      .filter((e): e is EventSnapshot => e !== undefined)
+
+    const resultWithSlices = result.map((snapshot, idx) => {
+      const slice = slices[idx]
+      return { snapshot, slice }
+    })
 
-    res.status(200).send(result)
+    res.status(200).send(resultWithSlices)
   } catch (error) {
     await log.error(error)
     res.status(500).send(new ServerError())

packages/mds-metrics/tests/test.ts

@@ -10,17 +10,22 @@ import supertest from 'supertest'
 import { ApiServer } from '@mds-core/mds-api-server'
 import test from 'unit.js'
 import { TEST1_PROVIDER_ID } from '@mds-core/mds-providers'
-import { PROVIDER_SCOPES, SCOPED_AUTH } from '@mds-core/mds-test-data'
+import { PROVIDER_SCOPES, SCOPED_AUTH, makeDevices, makeEventsWithTelemetry } from '@mds-core/mds-test-data'
+import { now } from '@mds-core/mds-utils'
 import db from '@mds-core/mds-db'
 import cache from '@mds-core/mds-cache'
 import stream from '@mds-core/mds-stream'
+import { Telemetry } from 'packages/mds-types'
 import { api } from '../api'
+import { StateSnapshotResponse } from '../types'
 
 const request = supertest(ApiServer(api))
 
 const AUTH = SCOPED_AUTH([PROVIDER_SCOPES], TEST1_PROVIDER_ID)
 const AUTH_NO_SCOPE = SCOPED_AUTH([], TEST1_PROVIDER_ID)
 
+const CITY_OF_LA = '1f943d59-ccc9-4d91-b6e2-0c5e771cbc49'
+
 before(async () => {
   await Promise.all([db.initialize(), cache.initialize(), stream.initialize()])
 })
@@ -116,3 +121,64 @@ describe('Tests API Scope Access', () => {
       })
   })
 })
+
+describe('Tests API', () => {
+  const HALF_DAY_AGO = now() - 43200000
+  before(async () => {
+    const devices = makeDevices(15, HALF_DAY_AGO)
+    const events = makeEventsWithTelemetry(devices, HALF_DAY_AGO, CITY_OF_LA, 'trip_start')
+    const telem = events.reduce((acc: Telemetry[], e) => {
+      const { telemetry } = e
+      return [...acc, telemetry as Telemetry]
+    }, [])
+
+    const seedData = { devices, events, telemetry: telem }
+    await Promise.all([db.seed(seedData), cache.seed(seedData)])
+  })
+
+  it('verifies valid response from state_snapshot', done => {
+    request
+      .get('/state_snapshot')
+      .set('Authorization', AUTH)
+      .expect(200)
+      .end((err, result) => {
+        result.body.forEach((res: StateSnapshotResponse) => {
+          const { snapshot, slice } = res
+          if (slice.end >= HALF_DAY_AGO) {
+            test.assert(snapshot.bicycle.trip === 15)
+          }
+        })
+        done(err)
+      })
+  })
+
+  it('verifies access to event_snapshot if scoped', done => {
+    request
+      .get('/event_snapshot')
+      .set('Authorization', AUTH)
+      .expect(200)
+      .end(err => {
+        done(err)
+      })
+  })
+
+  it('verifies access to telemetry_counts if scoped', done => {
+    request
+      .get('/telemetry_counts')
+      .set('Authorization', AUTH)
+      .expect(200)
+      .end(err => {
+        done(err)
+      })
+  })
+
+  it('verifies access to event_counts if scoped', done => {
+    request
+      .get('/event_counts')
+      .set('Authorization', AUTH)
+      .expect(200)
+      .end(err => {
+        done(err)
+      })
+  })
+})

packages/mds-metrics/types.ts

@@ -10,14 +10,26 @@ import {
   UUID
 } from '@mds-core/mds-types'
 
-export type StateSnapshotResponse = {
+export type WithSlice<T> = {
+  snapshot: T
+  slice: {
+    start: number
+    end: number
+  }
+}
+
+export type StateSnapshot = {
   [T in VEHICLE_TYPE]: { [S in VEHICLE_STATUS]: number }
 }
 
-export type EventSnapshotResponse = {
+export type StateSnapshotResponse = WithSlice<StateSnapshot>
+
+export type EventSnapshot = {
   [T in VEHICLE_TYPE]: { [S in VEHICLE_EVENT]: number }
 }
 
+export type EventSnapshotResponse = WithSlice<EventSnapshot>
+
 export type TelemetryCountsResponse = {
   telemetryCount: {
     count: number
@@ -65,7 +77,7 @@ export const instantiateEventSnapshotResponse = (value: number) =>
       [vehicle_type]: Object.keys(VEHICLE_EVENTS).reduce((acc2, event_type) => ({ ...acc2, [event_type]: value }), {})
     }),
     {}
-  ) as EventSnapshotResponse
+  ) as EventSnapshot
 
 export const instantiateStateSnapshotResponse = (value: number) =>
   Object.keys(VEHICLE_TYPES).reduce(
@@ -74,4 +86,4 @@ export const instantiateStateSnapshotResponse = (value: number) =>
       [vehicle_type]: Object.keys(VEHICLE_STATUSES).reduce((acc2, event_type) => ({ ...acc2, [event_type]: value }), {})
     }),
     {}
-  ) as StateSnapshotResponse
+  ) as StateSnapshot

packages/mds-metrics/utils.ts

@@ -1,4 +1,5 @@
 import { now, yesterday } from '@mds-core/mds-utils'
+
 import { GetTimeBinsParams } from './types'
 
 export function getTimeBins({
@@ -8,9 +9,7 @@ export function getTimeBins({
 }: Partial<GetTimeBinsParams>) {
   const interval = end_time - start_time
 
-  const bins = new Array(Math.floor(interval / bin_size))
-
-  return bins.map((_, idx) => ({
+  return [...Array(Math.floor(interval / bin_size))].map((_, idx) => ({
     start: start_time + idx * bin_size,
     end: start_time + (idx + 1) * bin_size
   }))

packages/mds-types/index.ts

@@ -18,11 +18,9 @@ import { FeatureCollection } from 'geojson'
 export { AccessTokenScope, AccessTokenScopes, ScopeDescriptions } from './scopes'
 
 export const Enum = <T extends string>(...keys: T[]) =>
-  Object.freeze(
-    keys.reduce((e, key) => {
-      return { ...e, [key]: key }
-    }, {}) as { [K in T]: K }
-  )
+  Object.freeze(keys.reduce((e, key) => {
+    return { ...e, [key]: key }
+  }, {}) as { [K in T]: K })
 
 export const isEnum = (enums: { [key: string]: string }, value: unknown) =>
   typeof value === 'string' && typeof enums === 'object' && enums[value] === value