Better handling of includes for 'clearOnUpdate'

- Includes must come after 'get' has cleared the store
- Includes must use mergeRecords, or they too will clear the store

Author: mrichar1

package.json

@@ -17,7 +17,7 @@
     "babel-polyfill": "^6.26.0",
     "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
-    "chromedriver": "91",
+    "chromedriver": "^93",
     "concurrently": "^6.2.1",
     "core-js": "^3.16.1",
     "eslint": "^7.32.0",
@@ -49,7 +49,7 @@
     "vuex": "^4.0.0"
   },
   "name": "jsonapi-vuex",
-  "version": "5.3.0",
+  "version": "5.4.0",
   "description": "Access restructured JSONAPI data from a Vuex Store.",
   "keywords": [
     "vue",

src/actions.js

@@ -85,7 +85,6 @@ const actions = (api, conf) => {
       config['data'] = config['data'] || {}
       merge(apiConf, config)
       return api(apiConf).then((results) => {
-        utils.processIncludedRecords(context, results)
         let resData = utils.jsonapiToNorm(results.data.data)
         context.commit('addRecords', resData)
         if (conf.clearOnUpdate) {
@@ -97,6 +96,7 @@ const actions = (api, conf) => {
           }
           context.commit('clearRecords', record)
         }
+        utils.processIncludedRecords(context, results)
         resData = utils.checkAndFollowRelationships(context.state, context.getters, resData)
         resData = utils.preserveJSON(resData, results.data)
         return resData

src/lib.js

@@ -500,7 +500,7 @@ const Utils = class {
   processIncludedRecords(context, results) {
     for (let item of get(results, ['data', 'included'], [])) {
       const includedItem = this.jsonapiToNormItem(item)
-      context.commit('addRecords', includedItem)
+      context.commit('mergeRecords', includedItem)
     }
   }
 

tests/unit/actions/get.spec.js

@@ -114,8 +114,8 @@ describe('get', function () {
     // for a real API call, would need axios include params here
     await jsonapiModule.actions.get(stubContext, normWidget1)
 
-    expect(stubContext.commit).to.have.been.calledWith('addRecords', normWidget2)
-    expect(stubContext.commit).to.have.been.calledWith('addRecords', normMachine1)
+    expect(stubContext.commit).to.have.been.calledWith('mergeRecords', normWidget2)
+    expect(stubContext.commit).to.have.been.calledWith('mergeRecords', normMachine1)
   })
 
   it('should return normalized data with expanded rels (single item)', async function () {

tests/unit/jsonapi-vuex.spec.js

@@ -308,7 +308,7 @@ describe('jsonapi-vuex tests', function () {
       it('should process included records', function () {
         jsonWidget1['included'] = [jsonWidget2]
         utils.processIncludedRecords(stubContext, { data: jsonWidget1 })
-        expect(stubContext.commit).to.have.been.calledWith('addRecords')
+        expect(stubContext.commit).to.have.been.calledWith('mergeRecords')
       })
     })
 

yarn.lock

@@ -2229,6 +2229,13 @@ axios@^0.21.1:
   dependencies:
     follow-redirects "^1.10.0"
 
+axios@^0.21.2:
+  version "0.21.4"
+  resolved "https://registry.yarnpkg.com/axios/-/axios-0.21.4.tgz#c67b90dc0568e5c1cf2b0b858c43ba28e2eda575"
+  integrity sha512-ut5vewkiu8jjGBdqpM44XxjuCjq9LAKeHVmoVfHVzy8eHgxxq8SbAVQNovDA8mVi05kP0Ea/n/UzcSHcTJQfNg==
+  dependencies:
+    follow-redirects "^1.14.0"
+
 babel-eslint@^10.1.0:
   version "10.1.0"
   resolved "https://registry.yarnpkg.com/babel-eslint/-/babel-eslint-10.1.0.tgz#6968e568a910b78fb3779cdd8b6ac2f479943232"
@@ -2879,13 +2886,13 @@ chrome-trace-event@^1.0.2:
   resolved "https://registry.yarnpkg.com/chrome-trace-event/-/chrome-trace-event-1.0.3.tgz#1015eced4741e15d06664a957dbbf50d041e26ac"
   integrity sha512-p3KULyQg4S7NIHixdwbGX+nFHkoBiA4YQmyWtjb8XngSKV124nJmRysgAeujbUVb15vh+RvFUfCPqU7rXk+hZg==
 
-chromedriver@91:
-  version "91.0.1"
-  resolved "https://registry.yarnpkg.com/chromedriver/-/chromedriver-91.0.1.tgz#4d70a569901e356c978a41de3019c464f2a8ebd0"
-  integrity sha512-9LktpHiUxM4UWUsr+jI1K1YKx2GENt6BKKJ2mibPj1Wc6ODzX/3fFIlr8CZ4Ftuyga+dHTTbAyPWKwKvybEbKA==
+chromedriver@^93:
+  version "93.0.1"
+  resolved "https://registry.yarnpkg.com/chromedriver/-/chromedriver-93.0.1.tgz#3ed1f7baa98a754fc1788c42ac8e4bb1ab27db32"
+  integrity sha512-KDzbW34CvQLF5aTkm3b5VdlTrvdIt4wEpCzT2p4XJIQWQZEPco5pNce7Lu9UqZQGkhQ4mpZt4Ky6NKVyIS2N8A==
   dependencies:
     "@testim/chrome-version" "^1.0.7"
-    axios "^0.21.1"
+    axios "^0.21.2"
     del "^6.0.0"
     extract-zip "^2.0.1"
     https-proxy-agent "^5.0.0"
@@ -4942,6 +4949,11 @@ follow-redirects@^1.0.0, follow-redirects@^1.10.0:
   resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.14.1.tgz#d9114ded0a1cfdd334e164e6662ad02bfd91ff43"
   integrity sha512-HWqDgT7ZEkqRzBvc2s64vSZ/hfOceEol3ac/7tKwzuvEyWx3/4UegXh5oBOIotkGsObyk3xznnSRVADBgWSQVg==
 
+follow-redirects@^1.14.0:
+  version "1.14.4"
+  resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.14.4.tgz#838fdf48a8bbdd79e52ee51fb1c94e3ed98b9379"
+  integrity sha512-zwGkiSXC1MUJG/qmeIFH2HBJx9u0V46QGUe3YR1fXG8bXQxq7fLj0RjLZQ5nubr9qNJUZrH+xUcwXEoXNpfS+g==
+
 for-in@^1.0.2:
   version "1.0.2"
   resolved "https://registry.yarnpkg.com/for-in/-/for-in-1.0.2.tgz#81068d295a8142ec0ac726c6e2200c30fb6d5e80"