Add D2 layout engine option (#1570)

* Support ELK layout engine * Add smoke test for D2 layout option * Add D2 layout option to documentation * Check for null 'layout' argument
yuzutech · Aug 11, 2023 · 5adac1c · 5adac1c
1 parent 22558e0
commit 5adac1c
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 4 deletions.
diff --git a/ci/tests/smoke.js b/ci/tests/smoke.js
@@ -39,6 +39,7 @@ const tests = [
   { engine: 'diagramsnet', file: 'diagramsnet-venn.xml', options: {}, outputFormat: ['svg', 'png'] },
   { engine: 'diagramsnet', file: 'diagramsnet-infography.xml', options: { id: 'foo' }, outputFormat: ['svg', 'png'] },
   { engine: 'd2', file: 'connections.d2', options: {}, outputFormat: ['svg'] },
+  { engine: 'd2', file: 'connections.d2', options: { layout: 'elk' }, outputFormat: ['svg'] },
   { engine: 'd2', file: 'connections.d2', options: { sketch: 'true' }, outputFormat: ['svg'] },
   { engine: 'wireviz', file: 'wireviz.yaml', options: {}, outputFormat: ['svg', 'png'] },
   { engine: 'tikz', file: 'periodic-table.tex', options: {}, outputFormat: ['jpeg', 'pdf', 'png', 'svg'] }

diff --git a/docs/modules/setup/pages/diagram-options.adoc b/docs/modules/setup/pages/diagram-options.adoc
@@ -64,6 +64,12 @@ With flag set, option takes effect.
 
 |See: https://d2lang.com/tour/themes/
 
+|layout
+|
+* `dagre` (default)
+* `elk`
+|Use an alternate layout engine: https://d2lang.com/tour/layouts/
+
 |sketch
 |_flag_ +
 empty string ("")

diff --git a/server/src/main/java/io/kroki/server/service/D2.java b/server/src/main/java/io/kroki/server/service/D2.java
@@ -89,21 +89,26 @@ public void convert(String sourceDecoded, String serviceName, FileFormat fileFor
   private byte[] d2(byte[] source, JsonObject options) throws IOException, InterruptedException, IllegalStateException {
     List<String> commands = new ArrayList<>();
     commands.add(binPath);
-    String value = options.getString("theme");
-    if (value != null) {
+    String theme = options.getString("theme");
+    if (theme != null) {
       int themeId = 0;
-      Integer builtinThemeId = builtinThemes.get(value.toLowerCase().replaceAll("\\s", "-"));
+      Integer builtinThemeId = builtinThemes.get(theme.toLowerCase().replaceAll("\\s", "-"));
       if (builtinThemeId != null) {
         themeId = builtinThemeId;
       } else {
         try {
-          themeId = Integer.parseInt(value, 10);
+          themeId = Integer.parseInt(theme, 10);
         } catch (NumberFormatException e) {
           // ignore, fallback to 0
         }
       }
       commands.add("--theme=" + themeId);
     }
+    String layout = options.getString("layout");
+    if (layout != null && layout.equals("elk")) {
+      // Only pass the layout argument if the ELK layout engine is requested (default is 'dagre')
+      commands.add("--layout=" + layout);
+    }
     String sketch = options.getString("sketch");
     if (sketch != null) {
       commands.add("--sketch");