Add APIs to support configurable output (data provider)

bhufmann · bhufmann · commit 7fdc65b07390 · 2024-11-06T14:46:50.000-05:00
- Add ConfigurationQuery and OutputConfigurationQuery
- Add utility methods in query-helper.ts to create such query instances
- Add configuration service per output (data provider)
  This addition enables clients to create derived data providers from
  an existing data provider.
- Add unit tests

Signed-off-by: Bernd Hufmann &lt;bernd.hufmann@ericsson.com&gt;
diff --git a/tsp-typescript-client/fixtures/tsp-client/output-configuration-0.json b/tsp-typescript-client/fixtures/tsp-client/output-configuration-0.json
@@ -0,0 +1,25 @@
+{
+  "parentId": "org.eclipse.tracecompass.incubator.inandout.core.analysis.inAndOutDataProviderFactory",
+  "id": "org.eclipse.tracecompass.incubator.inandout.analysis85eec6d6-bea0-3680-84b6-f1a200e852d1",
+  "name": "InAndOut Analysis (My new InAndOut)",
+  "description": "Custom InAndOut analysis configured by \"My new InAndOut\"",
+  "type": "NONE",
+  "configuration": {
+    "id": "85eec6d6-bea0-3680-84b6-f1a200e852d1",
+    "name": "My new InAndOut",
+    "description": "My special configuration",
+    "sourceTypeId": "org.eclipse.tracecompass.incubator.internal.inandout.core.config",
+    "parameters": {
+      "specifiers": [
+        {
+          "label": "latency",
+          "inRegex": "(\\S*)_entry",
+          "outRegex": "(\\S*)_exit",
+          "contextInRegex": "(\\S*)_entry",
+          "contextOutRegex": "(\\S*)_exit",
+          "classifier": "CPU"
+        }
+      ]
+    }
+  }
+}
diff --git a/tsp-typescript-client/src/models/query/query-helper.test.ts b/tsp-typescript-client/src/models/query/query-helper.test.ts
@@ -1,5 +1,5 @@
 import { QueryHelper } from './query-helper';
