Suggestion: WebAssembly build of libavoid? #44

planger · 2021-02-11T14:55:32Z

I'd be very interested in using the libavoid library in a browser-based technology stack. Thus, I was thinking whether it would make sense to have a WebAssembly build of libavoid. Is that something that would be of interest for the adaptagrams community?

Or are there JavaScript-based alternatives to libavoid's object-avoiding routing library?

Thanks in advance!

jtiai · 2021-02-17T16:10:53Z

You can do that with emscripten. I did that for fun years ago. to 11. helmik. 2021 klo 16.56 Philip Langer <[email protected]> kirjoitti:

…

I'd be very interested in using the libavoid library in a browser-based technology stack. Thus, I was thinking whether it would make sense to have a WebAssembly build of libavoid. Is that something that would be of interest for the adaptagrams community? Or are there JavaScript-based alternatives to libavoid's object-avoiding routing library? Thanks in advance! — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#44>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAKORMJ4ULDRQNJ6NH6W6WTS6PVXTANCNFSM4XO7EUKA> .

planger · 2021-02-18T14:57:24Z

Thanks, yeah I was thinking about emscripten too. Do you happen to still have the concrete steps, if you've already tried it?
I think it'd be very nice to have a dockerfile that builds the wasm for libavoid (or also the other libraries).
I'd be happy to look into providing e.g. the typescript bindings.
Thanks again!

jtiai · 2021-02-18T16:19:04Z

Unfortunately it's been so long that I did it so I don't remember details. But libavoid code is really clean so I think I just compiled it with emscripten without any extra effort. to 18. helmik. 2021 klo 16.58 Philip Langer <[email protected]> kirjoitti:

…

Thanks, yeah I was thinking about emscripten too. Do you happen to still have the concrete steps, if you've already tried it? I think it'd be very nice to have a dockerfile that builds the wasm for libavoid (or also the other libraries). I'd be happy to look into providing e.g. the typescript bindings. Thanks again! — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#44 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAKORMID3CZ27JTHLINWTD3S7UTGRANCNFSM4XO7EUKA> .

planger · 2021-02-19T08:11:12Z

Thanks anyway! Here is a docker command that seems to successfully create a wasm from libavoid:

  docker run \
  --rm \
  -v $(pwd):/src -w /src/cola/libavoid \
  -u $(id -u):$(id -g) \
  emscripten/emsdk \
  emcc connectionpin.cpp \
                        connector.cpp \
                        connend.cpp \
                        geometry.cpp \
                        geomtypes.cpp \
                        graph.cpp \
                        junction.cpp \
                        makepath.cpp \
                        obstacle.cpp \
                        orthogonal.cpp \
                        router.cpp \
                        shape.cpp \
                        timer.cpp \
                        vertices.cpp \
                        viscluster.cpp \
                        visibility.cpp \
                        vpsc.cpp \
                        hyperedge.cpp \
                        hyperedgeimprover.cpp \
                        mtst.cpp \
                        hyperedgetree.cpp \
                        scanline.cpp \
                        actioninfo.cpp -I/src/cola/ -fPIC -o libavoid.js

I'll try to look into creating the bindings in the next few weeks. If anyone is interested in that, please feel free to comment here.

koahmad · 2021-09-21T19:51:23Z

@planger Thanks for the docker command, was very useful. I'm interesting in the bindings, were you able to create them? I'm new to WASM so still getting a hang of things.

planger · 2021-09-22T06:50:58Z

@Aksem is actually working on providing the bindings and already has a proof of concept for integrating them with https://github.com/eclipse/sprotty. So I hope they will be available soon.

clemmy · 2022-04-21T18:24:46Z

Very interested in this as well for libdialect. The emscripten idea sounds interesting.

Aksem · 2022-04-21T19:24:04Z

@clemmy, WebAssembly build of libavoid is already available : libavoid-js. Without many details, usage guide and similar, but it works(small demo). More is also planned, but I am currently working on improving the algorithm of orthogonal routing in libavoid(my fork).
I would like also to port libdialect, but after finishing the first version of libavoid. If you are interested to do this by yourself, all scripts and steps of how I did it for libavoid are available in the repository, the build is automated, so the build process is transparent. I could also help if you have questions.

clemmy · 2022-04-22T19:46:10Z

@Aksem, that's very exciting to hear! Where would you recommend starting when looking at the libavoid-js repo?

Aksem · 2022-04-22T20:48:27Z

The main source where almost the whole build process is implemented is tools/generate.py script, I would recommend starting with it.

Basically, the build process includes following steps(if the same approach is used as in libavoid-js):

