fix: don't panic on certain optional types (#224)

Author: a-frantz

wdl-format/CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+## 0.2.1 - 10-16-2024
+
+### Fixed
+
+* Don't panic on certain optional types ([#224](https://github.com/stjude-rust-labs/wdl/pull/224))
+
 ## 0.2.0 - 10-16-2024
 
 ### Added

wdl-format/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "wdl-format"
-version = "0.2.0"
+version = "0.2.1"
 description = "Formatting of WDL (Workflow Description Language) documents"
 license.workspace = true
 edition.workspace = true

wdl-format/src/v1/decl.rs

@@ -33,11 +33,9 @@ pub fn format_map_type(element: &FormatElement, stream: &mut TokenStream<PreToke
 
 /// Formats an [`ObjectType`](wdl_ast::v1::ObjectType).
 pub fn format_object_type(element: &FormatElement, stream: &mut TokenStream<PreToken>) {
-    let mut children = element.children().expect("object type children");
-    let object_keyword = children.next().expect("object type object keyword");
-    assert!(object_keyword.element().kind() == SyntaxKind::ObjectTypeKeyword);
-    (&object_keyword).write(stream);
-    assert!(children.next().is_none());
+    for child in element.children().expect("object type children") {
+        (&child).write(stream);
+    }
 }
 
 /// Formats a [`PairType`](wdl_ast::v1::PairType).
@@ -52,10 +50,9 @@ pub fn format_pair_type(element: &FormatElement, stream: &mut TokenStream<PreTok
 
 /// Formats a [`TypeRef`](wdl_ast::v1::TypeRef).
 pub fn format_type_ref(element: &FormatElement, stream: &mut TokenStream<PreToken>) {
-    let mut children = element.children().expect("type ref children");
-    let t = children.next().expect("type ref type");
-    (&t).write(stream);
-    assert!(children.next().is_none());
+    for child in element.children().expect("type ref children") {
+        (&child).write(stream);
+    }
 }
 
 /// Formats an [`UnboundDecl`](wdl_ast::v1::UnboundDecl).

wdl-format/tests/format/optional_structs/source.formatted.wdl

@@ -0,0 +1,23 @@
+version 1.1
+
+struct SpliceJunctionMotifs {
+    Int noncanonical_motifs
+    Int GT_AG_and_CT_AC_motif
+}
+
+workflow foo {
+    input {
+        SpliceJunctionMotifs? foo
+    }
+
+    SpliceJunctionMotifs declared = SpliceJunctionMotifs {
+        noncanonical_motifs: 1,
+        GT_AG_and_CT_AC_motif: 2,
+    }
+    SpliceJunctionMotifs? optional = None
+    Object? deprecated = None
+
+    output {
+        SpliceJunctionMotifs? bar = declared
+    }
+}

wdl-format/tests/format/optional_structs/source.wdl

@@ -0,0 +1,19 @@
+version 1.1
+struct SpliceJunctionMotifs {
+    Int noncanonical_motifs
+    Int GT_AG_and_CT_AC_motif
+}
+workflow foo {
+    SpliceJunctionMotifs declared = SpliceJunctionMotifs {
+        noncanonical_motifs: 1,
+        GT_AG_and_CT_AC_motif: 2
+    }
+    SpliceJunctionMotifs? optional = None
+    Object? deprecated = None
+    input {
+        SpliceJunctionMotifs? foo
+    }
+    output {
+        SpliceJunctionMotifs? bar = declared
+    }
+}

wdl/CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+## 0.9.1 - 10-16-2024
+
+### Fixed
+
+* Fixed a bug in `wdl-format` that panicked on certain optional types ([#224](https://github.com/stjude-rust-labs/wdl/pull/224))
+
 ## 0.9.0 - 10-16-2024
 
 ### Added

wdl/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "wdl"
-version = "0.9.0"
+version = "0.9.1"
 authors = ["Clay McLeod <clay.l.mcleod@gmail.com>"]
 rust-version.workspace = true
 license.workspace = true
@@ -17,7 +17,7 @@ wdl-ast = { path = "../wdl-ast", version = "0.8.0", optional = true }
 wdl-lint = { path = "../wdl-lint", version = "0.7.0", optional = true }
 wdl-analysis = { path = "../wdl-analysis", version = "0.4.0", optional = true }
 wdl-lsp = { path = "../wdl-lsp", version = "0.4.0", optional = true }
-wdl-format = { path = "../wdl-format", version = "0.2.0", optional = true }
+wdl-format = { path = "../wdl-format", version = "0.2.1", optional = true }
 tracing-subscriber = { workspace = true, optional = true }
 clap = { workspace = true, optional = true }
 anyhow = { workspace = true, optional = true }