Store errors on FileNotFound on import (master)

[ppvolto]

I currently work with neurocyte/libvaxis repo in the awebo branch, it depends on jacobsandlund/uucode branch zig-0.16 it has in src/build files that are not imported. But there import a non existing file, with that zls can not provide the resolution of symbols for libvaxis.

[ppvolto]

A hack that i found is in DocumentStore.zig line 1525 catch the FileNotFound error and break with a empty string.

[Techatrix]

There is too little information provided to investigate this issue. Please provide the following:

• ZLS version
• Zig version
• ZLS logs
• precise steps to reproduce (link to source code, individual steps, etc.)

[ppvolto]

ZLS (0.16.0-dev.180+95f4b1a6) compiled with ZIG (0.16.0-dev.2255+d417441f4).

Step 1: setup

zig init
zig fetch --save git+https://github.com/neurocyte/libvaxis#awebo

Step 2: add to build.zig

    const vaxis_dep = b.dependency("vaxis", .{
        .target = target,
        .optimize = optimize,
    });
    exe.root_module.addImport("vaxis", vaxis_dep.module("vaxis"));

Step 3: add to src/main.zig

const vaxis = @import("vaxis");

Open the file in a editor:

Logs:

info  ( main ): Starting ZLS      0.16.0-dev.180+95f4b1a6 @ '/home/ppvolto/.local/bin/zls'
info  ( main ): Log File:         /home/ppvolto/.cache/zls/zls.log (debug)
info  (server): Client Info:      Visual Studio Code (1.108.2)
debug (server): Offset Encoding:  'utf-16'
info  (server): added Workspace Folder: file:///home/ppvolto/dev/internal/test
debug (server): Dynamically registering method 'workspace/didChangeConfiguration'
debug (server): Dynamically registering method 'workspace/didChangeWatchedFiles'
info  (store ): Loaded build file 'file:///home/ppvolto/dev/internal/test/build.zig'
info  (server): Set config option 'semantic_tokens' to "partial"
info  (server): Set config option 'builtin_path' to "/home/ppvolto/.cache/zls/builtin.zig"
info  (server): Set config option 'zig_lib_path' to "/home/ppvolto/.cache/zig/p/N-V-__8AANiuSxXAgQGsPUa6P2t3QY1SWI8B3cOKDnE8syza/lib"
info  (server): Set config option 'zig_exe_path' to "/home/ppvolto/.local/bin/zig"
info  (server): Set config option 'build_runner_path' to "/home/ppvolto/.cache/zls/build_runner/b76c862319d25672f0fd5febd47dad71/build_runner.zig"
info  (server): Set config option 'global_cache_path' to "/home/ppvolto/.cache/zls"
info  (server): trying to start Build-On-Save for 'file:///home/ppvolto/dev/internal/test'
debug ( diag ): zig build runner process has exited
warn  ( diag ): zig build runner exited with non-zero status: 255
stderr:
no build.zig to pull a zig version from, you can:
  1. run 'zig VERSION' to specify a version
  2. run from a directory where a build.zig can be found

