Update wireviz version to latest

[rwarren]

Kroki currently uses wireviz v0.3.3 (which is not even an official version... see below). The latest version is v0.4.1. Updating would be very nice.

---

More detail...

The wireviz version currently in use is v0.3.3, per this line:

kroki/server/ops/docker/jdk17-noble/Dockerfile

Line 180 in d96fd25

ARG WIREVIZ_VERSION="0.3.3"

Curiously, v0.3.3 is not even an official wireviz tag!? Officail Wireviz versions jump from v0.3.2 to v0.4, so I'm not sure how v0.3.3 works.

The latest version of wireviz is v0.4.1, and it contains some significant, and long awaited, features.

NOTE: You can't even run basic wireviz tutorials with the v0.3.x version included with Kroki! For example the syntax for this wireviz tutorial currently fails with the syntax below (also available at the kroki.io renderer here):

connectors:
  X1:
    pinlabels: [+12V, GND, GND, +5V]
    type: Molex 8981
    subtype: female
  F1:
    style: simple
    type: Crimp ferrule
    subtype: 0.5 mm²
    color: OG # optional color

cables:
  W1:
    category: bundle # bundle
    length: 0.3
    gauge: 0.5 mm2
    colors: [YE, BK, BK, RD] # custom colors, wirecount is implicit

connections:
  -
    - F1. # a new ferrule is auto-generated for each of the four wires
    - W1: [1-4]
    - X1: [1-4]

The problem is the relatively new syntax in connections: with F1.. Drop the . and it renders... but not as it should.

[ggrossetie]

We are using a fork: https://github.com/yuzutech/WireViz mainly because we are consuming wireviz as a binary CLI (and not as a Python library).

$ echo 'yaml definition' | wireviz -f svg - -o -

My pull request didn't get merged (wireviz/WireViz#321) but it seems that it's now possible to specify an output file. Not sure if outputting to stdout and reading the content from stdin are supported though...

[sgorsh]

I've created Python wrapper for WireViz with no changes to existing WireViz files:
https://github.com/sgorsh/WireViz/

Binary for Kroki can be downloaded here:
https://github.com/sgorsh/WireViz/releases/tag/v0.4.1-kroki

You can merge this into https://github.com/yuzutech/WireViz/. This method should allow seamless upgrade of WireViz. I would create a pull request but I'm not familiar enough with CI scripts for your repo. Wrapper also supports WireViz version output with wireviz -v.

Here's a test output with local Kroki server and WireWiz v0.4 features (https://github.com/sgorsh/WireViz/blob/master/examples/ex12.yml):

[ggrossetie]

@sgorsh That's neat, thanks!

Ideally, I would like to delete my fork and use the upstream version directly. Could you please open an issue on the upstream project to gradually implement this features upstream?

Would it be possible to use the pip package instead of copying/forking the project? As far as I understand, all the custom code is inside `wireviz_kroki.py ?

[ggrossetie]

@sgorsh friendly ping 😉

[sgorsh]

I have looked into WireViz service file but I don't have a good solution for this.

I think the best way would be to call wrapper like my wireviz_kroki.py from Java code, wrapper should use Wireviz pip package directly for best compatibility. Implementing this in upstream doesn't make so much sense because Kroki need specific functionality (output via stdout, stderr). It's better to have own Python code which can be easily changed when needed.

As I've seen you currently compile Python executables for most services? In this case, maybe wrapper could be used in building step when compiling WireViz package...

[ggrossetie]

As I've seen you currently compile Python executables for most services? In this case, maybe wrapper could be used in building step when compiling WireViz package...

Yes, I'm using nuitka to build a binary.

Implementing this in upstream doesn't make so much sense because Kroki need specific functionality (output via stdout, stderr)

I mean, it's always useful to be able to output the result to stdout and read the input from stdin when using the CLI.

I have looked into WireViz service file but I don't have a good solution for this.

Ideally, I would like to have as little code as possible to maintain (and potentially code that will be integrated upstream) and be able to update Wireviz simply by updating a requirements.txt file.

Currently, I'm using a fork https://github.com/yuzutech/WireViz/tree/master but if you know how I could cleanly extend/build upon the pip package, I'm all ears