Vendor the fixed get_server_dir, but compare its output to that of the upstream Pkg.PlatformEngines.get_server_dir, and print a warning if the two values differ

Author: DilumAluthge

README.md

@@ -7,7 +7,7 @@ Interactive browser-based authentication to private Julia Pkg servers.
 #### Step 1: Make sure that PkgAuthentication.jl is installed in the default global Julia package environment (`v1.x`)
 
 ```julia
-julia> delete!(ENV, "JULIA_PKG_SERVER")
+julia> delete!(ENV, "JULIA_PKG_SERVER");
 
 julia> import Pkg
 

src/PkgAuthentication.jl

@@ -99,7 +99,7 @@ function authenticate(;
 
     _assert_pkg_server_env_var_is_set()
 
-    server = get_pkg_server()::String
+    server = pkg_server()
     server = rstrip(server, '/')
     server = string(server, "/", auth_suffix)
 
@@ -347,20 +347,6 @@ end
 
 ## utils
 
-@static if Base.VERSION >= v"1.4-"
-    # Note that we add `::Union{String, Nothing}` to force conversion from `SubString` to `String`
-    get_pkg_server()::Union{String, Nothing} = Pkg.pkg_server()
-else
-    # This function does not exist in Julia 1.3
-    # Note that we add `::Union{String, Nothing}` to force conversion from `SubString` to `String`
-    function get_pkg_server()::Union{String, Nothing}
-        server = get(ENV, "JULIA_PKG_SERVER", "https://pkg.julialang.org")
-        isempty(server) && return nothing
-        startswith(server, r"\w+://") || (server = "https://$server")
-        return rstrip(server, '/')
-    end
-end
-
 is_new_auth_mechanism() =
     isdefined(Pkg, :PlatformEngines) &&
     isdefined(Pkg.PlatformEngines, :get_server_dir) &&
@@ -373,16 +359,58 @@ is_token_valid(toml) =
     (get(toml, "expires_at", nothing) isa Union{Integer, AbstractFloat} ||
      get(toml, "expires", nothing) isa Union{Integer, AbstractFloat})
 
+@static if Base.VERSION >= v"1.4-"
+    const pkg_server = Pkg.pkg_server
+else
+    # This function does not exist in Julia 1.3
+    function pkg_server()
+        server = get(ENV, "JULIA_PKG_SERVER", "https://pkg.julialang.org")
+        isempty(server) && return nothing
+        startswith(server, r"\w+://") || (server = "https://$server")
+        return rstrip(server, '/')
+    end
+end
+
+function _get_server_dir(
+        url::AbstractString,
+        server::Union{AbstractString, Nothing},
+    )
+    server === nothing && return
+    url == server || startswith(url, "$server/") || return
+    m = match(r"^\w+://([^\\/]+)(?:$|/)", server)
+    if m === nothing
+        @warn "malformed Pkg server value" server
+        return
+    end
+    isempty(Base.DEPOT_PATH) && return
+    invalid_filename_chars = [':', '/', '<', '>', '"', '/', '\\', '|', '?', '*']
+    dir = join(replace(c -> c in invalid_filename_chars ? '_' : c, collect(String(only(m.captures)))))
+    return joinpath(Pkg.depots1(), "servers", dir)
+end
+function get_server_dir(
+        url::AbstractString,
+        server::Union{AbstractString, Nothing} = pkg_server(),
+    )
+    server_dir_pkgauth = _get_server_dir(url, server)
+    server_dir_pkg = Pkg.PlatformEngines.get_server_dir(url, server)
+    if server_dir_pkgauth != server_dir_pkg
+        msg = "The PkgAuthentication server directory is not equal to the Pkg server directory." *
+              "Unexpected behavior may occur."
+        @warn msg server_dir_pkgauth server_dir_pkg
+    end
+    return server_dir_pkgauth
+end
+
 function token_path(url::AbstractString)
     @static if is_new_auth_mechanism()
-        server_dir = Pkg.PlatformEngines.get_server_dir(url)
+        server_dir = get_server_dir(url)
         if server_dir !== nothing
             return joinpath(server_dir, "auth.toml")
         end
     end
     # older auth mechanism uses a different token location
     default = joinpath(Pkg.depots1(), "token.toml")
-    get(ENV, "JULIA_PKG_TOKEN_PATH", default)
+    return get(ENV, "JULIA_PKG_TOKEN_PATH", default)
 end
 
 const OPEN_BROWSER_HOOK = Ref{Union{Base.Callable, Nothing}}(nothing)
@@ -482,7 +510,7 @@ function install(; maxcount::Integer = 3)
         throw(ArgumentError("`maxcount` must be greater than or equal to one"))
     end
     _assert_pkg_server_env_var_is_set()
-    server = get_pkg_server()
+    server = String(pkg_server())
     auth_handler = generate_auth_handler(maxcount)
     @static if PkgAuthentication.is_new_auth_mechanism()
         Pkg.PlatformEngines.register_auth_error_handler(server, auth_handler)

test/runtests.jl

@@ -6,33 +6,6 @@ import Pkg
 
 include("util.jl")
 
-@static if Base.VERSION < v"1.4-"
-    @eval Pkg function pkg_server()::Union{String, Nothing}
-        server = get(ENV, "JULIA_PKG_SERVER", "https://pkg.julialang.org")
-        isempty(server) && return nothing
-        startswith(server, r"\w+://") || (server = "https://$server")
-        return rstrip(server, '/')
-    end
-end
-@static if Base.VERSION < v"1.10-" # TODO: change this to "1.9-"
-     @eval Pkg.PlatformEngines function get_server_dir(
-        url :: AbstractString,
-        server :: Union{AbstractString, Nothing} = pkg_server(),
-    )
-        server === nothing && return
-        url == server || startswith(url, "$server/") || return
-        m = match(r"^\w+://([^\\/]+)(?:$|/)", server)
-        if m === nothing
-            @warn "malformed Pkg server value" server
-            return
-        end
-        isempty(Base.DEPOT_PATH) && return
-        invalid_filename_chars = [':', '/', '<', '>', '"', '/', '\\', '|', '?', '*']
-        dir = join(replace(c -> c in invalid_filename_chars ? '_' : c, collect(String(m.captures[1]))))
-        return joinpath(depots1(), "servers", dir)
-    end
- end
-
 @testset "PkgAuthentication" begin
     with_temp_depot() do
         include("tests.jl")