Release 0.2.1 (official release)

[noklam]

How to install

fix #88

you can install pre-release version of extension from marketplace directly:

• Click the arrow next to the Install button

How to test

• Make sure you open VSCode at the root of a Kedro project

• Make sure VSCode is using the correct virtual environment, i.e. the environment that you can do kedro run

• Bonus: Start a fresh new environment, kedro project to test because we need to make sure dependencies is not a problem. We added a new flow in case user are missing certain dependencies.

• Test Kedro: Run Viz

• playaround with namespace, non spaceflights project structure.

• Make sure kedro-viz is an optional dependency and don't crash the server. #71

[jitu5]

@noklam Will it be useful to track who is installing and canceling "Kedro-Viz" dependency in telemetry ?

[noklam]

@noklam Will it be useful to track who is installing and canceling "Kedro-Viz" dependency in telemetry ?

We cannot track who is installing since that's personal information. I think it's more important to know if people are cancelling because of bug or it doesn't work, the usage of the installation is not too important since we are not going to remove it simply because people are not clicking on it.

[noklam]

One thing that I want to improve though, is a little bit more help or at least guide user to report the issue when the server didn't start properly. I think that's the most frustrating part for now, since it doesn't do anything and user have little information about what's going on.

Based on some previous chat a few users have installed it but it didn't worked for their project so they didn't use the extension. Sometimes it's simply because they are not opening the workspace or missing dependencies to start the extension. (This is separated and we don't need to block this for the release, just something to consider in the future).

[jitu5]

One thing that I want to improve though, is a little bit more help or at least guide user to report the issue when the server didn't start properly. I think that's the most frustrating part for now, since it doesn't do anything and user have little information about what's going on.

Based on some previous chat a few users have installed it but it didn't worked for their project so they didn't use the extension. Sometimes it's simply because they are not opening the workspace or missing dependencies to start the extension. (This is separated and we don't need to block this for the release, just something to consider in the future).

On similar line we also need to fix those panic errors when not on a Kedro project.

[noklam]

Good point, I want to spare some time after this feature release on more bug fix, UX improvement and start adding some tests.

#58

[astrojuanlu]

Right after opening my IDE I found this error:

2024-09-20 17:50:45.543 [info] Traceback (most recent call last):
  File "/Users/juan_cano/.vscode/extensions/kedro.kedro-0.2.0/bundled/tool/lsp_server.py", line 75, in <module>

2024-09-20 17:50:45.543 [info]     import yaml
ModuleNotFoundError: No module named 'yaml'

vscode-kedro/bundled/tool/lsp_server.py

Line 75 in 8ed1f30

import yaml

Make sure VSCode is using the correct virtual environment, i.e. the environment that you can do kedro run

It was indeed solved by setting the correct Python interpreter.

Test Kedro: Run Viz

I get the "missing dependency" prompt, click "Install", I get an info message saying "Kedro-Viz and its Dependencies installed successfully!", and then nothing happens ❓

I run Run Viz again and I get the same prompt.

Looking at the output, I get "No module named pip", which makes a ton of sense because my environment doesn't have pip installed (uv venv doesn't install pip by default).

I eventually solved it by doing uv add kedro-viz myself.

I now see a black screen though, and nothing meaningful in the output.

[jitu5]

Right after opening my IDE I found this error:

2024-09-20 17:50:45.543 [info] Traceback (most recent call last):
  File "/Users/juan_cano/.vscode/extensions/kedro.kedro-0.2.0/bundled/tool/lsp_server.py", line 75, in <module>

2024-09-20 17:50:45.543 [info]     import yaml
ModuleNotFoundError: No module named 'yaml'

vscode-kedro/bundled/tool/lsp_server.py

Line 75 in 8ed1f30

import yaml

Make sure VSCode is using the correct virtual environment, i.e. the environment that you can do kedro run

It was indeed solved by setting the correct Python interpreter.

Test Kedro: Run Viz

I get the "missing dependency" prompt, click "Install", I get an info message saying "Kedro-Viz and its Dependencies installed successfully!", and then nothing happens ❓

I run Run Viz again and I get the same prompt.

Looking at the output, I get "No module named pip", which makes a ton of sense because my environment doesn't have pip installed (uv venv doesn't install pip by default).

I eventually solved it by doing uv add kedro-viz myself.

I now see a black screen though, and nothing meaningful in the output.

@astrojuanlu About the blank screen, LSP server error log coming from Kedro-Viz was missing and just print statement was added, we will fix this before final release. In one of my Kedro project I also got blank screen, on debug I found "Class 'pandas.CSVDataset' not found" error. Which kedro project are you using ?

[astrojuanlu]

I was using a WIP version of https://github.com/astrojuanlu/kedro-pypi-monitor, not sure if you'll be able to reproduce. Let me know when I can try a version with logs.

[jitu5]

I was using a WIP version of https://github.com/astrojuanlu/kedro-pypi-monitor, not sure if you'll be able to reproduce. Let me know when I can try a version with logs.

@astrojuanlu I tried and able to reproduce same blank screen and in log I got below error. I have a extension with log, you have to install it. I can share in in Slack.

Globals key 'start_date' not found and no default value provided.
    full_key: pypi_kedro_raw.sql
    object_type=dict

Also I tried running kedro viz run on the same Kedro project and got the same above error.

[astrojuanlu]

Thanks, looks like problem was between chair and keyboard then!

Any chance to show an error message instead of a blank screen? Or at least an error notification like "couldn't display Kedro Viz, check logs"

[noklam]

Looking at the output, I get "No module named pip", which makes a ton of sense because my environment doesn't have pip installed (uv venv doesn't install pip by default).

That was indeed the assumptions with pip. c189778 Update the message slightly.

For the blank screen, any idea @jitu5?

[rashidakanchwala]

I am still reviewing some other things.
But I also got a blank Kedro-viz screen initially, and Nok showed me how I need to go to Outputs on VSCode, select Kedro to understand what error was being thrown. Not sure, if others will also face the same issue and know where to find the error logs.

[jitu5]

couldn't display Kedro Viz, check logs

@noklam @astrojuanlu
In case of blank screen or server error while getting json data by Kedro-Viz, I can show error message like this,

[noklam]

looks good for me, I notice this seems to be a common thing to do among extensions, maybe it's even better make this one step instead of Output -> Kedro? We will need to update the README.md to reflect the troubleshoot section too.

They all implement a simple command that directly go to the extension outputs, for example:
https://github.com/microsoft/vscode/blob/464f63c2f7ec85dfa7c1946ba62994072945cef2/extensions/tunnel-forwarding/src/extension.ts#L99-L106

[jitu5]

looks good for me, I notice this seems to be a common thing to do among extensions, maybe it's even better make this one step instead of Output -> Kedro? We will need to update the README.md to reflect the troubleshoot section too.

They all implement a simple command that directly go to the extension outputs, for example: https://github.com/microsoft/vscode/blob/464f63c2f7ec85dfa7c1946ba62994072945cef2/extensions/tunnel-forwarding/src/extension.ts#L99-L106

@noklam If we can directly open Kedro output check with command, So I make a link, by clicking on that user will directly jump to Kedro output logs

[noklam]

That's look smooooth

[astrojuanlu]

Ship ittttttt

[rashidakanchwala]

This is suppper exciting!

[noklam]

Updated release title to be 0.2.1 since the VSCode extension treat pre-release as an official release and not allow the same version name.

[noklam]

Updated the contribution point so this is now a public facing command Kedro: Show logs to simplify the troubleshooting steps.

[jitu5]