Add an endpoint for closing an experiment

With this it's possible to close an experiment on the server. Upon reception of the command the server can dispose allocated resources hence the client doesn't need them anymore. This change follows the TSP update provided by: eclipse-cdt-cloud/trace-server-protocol#95 Signed-off-by: Bernd Hufmann <[email protected]>
bhufmann · Nov 2, 2023 · 71b8575 · 71b8575
1 parent e23c508
commit 71b8575
Show file tree

Hide file tree

Showing 4 changed files with 48 additions and 0 deletions.
diff --git a/tsp-typescript-client/fixtures/tsp-client/close-experiment-0.json b/tsp-typescript-client/fixtures/tsp-client/close-experiment-0.json
@@ -0,0 +1,19 @@
+{
+	"name": "kernel",
+	"UUID": "22222222-2222-2222-2222-222222222222",
+	"nbEvents": 0,
+	"start": 0,
+	"end": 0,
+	"indexingStatus": "CLOSED",
+	"traces": [
+		{
+			"name": "kernel",
+			"path": "/path/kernel",
+			"UUID": "11111111-1111-1111-1111-111111111111",
+			"nbEvents": 0,
+			"start": 0,
+			"end": 0,
+			"indexingStatus": "CLOSED"
+		}
+	]
+}
diff --git a/tsp-typescript-client/src/protocol/http-tsp-client.ts b/tsp-typescript-client/src/protocol/http-tsp-client.ts
@@ -142,6 +142,18 @@ export class HttpTspClient implements ITspClient {
         return RestClient.put(url, parameters, Experiment);
     }
 
+    /**
+     * Close an experiment
+     * @param expUUID Experiment UUID to close
+     * @returns The closed experiment
+     */
+    closeExperiment(
+        expUUID: string
+    ): Promise<TspClientResponse<Experiment>> {
+        const url = this.baseUrl + "/experiments/" + expUUID + ":close";
+        return RestClient.put(url, new Query({}), Experiment);
+    }
+
     /**
      * Delete an experiment on the server
      * @param expUUID Experiment UUID to delete

diff --git a/tsp-typescript-client/src/protocol/tsp-client.test.ts b/tsp-typescript-client/src/protocol/tsp-client.test.ts
@@ -108,6 +108,14 @@ describe('HttpTspClient Deserialization', () => {
     expect(typeof experiment.nbEvents).toEqual('number');
   });
 
+  it('deleteExperiment', async () => {
+    httpRequestMock.mockReturnValueOnce(fixtures.asResponse('close-experiment-0.json'));
+    const response = await client.closeExperiment('not-relevant');
+    const experiment = response.getModel()!;
+
+    expect(experiment.indexingStatus).toEqual('CLOSED');
+  });
+
   it('deleteTrace', async () => {
     httpRequestMock.mockReturnValueOnce(fixtures.asResponse('delete-trace-0.json'));
     const response = await client.deleteTrace('not-relevant');

diff --git a/tsp-typescript-client/src/protocol/tsp-client.ts b/tsp-typescript-client/src/protocol/tsp-client.ts
@@ -94,6 +94,15 @@ export interface ITspClient {
         parameters: Query
     ): Promise<TspClientResponse<Experiment>>;
 
+    /**
+     * Close an experiment
+     * @param expUUID Experiment UUID to close
+     * @returns The closed experiment
+     */
+    closeExperiment(
+        expUUID: string
+    ): Promise<TspClientResponse<Experiment>>;
+
     /**
      * Delete an experiment on the server
      * @param expUUID Experiment UUID to delete