@contrail/flexplm 1.2.1 → 1.3.0-alpha.04c91a9

package/src/util/federation.ts

@@ -1,172 +1,172 @@
-import { Entities } from '@contrail/sdk';
-
-import { FederationRecord } from '../interfaces/interfaces';
-import pLimit from 'p-limit';
-const limit = pLimit(30);
-
-interface fedConfigDef {
-  appIdentifier: string,
-  federationSchema: string
-}
-const FED_CONFIG: fedConfigDef = {
-  appIdentifier: '@vibeiq/flexplm-connector',
-  federationSchema: 'DEFAULT'
-};
-export class Federation {
-
-  private CHUNK_SIZE = 50;
-
-  async getFederatedMappedRefId(entityType: string, entityId: string) {
-    const criteria = {
-      reference: entityType + ':' + entityId,
-      appIdentifier: FED_CONFIG.appIdentifier,
-      federationSchema: FED_CONFIG.federationSchema
-    };
-    console.log('getFederatedMappedRefId: ' + JSON.stringify(criteria));
-    const fedRecords: FederationRecord[] = await new Entities().get({
-      entityName: 'federation',
-      criteria
-    });
-
-    const federatedId = (fedRecords[0])
-      ? fedRecords[0]['mappedReference']
-      : '';
-
-    return federatedId;
-  }
-
-  async createFederatedRecord(eventBody) {
-    const itemResults = eventBody.payload;
-    for (let i = 0; i < itemResults.length; i++) {
-      if (!itemResults[i].federatedId) {
-        continue;
-      }
-      const payload: FederationRecord = {
-        appIdentifier: FED_CONFIG.appIdentifier,
-        reference: itemResults[i].entityReference,
-        mappedReference: itemResults[i].federatedId,
-        federationSchema: FED_CONFIG.federationSchema
-      };
-      // console.log('createFederatedRecord: ' + JSON.stringify(payload));
-
-      try {
-        const results = await new Entities().create({ entityName: 'federation', object: payload });
-        return results;
-        // console.log(JSON.stringify(results));
-      } catch (error) {
-        console.log('createFederatedRecord-error: ', error);
-        throw new Error('Error creating federation record: ' + error.message);
-      }
-    }
-  }
-
-  async getFederationRecordFromMappedRefId(mappedRefId: string) {
-    const criteria = {
-      appIdentifier: FED_CONFIG.appIdentifier,
-      mappedReference: mappedRefId,
-      federationSchema: FED_CONFIG.federationSchema
-    };
-    try {
-      const fedRecords: FederationRecord[] = await new Entities().get({
-        entityName: 'federation',
-        criteria
-      });
-      return (fedRecords && fedRecords[0]) ? fedRecords[0] : undefined;
-    } catch (e) {
-      console.log('getFederationData-error: ' + e.message);
-    }
-    return undefined;
-  }
-
-  static getEntityId(fedRecord: FederationRecord) {
-    const entityString = fedRecord['reference'];
-    const entitySplit = entityString.split(':');
-    const entityType = entitySplit[0];
-    const entityId = entitySplit[1];
-
-    return { entityType, entityId };
-
-  }
-
-  async getEntityFromMappedRefId(mappedRefId: string) {
-    // console.log('!---getEntityFromMappedRefId: ' + mappedRefId);
-    const fedRecord = await this.getFederationRecordFromMappedRefId(mappedRefId);
-    console.log('fedRecord: ' + JSON.stringify(fedRecord));
-    if (!fedRecord) {
-      //Not creating from FlexPLM at this time.
-      console.log('Federation Record doesnt exist. Cant get entity!');
-      return;
-    }
-
-    const { entityType, entityId } = Federation.getEntityId(fedRecord);
-    // console.log(entityType + ':' + entityId);
-    const criteria = {
-      id: entityId
-    };
-    const entities = await new Entities().get({
-      entityName: entityType,
-      criteria
-    });
-    const entity = (entities && entities[0]) ? entities[0] : undefined;
-    // console.log(' entities: ' +JSON.stringify(entities));
-    return entity;
-  }
-
-  async getFederationRecordsFromIds(ids: string[]): Promise<FederationRecord[]> {
-    const fedRecords = [];
-    for (let i = 0; i < ids.length; i++) {
-      const criteria = {
-        reference: ids[i],
-        appIdentifier: FED_CONFIG.appIdentifier,
-        federationSchema: FED_CONFIG.federationSchema
-      };
-      // this.logger.log('getFederatedMappedRefId: ' + JSON.stringify(criteria));
-      const recs: FederationRecord[] = await new Entities().get({
-        entityName: 'federation',
-        criteria
-      });
-      if (recs[0]) {
-        fedRecords.push(recs[0]);
-      }
-    }
-
-    return fedRecords;
-  }
-
-  async getFederationRecordsFromIdsBulk(ids: string[]): Promise<FederationRecord[]> {
-
-    const chunks: string[][] = this.splitIntoChunksByLen(ids, this.CHUNK_SIZE);
-    const fedRecords = [];
-    const federatedPromises = [];
-    const entities: Entities = new Entities();
-    for (const chunk of chunks) {
-      const fedPromise = limit(async () => {
-        const criteria = {
-          references: chunk,
-          appIdentifier: FED_CONFIG.appIdentifier,
-          federationSchema: FED_CONFIG.federationSchema
-        };
-        // this.logger.log('getFederatedMappedRefId: ' + JSON.stringify(criteria));
-        const records: FederationRecord[] = await entities.get({
-          entityName: 'federation',
-          criteria
-        });
-        fedRecords.push(...records);
-
-      });
-      federatedPromises.push(fedPromise);
-    }
-    await Promise.all(federatedPromises);
-
-    return fedRecords;
-  }
-
-  splitIntoChunksByLen(arr, len) {
-    const chunks = [], n = arr?.length;
-    let i = 0;
-    while (i < n) {
-      chunks.push(arr.slice(i, i += len));
-    }
-    return chunks;
-  }
-}
+import { Entities } from '@contrail/sdk';
+
+import { FederationRecord } from '../interfaces/interfaces';
+import pLimit from 'p-limit';
+const limit = pLimit(30);
+
+interface fedConfigDef {
+  appIdentifier: string,
+  federationSchema: string
+}
+const FED_CONFIG: fedConfigDef = {
+  appIdentifier: '@vibeiq/flexplm-connector',
+  federationSchema: 'DEFAULT'
+};
+export class Federation {
+
+  private CHUNK_SIZE = 50;
+
+  async getFederatedMappedRefId(entityType: string, entityId: string) {
+    const criteria = {
+      reference: entityType + ':' + entityId,
+      appIdentifier: FED_CONFIG.appIdentifier,
+      federationSchema: FED_CONFIG.federationSchema
+    };
+    console.log('getFederatedMappedRefId: ' + JSON.stringify(criteria));
+    const fedRecords: FederationRecord[] = await new Entities().get({
+      entityName: 'federation',
+      criteria
+    });
+
+    const federatedId = (fedRecords[0])
+      ? fedRecords[0]['mappedReference']
+      : '';
+
+    return federatedId;
+  }
+
+  async createFederatedRecord(eventBody) {
+    const itemResults = eventBody.payload;
+    for (let i = 0; i < itemResults.length; i++) {
+      if (!itemResults[i].federatedId) {
+        continue;
+      }
+      const payload: FederationRecord = {
+        appIdentifier: FED_CONFIG.appIdentifier,
+        reference: itemResults[i].entityReference,
+        mappedReference: itemResults[i].federatedId,
+        federationSchema: FED_CONFIG.federationSchema
+      };
+      // console.log('createFederatedRecord: ' + JSON.stringify(payload));
+
+      try {
+        const results = await new Entities().create({ entityName: 'federation', object: payload });
+        return results;
+        // console.log(JSON.stringify(results));
+      } catch (error) {
+        console.log('createFederatedRecord-error: ', error);
+        throw new Error('Error creating federation record: ' + error.message);
+      }
+    }
+  }
+
+  async getFederationRecordFromMappedRefId(mappedRefId: string) {
+    const criteria = {
+      appIdentifier: FED_CONFIG.appIdentifier,
+      mappedReference: mappedRefId,
+      federationSchema: FED_CONFIG.federationSchema
+    };
+    try {
+      const fedRecords: FederationRecord[] = await new Entities().get({
+        entityName: 'federation',
+        criteria
+      });
+      return (fedRecords && fedRecords[0]) ? fedRecords[0] : undefined;
+    } catch (e) {
+      console.log('getFederationData-error: ' + e.message);
+    }
+    return undefined;
+  }
+
+  static getEntityId(fedRecord: FederationRecord) {
+    const entityString = fedRecord['reference'];
+    const entitySplit = entityString.split(':');
+    const entityType = entitySplit[0];
+    const entityId = entitySplit[1];
+
+    return { entityType, entityId };
+
+  }
+
+  async getEntityFromMappedRefId(mappedRefId: string) {
+    // console.log('!---getEntityFromMappedRefId: ' + mappedRefId);
+    const fedRecord = await this.getFederationRecordFromMappedRefId(mappedRefId);
+    console.log('fedRecord: ' + JSON.stringify(fedRecord));
+    if (!fedRecord) {
+      //Not creating from FlexPLM at this time.
+      console.log('Federation Record doesnt exist. Cant get entity!');
+      return;
+    }
+
+    const { entityType, entityId } = Federation.getEntityId(fedRecord);
+    // console.log(entityType + ':' + entityId);
+    const criteria = {
+      id: entityId
+    };
+    const entities = await new Entities().get({
+      entityName: entityType,
+      criteria
+    });
+    const entity = (entities && entities[0]) ? entities[0] : undefined;
+    // console.log(' entities: ' +JSON.stringify(entities));
+    return entity;
+  }
+
+  async getFederationRecordsFromIds(ids: string[]): Promise<FederationRecord[]> {
+    const fedRecords = [];
+    for (let i = 0; i < ids.length; i++) {
+      const criteria = {
+        reference: ids[i],
+        appIdentifier: FED_CONFIG.appIdentifier,
+        federationSchema: FED_CONFIG.federationSchema
+      };
+      // this.logger.log('getFederatedMappedRefId: ' + JSON.stringify(criteria));
+      const recs: FederationRecord[] = await new Entities().get({
+        entityName: 'federation',
+        criteria
+      });
+      if (recs[0]) {
+        fedRecords.push(recs[0]);
+      }
+    }
+
+    return fedRecords;
+  }
+
+  async getFederationRecordsFromIdsBulk(ids: string[]): Promise<FederationRecord[]> {
+
+    const chunks: string[][] = this.splitIntoChunksByLen(ids, this.CHUNK_SIZE);
+    const fedRecords = [];
+    const federatedPromises = [];
+    const entities: Entities = new Entities();
+    for (const chunk of chunks) {
+      const fedPromise = limit(async () => {
+        const criteria = {
+          references: chunk,
+          appIdentifier: FED_CONFIG.appIdentifier,
+          federationSchema: FED_CONFIG.federationSchema
+        };
+        // this.logger.log('getFederatedMappedRefId: ' + JSON.stringify(criteria));
+        const records: FederationRecord[] = await entities.get({
+          entityName: 'federation',
+          criteria
+        });
+        fedRecords.push(...records);
+
+      });
+      federatedPromises.push(fedPromise);
+    }
+    await Promise.all(federatedPromises);
+
+    return fedRecords;
+  }
+
+  splitIntoChunksByLen(arr, len) {
+    const chunks = [], n = arr?.length;
+    let i = 0;
+    while (i < n) {
+      chunks.push(arr.slice(i, i += len));
+    }
+    return chunks;
+  }
+}

