EPMRPP-113713 || Introduce the instanceId property

CHANGELOG.md

@@ -1,3 +1,5 @@
+### Added
+- `instanceID` property for Google Analytics events.
 
 ## [5.5.10] - 2026-02-05
 ### Fixed

__tests__/report-portal-client.spec.js

@@ -158,6 +158,7 @@ describe('ReportPortal javascript client', () => {
         endpoint: 'https://rp.us/api/v1',
         project: 'tst',
       });
+      jest.spyOn(client, 'fetchServerInfo').mockResolvedValue({});
       jest.spyOn(client.statistics, 'trackEvent').mockImplementation();
 
       await client.triggerStatisticsEvent();
@@ -218,6 +219,101 @@ describe('ReportPortal javascript client', () => {
         }),
       );
     });
+
+    it('should fetch server info and set instanceID before tracking event', async () => {
+      const client = new RPClient({
+        apiKey: 'startLaunchTest',
+        endpoint: 'https://rp.us/api/v1',
+        project: 'tst',
+      });
+      const serverInfoResponse = {
+        extensions: {
+          result: {
+            'server.details.instance': 'test-instance-123',
+          },
+        },
+      };
+      jest.spyOn(client, 'fetchServerInfo').mockResolvedValue(serverInfoResponse);
+      jest.spyOn(client.statistics, 'trackEvent').mockImplementation();
+      jest.spyOn(client.statistics, 'setInstanceID');
+
+      await client.triggerStatisticsEvent();
+
+      expect(client.fetchServerInfo).toHaveBeenCalled();
+      expect(client.statistics.setInstanceID).toHaveBeenCalledWith('test-instance-123');
+      expect(client.statistics.trackEvent).toHaveBeenCalled();
+    });
+
+    it('should still track event with not_set instanceID if fetchServerInfo fails', async () => {
+      const client = new RPClient({
+        apiKey: 'startLaunchTest',
+        endpoint: 'https://rp.us/api/v1',
+        project: 'tst',
+      });
+      jest.spyOn(client, 'fetchServerInfo').mockRejectedValue(new Error('Network error'));
+      jest.spyOn(client.statistics, 'trackEvent').mockImplementation();
+      jest.spyOn(client.statistics, 'setInstanceID');
+
+      await client.triggerStatisticsEvent();
+
+      expect(client.statistics.setInstanceID).toHaveBeenCalledWith('not_set');
+      expect(client.statistics.trackEvent).toHaveBeenCalled();
+    });
+
+    it('should not set instanceID if server info does not contain it', async () => {
+      const client = new RPClient({
+        apiKey: 'startLaunchTest',
+        endpoint: 'https://rp.us/api/v1',
+        project: 'tst',
+      });
+      jest.spyOn(client, 'fetchServerInfo').mockResolvedValue({});
+      jest.spyOn(client.statistics, 'trackEvent').mockImplementation();
+      jest.spyOn(client.statistics, 'setInstanceID');
+
+      await client.triggerStatisticsEvent();
+
+      expect(client.statistics.setInstanceID).not.toHaveBeenCalled();
+      expect(client.statistics.trackEvent).toHaveBeenCalled();
+    });
+  });
+
+  describe('getServerInfoUrl', () => {
+    it('should return correct info URL for v1 endpoint', () => {
+      const client = new RPClient({
+        apiKey: 'test',
+        project: 'test',
+        endpoint: 'https://rp.us/api/v1',
+      });
+
+      expect(client.getServerInfoUrl()).toBe('https://rp.us/api/info');
+    });
+
+    it('should return correct info URL for v2 endpoint', () => {
+      const client = new RPClient({
+        apiKey: 'test',
+        project: 'test',
+        endpoint: 'https://rp.us/api/v2',
+      });
+
+      expect(client.getServerInfoUrl()).toBe('https://rp.us/api/info');
+    });
+  });
+
+  describe('fetchServerInfo', () => {
+    it('should call restClient.request with correct URL', async () => {
+      const client = new RPClient({
+        apiKey: 'test',
+        project: 'test',
+        endpoint: 'https://rp.us/api/v1',
+      });
+      const serverInfo = { extensions: { result: {} } };
+      jest.spyOn(client.restClient, 'request').mockResolvedValue(serverInfo);
+
+      const result = await client.fetchServerInfo();
+
+      expect(client.restClient.request).toHaveBeenCalledWith('GET', 'https://rp.us/api/info', {});
+      expect(result).toEqual(serverInfo);
+    });
   });
 
   describe('startLaunch', () => {

__tests__/statistics.spec.js

@@ -91,4 +91,43 @@ describe('Statistics', () => {
       expect(console.error).toHaveBeenCalledWith(errorMessage);
     });
   });
+
+  describe('setInstanceID', () => {
+    it('should set instanceID in event params', async () => {
+      jest.spyOn(axios, 'post').mockReturnValue({
+        send: () => {}, // eslint-disable-line
+      });
+
+      const statistics = new Statistics(eventName, agentParams);
+      statistics.setInstanceID('test-instance-id');
+      await statistics.trackEvent();
+
+      expect(axios.post).toHaveBeenCalledTimes(1);
+      expect(axios.post).toHaveBeenCalledWith(
+        url,
+        expect.objectContaining({
+          events: expect.arrayContaining([
+            expect.objectContaining({
+              params: expect.objectContaining({
+                instanceID: 'test-instance-id',
+              }),
+            }),
+          ]),
+        }),
+      );
+    });
+
+    it('should not include instanceID if setInstanceID was not called', async () => {
+      jest.spyOn(axios, 'post').mockReturnValue({
+        send: () => {}, // eslint-disable-line
+      });
+
+      const statistics = new Statistics(eventName, agentParams);
+      await statistics.trackEvent();
+
+      expect(axios.post).toHaveBeenCalledTimes(1);
+      const callArgs = axios.post.mock.calls[0][1];
+      expect(callArgs.events[0].params).not.toHaveProperty('instanceID');
+    });
+  });
 });

lib/report-portal-client.js

@@ -146,10 +146,28 @@ class RPClient {
     return this.restClient.request('GET', url, {});
   }
 
+  getServerInfoUrl() {
+    return this.config.endpoint.replace('/v1', '/info').replace('/v2', '/info');
+  }
+
+  async fetchServerInfo() {
+    const url = this.getServerInfoUrl();
+    return this.restClient.request('GET', url, {});
+  }
+
   async triggerStatisticsEvent() {
     if (process.env.REPORTPORTAL_CLIENT_JS_NO_ANALYTICS) {
       return;
     }
+    try {
+      const serverInfo = await this.fetchServerInfo();
+      const instanceID = serverInfo?.extensions?.result?.['server.details.instance'];
+      if (instanceID) {
+        this.statistics.setInstanceID(instanceID);
+      }
+    } catch (e) {
+      this.statistics.setInstanceID('not_set');
+    }
     await this.statistics.trackEvent();
   }
 

statistics/statistics.js

@@ -27,6 +27,10 @@
     return params;
   }
 
+  setInstanceID(instanceID) {
+    this.eventParams.instanceID = instanceID;
+  }
+
   async trackEvent() {
     try {
       const requestBody = {
@@ -44,7 +48,7 @@
         requestBody,
       );
     } catch (error) {
       console.error(error.message);
     }
   }
 }