@contrail/flexplm 1.6.1 → 1.7.0-alpha.c295a1e

package/lib/publish/base-process-publish-assortment.d.ts

@@ -86,8 +86,10 @@ export declare class BaseProcessPublishAssortment {
     getResultsCount(events: any): any;
     private sendEvents;
     private sendToFlexPLM;
+    private sendAndRecordPublishEvent;
     private saveToLocalFile;
     private handleVibeIQFile;
+    private sendPublishPayloadEvent;
     private getCurrentDateString;
     getItemFamilyChanges(pcd: PublishChangeData, changeDetail: any, assortmentItemFullChangeMap: Map<string, any>, assortmentItemDeleteMap: Map<string, any>): Map<string, ItemFamilyChanges>;
     getEventsForPublishChangeData(publishChangeData: PublishChangeData): Promise<SeasonalPayload[]>;

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

@@ -595,14 +595,41 @@ class BaseProcessPublishAssortment {
         }
     }
     async sendToFlexPLM(events, eventType) {
-        const asyncEvent = {
+        const outboundPublishEvent = {
             taskId: this.config.taskId,
             eventType,
             objectClass: 'LCSSeason',
             events
         };
         const flexPLMConnect = new flexplm_connect_1.FlexPLMConnect(this.config);
-        return await flexPLMConnect.sendToFlexPLM(asyncEvent);
+        const result = await this.sendAndRecordPublishEvent(flexPLMConnect, outboundPublishEvent);
+        const isResultObject = typeof result === 'object' && result !== null;
+        return isResultObject
+            ? { ...result, outboundPublishEvent }
+            : { result, outboundPublishEvent };
+    }
+    async sendAndRecordPublishEvent(flexPLMConnect, outboundPublishEvent) {
+        let sendResult;
+        try {
+            sendResult = await flexPLMConnect.sendToFlexPLM(outboundPublishEvent);
+        }
+        catch (e) {
+            const error = e instanceof Error ? e : new Error(String(e));
+            error.outboundPublishEvent = outboundPublishEvent;
+            error.sendToFlexPLMResult = { error: e?.message ?? String(e) };
+            throw error;
+        }
+        try {
+            await this.sendPublishPayloadEvent(outboundPublishEvent);
+        }
+        catch (e) {
+            const error = e instanceof Error ? e : new Error(String(e));
+            error.outboundPublishEvent = outboundPublishEvent;
+            error.sendToFlexPLMResult = sendResult;
+            error.sendPublishPayloadEventResult = { error: e?.message ?? String(e) };
+            throw error;
+        }
+        return sendResult;
     }
     async saveToLocalFile(events, eventType) {
         let results = {};
@@ -614,15 +641,16 @@ class BaseProcessPublishAssortment {
             const eventDirName = 'events-output';
             const fileName = `${path.sep}${eventDirName}${path.sep}events-${dateString}.json`;
             fileHandle = await fsPromise.open('.' + fileName, 'a');
-            const asyncEvent = {
+            const outboundPublishEvent = {
                 taskId: this.config.taskId,
                 eventType,
                 objectClass: 'LCSSeason',
                 events
             };
-            await fileHandle.writeFile(JSON.stringify(asyncEvent));
+            await fileHandle.writeFile(JSON.stringify(outboundPublishEvent));
             results = {
                 message: 'Successfully Saved File',
+                outboundPublishEvent,
                 fileLocation: dirName + fileName
             };
         }
@@ -638,7 +666,7 @@ class BaseProcessPublishAssortment {
         const eventBuffer = Buffer.from(JSON.stringify(events), 'utf-8');
         const fileName = 'ASYNC_PUBLISH_SEASON-events.json';
         const uploadFile = await new sdk_1.Files().createAndUploadFileFromBuffer(eventBuffer, 'application/json', fileName, null, this.TTL);
-        const asyncEvent = {
+        const outboundPublishEvent = {
             taskId: this.config.taskId,
             eventType,
             objectClass: 'LCSSeason',
@@ -648,15 +676,39 @@ class BaseProcessPublishAssortment {
         };
         if (sendMode === 'vibeiqfile') {
             const flexPLMConnect = new flexplm_connect_1.FlexPLMConnect(this.config);
-            return await flexPLMConnect.sendToFlexPLM(asyncEvent);
+            const result = await this.sendAndRecordPublishEvent(flexPLMConnect, outboundPublishEvent);
+            const isResultObject = typeof result === 'object' && result !== null;
+            return isResultObject
+                ? { ...result, outboundPublishEvent }
+                : { result, outboundPublishEvent };
         }
         else {
+            await this.sendPublishPayloadEvent(outboundPublishEvent);
             return {
                 message: 'Successfully Uploaded File.',
-                asyncEvent
+                outboundPublishEvent
             };
         }
     }
+    async sendPublishPayloadEvent(outboundPublishEvent) {
+        console.info('sendPublishPayloadEvent()');
+        let initialEvent = {};
+        if (this.config?.event) {
+            initialEvent = (typeof this.config?.event === 'string')
+                ? JSON.parse(this.config?.event)
+                : this.config?.event;
+        }
+        const eventBody = {
+            originSystemType: 'VibeIQ',
+            objectClass: 'AssortmentPublishedToFlexPLM',
+            outboundPublishEvent,
+            initialEvent
+        };
+        await new sdk_1.Entities().create({
+            entityName: 'external-event',
+            object: eventBody
+        });
+    }
     getCurrentDateString() {
         const d = new Date();
         return '' + d.getUTCFullYear()

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

@@ -9,6 +9,7 @@ const sdk_1 = require("@contrail/sdk");
 const type_conversion_utils_1 = require("../util/type-conversion-utils");
 const map_utils_1 = require("../util/map-utils");
 const item_family_changes_1 = require("../interfaces/item-family-changes");
+const flexplm_connect_1 = require("../util/flexplm-connect");
 let federatedId = '';
 jest.mock('../util/data-converter', () => {
     return {
@@ -31,6 +32,13 @@ jest.mock('../util/federation', () => {
 });
 let entityObject = {};
 let getOptionsObject = {};
+let createCallArg = undefined;
+let fileUploadCalls = [];
+let fileUploadResult = {
+    id: 'file-123',
+    downloadUrl: 'https://download.url',
+    adminDownloadUrl: 'https://admin.download.url'
+};
 jest.mock('@contrail/sdk', () => {
     return {
         Entities: class {
@@ -38,6 +46,18 @@ jest.mock('@contrail/sdk', () => {
                 getOptionsObject = _getOtionsObject;
                 return entityObject;
             }
+            create(arg) {
+                createCallArg = arg;
+                return Promise.resolve({});
+            }
+        },
+        Files: class {
+            createAndUploadFileFromBuffer(buffer, mimeType, fileName, _x, ttl) {
+                fileUploadCalls.push({ buffer, mimeType, fileName, ttl });
+                return Promise.resolve(fileUploadResult);
+            }
+        },
+        Request: class {
         }
     };
 });
@@ -1686,3 +1706,171 @@ describe('getEventsForItemFamilyChanges - conditional eventType', () => {
         expect(type_conversion_utils_1.TypeConversionUtils.isOutboundCreatableFromEntity).toHaveBeenNthCalledWith(2, undefined, mapFileUtil, colorProjectItem, { item: itemData, assortment });
     });
 });
+describe('sendToFlexPLM / handleVibeIQFile / sendPublishPayloadEvent', () => {
+    const config = {
+        taskId: 'task-abc',
+        event: '{"sourceEventId":"src-1"}'
+    };
+    const mapFileUtil = new transform_data_1.MapFileUtil(new sdk_1.Entities());
+    const dc = new data_converter_1.DataConverter(config, mapFileUtil);
+    const events = [{ objectClass: 'LCSProductSeasonLink' }];
+    const eventType = 'ASYNC_PUBLISH_SEASON';
+    beforeEach(() => {
+        createCallArg = undefined;
+        fileUploadCalls = [];
+        fileUploadResult = {
+            id: 'file-123',
+            downloadUrl: 'https://download.url',
+            adminDownloadUrl: 'https://admin.download.url'
+        };
+    });
+    afterEach(() => {
+        jest.restoreAllMocks();
+    });
+    it('should merge outboundPublishEvent into result and call sendPublishPayloadEvent after sendToFlexPLM succeeds', async () => {
+        const bppa = new base_process_publish_assortment_1.BaseProcessPublishAssortment(config, dc, mapFileUtil);
+        const flexResponse = { status: 200, data: { ok: true } };
+        const callOrder = [];
+        const spyFlex = jest.spyOn(flexplm_connect_1.FlexPLMConnect.prototype, 'sendToFlexPLM')
+            .mockImplementation(async () => {
+            await new Promise(r => setTimeout(r, 5));
+            callOrder.push('flex');
+            return flexResponse;
+        });
+        const spyEvent = jest.spyOn(bppa, 'sendPublishPayloadEvent')
+            .mockImplementation(async () => {
+            callOrder.push('event');
+        });
+        const result = await bppa.sendToFlexPLM(events, eventType);
+        expect(spyFlex).toHaveBeenCalledTimes(1);
+        expect(spyEvent).toHaveBeenCalledTimes(1);
+        expect(callOrder).toEqual(['flex', 'event']);
+        const passedOutboundPublishEvent = spyFlex.mock.calls[0][0];
+        expect(passedOutboundPublishEvent.taskId).toBe('task-abc');
+        expect(passedOutboundPublishEvent.eventType).toBe(eventType);
+        expect(passedOutboundPublishEvent.objectClass).toBe('LCSSeason');
+        expect(passedOutboundPublishEvent.events).toBe(events);
+        expect(spyEvent).toHaveBeenCalledWith(passedOutboundPublishEvent);
+        expect(result).toEqual({ ...flexResponse, outboundPublishEvent: passedOutboundPublishEvent });
+    });
+    it('should have sendToFlexPLM throw when flexPLMConnect.sendToFlexPLM fails, without calling sendPublishPayloadEvent', async () => {
+        const bppa = new base_process_publish_assortment_1.BaseProcessPublishAssortment(config, dc, mapFileUtil);
+        const flexError = new Error('flex failed');
+        jest.spyOn(flexplm_connect_1.FlexPLMConnect.prototype, 'sendToFlexPLM').mockRejectedValue(flexError);
+        const spyEvent = jest.spyOn(bppa, 'sendPublishPayloadEvent').mockResolvedValue(undefined);
+        await expect(bppa.sendToFlexPLM(events, eventType)).rejects.toMatchObject({
+            message: 'flex failed',
+            outboundPublishEvent: expect.objectContaining({ taskId: 'task-abc', eventType, objectClass: 'LCSSeason', events }),
+            sendToFlexPLMResult: { error: 'flex failed' }
+        });
+        expect(spyEvent).not.toHaveBeenCalled();
+        expect(flexError.sendPublishPayloadEventResult).toBeUndefined();
+    });
+    it('should have sendToFlexPLM throw when sendPublishPayloadEvent fails, with flex result attached', async () => {
+        const bppa = new base_process_publish_assortment_1.BaseProcessPublishAssortment(config, dc, mapFileUtil);
+        const flexResponse = { status: 200 };
+        const eventError = new Error('event failed');
+        jest.spyOn(flexplm_connect_1.FlexPLMConnect.prototype, 'sendToFlexPLM').mockResolvedValue(flexResponse);
+        jest.spyOn(bppa, 'sendPublishPayloadEvent').mockRejectedValue(eventError);
+        await expect(bppa.sendToFlexPLM(events, eventType)).rejects.toMatchObject({
+            message: 'event failed',
+            outboundPublishEvent: expect.objectContaining({ taskId: 'task-abc', eventType }),
+            sendToFlexPLMResult: flexResponse,
+            sendPublishPayloadEventResult: { error: 'event failed' }
+        });
+    });
+    it('should have handleVibeIQFile (vibeiqfile) throw when flexPLMConnect.sendToFlexPLM fails, without calling sendPublishPayloadEvent', async () => {
+        const bppa = new base_process_publish_assortment_1.BaseProcessPublishAssortment(config, dc, mapFileUtil);
+        const flexError = new Error('flex failed');
+        jest.spyOn(flexplm_connect_1.FlexPLMConnect.prototype, 'sendToFlexPLM').mockRejectedValue(flexError);
+        const spyEvent = jest.spyOn(bppa, 'sendPublishPayloadEvent').mockResolvedValue(undefined);
+        await expect(bppa.handleVibeIQFile(events, eventType, 'vibeiqfile')).rejects.toMatchObject({
+            message: 'flex failed',
+            outboundPublishEvent: expect.objectContaining({ eventsFileId: 'file-123' }),
+            sendToFlexPLMResult: { error: 'flex failed' }
+        });
+        expect(spyEvent).not.toHaveBeenCalled();
+        expect(flexError.sendPublishPayloadEventResult).toBeUndefined();
+    });
+    it('should have handleVibeIQFile (vibeiqfile) throw when sendPublishPayloadEvent fails, with flex result attached', async () => {
+        const bppa = new base_process_publish_assortment_1.BaseProcessPublishAssortment(config, dc, mapFileUtil);
+        const flexResponse = { status: 200 };
+        const eventError = new Error('event failed');
+        jest.spyOn(flexplm_connect_1.FlexPLMConnect.prototype, 'sendToFlexPLM').mockResolvedValue(flexResponse);
+        jest.spyOn(bppa, 'sendPublishPayloadEvent').mockRejectedValue(eventError);
+        await expect(bppa.handleVibeIQFile(events, eventType, 'vibeiqfile')).rejects.toMatchObject({
+            message: 'event failed',
+            outboundPublishEvent: expect.objectContaining({ eventsFileId: 'file-123' }),
+            sendToFlexPLMResult: flexResponse,
+            sendPublishPayloadEventResult: { error: 'event failed' }
+        });
+    });
+    it('should merge outboundPublishEvent into FlexPLM result and call sendPublishPayloadEvent when mode is vibeiqfile', async () => {
+        const bppa = new base_process_publish_assortment_1.BaseProcessPublishAssortment(config, dc, mapFileUtil);
+        const flexResponse = { status: 200, data: { ok: true } };
+        const spyFlex = jest.spyOn(flexplm_connect_1.FlexPLMConnect.prototype, 'sendToFlexPLM')
+            .mockResolvedValue(flexResponse);
+        const spyEvent = jest.spyOn(bppa, 'sendPublishPayloadEvent')
+            .mockResolvedValue(undefined);
+        const result = await bppa.handleVibeIQFile(events, eventType, 'vibeiqfile');
+        expect(fileUploadCalls).toHaveLength(1);
+        expect(fileUploadCalls[0].fileName).toBe('ASYNC_PUBLISH_SEASON-events.json');
+        expect(fileUploadCalls[0].mimeType).toBe('application/json');
+        const passedOutboundPublishEvent = spyFlex.mock.calls[0][0];
+        expect(passedOutboundPublishEvent.taskId).toBe('task-abc');
+        expect(passedOutboundPublishEvent.eventType).toBe(eventType);
+        expect(passedOutboundPublishEvent.objectClass).toBe('LCSSeason');
+        expect(passedOutboundPublishEvent.eventsFileId).toBe('file-123');
+        expect(passedOutboundPublishEvent.eventsDownloadLink).toBe('https://download.url');
+        expect(passedOutboundPublishEvent.eventsAdminDownloadLink).toBe('https://admin.download.url');
+        expect(spyFlex).toHaveBeenCalledTimes(1);
+        expect(spyEvent).toHaveBeenCalledTimes(1);
+        expect(spyEvent).toHaveBeenCalledWith(passedOutboundPublishEvent);
+        expect(result).toEqual({ ...flexResponse, outboundPublishEvent: passedOutboundPublishEvent });
+    });
+    it('should skip FlexPLM but still call sendPublishPayloadEvent when mode is vibeiqfile-dontsendtoflexplm', async () => {
+        const bppa = new base_process_publish_assortment_1.BaseProcessPublishAssortment(config, dc, mapFileUtil);
+        const spyFlex = jest.spyOn(flexplm_connect_1.FlexPLMConnect.prototype, 'sendToFlexPLM')
+            .mockResolvedValue({});
+        const spyEvent = jest.spyOn(bppa, 'sendPublishPayloadEvent')
+            .mockResolvedValue(undefined);
+        const result = await bppa.handleVibeIQFile(events, eventType, 'vibeiqfile-dontsendtoflexplm');
+        expect(spyFlex).not.toHaveBeenCalled();
+        expect(spyEvent).toHaveBeenCalledTimes(1);
+        const passedOutboundPublishEvent = spyEvent.mock.calls[0][0];
+        expect(passedOutboundPublishEvent.eventsFileId).toBe('file-123');
+        expect(result).toEqual({
+            message: 'Successfully Uploaded File.',
+            outboundPublishEvent: passedOutboundPublishEvent
+        });
+    });
+    it('should create an external-event with initialEvent parsed from config', async () => {
+        const bppa = new base_process_publish_assortment_1.BaseProcessPublishAssortment(config, dc, mapFileUtil);
+        const outboundPublishEvent = { foo: 'bar' };
+        await bppa.sendPublishPayloadEvent(outboundPublishEvent);
+        expect(createCallArg).toEqual({
+            entityName: 'external-event',
+            object: {
+                originSystemType: 'VibeIQ',
+                objectClass: 'AssortmentPublishedToFlexPLM',
+                outboundPublishEvent,
+                initialEvent: { sourceEventId: 'src-1' }
+            }
+        });
+    });
+    it('should default initialEvent to {} when config has no event', async () => {
+        const bareConfig = { taskId: 'task-x' };
+        const bppa = new base_process_publish_assortment_1.BaseProcessPublishAssortment(bareConfig, dc, mapFileUtil);
+        const outboundPublishEvent = { hello: 'world' };
+        await bppa.sendPublishPayloadEvent(outboundPublishEvent);
+        expect(createCallArg).toEqual({
+            entityName: 'external-event',
+            object: {
+                originSystemType: 'VibeIQ',
+                objectClass: 'AssortmentPublishedToFlexPLM',
+                outboundPublishEvent,
+                initialEvent: {}
+            }
+        });
+    });
+});

package/package.json

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