vdk-jupyter: Pick up REST API URL from the env (#2142)

Currently, users are expected to configure the REST API URL manually, which is a bad practice. After this change, the REST API URL will be picked up from the environment, which means it will be configured when deploying the docker image. Also, a file with a typo in its name was renamed. Testing done: pipelines --------- Signed-off-by: Gabriel Georgiev <[email protected]>
vmware · May 30, 2023 · e4f392c · e4f392c
1 parent 3dbb53b
commit e4f392c
Show file tree

Hide file tree

Showing 12 changed files with 27 additions and 72 deletions.
diff --git a/...k-plugins/vdk-jupyter/vdk-jupyterlab-extension/src/__tests__/create-job-component.spec.ts b/...k-plugins/vdk-jupyter/vdk-jupyterlab-extension/src/__tests__/create-job-component.spec.ts
@@ -82,15 +82,6 @@ describe('#onTeamChange', () => {
   });
 });
 
-describe('#onRestApiUrlChange', () => {
-  it('should change the rest api url in jobData', () => {
-    const component = render(new CreateJobDialog(defaultProps).render());
-    const input = component.getByPlaceholderText('http://my_vdk_instance');
-    fireEvent.change(input, { target: { value: 'random-url' } });
-    expect(jobData.get(VdkOption.REST_API_URL)).toEqual('random-url');
-  });
-});
-
 describe('#onPathChange', () => {
   it('should change the path in jobData', () => {
     const component = render(new CreateJobDialog(defaultProps).render());

diff --git a/...k-plugins/vdk-jupyter/vdk-jupyterlab-extension/src/__tests__/delete-job-component.spec.ts b/...k-plugins/vdk-jupyter/vdk-jupyterlab-extension/src/__tests__/delete-job-component.spec.ts
@@ -46,12 +46,3 @@ describe('#onTeamChange', () => {
     expect(jobData.get(VdkOption.TEAM)).toEqual('second-team');
   });
 });
-
-describe('#onRestApiUrlChange', () => {
-  it('should change the rest api url in jobData', () => {
-    const component = render(new DeleteJobDialog(defaultProps).render());
-    const input = component.getByPlaceholderText('http://my_vdk_instance');
-    fireEvent.change(input, { target: { value: 'random-url' } });
-    expect(jobData.get(VdkOption.REST_API_URL)).toEqual('random-url');
-  });
-});
diff --git a/...k-plugins/vdk-jupyter/vdk-jupyterlab-extension/src/__tests__/deploy-job-component.spec.ts b/...k-plugins/vdk-jupyter/vdk-jupyterlab-extension/src/__tests__/deploy-job-component.spec.ts
@@ -69,15 +69,6 @@ describe('#onTeamChange', () => {
   });
 });
 
