@contrail/flexplm 1.1.29 → 1.1.31

package/lib/index.d.ts

@@ -2,6 +2,7 @@ export * from './flexplm-request';
 export * from './flexplm-utils';
 export * from './util/config-defaults';
 export * from './util/data-converter';
+export * from './util/error-response-object';
 export * from './util/federation';
 export * from './util/flexplm-connect';
 export * from './interfaces/interfaces';

package/lib/index.js

@@ -18,6 +18,7 @@ __exportStar(require("./flexplm-request"), exports);
 __exportStar(require("./flexplm-utils"), exports);
 __exportStar(require("./util/config-defaults"), exports);
 __exportStar(require("./util/data-converter"), exports);
+__exportStar(require("./util/error-response-object"), exports);
 __exportStar(require("./util/federation"), exports);
 __exportStar(require("./util/flexplm-connect"), exports);
 __exportStar(require("./interfaces/interfaces"), exports);

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

@@ -12,15 +12,17 @@ class BaseProcessPublishAssortmentCallback {
         console.log("ProcessPublishAssortmentCallback-config: " + JSON.stringify(this.config));
         const statusCounts = this.config["statusCounts"];
         console.log("statusCounts: " + JSON.stringify(statusCounts));
-        this.checkFailuresAndSendNotification(event);
+        const statMessage = (statusCounts)
+            ? await this.checkFailuresAndSendNotification(event)
+            : 'no statusCount';
         return {
-            message: "Done ProcessPublishAssortmentCallback-process()",
+            message: "Done ProcessPublishAssortmentCallback-process(): " + statMessage,
         };
     }
