Extension rewrite #26

JBBianchi · 2024-02-26T09:50:31Z

Many thanks for submitting your Pull Request ❤️!

What this PR does / why we need it:
This is a complete rewrite of the extension. It simplifies & cleans the code and remove the dependency to an external server to render the graph.

Special notes for reviewers:
Fix #27

Additional information (if needed):

Signed-off-by: Jean-Baptiste Bianchi <[email protected]>

ricardozanini

Looks neat! I'd like to see this in action now. Is there a way to install a snapshot?

ricardozanini · 2024-02-26T20:20:32Z

.github/CODEOWNERS

You can remove Manuel here and I'll give you write permissions here. :)

JBBianchi · 2024-02-26T21:55:00Z

Looks neat! I'd like to see this in action now. Is there a way to install a snapshot?

I think you should be able to test it out using the Building from source instructions. The output file (vsix) will have a different name though, serverless-workflow-0.0.1.vsix if I'm not mistaken.

ricardozanini · 2024-02-29T15:33:30Z

@JBBianchi I was able to export to SVG and preview, but for some reason, I couldn't for PNG. The preview pane just opens and shows the diagram when I pick this option. Is this expected?

JBBianchi · 2024-02-29T17:02:12Z

@JBBianchi I was able to export to SVG and preview, but for some reason, I couldn't for PNG. The preview pane just opens and shows the diagram when I pick this option. Is this expected?

It's not, I'll investigate. Did the workflow you were trying to export exist on the disk or was it just a "virtual" file (tab) in VSCode but not yet saved on disk ?

…pace Signed-off-by: Jean-Baptiste Bianchi <[email protected]>

JBBianchi · 2024-02-29T17:38:54Z

I pushed a fix for "virtual files" but I think I faced a race condition on the first time I tried to debug but couldn't reproduce it.

@ricardozanini can you give me some feedbacks using the latest committed version ?

ricardozanini · 2024-02-29T17:55:07Z

@JBBianchi I was able to export to SVG and preview, but for some reason, I couldn't for PNG. The preview pane just opens and shows the diagram when I pick this option. Is this expected?

It's not, I'll investigate. Did the workflow you were trying to export exist on the disk or was it just a "virtual" file (tab) in VSCode but not yet saved on disk ?

It exists! I'll try the new commit.

ricardozanini · 2024-02-29T17:58:24Z

@JBBianchi same thing, the preview even flashes a little bit now, but won't generate the png. We can do a live session tomorrow, wdyt?

JBBianchi · 2024-02-29T21:49:46Z

Sure, with pleasure.

Signed-off-by: Jean-Baptiste Bianchi <[email protected]>

JBBianchi · 2024-03-01T15:14:10Z

I found a bug when generating the PNG. The process to generate the PNG is the following:

Generate the SVG using Mermaid
Grab the SVG, convert it to base64
Use the base64 as an img tag source
When the image has loaded, inject it in a canvas and export the canvas as PNG

There was a problem generating the base64 from the SVG in some cases (I guess bad character escaping). It should be fixed now. (If GitHub would be kind enough to sync the PR ...)

ricardozanini · 2024-03-01T15:21:42Z

I'll retest again this afternoon! Thanks!

ricardozanini · 2024-03-04T18:45:53Z

