feat(content): has many expand (#50)

* feat: add has many params to interfaces

* feat: add single type view example with hasMany

* feat: update tests

* feat: add expand hasMany components logic

* feat: cleanup

* feat: update query for expand data

* feat: get expand route properties

* feat: replace entities helper

* feat: add tests

* feat: hasMany parse

* feat(single-type-service): update tests

* refactor: update types

* refactor: update validation for requested expand data

* feat(expand-route-input): add attributes and relations params

* feat(expand-route-input): handle relations and attributes for entities

* feat: update http request examples

* feat: cleanup

* feat(http-requests): update examples

* feat: cleanup

* feat(http-requests): update examples

Author: OlegDO

http-requests/content/requests.http

@@ -209,8 +209,12 @@ Content-Type: application/json
                     "contentDate": "2023-05-28T13:56:55.360Z",
                     "contentDescription": "contentTitle",
                     "contentCreators": [
-                      "b9b61ca6-761b-4051-84b2-647a2262b78b",
-                      "a5326de3-d04c-425c-8711-0f99fc031c67"
+                      {
+                        "id": "b9b61ca6-761b-4051-84b2-647a2262b78b"
+                      },
+                      {
+                        "id": "a5326de3-d04c-425c-8711-0f99fc031c67"
+                      }
                     ]
                   }
                 }
@@ -237,7 +241,110 @@ Content-Type: application/json
   }
 }
 
-### View signle type
+### Create single type with the hasMany component for page
+POST http://127.0.0.1:8001/ms/content
+Accept: application/json
+Content-Type: application/json
+
+{
+  "id": "1",
+  "method": "single-type.create",
+  "params": {
+    "fields": {
+      "components": [
+        {
+          "id": "dff2719e-3c57-4248-9408-59af6287a568"
+        }
+      ],
+      "title": "Page single type",
+      "alias": "pageSingleType",
+      "value": {
+        "blogPostPage": {
+          "id": "dff2719e-3c57-4248-9408-59af6287a568",
+          "data": {
+            "header": {
+              "id": "9a7aedb4-4b00-44b3-89a3-a535692d28d6",
+              "data": {
+                "pageHeader": {
+                  "id": "9a7aedb4-4b00-44b3-89a3-a535692d28d6",
+                  "data": {
+                    "headerTitle": "Cars",
+                    "postNumber": 1
+                  }
+                }
+              }
+            },
+            "content": {
+              "id": "e6186469-a9a5-444c-812c-c801c95245b8",
+              "data": {
+                "pageContent": {
+                  "id": "e6186469-a9a5-444c-812c-c801c95245b8",
+                  "data": [
+                    {
+                      "contentTitle": "Green Lamborghini",
+                      "contentDate": "2023-05-28T13:56:55.360Z",
+                      "contentDescription": "contentTitle",
+                      "contentCreators": [
+                        {
+                          "id": "b9b61ca6-761b-4051-84b2-647a2262b78b"
+                        },
+                        {
+                          "id": "a5326de3-d04c-425c-8711-0f99fc031c67"
+                        }
+                      ]
+                    },
+                    {
+                      "contentTitle": "White Lamborghini",
+                      "contentDate": "2023-05-28T13:56:55.360Z",
+                      "contentDescription": "contentTitle",
+                      "contentCreators": [
+                        {
+                          "id": "m9b61ca6-761b-4051-84b2-647a2262b78b"
+                        },
+                        {
+                          "id": "z5326de3-d04c-425c-8711-0f99fc031c67"
+                        }
+                      ]
+                    },
+                    {
+                      "contentTitle": "Blue Lamborghini",
+                      "contentDate": "2023-05-28T13:56:55.360Z",
+                      "contentDescription": "contentTitle",
+                      "contentCreators": [
+                        {
+                          "id": "p9b61ca6-761b-4051-84b2-647a2262b78b"
+                        },
+                        {
+                          "id": "o5326de3-d04c-425c-8711-0f99fc031c67"
+                        }
+                      ]
+                    }
+                  ]
+                }
+              }
+            },
+            "footer": {
+              "id": "78567003-f8cb-4d92-8aab-d7c9dc88bf2e",
+              "data": {
+                "id": "78567003-f8cb-4d92-8aab-d7c9dc88bf2e",
+                "pageFooter": {
+                  "contactUsWithTheEmail": "[email protected]",
+                  "isThisPostRecommendedByUS": true
+                }
+              }
+            },
+            "options": {
+              "timeZoneId": "America/Los_Angeles",
+              "timeZoneName": "Pacific Daylight Time"
+            }
+          }
+        }
+      }
+    }
+  }
+}
+
+### View signle type with users (profile) relations
 POST http://127.0.0.1:8001/ms/content
 Accept: application/json
 Content-Type: application/json
