Merge pull request #241 from bytecodealliance/ydnar/issue240

wit/bindgen: correctly handle cyclical type dependencies

Author: ydnar

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+### Fixed
+
+- [#240](https://github.com/bytecodealliance/go-modules/issues/240): correctly handle cyclical data structures when generating variant lowering code.
+
 ## [v0.4.0] — 2024-11-05
 
 This module has been renamed. Going forward, please use `go.bytecodealliance.org` instead of `github.com/bytecodealliance/wasm-tools-go`.

testdata/issues/issue240.wit

@@ -0,0 +1,17 @@
+package issues:issue240;
+
+interface i {
+	// v refers to r
+	variant v {
+		one(r),
+	}
+
+	// r refers to v
+	resource r {
+		f: func(param: v);
+	}
+}
+
+world w {
+    import i;
+}

testdata/issues/issue240.wit.json

@@ -0,0 +1,105 @@
+{
+  "worlds": [
+    {
+      "name": "w",
+      "imports": {
+        "interface-0": {
+          "interface": {
+            "id": 0
+          }
+        }
+      },
+      "exports": {},
+      "package": 0
+    }
+  ],
+  "interfaces": [
+    {
+      "name": "i",
+      "types": {
+        "r": 0,
+        "v": 2
+      },
+      "functions": {
+        "[method]r.f": {
+          "name": "[method]r.f",
+          "kind": {
+            "method": 0
+          },
+          "params": [
+            {
+              "name": "self",
+              "type": 3
+            },
+            {
+              "name": "param",
+              "type": 2
+            }
+          ],
+          "results": []
+        }
+      },
+      "package": 0
+    }
+  ],
+  "types": [
+    {
+      "name": "r",
+      "kind": "resource",
+      "owner": {
+        "interface": 0
+      },
+      "docs": {
+        "contents": "r refers to v"
+      }
+    },
+    {
+      "name": null,
+      "kind": {
+        "handle": {
+          "own": 0
+        }
+      },
+      "owner": null
+    },
+    {
+      "name": "v",
+      "kind": {
+        "variant": {
+          "cases": [
+            {
+              "name": "one",
+              "type": 1
+            }
+          ]
+        }
+      },
+      "owner": {
+        "interface": 0
+      },
+      "docs": {
+        "contents": "v refers to r"
+      }
+    },
+    {
+      "name": null,
+      "kind": {
+        "handle": {
+          "borrow": 0
+        }
+      },
+      "owner": null
+    }
+  ],
+  "packages": [
+    {
+      "name": "issues:issue240",
+      "interfaces": {
+        "i": 0
+      },
+      "worlds": {
+        "w": 0
+      }
+    }
+  ]
+}

testdata/issues/issue240.wit.json.golden.wit

@@ -0,0 +1,15 @@
+package issues:issue240;
+
+interface i {
+	/// r refers to v
+	resource r {
+		f: func(param: v);
+	}
+
+	/// v refers to r
+	variant v { one(r) }
+}
+
+world w {
+	import i;
+}

testdata/issues/issue242.wit

@@ -0,0 +1,15 @@
+package issues:issue242;
+
+interface i {
+	variant v {
+		a,
+		b,
+		// tag might collide with (cm.Variant).Tag() method
+		tag,
+		%string(string),
+	}
+}
+
+world w {
+	import i;
+}

testdata/issues/issue242.wit.json

@@ -0,0 +1,70 @@
+{
+  "worlds": [
+    {
+      "name": "w",
+      "imports": {
+        "interface-0": {
+          "interface": {
+            "id": 0
+          }
+        }
+      },
+      "exports": {},
+      "package": 0
+    }
+  ],
+  "interfaces": [
+    {
+      "name": "i",
+      "types": {
+        "v": 0
+      },
+      "functions": {},
+      "package": 0
+    }
+  ],
+  "types": [
+    {
+      "name": "v",
+      "kind": {
+        "variant": {
+          "cases": [
+            {
+              "name": "a",
+              "type": null
+            },
+            {
+              "name": "b",
+              "type": null
+            },
+            {
+              "name": "tag",
+              "type": null,
+              "docs": {
+                "contents": "tag might collide with (cm.Variant).Tag() method"
+              }
+            },
+            {
+              "name": "string",
+              "type": "string"
+            }
+          ]
+        }
+      },
+      "owner": {
+        "interface": 0
+      }
+    }
+  ],
+  "packages": [
+    {
+      "name": "issues:issue242",
+      "interfaces": {
+        "i": 0
+      },
+      "worlds": {
+        "w": 0
+      }
+    }
+  ]
+}

testdata/issues/issue242.wit.json.golden.wit

@@ -0,0 +1,15 @@
+package issues:issue242;
+
+interface i {
+	variant v {
+		a,
+		b,
+		/// tag might collide with (cm.Variant).Tag() method
+		tag,
+		%string(string),
+	}
+}
+
+world w {
+	import i;
+}