implement identifier service

Signed-off-by: Vlad Arama <[email protected]>

Author: Vlad Arama

tsp-typescript-client/fixtures/tsp-client/fetch-identifier-0.json

@@ -0,0 +1,11 @@
+{
+    "version": "0.9.1",
+    "buildTime": "202408051810",
+    "os": "Windows 10",
+    "osArch": "amd64",
+    "osVersion": "10.0",
+    "cpuCount": 8,
+    "maxMemory": 8552185856,
+    "launcherName": "Tracecompass-serverc",
+    "productId": "org.eclipse.tracecompass.incubator.trace.server.jersey.rest.core.id"
+}

tsp-typescript-client/src/models/identifier.ts

@@ -0,0 +1,49 @@
+/**
+ * Model of the identifier
+ */
+export interface Identifier {
+    /**
+     * Version in the format Major.Minor.Micro
+     */
+    version: string;
+
+    /**
+     * Build time or qualifier of the server version, if available
+     */
+    buildTime: string;
+
+    /**
+     * Operating system name
+     */
+    os: string;
+
+    /**
+     * Architecture of the operating system
+     */
+    osArch: string;
+
+    /**
+     * Operating system version
+     */
+    osVersion: string;
+
+    /**
+     * Number of CPUs available
+     */
+    cpuCount: string;
+
+    /**
+     * Maximum memory available to the JVM in bytes
+     */
+    maxMemory: string;
+
+    /**
+     * Name of the launcher used, if available
+     */
+    launcherName: string;
+
+    /**
+     * Product identifier
+     */
+    productId: string;
+}

tsp-typescript-client/src/protocol/http-tsp-client.ts

@@ -8,6 +8,7 @@ import { DataTreeEntry } from "../models/data-tree";
 import { Entry, EntryModel } from "../models/entry";
 import { Experiment } from "../models/experiment";
 import { HealthStatus } from "../models/health";
+import { Identifier } from "../models/identifier";
 import { MarkerSet } from "../models/markerset";
 import { OutputDescriptor } from "../models/output-descriptor";
 import { Query } from "../models/query/query";
@@ -519,6 +520,15 @@ export class HttpTspClient implements ITspClient {
         return RestClient.get(url);
     }
 
+    /**
+     * Fetch the identifier service
+     * @returns Important information regarding the trace server and the system it is running on
+     */
+    public async fetchIdentifier(): Promise<TspClientResponse<Identifier>> {
+        const url = this.baseUrl + "/identifier";
+        return RestClient.get(url);
+    }
+
     /**
      * Fetch all configuration source types
      * @returns Generic response with the model

tsp-typescript-client/src/protocol/tsp-client.test.ts

@@ -178,6 +178,21 @@ describe('HttpTspClient Deserialization', () => {
     }
   });
 
+  it('fetchIdentifier' , async () => {
+    httpRequestMock.mockReturnValueOnce(fixtures.asResponse('fetch-identifier-0.json'));
+    const response = await client.fetchIdentifier();
+    const identifier = response.getModel()!;
+
+    expect(response.getStatusCode()).toEqual(200);
+    expect(identifier.version).toBeDefined();
+    expect(identifier.os).toBeDefined();
+    expect(identifier.osArch).toBeDefined();
+    expect(identifier.osVersion).toBeDefined();
+    expect(identifier.cpuCount).toBeDefined();
+    expect(identifier.maxMemory).toBeDefined();
+    expect(identifier.productId).toBeDefined();
+  });
+
   it('fetchMarkerSets', async () => {
     httpRequestMock.mockReturnValueOnce(fixtures.asResponse('fetch-marker-sets-0.json'));
     const response = await client.fetchMarkerSets('not-relevant');

tsp-typescript-client/src/protocol/tsp-client.ts

@@ -22,6 +22,7 @@ import { MarkerSet } from "../models/markerset";
 import { DataTreeEntry } from "../models/data-tree";
 import { ConfigurationSourceType } from "../models/configuration-source";
 import { Configuration } from "../models/configuration";
+import { Identifier } from "../models/identifier";
 
 export {
     /** @deprecated */ HttpTspClient as TspClient,
@@ -297,6 +298,12 @@ export interface ITspClient {
      */
     checkHealth(): Promise<TspClientResponse<HealthStatus>>;
 
+    /**
+     * Fetch the identifier service
+     * @returns Important information regarding the trace server and the system it is running on
+     */
+    fetchIdentifier(): Promise<TspClientResponse<Identifier>>;
+
     /**
      * Fetch all configuration source types
      * @returns Generic response with the model