Normalize still works when server does not send an 'included' or when relationship is null

Author: andrepcg

src/functions/find-items.ts

@@ -18,10 +18,14 @@ export function findItems(response: any, temp: any) {
         throw '[Normalize] [JSON:API Syntax Error] A data relationship item does not contain id field!';
     }
     const result = [];
-    // Adding all found results
-    result.push(
-        response.included.find((item: any) => (String(item.id) === String(temp.id)) &&
-            (String(item.type) === String(temp.type))),
-    );
+
+    // If response has a 'included' property then look for results
+    if (response.hasOwnProperty('included')) {
+        // Adding all found results
+        result.push(
+            response.included.find((item: any) => (String(item.id) === String(temp.id)) &&
+                (String(item.type) === String(temp.type))),
+        );
+    }
     return result;
 }

src/index.ts

@@ -47,6 +47,12 @@ export default function normalize(response: any) {
         // Using a for loop to go through all relationships of every item in data
         for (const key of Object.keys(item.relationships)) {
             const relation = item.relationships[key];
+
+            // Skip if relationship is not present
+            if (!relation.data) {
+                continue;
+            }
+
             // Checking if there is only one relationship stored in an object
             if (relation.data.constructor === Array) {
                 // Checking if a data relationship item has type field

src/test/normalize.spec.ts

@@ -0,0 +1,79 @@
+/*
+* Validation test file
+* Description: This file contains tests which check if any modifications
+* make the new code incompatible with the old one.
+*/
+
+// Importing the normalize function
+import normalize from '../index';
+// Importing mocha and chai for the tests
+import { expect } from 'chai';
+import 'mocha';
+
+// Creating the test set
+describe('normalize test', () => {
+    it('should normalize when included relationship is null', () => {
+        const test = {
+           "data":[
+              {
+                 "id":"3",
+                 "type":"conversation",
+                 "attributes":{
+                    "subject":"Test subject"
+                 },
+                 "relationships":{
+                    "last_message":{
+                       "data":{ type: "people", id: "9" }
+                    }
+                 }
+              },
+           ],
+           "included": [],
+        };
+        expect(() => normalize(test)).to.not.throw();
+        const normalized = normalize(test);
+        expect(normalized).to.have.property('conversation');
+    });
+    it('should normalize when property "included" is undefined', () => {
+        const test = {
+           "data":[
+              {
+                 "id":"3",
+                 "type":"conversation",
+                 "attributes":{
+                    "subject":"Test subject"
+                 },
+                 "relationships":{
+                    "last_message":{
+                       "data":{ type: "people", id: "9" }
+                    }
+                 }
+              },
+           ],
+        };
+        expect(() => normalize(test)).to.not.throw();
+        const normalized = normalize(test);
+        expect(normalized).to.have.property('conversation');
+    });
+    it('should normalize when property "included" is undefined and relationship is null', () => {
+        const test = {
+           "data":[
+              {
+                 "id":"3",
+                 "type":"conversation",
+                 "attributes":{
+                    "subject":"Test subject"
+                 },
+                 "relationships":{
+                    "last_message":{
+                       "data": null
+                    }
+                 }
+              },
+           ],
+        };
+        expect(() => normalize(test)).to.not.throw();
+        const normalized = normalize(test);
+        expect(normalized).to.have.property('conversation');
+    });
+});

src/test/validate.spec.ts

@@ -51,4 +51,10 @@ describe('Validation test', () => {
             validate(test);
         }).to.throw('[Normalize] [JSON:API Syntax Error] Not all data items are the same type!');
     });
-});
+    it('should throw that not all data items are the same type', () => {
+        const test = { data: [{ type: 'article' }, { type: 'person' }] };
+        expect(() => {
+            validate(test);
+        }).to.throw('[Normalize] [JSON:API Syntax Error] Not all data items are the same type!');
+    });
+});