avoid interpreting array properties as embedded collections

Author: usu

src/StoreValue.ts

@@ -40,8 +40,8 @@ class StoreValue implements Resource {
       .forEach(key => {
         const value = storeData[key]
 
-        // storeData[key] is an embedded collection
-        if (Array.isArray(value)) {
+        // storeData[key] is an embedded collection (need min. 1 item to detect an embedded collection)
+        if (Array.isArray(value) && value.length > 0 && isEntityReference(value[0])) {
           // build complete Collection class = EmbeddedCollection + HasItems mixin
           const EmbeddedCollectionClass = HasItems(EmbeddedCollection, this.apiActions, this.config, storeData._meta.self, key)
 

tests/resources/array-property.json

@@ -0,0 +1,40 @@
+{
+  "serverResponse": {
+    "id": 1,
+    "arrayProperty": [
+      {
+        "a": 1,
+        "nested": [
+          {
+            "b": 2
+          }
+        ]
+      }
+    ],
+    "emptyArray": [],
+    "_links": {
+      "self": {
+        "href": "/camps/1"
+      }
+    }
+  },
+  "storeState": {
+    "/camps/1": {
+      "id": 1,
+      "arrayProperty": [
+        {
+          "a": 1,
+          "nested": [
+            {
+              "b": 2
+            }
+          ]
+        }
+      ],
+      "emptyArray": [],
+      "_meta": {
+        "self": "/camps/1"
+      }
+    }
+  }
+}

tests/resources/embedded-linked-collection.json

@@ -0,0 +1,101 @@
+{
+  "serverResponse": {
+    "id": 1,
+    "_embedded": {
+      "periods": [
+        {
+          "id": 104,
+          "start": "01-01-2019",
+          "end": "03-01-2019",
+          "_links": {
+            "self": {
+              "href": "/periods/104"
+            },
+            "camp": {
+              "href": "/camps/1"
+            },
+            "activities": {
+              "href": "/periods/104/activities"
+            }
+          }
+        },
+        {
+          "id": 128,
+          "start": "12-04-2019",
+          "end": "19-04-2019",
+          "_links": {
+            "self": {
+              "href": "/periods/128"
+            },
+            "camp": {
+              "href": "/camps/1"
+            },
+            "activities": {
+              "href": "/periods/128/activities"
+            }
+          }
+        }
+      ]
+    },
+    "_links": {
+      "self": {
+        "href": "/camps/1"
+      },
+      "periods": {
+        "href": "/camps/1/periods"
+      }
+    }
+  },
+  "storeState": {
+    "/periods/104": {
+      "id": 104,
+      "start": "01-01-2019",
+      "end": "03-01-2019",
+      "camp": {
+        "href": "/camps/1"
+      },
+      "activities": {
+        "href": "/periods/104/activities"
+      },
+      "_meta": {
+        "self": "/periods/104"
+      }
+    },
+    "/periods/128": {
+      "id": 128,
+      "start": "12-04-2019",
+      "end": "19-04-2019",
+      "camp": {
+        "href": "/camps/1"
+      },
+      "activities": {
+        "href": "/periods/128/activities"
+      },
+      "_meta": {
+        "self": "/periods/128"
+      }
+    },
+    "/camps/1": {
+      "id": 1,
+      "periods": {
+        "href": "/camps/1/periods"
+      },
+      "_meta": {
+        "self": "/camps/1"
+      }
+    },
+    "/camps/1/periods": {
+      "_meta": {
+        "self": "/camps/1/periods"
+      },
+      "items": [
+        {
+          "href": "/periods/104"
+        },
+        {
+          "href": "/periods/128"
+        }
+      ]
+    }
+  }
+}

tests/resources/object-property.json

@@ -0,0 +1,32 @@
+{
+  "serverResponse": {
+    "id": 1,
+    "objectProperty": {
+      "a": 1,
+      "nested": {
+        "b": 2
+      }
+    },
+    "emptyObject": {},
+    "_links": {
+      "self": {
+        "href": "/camps/1"
+      }
+    }
+  },
+  "storeState": {
+    "/camps/1": {
+      "id": 1,
+      "objectProperty": {
+        "a": 1,
+        "nested": {
+          "b": 2
+        }
+      },
+      "emptyObject": {},
+      "_meta": {
+        "self": "/camps/1"
+      }
+    }
+  }
+}

tests/store.spec.js

@@ -9,13 +9,16 @@ import { cloneDeep } from 'lodash'
 import embeddedSingleEntity from './resources/embedded-single-entity'
 import referenceToSingleEntity from './resources/reference-to-single-entity'
 import embeddedCollection from './resources/embedded-collection'
+import embeddedLinkedCollection from './resources/embedded-linked-collection'
 import linkedSingleEntity from './resources/linked-single-entity'
 import linkedCollection from './resources/linked-collection'
 import collectionFirstPage from './resources/collection-firstPage'
 import collectionPage1 from './resources/collection-page1'
 import circularReference from './resources/circular-reference'
 import multipleReferencesToUser from './resources/multiple-references-to-user'
 import templatedLink from './resources/templated-link'
+import objectProperty from './resources/object-property'
+import arrayProperty from './resources/array-property'
 import root from './resources/root'
 
 import LoadingStoreValue from '../src/LoadingStoreValue'
@@ -143,6 +146,26 @@ describe('API store', () => {
         expect(vm.api.get('/periods/128').camp()._meta.self).toEqual('http://localhost/camps/1')
       })
 
+      it('imports embedded collection with link', async () => {
+        // given
+        axiosMock.onGet('http://localhost/camps/1').reply(200, embeddedLinkedCollection.serverResponse)
+
+        // when
+        vm.api.get('/camps/1')
+
+        // then
+        expect(vm.$store.state.api).toMatchObject({ '/camps/1': { _meta: { self: '/camps/1', loading: true } } })
+        await letNetworkRequestFinish()
+        expect(vm.$store.state.api).toMatchObject(embeddedLinkedCollection.storeState)
+        expect(vm.api.get('/camps/1')._meta.self).toEqual('http://localhost/camps/1')
+        expect(vm.api.get('/camps/1').periods().items[0]._meta.self).toEqual('http://localhost/periods/104')
+        expect(vm.api.get('/camps/1').periods().items[1]._meta.self).toEqual('http://localhost/periods/128')
+        expect(vm.api.get('/periods/104')._meta.self).toEqual('http://localhost/periods/104')
+        expect(vm.api.get('/periods/104').camp()._meta.self).toEqual('http://localhost/camps/1')
+        expect(vm.api.get('/periods/128')._meta.self).toEqual('http://localhost/periods/128')
+        expect(vm.api.get('/periods/128').camp()._meta.self).toEqual('http://localhost/camps/1')
+      })
+
       it('imports linked single entity', async () => {
         // given
         axiosMock.onGet('http://localhost/camps/1').reply(200, linkedSingleEntity.serverResponse)
@@ -1404,6 +1427,46 @@ describe('API store', () => {
         // then
         await expect(load).rejects.toThrow('Error trying to patch \"/camps/1\" (status 422): Request failed with status code 422')
       })
+
+      it('can handle object property', async done => {
+        // given
+        axiosMock.onGet('http://localhost/camps/1').reply(200, objectProperty.serverResponse)
+
+        // when
+        vm.api.get('/camps/1')
+        await letNetworkRequestFinish()
+
+        // then
+        expect(vm.$store.state.api).toMatchObject(objectProperty.storeState)
+
+        expect(vm.api.get('/camps/1').objectProperty).toBeInstanceOf(Object)
+        expect(vm.api.get('/camps/1').objectProperty.a).toEqual(1)
+        expect(vm.api.get('/camps/1').objectProperty.nested.b).toEqual(2)
+
+        expect(vm.api.get('/camps/1').emptyObject).toBeInstanceOf(Object)
+        expect(vm.api.get('/camps/1').emptyObject).toEqual({})
+        done()
+      })
+
+      it('can handle array property', async done => {
+        // given
+        axiosMock.onGet('http://localhost/camps/1').reply(200, arrayProperty.serverResponse)
+
+        // when
+        vm.api.get('/camps/1')
+        await letNetworkRequestFinish()
+
+        // then
+        expect(vm.$store.state.api).toMatchObject(arrayProperty.storeState)
+
+        expect(vm.api.get('/camps/1').arrayProperty).toBeInstanceOf(Array)
+        expect(vm.api.get('/camps/1').arrayProperty[0].a).toEqual(1)
+        expect(vm.api.get('/camps/1').arrayProperty[0].nested[0].b).toEqual(2)
+
+        expect(vm.api.get('/camps/1').emptyArray).toBeInstanceOf(Array)
+        expect(vm.api.get('/camps/1').emptyArray).toEqual([])
+        done()
+      })
     })
   })
 })