feat: improve the function based mockdata (#129)

* feat: improve the function based mockdata * fix: small adjustment for tests * chore: improve code quality * Update sour-points-rush.md
SAP · Jun 7, 2022 · 32c6142 · 32c6142
1 parent 3e3b257
commit 32c6142
Show file tree

Hide file tree

Showing 19 changed files with 815 additions and 376 deletions.
diff --git a/.changeset/sour-points-rush.md b/.changeset/sour-points-rush.md
@@ -0,0 +1,6 @@
+---
+'@sap-ux/fe-mockserver-core': minor
+'@sap-ux/ui5-middleware-fe-mockserver': minor
+---
+
+Improve the function based mockdata API
diff --git a/packages/fe-mockserver-core/src/data/common.ts b/packages/fe-mockserver-core/src/data/common.ts
@@ -7,8 +7,8 @@ import type { IFileLoader } from '../index';
 
 export interface EntitySetInterface {
     checkKeyValue(mockData: object, keyValues: object, keyName: string, keyProp?: Property): boolean;
-    checkFilter(mockData: object, filterExpression: any, tenantId: string): boolean;
-    checkSearch(mockData: object, searchQueries: string[]): boolean;
+    checkFilter(mockData: object, filterExpression: any, tenantId: string, odataRequest: ODataRequest): boolean;
+    checkSearch(mockData: object, searchQueries: string[], odataRequest: ODataRequest): boolean;
     executeAction(
         actionDefinition: Action,
         actionData: object | undefined,
@@ -19,12 +19,29 @@ export interface EntitySetInterface {
         keyValues: KeyDefinitions,
         asArray: boolean,
         tenantId: string,
-        dontClone?: boolean,
-        odataRequest?: ODataRequest
+        odataRequest: ODataRequest,
+        dontClone?: boolean
+    ): Promise<any>;
+    performPOST(
+        keyValues: KeyDefinitions,
+        postData: any,
+        tenantId: string,
+        odataRequest: ODataRequest,
+        _updateParent?: boolean
+    ): Promise<any>;
+    performPATCH(
+        keyValues: KeyDefinitions,
+        patchData: object,
+        tenantId: string,
+        odataRequest: ODataRequest,
+        _updateParent?: boolean
     ): Promise<any>;
-    performPOST(keyValues: KeyDefinitions, postData: any, tenantId: string, _updateParent?: boolean): Promise<any>;
-    performPATCH(keyValues: KeyDefinitions, patchData: object, tenantId: string, _updateParent?: boolean): Promise<any>;
-    performDELETE(keyValues: KeyDefinitions, tenantId: string, _updateParent?: boolean): Promise<void>;
+    performDELETE(
+        keyValues: KeyDefinitions,
+        tenantId: string,
+        odataRequest: ODataRequest,
+        _updateParent?: boolean
+    ): Promise<void>;
     getParentEntityInterface(tenantId: string): Promise<FileBasedMockData | undefined>;
     getEntityInterface(entitySetName: string, tenantId: string): Promise<FileBasedMockData | undefined>;
     getMockData(tenantId: string): FileBasedMockData;

diff --git a/packages/fe-mockserver-core/src/data/dataAccess.ts b/packages/fe-mockserver-core/src/data/dataAccess.ts
@@ -339,7 +339,8 @@ export class DataAccess implements DataAccessInterface {
         requestExpandObject: Record<string, ExpandDefinition>,
         tenantId: string,
         previousEntitySet: EntitySet | Singleton | undefined,
-        visitedPaths: string[]
+        visitedPaths: string[],
+        odataRequest: ODataRequest
     ) {
         if (data === null) {
             return;
@@ -361,7 +362,7 @@ export class DataAccess implements DataAccessInterface {
                 if (navProp && !navProp.containsTarget) {
                     let expandData = dataLine[expandNavProp];
                     if (!expandData) {
-                        expandData = navEntitySet.performGET(currentKeys, navProp.isCollection, tenantId);
+                        expandData = navEntitySet.performGET(currentKeys, navProp.isCollection, tenantId, odataRequest);
                         dataLine[expandNavProp] = expandData;
                     }
                     const expandDetail = requestExpandObject[expandNavProp];
@@ -376,7 +377,8 @@ export class DataAccess implements DataAccessInterface {
                                     expandDetail.expand,
                                     tenantId,
                                     targetEntitySet,
-                                    []
+                                    [],
+                                    odataRequest
                                 );
                             })
                         );
@@ -579,7 +581,7 @@ export class DataAccess implements DataAccessInterface {
                         targetContainedEntityType,
                         targetContainedData
                     )
-                ).performGET(currentKeys, asArray, odataRequest.tenantId, dontClone, odataRequest);
+                ).performGET(currentKeys, asArray, odataRequest.tenantId, odataRequest, dontClone);
             },
             Promise.resolve({})
         );
@@ -626,7 +628,8 @@ export class DataAccess implements DataAccessInterface {
                             odataRequest.expandProperties,
                             odataRequest.tenantId,
                             previousEntitySet,
-                            visitedPaths
+                            visitedPaths,
+                            odataRequest
                         );
                     })
                 );
@@ -639,14 +642,14 @@ export class DataAccess implements DataAccessInterface {
                     currentEntitySet ? currentEntitySet.name : currentEntityType.name
                 );
                 data = data.filter((dataLine) => {
-                    return mockEntitySet.checkFilter(dataLine, filterDef, odataRequest.tenantId);
+                    return mockEntitySet.checkFilter(dataLine, filterDef, odataRequest.tenantId, odataRequest);
                 });
             }
             // Apply $search
             if (odataRequest.searchQuery && Array.isArray(data)) {
                 const mockEntitySet = await this.getMockEntitySet(currentEntityType.name);
                 data = data.filter((dataLine) => {
-                    return mockEntitySet.checkSearch(dataLine, odataRequest.searchQuery);
+                    return mockEntitySet.checkSearch(dataLine, odataRequest.searchQuery, odataRequest);
                 });
             }
 
@@ -880,6 +883,7 @@ export class DataAccess implements DataAccessInterface {
             odataRequest.queryPath[0].keys,
             patchData,
             odataRequest.tenantId,
+            odataRequest,
             true
         );
     }
@@ -899,6 +903,7 @@ export class DataAccess implements DataAccessInterface {
                 odataRequest.queryPath[0].keys,
                 false,
                 odataRequest.tenantId,
+                odataRequest,
                 true
             );
 
@@ -932,6 +937,7 @@ export class DataAccess implements DataAccessInterface {
                     currentKeys,
                     postData,
                     odataRequest.tenantId,
+                    odataRequest,
                     true
                 );
             } else {
@@ -953,6 +959,7 @@ export class DataAccess implements DataAccessInterface {
                 currentKeys,
                 postData,
                 odataRequest.tenantId,
+                odataRequest,
                 true
             );
             odataRequest.setContext(`../$metadata#${entitySet.name}/$entity`);
@@ -972,7 +979,7 @@ export class DataAccess implements DataAccessInterface {
     public async deleteData(odataRequest: ODataRequest) {
         const entitySetName = odataRequest.queryPath[0].path;
         const mockEntitySet = await this.getMockEntitySet(entitySetName);
-        return mockEntitySet.performDELETE(odataRequest.queryPath[0].keys, odataRequest.tenantId, true);
+        return mockEntitySet.performDELETE(odataRequest.queryPath[0].keys, odataRequest.tenantId, odataRequest, true);
     }
     public async getDraftRoot(keyValues: KeyDefinitions, _tenantId: string, entitySetDefinition: EntitySet) {
         let data = {};