@@ -253,7 +360,36 @@ Content-Type: application/json
     },
     "payload": {
       "expand": [
-        "blogPostPage.content.pageContent.contentCreators"
+        {
+          "route": "blogPostPage.content.pageContent.contentCreators",
+          "relations": ["profile"]
+        }
+      ]
+    }
+  }
+}
+
+### View signle type with users atributes
+### NOTE: Provide always primary keys to attributes
+POST http://127.0.0.1:8001/ms/content
+Accept: application/json
+Content-Type: application/json
+
+{
+  "id": "1",
+  "method": "single-type.view",
+  "params": {
+    "query": {
+      "where": {
+        "id": "3cff317c-8ece-45b0-b0bb-0021760f06c2"
+      }
+    },
+    "payload": {
+      "expand": [
+        {
+          "route": "blogPostPage.content.pageContent.contentCreators",
+          "attributes": ["id", "firstName"]
+        }
       ]
     }
   }
@@ -541,3 +677,106 @@ Authorization: Bearer usertokenoooooooooooooooooooooon
     }
   }
 }
+
+### Additional
+### Create single type for page with hasMany
+POST http://127.0.0.1:8001/ms/content
+Accept: application/json
+Content-Type: application/json
+
+{
+  "id": "1",
+  "method": "single-type.create",
+  "params": {
+    "fields": {
+      "components": [
+        {
+          "id": "e5d4c33f-cd63-437a-a76b-bd798121ce15"
+        }
+      ],
+      "title": "Page single type",
+      "alias": "pageSingleTypeNew",
+      "value": {
+        "blogPostPage": {
+          "id": "e5d4c33f-cd63-437a-a76b-bd798121ce15",
+          "data": {
+            "header": {
+              "id": "43edbae4-ec2f-4a32-a477-b1cfc8bb3673",
+              "data": {
+                "pageHeader": {
+                  "id": "43edbae4-ec2f-4a32-a477-b1cfc8bb3673",
+                  "data": {
+                    "headerTitle": "Cars",
+                    "postNumber": 1
+                  }
+                }
+              }
+            },
+            "content": {
+              "id": "cc896aa8-1734-4556-94c1-fcbf849d520c",
+              "data": {
+                "pageContent": {
+                  "id": "cc896aa8-1734-4556-94c1-fcbf849d520c",
+                  "data": [
+                    {
+                      "contentTitle": "Green Lamborghini",
+                      "contentDate": "2023-05-28T13:56:55.360Z",
+                      "contentDescription": "contentTitle1",
+                      "contentCreators": [
+                        "a5326de3-d04c-425c-8711-0f99fc031c67"
+                      ]
+                    },
+                    {
+                      "contentTitle": "Blue Lamborghini",
+                      "contentDate": "2023-05-28T13:56:55.360Z",
+                      "contentDescription": "contentTitle2",
+                      "contentCreators": [
+                        "b9b61ca6-761b-4051-84b2-647a2262b78b"
+                      ]
+                    }
+                  ]
+                }
+              }
+            },
+            "footer": {
+              "id": "1fddf950-159f-419c-b006-eb07a51f7857",
+              "data": {
+                "id": "1fddf950-159f-419c-b006-eb07a51f7857",
+                "pageFooter": {
+                  "contactUsWithTheEmail": "[email protected]",
+                  "isThisPostRecommendedByUS": true
+                }
+              }
+            },
+            "options": {
+              "timeZoneId": "America/Los_Angeles",
+              "timeZoneName": "Pacific Daylight Time"
+            }
+          }
+        }
+      }
+    }
+  }
+}
+
+### View signle type
+POST http://127.0.0.1:8001/ms/content
+Accept: application/json
+Content-Type: application/json
+
+{
+  "id": "1",
+  "method": "single-type.view",
+  "params": {
+    "query": {
+      "where": {
+        "id": "8b4d7fa9-4f61-4f6f-9737-01546cd07b4e"
+      }
+    },
+    "payload": {
+      "expand": [
+        "blogPostPage.content.pageContent.contentCreators"
+      ]
+    }
+  }
+}

microservices/content/__mocks__/single-type-view-process.ts

