Package: vdk-jupyterlab-extension
vdk-jupyterlab-extensionA Jupyterlab extension for using VDK
For more information see:https://github.com/vmware/versatile-data-kit/tree/main/specs/vep-994-jupyter-notebook-integrationThis extension is composed of a Python package namedvdk-jupyterlab-extensionfor the server extension and a NPM package namedvdk-jupyterlab-extensionfor the frontend extension.RequirementsJupyterLab >= 3.0python ~=3.7Versatile Data KitnpmInstall and run# install the extensionpipinstallvdk-jupyterlab-extension# run jupyterlabjupyterlabUninstallTo remove the extension, execute:pipuninstallvdk-jupyterlab-extensionTroubleshootIf you are seeing the frontend extension, but it is not working, check
that the server extension is enabled:jupyterserverextensionlistIf the server extension is installed and enabled, but you are not seeing
the frontend extension, check the frontend extension is installed:jupyterlabextensionlistIf you are struggling with a particular aspect of the JupyterLab API,
you can contact the Jupyter team in the following way: go to their repo issues page athttps://github.com/jupyterlab/jupyterlab/issues/new/choosethen click on Open in the "Chat with the devs" section, which will send you
to a Gitter channel where you can ask your question.ContributingDevelopment installNote: You will need NodeJS to build the extension package.Thejlpmcommand is JupyterLab's pinned version ofyarnthat is installed with JupyterLab. You may useyarnornpmin lieu ofjlpmbelow.../cicd/build.shNB: If you're changing some dependencies of the project,
meaning you're adding, removing, or updating packages, you'd use npm install.You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.# Watch the source directory in one terminal, automatically rebuilding when neededjlpmwatch# Run JupyterLab in another terminaljupyterlabWith the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).By default, thejlpm buildcommand generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:jupyterlabbuild--minimize=FalseDevelopment uninstall# Server extension must be manually disabled in develop modejupyterserverextensiondisablevdk-jupyterlab-extension
pipuninstallvdk-jupyterlab-extensionIn development mode, you will also need to remove the symlink created byjupyter labextension developcommand. To find its location, you can runjupyter labextension listto figure out where thelabextensionsfolder is located. Then you can remove the symlink namedvdk-jupyterlab-extensionwithin that folder.Front-end extensionThis extension usesJSX.The components of the front-end extension are located in the /src directory. All the new UI elements are added there.The main script for the extension is index.ts - this is where the front-end extension is loaded.
In handlers.ts the connection with the server is done, while in serverRequests.ts all the requests are sent.
In the subdirectory /components are located the JSX components that represent VDK menu elements.
In the subdirectory /dataClasses are located the data classes responsible for saving the user input data for all the
vdk operations.Server extensionThis extension usesTordnado.All the requests handlers are located in handlers.py file where the communication with the front-end is created.The connection with VDK is done in the vdk_ui.py file - all the vdk operations are handled there.Job data modelFollows the enum VdkOption fromvdk_options.py.In the front-end extension a global storage object (jobData), which holds the information about the current job, is present.
It holds key value pairs, it's keys are generated automatically from theenumand the values of the keys are changed during vdk operations and after the operation ends they need to be set back to default.For example, if we want to run a job we would set job path and arguments  as:
jobData.set(VdkOption.PATH, value) and jobData.set(VdkOption.ARGUMENTS, value) and after the operation has passed
the values should be set back to default using setJobDataToDefault() function.Every Jupyter instance has its own global storage object (jobData) that can only be changed from that instance.
When a new Jupyter instance is loaded its jobData is set to default.Theenumis generated automatically fromthe python enumand shall not be changed directly in the .ts file. All the changes must be done in the python file and the .ts file will be automatically reloaded.The front-end sends the data from jobData to the server extension in JSON format.
In the server extension the JSON is loaded as input_data and the specific data can be accessed
via theenum.
For example, input_data[VdkOption.NAME.value] would return current job's name.Testing the extensionServer testsThis extension is usingPytestfor Python code testing.Install test dependencies (needed only once):pipinstall-e".[test]"To execute them, run:pytest-vv-rap--covvdk-jupyterlab-extensionFrontend testsThis extension is usingJestfor JavaScript code testing.To execute them, execute:jlpm
jlpmtestIntegration testsThis extension usesPlaywrightfor the integration tests (aka user level tests).
More precisely, the JupyterLab helperGalatais used to handle testing the extension in JupyterLab.More information are provided within theui-testsREADME.