-describe('#onRestApiUrlChange', () => {
-  it('should change the rest api url in jobData', () => {
-    const component = render(new DeployJobDialog(defaultProps).render());
-    const input = component.getByPlaceholderText('http://my_vdk_instance');
-    fireEvent.change(input, { target: { value: 'random-url' } });
-    expect(jobData.get(VdkOption.REST_API_URL)).toEqual('random-url');
-  });
-});
-
 describe('#onPathChange', () => {
   it('should change the path in jobData', () => {
     const component = render(new DeployJobDialog(defaultProps).render());

diff --git a/...plugins/vdk-jupyter/vdk-jupyterlab-extension/src/__tests__/download-job-component.spec.ts b/...plugins/vdk-jupyter/vdk-jupyterlab-extension/src/__tests__/download-job-component.spec.ts
@@ -54,15 +54,6 @@ describe('#onTeamChange', () => {
   });
 });
 
-describe('#onRestApiUrlChange', () => {
-  it('should change the rest api url in jobData', () => {
-    const component = render(new DownloadJobDialog(defaultProps).render());
-    const input = component.getByPlaceholderText('http://my_vdk_instance');
-    fireEvent.change(input, { target: { value: 'random-url' } });
-    expect(jobData.get(VdkOption.REST_API_URL)).toEqual('random-url');
-  });
-});
-
 describe('#onPathChange', () => {
   it('should change the path in jobData', () => {
     const component = render(new DownloadJobDialog(defaultProps).render());

diff --git a/projects/vdk-plugins/vdk-jupyter/vdk-jupyterlab-extension/src/components/CreateJob.tsx b/projects/vdk-plugins/vdk-jupyter/vdk-jupyterlab-extension/src/components/CreateJob.tsx
@@ -61,11 +61,6 @@ export default class CreateJobDialog extends Component<(IJobFullProps)> {
           value={this.props.jobTeam}
           label="Job Team:"
         ></VDKTextInput>
-        <VDKTextInput
-          option={VdkOption.REST_API_URL}
-          value="http://my_vdk_instance"
-          label="Rest API URL:"
-        ></VDKTextInput>
         <VDKTextInput
           option={VdkOption.PATH}
           value={this.props.jobPath}
@@ -79,26 +74,24 @@ export default class CreateJobDialog extends Component<(IJobFullProps)> {
    */
   private _onLocalClick() {
     return (event: React.MouseEvent) => {
-      this.setJobFlags('Local', 'jobPath');
+      this.setJobFlags('Local');
     };
   }
   /**
    * Callback invoked upon choosing cloud checkbox
    */
   private _onCloudClick() {
     return (event: React.MouseEvent) => {
-      this.setJobFlags('Cloud', 'jobRestApiUrl');
+      this.setJobFlags('Cloud');
     };
   }
   /**
    * Function that sets job's cloud/local flags
    */
-  private setJobFlags(flag: string, inputId: string) {
+  private setJobFlags(flag: string) {
     let checkbox = document.getElementById(flag);
-    let input = document.getElementById(inputId);
     if (checkbox?.classList.contains('checked')) {
       checkbox.classList.remove('checked');
-      input?.parentElement?.classList.add('hidden');
       if (flag === 'Cloud') {
         jobData.set(VdkOption.CLOUD, '');
       } else {
@@ -111,7 +104,6 @@ export default class CreateJobDialog extends Component<(IJobFullProps)> {
       } else {
         jobData.set(VdkOption.LOCAL, '1');
       }
-      input?.parentElement?.classList.remove('hidden');
     }
   }
 }

diff --git a/projects/vdk-plugins/vdk-jupyter/vdk-jupyterlab-extension/src/components/DeleteJob.tsx b/projects/vdk-plugins/vdk-jupyter/vdk-jupyterlab-extension/src/components/DeleteJob.tsx
@@ -35,11 +35,6 @@ export default class DeleteJobDialog extends Component<IJobNameAndTeamProps> {
           value={this.props.jobTeam}
           label="Job Team:"
         ></VDKTextInput>
-        <VDKTextInput
-          option={VdkOption.REST_API_URL}
-          value="http://my_vdk_instance"
-          label="Rest API URL:"
-        ></VDKTextInput>
       </>
     );
   }
@@ -63,8 +58,6 @@ export async function showDeleteJobDialog() {
         body:
           'Do you really want to delete the job with name ' +
           jobData.get(VdkOption.NAME) +
-          ' from ' +
-          jobData.get(VdkOption.REST_API_URL) +
           '?',
         buttons: [
           Dialog.cancelButton({ label: 'Cancel' }),

diff --git a/projects/vdk-plugins/vdk-jupyter/vdk-jupyterlab-extension/src/components/DeployJob.tsx b/projects/vdk-plugins/vdk-jupyter/vdk-jupyterlab-extension/src/components/DeployJob.tsx
@@ -35,11 +35,6 @@ export default class DeployJobDialog extends Component<(IJobFullProps)> {
           value={this.props.jobTeam}
           label="Job Team:"
         ></VDKTextInput>
-        <VDKTextInput
-          option={VdkOption.REST_API_URL}
-          value="http://my_vdk_instance"
-          label="Rest API URL:"
-        ></VDKTextInput>
         <VDKTextInput
           option={VdkOption.PATH}
           value={this.props.jobPath}
@@ -113,7 +108,7 @@ export async function showCreateDeploymentDialog() {
           }
         } else {
           showErrorMessage(
-            'Encauntered an error while running the job!',
+            'Encоuntered an error while running the job!',
             message,
             [Dialog.okButton()]
           );

diff --git a/projects/vdk-plugins/vdk-jupyter/vdk-jupyterlab-extension/src/components/DownloadJob.tsx b/projects/vdk-plugins/vdk-jupyter/vdk-jupyterlab-extension/src/components/DownloadJob.tsx
@@ -35,11 +35,6 @@ export default class DownloadJobDialog extends Component<IJobPathProp> {
           value="default-team"
           label="Job Team:"
         ></VDKTextInput>
-        <VDKTextInput
-          option={VdkOption.REST_API_URL}
-          value="http://my_vdk_instance"
-          label="Rest API URL:"
-        ></VDKTextInput>
         <VDKTextInput
           option={VdkOption.PATH}
           value={this.props.jobPath}

diff --git a/projects/vdk-plugins/vdk-jupyter/vdk-jupyterlab-extension/src/jobData.ts b/projects/vdk-plugins/vdk-jupyter/vdk-jupyterlab-extension/src/jobData.ts
@@ -41,7 +41,6 @@ export function getJobDataJsonObject() {
   const jsObj = {
     jobName: jobData.get(VdkOption.NAME),
     jobTeam: jobData.get(VdkOption.TEAM),
-    restApiUrl: jobData.get(VdkOption.REST_API_URL),
     jobPath: jobData.get(VdkOption.PATH),
     cloud: jobData.get(VdkOption.CLOUD),
     local: jobData.get(VdkOption.LOCAL),

diff --git a/projects/vdk-plugins/vdk-jupyter/vdk-jupyterlab-extension/src/vdkOptions/vdk_options.ts b/projects/vdk-plugins/vdk-jupyter/vdk-jupyterlab-extension/src/vdkOptions/vdk_options.ts
@@ -6,7 +6,6 @@
 export enum VdkOption {
   NAME = 'jobName',
   TEAM = 'jobTeam',
-  REST_API_URL = 'restApiUrl',
   PATH = 'jobPath',
   CLOUD = 'cloud',
   LOCAL = 'local',

diff --git a/...cts/vdk-plugins/vdk-jupyter/vdk-jupyterlab-extension/vdk_jupyterlab_extension/handlers.py b/...cts/vdk-plugins/vdk-jupyter/vdk-jupyterlab-extension/vdk_jupyterlab_extension/handlers.py
@@ -1,6 +1,7 @@
 # Copyright 2021-2023 VMware, Inc.
 # SPDX-License-Identifier: Apache-2.0
 import json
+import os
 
 import tornado
 from jupyter_server.base.handlers import APIHandler
@@ -11,6 +12,24 @@
 from .vdk_ui import VdkUI
 
 
+class HandlerConfiguration:
+    def __init__(self):
+        self._rest_api_url = os.environ["REST_API_URL"]
+        if not self._rest_api_url:
+            raise Exception(
+                "What happened: Missing environment variable REST_API_URL.\n"
+                "Why it happened: This is probably caused by a corrupt environment.\n"
+                "Consequences: The current environment cannot work as it cannot connect to the VDK Control Service.\n"
+                "Countermeasures: Please alert your support team; alternatively, try restarting your environment."
+            )
+
+    def get_rest_api_url(self):
+        return self._rest_api_url
+
+
+handler_config = HandlerConfiguration()
+
+
 class LoadJobDataHandler(APIHandler):
     """
     Class responsible for handling POST request for retrieving data(full path, job's name and team)
@@ -66,7 +85,7 @@ def post(self):
             status = VdkUI.delete_job(
                 input_data[VdkOption.NAME.value],
                 input_data[VdkOption.TEAM.value],
-                input_data[VdkOption.REST_API_URL.value],
+                handler_config.get_rest_api_url(),
             )
             self.finish(json.dumps({"message": f"{status}", "error": ""}))
         except Exception as e:
@@ -89,7 +108,7 @@ def post(self):
             status = VdkUI.download_job(
                 input_data[VdkOption.NAME.value],
                 input_data[VdkOption.TEAM.value],
-                input_data[VdkOption.REST_API_URL.value],
+                handler_config.get_rest_api_url(),
                 input_data[VdkOption.PATH.value],
             )
             self.finish(json.dumps({"message": f"{status}", "error": ""}))
@@ -114,7 +133,7 @@ def post(self):
             status = VdkUI.create_job(
                 input_data[VdkOption.NAME.value],
                 input_data[VdkOption.TEAM.value],
-                input_data[VdkOption.REST_API_URL.value],
+                handler_config.get_rest_api_url(),
                 input_data[VdkOption.PATH.value],
                 bool(input_data[VdkOption.LOCAL.value]),
                 bool(input_data[VdkOption.CLOUD.value]),
@@ -140,7 +159,7 @@ def post(self):
             status = VdkUI.create_deployment(
                 input_data[VdkOption.NAME.value],
                 input_data[VdkOption.TEAM.value],
-                input_data[VdkOption.REST_API_URL.value],
+                handler_config.get_rest_api_url(),
                 input_data[VdkOption.PATH.value],
                 input_data[VdkOption.DEPLOYMENT_REASON.value],
                 input_data[VdkOption.DEPLOY_ENABLE.value],

diff --git a/.../vdk-jupyter/vdk-jupyterlab-extension/vdk_jupyterlab_extension/vdk_options/vdk_options.py b/.../vdk-jupyter/vdk-jupyterlab-extension/vdk_jupyterlab_extension/vdk_options/vdk_options.py
@@ -6,7 +6,6 @@
 class VdkOption(Enum):
     NAME = "jobName"
     TEAM = "jobTeam"
-    REST_API_URL = "restApiUrl"
     PATH = "jobPath"
     CLOUD = "cloud"
     LOCAL = "local"