|
| 1 | +import { Trace } from 'tsp-typescript-client/lib/models/trace'; |
| 2 | +import { ITspClient } from 'tsp-typescript-client/lib/protocol/tsp-client'; |
| 3 | +import { Query } from 'tsp-typescript-client/lib/models/query/query'; |
| 4 | +import { OutputDescriptor } from 'tsp-typescript-client/lib/models/output-descriptor'; |
| 5 | +import { Experiment } from 'tsp-typescript-client/lib/models/experiment'; |
| 6 | +import { TraceManager } from './trace-manager'; |
| 7 | +import { TspClientResponse } from 'tsp-typescript-client/lib/protocol/tsp-client-response'; |
| 8 | +import { signalManager } from './signals/signal-manager'; |
| 9 | + |
| 10 | +export class ExperimentManager { |
| 11 | + private fOpenExperiments: Map<string, Experiment> = new Map(); |
| 12 | + private fTspClient: ITspClient; |
| 13 | + private fTraceManager: TraceManager; |
| 14 | + |
| 15 | + constructor(tspClient: ITspClient, traceManager: TraceManager) { |
| 16 | + this.fTspClient = tspClient; |
| 17 | + this.fTraceManager = traceManager; |
| 18 | + signalManager().on('EXPERIMENT_DELETED', (experiment: Experiment) => this.onExperimentDeleted(experiment)); |
| 19 | + } |
| 20 | + |
| 21 | + /** |
| 22 | + * Get an array of opened experiments |
| 23 | + * @returns Array of experiment |
| 24 | + */ |
| 25 | + async getOpenedExperiments(): Promise<Experiment[]> { |
| 26 | + const openedExperiments: Array<Experiment> = []; |
| 27 | + // Look on the server for opened experiments |
| 28 | + const experimentsResponse = await this.fTspClient.fetchExperiments(); |
| 29 | + const experiments = experimentsResponse.getModel(); |
| 30 | + if (experimentsResponse.isOk() && experiments) { |
| 31 | + openedExperiments.push(...experiments); |
| 32 | + } |
| 33 | + return openedExperiments; |
| 34 | + } |
| 35 | + |
| 36 | + /** |
| 37 | + * Get a specific experiment information |
| 38 | + * @param experimentUUID experiment UUID |
| 39 | + */ |
| 40 | + async getExperiment(experimentUUID: string): Promise<Experiment | undefined> { |
| 41 | + // Check if the experiment is in "cache" |
| 42 | + let experiment = this.fOpenExperiments.get(experimentUUID); |
| 43 | + |
| 44 | + // If the experiment is undefined, check on the server |
| 45 | + if (!experiment) { |
| 46 | + const experimentResponse = await this.fTspClient.fetchExperiment(experimentUUID); |
| 47 | + if (experimentResponse.isOk()) { |
| 48 | + experiment = experimentResponse.getModel(); |
| 49 | + } |
| 50 | + } |
| 51 | + return experiment; |
| 52 | + } |
| 53 | + |
| 54 | + /** |
| 55 | + * Get an array of OutputDescriptor for a given experiment |
| 56 | + * @param experimentUUID experiment UUID |
| 57 | + */ |
| 58 | + async getAvailableOutputs(experimentUUID: string): Promise<OutputDescriptor[] | undefined> { |
| 59 | + const outputsResponse = await this.fTspClient.experimentOutputs(experimentUUID); |
| 60 | + if (outputsResponse && outputsResponse.isOk()) { |
| 61 | + return outputsResponse.getModel(); |
| 62 | + } |
| 63 | + return undefined; |
| 64 | + } |
| 65 | + |
| 66 | + /** |
| 67 | + * Open a given experiment on the server |
| 68 | + * @param experimentURI experiment URI to open |
| 69 | + * @param experimentName Optional name for the experiment. If not specified the URI name is used |
| 70 | + * @returns The opened experiment |
| 71 | + */ |
| 72 | + async openExperiment(experimentName: string, traces: Array<Trace>): Promise<Experiment | undefined> { |
| 73 | + const name = experimentName; |
| 74 | + |
| 75 | + const traceURIs = new Array<string>(); |
| 76 | + for (let i = 0; i < traces.length; i++) { |
| 77 | + traceURIs.push(traces[i].UUID); |
| 78 | + } |
| 79 | + |
| 80 | + const tryCreate = async function ( |
| 81 | + tspClient: ITspClient, |
| 82 | + retry: number |
| 83 | + ): Promise<TspClientResponse<Experiment>> { |
| 84 | + return tspClient.createExperiment( |
| 85 | + new Query({ |
| 86 | + name: retry === 0 ? name : name + '(' + retry + ')', |
| 87 | + traces: traceURIs |
| 88 | + }) |
| 89 | + ); |
| 90 | + }; |
| 91 | + let tryNb = 0; |
| 92 | + let experimentResponse: TspClientResponse<Experiment> | undefined; |
| 93 | + while (experimentResponse === undefined || experimentResponse.getStatusCode() === 409) { |
| 94 | + experimentResponse = await tryCreate(this.fTspClient, tryNb); |
| 95 | + tryNb++; |
| 96 | + } |
| 97 | + const experiment = experimentResponse.getModel(); |
| 98 | + if (experimentResponse.isOk() && experiment) { |
| 99 | + this.addExperiment(experiment); |
| 100 | + signalManager().emit('EXPERIMENT_OPENED', experiment); |
| 101 | + return experiment; |
| 102 | + } |
| 103 | + // TODO Handle any other experiment open errors |
| 104 | + return undefined; |
| 105 | + } |
| 106 | + |
| 107 | + /** |
| 108 | + * Update the experiment with the latest info from the server. |
| 109 | + * @param experimentUUID experiment UUID |
| 110 | + * @returns The updated experiment or undefined if the experiment failed to update |
| 111 | + */ |
| 112 | + async updateExperiment(experimentUUID: string): Promise<Experiment | undefined> { |
| 113 | + const experimentResponse = await this.fTspClient.fetchExperiment(experimentUUID); |
| 114 | + const experiment = experimentResponse.getModel(); |
| 115 | + if (experiment && experimentResponse.isOk()) { |
| 116 | + this.fOpenExperiments.set(experimentUUID, experiment); |
| 117 | + return experiment; |
| 118 | + } |
| 119 | + return undefined; |
| 120 | + } |
| 121 | + |
| 122 | + /** |
| 123 | + * Delete the given experiment from the server |
| 124 | + * @param experimentUUID experiment UUID |
| 125 | + */ |
| 126 | + async deleteExperiment(experimentUUID: string): Promise<void> { |
| 127 | + const experimentToDelete = this.fOpenExperiments.get(experimentUUID); |
| 128 | + if (experimentToDelete) { |
| 129 | + await this.fTspClient.deleteExperiment(experimentUUID); |
| 130 | + const deletedExperiment = this.removeExperiment(experimentUUID); |
| 131 | + if (deletedExperiment) { |
| 132 | + signalManager().emit('EXPERIMENT_DELETED', deletedExperiment); |
| 133 | + } |
| 134 | + } |
| 135 | + } |
| 136 | + |
| 137 | + private onExperimentDeleted(experiment: Experiment) { |
| 138 | + /* |
| 139 | + * TODO: Do not close traces used by another experiment |
| 140 | + */ |
| 141 | + // Close each trace |
| 142 | + const traces = experiment.traces; |
| 143 | + for (let i = 0; i < traces.length; i++) { |
| 144 | + this.fTraceManager.deleteTrace(traces[i].UUID); |
| 145 | + } |
| 146 | + } |
| 147 | + |
| 148 | + public addExperiment(experiment: Experiment): void { |
| 149 | + this.fOpenExperiments.set(experiment.UUID, experiment); |
| 150 | + experiment.traces.forEach(trace => { |
| 151 | + this.fTraceManager.addTrace(trace); |
| 152 | + }); |
| 153 | + } |
| 154 | + |
| 155 | + private removeExperiment(experimentUUID: string): Experiment | undefined { |
| 156 | + const deletedExperiment = this.fOpenExperiments.get(experimentUUID); |
| 157 | + this.fOpenExperiments.delete(experimentUUID); |
| 158 | + return deletedExperiment; |
| 159 | + } |
| 160 | +} |
0 commit comments