@JBBianchi still not working on my machine :(

ricardozanini · 2024-03-06T20:30:53Z

Hey @JBBianchi I asked a friend (@handreyrc) to also test the extension and he used this file:

{
  "id": "statesExample",
  "version": "1.0",
  "specVersion": "0.8",
  "name": "States Example",
  "description": "States Example",
  "start": "Create Initial Data",
  "states": [
   {
    "name": "Create Initial Data",
    "type": "sleep",
    "end": false,
    "transition": "Inject data"
   },
   {
    "name": "Inject data",
    "type": "foreach",
    "end": false,
    "compensatedBy": "Compensate",
    "transition": "Wait for Events",
    "onErrors": [
     {
      "errorRef": "SomeError1",
      "end": false,
      "transition": "Handle Error1"
     },
     {
      "errorRef": "SomeError2",
      "end": false,
      "transition": "Handle Error2"
     }
    ]
   },
   {
    "name": "Handle Error1",
    "type": "inject",
    "end": true
   },
   {
    "name": "Handle Error2",
    "type": "inject",
    "end": true
   },
   {
    "name": "Wait for Events",
    "type": "event",
    "onEvents": [
     {
      "eventRefs": [
       "Event"
      ],
      "actions": [
       {
        "functionRef": "Function"
       }
      ]
     }
    ],
    "transition": "Run Operations",
    "end": false
   },
   {
    "name": "Run Operations",
    "type": "operation",
    "actionMode": "sequential",
    "actions": [
     {
      "name": "action1",
      "functionRef": "Task1"
     },
     {
      "name": "action2",
      "subFlowRef": "Task2"
     }
    ],
    "end": false,
    "transition": "Switch State"
   },
   {
    "name": "Switch State",
    "type": "switch",
    "onErrors": [
     {
      "errorRef": "SomeError3",
      "end": false,
      "transition": "Handle Error3"
     }
    ],
    "eventConditions": [
     {
      "eventRef": "event1",
      "transition": "Event1 State"
     },
     {
      "eventRef": "event2",
      "transition": "Event2 State"
     }
    ],
    "defaultCondition": {
     "transition": "Default State"
    }
   },
   {
    "name": "Handle Error3",
    "type": "callback",
    "end": true
   },
   {
    "name": "Event1 State",
    "type": "event",
    "end": true
   },
   {
    "name": "Event2 State",
    "type": "event",
    "end": true
   },
   {
    "name": "Default State",
    "type": "parallel",
    "end": true
   },
   {
    "name": "Compensate",
    "type": "callback",
    "end": true
   }
  ]
 }

Here's his output:

No the PNG export does not work, it opens a new preview tab for me and no png file is created.
I tested the SVG export as well, it seems it quickly creates a new tab and then closes it in the process. The SVG file was created but I cannot open it, it is broken.

JBBianchi · 2024-03-07T08:09:08Z

Afaik, he is not able to preview it either because the TS SDK raises an error: Format not supported

handreyrc · 2024-03-07T15:28:04Z

Afaik, he is not able to preview it either because the TS SDK raises an error: Format not supported

Hey @JBBianchi,

@ricardozanini posted a workflow not supported by this extension I mentioned in a talk with him. You are right this workflow won't work.
I apologize for the misunterstood!

In fact I tested this PR with many other worflows and it does not work.
Just giving you more background about the behavior above:
OS: Fedora Linux 38
VsCode version: 1.87.0

Here goes one of the workflows it fails:
greeting.sw.json

This is how it looks on my machine. I hope it helps you.

JBBianchi · 2024-03-08T10:25:40Z

Afaik, he is not able to preview it either because the TS SDK raises an error: Format not supported

Hey @JBBianchi,

@ricardozanini posted a workflow not supported by this extension I mentioned in a talk with him. You are right this workflow won't work. I apologize for the misunterstood!

In fact I tested this PR with many other worflows and it does not work. Just giving you more background about the behavior above: OS: Fedora Linux 38 VsCode version: 1.87.0

Here goes one of the workflows it fails: greeting.sw.json

This is how it looks on my machine. I hope it helps you. ...

Thanks for your report. I'll investigate.

Signed-off-by: Jean-Baptiste Bianchi <[email protected]>

JBBianchi · 2024-03-08T13:14:26Z

@handreyrc I pushed an update that should provide more debug info. Could you please try again and tell me what error pops up ?

Two more little things that could bring some pieces of info:

switch to the explorer view
enable the Developer Tools console to see if some messages are displayed there (F1: Developer: Toggle Developer Tools)

Signed-off-by: Jean-Baptiste Bianchi <[email protected]>

JBBianchi · 2024-03-08T14:49:38Z

I fixed a possible race condition where the request to draw the graph would be sent before mermaid was important in the viewport (basically, the handler for the rendering request wouldn't be attached yet, therefore resulting in a blank page).

Besides that, which didn't seem to be the case in @handreyrc case as the graph was rendering, I didn't find anything else and it seems to be working on the latest Fedora:

ricardozanini · 2024-03-11T19:48:30Z

@JBBianchi @handreyrc it's working now!!!

Signed-off-by: Jean-Baptiste Bianchi <[email protected]>

ricardozanini · 2024-03-12T11:35:19Z

@cdavernas @antmendoza can you please review?

cdavernas

LGTM! Cheers ❤️

ricardozanini · 2024-03-18T12:39:29Z

@antmendoza can you ptal?

LuboTerifaj · 2024-03-19T16:29:36Z

Hello @JBBianchi , @ricardozanini

is there any issue reported with the details what is its goal? I see only one bug-fix linked in the PR description. However, the PR's description looks like it has a wider scope than just to fix a bug.

I see there is no github action that would build the extension. Building it locally is the only option at the moment?

Thanks!

ricardozanini · 2024-03-19T16:43:02Z

@LuboTerifaj there's none AFAIK. The extension won't work in the current context. @JBBianchi did the whole rewriting to make it work again. So what we are trying to do here is to test it locally and see if it's working. e.g. visualize the workflow and export to PNG/SVG.

@cdavernas Wanna take a look? After your approval, we can consider merging it. @JBBianchi can we follow up by fixing also the web editor? 🤔

ricardozanini · 2024-03-19T16:43:56Z

@LuboTerifaj one more thing, we don't have a GHA for this extension. If you know about GHA, can you consider a PR? 🙏
thank you!

cdavernas · 2024-03-19T19:07:38Z

@ricardozanini I have already approved it yesterday 😉

JBBianchi · 2024-03-19T19:30:05Z

Hello @JBBianchi , @ricardozanini

is there any issue reported with the details what is its goal? I see only one bug-fix linked in the PR description. However, the PR's description looks like it has a wider scope than just to fix a bug.

I see there is no github action that would build the extension. Building it locally is the only option at the moment?

Thanks!

@LuboTerifaj > The first goal was to fix a bug reported on Slack. But when I tracked the bug I noticed 1st that the extension was relying on an external server to process the graph, which isn't optimal, and 2nd the code base was a bit scattered and not very ubiquitous. Therefore I decided to go for a full refactor, bringing the graph generation inside the extension.

At the moment, we didn't configure any pipeline to build the extension so there only solution to test it is to clone it and build it locally. But it's certainly possible to create a pipeline to do so. Please feel free to contribute one if you feel like it.

@LuboTerifaj there's none AFAIK. The extension won't work in the current context. @JBBianchi did the whole rewriting to make it work again. So what we are trying to do here is to test it locally and see if it's working. e.g. visualize the workflow and export to PNG/SVG.

@cdavernas Wanna take a look? After your approval, we can consider merging it. @JBBianchi can we follow up by fixing also the web editor? 🤔

What fix for the web editor are you talking about @ricardozanini ? (Besides updating the TS SDK. It's not related to this VSCode extension.)

Other general note, there is no tests for the extension. I didn't dig a lot but at first glance I couldn't find a proper e2e testing example for VSCode.

ricardozanini · 2024-03-19T20:05:38Z

@ricardozanini I have already approved it yesterday 😉

LOL

ricardozanini · 2024-03-19T20:06:51Z

@JBBianchi I thought the web editor in the website would share the same libs/framework as the extension. My bad then! Can we merge this?

JBBianchi · 2024-03-20T08:34:52Z

@JBBianchi I thought the web editor in the website would share the same libs/framework as the extension. My bad then! Can we merge this?

They do, the SDK and Mermaid :) We can merge.

LuboTerifaj · 2024-03-21T15:03:59Z

Just fyi, the user experience is not very good when you try to open more workflows in a short time. It is very time consuming to open the diagram using Palette again and again. I have reported the issue here: #29

ricardozanini · 2024-03-22T14:25:00Z

Thank you @LuboTerifaj!

JBBianchi added 2 commits February 20, 2024 11:00

Rewriting extension

2a96a96

Signed-off-by: Jean-Baptiste Bianchi <[email protected]>

fix(global): updated MD and other misc files

df61774

Signed-off-by: Jean-Baptiste Bianchi <[email protected]>

JBBianchi requested review from tsurdilo and ricardozanini as code owners February 26, 2024 09:50

Readded .github directory

4222648

Signed-off-by: Jean-Baptiste Bianchi <[email protected]>

ricardozanini approved these changes Feb 26, 2024

View reviewed changes

ricardozanini requested a review from cdavernas February 27, 2024 12:39

fix(diagram-panel): handled "virtual files" inside or outside a works…

748cc49

…pace Signed-off-by: Jean-Baptiste Bianchi <[email protected]>

fix(diagram-panel): fixed svg convertion to base64

bc21de1

Signed-off-by: Jean-Baptiste Bianchi <[email protected]>

JBBianchi changed the title ~~Extension rewrite~~ [WIP] Extension rewrite Mar 7, 2024

fix(diagram-panel): improved error reporting

7083f03

Signed-off-by: Jean-Baptiste Bianchi <[email protected]>

fix(diagram-panel): fixed possible race condition during mermaid import

daf24f9

Signed-off-by: Jean-Baptiste Bianchi <[email protected]>

ricardozanini approved these changes Mar 11, 2024

View reviewed changes

JBBianchi changed the title ~~[WIP] Extension rewrite~~ Extension rewrite Mar 12, 2024

fix(global): updated version info

dc1db66

Signed-off-by: Jean-Baptiste Bianchi <[email protected]>

JBBianchi force-pushed the main branch from 36bea1a to dc1db66 Compare March 12, 2024 08:13

cdavernas approved these changes Mar 18, 2024

View reviewed changes

ricardozanini merged commit 5769100 into serverlessworkflow:main Mar 20, 2024
1 check passed

ricardozanini mentioned this pull request Mar 21, 2024

Getting better file readme #23

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Extension rewrite #26

Extension rewrite #26

JBBianchi commented Feb 26, 2024 •

edited by ricardozanini

Loading

ricardozanini left a comment

ricardozanini Feb 26, 2024

JBBianchi commented Feb 26, 2024

ricardozanini commented Feb 29, 2024

JBBianchi commented Feb 29, 2024

JBBianchi commented Feb 29, 2024

ricardozanini commented Feb 29, 2024

ricardozanini commented Feb 29, 2024

JBBianchi commented Feb 29, 2024

JBBianchi commented Mar 1, 2024

ricardozanini commented Mar 1, 2024

ricardozanini commented Mar 4, 2024

ricardozanini commented Mar 6, 2024

JBBianchi commented Mar 7, 2024

handreyrc commented Mar 7, 2024 •

edited

Loading

JBBianchi commented Mar 8, 2024 •

edited

Loading

JBBianchi commented Mar 8, 2024 •

edited

Loading

JBBianchi commented Mar 8, 2024

ricardozanini commented Mar 11, 2024

ricardozanini commented Mar 12, 2024

cdavernas left a comment

ricardozanini commented Mar 18, 2024

LuboTerifaj commented Mar 19, 2024

ricardozanini commented Mar 19, 2024

ricardozanini commented Mar 19, 2024

cdavernas commented Mar 19, 2024

JBBianchi commented Mar 19, 2024

ricardozanini commented Mar 19, 2024

ricardozanini commented Mar 19, 2024

JBBianchi commented Mar 20, 2024

LuboTerifaj commented Mar 21, 2024

ricardozanini commented Mar 22, 2024

Extension rewrite #26

Extension rewrite #26

Conversation

JBBianchi commented Feb 26, 2024 • edited by ricardozanini Loading

ricardozanini left a comment

Choose a reason for hiding this comment

ricardozanini Feb 26, 2024

Choose a reason for hiding this comment

JBBianchi commented Feb 26, 2024

ricardozanini commented Feb 29, 2024

JBBianchi commented Feb 29, 2024

JBBianchi commented Feb 29, 2024

ricardozanini commented Feb 29, 2024

ricardozanini commented Feb 29, 2024

JBBianchi commented Feb 29, 2024

JBBianchi commented Mar 1, 2024

ricardozanini commented Mar 1, 2024

ricardozanini commented Mar 4, 2024

ricardozanini commented Mar 6, 2024

JBBianchi commented Mar 7, 2024

handreyrc commented Mar 7, 2024 • edited Loading

JBBianchi commented Mar 8, 2024 • edited Loading

JBBianchi commented Mar 8, 2024 • edited Loading

JBBianchi commented Mar 8, 2024

ricardozanini commented Mar 11, 2024

ricardozanini commented Mar 12, 2024

cdavernas left a comment

Choose a reason for hiding this comment

ricardozanini commented Mar 18, 2024

LuboTerifaj commented Mar 19, 2024

ricardozanini commented Mar 19, 2024

ricardozanini commented Mar 19, 2024

cdavernas commented Mar 19, 2024

JBBianchi commented Mar 19, 2024

ricardozanini commented Mar 19, 2024

ricardozanini commented Mar 19, 2024

JBBianchi commented Mar 20, 2024

LuboTerifaj commented Mar 21, 2024

ricardozanini commented Mar 22, 2024

JBBianchi commented Feb 26, 2024 •

edited by ricardozanini

Loading

handreyrc commented Mar 7, 2024 •

edited

Loading

JBBianchi commented Mar 8, 2024 •

edited

Loading

JBBianchi commented Mar 8, 2024 •

edited

Loading