ZLS build break with Zig 0.16.0-dev.3203+edfc4727e due to ArrayHashMap/ObjectMap API changes

[1337est]

Zig Version

0.16.0-dev.3203+edfc4727e

ZLS Version

0.15.1

Client / Code Editor / Extensions

nvim v0.12.1

Steps to Reproduce and Observed Behavior

1. Clone latest zig version from coderberg and build from source to include building LLVM via the zig instructions. This is my build process for zig in pseudo-code:

# LLVM section
git clone --depth 1 --branch release/21.x
cmake ../llvm \
      -DCMAKE_INSTALL_PREFIX="$LLVM_INSTALL" \
      -DCMAKE_BUILD_TYPE=Release \
      -DLLVM_ENABLE_PROJECTS="lld;clang" \
      -DLLVM_ENABLE_LIBXML2=OFF \
      -DLLVM_ENABLE_TERMINFO=OFF \
      -DLLVM_ENABLE_LIBEDIT=OFF \
      -DLLVM_ENABLE_ASSERTIONS=ON \
      -DLLVM_PARALLEL_LINK_JOBS=1 \
      -G Ninja
ninja install

# Zig section
git clone https://codeberg.org/ziglang/zig.git
cmake .. \
      -G Ninja \
      -DCMAKE_BUILD_TYPE=Release \
      -DCMAKE_INSTALL_PREFIX="$ZIG_INSTALL" \
      -DCMAKE_PREFIX_PATH="$LLVM_INSTALL"
ninja install

# zls section
git clone https://github.com/zigtools/zls.git
zig build -Doptimize=ReleaseSafe

2. Error when running zig build -Doptimize=ReleaseSafe:

build.zig:191:14: error: member function expected 3 argument(s), found 2
    b.modules.put("zls", zls_module) catch @panic("OOM");
    ~~~~~~~~~^~~~
