Add Lockable to Base, to bundle a lock with its resource

[ericphanson]

redo of #34400
closes #52897

I think this can be useful, so putting it back up. (First commit I copied from https://github.com/JuliaServices/ConcurrentUtilities.jl/blob/main/src/lockable.jl, so I added @quinnj as a co-author, then I realized it came from #34400, so I added @DilumAluthge).

I am not sure about the lock(f, ::Lockable) method: it is nice because it unpacks the value for you, but it is weird because it unpacks the value for you. For a Lockable, f must accept one argument, whereas for a Lock, f must be 0-arg. A Lockable is not <:AbstractLock here, so maybe this is allowed, but if we deleted this lock method, we could inherit from AbstractLock and just use the generic one (requiring folks to unpack the value within the locked region themselves, as is the case for @lock). I think it is preferred these days to use @lock anyway, so having the lock(f,::Lockable) method may be of limited value anyway.

I searched Base and came up with two places that could currently use this internally, TEMP_CLEANUP and env_dict, so I've added commits to show the usage there.

[vtjnash]

SGTM

[ericphanson]

ArgTools tests are failing here, should be fixed by JuliaIO/ArgTools.jl#35. Alternatively, we could remove the TEMP_CLEANUP changes from this PR.

[vtjnash]

Would probably be best not to hold up this PR for that change, but is almost done now, so can just see about rebasing onto soon: #53124

[inkydragon]

Test failed related:

Error in testset Pkg:
Error During Test at /Users/julia/.julia/scratchspaces/a66863c6-20e8-4ff4-8a62-49f30b1f605e/agent-cache/default-honeycrisp-XG3Q6T6R70.0/build/default-honeycrisp-XG3Q6T6R70-0/julialang/julia-master/julia-7f8a4a525c/share/julia/test/testdefs.jl:24
  Got exception outside of a @test
  LoadError: MethodError: no method matching empty!(::Lockable{Dict{String, Bool}, ReentrantLock})
  Closest candidates are:
    ...
  Stacktrace:
    [1] top-level scope
      @ /Users/julia/.julia/scratchspaces/a66863c6-20e8-4ff4-8a62-49f30b1f605e/agent-cache/default-honeycrisp-XG3Q6T6R70.0/build/default-honeycrisp-XG3Q6T6R70-0/julialang/julia-master/julia-7f8a4a525c/share/julia/stdlib/v1.11/Pkg/test/runtests.jl:96

https://github.com/JuliaLang/Pkg.jl/blob/f3b81f1aac77acf08f5d847ead29ad0a228dec67/test/runtests.jl#L94-L99

[ericphanson]

Urg, I regret making the temp file changes here, I just wanted to show Lockable had uses within Base. At least I checked if TEMP_FILE isa Lockable in the ArgTools PR so it's not too late to revert that here.

[ericphanson]

Failure seems unrelated now:

cmdlineargs                                       (7) |         failed at 2024-02-04T00:12:08.906
Test Failed at /cache/build/tester-amdci4-12/julialang/julia-master/julia-8a35ded8ae/share/julia/test/cmdlineargs.jl:1065
  Expression: success(pipeline(setenv(`$(Base.julia_cmd()) --bug-report=rr-local -e 'exit()'`, "JULIA_RR_RECORD_ARGS" => "-n --nested=ignore", "_RR_TRACE_DIR" => temp_trace_dir); ))

[vtjnash]

Seems odd it would fail repeatedly though, when that test hasn't usually been a problem

[vtjnash]

Indeed it is related. Running locally gives:

WARNING: both ConcurrentUtilities and Base export "Lockable"; uses of it in module Connections must be qualified

ERROR: LoadError: UndefVarError: `Lockable` not defined in `HTTP.Connections`
Stacktrace:
 [1] top-level scope
   @ ~/.julia/packages/HTTP/bDoga/src/Connections.jl:385
 [2] include(mod::Module, _path::String)
   @ Base ./Base.jl:556
 [3] include(x::String)
   @ HTTP ~/.julia/packages/HTTP/bDoga/src/HTTP.jl:1
 [4] top-level scope
   @ ~/.julia/packages/HTTP/bDoga/src/HTTP.jl:40
 [5] include
   @ ./Base.jl:556 [inlined]
 [6] include_package_for_output(pkg::Base.PkgId, input::String, depot_path::Vector{String}, dl_load_path::Vector{String}, load_path::Vector{String}, concrete_deps::Vector{Pair{Base.PkgId, UInt128}}, source::String)
   @ Base ./loading.jl:2427
 [7] top-level scope
   @ stdin:3
in expression starting at /home/vtjnash/.julia/packages/HTTP/bDoga/src/Connections.jl:1
in expression starting at /home/vtjnash/.julia/packages/HTTP/bDoga/src/HTTP.jl:1
in expression starting at stdin:3

[DilumAluthge]

Sounds like HTTP.jl has a using ConcurrentUtilities somewhere that they need to change to using ConcurrentUtilities: Lockable.

[vtjnash]

Or ConcurrentUtilities should add a case if isdefined(Base, :Lockable); using Base: Lockable; else; include("lockable.jl"); end

[vtjnash]

JuliaServices/ConcurrentUtilities.jl#31

[adienes]

would be cool to have this in 1.11 if possible

[vtjnash]

I don't have the ability to make a new JuliaServices/ConcurrentUtilities.jl#31 release, but once that is done, this should be able to merge

[vtjnash]

You know what though, we don't actually have to wait for that. We will put off doing the actual export for a later day though.

[quinnj]

submitted a new ConcurrentUtilities.jl release

[vtjnash]

Thanks! We will still merge this today, and then now can merge the export in a couple days or weeks to give people time to update to the new release

[ericphanson]

Thanks for getting this in @vtjnash!