@@ -1,4 +1,4 @@
-const adminsRelationMock = ['blog.admins'];
+const adminsRelationMock = [{ route: 'blog.admins' }];
 
 const adminsSingleTypeMock = {
   alias: 'blog',

microservices/content/__tests__/helpers/replace-entities-test.ts

@@ -0,0 +1,58 @@
+import { expect } from 'chai';
+import sinon from 'sinon';
+import replaceEntities from '@helpers/replace-entities';
+
+describe('helpers/replace-entities', () => {
+  const originalEntities = [
+    { cardId: 1, userId: 2 },
+    { cardId: 2, userId: 3 },
+  ];
+
+  it('should update original data with matching values from updated data', () => {
+    const updatedEntities = [
+      { cardId: 1, userId: 2, name: 'Alex' },
+      { cardId: 2, userId: 3, name: 'Oleg' },
+    ];
+
+    const result = replaceEntities(originalEntities, updatedEntities);
+
+    expect(result).to.deep.equal(updatedEntities);
+  });
+
+  it('should return empty array if matches not found and should clear is true', () => {
+    const updatedData = [
+      { cardId: 1, userId: 5, name: 'Alex' },
+      { cardId: 2, userId: 5, name: 'Oleg' },
+    ];
+
+    const result = replaceEntities(originalEntities, updatedData);
+
+    expect(result).to.deep.equal([]);
+  });
+
+  it('should return empty original entities if matches not found and should clear is true', () => {
+    const updatedData = [
+      { cardId: 1, userId: 5, name: 'Alex' },
+      { cardId: 2, userId: 5, name: 'Oleg' },
+    ];
+
+    const result = replaceEntities(originalEntities, updatedData, false);
+
+    expect(result).to.deep.equal(originalEntities);
+  });
+
+  it('should update original data with matching values', () => {
+    const spy = sinon.spy(Object, 'assign');
+    const usersData = [{ id: 'id-1' }, { id: 'id-2' }];
+    const usersResultData = [
+      { id: 'id-1', name: 'Alex' },
+      { id: 'id-2', name: 'Oleg' },
+    ];
+
+    const result = replaceEntities(usersData, usersResultData);
+
+    expect(result).to.deep.equal(usersData);
+    expect(spy.callCount).to.equal(2);
+    spy.restore();
+  });
+});

microservices/content/__tests__/services/single-type-view-process-test.ts

@@ -28,7 +28,7 @@ describe('services/single-type-view-process', () => {
   });
 
   it('should throw error: incorrect relation routes', async () => {
-    const relations = ['relation/admins'];
+    const relations = [{ route: 'relation/admins' }];
     const service = SingleTypeViewProcess.init({
       // @ts-ignore
       entity: {},
@@ -84,7 +84,7 @@ describe('services/single-type-view-process', () => {
 
     expect(await waitResult(service.expand(adminsRelationMock))).to.throw(
       BaseException,
-      'Failed to get one or more expanded routes according to the passed relationship routes',
+      'Failed to get one or more expanded routes according to the provided relationship routes.',
     );
   });
 
@@ -96,7 +96,7 @@ describe('services/single-type-view-process', () => {
       singleTypeRepository,
     });
 
-    const [route] = adminsRelationMock;
+    const [{ route }] = adminsRelationMock;
 
     const handleRelationsStub = sinon.stub(componentRepository, 'handleRelations');
 
@@ -111,10 +111,10 @@ describe('services/single-type-view-process', () => {
      * that's the reason of usage ts-ignore
      */
     // @ts-ignore
-    const getExpandDataStub = sinon.stub(service, 'getExpandData');
+    const handleExpandStub = sinon.stub(service, 'handleExpand');
 
     // @ts-ignore
-    getExpandDataStub.resolves({ data: adminsMock, routeRef: route } as IExpandData);
+    handleExpandStub.resolves({ data: adminsMock, routeRef: route } as IExpandData);
 
     const adminsSingleType = { ...adminsSingleTypeMock };
 

microservices/content/src/helpers/get-expand-route-properties.ts

@@ -0,0 +1,15 @@
+interface IProperties {
+  properties: string[];
+  lastIndex: number;
+}
+
+/**
+ * Returns expand route properties and last index
+ */
+const getExpandRouteProperties = (route: string): IProperties => {
+  const properties = route.split('.');
+
+  return { properties, lastIndex: properties.length - 1 };
+};
+
+export default getExpandRouteProperties;