/home/adrian/.local/opt/zig_lang/zigroot/zig-out/lib/zig/std/array_hash_map.zig:469:13: note: function declared here
        pub fn put(self: *Self, gpa: Allocator, key: K, value: V) Oom!void {
        ~~~~^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

3. Local fix by changing build.zig by simply passing the build allocator to put:

b.modules.put(b.allocator, "zls", zls_module) catch @panic("OOM");

4. Error when running zig build -Doptimize=ReleaseSafe:

src/Server.zig:602:44: error: expected 3 argument(s), found 1
        var watcher: std.json.ObjectMap = .init(arena);
                                          ~^~~~
/home/adrian/.local/opt/zig_lang/zigroot/zig-out/lib/zig/std/array_hash_map.zig:168:13: note: function declared here
        pub fn init(gpa: Allocator, key_list: []const K, value_list: []const V) Oom!Self {
        ~~~~^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

5. Local fix in src/Server.zig where I changed std.json.ObjectMap initialization from init(arena) to .empty, and passing the arena allocator to putNoClobber(...). Here is the git diff:

diff --git a/build.zig b/build.zig
index 9f0dfd6f..3f2ecb8f 100644
--- a/build.zig
+++ b/build.zig
@@ -188,7 +188,7 @@ pub fn build(b: *Build) !void {
         .build_options = build_options,
         .version_data = version_data_module,
     });
-    b.modules.put("zls", zls_module) catch @panic("OOM");
+    b.modules.put(b.allocator, "zls", zls_module) catch @panic("OOM");

     const known_folders_module = b.dependency("known_folders", .{
         .target = target,
diff --git a/src/Server.zig b/src/Server.zig
index 80e1366e..7deecdd9 100644
--- a/src/Server.zig
+++ b/src/Server.zig
@@ -599,12 +599,12 @@ fn initializedHandler(server: *Server, arena: std.mem.Allocator, notification: t

     if (server.client_capabilities.supports_workspace_did_change_watched_files) {
         // `{ "watchers": [ { "globPattern": "**/*.{zig,zon}" } ] }`
-        var watcher: std.json.ObjectMap = .init(arena);
-        try watcher.putNoClobber("globPattern", .{ .string = "**/*.{zig,zon}" });
+        var watcher: std.json.ObjectMap = .empty;
+        try watcher.putNoClobber(arena, "globPattern", .{ .string = "**/*.{zig,zon}" });
         var watchers_arr: std.json.Array = try .initCapacity(arena, 1);
         watchers_arr.appendAssumeCapacity(.{ .object = watcher });
-        var fs_watcher_obj: std.json.ObjectMap = .init(arena);
-        try fs_watcher_obj.putNoClobber("watchers", .{ .array = watchers_arr });
+        var fs_watcher_obj: std.json.ObjectMap = .empty;
+        try fs_watcher_obj.putNoClobber(arena, "watchers", .{ .array = watchers_arr });
         const json_val: std.json.Value = .{ .object = fs_watcher_obj };

         try server.registerCapability("workspace/didChangeWatchedFiles", json_val);

6. After these changes I get a successful zig build -Doptimize=ReleaseSafe. I also performed a zig build test and got this back, but don't have time to complete passing tests. Just wanted to help out in case this helps at all:

test
└─ run test 478 pass, 11 skip, 1 fail (490 total)
error: 'language_features.cimport.test.zig compile server - translate c' failed:
       /home/adrian/.local/opt/zig_lang/zigroot/zig-out/lib/zig/std/Io/Threaded.zig:2854:21: 0x12a3ef9 in batchAwaitConcurrent (std.zig)
                           return error.Timeout;
                           ^
       /home/adrian/.local/opt/zig_lang/zigroot/zig-out/lib/zig/std/Io.zig:592:9: 0x1242936 in awaitConcurrent (std.zig)
               return io.vtable.batchAwaitConcurrent(io.userdata, batch, timeout);
               ^
       /home/adrian/.local/opt/zig_lang/zigroot/zig-out/lib/zig/std/Io/File/MultiReader.zig:207:5: 0x14cb999 in fill (std.zig)
           try mr.batch.awaitConcurrent(io, timeout);
           ^
       /home/adrian/.local/opt/zig_lang/zls/src/translate_c.zig:226:29: 0x14b73ff in translate (zls.zig)
                       else => |e| return e,
                                   ^
       /home/adrian/.local/opt/zig_lang/zls/tests/language_features/cimport.zig:113:19: 0x14bcceb in testTranslate (tests.zig)
           var result = (try translate_c.translate(
                         ^
       /home/adrian/.local/opt/zig_lang/zls/tests/language_features/cimport.zig:15:19: 0x14bd5fc in test.zig compile server - translate c (tests.zig)
           var result1 = try testTranslate(
                         ^
failed command: ./.zig-cache/o/869bf9e6bfa49e520a292290b6586bef/test --cache-dir=./.zig-cache --seed=0x50c42aa0 --listen=-

Build Summary: 55/57 steps succeeded (1 failed); 572/584 tests passed (11 skipped, 1 failed)
test transitive failure
└─ run test 478 pass, 11 skip, 1 fail (490 total)

error: the following build command failed with exit code 1:
.zig-cache/o/3f6978e8efc89eeaffc6f973171332e4/build /home/adrian/.local/opt/zig_lang/zigroot/zig-out/bin/zig /home/adrian/.local/opt/zig_lang/zigroot/zig-out/lib/zig /home/adrian/.local/opt/zig_lang/zls .zig-cache /home/adrian/.cache/zig --seed 0x50c42aa0 -Z964a2bdc5447ccd7 test

Expected Behavior

It should build with the latest nightly build of zig.

Attach ZLS log output

No response

[nikitalocalhost]

Same fixes worked for me. Master for zls, zig-x86_64-linux-0.16.0-dev.3153+d6f43caad. Build and zig build test are successful

[Jr-14]

Same fixes worked for me. Master for zls, zig-x86_64-linux-0.16.0-dev.3153+d6f43caad. Build and zig build test are successful

+1 Thanks for the breakdown @1337est and diff of the fix. Works for me with the same versions ^^^

[sonictim]

Same Issue and solves.. Thank you!

[1337est]

After upgrading to the latest Zig dev build following the 0.16.0 release, I started seeing this warning:

LSP[zls] ZLS '0.16.0-dev.301+84918097' requires at least Zig '0.16.0-dev.2736+3b515fbed' but got Zig '0.17.0-dev.9+046002d1a'.
Update Zig to avoid unexpected behavior.

The cause of this is in src/Server.zig within this check:

    check: {
        if (server.status != .initialized) break :check;

        switch (server.config_manager.build_runner_supported) {
            .yes, .no_dont_error => break :check,
            .no => {},
        }

        const zig_version = server.config_manager.zig_exe.?.version;
        const zls_version = build_options.version;

        const zig_version_is_tagged = zig_version.pre == null;
        const zls_version_is_tagged = zls_version.pre == null;

        if (zig_version_is_tagged) {
            server.showMessage(
                .Warning,
                "ZLS '{f}' does not support Zig '{f}'. A ZLS '{}.{}' release should be used instead.",
                .{ zls_version, zig_version, zig_version.major, zig_version.minor },
            );
        } else if (zls_version_is_tagged) {
            server.showMessage(
                .Warning,
                "ZLS '{f}' should be used with a Zig '{}.{}' release but found Zig '{f}'.",
                .{ zls_version, zls_version.major, zls_version.minor, zig_version },
            );
        } else {
            server.showMessage(
                .Warning,
                "ZLS '{f}' requires at least Zig '{s}' but got Zig '{f}'. Update Zig to avoid unexpected behavior.",
                .{ zls_version, build_options.minimum_runtime_zig_version_string, zig_version },
            );
        }
    }

My minimal understanding is that this warning is too strict for newer dev builds. Once zig moves to a newer dev cycle, such as 0.17.0-dev.*, this check is insufficient, and another check may be needed to see if the zls version is out of date as well.

A possible solution would be to make this check smarter, or to add another check so that potentially there's a different "toggleable" warning in build.zig and/or Server.zig. It could look something like: if zig_version.major > zls_version.major. This would allow keeping the hard-coded version string in build.zig as well.

A longer-term approach could be getting the resolved zig_version throughthe output of zig env or zig version commands, which I think may already being done later in the pipeline anyways, which is then stored through configuration.zig?

As a local workaround, I updated the version line to match my current Zig dev build. This is not intended as a proper upstream fix, but wanted to post to let anyone else do a local fix while proper fixes are underway. This suppresses the warning and everything is working correctly for me in Neovim after recompiling with these changes:

diff --git a/build.zig b/build.zig
index 3f2ecb8f..f76b8494 100644
--- a/build.zig
+++ b/build.zig
@@ -9,7 +9,7 @@ const minimum_build_zig_version = @import("build.zig.zon").minimum_zig_version;
 /// std.Io: move netReceive to become an Operation
 ///
 /// A breaking change to the Zig Build System should be handled by updating ZLS's build runner (see src\build_runner)
-const minimum_runtime_zig_version = "0.16.0-dev.2736+3b515fbed";
+const minimum_runtime_zig_version = "0.17.0-dev.9+046002d1a";

 const release_targets = [_]std.Target.Query{
     .{ .cpu_arch = .aarch64, .os_tag = .linux },
diff --git a/build.zig.zon b/build.zig.zon
index ab4ada33..30205ed1 100644
--- a/build.zig.zon
+++ b/build.zig.zon
@@ -1,7 +1,7 @@
 .{
     .name = .zls,
     // Remove `-dev` when tagging a new ZLS release and add it back on the next development cycle.
-    .version = "0.16.0-dev",
+    .version = "0.17.0-dev",
     // Specifies the minimum Zig version that is required to compile and test ZLS.
     // Must be a Zig version that is downloadable from https://ziglang.org/download/ or a mirror.
     //
@@ -10,7 +10,7 @@
     // nix flake update --commit-lock-file
     // ```
     // If you do not use Nix, a ZLS maintainer can take care of this.
-    .minimum_zig_version = "0.16.0-dev.3133+5ec8e45f3",
+    .minimum_zig_version = "0.17.0-dev.9+046002d1a",
     // Must be kept in sync with the `deps.nix` for the Nix flake.
     // If you do not use Nix, a ZLS maintainer can take care of this.
     .dependencies = .{