fix: unflatten relationships in their original attribute (#790)

Author: SteveBunlon

src/services/flattener.js

@@ -79,6 +79,24 @@ module.exports = class Flattener {
     return { parentObjectName, unflattenedObject };
   }
 
+  static _unwrapFlattenedReferences(request) {
+    if (!request.body.data.attributes) request.body.data.attributes = {};
+
+    const { attributes, relationships } = request.body.data;
+
+    Object.entries(relationships)
+      .filter(([attributeName]) => Flattener._isFieldFlattened(attributeName))
+      .forEach(([attributeName, value]) => {
+        const { parentObjectName, unflattenedObject } = Flattener._unflattenAttribute(
+          attributeName,
+          value.data?.id,
+          attributes,
+        );
+        attributes[parentObjectName] = _.merge(attributes[parentObjectName], unflattenedObject);
+        delete relationships[attributeName];
+      });
+  }
+
   static _unflattenAttributes(request) {
     Object.entries(request.body.data.attributes).forEach(([attributeName, value]) => {
       if (Flattener._isFieldFlattened(attributeName)) {
@@ -115,6 +133,9 @@ module.exports = class Flattener {
           Flattener._unflattenSubsetQuery(request);
         }
       }
+      if (!_.isEmpty(request.body?.data?.relationships)) {
+        Flattener._unwrapFlattenedReferences(request);
+      }
       if (!_.isEmpty(request.query?.fields)) {
         Flattener._unflattenFields(request);
       }

src/services/resource-creator.js

@@ -1,7 +1,6 @@
 import { Schemas } from 'forest-express';
 import utils from '../utils/schema';
 import ResourceGetter from './resource-getter';
-import Flattener from './flattener';
 
 class ResourceCreator {
   constructor(model, params, body, user) {
@@ -10,13 +9,6 @@ class ResourceCreator {
     this._body = body;
     this._user = user;
     this._schema = Schemas.schemas[utils.getModelName(model)];
-
-    /*
-      We unflatten the attributes here, because the deserializer validates the fields'
-      name against the schema so we can not do it in the middleware, we have to unflatten
-      at the very end of the record creation flow.
-     */
-    Flattener.unflattenFieldNamesInObject(this._body);
   }
 
   async _create() {

test/tests/services/flattener.test.js

@@ -572,41 +572,169 @@ describe('service > Flattener', () => {
     });
 
     describe('for a POST request', () => {
-      const mockResponse = {};
-      const mockNext = jest.fn();
-      const request = {
-        originalUrl: 'http://localhost:3311/forest/cars',
-        body: {
-          data: {
-            attributes: {
-              [`engine${FLATTEN_SEPARATOR}horsePower`]: '125cv',
-              [`engine${FLATTEN_SEPARATOR}identification${FLATTEN_SEPARATOR}serialNumber`]: '1234567',
-              name: 'Car',
+      const setupTest = () => ({
+        mockResponse: {},
+        mockNext: jest.fn(),
+        request: {
+          originalUrl: 'http://localhost:3311/forest/cars',
+          body: {
+            data: {
+              attributes: {
+                [`engine${FLATTEN_SEPARATOR}horsePower`]: '125cv',
+                [`engine${FLATTEN_SEPARATOR}identification${FLATTEN_SEPARATOR}serialNumber`]: '1234567',
+                name: 'Car',
+              },
+              relationships: {
+                [`engine${FLATTEN_SEPARATOR}identification${FLATTEN_SEPARATOR}company`]: {
+                  data: {
+                    type: 'companies',
+                    id: '5fd78361f8e514b2abe7044b',
+                  },
+                },
+                company: {
+                  data: {
+                    type: 'companies',
+                    id: '5fd78361f8e514b2abe7044b',
+                  },
+                },
+              },
             },
+            type: 'cars',
           },
         },
-      };
+      });
 
       it('should unflatten the attributes in the body', () => {
         expect.assertions(2);
 
+        const { request, mockResponse, mockNext } = setupTest();
+
         Flattener.requestUnflattener(request, mockResponse, mockNext);
 
-        expect(request.body).toStrictEqual({
-          data: {
-            attributes: {
-              engine: {
-                horsePower: '125cv',
-                identification: {
-                  serialNumber: '1234567',
-                },
-              },
-              name: 'Car',
+        const { attributes } = request.body.data;
+
+        expect(attributes).toStrictEqual({
+          engine: {
+            horsePower: '125cv',
+            identification: {
+              company: '5fd78361f8e514b2abe7044b',
+              serialNumber: '1234567',
             },
           },
+          name: 'Car',
         });
         expect(mockNext).toHaveBeenCalledTimes(1);
       });
+
+      describe('handling relationships', () => {
+        it('should not change the request if no relationship exits', () => {
+          expect.assertions(2);
+
+          const relationshipUnWrapperSpy = jest.spyOn(Flattener, '_unwrapFlattenedReferences');
+          const {
+            request,
+            mockResponse,
+            mockNext,
+          } = setupTest();
+
+          request.body.data.relationships = {};
+          const originalRequest = Object.assign(request);
+
+          Flattener.requestUnflattener(request, mockResponse, mockNext);
+
+          expect(originalRequest).toStrictEqual(request);
+          expect(relationshipUnWrapperSpy).not.toHaveBeenCalled();
+
+          relationshipUnWrapperSpy.mockClear();
+        });
+
+        it('should not change the request if relationships are not flattened ones', () => {
+          expect.assertions(2);
+
+          const relationshipUnWrapperSpy = jest.spyOn(Flattener, '_unwrapFlattenedReferences');
+          const {
+            request,
+            mockResponse,
+            mockNext,
+          } = setupTest();
+
+          delete request.body.data.relationships[`engine${FLATTEN_SEPARATOR}identification${FLATTEN_SEPARATOR}company`];
+          const originalRequest = Object.assign(request);
+
+          Flattener.requestUnflattener(request, mockResponse, mockNext);
+
+          expect(originalRequest).toStrictEqual(request);
+          expect(relationshipUnWrapperSpy).toHaveBeenCalledTimes(1);
+
+          relationshipUnWrapperSpy.mockClear();
+        });
+
+        it('should move flattened relationships in the original attribute', () => {
+          expect.assertions(4);
+
+          const {
+            request,
+            mockResponse,
+            mockNext,
+          } = setupTest();
+
+          Flattener.requestUnflattener(request, mockResponse, mockNext);
+
+          const { attributes, relationships } = request.body.data;
+
+          expect(attributes.engine.identification.company).toStrictEqual('5fd78361f8e514b2abe7044b');
+          expect(relationships[`engine${FLATTEN_SEPARATOR}identification${FLATTEN_SEPARATOR}company`]).toBeUndefined();
+          expect(relationships).toStrictEqual({
+            company: {
+              data: {
+                type: 'companies',
+                id: '5fd78361f8e514b2abe7044b',
+              },
+            },
+          });
+          expect(mockNext).toHaveBeenCalledTimes(1);
+        });
+
+        it('should correctly unwrap relationship even if original object is not present', () => {
+          expect.assertions(2);
+
+          const {
+            request,
+            mockResponse,
+            mockNext,
+          } = setupTest();
+
+          request.body.data.attributes = {
+            name: 'Car',
+          };
+
+          Flattener.requestUnflattener(request, mockResponse, mockNext);
+
+          const { attributes, relationships } = request.body.data;
+
+          expect(attributes.engine.identification.company).toStrictEqual('5fd78361f8e514b2abe7044b');
+          expect(relationships[`engine${FLATTEN_SEPARATOR}identification${FLATTEN_SEPARATOR}company`]).toBeUndefined();
+        });
+
+        it('should correctly unwrap relationship even if no attributes has been set', () => {
+          expect.assertions(2);
+
+          const {
+            request,
+            mockResponse,
+            mockNext,
+          } = setupTest();
+
+          request.body.data.attributes = undefined;
+
+          Flattener.requestUnflattener(request, mockResponse, mockNext);
+
+          const { attributes, relationships } = request.body.data;
+
+          expect(attributes.engine.identification.company).toStrictEqual('5fd78361f8e514b2abe7044b');
+          expect(relationships[`engine${FLATTEN_SEPARATOR}identification${FLATTEN_SEPARATOR}company`]).toBeUndefined();
+        });
+      });
     });
 
     describe('for a bulk delete', () => {