Merge pull request #25 from opentripplanner/dev

New release

Author: evansiroky

__tests__/actions/__snapshots__/form.js.snap

@@ -0,0 +1,59 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`actions > api > form should debounce numerous requests to plan a trip 1`] = `
+Array [
+  Array [
+    Object {
+      "type": "FORM_CHANGED",
+    },
+  ],
+  Array [
+    Object {
+      "type": "FORM_CHANGED",
+    },
+  ],
+  Array [
+    Object {
+      "type": "FORM_CHANGED",
+    },
+  ],
+  Array [
+    Object {
+      "type": "FORM_CHANGED",
+    },
+  ],
+  Array [
+    Object {
+      "type": "FORM_CHANGED",
+    },
+  ],
+  Array [
+    Object {
+      "type": "FORM_CHANGED",
+    },
+  ],
+  Array [
+    Object {
+      "type": "FORM_CHANGED",
+    },
+  ],
+  Array [
+    Object {
+      "type": "FORM_CHANGED",
+    },
+  ],
+  Array [
+    Object {
+      "type": "FORM_CHANGED",
+    },
+  ],
+  Array [
+    Object {
+      "type": "FORM_CHANGED",
+    },
+  ],
+  Array [
+    [Function],
+  ],
+]
+`;

__tests__/actions/api.js

@@ -2,13 +2,9 @@
 
 import nock from 'nock'
 
-import {planTrip} from '../../lib/actions/api'
+import {timeoutPromise} from '../test-utils'
 
-function timeoutPromise (ms) {
-  return new Promise((resolve, reject) => {
-    setTimeout(resolve, ms)
-  })
-}
+import {planTrip} from '../../lib/actions/api'
 
 describe('actions > api', () => {
   describe('> planTrip', () => {

__tests__/actions/form.js

@@ -0,0 +1,40 @@
+/* globals describe, expect, it, jest */
+
+import {timeoutPromise} from '../test-utils'
+
+import {formChanged} from '../../lib/actions/form'
+
+describe('actions > api > form', () => {
+  it('should debounce numerous requests to plan a trip', async () => {
+    const defaultState = {
+      otp: {
+        config: {
+          api: {
+            host: 'http://mock-host.com',
+            path: '/api',
+            port: 80
+          },
+          autoPlan: true,
+          debouncePlanTimeMs: 500
+        },
+        currentQuery: {
+          from: { lat: 12, lon: 34 },
+          to: { lat: 34, lon: 12 }
+        },
+        searches: []
+      }
+    }
+
+    const formChangedAction = formChanged()
+
+    const mockDispatch = jest.fn()
+    for (var i = 0; i < 10; i++) {
+      formChangedAction(mockDispatch, () => defaultState)
+    }
+
+    // wait for request to complete
+    await timeoutPromise(1000)
+
+    expect(mockDispatch.mock.calls).toMatchSnapshot()
+  })
+})

__tests__/test-utils/index.js

@@ -0,0 +1,5 @@
+export function timeoutPromise (ms) {
+  return new Promise((resolve, reject) => {
+    setTimeout(resolve, ms)
+  })
+}

lib/actions/api.js

@@ -28,9 +28,9 @@ export function planTrip (customOtpQueryBuilder) {
     const queryBuilderFn = customOtpQueryBuilder || otpState.config.customOtpQueryBuilder || constructPlanQuery
     const url = queryBuilderFn(otpState.config.api, otpState.currentQuery)
     // setURLSearch(url)
-    let response, json
+    let json
     try {
-      response = await fetch(url)
+      const response = await fetch(url)
       if (response.status >= 400) {
         const error = new Error('Received error from server')
         error.response = response

lib/actions/form.js

@@ -1,3 +1,4 @@
+import debounce from 'lodash.debounce'
 import { createAction } from 'redux-actions'
 
 import { planTrip } from './api'
@@ -37,12 +38,25 @@ export function setTime (payload) {
   }
 }
 
+let debouncedPlanTrip  // store as variable here, so it can be reused.
+let lastDebouncePlanTimeMs
+
 export function formChanged () {
   return function (dispatch, getState) {
     dispatch(changingForm())
-    // TODO: make auto-plan trip a configurable
-    if (queryIsValid(getState().otp)) {
-      dispatch(planTrip())
+    const otpState = getState().otp
+    const {autoPlan, debouncePlanTimeMs} = otpState.config
+
+    // check if a trip plan should be made
+    if (autoPlan && queryIsValid(otpState)) {
+      // trip plan should be made
+
+      // check if debouncing function needs to be (re)created
+      if (!debouncedPlanTrip || lastDebouncePlanTimeMs !== debouncePlanTimeMs) {
+        debouncedPlanTrip = debounce(() => dispatch(planTrip()), debouncePlanTimeMs)
+        lastDebouncePlanTimeMs = debouncePlanTimeMs
+      }
+      debouncedPlanTrip()
     }
   }
 }

lib/reducers/create-otp-reducer.js

@@ -22,9 +22,11 @@ function createOtpReducer (config, initialQuery) {
   defaultQuery.mode = defaultQuery.mode || config.modes[0] || 'TRANSIT,WALK'
   // populate query by merging any provided query params w/ the default params
   const currentQuery = Object.assign(defaultQuery, initialQuery)
-  console.log(currentQuery)
   const initialState = {
-    config,
+    config: Object.assign({
+      autoPlan: true,
+      debouncePlanTimeMs: 0
+    }, config),
     currentQuery,
     searches: [],
     activeSearch: 0

package.json

@@ -36,6 +36,7 @@
     "immutability-helper": "^2.1.1",
     "isomorphic-fetch": "^2.2.1",
     "leaflet": "^1.0.3",
+    "lodash.debounce": "^4.0.8",
     "moment": "^2.17.1",
     "object-path": "^0.11.3",
     "qs": "^6.3.0",

yarn.lock

@@ -4306,6 +4306,10 @@ lodash.assign@^4.0.3, lodash.assign@^4.0.6:
   version "4.2.0"
   resolved "https://registry.yarnpkg.com/lodash.assign/-/lodash.assign-4.2.0.tgz#0d99f3ccd7a6d261d19bdaeb9245005d285808e7"
 
+lodash.debounce@^4.0.8:
+  version "4.0.8"
+  resolved "https://registry.yarnpkg.com/lodash.debounce/-/lodash.debounce-4.0.8.tgz#82d79bff30a67c4005ffd5e2515300ad9ca4d7af"
+
 lodash.isarguments@^3.0.0:
   version "3.1.0"
   resolved "https://registry.yarnpkg.com/lodash.isarguments/-/lodash.isarguments-3.1.0.tgz#2f573d85c6a24289ff00663b491c1d338ff3458a"