Add invalidation-insulating accessors (#101)

Because IdDict's `setindex!` uses `@nospecialize` on both the key and
value, it makes callers vulnerable to invalidation. These convenience
utilities allow callers to insulate themselves from invalidation.
These will be used by Revise.

Author: timholy

Project.toml

@@ -1,7 +1,7 @@
 name = "CodeTracking"
 uuid = "da1fd8a2-8d9e-5ec2-8556-3022fb5608a2"
 authors = ["Tim Holy <[email protected]>"]
-version = "1.1.2"
+version = "1.2.0"
 
 [deps]
 InteractiveUtils = "b77e0a4c-d291-57a0-90e8-8db25a27a240"

src/utils.jl

@@ -149,3 +149,10 @@ end
 getpkgid(project::AbstractString, libname) = getpkgid(Base.project_deps_get(project, libname), libname)
 getpkgid(id::PkgId, libname) = id
 getpkgid(uuid::UUID, libname) = PkgId(uuid, libname)
+
+# Because IdDict's `setindex!` uses `@nospecialize` on both the key and value, it makes
+# callers vulnerable to invalidation. These convenience utilities allow callers to insulate
+# themselves from invalidation. These are used by Revise.
+# example package triggering invalidation: StaticArrays (new `convert(Type{Array{T,N}}, ::AbstractArray)` methods)
+invoked_setindex!(dct::IdDict{K,V}, @nospecialize(val), @nospecialize(key)) where {K,V} = Base.invokelatest(setindex!, dct, val, key)::typeof(dct)
+invoked_get!(::Type{T}, dct::IdDict{K,V}, @nospecialize(key)) where {K,V,T<:V} = Base.invokelatest(get!, T, dct, key)::V

test/runtests.jl

@@ -162,6 +162,11 @@ isdefined(Main, :Revise) ? Main.Revise.includet("script.jl") : include("script.j
     deleteat!(ex.args[2].args, 1)    # delete the file & line number info
     eval(ex)
     @test code_string(f_no_linenum, (Int,)) === nothing
+
+    # Invalidation-insulating methods used by Revise and perhaps others
+    d = IdDict{Union{String,Symbol},Union{Function,Vector{Function}}}()
+    CodeTracking.invoked_setindex!(d, sin, "sin")
+    @test CodeTracking.invoked_get!(Vector{Function}, d, :cos) isa Vector{Function}
 end
 
 @testset "With Revise" begin
@@ -281,7 +286,7 @@ struct Functor end
     @test body == "(::Functor)(x, y) = x+y"
 end
 
-if VERSION >= v"1.6.0"
+if v"1.6" <= VERSION < v"1.9"
 @testset "kwfuncs" begin
     body, _ = CodeTracking.definition(String, @which fkw(; x=1))
     @test body == """