-    checkFailuresAndSendNotification(event) {
+    async checkFailuresAndSendNotification(event) {
         const statusCounts = JSON.parse(this.config["statusCounts"]);
         if (statusCounts["INVALID"] > 0 || statusCounts["FAILURE"] > 0) {
-            new sdk_1.Notification().Dispatch({
+            await new sdk_1.Notification().Dispatch({
                 message: `There were errors when publishing the season data. Please review the event and config information from context.`,
                 level: sdk_1.LogLevel.WARN,
                 context: {
@@ -28,7 +30,9 @@ class BaseProcessPublishAssortmentCallback {
                     config: this.config,
                 },
             });
+            return 'sent notification';
         }
+        return 'no notification needed';
     }
 }
 exports.BaseProcessPublishAssortmentCallback = BaseProcessPublishAssortmentCallback;

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

@@ -6,9 +6,12 @@ export declare class DataConverter {
     private typeUtils;
     private transformMapFile;
     private useDisplayForEnumerationMatching;
+    private verboseDebug;
     private objRefCache;
     private userRefCache;
     constructor(config: FCConfig, mapFileUtil: MapFileUtil);
+    setVerboseDebug(val?: boolean): void;
+    isVerboseDebugOn(): boolean;
     getFlexPLMObjectDataFromEvent(event: any, dataToSkip: string[]): Promise<{}>;
     getFlexPLMObjectData(newData: any, dataToSkip: string[], inflateObjRef: boolean): Promise<{}>;
     getFlexPLMValue(prop: any, newData: any, inflateObjRef: boolean): Promise<any>;

package/lib/util/data-converter.js

@@ -12,18 +12,27 @@ class DataConverter {
         this.config = config;
         this.mapFileUtil = mapFileUtil;
         this.useDisplayForEnumerationMatching = false;
+        this.verboseDebug = false;
         this.objRefCache = {};
         this.userRefCache = {};
         this.typeUtils = new type_utils_1.TypeUtils();
         this.transformMapFile = this.config['transformMapFile'];
         this.useDisplayForEnumerationMatching = this.config['dataConverter']
             && this.config['dataConverter']['useDisplayForEnumerationMatching'];
+        this.verboseDebug = this.config['dataConverter']
+            && this.config['dataConverter']['verboseDebug'];
+    }
+    setVerboseDebug(val = false) {
+        this.verboseDebug = val;
+    }
+    isVerboseDebugOn() {
+        return this.verboseDebug && app_framework_1.Logger.isDebugOn();
     }
     async getFlexPLMObjectDataFromEvent(event, dataToSkip) {
         return this.getFlexPLMObjectData(event.newData, dataToSkip, true);
     }
     async getFlexPLMObjectData(newData, dataToSkip, inflateObjRef) {
-        if (app_framework_1.Logger.isDebugOn()) {
+        if (this.isVerboseDebugOn()) {
             console.debug('newData: ' + JSON.stringify(newData));
         }
         dataToSkip = dataToSkip.concat(['updatedOn', 'updatedById', 'createdOn', 'createdById', 'modifiedAt', 'orgId', 'createdAt', 'id', 'typeId', 'workspaceId']);
@@ -42,7 +51,7 @@ class DataConverter {
             }
             data[slug] = await this.getFlexPLMValue(prop, newData, inflateObjRef);
         }
-        if (app_framework_1.Logger.isDebugOn()) {
+        if (this.isVerboseDebugOn()) {
             console.debug('getFlexPLMObjectData-data:  ' + JSON.stringify(data));
         }
         return data;
@@ -77,7 +86,7 @@ class DataConverter {
         }
         else if ('object_reference' === propertyType) {
             value = await this.getObjectReferenceValue(prop, newData, inflateObjRef);
-            if (app_framework_1.Logger.isDebugOn()) {
+            if (this.isVerboseDebugOn()) {
                 console.debug('object_reference: ' + JSON.stringify(value));
             }
         }

package/lib/util/error-response-object.d.ts

@@ -0,0 +1,4 @@
+import { AppActionCallBack } from "@contrail/app-framework";
+export declare class ErrorResponseObject {
+    static getResponse(e: any): AppActionCallBack;
+}

package/lib/util/error-response-object.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ErrorResponseObject = void 0;
+const app_framework_1 = require("@contrail/app-framework");
+class ErrorResponseObject {
+    static getResponse(e) {
+        if (!e) {
+            const response = {
+                status: app_framework_1.AppActionCallbackStatus.FAILURE,
+                output: {
+                    message: 'No error provided.'
+                }
+            };
+            return response;
+        }
+        const response = {
+            status: app_framework_1.AppActionCallbackStatus.FAILURE,
+            output: {
+                message: e.message
+            }
+        };
+        const output = response.output;
+        if (e.details)
+            output.errorDetails = e.details;
+        if (e.code)
+            output.code = e.code;
+        if (e.errno)
+            output.errno = e.errno;
+        if (e.type)
+            output.type = e.type;
+        if (e.name)
+            output.errorName = e.name;
+        if (e.cause) {
+            output.cause = {};
+            const cause = output.cause;
+            if (e.cause.code)
+                cause.code = e.cause.code;
+            if (e.cause.message)
+                cause.message = e.cause.message;
+        }
+        if (e.stack) {
+            console.log('ErrorResponseObject.getResponse stack: ' + e.stack);
+        }
+        return response;
+    }
+}
+exports.ErrorResponseObject = ErrorResponseObject;

package/lib/util/error-response-object.spec.d.ts

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

package/lib/util/error-response-object.spec.js

@@ -0,0 +1,99 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const app_framework_1 = require("@contrail/app-framework");
+const error_response_object_1 = require("./error-response-object");
+describe('getResponse() Tests', () => {
+    it('no error provided', () => {
+        const e = undefined;
+        const response = error_response_object_1.ErrorResponseObject.getResponse(e);
+        expect(response.status).toMatch(app_framework_1.AppActionCallbackStatus.FAILURE);
+        expect(response?.output?.message).toMatch('No error provided');
+    });
+    it('error with message', () => {
+        const e = {
+            message: 'Test'
+        };
+        const response = error_response_object_1.ErrorResponseObject.getResponse(e);
+        expect(response.status).toMatch(app_framework_1.AppActionCallbackStatus.FAILURE);
+        expect(response?.output?.message).toMatch('Test');
+    });
+    it('error with details', () => {
+        const details = {
+            message: 'Detail Message',
+            itemType: [
+                {
+                    message: "Type 'item:product:newBalance:apparel' cannot be assigned to a property with type 'item'."
+                }
+            ]
+        };
+        const e = {
+            message: 'Test',
+            details
+        };
+        const response = error_response_object_1.ErrorResponseObject.getResponse(e);
+        expect(response).toBeTruthy();
+        expect(response.status).toMatch(app_framework_1.AppActionCallbackStatus.FAILURE);
+        expect(response.output.message).toMatch('Test');
+        const errorDetails = response.output.errorDetails;
+        expect(errorDetails).toBeTruthy();
+        expect(errorDetails.message).toMatch('Detail Message');
+        expect(errorDetails).toHaveProperty('itemType');
+    });
+    it('error with cause', () => {
+        const cause = {
+            code: 401,
+            message: 'cause message'
+        };
+        const e = {
+            message: 'Test',
+            cause
+        };
+        const response = error_response_object_1.ErrorResponseObject.getResponse(e);
+        expect(response.status).toMatch(app_framework_1.AppActionCallbackStatus.FAILURE);
+        expect(response?.output?.message).toMatch('Test');
+        const resCause = response.output.cause;
+        expect(resCause).toBeTruthy();
+        expect(resCause.code).toBe(401);
+        expect(resCause.message).toMatch('cause message');
+    });
+    it('error with code', () => {
+        const e = {
+            message: 'Test',
+            code: 404
+        };
+        const response = error_response_object_1.ErrorResponseObject.getResponse(e);
+        expect(response.status).toMatch(app_framework_1.AppActionCallbackStatus.FAILURE);
+        expect(response?.output?.message).toMatch('Test');
+        expect(response.output.code).toBe(404);
+    });
+    it('error with code', () => {
+        const e = {
+            message: 'Test',
+            name: 'Error'
+        };
+        const response = error_response_object_1.ErrorResponseObject.getResponse(e);
+        expect(response.status).toMatch(app_framework_1.AppActionCallbackStatus.FAILURE);
+        expect(response?.output?.message).toMatch('Test');
+        expect(response.output.errorName).toMatch('Error');
+    });
+    it('error with errno', () => {
+        const e = {
+            message: 'Test',
+            errno: 500
+        };
+        const response = error_response_object_1.ErrorResponseObject.getResponse(e);
+        expect(response.status).toMatch(app_framework_1.AppActionCallbackStatus.FAILURE);
+        expect(response?.output?.message).toMatch('Test');
+        expect(response.output.errno).toBe(500);
+    });
+    it('error with type', () => {
+        const e = {
+            message: 'Test',
+            type: 'system'
+        };
+        const response = error_response_object_1.ErrorResponseObject.getResponse(e);
+        expect(response.status).toMatch(app_framework_1.AppActionCallbackStatus.FAILURE);
+        expect(response?.output?.message).toMatch('Test');
+        expect(response.output.type).toMatch('system');
+    });
+});

package/package.json

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

package/src/index.ts

@@ -2,6 +2,7 @@ export * from './flexplm-request';
 export * from './flexplm-utils';
 export * from './util/config-defaults';
 export * from './util/data-converter';
+export * from './util/error-response-object';
 export * from './util/federation';
 export * from './util/flexplm-connect';
 export * from './interfaces/interfaces';

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

@@ -21,18 +21,20 @@ export class BaseProcessPublishAssortmentCallback {
     const statusCounts = this.config["statusCounts"];
     console.log("statusCounts: " + JSON.stringify(statusCounts));
 
-    this.checkFailuresAndSendNotification(event);
+    const statMessage =(statusCounts)
+      ?await this.checkFailuresAndSendNotification(event)
+      :'no statusCount';
 
     return {
-      message: "Done ProcessPublishAssortmentCallback-process()",
+      message: "Done ProcessPublishAssortmentCallback-process(): " + statMessage,
     };
   }
 
-  private checkFailuresAndSendNotification(event) {
+  private async checkFailuresAndSendNotification(event): Promise<string> {
     const statusCounts = JSON.parse(this.config["statusCounts"]);
 
     if (statusCounts["INVALID"] > 0 || statusCounts["FAILURE"] > 0) {
-      new Notification().Dispatch({
+      await new Notification().Dispatch({
         message: `There were errors when publishing the season data. Please review the event and config information from context.`,
         level: LogLevel.WARN,
         context: {
@@ -40,6 +42,9 @@ export class BaseProcessPublishAssortmentCallback {
           config: this.config,
         },
       });
+      return 'sent notification';
     }
+
+    return 'no notification needed';
   }
 }

package/src/util/data-converter.ts

@@ -11,6 +11,7 @@ export class DataConverter {
   private typeUtils: TypeUtils;
   private transformMapFile: string;
   private useDisplayForEnumerationMatching = false;
+  private verboseDebug = false;
   private objRefCache = {};
   private userRefCache = {};
   constructor(private config: FCConfig, private mapFileUtil: MapFileUtil){
@@ -18,6 +19,15 @@ export class DataConverter {
     this.transformMapFile = this.config['transformMapFile'];
     this.useDisplayForEnumerationMatching = this.config['dataConverter']
       && this.config['dataConverter']['useDisplayForEnumerationMatching'];
+    this.verboseDebug = this.config['dataConverter']
+      && this.config['dataConverter']['verboseDebug'];
+  }
+
+  public setVerboseDebug(val: boolean = false) {
+    this.verboseDebug= val;
+  }
+  public isVerboseDebugOn(): boolean {
+    return this.verboseDebug && Logger.isDebugOn();
   }
 
   async getFlexPLMObjectDataFromEvent(event, dataToSkip: string[]) {
@@ -25,7 +35,7 @@ export class DataConverter {
   }
 
   async getFlexPLMObjectData(newData, dataToSkip: string[], inflateObjRef: boolean) {
-    if(Logger.isDebugOn()) {
+    if(this.isVerboseDebugOn()) {
       console.debug('newData: ' + JSON.stringify(newData));
     }
     //Using event to get propertyDiffs to find emptied values
@@ -51,7 +61,7 @@ export class DataConverter {
       data[slug] = await this.getFlexPLMValue(prop, newData, inflateObjRef);
     }
 
-    if(Logger.isDebugOn()) {
+    if(this.isVerboseDebugOn()) {
       console.debug('getFlexPLMObjectData-data:  ' + JSON.stringify(data));
     }
     return data;
@@ -86,7 +96,7 @@ export class DataConverter {
       value = this.getEnumerationValue(prop, nd);
     }else if('object_reference' === propertyType){
       value = await this.getObjectReferenceValue(prop, newData, inflateObjRef);
-      if(Logger.isDebugOn()){
+      if(this.isVerboseDebugOn()){
         console.debug('object_reference: ' + JSON.stringify(value));
       }
     } else if ('image' === propertyType) {

package/src/util/error-response-object.spec.ts

@@ -0,0 +1,116 @@
+import { AppActionCallbackStatus } from "@contrail/app-framework";
+import { ErrorResponseObject } from "./error-response-object";
+
+describe('getResponse() Tests', () =>{
+  it('no error provided', () => {
+    const e = undefined;
+
+    const response = ErrorResponseObject.getResponse(e);
+    expect(response.status).toMatch(AppActionCallbackStatus.FAILURE);
+    expect(response?.output?.message).toMatch('No error provided');
+  });
+  it('error with message', () => {
+    const e = {
+      message: 'Test'
+    };
+
+    const response = ErrorResponseObject.getResponse(e);
+    expect(response.status).toMatch(AppActionCallbackStatus.FAILURE);
+    expect(response?.output?.message).toMatch('Test');
+  });
+
+  it('error with details', () => {
+    const details = {
+      message: 'Detail Message',
+      itemType: [
+        {
+            message: "Type 'item:product:newBalance:apparel' cannot be assigned to a property with type 'item'."
+        }]
+    };
+    const e = {
+      message: 'Test',
+      details
+
+    };
+
+    const response = ErrorResponseObject.getResponse(e);
+    expect(response).toBeTruthy();
+    expect(response.status).toMatch(AppActionCallbackStatus.FAILURE);
+    expect(response.output.message).toMatch('Test');
+
+    const errorDetails = response.output.errorDetails;
+    expect(errorDetails).toBeTruthy();
+    expect(errorDetails.message).toMatch('Detail Message');
+    expect(errorDetails).toHaveProperty('itemType');
+  });
+
+  it('error with cause', () => {
+    const cause = {
+      code: 401,
+      message: 'cause message'
+    };
+    const e = {
+      message: 'Test',
+      cause
+    };
+
+    const response = ErrorResponseObject.getResponse(e);
+    expect(response.status).toMatch(AppActionCallbackStatus.FAILURE);
+    expect(response?.output?.message).toMatch('Test');
+    const resCause = response.output.cause;
+
+    expect(resCause).toBeTruthy();
+    expect(resCause.code).toBe(401);
+    expect(resCause.message).toMatch('cause message');
+
+  });
+
+  it('error with code', () => {
+    const e = {
+      message: 'Test',
+      code: 404
+    };
+
+    const response = ErrorResponseObject.getResponse(e);
+    expect(response.status).toMatch(AppActionCallbackStatus.FAILURE);
+    expect(response?.output?.message).toMatch('Test');
+    expect(response.output.code).toBe(404);
+  });
+
+  it('error with code', () => {
+    const e = {
+      message: 'Test',
+      name: 'Error'
+    };
+
+    const response = ErrorResponseObject.getResponse(e);
+    expect(response.status).toMatch(AppActionCallbackStatus.FAILURE);
+    expect(response?.output?.message).toMatch('Test');
+    expect(response.output.errorName).toMatch('Error');
+  });
+
+  it('error with errno', () => {
+    const e = {
+      message: 'Test',
+      errno: 500
+    };
+
+    const response = ErrorResponseObject.getResponse(e);
+    expect(response.status).toMatch(AppActionCallbackStatus.FAILURE);
+    expect(response?.output?.message).toMatch('Test');
+    expect(response.output.errno).toBe(500);
+  });
+
+  it('error with type', () => {
+    const e = {
+      message: 'Test',
+      type: 'system'
+    };
+
+    const response = ErrorResponseObject.getResponse(e);
+    expect(response.status).toMatch(AppActionCallbackStatus.FAILURE);
+    expect(response?.output?.message).toMatch('Test');
+    expect(response.output.type).toMatch('system');
+  });
+
+});

package/src/util/error-response-object.ts

@@ -0,0 +1,50 @@
+import { AppActionCallBack, AppActionCallbackStatus } from "@contrail/app-framework";
+
+export class ErrorResponseObject {
+
+  /** Returns a response, checking for multiple possible error details
+   *
+   * @param e
+   * @returns
+   */
+  public static getResponse(e): AppActionCallBack {
+    if(!e){
+      const response: AppActionCallBack = {
+        status: AppActionCallbackStatus.FAILURE,
+        output: {
+          message: 'No error provided.'
+        }
+      };
+        return response;
+    }
+
+    const response: AppActionCallBack = {
+      status: AppActionCallbackStatus.FAILURE,
+      output: {
+        message: e.message
+      }
+    };
+    const output = response.output;
+
+    //Errors when persisting in VibeIQ
+    if(e.details) output.errorDetails = e.details;
+
+    if(e.code) output.code = e.code;
+    if(e.errno) output.errno = e.errno;
+    if(e.type) output.type = e.type;
+    if(e.name) output.errorName = e.name;
+
+    //Has original cause
+    if(e.cause){
+      output.cause = {};
+      const cause = output.cause;
+      if(e.cause.code) cause.code = e.cause.code;
+      if(e.cause.message) cause.message = e.cause.message;
+    }
+
+    if(e.stack){
+      console.log('ErrorResponseObject.getResponse stack: ' + e.stack);
+    }
+    return response;
+  }
+}

package/error-response-object.spec.ts

@@ -1,13 +0,0 @@
-import { AppActionCallbackStatus } from "@contrail/app-framework";
-import { ErrorResponseObject } from "./error-response-object";
-
-describe('getResponse() Tests', () =>{
-  it('status set', () => {
-    const e = {
-      message: 'Test'
-    };
-
-    const response = ErrorResponseObject.getResponse(e);
-    expect(response.status).toMatch(AppActionCallbackStatus.FAILURE);
-  })
-});

package/error-response-object.ts

@@ -1,38 +0,0 @@
-import { AppActionCallBack, AppActionCallbackStatus } from "@contrail/app-framework";
-
-export class ErrorResponseObject {
-
-  /** Returns a response, checking for multiple possible error details
-   * 
-   * @param e 
-   * @returns 
-   */
-  public static getResponse(e): AppActionCallBack {
-    const response: AppActionCallBack = {
-      status: AppActionCallbackStatus.FAILURE,
-      output: {
-        message: e.message
-      }
-    };
-    if(!e){
-      return response;
-    }
-    const output = response.output;
-
-    //Errors when persisting in VibeIQ
-    if(e?.details){
-      output.errorDetails = e.details;
-    }
-
-    //Has original cause
-    if(e?.cause){
-      const cause = {
-        code: e.cause.code,
-        message: e.cause.message,
-      };
-      output.cause = cause;
-    }
-
-    return response;
-  }
-}