-import { Query } from './query';
+import { ConfigurationQuery, OutputConfigurationQuery, Query } from './query';
 
 describe('Query helper tests', () => {
   it('Should build a simple query', () => {
@@ -105,4 +105,50 @@ describe('Query helper tests', () => {
 
     expect(test).toEqual(array);
   });
+
+  it('Should create a configuration query', () => {
+    const param = {
+      cpu: 0,
+      thread: "myThread"
+    };
+
+    const test = QueryHelper.configurationQuery(
+      'My Config',
+      'My special configuration', 
+      param);
+
+    const query = new ConfigurationQuery('My Config',
+      'My special configuration',
+      param);
+    
+    expect(test).toEqual(query);
+  });
+
+  it('Should create a output configuration query', () => {
+    const param = {
+      specifiers: [
+        {
+         label: 'latency',
+         inRegex: '(\\S*)_entry',
+          outRegex: '(\\S*)_exit',
+         contextInRegex: '(\\S*)_entry',
+         contextOutRegex: '(\\S*)_exit',
+          classifier: 'CPU'
+        }
+      ]
+    };
+
+  const test = QueryHelper.outputConfigurationQuery(
+    'My new InAndOut',
+    'org.eclipse.tracecompass.incubator.internal.inandout.core.config',
+    'My special configuration', 
+    param);
+
+    const query = new OutputConfigurationQuery('My new InAndOut',
+      'org.eclipse.tracecompass.incubator.internal.inandout.core.config',
+      'My special configuration', 
+      param);
+
+    expect(test).toEqual(query);
+  });
 });
diff --git a/tsp-typescript-client/src/models/query/query-helper.ts b/tsp-typescript-client/src/models/query/query-helper.ts
@@ -1,4 +1,4 @@
-import { Query } from './query';
+import { ConfigurationQuery, OutputConfigurationQuery, Query } from './query';
 
 /**
  * Helper class to create query object
@@ -163,6 +163,27 @@ export class QueryHelper {
         return new Query({ ...tableObj, ...additionalProperties });
     }
 
+    /**
+     * Build a configuration query
+     * @param name the name of the configuration
+     * @param description the optional description of the configuration
+     * @param parameters the custom parameters
+     */
+    public static configurationQuery(name: string, description: string | undefined, parameters: { [key: string]: any }) {
+        return new ConfigurationQuery(name, description, parameters);
+    }
+
+    /**
+     * Build a output configuration query
+     * @param name the name of the configuration
+     * @param description the optional description of the configuration
+     * @param typeId the configuration type ID
+     * @param parameters the custom parameters
+     */
+    public static outputConfigurationQuery(name: string, description: string | undefined, typeId: string, parameters: { [key: string]: any }) {
+        return new OutputConfigurationQuery(name, description, typeId, parameters);
+    }
+
     /**
      * Split the range into equal parts
      * @param start Start time
diff --git a/tsp-typescript-client/src/models/query/query.ts b/tsp-typescript-client/src/models/query/query.ts
@@ -19,3 +19,47 @@ export class Query {
         this.parameters = parameters;
     }
 }
+export class ConfigurationQuery extends Query {
+    /**
+     * Name of the configuration
+     */
+    // @ts-expect-error TS doesn't like unused private fields.
+    private name: string;
+
+    /**
+     * The optional description of configuration
+     */
+    // @ts-expect-error TS doesn't like unused private fields.
+    private description?: string;
+
+    /**
+     * Constructor
+     * @param name Name of the configuration
+     * @param parameters Object used to send parameters to the server
+     * @param description Optional description of the configuraiton
+     */
+    constructor(name: string, descripion: string | undefined, parameters: Object) {
+        super(parameters);
+        this.name = name;
+        this.description = descripion;
+    }
+}
+export class OutputConfigurationQuery extends ConfigurationQuery {
+    /**
+     * The configuration source type ID
+     */
+    // @ts-expect-error TS doesn't like unused private fields.
+    private typeId: string;
+
+    /**
+     * Constructor
+     * @param name Name of the configuration
+     * @param description Optional description of the configuraiton
+     * @param typeId The ID of the configuration source type
+     * @param parameters Object used to send parameters to the server
+     */
+    constructor(name: string, description: string | undefined,  typeId: string, parameters: Object) {
+        super(name, description, parameters);
+        this.typeId = typeId;
+    }
+}
diff --git a/tsp-typescript-client/src/protocol/http-tsp-client.ts b/tsp-typescript-client/src/protocol/http-tsp-client.ts
@@ -11,7 +11,7 @@ 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";
+import { ConfigurationQuery, OutputConfigurationQuery, Query } from "../models/query/query";
 import { GenericResponse } from "../models/response/responses";
 import { OutputStyleModel } from "../models/styles";
 import { ColumnHeaderEntry, TableModel } from "../models/table";
@@ -511,6 +511,92 @@ export class HttpTspClient implements ITspClient {
         return RestClient.post(url, parameters);
     }
 
+    /**
+     * Fetch all configuration source types for a given experiment and output
+     * @param expUUID Experiment UUID
+     * @param outputID Output ID
+     * @returns Generic response with the model
+     */
+    public async fetchOutputConfigurationTypes(
+        expUUID: string,
+        outputID: string
+    ): Promise<TspClientResponse<ConfigurationSourceType[]>> {
+        const url =
+            this.baseUrl +
+            "/experiments/" +
+            expUUID +
+            "/outputs/" +
+            outputID +
+            "/configTypes";
+        return RestClient.get(url);
+    }
+
+    /**
+     * Fetch a single configuration source type for a given experiment, output and type
+     * @param expUUID Experiment UUID
+     * @param outputID Output ID
+     * @param typeID the ID of the configuration source type
+     * @returns Generic response with the model
+     */
+    public async fetchOutputConfigurationType(
+        expUUID: string,
+        outputID: string,
+        typeID: string
+    ): Promise<TspClientResponse<ConfigurationSourceType>> {
+        const url =
+            this.baseUrl +
+            "/experiments/" +
+            expUUID +
+            "/outputs/" +
+            outputID +
+            "/configTypes/" +
+            typeID;
+        return RestClient.get(url);
+    }
+
+    /**
+     * Create a derived output for a given experiment, output and parameters
+     * @param expUUID Experiment UUID
+     * @param outputID Output ID
+     * @param parameters OutputConfigurationQuery object
+     * @returns Generic response with the model
+     */
+    public async createDerivedOutput(
+        expUUID: string,
+        outputID: string,
+        parameters: OutputConfigurationQuery): Promise<TspClientResponse<OutputDescriptor>> {
+        const url =
+            this.baseUrl +
+            "/experiments/" +
+            expUUID +
+            "/outputs/" +
+            outputID;
+        return RestClient.post(url, parameters, OutputDescriptor);
+    }
+
+    /**
+     * Delete a derived output (and its configuration) for a given experiment,
+     * output and derived output
+     * @param expUUID Experiment UUID
+     * @param outputID Output ID
+     * @param derivedOutputID the ID of the derived output
+     * @returns Generic response with the model
+     */
+    public async deleteDerivedOutput(
+        expUUID: string,
+        outputID: string,
+        derivedOutputID: string): Promise<TspClientResponse<OutputDescriptor>> {
+        const url =
+            this.baseUrl +
+            "/experiments/" +
+            expUUID +
+            "/outputs/" +
+            outputID +
+            "/" +
+            derivedOutputID;
+        return RestClient.delete(url, undefined, OutputDescriptor);
+        }
+
     /**
      * Check the health status of the server
      * @returns The Health Status
@@ -572,10 +658,10 @@ export class HttpTspClient implements ITspClient {
     /**
      * Create a configuration for a given type ID and parameters
      * @param typeId the ID of the configuration source type
-     * @param parameters Query object
+     * @param parameters ConfigurationQuery object
      * @returns Generic response with the model
      */
-    createConfiguration(typeId: string, parameters: Query): Promise<TspClientResponse<Configuration>> {
+    createConfiguration(typeId: string, parameters: ConfigurationQuery): Promise<TspClientResponse<Configuration>> {
         const url = this.baseUrl + "/config/types/" + typeId;
         return RestClient.post(url, parameters);
     }
@@ -584,10 +670,10 @@ export class HttpTspClient implements ITspClient {
      * Update a configuration for a given type ID, config ID and parameters
      * @param typeId the ID of the configuration source type
      * @param configId the ID of the configuration
-     * @param parameters Query object
+     * @param parameters ConfigurationQuery object
      * @returns Generic response with the model
      */
-    updateConfiguration(typeId: string, configId: string, parameters: Query): Promise<TspClientResponse<Configuration>> {
+    updateConfiguration(typeId: string, configId: string, parameters: ConfigurationQuery): Promise<TspClientResponse<Configuration>> {
         const url = this.baseUrl + "/config/types/" + typeId + "/configs/" + configId;
         return RestClient.put(url, parameters);
     }
diff --git a/tsp-typescript-client/src/protocol/tsp-client.test.ts b/tsp-typescript-client/src/protocol/tsp-client.test.ts
@@ -1,10 +1,11 @@
 import { Headers } from 'node-fetch';
-import { Query } from '../models/query/query';
+import { ConfigurationQuery, OutputConfigurationQuery, Query } from '../models/query/query';
 import { HttpRequest, HttpResponse, RestClient } from './rest-client';
 import { FixtureSet } from './test-utils';
 import { HttpTspClient } from './http-tsp-client';
 import { DataType } from '../models/data-type';
 import { ConfigurationParameterDescriptor } from '../models/configuration-source';
+import { QueryHelper } from '../models/query/query-helper';
 
 describe('HttpTspClient Deserialization', () => {
 
@@ -474,7 +475,7 @@ describe('HttpTspClient Deserialization', () => {
 
   it('createConfiguration', async () => {
     httpRequestMock.mockReturnValueOnce(fixtures.asResponse('configuration-0.json'));
-    const response = await client.createConfiguration("my-source-type-1-id", new Query({}));
+    const response = await client.createConfiguration("my-source-type-1-id", new ConfigurationQuery('', undefined, {}));
     const config = response.getModel()!;
 
     expect(config.name).toEqual('My configuration 1');
@@ -487,7 +488,7 @@ describe('HttpTspClient Deserialization', () => {
 
   it('updateConfiguration', async () => {
     httpRequestMock.mockReturnValueOnce(fixtures.asResponse('configuration-0.json'));
-    const response = await client.updateConfiguration("my-source-type-1-id", "my-config-1-id", new Query({}));
+    const response = await client.updateConfiguration("my-source-type-1-id", "my-config-1-id", new ConfigurationQuery('', undefined, {}));
     const config = response.getModel()!;
 
     expect(config.name).toEqual('My configuration 1');
@@ -511,4 +512,48 @@ describe('HttpTspClient Deserialization', () => {
     expect(config.parameters?.path).toEqual('/home/user/tmp');
   });
 
+  it('createOutputConfiguration', async () => {
+    httpRequestMock.mockReturnValueOnce(fixtures.asResponse('output-configuration-0.json'));
+    const config: OutputConfigurationQuery = QueryHelper.outputConfigurationQuery(
+      'My new InAndOut',
+      'org.eclipse.tracecompass.incubator.internal.inandout.core.config',
+      'My special configuration',
+      {
+        specifiers: [
+          {
+            label: 'latency',
+            inRegex: '(\\S*)_entry',
+            outRegex: '(\\S*)_exit',
+            contextInRegex: '(\\S*)_entry',
+            contextOutRegex: '(\\S*)_exit',
+            classifier: 'CPU'
+          }
+        ]
+      }
+    );
+
+    const response = await client.createDerivedOutput(
+      'd280b5ab-b0ff-38cf-b3e1-d33a0d56d1a3',
+      'org.eclipse.tracecompass.incubator.inandout.core.analysis.inAndOutDataProviderFactory',
+      config);
+
+    const output = response.getModel()!;
+    expect(output.name).toEqual('InAndOut Analysis (My new InAndOut)');
+    expect(output.description).toEqual('Custom InAndOut analysis configured by "My new InAndOut"');
+    expect(output.id).toEqual('org.eclipse.tracecompass.incubator.inandout.analysis85eec6d6-bea0-3680-84b6-f1a200e852d1');
+    expect(output.parentId).toBeDefined();
+    expect(output.parentId).toEqual('org.eclipse.tracecompass.incubator.inandout.core.analysis.inAndOutDataProviderFactory');
+    expect(output.configuration).toBeDefined();
+  });
+
+  it('deleteOutputConfiguration', async () => {
+    httpRequestMock.mockReturnValueOnce(fixtures.asResponse('output-configuration-0.json'));
+    const response = await client.deleteDerivedOutput(
+      'd280b5ab-b0ff-38cf-b3e1-d33a0d56d1a3',
+      'org.eclipse.tracecompass.incubator.inandout.core.analysis.inAndOutdataProviderFactory',
+      'org.eclipse.tracecompass.incubator.inandout.analysis85eec6d6-bea0-3680-84b6-f1a200e852d1');
+
+    const output = response.getModel()!;
+    expect(output).toBeDefined();
+  });
 });
diff --git a/tsp-typescript-client/src/protocol/tsp-client.ts b/tsp-typescript-client/src/protocol/tsp-client.ts
