Merge pull request #286 from tpgillam/tg/manifest_path_fix

Correctly compute project SHA when Manifest contains paths starting with `../`

Author: pfitzseb

.gitignore

@@ -2,5 +2,5 @@
 *.jl.*.cov
 *.jl.mem
 .vscode
-./Manifest.toml
+/Manifest.toml
 registryindexcache

Project.toml

@@ -1,6 +1,6 @@
 name = "SymbolServer"
 uuid = "cf896787-08d5-524d-9de7-132aaa0cb996"
-version = "7.3.0"
+version = "7.3.1"
 
 [deps]
 InteractiveUtils = "b77e0a4c-d291-57a0-90e8-8db25a27a240"

src/server.jl

@@ -55,7 +55,12 @@ server = Server(store_path, ctx, Dict{UUID,Package}())
 written_caches = String[] # List of caches that have already been written
 toplevel_pkgs = deps(project(ctx)) # First get a list of all package UUIds that we want to cache
 packages_to_load = []
-# Next make sure the cache is up-to-date for all of these
+
+# Obtain the directory containing the active Manifest.toml. Any 'develop'ed dependencies
+# will contain a path that is relative to this directory.
+manifest_dir = dirname(ctx.env.manifest_file)
+
+# Next make sure the cache is up-to-date for all of these.
 for (pk_name, uuid) in toplevel_pkgs
     uuid isa UUID || (uuid = UUID(uuid))
     if !isinmanifest(ctx, uuid)
@@ -71,7 +76,7 @@ for (pk_name, uuid) in toplevel_pkgs
                 cached_version = open(cache_path) do io
                     CacheStore.read(io)
                 end
-                if sha_pkg(frommanifest(manifest(ctx), uuid)) != cached_version.sha
+                if sha_pkg(manifest_dir, frommanifest(manifest(ctx), uuid)) != cached_version.sha
                     @info "Outdated sha, will recache package $pk_name ($uuid)"
                     push!(packages_to_load, uuid)
                 else
@@ -118,7 +123,7 @@ for (pkg_name, cache) in env_symbols
     !isinmanifest(ctx, String(pkg_name)) && continue
     uuid = packageuuid(ctx, String(pkg_name))
     pe = frommanifest(ctx, uuid)
-    server.depot[uuid] = Package(String(pkg_name), cache, uuid, sha_pkg(pe))
+    server.depot[uuid] = Package(String(pkg_name), cache, uuid, sha_pkg(manifest_dir, pe))
 end
 
 write_depot(server, server.context, written_caches)

src/utils.jl

@@ -189,8 +189,11 @@ function sha2_256_dir(path, sha=zeros(UInt8, 32))
     return sha
 end
 
-function sha_pkg(pe::PackageEntry)
-    path(pe) isa String && isdir(path(pe)) && isdir(joinpath(path(pe), "src")) ? sha2_256_dir(joinpath(path(pe), "src")) : nothing
+function sha_pkg(manifest_dir::AbstractString, pe::PackageEntry)
+    relpath = path(pe)
+    isa(relpath, String) || return nothing
+    src_path = normpath(joinpath(manifest_dir, relpath, "src"))
+    return isdir(src_path) ? sha2_256_dir(src_path) : nothing
 end
 
 function _doc(binding::Base.Docs.Binding)

test/runtests.jl

@@ -1,6 +1,6 @@
 using SymbolServer, Pkg
 using SymbolServer: packagename, packageuuid, deps, manifest, project, version, Package, frommanifest, VarRef, _lookup
-using Base:UUID
+using Base: UUID
 using Test
 
 allns = SymbolServer.getallns()
@@ -141,6 +141,47 @@ end
         @test length(readdir(store_path)) == 0
     end
 
+    if VERSION >= v"1.6"
+        # The test-case uses a Manifest format that is incompatible with older versions of
+        # Julia.
+        @testset "issues/285" begin
+            mktempdir() do path
+                cp(joinpath(@__DIR__, "testenv2"), path; force=true)
+
+                project_path = joinpath(path, "proj")
+
+                store_path = joinpath(path, "store")
+                mkpath(store_path)
+
+                jl_cmd = joinpath(Sys.BINDIR, Base.julia_exename())
+                withenv("JULIA_PKG_PRECOMPILE_AUTO" => 0) do
+                    run(`$jl_cmd --project=$project_path --startup-file=no -e 'using Pkg; Pkg.instantiate()'`)
+                end
+
+                ssi = SymbolServerInstance("", store_path)
+                ret_status, store = getstore(ssi, project_path; download=false)
+                @test ret_status == :success
+                @test length(store) == 4
+                @test haskey(store, :Core)
+                @test haskey(store, :Base)
+                @test haskey(store, :Main)
+                @test haskey(store, :A)
+
+                # Inspect the cached version, and check that the package SHA has been computed
+                # correctly.
+                cache_path = joinpath(store_path, "A", "A_94f385dd-073b-49fe-b7ed-f824d09b3331", "v0.1.0_nothing.jstore")
+                @test isfile(cache_path)
+
+                cached_version = open(SymbolServer.CacheStore.read, cache_path)
+                @test !isnothing(cached_version.sha)
+                @test cached_version.sha == SymbolServer.sha2_256_dir(joinpath(path, "A", "src"))
+
+                SymbolServer.clear_disc_store(ssi)
+                @test length(readdir(store_path)) == 0
+            end
+        end
+    end
+
     @test SymbolServer.stdlibs[:Base][:Sort][:sort] isa SymbolServer.FunctionStore
 
     @testset "symbol documentation" begin