package/src/util/flexplm-connect.spec.ts

@@ -0,0 +1,132 @@
+
+import { FlexPLMConnect } from './flexplm-connect';
+import { FCConfig } from '../interfaces/interfaces';
+
+const mockJsonData = { items: [{ id: '123', name: 'test' }] };
+
+const mockResponse = (status: number, json = mockJsonData) => ({
+  status,
+  json: jest.fn().mockResolvedValue(json),
+  text: jest.fn().mockResolvedValue('error text'),
+});
+
+const globalFetch = global.fetch;
+
+beforeEach(() => {
+  global.fetch = jest.fn().mockResolvedValue(mockResponse(200));
+});
+
+afterAll(() => {
+  global.fetch = globalFetch;
+});
+
+const createConfig = (overrides?: Partial<FCConfig>): FCConfig => ({
+  apiHost: 'https://flexplm.example.com',
+  urlContext: '/FlexPLM',
+  vibeEventEndpoint: '/api/events',
+  csrfEndpoint: '/csrf',
+  plmEnviornment: 'test',
+  userName: () => 'user',
+  password: () => 'pass',
+  itemPreDevelopmentLifecycleStages: [],
+  payloadDefaultAsArray: true,
+  ...overrides,
+});
+
+describe('FlexPLMConnect.getRequest', () => {
+
+  it('should call default URL with urlContext when no params provided', async () => {
+    const connect = new FlexPLMConnect(createConfig());
+    await connect.getRequest();
+
+    expect(global.fetch).toHaveBeenCalledWith(
+      'https://flexplm.example.com/FlexPLM/servlet/rest/api/events',
+      expect.objectContaining({ method: 'GET' }),
+    );
+  });
+
+  it('should use the constructor endpoint in the default URL', async () => {
+    const connect = new FlexPLMConnect(createConfig(), '/custom/endpoint');
+    await connect.getRequest();
+
+    expect(global.fetch).toHaveBeenCalledWith(
+      'https://flexplm.example.com/FlexPLM/servlet/rest/custom/endpoint',
+      expect.any(Object),
+    );
+  });
+
+  it('should return parsed JSON by default', async () => {
+    const connect = new FlexPLMConnect(createConfig());
+    const result = await connect.getRequest();
+    expect(result).toEqual(mockJsonData);
+  });
+
+  it('should use urlPath when provided', async () => {
+    const connect = new FlexPLMConnect(createConfig());
+    await connect.getRequest({ urlPath: '/custom/path' });
+
+    expect(global.fetch).toHaveBeenCalledWith(
+      'https://flexplm.example.com/FlexPLM/custom/path',
+      expect.any(Object),
+    );
+  });
+
+  it('should exclude urlContext when includeUrlContext is false', async () => {
+    const connect = new FlexPLMConnect(createConfig());
+    await connect.getRequest({ includeUrlContext: false });
+
+    expect(global.fetch).toHaveBeenCalledWith(
+      'https://flexplm.example.com/servlet/rest/api/events',
+      expect.any(Object),
+    );
+  });
+
+  it('should exclude urlContext with custom urlPath', async () => {
+    const connect = new FlexPLMConnect(createConfig());
+    await connect.getRequest({ urlPath: '/custom/path', includeUrlContext: false });
+
+    expect(global.fetch).toHaveBeenCalledWith(
+      'https://flexplm.example.com/custom/path',
+      expect.any(Object),
+    );
+  });
+
+  it('should return full response when returnFullResponse is true', async () => {
+    const rawResponse = mockResponse(200);
+    (global.fetch as jest.Mock).mockResolvedValue(rawResponse);
+
+    const connect = new FlexPLMConnect(createConfig());
+    const result = await connect.getRequest({ returnFullResponse: true });
+
+    expect(result).toBe(rawResponse);
+    expect(rawResponse.json).not.toHaveBeenCalled();
+  });
+
+  it('should throw on status >= 300', async () => {
+    (global.fetch as jest.Mock).mockResolvedValue(mockResponse(404));
+
+    const connect = new FlexPLMConnect(createConfig());
+    await expect(connect.getRequest()).rejects.toThrow('Error connecting to FlexPLM:status: 404');
+  });
+
+  it('should throw on status >= 300 even with returnFullResponse', async () => {
+    (global.fetch as jest.Mock).mockResolvedValue(mockResponse(500));
+
+    const connect = new FlexPLMConnect(createConfig());
+    await expect(connect.getRequest({ returnFullResponse: true })).rejects.toThrow(
+      'Error connecting to FlexPLM:status: 500',
+    );
+  });
+
+  it('should throw when response.json() fails', async () => {
+    const badResponse = {
+      status: 200,
+      json: jest.fn().mockRejectedValue(new Error('Invalid JSON')),
+      text: jest.fn().mockResolvedValue('not json'),
+    };
+    (global.fetch as jest.Mock).mockResolvedValue(badResponse);
+
+    const connect = new FlexPLMConnect(createConfig());
+    await expect(connect.getRequest()).rejects.toThrow('Error getting json data from FlexPLM: Invalid JSON');
+  });
+});