Write WebIDL definitions of the interface that should be available in JavaScript. The result in the case of libavoid-js is in webidl_definitions/libavoid.
Generate C++ and JS glue code using WebIDL Binder. See generate_bindings function.
Compile original C++ and generated glue code with emcc. See compile function. Arguments for emcc is not the easiest theme, I would recommend either starting with minimal set or trying to use the same as for libavoid-js. And start with all possible debug options(you can find them in generate script under debug flag) for emcc and without optimizations, the probability to get working code is higher. In some cases, I had problems with stability and the current command is the best one I found until now.

Another simple tip based on my experience with libavoid-js: don't try to create bindings for the whole API of library. In libavoid-js it's enough to have ~3-4 classes and a few methods in each of them to be able to use its whole power. All other classes are used mostly internally and are useful for example for custom solutions/modifications, which is not the main use case. So creating one example in C++ or analyzing library API in more details is really right way, I realized that later.

Good luck!:)

vlovich · 2023-04-07T03:20:20Z

@Aksem How do I use libavoid-js from node? Am I correct that I have to adjust generate.py and hard-code ENVIRONMENT="node"? Is there some way to have a universal package?

Even when I do that, when I try to await AvoidLib.load() or AvoidLib.getInstance(), it throws:

ReferenceError: self is not defined
    at t (node_modules/libavoid-js/dist/index.js:1:198)
    at Object.<anonymous> (node_modules/libavoid-js/dist/index.js:1:217526)
    at Module._compile (node:internal/modules/cjs/loader:1275:14)
    at Object.F (node_modules/@esbuild-kit/cjs-loader/dist/index.js:1:941)
    at Module.load (node:internal/modules/cjs/loader:1133:32)
    at Module._load (node:internal/modules/cjs/loader:972:12)
    at ModuleWrap.<anonymous> (node:internal/modules/esm/translators:168:29)
    at ModuleJob.run (node:internal/modules/esm/module_job:193:25)
Thrown at:
    at node_modules/libavoid-js/dist/index.js:2:312
    at node_modules/libavoid-js/dist/index.js:3:3
    at Module._compile (node:internal/modules/cjs/loader:1275:14)
    at F (node_modules/@esbuild-kit/cjs-loader/dist/index.js:1:941)
    at Module.load (node:internal/modules/cjs/loader:1133:32)
    at Module._load (node:internal/modules/cjs/loader:972:12)
    at node:internal/modules/esm/translators:168:29
    at run (node:internal/modules/esm/module_job:193:25)

If I hack package.json to use the examples/ variant, then a) the types are not the same as for release b) importing throws an exception:

asynchronously preparing wasm
run() called, but dependencies remain, so not running
node_modules/libavoid-js/examples/libavoid.js:1368
      throw ex;
      ^


TypeError: Failed to parse URL from node_modules/libavoid-js/examples/libavoid.wasm
    at Object.fetch (node:internal/deps/undici/undici:11413:11) {
  [cause]: TypeError [ERR_INVALID_URL]: Invalid URL
      at __node_internal_captureLargerStackTrace (node:internal/errors:490:5)
      at new NodeError (node:internal/errors:399:5)
      at new URL (node:internal/url:588:13)
      at new Request (node:internal/deps/undici/undici:7002:25)
      at fetch2 (node:internal/deps/undici/undici:10554:25)
      at Object.fetch (node:internal/deps/undici/undici:11411:18)
      at fetch (node:internal/process/pre_execution:234:25)
      at instantiateAsync (node_modules/libavoid-js/examples/libavoid.js:2796:14)
      at createWasm (node_modules/libavoid-js/examples/libavoid.js:2835:3)
      at Object.<anonymous> (node_modules/libavoid-js/examples/libavoid.js:3900:11)
      at <anonymous> (path-layout.ts:4:30)
      at ModuleJob.run (node:internal/modules/esm/module_job:193:25) {
    input: 'node_modules/libavoid-js/examples/libavoid.wasm',
    code: 'ERR_INVALID_URL'
  }
}
Thrown at:
    at fetch (node:internal/deps/undici/undici:11413:11)

Aksem · 2023-04-07T19:55:05Z

@vlovich, yes, creating a universal build of the package should be possible. I already have a test version and will finish it over the weekend. I need to do more tests in different environments.

Aksem · 2023-04-19T06:00:01Z