debug ( diag ): zig build runner process has exited
debug ( diag ): zig build runner process has exited
error (store ): failed to read document 'file:///home/ppvolto/.cache/zig/p/uucode-0.1.0-ZZjBPphWUABH_ChjdEku1Vplc1Y107C0GvgGJk8HrX8Z/src/build/types.zig': error.FileNotFound
error (store ): failed to read document 'file:///home/ppvolto/.cache/zig/p/uucode-0.1.0-ZZjBPphWUABH_ChjdEku1Vplc1Y107C0GvgGJk8HrX8Z/src/build/types.zig': error.FileNotFound
error (store ): failed to read document 'file:///home/ppvolto/.cache/zig/p/uucode-0.1.0-ZZjBPphWUABH_ChjdEku1Vplc1Y107C0GvgGJk8HrX8Z/src/build/types.zig': error.FileNotFound
error (store ): failed to read document 'file:///home/ppvolto/.cache/zig/p/uucode-0.1.0-ZZjBPphWUABH_ChjdEku1Vplc1Y107C0GvgGJk8HrX8Z/src/build/types.zig': error.FileNotFound
error (store ): failed to read document 'file:///home/ppvolto/.cache/zig/p/uucode-0.1.0-ZZjBPphWUABH_ChjdEku1Vplc1Y107C0GvgGJk8HrX8Z/src/build/types.zig': error.FileNotFound
error (store ): failed to read document 'file:///home/ppvolto/.cache/zig/p/uucode-0.1.0-ZZjBPphWUABH_ChjdEku1Vplc1Y107C0GvgGJk8HrX8Z/src/build/types.zig': error.FileNotFound
error (store ): failed to read document 'file:///home/ppvolto/.cache/zig/p/uucode-0.1.0-ZZjBPphWUABH_ChjdEku1Vplc1Y107C0GvgGJk8HrX8Z/src/build/types.zig': error.FileNotFound
error (store ): failed to read document 'file:///home/ppvolto/.cache/zig/p/uucode-0.1.0-ZZjBPphWUABH_ChjdEku1Vplc1Y107C0GvgGJk8HrX8Z/src/build/types.zig': error.FileNotFound
error (store ): failed to read document 'file:///home/ppvolto/.cache/zig/p/uucode-0.1.0-ZZjBPphWUABH_ChjdEku1Vplc1Y107C0GvgGJk8HrX8Z/src/build/types.zig': error.FileNotFound
error (store ): failed to read document 'file:///home/ppvolto/.cache/zig/p/uucode-0.1.0-ZZjBPphWUABH_ChjdEku1Vplc1Y107C0GvgGJk8HrX8Z/src/build/types.zig': error.FileNotFound
error (store ): failed to read document 'file:///home/ppvolto/.cache/zig/p/uucode-0.1.0-ZZjBPphWUABH_ChjdEku1Vplc1Y107C0GvgGJk8HrX8Z/src/build/types.zig': error.FileNotFound
error (store ): failed to read document 'file:///home/ppvolto/.cache/zig/p/uucode-0.1.0-ZZjBPphWUABH_ChjdEku1Vplc1Y107C0GvgGJk8HrX8Z/src/build/types.zig': error.FileNotFound
error (store ): failed to read document 'file:///home/ppvolto/.cache/zig/p/uucode-0.1.0-ZZjBPphWUABH_ChjdEku1Vplc1Y107C0GvgGJk8HrX8Z/src/build/types.zig': error.FileNotFound
error (store ): failed to read document 'file:///home/ppvolto/.cache/zig/p/uucode-0.1.0-ZZjBPphWUABH_ChjdEku1Vplc1Y107C0GvgGJk8HrX8Z/src/build/types.zig': error.FileNotFound
error (store ): failed to read document 'file:///home/ppvolto/.cache/zig/p/uucode-0.1.0-ZZjBPphWUABH_ChjdEku1Vplc1Y107C0GvgGJk8HrX8Z/src/build/types.zig': error.FileNotFound
error (store ): failed to read document 'file:///home/ppvolto/.cache/zig/p/uucode-0.1.0-ZZjBPphWUABH_ChjdEku1Vplc1Y107C0GvgGJk8HrX8Z/src/build/types.zig': error.FileNotFound

My Hack from:

    const text: [:0]const u8 = switch (file_source) {
        .text => |text| text,
        .uri => try store.readFile(uri),
    };

to

    const text: [:0]const u8 = switch (file_source) {
        .text => |text| text,
        .uri => blk: {
            const content = store.readFile(uri) catch |err| switch (err) {
                error.FileNotFound => break :blk "",
                else => |e| {
                    if (err != error.Canceled) log.err("failed to read document '{s}': {}", .{ uri.raw, err });
                    handle_future.err = e;
                    return &handle_future.handle;
                },
            };
            break :blk content;
        },
    };

[Techatrix]

#2591 should prevent the "failed to read document" log message from appearing on missing files. I wasn't able to reproduce those error messages about the build runner but #2590 may have resolve those.

Can you confirm whether this has fixed your issue?