Revision 9e8fe688c5e32bde3ab48bb71f9d4ab45ef272ee authored by Valentin Churavy on 24 November 2023, 22:35:51 UTC, committed by GitHub on 24 November 2023, 22:35:51 UTC
Fixes #52213
Overwritting methods during cache creation is currently not something
that the system
can support and can lead to surprising, counter-intuitive and fatal
errors.
In 1.10 we turned it from a warning to a strong error, with this PR it
remains
a strong error, but the precompilation system recognizes it and
essentially sets `__precompile__(false)`
for this module and all modules that depend on it.
Before:
```
julia> using OverwriteMethodError
[ Info: Precompiling OverwriteMethodError [top-level]
WARNING: Method definition +(Bool, Bool) in module Base at bool.jl:166 overwritten in module OverwriteMethodError at /home/vchuravy/src/julia2/OverwriteMethodError.jl:2.
ERROR: LoadError: Method overwriting is not permitted during Module precompile.
Stacktrace:
[1] top-level scope
@ ~/src/julia2/OverwriteMethodError.jl:2
[2] include
@ Base ./Base.jl:489 [inlined]
[3] 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::Nothing)
@ Base ./loading.jl:2216
[4] top-level scope
@ stdin:3
in expression starting at /home/vchuravy/src/julia2/OverwriteMethodError.jl:1
in expression starting at stdin:3
ERROR: Failed to precompile OverwriteMethodError [top-level] to "/home/vchuravy/.julia/compiled/v1.10/jl_guiuCQ".
Stacktrace:
[1] error(s::String)
@ Base ./error.jl:35
[2] compilecache(pkg::Base.PkgId, path::String, internal_stderr::IO, internal_stdout::IO, keep_loaded_modules::Bool)
@ Base ./loading.jl:2462
[3] compilecache
@ Base ./loading.jl:2334 [inlined]
[4] (::Base.var"#968#969"{Base.PkgId})()
@ Base ./loading.jl:1968
[5] mkpidlock(f::Base.var"#968#969"{Base.PkgId}, at::String, pid::Int32; kwopts::@Kwargs{stale_age::Int64, wait::Bool})
@ FileWatching.Pidfile ~/.julia/juliaup/julia-1.10.0-rc1+0.x64.linux.gnu/share/julia/stdlib/v1.10/FileWatching/src/pidfile.jl:93
[6] #mkpidlock#6
@ FileWatching.Pidfile ~/.julia/juliaup/julia-1.10.0-rc1+0.x64.linux.gnu/share/julia/stdlib/v1.10/FileWatching/src/pidfile.jl:88 [inlined]
[7] trymkpidlock(::Function, ::Vararg{Any}; kwargs::@Kwargs{stale_age::Int64})
@ FileWatching.Pidfile ~/.julia/juliaup/julia-1.10.0-rc1+0.x64.linux.gnu/share/julia/stdlib/v1.10/FileWatching/src/pidfile.jl:111
[8] #invokelatest#2
@ Base ./essentials.jl:889 [inlined]
[9] invokelatest
@ Base ./essentials.jl:884 [inlined]
[10] maybe_cachefile_lock(f::Base.var"#968#969"{Base.PkgId}, pkg::Base.PkgId, srcpath::String; stale_age::Int64)
@ Base ./loading.jl:2977
[11] maybe_cachefile_lock
@ Base ./loading.jl:2974 [inlined]
[12] _require(pkg::Base.PkgId, env::String)
@ Base ./loading.jl:1964
[13] __require_prelocked(uuidkey::Base.PkgId, env::String)
@ Base ./loading.jl:1806
[14] #invoke_in_world#3
@ Base ./essentials.jl:921 [inlined]
[15] invoke_in_world
@ Base ./essentials.jl:918 [inlined]
[16] _require_prelocked(uuidkey::Base.PkgId, env::String)
@ Base ./loading.jl:1797
[17] macro expansion
@ Base ./loading.jl:1784 [inlined]
[18] macro expansion
@ Base ./lock.jl:267 [inlined]
[19] __require(into::Module, mod::Symbol)
@ Base ./loading.jl:1747
[20] #invoke_in_world#3
@ Base ./essentials.jl:921 [inlined]
[21] invoke_in_world
@ Base ./essentials.jl:918 [inlined]
[22] require(into::Module, mod::Symbol)
@ Base ./loading.jl:1740
```
After:
```
julia> using OverwriteMethodError
┌ Info: Precompiling OverwriteMethodError [top-level]
└ @ Base loading.jl:2486
WARNING: Method definition +(Bool, Bool) in module Base at bool.jl:166 overwritten in module OverwriteMethodError at /home/vchuravy/src/julia2/OverwriteMethodError.jl:2.
ERROR: Method overwriting is not permitted during Module precompile.
┌ Info: Skipping precompilation since __precompile__(false). Importing OverwriteMethodError [top-level].
└ @ Base loading.jl:2084
```
---------
Co-authored-by: Kristoffer Carlsson <kcarlsson89@gmail.com> 1 parent 6e23543
error.jl
# This file is a part of Julia. License is MIT: https://julialang.org/license
# for curmod_str
include("testenv.jl")
@testset "ExponentialBackOff" begin
@test length(ExponentialBackOff(n=10)) == 10
@test collect(ExponentialBackOff(n=10, first_delay=0.01))[1] == 0.01
@test maximum(ExponentialBackOff(n=10, max_delay=0.06)) == 0.06
ratio(x) = x[2:end]./x[1:end-1]
@test all(x->x ≈ 10.0, ratio(collect(ExponentialBackOff(n=10, max_delay=Inf, factor=10, jitter=0.0))))
Libc.srand(12345)
x = ratio(collect(ExponentialBackOff(n=100, max_delay=Inf, factor=1, jitter=0.1)))
xm = sum(x) / length(x)
@test abs(xm - 1.0) < 0.01
Libc.srand()
end
@testset "retrying after errors" begin
function foo_error(c, n)
c[1] += 1
if c[1] <= n
error("foo")
end
return 7
end
# Success on first attempt
c = [0]
@test retry(foo_error)(c,0) == 7
@test c[1] == 1
# Success on second attempt
c = [0]
@test retry(foo_error)(c,1) == 7
@test c[1] == 2
# 2 failed retry attempts, so exception is raised
c = [0]
ex = try retry(foo_error, delays=ExponentialBackOff(n=2))(c,3) catch e; e end
@test ex.msg == "foo"
@test c[1] == 3
c = [0]
ex = try retry(foo_error, check=(s,e)->(s,isa(e, ErrorException)))(c,2) catch e; e end
@test typeof(ex) == ErrorException
@test ex.msg == "foo"
@test c[1] == 2
c = [0]
ex = try retry(foo_error, check=(s,e)->(s,e.msg == "foo"))(c,2) catch e; e end
@test typeof(ex) == ErrorException
@test ex.msg == "foo"
@test c[1] == 2
# No retry if condition does not match
c = [0]
ex = try retry(foo_error, check=(s,e)->(s,e.msg == "bar"))(c,2) catch e; e end
@test typeof(ex) == ErrorException
@test ex.msg == "foo"
@test c[1] == 1
c = [0]
ex = try retry(foo_error, check=(s,e)->(s,try e.http_status_code == "503"; catch; end != true))(c,2) catch e; e end
@test typeof(ex) == ErrorException
@test ex.msg == "foo"
@test c[1] == 2
c = [0]
ex = try retry(foo_error, check=(s,e)->(s,isa(e,SystemError)))(c,2) catch e; e end
@test typeof(ex) == ErrorException
@test ex.msg == "foo"
@test c[1] == 1
# Test example in docstring where the check function doesn't return the state.
c = [0]
@test retry(foo_error, check=(s,e)->e.msg == "foo")(c,1) == 7
@test c[1] == 2
# Functions with keyword arguments
foo_kwargs(x; y=5) = x + y
@test retry(foo_kwargs)(3) == 8
@test retry(foo_kwargs)(3; y=4) == 7
# non-Functions
@test retry(Float64)(1) === 1.0
end
@testset "SystemError initialization" begin
e = SystemError("fail")
@test e.extrainfo === nothing
end
@testset "MethodError for methods without line numbers" begin
try
eval(Expr(:function, :(f44319()), 0))
f44319(1)
catch e
s = sprint(showerror, e)
@test s == "MethodError: no method matching f44319(::Int$(Sys.WORD_SIZE))\n\nClosest candidates are:\n f44319()\n @ $curmod_str none:0\n"
end
end
@testset "All types ending with Exception or Error subtype Exception" begin
function test_exceptions(mod, visited=Set{Module}())
if mod ∉ visited
push!(visited, mod)
for name in names(mod, all=true)
isdefined(mod, name) || continue
value = getfield(mod, name)
if value isa Module
test_exceptions(value, visited)
elseif value isa Type
str = string(value)
if endswith(str, "Exception") || endswith(str, "Error")
@test value <: Exception
end
end
end
end
visited
end
visited = test_exceptions(Base)
test_exceptions(Core, visited)
end
Computing file changes ...