@@ -158,7 +199,7 @@ end
 
     if VERSION >= v"1.1-"
         @testset "Excluding private packages from cache download requests" begin
-            pkgs = Dict{Base.UUID, Pkg.Types.PackageEntry}()
+            pkgs = Dict{Base.UUID,Pkg.Types.PackageEntry}()
             if VERSION < v"1.3-"
                 pkgs[UUID("7876af07-990d-54b4-ab0e-23690620f79a")] = Pkg.Types.PackageEntry(name="Example", other=Dict("git-tree-sha1" => Base.SHA1("0"^40)))
                 pkgs[UUID("3e13f8c9-a9aa-412e-8b2a-fda000b375e2")] = Pkg.Types.PackageEntry(name="NotInGeneral", other=Dict("git-tree-sha1" => Base.SHA1("0"^40)))
@@ -188,7 +229,7 @@ end
 using SymbolServer: FakeTypeName
 
 @testset "TypeofVararg" begin
-    Ts = Any[Vararg, Vararg{Bool,3}, NTuple{N,Any} where N]
+    Ts = Any[Vararg, Vararg{Bool,3}, NTuple{N,Any} where {N}]
     isdefined(Core, :TypeofVararg) && append!(Ts, Any[Vararg{Int}, Vararg{Rational}])
 
     for ((i, T1), (j, T2)) in Iterators.product(enumerate.((Ts, Ts))...)
@@ -212,23 +253,26 @@ import UUIDs
     else
         tmp_access = try
             n = "/tmp/" * string(UUIDs.uuid4())
-            touch(n); rm(n)
+            touch(n)
+            rm(n)
             true
         catch
             false
         end
         too_long = joinpath(tempdir(), string(UUIDs.uuid4())^3)
         mkdir(too_long)
-        for TEMPDIR in (tempdir(), too_long); withenv("TEMPDIR" => TEMPDIR) do
-            p = SymbolServer.pipe_name()
-            #         TEMPDIR    + / + prefix                  + UUID[1:13]
-            if length(tempdir()) + 1 + length("vscjlsymserv-") + 13 < 92 || !tmp_access
-                @test startswith(p, tempdir())
-                @test occursin(r"^vscjlsymserv-\w{8}-\w{4}$", basename(p))
-            else
-                @test occursin(r"^/tmp/vscjlsymserv-\w{8}(?:-\w{4}){3}-\w{12}$", p)
+        for TEMPDIR in (tempdir(), too_long)
+            withenv("TEMPDIR" => TEMPDIR) do
+                p = SymbolServer.pipe_name()
+                #         TEMPDIR    + / + prefix                  + UUID[1:13]
+                if length(tempdir()) + 1 + length("vscjlsymserv-") + 13 < 92 || !tmp_access
+                    @test startswith(p, tempdir())
+                    @test occursin(r"^vscjlsymserv-\w{8}-\w{4}$", basename(p))
+                else
+                    @test occursin(r"^/tmp/vscjlsymserv-\w{8}(?:-\w{4}){3}-\w{12}$", p)
+                end
             end
-        end end
+        end
         rm(too_long; recursive=true)
     end
 end

test/testenv2/A/Project.toml

@@ -0,0 +1,4 @@
+name = "A"
+uuid = "94f385dd-073b-49fe-b7ed-f824d09b3331"
+authors = ["Tom Gillam <[email protected]>"]
+version = "0.1.0"

test/testenv2/A/src/A.jl

@@ -0,0 +1,5 @@
+module A
+
+moo() = 42
+
+end # module A

test/testenv2/proj/Manifest.toml

@@ -0,0 +1,10 @@
+# This file is machine-generated - editing it directly is not advised
+
+julia_version = "1.10.1"
+manifest_format = "2.0"
+project_hash = "c82015c2e523eeff7aaad9dc94d1d3baa11cc7bd"
+
+[[deps.A]]
+path = "../A"
+uuid = "94f385dd-073b-49fe-b7ed-f824d09b3331"
+version = "0.1.0"

test/testenv2/proj/Project.toml

@@ -0,0 +1,2 @@
+[deps]
+A = "94f385dd-073b-49fe-b7ed-f824d09b3331"