confluentinc / vscode

Confluent for Visual Studio Code
https://marketplace.visualstudio.com/items?itemName=confluentinc.vscode-confluent
Apache License 2.0
13 stars 3 forks source link

If project generation fails, notification should provide helpful actions #356

Open noeldevelops opened 1 month ago

noeldevelops commented 1 month ago

Code of Conduct

On what operating system are you seeing the problem?

macOS (Apple/arm64)

VS Code version

1.94.1 (Universal)

Version of Confluent extension

v0.17.x

To Reproduce

⚠️ difficult if not impossible to reproduce! (thankfully) I was forcing an error to occur locally

  1. Run the "Generate project from template" command
  2. Fill out the form and Submit
  3. In a terrible alternate universe, the project is not generated because an Error Occured
  4. View the 'error notification' in the VS Code window - in the latest iteration (v.0.18) it has two options, but neither is super helpful Screenshot 2024-10-09 at 11 25 26 AM

Current vs. Expected behavior

I expect that the error notification has specific information about what went wrong and actionable buttons to resolve it, not just "try again"

Relevant log output

n/a

Which area(s) are affected? (Select all that apply)

Project generation

Additional context

Low priority imo. This issue is very rare and hard to reproduce. It is unlikely end users will encounter this without something else going wrong before they get here.

noeldevelops commented 3 weeks ago

This can be a example/pattern for other error handling in the app

noeldevelops commented 3 weeks ago

Docs team input and guidelines would be great for errors cc @JimGalasyn @tikimims

noeldevelops commented 3 weeks ago

Example of opening logs on command: https://github.com/confluentinc/vscode/blob/6c61210b68ff1eb6ff8debb8fe433d600c9cc907/src/consume.ts#L426-L432