package/src/util/flexplm-connect.ts

@@ -171,12 +171,18 @@ export class FlexPLMConnect {
     return await this.processRequest(payload);
   }
 
-  /** Runs a get request to FlexPLM using the endpoint provided in the constructor
-   * 
+  /** Runs a GET request to FlexPLM.
+   * @param params - Optional configuration for the request.
+   * @param params.urlPath - Custom URL path to use instead of the default `/servlet/rest` + endpoint.
+   * @param params.includeUrlContext - Whether to include the urlContext in the URL. Defaults to `true`.
+   * @param params.returnFullResponse - If `true`, returns the raw `Response` object instead of parsed JSON. Defaults to `false`.
+   * @returns The parsed JSON response body, or the raw `Response` object if `returnFullResponse` is `true`.
    */
-  async getRequest(){
-    const urlContext = this.config.urlContext;
-    const vibeEventsURL: string = this.config.apiHost + urlContext + '/servlet/rest' + this.vibeEventEndpoint;
+  async getRequest(params?: { urlPath?: string; includeUrlContext?: boolean; returnFullResponse?: boolean }): Promise<Response | unknown>{
+    const { urlPath, includeUrlContext = true, returnFullResponse = false } = params || {};
+    const urlContext = includeUrlContext ? this.config.urlContext : '';
+    const path = urlPath || ('/servlet/rest' + this.vibeEventEndpoint);
+    const vibeEventsURL: string = this.config.apiHost + urlContext + path;
     const csrfOptions = this.getRequestOptions('GET');
     const response = await fetch(vibeEventsURL, csrfOptions);
 
@@ -186,6 +192,9 @@ export class FlexPLMConnect {
       console.error(await response.text());
       throw new Error(message);
     }
+    if(returnFullResponse){
+      return response;
+    }
     try {
       const data = await response.json();
       return data;

package/src/util/logger-config.ts

@@ -1,20 +1,20 @@
-import { LogLevel, Logger } from '@contrail/app-framework';
-
-export async function setLoggerConfig(appConfig) {
-  let logLevel: LogLevel = LogLevel.INFO;
-  if(!appConfig.logLevel) {
-    //pass
-  } else if (appConfig.logLevel === 'error') {
-    logLevel = LogLevel.ERROR;
-  } else if (appConfig.logLevel === 'warn') {
-    logLevel = LogLevel.WARN;
-  } else if (appConfig.logLevel === 'info') {
-    logLevel = LogLevel.INFO;
-  } else if (appConfig.logLevel === 'debug') {
-    logLevel = LogLevel.DEBUG;
-  } else {
-    console.log('could not parse log level:', appConfig);
-  }
-
-  Logger.setConfig({logLevel: logLevel});
+import { LogLevel, Logger } from '@contrail/app-framework';
+
+export async function setLoggerConfig(appConfig) {
+  let logLevel: LogLevel = LogLevel.INFO;
+  if(!appConfig.logLevel) {
+    //pass
+  } else if (appConfig.logLevel === 'error') {
+    logLevel = LogLevel.ERROR;
+  } else if (appConfig.logLevel === 'warn') {
+    logLevel = LogLevel.WARN;
+  } else if (appConfig.logLevel === 'info') {
+    logLevel = LogLevel.INFO;
+  } else if (appConfig.logLevel === 'debug') {
+    logLevel = LogLevel.DEBUG;
+  } else {
+    console.log('could not parse log level:', appConfig);
+  }
+
+  Logger.setConfig({logLevel: logLevel});
 }