@vlovich , sorry it took longer as expected and was not so straightforward. Anyway new v0.2.0 release is out and supports node.js(Aksem/libavoid-js#5). I would be happy to receive a feedback in libavoid-js repository if you try it.

In case of new issues, please report them in https://github.com/Aksem/libavoid-js repo.

@Aksem How do I use libavoid-js from node? Am I correct that I have to adjust generate.py and hard-code ENVIRONMENT="node"? Is there some way to have a universal package?

Even when I do that, when I try to await AvoidLib.load() or AvoidLib.getInstance(), it throws:

ReferenceError: self is not defined
    at t (node_modules/libavoid-js/dist/index.js:1:198)
    at Object.<anonymous> (node_modules/libavoid-js/dist/index.js:1:217526)
    at Module._compile (node:internal/modules/cjs/loader:1275:14)
    at Object.F (node_modules/@esbuild-kit/cjs-loader/dist/index.js:1:941)
    at Module.load (node:internal/modules/cjs/loader:1133:32)
    at Module._load (node:internal/modules/cjs/loader:972:12)
    at ModuleWrap.<anonymous> (node:internal/modules/esm/translators:168:29)
    at ModuleJob.run (node:internal/modules/esm/module_job:193:25)
Thrown at:
    at node_modules/libavoid-js/dist/index.js:2:312
    at node_modules/libavoid-js/dist/index.js:3:3
    at Module._compile (node:internal/modules/cjs/loader:1275:14)
    at F (node_modules/@esbuild-kit/cjs-loader/dist/index.js:1:941)
    at Module.load (node:internal/modules/cjs/loader:1133:32)
    at Module._load (node:internal/modules/cjs/loader:972:12)
    at node:internal/modules/esm/translators:168:29
    at run (node:internal/modules/esm/module_job:193:25)

If I hack package.json to use the examples/ variant, then a) the types are not the same as for release b) importing throws an exception:

asynchronously preparing wasm
run() called, but dependencies remain, so not running
node_modules/libavoid-js/examples/libavoid.js:1368
      throw ex;
      ^


TypeError: Failed to parse URL from node_modules/libavoid-js/examples/libavoid.wasm
    at Object.fetch (node:internal/deps/undici/undici:11413:11) {
  [cause]: TypeError [ERR_INVALID_URL]: Invalid URL
      at __node_internal_captureLargerStackTrace (node:internal/errors:490:5)
      at new NodeError (node:internal/errors:399:5)
      at new URL (node:internal/url:588:13)
      at new Request (node:internal/deps/undici/undici:7002:25)
      at fetch2 (node:internal/deps/undici/undici:10554:25)
      at Object.fetch (node:internal/deps/undici/undici:11411:18)
      at fetch (node:internal/process/pre_execution:234:25)
      at instantiateAsync (node_modules/libavoid-js/examples/libavoid.js:2796:14)
      at createWasm (node_modules/libavoid-js/examples/libavoid.js:2835:3)
      at Object.<anonymous> (node_modules/libavoid-js/examples/libavoid.js:3900:11)
      at <anonymous> (path-layout.ts:4:30)
      at ModuleJob.run (node:internal/modules/esm/module_job:193:25) {
    input: 'node_modules/libavoid-js/examples/libavoid.wasm',
    code: 'ERR_INVALID_URL'
  }
}
Thrown at:
    at fetch (node:internal/deps/undici/undici:11413:11)

planger mentioned this issue Apr 28, 2022

ELK: moving a node and recalculating the edge bends eclipse-sprotty/sprotty#286

Closed

spoenemann mentioned this issue Jan 26, 2023

Now that elk supports libavoid, will libavoid find its way into elkjs? kieler/elkjs#210

Open

Aksem mentioned this issue Apr 14, 2023

Node.js support Aksem/libavoid-js#5

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Suggestion: WebAssembly build of libavoid? #44

Suggestion: WebAssembly build of libavoid? #44

planger commented Feb 11, 2021

jtiai commented Feb 17, 2021 via email

planger commented Feb 18, 2021

jtiai commented Feb 18, 2021 via email

planger commented Feb 19, 2021

koahmad commented Sep 21, 2021

planger commented Sep 22, 2021

clemmy commented Apr 21, 2022

Aksem commented Apr 21, 2022

clemmy commented Apr 22, 2022

Aksem commented Apr 22, 2022

vlovich commented Apr 7, 2023 •

edited

Loading

Aksem commented Apr 7, 2023

Aksem commented Apr 19, 2023

Suggestion: WebAssembly build of libavoid? #44

Suggestion: WebAssembly build of libavoid? #44

Comments

planger commented Feb 11, 2021

jtiai commented Feb 17, 2021 via email

planger commented Feb 18, 2021

jtiai commented Feb 18, 2021 via email

planger commented Feb 19, 2021

koahmad commented Sep 21, 2021

planger commented Sep 22, 2021

clemmy commented Apr 21, 2022

Aksem commented Apr 21, 2022

clemmy commented Apr 22, 2022

Aksem commented Apr 22, 2022

vlovich commented Apr 7, 2023 • edited Loading

Aksem commented Apr 7, 2023

Aksem commented Apr 19, 2023

vlovich commented Apr 7, 2023 •

edited

Loading