feat: expose get experiment from workspace

modelon-community · May 11, 2023 · f22079a · f22079a
1 parent 197a16e
commit f22079a
Show file tree

Hide file tree

Showing 3 changed files with 48 additions and 1 deletion.
diff --git a/src/api.ts b/src/api.ts
@@ -7,6 +7,7 @@ import ApiError, {
     UnknownApiError,
 } from './api-error'
 import { Cookie, CookieJar } from 'tough-cookie'
+import Experiment from './experiment'
 import ExperimentDefinition from './experiment-definition'
 import {
     Case,
@@ -436,6 +437,40 @@ class Api {
         })
     }
 
+    getExperiment({
+        experimentId,
+        workspaceId,
+    }: {
+        experimentId: ExperimentId
+        workspaceId: WorkspaceId
+    }): Promise<Experiment | undefined> {
+        return new Promise((resolve, reject) => {
+            this.ensureImpactToken()
+                .then(() => {
+                    this.axios
+                        .get(
+                            `${this.baseUrl}${this.jhUserPath}impact/api/workspaces/${workspaceId}/experiments/${experimentId}`,
+                            {
+                                headers: {
+                                    Accept: 'application/vnd.impact.experiment.v2+json',
+                                },
+                            }
+                        )
+                        .then(() =>
+                            resolve(
+                                new Experiment({
+                                    api: this,
+                                    id: experimentId,
+                                    workspaceId,
+                                })
+                            )
+                        )
+                        .catch((e) => reject(toApiError(e)))
+                })
+                .catch((e) => reject(toApiError(e)))
+        })
+    }
+
     getCases({
         experimentId,
         workspaceId,

diff --git a/src/workspace.ts b/src/workspace.ts
@@ -1,4 +1,4 @@
-import { CaseId, CustomFunction, WorkspaceId } from './types'
+import { CaseId, CustomFunction, ExperimentId, WorkspaceId } from './types'
 import Api from './api'
 import Experiment from './experiment'
 import ExperimentDefinition from './experiment-definition'
@@ -76,6 +76,13 @@ class Workspace {
     getCustomFunctions(): Promise<CustomFunction[]> {
         return this.api.getCustomFunctions(this.id)
     }
+
+    getExperiment(experimentId: ExperimentId): Promise<Experiment | undefined> {
+        return this.api.getExperiment({
+            experimentId,
+            workspaceId: this.id,
+        })
+    }
 }
 
 export default Workspace
diff --git a/tests/integration/integration.test.ts b/tests/integration/integration.test.ts
@@ -152,6 +152,11 @@ test(
             expect(trajectories[1].items[0].trajectory.length).toBe(102)
             expect(trajectories[1].items[0].trajectory.length).toBe(102)
 
+            const experimentAfterwards = await testWorkspace.getExperiment(
+                experiment.id
+            )
+            expect(experimentAfterwards).not.toBeUndefined()
+
             await deleteTestWorkspace(client)
         } catch (e) {
             if (e instanceof Error) {