fix(time): make default query react properly to homeTimezone config

Author: evansiroky

__tests__/reducers/__snapshots__/create-otp-reducer.js.snap

@@ -6,6 +6,7 @@ Object {
   "config": Object {
     "autoPlan": false,
     "debouncePlanTimeMs": 0,
+    "homeTimezone": "America/Los_Angeles",
     "language": Object {},
     "operators": Array [],
     "realtimeEffectsDisplayThreshold": 120,

__tests__/util/__snapshots__/state.js.snap

@@ -1,13 +1,8 @@
 /* globals describe, expect, it */
 
-import {getDefaultQuery, queryIsValid} from '../../lib/util/state'
+import {queryIsValid} from '../../lib/util/state'
 
 describe('util > state', () => {
-  it('getDefaultQuery should parse window hash if available', () => {
-    window.location.hash = '#plan?arriveBy=false&date=2017-02-03&fromPlace=12,34&toPlace=34,12&time=12:34'
-    expect(getDefaultQuery()).toMatchSnapshot()
-  })
-
   describe('queryIsValid', () => {
     const fakeFromLocation = {
       lat: 12,

__tests__/util/state.js

@@ -35,7 +35,10 @@ export function resetForm () {
     } else {
       // Get user overrides and apply to default query
       const userOverrides = getItem('defaultQuery', {})
-      const defaultQuery = Object.assign(getDefaultQuery(), userOverrides)
+      const defaultQuery = Object.assign(
+        getDefaultQuery(otpState.config),
+        userOverrides
+      )
       // Filter out non-options (i.e., date, places).
       const options = getTripOptionsFromQuery(defaultQuery)
       // Default mode is currently WALK,TRANSIT. We need to update this value
@@ -67,7 +70,15 @@ export function parseUrlQueryString (params = getUrlParams()) {
     })
     const searchId = params.ui_activeSearch || randId()
     // Convert strings to numbers/objects and dispatch
-    dispatch(setQueryParam(planParamsToQuery(planParams), searchId))
+    dispatch(
+      setQueryParam(
+        planParamsToQuery(
+          planParams,
+          getState().otp.config
+        ),
+        searchId
+      )
+    )
   }
 }
 

lib/actions/form.js

@@ -1,6 +1,7 @@
 import clone from 'clone'
 import update from 'immutability-helper'
 import isEqual from 'lodash.isequal'
+import moment from 'moment-timezone'
 import objectPath from 'object-path'
 
 import { matchLatLon } from '../util/map'
@@ -58,10 +59,11 @@ function validateInitalState (initialState) {
  * Create the initial state of otp-react-redux using user-provided config, any
  * items in localStorage and a few defaults.
  */
-export function getInitialState (config, initialQuery) {
+export function getInitialState (userDefinedConfig, initialQuery) {
   const defaultConfig = {
     autoPlan: false,
     debouncePlanTimeMs: 0,
+    homeTimezone: moment.tz.guess(),
     language: {},
     operators: [],
     realtimeEffectsDisplayThreshold: 120,
@@ -74,14 +76,15 @@ export function getInitialState (config, initialQuery) {
       timeRange: 345600 // four days in seconds
     }
   }
+  const config = Object.assign(defaultConfig, userDefinedConfig)
 
   // Load user settings from local storage.
   // TODO: Make this work with settings fetched from alternative storage system
   //  (e.g., OTP backend middleware containing user profile system).
   // User overrides determine user's default mode/query parameters.
   const userOverrides = getItem('defaultQuery', {})
   // Combine user overrides with default query to get default search settings.
-  const defaults = Object.assign(getDefaultQuery(), userOverrides)
+  const defaults = Object.assign(getDefaultQuery(config), userOverrides)
   // Whether to auto-refresh stop arrival times in the Stop Viewer.
   const autoRefreshStopTimes = getItem('autoRefreshStopTimes', true)
   // User's home and work locations
@@ -123,7 +126,7 @@ export function getInitialState (config, initialQuery) {
   }
 
   return {
-    config: Object.assign(defaultConfig, config),
+    config,
     currentQuery,
     location: {
       currentPosition: {

lib/reducers/create-otp-reducer.js

@@ -19,8 +19,9 @@ import { getCurrentDate, getCurrentTime } from './time'
  *   (Applicability is assumed if this function is not provided.)
  *
  * default: the default value for this parameter. The default can be also be a
- *  function that gets executed when accessing the default value. This can be
- *  particluarly helpful if a brand new time-dependent value is desired to be
+ *  function that gets executed when accessing the default value. When the value
+ *  is a funciton, it will take an argument of the current config of the otp-rr
+ *  store. This is needed when a brand new time-dependent value is desired to be
  *  calculated. It's also helpful for producing tests that have consistent data
  *  output.
  *

lib/util/query-params.js

@@ -98,11 +98,11 @@ export function getTripOptionsFromQuery (query, keepPlace = false) {
 }
 
 /**
- * Gets the default query param by executing the default value function if the
- * default is a function.
+ * Gets the default query param by executing the default value function with the
+ * provided otp config if the default value is a function.
  */
-function getDefaultQueryParamValue (param) {
-  return typeof param.default === 'function' ? param.default() : param.default
+function getDefaultQueryParamValue (param, config) {
+  return typeof param.default === 'function' ? param.default(config) : param.default
 }
 
 /**
@@ -127,23 +127,35 @@ export function isNotDefaultQuery (query, config) {
       // Check that the applicability test (if provided) is satisfied
       if (typeof paramInfo.applicable === 'function' &&
         !paramInfo.applicable(query, config)) return
-      if (query[param] !== getDefaultQueryParamValue(paramInfo)) {
+      if (query[param] !== getDefaultQueryParamValue(paramInfo, config)) {
         queryIsDifferent = true
       }
     })
   }
   return queryIsDifferent
 }
 
-export function getDefaultQuery () {
+/**
+ * Get the default query to OTP based on the given config.
+ *
+ * @param config the config in the otp-rr store.
+ */
+export function getDefaultQuery (config) {
   const defaultQuery = { routingType: 'ITINERARY' }
   queryParams.filter(qp => 'default' in qp).forEach(qp => {
-    defaultQuery[qp.name] = getDefaultQueryParamValue(qp)
+    defaultQuery[qp.name] = getDefaultQueryParamValue(qp, config)
   })
   return defaultQuery
 }
 
-export function planParamsToQuery (params) {
+/**
+ * Create a otp query based on a the url params.
+ *
+ * @param  {Object} params An object representing the parsed querystring of url
+ *    params.
+ * @param config the config in the otp-rr store.
+ */
+export function planParamsToQuery (params, config) {
   const query = {}
   for (var key in params) {
     switch (key) {
@@ -161,10 +173,10 @@ export function planParamsToQuery (params) {
             : 'NOW'
         break
       case 'date':
-        query.date = params.date || getCurrentDate()
+        query.date = params.date || getCurrentDate(config)
         break
       case 'time':
-        query.time = params.time || getCurrentTime()
+        query.time = params.time || getCurrentTime(config)
         break
       default:
         if (!isNaN(params[key])) query[key] = parseFloat(params[key])

lib/util/query.js

@@ -70,43 +70,6 @@ export function queryIsValid (otpState) {
     // TODO: add date/time validation
 }
 
-/**
- * This parses the current URL params and returns a simple query object
- * containing only the primary query params.
- *
- * TODO: Determine if this needs to/can be replaced with
- * 'util/query.js#getDefaultQuery'
- */
-export function getDefaultQuery () {
-  let params = {}
-  if (typeof (window) !== 'undefined') {
-    params = getUrlParams()
-  }
-  const from = (params.fromPlace && params.fromPlace.split(',')) || []
-  const to = (params.toPlace && params.toPlace.split(',')) || []
-  return {
-    routingType: 'ITINERARY',
-    from: from.length ? {
-      name: coordsToString(from) || null,
-      lat: from[0] || null,
-      lon: from[1] || null
-    } : null,
-    to: to.length ? {
-      name: coordsToString(to) || null,
-      lat: to[0] || null,
-      lon: to[1] || null
-    } : null,
-    departArrive: params.arriveBy === 'true'
-      ? 'ARRIVE'
-      : params.arriveBy === 'false'
-        ? 'DEPART'
-        : 'NOW',
-    date: params.date || getCurrentDate(),
-    time: params.time || getCurrentTime(),
-    mode: params.mode
-  }
-}
-
 export function getRealtimeEffects (otpState) {
   const search = getActiveSearch(otpState)
 

lib/util/state.js

@@ -64,17 +64,21 @@ export function formatStopTime (seconds, timezone = null, timeFormat = 'h:mm a')
 }
 
 /**
- * Formats current time for use in OTP query
+ * Formats current time for use in OTP query based on the given config.
+ *
+ * @param config the config in the otp-rr store.
  * @returns {string} formatted text representation
  */
-export function getCurrentTime () {
-  return moment().format(TIME_FORMAT_24_HR)
+export function getCurrentTime (config) {
+  return moment().tz(config.homeTimezone).format(getTimeFormat(config))
 }
 
 /**
- * Formats current date for use in OTP query
+ * Formats current date for use in OTP query based on the given config.
+ *
+ * @param config the config in the otp-rr store.
  * @returns {string} formatted text representation
  */
-export function getCurrentDate () {
-  return moment().format('YYYY-MM-DD')
+export function getCurrentDate (config) {
+  return moment().tz(config.homeTimezone).format(getDateFormat(config))
 }