@contrail/flexplm 1.1.14 → 1.1.16

package/lib/util/data-converter.d.ts

@@ -7,6 +7,7 @@ export declare class DataConverter {
     private transformMapFile;
     private useDisplayForEnumerationMatching;
     private objRefCache;
+    private userRefCache;
     constructor(config: FCConfig, mapFileUtil: MapFileUtil);
     getFlexPLMObjectDataFromEvent(event: any, dataToSkip: string[]): Promise<{}>;
     getFlexPLMObjectData(newData: any, dataToSkip: string[], inflateObjRef: boolean): Promise<{}>;
@@ -19,4 +20,9 @@ export declare class DataConverter {
     getEntityValue(prop: any, data: any): Promise<any>;
     setEnumerationKeys(prop: any, nd: any, matchByDisplay: any): any;
     getPersistableChanges(entity: object, changes: object): object;
+    setUserListValue(prop: any, nd: any): Promise<any>;
+    getUserByEmail(nd: any): Promise<any>;
+    processGroupMemberCheck(prop: any, userEmail: any): Promise<void>;
+    getUserListValue(prop: any, newData: any): Promise<any>;
+    getUserById(userId: any): Promise<any>;
 }

package/lib/util/data-converter.js

@@ -13,6 +13,7 @@ class DataConverter {
         this.mapFileUtil = mapFileUtil;
         this.useDisplayForEnumerationMatching = false;
         this.objRefCache = {};
+        this.userRefCache = {};
         this.typeUtils = new type_utils_1.TypeUtils();
         this.transformMapFile = this.config['transformMapFile'];
         this.useDisplayForEnumerationMatching = this.config['dataConverter']
@@ -88,6 +89,9 @@ class DataConverter {
         else if ('json' === propertyType) {
             value = nd;
         }
+        else if ('userList' === propertyType) {
+            value = await this.getUserListValue(prop, newData);
+        }
         return value;
     }
     getEnumerationValue(prop, nd) {
@@ -194,8 +198,13 @@ class DataConverter {
         const dataKeys = Object.getOwnPropertyNames(data);
         typeProps = typeProps.filter(prop => dataKeys.includes(prop['slug']));
         for (const prop of typeProps) {
+            const propertyType = prop['propertyType'];
             const slug = prop['slug'];
-            entity[slug] = await this.getEntityValue(prop, data);
+            let keyName = slug;
+            if (propertyType === 'userList') {
+                keyName = slug + 'Id';
+            }
+            entity[keyName] = await this.getEntityValue(prop, data);
         }
         return entity;
     }
@@ -260,6 +269,9 @@ class DataConverter {
         }
         else if ('json' === propertyType) {
         }
+        else if ('userList' === propertyType) {
+            value = await this.setUserListValue(prop, nd);
+        }
         return value;
     }
     setEnumerationKeys(prop, nd, matchByDisplay) {
@@ -309,5 +321,103 @@ class DataConverter {
         }
         return diffValues;
     }
+    async setUserListValue(prop, nd) {
+        if (!nd?.email) {
+            return "";
+        }
+        if (this.userRefCache[nd.email]) {
+            if (app_framework_1.Logger.isDebugOn()) {
+                console.debug('user cache hit: ' + nd.email);
+            }
+            await this.processGroupMemberCheck(prop, nd.email);
+            return this.userRefCache[nd.email];
+        }
+        const user = await this.getUserByEmail(nd);
+        const userId = (user) ? user.id : undefined;
+        if (userId) {
+            this.userRefCache[nd.email] = userId;
+            await this.processGroupMemberCheck(prop, nd.email);
+        }
+        return userId;
+    }
+    async getUserByEmail(nd) {
+        let userOrg = undefined;
+        let count = 0;
+        let size = 0;
+        const entities = new sdk_1.Entities();
+        const getOptionsCriteria = {
+            entityName: 'user-org',
+            take: 1000
+        };
+        do {
+            const userBatch = await entities.get(getOptionsCriteria);
+            userOrg = userBatch.find(uo => uo?.userEmail === nd?.email);
+        } while (!userOrg && size == getOptionsCriteria.take && count < 15);
+        return userOrg?.user;
+    }
+    async processGroupMemberCheck(prop, userEmail) {
+        let arrUserList = [];
+        if (this.userRefCache[prop.typePropertyUserListId]) {
+            arrUserList = this.userRefCache[prop.typePropertyUserListId];
+        }
+        else {
+            const userListResult = await new sdk_1.Entities().get({
+                entityName: 'user-list',
+                id: prop.typePropertyUserListId
+            });
+            if (userListResult && Object.keys(userListResult).length) {
+                arrUserList = userListResult.userList;
+                this.userRefCache[prop.typePropertyUserListId] = arrUserList;
+            }
+        }
+        if (arrUserList.length) {
+            const result = arrUserList.find(element => element['display'] === userEmail);
+            if (!result) {
+                console.warn(`The passed in user ${userEmail} in property slug ${prop.slug} should be a member of the group associated with the property 'typePropertyUserListId'`);
+            }
+        }
+    }
+    async getUserListValue(prop, newData) {
+        const slug = prop['slug'];
+        if (app_framework_1.Logger.isDebugOn()) {
+            console.debug('getUserListValue-prop: ' + slug);
+        }
+        const entityId = newData[slug + 'Id'];
+        if (!entityId) {
+            return {};
+        }
+        if (this.userRefCache[entityId]) {
+            if (app_framework_1.Logger.isDebugOn()) {
+                console.debug('user cache hit: ' + entityId);
+            }
+            return this.userRefCache[entityId];
+        }
+        const user = await this.getUserById(entityId);
+        const value = (user) ? {
+            email: user.email,
+            firstName: user.first,
+            lastName: user.last,
+            isSsoUser: user.isSsoUser,
+        } : undefined;
+        if (value) {
+            this.userRefCache[entityId] = value;
+        }
+        return value;
+    }
+    async getUserById(userId) {
+        let userOrg = undefined;
+        let count = 0;
+        let size = 0;
+        const entities = new sdk_1.Entities();
+        const getOptionsCriteria = {
+            entityName: 'user-org',
+            take: 1000
+        };
+        do {
+            const userBatch = await entities.get(getOptionsCriteria);
+            userOrg = userBatch.find(uo => uo?.user?.id === userId);
+        } while (!userOrg && size == getOptionsCriteria.take && count < 15);
+        return userOrg?.user;
+    }
 }
 exports.DataConverter = DataConverter;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrail/flexplm",
-  "version": "1.1.14",
+  "version": "1.1.16",
   "description": "Library used for integration with flexplm.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",

package/src/util/data-converter.ts

@@ -1,7 +1,7 @@
 import { Entities, TypeClientOptions } from '@contrail/sdk';
 import { TypeUtils } from './type-utils';
 import { FCConfig } from '../interfaces/interfaces';
-import { MapFileUtil, TransformProcessor, TransformTask } from '@contrail/transform-data';
+import { MapFileUtil } from '@contrail/transform-data';
 import { Logger } from '@contrail/app-framework';
 import { ObjectDiff, ObjectUtil } from '@contrail/util';
 import { TypeConversionUtils } from './type-conversion-utils';
@@ -12,6 +12,7 @@ export class DataConverter {
   private transformMapFile: string;
   private useDisplayForEnumerationMatching = false;
   private objRefCache = {};
+  private userRefCache = {};
   constructor(private config: FCConfig, private mapFileUtil: MapFileUtil){
     this.typeUtils = new TypeUtils();
     this.transformMapFile = this.config['transformMapFile'];
@@ -95,6 +96,8 @@ export class DataConverter {
     }else if('json' === propertyType){
       // console.log('json-TODO');
       value = nd;
+    } else if ('userList' === propertyType) {
+      value = await this.getUserListValue(prop, newData);
     }
 
     return value;
@@ -234,9 +237,13 @@ export class DataConverter {
     typeProps = typeProps.filter( prop => dataKeys.includes(prop['slug']));
 
     for(const prop of typeProps){
-      // const propertyType = prop['propertyType'];
+      const propertyType = prop['propertyType'];
       const slug = prop['slug'];
-      entity[slug] = await this.getEntityValue(prop, data);
+      let keyName = slug;
+      if(propertyType === 'userList') {
+          keyName = slug + 'Id';
+      }
+      entity[keyName] = await this.getEntityValue(prop, data);
       // console.log('entity[slug]: ' + entity[slug]);
     }
 
@@ -324,6 +331,8 @@ export class DataConverter {
       // console.log('TODO-formula');
     } else if ('json' === propertyType) {
       // console.log('TODO-json');
+    } else if ('userList' === propertyType) {
+      value = await this.setUserListValue(prop, nd);
     }
 
     // console.log(value);
@@ -386,4 +395,156 @@ export class DataConverter {
 
   }
 
+  /** Sets userListId value from FlexPLM data passed in
+   * 
+   * @param prop the VibeIQ property
+   * @param nd the VibeIQ data
+   * @returns the modified entity with FlexPLM values
+   */
+  async setUserListValue(prop, nd) {
+    if(!nd?.email) {
+        return "";
+    }    
+
+    if (this.userRefCache[nd.email]) {
+        if (Logger.isDebugOn()) {
+            console.debug('user cache hit: ' + nd.email);
+        }
+
+        await this.processGroupMemberCheck(prop, nd.email);
+        return this.userRefCache[nd.email];
+    }
+
+    const user = await this.getUserByEmail(nd);
+    const userId = (user)?user.id:undefined;
+
+    if(userId) {
+      this.userRefCache[nd.email] = userId;
+      await this.processGroupMemberCheck(prop, nd.email);
+    }
+
+    return userId;
+  }
+
+  /** Makes batch calls of 1000 of user-org entities until
+   * it find one with userEmail of passed in nd.email.
+   * Maxes out after querying for 15,000 user-org entities
+   *
+   * @param nd
+   * @returns
+   */
+  async getUserByEmail(nd: any) {
+    let userOrg = undefined;
+    let count =0;
+    let size = 0;
+    const entities = new Entities();
+    const getOptionsCriteria = {
+      entityName: 'user-org',
+      take:1000
+    }
+
+    do {
+      const userBatch: [any] = await entities.get(getOptionsCriteria);
+      userOrg = userBatch.find(uo => uo?.userEmail === nd?.email);
+
+    }while( !userOrg && size == getOptionsCriteria.take && count < 15);
+    return userOrg?.user
+
+  }
+
+  /** Shows warning if user email address not present in group associated to property
+   *
+   * @param prop the VibeIQ property
+   * @param userEmail user email address
+   */
+  async processGroupMemberCheck(prop, userEmail) {
+    let arrUserList = [];
+    if(this.userRefCache[prop.typePropertyUserListId]) {
+      arrUserList = this.userRefCache[prop.typePropertyUserListId];
+    } else {
+      const userListResult = await new Entities().get({
+        entityName: 'user-list',
+        id: prop.typePropertyUserListId
+      });
+
+      if(userListResult && Object.keys(userListResult).length) {
+        arrUserList = userListResult.userList;
+        this.userRefCache[prop.typePropertyUserListId] = arrUserList;
+      }
+    }
+
+    if(arrUserList.length) {
+      const result = arrUserList.find(element => element['display'] === userEmail);
+      if(!result) {
+          console.warn(`The passed in user ${userEmail} in property slug ${prop.slug} should be a member of the group associated with the property 'typePropertyUserListId'`)
+      }
+    }
+  }
+
+  /** Gets the VibeIQ value for the userList property from data
+   *
+   * @param prop the VibeIQ property
+   * @param newData the FlexPLM data
+   * @returns value to be set in VibeIQ
+   */
+  async getUserListValue(prop, newData) {
+      const slug = prop['slug'];
+      if (Logger.isDebugOn()) {
+          console.debug('getUserListValue-prop: ' + slug);
+      }
+
+      const entityId = newData[slug + 'Id'];
+
+      if(!entityId) {
+          return {};
+      }
+
+      if (this.userRefCache[entityId]) {
+          if (Logger.isDebugOn()) {
+              console.debug('user cache hit: ' + entityId);
+          }
+          return this.userRefCache[entityId];
+      }
+
+      const user = await this.getUserById(entityId);
+
+      const value = (user) ? {
+          email: user.email,
+          firstName: user.first,
+          lastName: user.last,
+          isSsoUser: user.isSsoUser,
+      } : undefined;
+
+      if(value) {
+          this.userRefCache[entityId] = value;
+      }
+
+      return value;
+  }
+
+  /** Makes batch calls of 1000 of user-org entities until
+   * it find one with user.id of passed in userId.
+   * Maxes out after querying for 15,000 user-org entities
+   *
+   * @param userId
+   * @returns
+   */
+  async getUserById(userId: any) {
+    let userOrg = undefined;
+    let count =0;
+    let size = 0;
+    const entities = new Entities();
+    const getOptionsCriteria = {
+      entityName: 'user-org',
+      take:1000
+    }
+
+    do {
+      const userBatch: [any] = await entities.get(getOptionsCriteria);
+      userOrg = userBatch.find(uo => uo?.user?.id === userId);
+
+    }while( !userOrg && size == getOptionsCriteria.take && count < 15);
+    return userOrg?.user
+  }
+
 }