@contrail/flexplm 1.1.40 → 1.1.42

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

@@ -31,4 +31,7 @@ export declare abstract class BaseEntityProcessor {
     getOutboundEntityUpdates(event: any, flexResponse: any): Promise<any>;
     handleOutgoingDelete(entityType: any, event: any): Promise<void>;
     protected abstract getOutgoingUpsertPayload(entityType: any, event: any): Promise<EntityPayloadType>;
+    protected triggerNewEvent(triggerKey: string, event: any): Promise<any>;
+    protected sendUpsertToFlexPLM(event: any): Promise<any>;
+    protected getEntityCurrentStateUpsertPayload(event: any): Promise<EntityPayloadType>;
 }

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

@@ -133,6 +133,8 @@ class BaseEntityProcessor {
                 return await this.handleOutgoingUpsert(entityType, event);
             case 'delete':
                 return await this.handleOutgoingDelete(entityType, event);
+            case 'sendUpsertToFlexPLM':
+                return await this.sendUpsertToFlexPLM(event);
             default:
                 console.log(UNSUPPORTED_TYPE);
                 return {
@@ -171,5 +173,51 @@ class BaseEntityProcessor {
     async handleOutgoingDelete(entityType, event) {
         console.warn('delete is not configured', entityType, event.oldData);
     }
+    async triggerNewEvent(triggerKey, event) {
+        const newEvent = {
+            entityName: 'event-workflow-request',
+            object: {
+                triggerKey,
+                event
+            }
+        };
+        const response = await this.entities.create(newEvent);
+        return response;
+    }
+    async sendUpsertToFlexPLM(event) {
+        const payload = await this.getEntityCurrentStateUpsertPayload(event);
+        if (!payload) {
+            const message = 'No payload to send to FlexPLM';
+            console.log(message);
+            return {
+                status: 500,
+                data: { message }
+            };
+        }
+        ;
+        const flexResponse = await new flexplm_connect_1.FlexPLMConnect(this.config).sendToFlexPLM(payload);
+        const outboundEntityUpdates = await this.getOutboundEntityUpdates(event, flexResponse);
+        if (outboundEntityUpdates) {
+            flexResponse['outboundEntityUpdates'] = outboundEntityUpdates;
+        }
+        return flexResponse;
+    }
+    async getEntityCurrentStateUpsertPayload(event) {
+        const id = event.id;
+        if (!id) {
+            return undefined;
+        }
+        const entity = await this.entities.get({
+            entityName: this.baseType,
+            id
+        });
+        if (!entity) {
+            return undefined;
+        }
+        event.newData = entity;
+        event.oldData = entity;
+        const payload = await this.getOutgoingUpsertPayload(this.baseType, event);
+        return payload;
+    }
 }
 exports.BaseEntityProcessor = BaseEntityProcessor;

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

@@ -25,6 +25,7 @@ export declare class BaseProcessPublishAssortment {
         skip_await?: undefined;
     }>;
     getPublishInfo(assortmentId: string, assortmentPublishChangeId: string, apcHistory: any, publisher: any): Promise<any>;
+    getSnapshotVersion(assortment: any, apc: any): Promise<number | string>;
     getSeasonFederation(assortmentId: any): Promise<SeasonFederation>;
     getAssortment(assortmentId: any): Promise<any>;
     getSinceDate(assortmentId: any, assortmentPublishChangeId: any, apcHistory: object[]): Promise<Date>;

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

@@ -72,16 +72,52 @@ class BaseProcessPublishAssortment {
     }
     async getPublishInfo(assortmentId, assortmentPublishChangeId, apcHistory, publisher) {
         const apc = apcHistory?.find(apc => apc?.id === assortmentPublishChangeId) || {};
-        const assortmentName = (await this.getAssortment(assortmentId))?.name;
+        const assortment = await this.getAssortment(assortmentId);
+        const assortmentName = assortment?.name;
+        const versionHistoryNumber = await this.getSnapshotVersion(assortment, apc);
         const publishInfo = {
             assortmentName,
             versionName: apc?.versionName,
             versionComments: apc?.versionComments,
             publishDate: apc?.createdOn,
-            publisher
+            publisher,
+            versionHistoryNumber
         };
         return publishInfo;
     }
+    async getSnapshotVersion(assortment, apc) {
+        const entityReference = assortment?.createdForReference;
+        const createdOnString = apc?.createdOn;
+        if (!entityReference || !createdOnString || !apc?.id) {
+            return 'unknown';
+        }
+        const createdOnDate = new Date(createdOnString);
+        createdOnDate.setDate(createdOnDate.getDate() - 1);
+        const createdOnStringMinus1 = createdOnDate.toISOString();
+        const createdOn = 'ISGREATERTHAN ' + createdOnStringMinus1;
+        const snapshots = await new sdk_1.Entities().get({
+            entityName: 'entity-snapshot',
+            criteria: {
+                entityReference,
+                createdOn
+            }
+        });
+        const assortmentPublishChangeId = apc?.id;
+        const snapshot = snapshots.find(snap => snap?.assortmentChangeId === assortmentPublishChangeId);
+        let snapshotVersion = 'unknown';
+        if (snapshot && snapshot.versionNumber) {
+            snapshotVersion = snapshot.versionNumber;
+        }
+        else if (!snapshot) {
+            const createdOnTime = new Date(createdOnString).getTime();
+            const lastSnapshot = snapshots[snapshots.length - 1];
+            const lastSnapshotTime = new Date(lastSnapshot.createdOn).getTime();
+            if (createdOnTime > lastSnapshotTime) {
+                snapshotVersion = 'after: ' + lastSnapshot.versionNumber;
+            }
+        }
+        return snapshotVersion;
+    }
     async getSeasonFederation(assortmentId) {
         const assortment = await this.getAssortment(assortmentId);
         console.error('assortment-name: ' + assortment?.name);

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

@@ -28,11 +28,13 @@ jest.mock('../util/federation', () => {
         }
     };
 });
+let entityObject = {};
+let getOptionsObject = {};
 jest.mock('@contrail/sdk', () => {
-    const entityObject = { publishToFlexPLM: true };
     return {
         Entities: class {
-            get() {
+            get(_getOtionsObject) {
+                getOptionsObject = _getOtionsObject;
                 return entityObject;
             }
         }
@@ -46,6 +48,8 @@ describe('process publish assortment', () => {
     };
     beforeEach(() => {
         federatedId = '';
+        entityObject = { publishToFlexPLM: true };
+        getOptionsObject = {};
     });
     it('No Federation Info', async () => {
         const event = {
@@ -80,17 +84,24 @@ describe('getPublishInfo', () => {
             email: 'chris@vibeiq.com'
         };
         const assortmentName = 'VibeIQ Fall 2023';
-        const spy = jest.spyOn(ppa, 'getAssortment')
+        const versionHistoryNumber = 1234;
+        const spyGetAssortment = jest.spyOn(ppa, 'getAssortment')
             .mockImplementation(async (assortmentId) => {
             return { id: assortmentId, name: assortmentName };
         });
+        const spyyGetSnapshotVersion = jest.spyOn(ppa, 'getSnapshotVersion')
+            .mockImplementation(async (assortmentId, assortmentPublishChangeId) => {
+            return versionHistoryNumber;
+        });
         const publishInfo = await ppa.getPublishInfo(assortmentId, assortmentPublishChangeId, plan_history, publisher);
         expect(publishInfo.assortmentName).toEqual(assortmentName);
         expect(publishInfo.versionName).toEqual(versionName);
         expect(publishInfo.versionComments).toEqual(versionComments);
         expect(publishInfo.publishDate).toEqual(createdOn);
         expect(publishInfo.publisher).toEqual(publisher);
-        spy.mockRestore();
+        expect(publishInfo.versionHistoryNumber).toEqual(versionHistoryNumber);
+        spyGetAssortment.mockRestore();
+        spyyGetSnapshotVersion.mockRestore();
     });
     it('No Assortment Name', async () => {
         const ppa = new base_process_publish_assortment_1.BaseProcessPublishAssortment(config, dc, mapFileUtil);
@@ -98,17 +109,24 @@ describe('getPublishInfo', () => {
         const publisher = {
             email: 'chris@vibeiq.com'
         };
-        const spy = jest.spyOn(ppa, 'getAssortment')
+        const versionHistoryNumber = 1234;
+        const spyGetAssortment = jest.spyOn(ppa, 'getAssortment')
             .mockImplementation(async (assortmentId) => {
             return { id: assortmentId, name: undefined };
         });
+        const spyyGetSnapshotVersion = jest.spyOn(ppa, 'getSnapshotVersion')
+            .mockImplementation(async (assortmentId, assortmentPublishChangeId) => {
+            return versionHistoryNumber;
+        });
         const publishInfo = await ppa.getPublishInfo(assortmentId, assortmentPublishChangeId, plan_history, publisher);
         expect(publishInfo.assortmentName).toBeUndefined;
         expect(publishInfo.versionName).toEqual(versionName);
         expect(publishInfo.versionComments).toEqual(versionComments);
         expect(publishInfo.publishDate).toEqual(createdOn);
         expect(publishInfo.publisher).toEqual(publisher);
-        spy.mockRestore();
+        expect(publishInfo.versionHistoryNumber).toEqual(versionHistoryNumber);
+        spyGetAssortment.mockRestore();
+        spyyGetSnapshotVersion.mockRestore();
     });
     it('No Assortment', async () => {
         const ppa = new base_process_publish_assortment_1.BaseProcessPublishAssortment(config, dc, mapFileUtil);
@@ -116,17 +134,24 @@ describe('getPublishInfo', () => {
         const publisher = {
             email: 'chris@vibeiq.com'
         };
-        const spy = jest.spyOn(ppa, 'getAssortment')
+        const versionHistoryNumber = 1234;
+        const spyGetAssortment = jest.spyOn(ppa, 'getAssortment')
             .mockImplementation(async (assortmentId) => {
             return undefined;
         });
+        const spyyGetSnapshotVersion = jest.spyOn(ppa, 'getSnapshotVersion')
+            .mockImplementation(async (assortmentId, assortmentPublishChangeId) => {
+            return versionHistoryNumber;
+        });
         const publishInfo = await ppa.getPublishInfo(assortmentId, assortmentPublishChangeId, plan_history, publisher);
         expect(publishInfo.assortmentName).toBeUndefined();
         expect(publishInfo.versionName).toEqual(versionName);
         expect(publishInfo.versionComments).toEqual(versionComments);
         expect(publishInfo.publishDate).toEqual(createdOn);
         expect(publishInfo.publisher).toEqual(publisher);
-        spy.mockRestore();
+        expect(publishInfo.versionHistoryNumber).toEqual(versionHistoryNumber);
+        spyGetAssortment.mockRestore();
+        spyyGetSnapshotVersion.mockRestore();
     });
     it('Empty Version Name & Comments', async () => {
         const ppa = new base_process_publish_assortment_1.BaseProcessPublishAssortment(config, dc, mapFileUtil);
@@ -143,34 +168,48 @@ describe('getPublishInfo', () => {
             email: 'chris@vibeiq.com'
         };
         const assortmentName = 'VibeIQ Fall 2023';
-        const spy = jest.spyOn(ppa, 'getAssortment')
+        const versionHistoryNumber = 1234;
+        const spyGetAssortment = jest.spyOn(ppa, 'getAssortment')
             .mockImplementation(async (assortmentId) => {
             return { id: assortmentId, name: assortmentName };
         });
+        const spyyGetSnapshotVersion = jest.spyOn(ppa, 'getSnapshotVersion')
+            .mockImplementation(async (assortmentId, assortmentPublishChangeId) => {
+            return versionHistoryNumber;
+        });
         const publishInfo = await ppa.getPublishInfo(assortmentId, assortmentPublishChangeId, history, publisher);
         expect(publishInfo.assortmentName).toEqual(assortmentName);
         expect(publishInfo.versionName).toEqual('');
         expect(publishInfo.versionComments).toEqual('');
         expect(publishInfo.publishDate).toEqual(createdOn);
         expect(publishInfo.publisher).toEqual(publisher);
-        spy.mockRestore();
+        expect(publishInfo.versionHistoryNumber).toEqual(versionHistoryNumber);
+        spyGetAssortment.mockRestore();
+        spyyGetSnapshotVersion.mockRestore();
     });
     it('Undefined Publisher', async () => {
         const ppa = new base_process_publish_assortment_1.BaseProcessPublishAssortment(config, dc, mapFileUtil);
         const assortmentPublishChangeId = 'sJbGx1Fpq1v2MmcI';
         const publisher = undefined;
         const assortmentName = 'VibeIQ Fall 2023';
-        const spy = jest.spyOn(ppa, 'getAssortment')
+        const versionHistoryNumber = 1234;
+        const spyGetAssortment = jest.spyOn(ppa, 'getAssortment')
             .mockImplementation(async (assortmentId) => {
             return { id: assortmentId, name: assortmentName };
         });
+        const spyyGetSnapshotVersion = jest.spyOn(ppa, 'getSnapshotVersion')
+            .mockImplementation(async (assortmentId, assortmentPublishChangeId) => {
+            return versionHistoryNumber;
+        });
         const publishInfo = await ppa.getPublishInfo(assortmentId, assortmentPublishChangeId, plan_history, publisher);
         expect(publishInfo.assortmentName).toEqual(assortmentName);
         expect(publishInfo.versionName).toEqual(versionName);
         expect(publishInfo.versionComments).toEqual(versionComments);
         expect(publishInfo.publishDate).toEqual(createdOn);
         expect(publishInfo.publisher).toBeUndefined();
-        spy.mockRestore();
+        expect(publishInfo.versionHistoryNumber).toEqual(versionHistoryNumber);
+        spyGetAssortment.mockRestore();
+        spyyGetSnapshotVersion.mockRestore();
     });
     it('No APC', async () => {
         const ppa = new base_process_publish_assortment_1.BaseProcessPublishAssortment(config, dc, mapFileUtil);
@@ -179,17 +218,24 @@ describe('getPublishInfo', () => {
             email: 'chris@vibeiq.com'
         };
         const assortmentName = 'VibeIQ Fall 2023';
-        const spy = jest.spyOn(ppa, 'getAssortment')
+        const versionHistoryNumber = 1234;
+        const spyGetAssortment = jest.spyOn(ppa, 'getAssortment')
             .mockImplementation(async (assortmentId) => {
             return { id: assortmentId, name: assortmentName };
         });
+        const spyyGetSnapshotVersion = jest.spyOn(ppa, 'getSnapshotVersion')
+            .mockImplementation(async (assortmentId, assortmentPublishChangeId) => {
+            return versionHistoryNumber;
+        });
         const publishInfo = await ppa.getPublishInfo(assortmentId, assortmentPublishChangeId, plan_history, publisher);
         expect(publishInfo.assortmentName).toEqual(assortmentName);
         expect(publishInfo.versionName).toBeUndefined();
         expect(publishInfo.versionComments).toBeUndefined();
         expect(publishInfo.publishDate).toBeUndefined();
         expect(publishInfo.publisher).toEqual(publisher);
-        spy.mockRestore();
+        expect(publishInfo.versionHistoryNumber).toEqual(versionHistoryNumber);
+        spyGetAssortment.mockRestore();
+        spyyGetSnapshotVersion.mockRestore();
     });
     it('No APC history', async () => {
         const ppa = new base_process_publish_assortment_1.BaseProcessPublishAssortment(config, dc, mapFileUtil);
@@ -198,17 +244,125 @@ describe('getPublishInfo', () => {
             email: 'chris@vibeiq.com'
         };
         const assortmentName = 'VibeIQ Fall 2023';
-        const spy = jest.spyOn(ppa, 'getAssortment')
+        const versionHistoryNumber = 1234;
+        const spyGetAssortment = jest.spyOn(ppa, 'getAssortment')
             .mockImplementation(async (assortmentId) => {
             return { id: assortmentId, name: assortmentName };
         });
+        const spyyGetSnapshotVersion = jest.spyOn(ppa, 'getSnapshotVersion')
+            .mockImplementation(async (assortmentId, assortmentPublishChangeId) => {
+            return versionHistoryNumber;
+        });
         const publishInfo = await ppa.getPublishInfo(assortmentId, assortmentPublishChangeId, undefined, publisher);
         expect(publishInfo.assortmentName).toEqual(assortmentName);
         expect(publishInfo.versionName).toBeUndefined();
         expect(publishInfo.versionComments).toBeUndefined();
         expect(publishInfo.publishDate).toBeUndefined();
         expect(publishInfo.publisher).toEqual(publisher);
-        spy.mockRestore();
+        expect(publishInfo.versionHistoryNumber).toEqual(versionHistoryNumber);
+        spyGetAssortment.mockRestore();
+        spyyGetSnapshotVersion.mockRestore();
+    });
+});
+describe('getSnapshotVersion', () => {
+    const config = {
+        identifierAtts: {
+            LCSSeason: ['flexPLMSeasonName']
+        }
+    };
+    const mapFileUtil = new transform_data_1.MapFileUtil(new sdk_1.Entities());
+    const dc = new data_converter_1.DataConverter(config, mapFileUtil);
+    const ppa = new base_process_publish_assortment_1.BaseProcessPublishAssortment(config, dc, mapFileUtil);
+    beforeEach(() => {
+        federatedId = '';
+        entityObject = { publishToFlexPLM: true };
+        getOptionsObject = {};
+    });
+    it('has snapshot version', async () => {
+        const assortment = {
+            id: 'rm35clTNxvS4wm6y',
+            name: 'VibeIQ Fall 2023',
+            createdForReference: 'plan:w23wre'
+        };
+        const assortmentChangeId = 'sJbGx1Fpq1v2MmcI';
+        const apc = {
+            id: assortmentChangeId,
+            versionName: 'Version 1',
+            versionComments: 'Some Comments',
+            createdOn: '2023-01-15T19:13:58.902Z'
+        };
+        const versionNumber = 1234;
+        const snapshots = [
+            {
+                id: 'qewrwer',
+                assortmentChangeId,
+                versionNumber
+            }
+        ];
+        entityObject = snapshots;
+        const versionHistoryNumber = await ppa.getSnapshotVersion(assortment, apc);
+        expect(versionHistoryNumber).toEqual(versionNumber);
+        expect(getOptionsObject['entityName']).toEqual('entity-snapshot');
+        expect(getOptionsObject['criteria']['entityReference']).toEqual(assortment.createdForReference);
+        expect(getOptionsObject['criteria']['createdOn'].indexOf('ISGREATERTHAN')).toEqual(0);
+    });
+    it('doesnt find snapshot version, last snapshot after apc', async () => {
+        const assortment = {
+            id: 'rm35clTNxvS4wm6y',
+            name: 'VibeIQ Fall 2023',
+            createdForReference: 'plan:w23wre'
+        };
+        const assortmentChangeId = 'sJbGx1Fpq1v2MmcI';
+        const apc = {
+            id: assortmentChangeId,
+            versionName: 'Version 1',
+            versionComments: 'Some Comments',
+            createdOn: '2023-01-15T19:13:58.902Z'
+        };
+        const versionNumber = 1234;
+        const snapshots = [
+            {
+                id: 'qewrwer',
+                assortmentChangeId: 'bad-id',
+                createdOn: '2024-01-15T19:13:58.902Z',
+                versionNumber
+            }
+        ];
+        entityObject = snapshots;
+        const versionHistoryNumber = await ppa.getSnapshotVersion(assortment, apc);
+        expect(versionHistoryNumber).toEqual('unknown');
+        expect(getOptionsObject['entityName']).toEqual('entity-snapshot');
+        expect(getOptionsObject['criteria']['entityReference']).toEqual(assortment.createdForReference);
+        expect(getOptionsObject['criteria']['createdOn'].indexOf('ISGREATERTHAN')).toEqual(0);
+    });
+    it('doesnt find snapshot version, last snapshot before apc', async () => {
+        const assortment = {
+            id: 'rm35clTNxvS4wm6y',
+            name: 'VibeIQ Fall 2023',
+            createdForReference: 'plan:w23wre'
+        };
+        const assortmentChangeId = 'sJbGx1Fpq1v2MmcI';
+        const apc = {
+            id: assortmentChangeId,
+            versionName: 'Version 1',
+            versionComments: 'Some Comments',
+            createdOn: '2023-01-15T19:13:58.902Z'
+        };
+        const versionNumber = 1234;
+        const snapshots = [
+            {
+                id: 'qewrwer',
+                assortmentChangeId: 'bad-id',
+                createdOn: '2023-01-14T19:13:58.902Z',
+                versionNumber
+            }
+        ];
+        entityObject = snapshots;
+        const versionHistoryNumber = await ppa.getSnapshotVersion(assortment, apc);
+        expect(versionHistoryNumber).toEqual('after: ' + versionNumber);
+        expect(getOptionsObject['entityName']).toEqual('entity-snapshot');
+        expect(getOptionsObject['criteria']['entityReference']).toEqual(assortment.createdForReference);
+        expect(getOptionsObject['criteria']['createdOn'].indexOf('ISGREATERTHAN')).toEqual(0);
     });
 });
 describe('getSeasonFederation', () => {
@@ -219,6 +373,8 @@ describe('getSeasonFederation', () => {
     };
     beforeEach(() => {
         federatedId = '';
+        entityObject = { publishToFlexPLM: true };
+        getOptionsObject = {};
     });
     it('No Federation Info', async () => {
         const assortmentId = 'B3oRQpYVYzcJAJtQ';

package/package.json

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

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

@@ -176,6 +176,8 @@ export abstract class BaseEntityProcessor {
       return await this.handleOutgoingUpsert(entityType, event);
     case 'delete':
       return await this.handleOutgoingDelete(entityType, event);
+    case 'sendUpsertToFlexPLM':
+      return await this.sendUpsertToFlexPLM(event);
     default:
       console.log(UNSUPPORTED_TYPE);
       return {
@@ -223,4 +225,82 @@ export abstract class BaseEntityProcessor {
 
   // This method must be implemented by derived classes
   protected abstract getOutgoingUpsertPayload(entityType, event): Promise<EntityPayloadType>;
+
+  /** Create a new event-workflow-request to rerun sending the entity to FlexPLM
+   * The event must contain any information needed to ensure it is put in the correct queue for the entity
+   *
+   * @param triggerKey Ex: event.entityType + '|sendUpsertToFlexPLM'
+   * @param event
+   * @returns
+   */
+
+  protected async triggerNewEvent(triggerKey: string, event: any) {
+    const newEvent = {
+      entityName: 'event-workflow-request',
+      object: {
+        triggerKey,
+        event
+      }
+  };
+  const response = await this.entities.create(newEvent);
+
+    return response;
+  }
+
+  /** Sends the current state of the entity to FlexPLM.
+   * So any changes made in Vibe between the event being generated and the event being processed are sent to FlexPLM.
+   *
+   * @param event must contain entityType, id; which are used to query for the entity
+   * @returns results of sending the entity to FlexPLM
+   */
+  protected async sendUpsertToFlexPLM(event) {
+    const payload = await this.getEntityCurrentStateUpsertPayload(event);
+    if(!payload){
+      const message = 'No payload to send to FlexPLM';
+      console.log(message);
+      return {
+        status: 500,
+        data: {message}
+      };
+    };
+    const flexResponse: any = await new FlexPLMConnect(this.config).sendToFlexPLM(payload);
+
+    const outboundEntityUpdates = await this.getOutboundEntityUpdates(event, flexResponse);
+    if(outboundEntityUpdates){
+      flexResponse['outboundEntityUpdates'] = outboundEntityUpdates;
+    }
+
+    return flexResponse;
+
+  }
+
+  /** Generates the payload to send to FlexPLM, based on the current state of the entity.
+   * The current state of the entity are used as the newData and oldData; which is passed
+   * to getOutgoingUpsertPayload to generate the payload.
+   * @param event information about the item to send to FlexPLM
+   * @returns The payload to send to FlexPLM
+   */
+  protected async getEntityCurrentStateUpsertPayload(event: any): Promise<EntityPayloadType> {
+
+    const id = event.id;
+    if(!id){
+      return undefined;
+    }
+
+    const entity = await this.entities.get({
+      entityName: this.baseType,
+      id
+    });
+
+    if(!entity){
+      return undefined;
+    }
+
+    event.newData = entity;
+    event.oldData = entity;
+
+    const payload = await this.getOutgoingUpsertPayload(this.baseType, event);
+
+    return payload;
+  }
 }

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

@@ -30,11 +30,13 @@ jest.mock('../util/federation', () => {
     }
   };
 });
+let entityObject = {};
+let getOptionsObject = {};
 jest.mock('@contrail/sdk', () => {
-  const entityObject = { publishToFlexPLM: true };
   return {
-    Entities: class {
-      get() {
+    Entities: class{
+      get(_getOtionsObject){
+        getOptionsObject = _getOtionsObject;
         return entityObject;
       }
     }
@@ -48,6 +50,8 @@ describe('process publish assortment', () => {
   } as unknown as FCConfig;
   beforeEach(() => {
     federatedId = '';
+    entityObject = {publishToFlexPLM:true};
+    getOptionsObject = {};
   });
   it('No Federation Info', async () => {
     const event = {
@@ -86,17 +90,25 @@ describe('getPublishInfo', () =>{
       email: 'chris@vibeiq.com'
     };
     const assortmentName = 'VibeIQ Fall 2023';
-    const spy = jest.spyOn(ppa, 'getAssortment')
+    const versionHistoryNumber = 1234;
+    const spyGetAssortment = jest.spyOn(ppa, 'getAssortment')
       .mockImplementation(async (assortmentId) => {
         return {id: assortmentId, name: assortmentName};
       });
+    const spyyGetSnapshotVersion = jest.spyOn(ppa, 'getSnapshotVersion')
+      // eslint-disable-next-line unused-imports/no-unused-vars, @typescript-eslint/no-unused-vars
+      .mockImplementation(async (assortmentId, assortmentPublishChangeId) => {
+        return versionHistoryNumber;
+      });
     const publishInfo = await ppa.getPublishInfo(assortmentId, assortmentPublishChangeId, plan_history, publisher);
     expect(publishInfo.assortmentName).toEqual(assortmentName);
     expect(publishInfo.versionName).toEqual(versionName);
     expect(publishInfo.versionComments).toEqual(versionComments);
     expect(publishInfo.publishDate).toEqual(createdOn);
     expect(publishInfo.publisher).toEqual(publisher);
-    spy.mockRestore();
+    expect(publishInfo.versionHistoryNumber).toEqual(versionHistoryNumber);
+    spyGetAssortment.mockRestore();
+    spyyGetSnapshotVersion.mockRestore();
   });
 
   it('No Assortment Name', async () =>{
@@ -106,17 +118,25 @@ describe('getPublishInfo', () =>{
     const publisher = {
       email: 'chris@vibeiq.com'
     };
-    const spy = jest.spyOn(ppa, 'getAssortment')
+    const versionHistoryNumber = 1234;
+    const spyGetAssortment = jest.spyOn(ppa, 'getAssortment')
       .mockImplementation(async (assortmentId) => {
         return {id: assortmentId, name: undefined};
       });
+    const spyyGetSnapshotVersion = jest.spyOn(ppa, 'getSnapshotVersion')
+      // eslint-disable-next-line unused-imports/no-unused-vars, @typescript-eslint/no-unused-vars
+      .mockImplementation(async (assortmentId, assortmentPublishChangeId) => {
+        return versionHistoryNumber;
+      });
     const publishInfo = await ppa.getPublishInfo(assortmentId, assortmentPublishChangeId, plan_history, publisher);
     expect(publishInfo.assortmentName).toBeUndefined;
     expect(publishInfo.versionName).toEqual(versionName);
     expect(publishInfo.versionComments).toEqual(versionComments);
     expect(publishInfo.publishDate).toEqual(createdOn);
     expect(publishInfo.publisher).toEqual(publisher);
-    spy.mockRestore();
+    expect(publishInfo.versionHistoryNumber).toEqual(versionHistoryNumber);
+    spyGetAssortment.mockRestore();
+    spyyGetSnapshotVersion.mockRestore();
   });
 
   it('No Assortment', async () =>{
@@ -126,17 +146,25 @@ describe('getPublishInfo', () =>{
     const publisher = {
       email: 'chris@vibeiq.com'
     };
-    const spy = jest.spyOn(ppa, 'getAssortment')
+    const versionHistoryNumber = 1234;
+    const spyGetAssortment = jest.spyOn(ppa, 'getAssortment')
       .mockImplementation(async (assortmentId) => {
         return undefined;
       });
+    const spyyGetSnapshotVersion = jest.spyOn(ppa, 'getSnapshotVersion')
+      // eslint-disable-next-line unused-imports/no-unused-vars, @typescript-eslint/no-unused-vars
+      .mockImplementation(async (assortmentId, assortmentPublishChangeId) => {
+        return versionHistoryNumber;
+      });
     const publishInfo = await ppa.getPublishInfo(assortmentId, assortmentPublishChangeId, plan_history, publisher);
     expect(publishInfo.assortmentName).toBeUndefined();
     expect(publishInfo.versionName).toEqual(versionName);
     expect(publishInfo.versionComments).toEqual(versionComments);
     expect(publishInfo.publishDate).toEqual(createdOn);
     expect(publishInfo.publisher).toEqual(publisher);
-    spy.mockRestore();
+    expect(publishInfo.versionHistoryNumber).toEqual(versionHistoryNumber);
+    spyGetAssortment.mockRestore();
+    spyyGetSnapshotVersion.mockRestore();
   });
 
   it('Empty Version Name & Comments', async () =>{
@@ -154,17 +182,25 @@ describe('getPublishInfo', () =>{
       email: 'chris@vibeiq.com'
     };
     const assortmentName = 'VibeIQ Fall 2023';
-    const spy = jest.spyOn(ppa, 'getAssortment')
+    const versionHistoryNumber = 1234;
+    const spyGetAssortment = jest.spyOn(ppa, 'getAssortment')
       .mockImplementation(async (assortmentId) => {
         return {id: assortmentId, name: assortmentName};
       });
+    const spyyGetSnapshotVersion = jest.spyOn(ppa, 'getSnapshotVersion')
+      // eslint-disable-next-line unused-imports/no-unused-vars, @typescript-eslint/no-unused-vars
+      .mockImplementation(async (assortmentId, assortmentPublishChangeId) => {
+        return versionHistoryNumber;
+      });
     const publishInfo = await ppa.getPublishInfo(assortmentId, assortmentPublishChangeId, history, publisher);
     expect(publishInfo.assortmentName).toEqual(assortmentName);
     expect(publishInfo.versionName).toEqual('');
     expect(publishInfo.versionComments).toEqual('');
     expect(publishInfo.publishDate).toEqual(createdOn);
     expect(publishInfo.publisher).toEqual(publisher);
-    spy.mockRestore();
+    expect(publishInfo.versionHistoryNumber).toEqual(versionHistoryNumber);
+    spyGetAssortment.mockRestore();
+    spyyGetSnapshotVersion.mockRestore();
   });
 
   it('Undefined Publisher', async () =>{
@@ -173,17 +209,25 @@ describe('getPublishInfo', () =>{
     const assortmentPublishChangeId = 'sJbGx1Fpq1v2MmcI';
     const publisher = undefined;
     const assortmentName = 'VibeIQ Fall 2023';
-    const spy = jest.spyOn(ppa, 'getAssortment')
+    const versionHistoryNumber = 1234;
+    const spyGetAssortment = jest.spyOn(ppa, 'getAssortment')
       .mockImplementation(async (assortmentId) => {
         return {id: assortmentId, name: assortmentName};
       });
+    const spyyGetSnapshotVersion = jest.spyOn(ppa, 'getSnapshotVersion')
+      // eslint-disable-next-line unused-imports/no-unused-vars, @typescript-eslint/no-unused-vars
+      .mockImplementation(async (assortmentId, assortmentPublishChangeId) => {
+        return versionHistoryNumber;
+      });
     const publishInfo = await ppa.getPublishInfo(assortmentId, assortmentPublishChangeId, plan_history, publisher);
     expect(publishInfo.assortmentName).toEqual(assortmentName);
     expect(publishInfo.versionName).toEqual(versionName);
     expect(publishInfo.versionComments).toEqual(versionComments);
     expect(publishInfo.publishDate).toEqual(createdOn);
     expect(publishInfo.publisher).toBeUndefined();
-    spy.mockRestore();
+    expect(publishInfo.versionHistoryNumber).toEqual(versionHistoryNumber);
+    spyGetAssortment.mockRestore();
+    spyyGetSnapshotVersion.mockRestore();
   });
 
   it('No APC', async () =>{
@@ -194,17 +238,25 @@ describe('getPublishInfo', () =>{
       email: 'chris@vibeiq.com'
     };
     const assortmentName = 'VibeIQ Fall 2023';
-    const spy = jest.spyOn(ppa, 'getAssortment')
+    const versionHistoryNumber = 1234;
+    const spyGetAssortment = jest.spyOn(ppa, 'getAssortment')
       .mockImplementation(async (assortmentId) => {
         return {id: assortmentId, name: assortmentName};
       });
+    const spyyGetSnapshotVersion = jest.spyOn(ppa, 'getSnapshotVersion')
+      // eslint-disable-next-line unused-imports/no-unused-vars, @typescript-eslint/no-unused-vars
+      .mockImplementation(async (assortmentId, assortmentPublishChangeId) => {
+        return versionHistoryNumber;
+      });
     const publishInfo = await ppa.getPublishInfo(assortmentId, assortmentPublishChangeId, plan_history, publisher);
     expect(publishInfo.assortmentName).toEqual(assortmentName);
     expect(publishInfo.versionName).toBeUndefined();
     expect(publishInfo.versionComments).toBeUndefined();
     expect(publishInfo.publishDate).toBeUndefined();
     expect(publishInfo.publisher).toEqual(publisher);
-    spy.mockRestore();
+    expect(publishInfo.versionHistoryNumber).toEqual(versionHistoryNumber);
+    spyGetAssortment.mockRestore();
+    spyyGetSnapshotVersion.mockRestore();
   });
 
   it('No APC history', async () =>{
@@ -215,21 +267,148 @@ describe('getPublishInfo', () =>{
       email: 'chris@vibeiq.com'
     };
     const assortmentName = 'VibeIQ Fall 2023';
-    const spy = jest.spyOn(ppa, 'getAssortment')
+    const versionHistoryNumber = 1234;
+    const spyGetAssortment = jest.spyOn(ppa, 'getAssortment')
       .mockImplementation(async (assortmentId) => {
         return {id: assortmentId, name: assortmentName};
       });
+    const spyyGetSnapshotVersion = jest.spyOn(ppa, 'getSnapshotVersion')
+      // eslint-disable-next-line unused-imports/no-unused-vars, @typescript-eslint/no-unused-vars
+      .mockImplementation(async (assortmentId, assortmentPublishChangeId) => {
+        return versionHistoryNumber;
+      });
     const publishInfo = await ppa.getPublishInfo(assortmentId, assortmentPublishChangeId, undefined, publisher);
     expect(publishInfo.assortmentName).toEqual(assortmentName);
     expect(publishInfo.versionName).toBeUndefined();
     expect(publishInfo.versionComments).toBeUndefined();
     expect(publishInfo.publishDate).toBeUndefined();
     expect(publishInfo.publisher).toEqual(publisher);
-    spy.mockRestore();
+    expect(publishInfo.versionHistoryNumber).toEqual(versionHistoryNumber);
+    spyGetAssortment.mockRestore();
+    spyyGetSnapshotVersion.mockRestore();
   });
 
 });
-describe('getSeasonFederation', () => {
+
+describe('getSnapshotVersion', () =>{
+  const config = {
+    identifierAtts: {
+      LCSSeason: ['flexPLMSeasonName']
+    }
+  } as unknown as FCConfig;
+  const mapFileUtil = new MapFileUtil(new Entities());
+  const dc = new DataConverter(config, mapFileUtil);
+  const ppa = new BaseProcessPublishAssortment(config, dc, mapFileUtil);
+  beforeEach(() =>{
+    federatedId = '';
+    entityObject = { publishToFlexPLM:true};
+    getOptionsObject = {};
+  });
+
+  it('has snapshot version', async () =>{
+    const assortment = {
+      id: 'rm35clTNxvS4wm6y',
+      name: 'VibeIQ Fall 2023',
+      createdForReference: 'plan:w23wre'
+    };
+    const assortmentChangeId = 'sJbGx1Fpq1v2MmcI';
+    const apc = {
+      id: assortmentChangeId,
+      versionName: 'Version 1',
+      versionComments: 'Some Comments',
+      createdOn: '2023-01-15T19:13:58.902Z'
+    };
+
+    const versionNumber = 1234;
+    const snapshots = [
+      {
+        id: 'qewrwer',
+        assortmentChangeId,
+        versionNumber
+      }
+    ];
+
+    entityObject = snapshots;
+
+    const versionHistoryNumber = await ppa.getSnapshotVersion(assortment, apc);
+
+    expect(versionHistoryNumber).toEqual(versionNumber);
+    expect(getOptionsObject['entityName']).toEqual('entity-snapshot');
+    expect(getOptionsObject['criteria']['entityReference']).toEqual(assortment.createdForReference);
+    expect(getOptionsObject['criteria']['createdOn'].indexOf('ISGREATERTHAN')).toEqual(0);
+  });
+
+  it('doesnt find snapshot version, last snapshot after apc', async () =>{
+    const assortment = {
+      id: 'rm35clTNxvS4wm6y',
+      name: 'VibeIQ Fall 2023',
+      createdForReference: 'plan:w23wre'
+    };
+    const assortmentChangeId = 'sJbGx1Fpq1v2MmcI';
+    const apc = {
+      id: assortmentChangeId,
+      versionName: 'Version 1',
+      versionComments: 'Some Comments',
+      createdOn: '2023-01-15T19:13:58.902Z'
+    };
+
+    const versionNumber = 1234;
+    const snapshots = [
+      {
+        id: 'qewrwer',
+        assortmentChangeId: 'bad-id',
+        createdOn: '2024-01-15T19:13:58.902Z',
+        versionNumber
+      }
+    ];
+
+    entityObject = snapshots;
+
+    const versionHistoryNumber = await ppa.getSnapshotVersion(assortment, apc);
+
+    expect(versionHistoryNumber).toEqual('unknown');
+    expect(getOptionsObject['entityName']).toEqual('entity-snapshot');
+    expect(getOptionsObject['criteria']['entityReference']).toEqual(assortment.createdForReference);
+    expect(getOptionsObject['criteria']['createdOn'].indexOf('ISGREATERTHAN')).toEqual(0);
+  });
+
+  it('doesnt find snapshot version, last snapshot before apc', async () =>{
+    const assortment = {
+      id: 'rm35clTNxvS4wm6y',
+      name: 'VibeIQ Fall 2023',
+      createdForReference: 'plan:w23wre'
+    };
+    const assortmentChangeId = 'sJbGx1Fpq1v2MmcI';
+    const apc = {
+      id: assortmentChangeId,
+      versionName: 'Version 1',
+      versionComments: 'Some Comments',
+      createdOn: '2023-01-15T19:13:58.902Z'
+    };
+
+    const versionNumber = 1234;
+    const snapshots = [
+      {
+        id: 'qewrwer',
+        assortmentChangeId: 'bad-id',
+        createdOn: '2023-01-14T19:13:58.902Z',
+        versionNumber
+      }
+    ];
+
+    entityObject = snapshots;
+
+    const versionHistoryNumber = await ppa.getSnapshotVersion(assortment, apc);
+
+    expect(versionHistoryNumber).toEqual('after: '+ versionNumber);
+    expect(getOptionsObject['entityName']).toEqual('entity-snapshot');
+    expect(getOptionsObject['criteria']['entityReference']).toEqual(assortment.createdForReference);
+    expect(getOptionsObject['criteria']['createdOn'].indexOf('ISGREATERTHAN')).toEqual(0);
+  });
+
+});
+
+describe('getSeasonFederation', () =>{
   const config = {
     identifierAtts: {
       LCSSeason: ['flexPLMSeasonName']
@@ -237,6 +416,8 @@ describe('getSeasonFederation', () => {
   } as unknown as FCConfig;
   beforeEach(() => {
     federatedId = '';
+    entityObject = { publishToFlexPLM:true};
+    getOptionsObject = {};
   });
   it('No Federation Info', async () => {
     const assortmentId = 'B3oRQpYVYzcJAJtQ';

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

@@ -95,18 +95,66 @@ export class BaseProcessPublishAssortment {
   }
   async getPublishInfo(assortmentId: string, assortmentPublishChangeId: string, apcHistory: any, publisher: any): Promise<any> {
     const apc = apcHistory?.find(apc => apc?.id === assortmentPublishChangeId) || {};
-    const assortmentName = (await this.getAssortment(assortmentId))?.name;
+    const assortment = await this.getAssortment(assortmentId);
+    const assortmentName = assortment?.name;
+    const versionHistoryNumber = await this.getSnapshotVersion(assortment, apc);
     const publishInfo = {
       assortmentName,
       versionName: apc?.versionName,
       versionComments: apc?.versionComments,
       publishDate: apc?.createdOn,
-      publisher
+      publisher,
+      versionHistoryNumber
     };
 
     return publishInfo;
   }
 
+  /** Gets the version number of the snapshot that was created for the publish change.
+   * But if no snapshot was found for the publish change, and the last snapshot was
+   * created before the publish change, then it returns 'after: versionNumber' where
+   * versionNumber is the version number of the last snapshot.
+   * If no snapshot was found for the publish change, and the last snapshot was
+   * created after the publish change, then it returns 'unknown'.
+   *
+   * @returns versionNumber or 'unknown' or 'after: versionNumber'
+   */
+  async getSnapshotVersion(assortment: any, apc: any ): Promise<number|string>{
+    const entityReference = assortment?.createdForReference;
+    const createdOnString = apc?.createdOn;
+    if(!entityReference || !createdOnString || !apc?.id){
+      return 'unknown';
+    }
+    const createdOnDate = new Date(createdOnString);
+    createdOnDate.setDate(createdOnDate.getDate() - 1);//subtract 1 day
+    const createdOnStringMinus1 = createdOnDate.toISOString();
+    const createdOn = 'ISGREATERTHAN ' + createdOnStringMinus1;
+
+    const snapshots = await new Entities().get({
+      entityName: 'entity-snapshot',
+      criteria: {
+        entityReference,
+        createdOn
+      }
+    });
+
+    const assortmentPublishChangeId = apc?.id;
+    const snapshot = snapshots.find(snap => snap?.assortmentChangeId === assortmentPublishChangeId);
+    let snapshotVersion = 'unknown';
+    if(snapshot && snapshot.versionNumber){
+      snapshotVersion = snapshot.versionNumber;
+    } else if(!snapshot){
+      const createdOnTime = new Date(createdOnString).getTime();
+      const lastSnapshot = snapshots[snapshots.length - 1];
+      const lastSnapshotTime = new Date(lastSnapshot.createdOn).getTime();
+      if(createdOnTime > lastSnapshotTime){
+        snapshotVersion = 'after: ' + lastSnapshot.versionNumber;
+      }
+
+    }
+
+    return snapshotVersion;
+  }
   async getSeasonFederation(assortmentId): Promise<SeasonFederation> {
     const assortment = await this.getAssortment(assortmentId);
     console.error('assortment-name: ' + assortment?.name);