Observe API service

.env.sample

@@ -27,11 +27,14 @@ OAUTH_CONSUMER_KEY=<consumer_key>
 OAUTH_CONSUMER_SECRET=<consumer_secret>
 
 # require additional auth before osm auth
-PREAUTH_URL=<optional>
-PREAUTH_NAME=<optional>
+# PREAUTH_URL=<optional>
+# PREAUTH_NAME=<optional>
 
 # geocoding via opencage
 OPENCAGE_KEY=<optional>
 
 # set limit for downloading mapbox tiles. 6000 is default and compliant with ToS
-MAPBOX_OFFLINE_TILE_DOWNLOAD_LIMIT=6000
+MAPBOX_OFFLINE_TILE_DOWNLOAD_LIMIT=6000
+
+# optional observe api endpoint to send photos and traces to
+# OBSERVE_API_URL=<optional>

__tests__/actions/__snapshots__/trace.test.js.snap

@@ -1,6 +1,6 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`test trace actions should start trace correctly 1`] = `
+exports[`test trace sync actions should start trace correctly 1`] = `
 Array [
   Object {
     "type": "TRACE_START",
@@ -45,3 +45,173 @@ Array [
   },
 ]
 `;
+
+exports[`trace upload / async actions should add error to the trace for an error response 1`] = `
+Array [
+  Object {
+    "id": "id-1",
+    "type": "TRACE_UPLOAD_STARTED",
+  },
+  Object {
+    "error": [Error: Unknown error],
+    "id": "id-1",
+    "type": "TRACE_UPLOAD_FAILED",
+  },
+]
+`;
+
+exports[`trace upload / async actions should add error to the trace for an error response 2`] = `
+Array [
+  Array [
+    "http://localhost:3000/traces",
+    Object {
+      "body": "{\\"tracejson\\":{\\"type\\":\\"Feature\\",\\"properties\\":{\\"timestamps\\":[1,11,21],\\"description\\":\\"\\"},\\"geometry\\":{\\"type\\":\\"LineString\\",\\"coordinates\\":[[1,1],[2,0],[3,-1]]}}}",
+      "headers": Object {
+        "Authorization": "abcd",
+        "Content-Type": "application/json",
+      },
+      "method": "POST",
+    },
+  ],
+]
+`;
+
+exports[`trace upload / async actions should not upload non-pending traces 1`] = `
+Array [
+  Object {
+    "id": "id-1",
+    "type": "TRACE_UPLOAD_STARTED",
+  },
+  Object {
+    "newId": "fakeid-1",
+    "oldId": "id-1",
+    "type": "TRACE_UPLOADED",
+  },
+]
+`;
+
+exports[`trace upload / async actions should not upload non-pending traces 2`] = `
+Array [
+  Array [
+    "http://localhost:3000/traces",
+    Object {
+      "body": "{\\"tracejson\\":{\\"type\\":\\"Feature\\",\\"properties\\":{\\"timestamps\\":[1,11,21],\\"description\\":\\"\\"},\\"geometry\\":{\\"type\\":\\"LineString\\",\\"coordinates\\":[[1,1],[2,0],[3,-1]]}}}",
+      "headers": Object {
+        "Authorization": "abcd",
+        "Content-Type": "application/json",
+      },
+      "method": "POST",
+    },
+  ],
+]
+`;
+
+exports[`trace upload / async actions should not upload uploading traces 1`] = `
+Array [
+  Object {
+    "id": "id-2",
+    "type": "TRACE_UPLOAD_STARTED",
+  },
+  Object {
+    "newId": "fakeid-2",
+    "oldId": "id-2",
+    "type": "TRACE_UPLOADED",
+  },
+]
+`;
+
+exports[`trace upload / async actions should not upload uploading traces 2`] = `
+Array [
+  Array [
+    "http://localhost:3000/traces",
+    Object {
+      "body": "{\\"tracejson\\":{\\"type\\":\\"Feature\\",\\"properties\\":{\\"timestamps\\":[2,12,22],\\"description\\":\\"\\"},\\"geometry\\":{\\"type\\":\\"LineString\\",\\"coordinates\\":[[2,2],[3,1],[4,0]]}}}",
+      "headers": Object {
+        "Authorization": "abcd",
+        "Content-Type": "application/json",
+      },
+      "method": "POST",
+    },
+  ],
+]
+`;
+
+exports[`trace upload / async actions should upload a single trace 1`] = `
+Array [
+  Object {
+    "id": "id-1",
+    "type": "TRACE_UPLOAD_STARTED",
+  },
+  Object {
+    "newId": "fakeid",
+    "oldId": "id-1",
+    "type": "TRACE_UPLOADED",
+  },
+]
+`;
+
+exports[`trace upload / async actions should upload a single trace 2`] = `
+Array [
+  Array [
+    "http://localhost:3000/traces",
+    Object {
+      "body": "{\\"tracejson\\":{\\"type\\":\\"Feature\\",\\"properties\\":{\\"timestamps\\":[1,11,21],\\"description\\":\\"\\"},\\"geometry\\":{\\"type\\":\\"LineString\\",\\"coordinates\\":[[1,1],[2,0],[3,-1]]}}}",
+      "headers": Object {
+        "Authorization": "abcd",
+        "Content-Type": "application/json",
+      },
+      "method": "POST",
+    },
+  ],
+]
+`;
+
+exports[`trace upload / async actions should upload multiple pending traces 1`] = `
+Array [
+  Object {
+    "id": "id-1",
+    "type": "TRACE_UPLOAD_STARTED",
+  },
+  Object {
+    "newId": "fakeid-1",
+    "oldId": "id-1",
+    "type": "TRACE_UPLOADED",
+  },
+  Object {
+    "id": "id-2",
+    "type": "TRACE_UPLOAD_STARTED",
+  },
+  Object {
+    "newId": "fakeid-2",
+    "oldId": "id-2",
+    "type": "TRACE_UPLOADED",
+  },
+]
+`;
+
+exports[`trace upload / async actions should upload multiple pending traces 2`] = `
+Array [
+  Array [
+    "http://localhost:3000/traces",
+    Object {
+      "body": "{\\"tracejson\\":{\\"type\\":\\"Feature\\",\\"properties\\":{\\"timestamps\\":[1,11,21],\\"description\\":\\"\\"},\\"geometry\\":{\\"type\\":\\"LineString\\",\\"coordinates\\":[[1,1],[2,0],[3,-1]]}}}",
+      "headers": Object {
+        "Authorization": "abcd",
+        "Content-Type": "application/json",
+      },
+      "method": "POST",
+    },
+  ],
+  Array [
+    "http://localhost:3000/traces",
+    Object {
+      "body": "{\\"tracejson\\":{\\"type\\":\\"Feature\\",\\"properties\\":{\\"timestamps\\":[2,12,22],\\"description\\":\\"\\"},\\"geometry\\":{\\"type\\":\\"LineString\\",\\"coordinates\\":[[2,2],[3,1],[4,0]]}}}",
+      "headers": Object {
+        "Authorization": "abcd",
+        "Content-Type": "application/json",
+      },
+      "method": "POST",
+    },
+  ],
+]
+`;

__tests__/actions/trace.test.js

@@ -1,4 +1,4 @@
-/* global jest, it, expect, describe */
+/* global jest, it, expect, describe, fetch */
 
 import configureStore from 'redux-mock-store'
 import thunk from 'redux-thunk'
@@ -8,7 +8,8 @@ import {
   pauseTrace,
   unpauseTrace,
   startSavingTrace,
-  discardTrace
+  discardTrace,
+  uploadPendingTraces
 } from '../../app/actions/traces'
 const middlewares = [thunk]
 const mockStore = configureStore(middlewares)
@@ -45,6 +46,22 @@ jest.mock('../../app/services/trace', () => {
   }
 })
 
+// This is required because the observe API service calls the store directly
+// to get the token.
+jest.mock('../../app/utils/store', () => {
+  return {
+    store: {
+      getState: () => {
+        return {
+          observeApi: {
+            token: 'abcd'
+          }
+        }
+      }
+    }
+  }
+})
+
 const getMockCurrentTrace = function () {
   return {
     type: 'Feature',
@@ -59,7 +76,59 @@ const getMockCurrentTrace = function () {
   }
 }
 
-describe('test trace actions', () => {
+/**
+ *
+ * @param {Number} m - used to construct id, timestamps, coords
+ */
+const getMockTrace = function (m) {
+  return {
+    id: `id-${m}`,
+    pending: true,
+    uploading: false,
+    geojson: {
+      type: 'Feature',
+      properties: {
+        timestamps: [
+          m,
+          m + 10,
+          m + 20
+        ]
+      },
+      geometry: {
+        type: 'LineString',
+        coordinates: [
+          [m, m],
+          [m + 1, m - 1],
+          [m + 2, m - 2]
+        ]
+      }
+    }
+  }
+}
+
+const getMockTracePostResponse = function (m, id) {
+  return {
+    type: 'Feature',
+    properties: {
+      id,
+      timestamps: [
+        m,
+        m + 10,
+        m + 20
+      ]
+    },
+    geometry: {
+      type: 'LineString',
+      coordinates: [
+        [m, m],
+        [m + 1, m - 1],
+        [m + 2, m - 2]
+      ]
+    }
+  }
+}
+
+describe('test trace sync actions', () => {
   it('should start trace correctly', () => {
     const store = mockStore({
       traces: {
@@ -123,3 +192,96 @@ describe('test trace actions', () => {
     expect(actions[0].type).toEqual('TRACE_DISCARD')
   })
 })
+
+describe('trace upload / async actions', () => {
+  it('should upload a single trace', async () => {
+    const store = mockStore({
+      traces: {
+        traces: [
+          getMockTrace(1)
+        ]
+      }
+    })
+    fetch.resetMocks()
+    fetch.once(JSON.stringify(getMockTracePostResponse(1, 'fakeid')))
+    await store.dispatch(uploadPendingTraces())
+    const actions = store.getActions()
+    expect(actions).toMatchSnapshot()
+    expect(fetch.mock.calls).toMatchSnapshot()
+  })
+
+  it('should upload multiple pending traces', async () => {
+    const store = mockStore({
+      traces: {
+        traces: [
+          getMockTrace(1),
+          getMockTrace(2)
+        ]
+      }
+    })
+    fetch.resetMocks()
+    fetch.once(JSON.stringify(getMockTracePostResponse(1, 'fakeid-1')))
+      .once(JSON.stringify(getMockTracePostResponse(2, 'fakeid-2')))
+    await store.dispatch(uploadPendingTraces())
+    const actions = store.getActions()
+    expect(actions).toMatchSnapshot()
+    expect(fetch.mock.calls).toMatchSnapshot()
+  })
+
+  it('should not upload non-pending traces', async () => {
+    const trace1 = getMockTrace(1)
+    const trace2 = getMockTrace(2)
+    trace2.pending = false
+    const store = mockStore({
+      traces: {
+        traces: [
+          trace1,
+          trace2
+        ]
+      }
+    })
+    fetch.resetMocks()
+    fetch.once(JSON.stringify(getMockTracePostResponse(1, 'fakeid-1')))
+    await store.dispatch(uploadPendingTraces())
+    const actions = store.getActions()
+    expect(actions).toMatchSnapshot()
+    expect(fetch.mock.calls).toMatchSnapshot()
+  })
+
+  it('should not upload uploading traces', async () => {
+    const trace1 = getMockTrace(1)
+    trace1.uploading = true
+    const trace2 = getMockTrace(2)
+    const store = mockStore({
+      traces: {
+        traces: [
+          trace1,
+          trace2
+        ]
+      }
+    })
+    fetch.resetMocks()
+    fetch.once(JSON.stringify(getMockTracePostResponse(2, 'fakeid-2')))
+    await store.dispatch(uploadPendingTraces())
+    const actions = store.getActions()
+    expect(actions).toMatchSnapshot()
+    expect(fetch.mock.calls).toMatchSnapshot()
+  })
+
+  it('should add error to the trace for an error response', async () => {
+    const trace1 = getMockTrace(1)
+    const store = mockStore({
+      traces: {
+        traces: [
+          trace1
+        ]
+      }
+    })
+    fetch.resetMocks()
+    fetch.once(JSON.stringify({ 'message': 'Unknown error' }), { status: 500 })
+    await store.dispatch(uploadPendingTraces())
+    const actions = store.getActions()
+    expect(actions).toMatchSnapshot()
+    expect(fetch.mock.calls).toMatchSnapshot()
+  })
+})