@contrail/flexplm 1.1.43 → 1.1.45

package/.github/pull_request_template.md

@@ -27,4 +27,5 @@ Describe the testing you added to this PR
 
 
 ## Link to Jira ticket(s)
+https://vibe-team.atlassian.net/browse/TICKET_NUMBER_HERE
 

package/lib/entity-processor/base-entity-processor.js

@@ -162,7 +162,8 @@ class BaseEntityProcessor {
         return flexResponse;
     }
     async getOutboundEntityUpdates(event, flexResponse) {
-        const flexPayload = flexResponse?.data?.payload[0];
+        const payload = flexResponse?.data?.payload;
+        const flexPayload = (payload) ? payload[0] : undefined;
         let outboundEntityUpdates = undefined;
         if (flexPayload && 'OK' === flexPayload.status) {
             const inboundData = await this.getTransformedData(flexPayload);

package/lib/entity-processor/base-entity-processor.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/entity-processor/base-entity-processor.spec.js

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const sdk_1 = require("@contrail/sdk");
+const transform_data_1 = require("@contrail/transform-data");
+const data_converter_1 = require("../util/data-converter");
+const base_entity_processor_1 = require("./base-entity-processor");
+class TestBaseEntityProcessor extends base_entity_processor_1.BaseEntityProcessor {
+    getIncomingEntity(event, inboundData) {
+        throw new Error("Method not implemented.");
+    }
+    getCreateEntity(inboundData) {
+        throw new Error("Method not implemented.");
+    }
+    getOutgoingUpsertPayload(entityType, event) {
+        throw new Error("Method not implemented.");
+    }
+}
+describe('BaseEntityProcessor', () => {
+    describe('getOutboundEntityUpdates', () => {
+        const config = {};
+        const mapFileUtil = new transform_data_1.MapFileUtil(new sdk_1.Entities());
+        const dc = new data_converter_1.DataConverter(config, mapFileUtil);
+        it('no payload', async () => {
+            const btep = new TestBaseEntityProcessor(config, dc, mapFileUtil, 'test');
+            const event = {};
+            const flexResponse = {};
+            const updates = await btep.getOutboundEntityUpdates(event, flexResponse);
+            expect(updates).toBeUndefined();
+        });
+        it('flexPayload.status === OK', async () => {
+            const btep = new TestBaseEntityProcessor(config, dc, mapFileUtil, 'test');
+            const event = {};
+            const flexResponse = {
+                data: {
+                    payload: [
+                        {
+                            status: 'OK'
+                        }
+                    ]
+                }
+            };
+            const getTransformedDataSpy = jest.spyOn(btep, 'getTransformedData').mockReturnValue(Promise.resolve({}));
+            const returnValue = {
+                name: 'Test'
+            };
+            const getUpdatesForEntitySpy = jest.spyOn(btep, 'getUpdatesForEntity').mockReturnValue(Promise.resolve(returnValue));
+            const updates = await btep.getOutboundEntityUpdates(event, flexResponse);
+            expect(getTransformedDataSpy).toBeCalledTimes(1);
+            expect(getUpdatesForEntitySpy).toBeCalledTimes(1);
+            expect(updates).toBe(returnValue);
+        });
+        it('flexPayload.status === FAIL', async () => {
+            const btep = new TestBaseEntityProcessor(config, dc, mapFileUtil, 'test');
+            const event = {};
+            const flexResponse = {
+                data: {
+                    payload: [
+                        {
+                            status: 'FAIL'
+                        }
+                    ]
+                }
+            };
+            const getTransformedDataSpy = jest.spyOn(btep, 'getTransformedData').mockReturnValue(Promise.resolve({}));
+            const returnValue = {
+                name: 'Test'
+            };
+            const getUpdatesForEntitySpy = jest.spyOn(btep, 'getUpdatesForEntity').mockReturnValue(Promise.resolve(returnValue));
+            const updates = await btep.getOutboundEntityUpdates(event, flexResponse);
+            expect(getTransformedDataSpy).toBeCalledTimes(0);
+            expect(getUpdatesForEntitySpy).toBeCalledTimes(0);
+            expect(updates).toBeUndefined();
+        });
+    });
+});

package/lib/interfaces/interfaces.d.ts

@@ -69,6 +69,7 @@ export interface AsyncEventsPayloadType extends AsyncPayloadType {
     events?: PayloadType[];
     eventsFileId?: string;
     eventsDownloadLink?: string;
+    eventsAdminDownloadLink?: string;
 }
 export interface EntityPayloadType extends PayloadType {
     entityReference: string;

package/lib/publish/base-process-publish-assortment.js

@@ -584,7 +584,8 @@ class BaseProcessPublishAssortment {
             eventType,
             objectClass: 'LCSSeason',
             eventsFileId: uploadFile.id,
-            eventsDownloadLink: uploadFile.downloadUrl
+            eventsDownloadLink: uploadFile.downloadUrl,
+            eventsAdminDownloadLink: uploadFile.adminDownloadUrl
         };
         if (sendMode === 'vibeiqfile') {
             const flexPLMConnect = new flexplm_connect_1.FlexPLMConnect(this.config);

package/lib/util/config-defaults.d.ts

@@ -1,6 +1,8 @@
 import { FCConfig } from '../interfaces/interfaces';
 export declare class ConfigDefaults {
     static NEED_CONFIG_VALUES: string;
+    static STATIC_CONFIG_CACHE: {};
     static setConfigDefaults(config: any): Promise<FCConfig>;
     static getConfigFile(fileId: string): Promise<any>;
+    static clearConfigCache(): void;
 }

package/lib/util/config-defaults.js

@@ -46,6 +46,10 @@ class ConfigDefaults {
     }
     static async getConfigFile(fileId) {
         try {
+            if (ConfigDefaults.STATIC_CONFIG_CACHE[fileId]) {
+                console.debug('returning cached config file: ' + fileId);
+                return ConfigDefaults.STATIC_CONFIG_CACHE[fileId];
+            }
             const options = {
                 entityName: 'file',
                 id: fileId,
@@ -62,6 +66,9 @@ class ConfigDefaults {
             }
             const response = await fetch(downloadUrl);
             const config = await response.json();
+            if (config) {
+                ConfigDefaults.STATIC_CONFIG_CACHE[fileId] = config;
+            }
             return config ? config : {};
         }
         catch (e) {
@@ -69,6 +76,10 @@ class ConfigDefaults {
             return {};
         }
     }
+    static clearConfigCache() {
+        ConfigDefaults.STATIC_CONFIG_CACHE = {};
+    }
 }
 exports.ConfigDefaults = ConfigDefaults;
 ConfigDefaults.NEED_CONFIG_VALUES = 'To connect to FlexPLM all these APP values need to be set apiHost, userName, and password';
+ConfigDefaults.STATIC_CONFIG_CACHE = {};

package/lib/util/config-defaults.spec.js

@@ -265,6 +265,9 @@ describe('all tests', () => {
         });
     });
     describe('getConfigFile', () => {
+        beforeEach(() => {
+            config_defaults_1.ConfigDefaults.clearConfigCache();
+        });
         it('response has test var', async () => {
             fetchJson = { testVar: true };
             entityObject = { downloadUrl: 'http://sss.com' };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrail/flexplm",
-  "version": "1.1.43",
+  "version": "1.1.45",
   "description": "Library used for integration with flexplm.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -41,7 +41,7 @@
   "dependencies": {
     "@contrail/app-framework": "^1.2.4",
     "@contrail/sdk": "^1.3.7",
-    "@contrail/transform-data": "^1.0.15",
+    "@contrail/transform-data": "^1.1.1",
     "axios": "^1.4.0",
     "p-limit": "^3.1.0"
   }

package/src/entity-processor/base-entity-processor.spec.ts

@@ -0,0 +1,80 @@
+import { Entities } from "@contrail/sdk";
+import { MapFileUtil } from "@contrail/transform-data";
+import { EntityPayloadType, FCConfig } from "../interfaces/interfaces";
+import { DataConverter } from "../util/data-converter";
+import { BaseEntityProcessor, IncomingEntityResponse } from "./base-entity-processor";
+
+class TestBaseEntityProcessor extends BaseEntityProcessor {
+  protected getIncomingEntity(event: any, inboundData: any): Promise<IncomingEntityResponse> {
+    throw new Error("Method not implemented.");
+  }
+  protected getCreateEntity(inboundData: any): Promise<IncomingEntityResponse> {
+    throw new Error("Method not implemented.");
+  }
+  protected getOutgoingUpsertPayload(entityType: any, event: any): Promise<EntityPayloadType> {
+    throw new Error("Method not implemented.");
+  }
+
+}
+describe('BaseEntityProcessor', () =>{
+  describe('getOutboundEntityUpdates', () =>{
+
+    const config = {} as FCConfig;
+    const mapFileUtil = new MapFileUtil(new Entities());
+    const dc = new DataConverter(config, mapFileUtil);
+    it('no payload', async () =>{
+      const btep = new TestBaseEntityProcessor(config, dc, mapFileUtil, 'test');
+      const event = {};
+      const flexResponse = {};
+
+      const updates = await btep.getOutboundEntityUpdates(event, flexResponse);
+      expect(updates).toBeUndefined();
+    });
+
+    it('flexPayload.status === OK', async () =>{
+      const btep = new TestBaseEntityProcessor(config, dc, mapFileUtil, 'test');
+      const event = {};
+      const flexResponse = {
+        data: {
+          payload: [
+            {
+              status: 'OK'
+            }
+          ]
+        }
+      };
+      const getTransformedDataSpy = jest.spyOn(btep, 'getTransformedData').mockReturnValue(Promise.resolve({}));
+      const returnValue = {
+        name: 'Test'
+      };
+      const getUpdatesForEntitySpy = jest.spyOn(btep, 'getUpdatesForEntity').mockReturnValue(Promise.resolve(returnValue));
+      const updates = await btep.getOutboundEntityUpdates(event, flexResponse);
+      expect(getTransformedDataSpy).toBeCalledTimes(1);
+      expect(getUpdatesForEntitySpy).toBeCalledTimes(1);
+      expect(updates).toBe(returnValue);
+    });
+
+    it('flexPayload.status === FAIL', async () =>{
+      const btep = new TestBaseEntityProcessor(config, dc, mapFileUtil, 'test');
+      const event = {};
+      const flexResponse = {
+        data: {
+          payload: [
+            {
+              status: 'FAIL'
+            }
+          ]
+        }
+      };
+      const getTransformedDataSpy = jest.spyOn(btep, 'getTransformedData').mockReturnValue(Promise.resolve({}));
+      const returnValue = {
+        name: 'Test'
+      };
+      const getUpdatesForEntitySpy = jest.spyOn(btep, 'getUpdatesForEntity').mockReturnValue(Promise.resolve(returnValue));
+      const updates = await btep.getOutboundEntityUpdates(event, flexResponse);
+      expect(getTransformedDataSpy).toBeCalledTimes(0);
+      expect(getUpdatesForEntitySpy).toBeCalledTimes(0);
+      expect(updates).toBeUndefined();
+    });
+  });
+});

package/src/entity-processor/base-entity-processor.ts

@@ -210,7 +210,8 @@ export abstract class BaseEntityProcessor {
   }
 
   async getOutboundEntityUpdates(event, flexResponse): Promise<any> {
-    const flexPayload = flexResponse?.data?.payload[0];
+    const payload = flexResponse?.data?.payload;
+    const flexPayload = (payload)? payload[0] : undefined;
     let outboundEntityUpdates = undefined;
     if(flexPayload && 'OK' === flexPayload.status) {
       const inboundData = await this.getTransformedData(flexPayload);

package/src/interfaces/interfaces.ts

@@ -74,6 +74,7 @@ export interface AsyncEventsPayloadType extends AsyncPayloadType {
     events?: PayloadType[];
     eventsFileId?: string;
     eventsDownloadLink?: string;
+    eventsAdminDownloadLink?: string;
 }
 
 export interface EntityPayloadType extends PayloadType {

package/src/publish/base-process-publish-assortment.ts

@@ -707,8 +707,9 @@ export class BaseProcessPublishAssortment {
       eventType,
       objectClass: 'LCSSeason',
       eventsFileId: uploadFile.id,
-      eventsDownloadLink: uploadFile.downloadUrl
-    };
+      eventsDownloadLink: uploadFile.downloadUrl,
+      eventsAdminDownloadLink: uploadFile.adminDownloadUrl
+};
 
     if (sendMode === 'vibeiqfile') {
       const flexPLMConnect = new FlexPLMConnect(this.config);

package/src/util/config-defaults.spec.ts

@@ -315,6 +315,10 @@ describe('all tests', () => {
   });
 
   describe('getConfigFile', () => {
+    beforeEach(() => {
+      ConfigDefaults.clearConfigCache();
+    });
+
     it('response has test var', async () => {
       fetchJson = { testVar: true };
       entityObject = { downloadUrl: 'http://sss.com' };

package/src/util/config-defaults.ts

@@ -4,6 +4,7 @@ import { ObjectUtil } from '@contrail/util';
 
 export class ConfigDefaults {
   static NEED_CONFIG_VALUES = 'To connect to FlexPLM all these APP values need to be set apiHost, userName, and password';
+  static STATIC_CONFIG_CACHE = {};
   static async setConfigDefaults(config): Promise<FCConfig> {
   //Validate config
     if (!config.apiHost || !config.userName || !config.password) {
@@ -55,6 +56,10 @@ export class ConfigDefaults {
   static async getConfigFile(fileId: string) {
     try {
 
+      if(ConfigDefaults.STATIC_CONFIG_CACHE[fileId]){
+        console.debug('returning cached config file: ' + fileId);
+        return ConfigDefaults.STATIC_CONFIG_CACHE[fileId];
+      }
       const options = {
         entityName: 'file',
         id: fileId,
@@ -72,10 +77,17 @@ export class ConfigDefaults {
       }
       const response = await fetch(downloadUrl);
       const config = await response.json();
+      if(config){
+        ConfigDefaults.STATIC_CONFIG_CACHE[fileId] = config;
+      }
       return config ? config: {};
     }catch(e){
       console.log('Error getting config file: ' + fileId + '- ' +e.message);
       return {};
     }
   }
+
+  static clearConfigCache(){
+    ConfigDefaults.STATIC_CONFIG_CACHE = {};
+  }
 }