evidence-dev/evidence-vscode

Start Server and Create project from template progress notification messages and display

archiewood opened this issue · 4 comments

Wasn't sure there was a good issue that covered both of these
These are pretty minor

Start Server

  • hangs around after the process finishes

CleanShot 2023-06-02 at 15 19 35

Create project

  • All on one line so you can't read all the text
  • hangs around after the process finishes
image
  • Those are standard Information and Progress Notification messages. So, I renamed this issue. I know web apps use toasts lingo. VS Code uses notification message terminology.
  • VS Code docs have good page describing the different notification message types accessible to extension developers via their public api with some UX guidelines: https://code.visualstudio.com/api/ux-guidelines/notifications
  • Also, the first notification message on Start server is not from Evidence extension. Must be some other NodeJS extension displaying it in your VS Code installation. Check Source: in the displayed notification message to determine what extension it is from.
  • The second message on server startup and progress display when project is created from template are related to our general delay timers and faster start up time on your platform OS.
  • Those app server command progress delay timers and messages display might be hard to fix without implementing custom Evidence app shell instead of using primitive vscode send command only terminal API.
  • We used simple Terminal API to get the MVP out in a week, and can revisit more advanced and in sync with started processes shell implementation and notifications later. See #4 for more Evidence terminal implementation info.
  • With the shell API we could actually get running process response. Terminal API we are using now only gives us Process Id that we added recently to the new Evidence Output channel sink in #50.
  • There is no other process info that we can get from sending command to terminal to fine tune those delays from the terminal via vscode api.
  • We'll change those delays to match actual delays while running Evidence app via node in GitHub Codespaces to improve onboarding in the browser. We'll have to use those timings as the most common denominator.
  • We'll refine the Finished creating project progress step message, but you should have an option to expand it and see the full message.
  • We might be able to get better app page loading detection by using ping() recently added to src/utils/httpUtils.ts in 03a798a, and close some of those dialogs for the running server before our next release.

Create project

  • All on one line so you can't read all the text
  • hangs around after the process finishes

Refined in #58. To resolve it completely we'll have to switch to embedding template project files in extension package or use different github cloning library that gives us better progress reporting.

You can expand the Finished message step to see the full message. That should be doable even without the changes in #58.

Start Server

  • hangs around after the process finishes

This is not reproducible in the latest version of this extension in this branch.

That install dependencies and start server two step process has been split earlier this week. I suspect you captured that with older rev. of this ext. prior to that install/start flow split.

Please provide more detailed list of steps in text along with screen captures next time, as it is not always clear of how you got it, and provide recordings in 2 or 3x speed. Sometimes it's hard to tell what is working or not when those gifs are reduced.

Here is what you should be seeing:

evidence-install-dependencies-start-flow

Closing this as resolved. See #58 for the other issue you mentioned.