Merge pull request #395 from AutomatingSciencePipeline/173-cancelling-an-experiment-in-progress

Add cancel feature

Author: rhit-windsors

apps/backend/app.py

@@ -66,6 +66,15 @@ def spawn_job(experiment_data):
     job = create_job_object(experiment_data)
     create_job(BATCH_API, job)
 
+@flaskApp.post("/cancelExperiment")
+def cancel_experiment():
+    """The query to cancel an experiment"""
+    data = request.get_json()
+    job_name = data['jobName']
+    # kill the job
+    BATCH_API.delete_namespaced_job(job_name, "default", propagation_policy="Background")
+    return Response(status=200)
+    
 @flaskApp.post("/uploadResults")
 def upload_results():
     json = request.get_json()

apps/backend/spawn_runner.py

@@ -12,7 +12,8 @@
 def create_job_object(experiment_data):
     """Function that creates the job object for the runner"""
     # Configure Pod template container
-    job_name = "runner-" + str(time.time())
+    job_name = "runner-" + experiment_data['experiment']['id']
+    
     job_command = ["python3", "runner.py", json.dumps(experiment_data)]
 
     runner_body = get_yaml_file_body(RUNNER_PATH)

apps/frontend/app/components/flows/ViewExperiment/ExperimentListing.tsx

@@ -4,7 +4,7 @@ import { useEffect, useState } from 'react';
 import { ExperimentData } from '../../../../lib/db_types';
 import { MdEdit } from 'react-icons/md';
 import Chart from './Chart';
-import { addShareLink, unfollowExperiment, updateExperimentNameById } from '../../../../lib/mongodb_funcs';
+import { addShareLink, unfollowExperiment, updateExperimentNameById, cancelExperimentById } from '../../../../lib/mongodb_funcs';
 import toast from 'react-hot-toast';
 import { useSession } from 'next-auth/react';
 
@@ -248,13 +248,28 @@ export const ExperimentListing = ({ projectData: projectData, onCopyExperiment,
 				</button> */}
 				{
 					project.creator == session?.user?.id! ?
-						<button type="button"
-							className='inline-flex items-center justify-center px-4 py-2 border border-transparent shadow-sm text-sm font-medium rounded-md text-white bg-blue-600 hover:bg-blue-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500 xl:w-full'
-							onClick={() => {
-								openDeleteModal();
-							}}>
-							Delete Experiment
-						</button> :
+						(
+							project.finished ?
+								<button type="button"
+									className='inline-flex items-center justify-center px-4 py-2 border border-transparent shadow-sm text-sm font-medium rounded-md text-white bg-blue-600 hover:bg-blue-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500 xl:w-full'
+									onClick={() => {
+										openDeleteModal();
+									}}>
+									Delete Experiment
+								</button>
+								:
+								<button type="button"
+									className='inline-flex items-center justify-center px-4 py-2 border border-transparent shadow-sm text-sm font-medium rounded-md text-white bg-blue-600 hover:bg-blue-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500 xl:w-full'
+									onClick={() => {
+										toast.promise(cancelExperimentById(project.expId), {
+											success: 'Cancelled experiment', error: 'Failed to cancel experiment', loading: 'Cancelling experiment...'
+										});
+									}}
+								>
+									Cancel Experiment
+								</button>
+						)
+						:
 						<button type="button"
 							className='inline-flex items-center justify-center px-4 py-2 border border-transparent shadow-sm text-sm font-medium rounded-md text-white bg-blue-600 hover:bg-blue-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500 xl:w-full'
 							onClick={() => {
@@ -267,12 +282,12 @@ export const ExperimentListing = ({ projectData: projectData, onCopyExperiment,
 						</button>
 				}
 				{project.finished ?
-				 <button type="button"
-					className='inline-flex items-center justify-center px-4 py-2 border border-transparent shadow-sm text-sm font-medium rounded-md text-white bg-blue-600 hover:bg-blue-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500 xl:w-full'
-					onClick={openGraphModal}
-				>
-					See Graph
-				</button> : null
+					<button type="button"
+						className='inline-flex items-center justify-center px-4 py-2 border border-transparent shadow-sm text-sm font-medium rounded-md text-white bg-blue-600 hover:bg-blue-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500 xl:w-full'
+						onClick={openGraphModal}
+					>
+						See Graph
+					</button> : null
 				}
 				{
 					project.creator == session?.user?.id! ?

apps/frontend/lib/mongodb_funcs.ts

@@ -67,6 +67,35 @@ export async function deleteDocumentById(expId: string) {
     return Promise.resolve();
 }
 
+export async function cancelExperimentById(expId: string) {
+    'use server';
+    //Call the backend at the endpoint to cancel the experiment
+    const BACKEND_PORT = process.env.BACKEND_PORT || '5050';
+    const url = `http://glados-service-backend:${BACKEND_PORT}/cancelExperiment`;
+    //Just post a json object with the experiment id
+    const backendResponse = await fetch(url, {
+        method: 'POST',
+        headers: new Headers({
+            'Content-Type': 'application/json',
+        }),
+        body: JSON.stringify({ jobName: 'runner-' + expId }),
+    });
+
+    //Mark the experiment as completed
+    const client = await clientPromise;
+    const collection = client.db(DB_NAME).collection(COLLECTION_EXPERIMENTS);
+    await collection
+        .updateOne({ '_id': new ObjectId(expId) }, { $set: { 'finished': true } });
+
+    //If the backend returns a 200 status code, the experiment was successfully cancelled
+    if (backendResponse.status === 200) {
+        return Promise.resolve(true);
+    } else {
+        return Promise.resolve(false);
+    }
+
+}
+
 export async function updateExperimentNameById(expId: string, newExpName: string) {
     'use server';
     const client = await clientPromise;
@@ -124,7 +153,7 @@ export async function getRecentFiles(userId: string) {
     return serializedFiles;
 }
 
-export async function copyFile(fileID: string, userId: string){
+export async function copyFile(fileID: string, userId: string) {
     'use server';
     const client = await clientPromise;
     const db = client.db(DB_NAME);
@@ -252,4 +281,4 @@ export async function unfollowExperiment(expId: string, userId: string) {
     await collection.updateOne({ '_id': new ObjectId(expId) }, { $pull: { 'sharedUsers': userId as any } });
 
     return Promise.resolve();
-}
+}