Update to SciMLLogging 2.0 (#927)

* move linear verbosity t o specifiers

* update to SciMLLogging 2.0

* CI

* AbstractMessageLevel => MessageLevel

* fix projects, fix up tests

* fix verbosity setting in downstream test

* format verbosity.jl

* bump patch versions

Author: jClugstor

Project.toml

@@ -1,6 +1,6 @@
 name = "NonlinearSolve"
 uuid = "8913a72c-1f9b-4ce2-8d82-65094dcecaec"
-version = "4.19.0"
+version = "4.19.1"
 authors = ["SciML"]
 
 [deps]
@@ -25,7 +25,6 @@ Preferences = "21216c6a-2e73-6563-6e65-726566657250"
 Reexport = "189a3867-3050-52da-a836-e630ba90ab69"
 SciMLBase = "0bca4576-84f4-4d90-8ffe-ffa030f20462"
 Setfield = "efcf1570-3423-57d1-acb7-fd33fddbac46"
-SciMLLogging = "a6db7da4-7206-11f0-1eab-35f2a5dbe1d1"
 SimpleNonlinearSolve = "727e6d20-b764-4bd8-a329-72de5adea6c7"
 StaticArraysCore = "1e83bf80-4336-4d27-bf5d-d5a4f845583c"
 SymbolicIndexingInterface = "2efcf032-c050-4f8e-a9bb-153293bab1f5"
@@ -120,7 +119,7 @@ ReverseDiff = "1.15"
 SIAMFANLEquations = "1.0.1"
 SciMLBase = "2.154, 3"
 Setfield = "1.1.2"
-SciMLLogging = "1.7"
+SciMLLogging = "1.10.1, 2"
 SimpleNonlinearSolve = "2.10"
 SparseArrays = "1.10"
 SparseConnectivityTracer = "1"

lib/NonlinearSolveBase/Project.toml

@@ -1,6 +1,6 @@
 name = "NonlinearSolveBase"
 uuid = "be0214bd-f91f-a760-ac4e-3421ce2b2da0"
-version = "2.25.0"
+version = "2.25.1"
 authors = ["Avik Pal <avikpal@mit.edu> and contributors"]
 
 [deps]
@@ -94,7 +94,7 @@ RecursiveArrayTools = "3, 4"
 ReverseDiff = "1.15"
 SciMLBase = "2.153, 3"
 SciMLJacobianOperators = "0.1.1"
-SciMLLogging = "1.7"
+SciMLLogging = "1.10.1, 2"
 SciMLOperators = "1.7"
 SciMLStructures = "1.5"
 Setfield = "1.1.2"

lib/NonlinearSolveBase/src/NonlinearSolveBase.jl

@@ -31,7 +31,7 @@ import SciMLBase: solve, init, __init, __solve, wrap_sol, get_root_indp, isinpla
 using SciMLJacobianOperators: JacobianOperator, StatefulJacobianOperator
 using SciMLOperators: AbstractSciMLOperator, IdentityOperator
 using SciMLLogging: SciMLLogging, @SciMLMessage, @verbosity_specifier,
-    AbstractVerbositySpecifier, AbstractVerbosityPreset, AbstractMessageLevel,
+    AbstractVerbositySpecifier, AbstractVerbosityPreset, MessageLevel,
     None, Minimal, Standard, Detailed, All, Silent, InfoLevel, WarnLevel
 
 using PreallocationTools: FixedSizeDiffCache, get_tmp

lib/NonlinearSolveBase/src/verbosity.jl

@@ -65,8 +65,9 @@ verbose = NonlinearVerbosity(
 NonlinearVerbosity
 
 @verbosity_specifier NonlinearVerbosity begin
+    sub_specifiers = (:linear_verbosity,)
     toggles = (
-        :linear_verbosity, :non_enclosing_interval, :alias_u0_immutable,
+        :non_enclosing_interval, :alias_u0_immutable,
         :linsolve_failed_noncurrent, :termination_condition, :threshold_state, :forcing,
         :sensitivity_vjp_choice,
     )

lib/NonlinearSolveBase/test/runtests.jl

@@ -25,7 +25,7 @@ using InteractiveUtils, Test
         # Ignore SciMLLogging types used by @verbosity_specifier macro (ExplicitImports can't track macro usage)
         @test check_no_stale_explicit_imports(
             NonlinearSolveBase;
-            ignore = (:AbstractMessageLevel, :AbstractVerbositySpecifier, :All, :Detailed, :Minimal, :None, :Standard, :SciMLLogging)
+            ignore = (:MessageLevel, :AbstractVerbositySpecifier, :All, :Detailed, :Minimal, :None, :Standard, :SciMLLogging)
         ) === nothing
         @test check_all_qualified_accesses_via_owners(NonlinearSolveBase) === nothing
     end

test/core_tests.jl

@@ -255,6 +255,7 @@ end
 # Trust region methods also don't work with complex numbers (they use extrema internally).
 @testitem "Complex Valued Problems: Single-Shooting" tags = [:downstream] begin
     using OrdinaryDiffEqTsit5
+    using SciMLLogging: SciMLLogging
 
     function ode_func!(du, u, p, t)
         du[1] = u[2]
@@ -265,7 +266,7 @@ end
     function objective_function!(resid, u0, p)
         odeprob = ODEProblem{true}(ode_func!, u0, (0.0, 100.0), p)
         sol = solve(
-            odeprob, Tsit5(), abstol = 1.0e-9, reltol = 1.0e-9, verbose = false
+            odeprob, Tsit5(), abstol = 1.0e-9, reltol = 1.0e-9, verbose = SciMLLogging.None()
         )
         resid[1] = sol(0.0)[1]
         resid[2] = sol(100.0)[1] - 1.0

test/verbosity_tests.jl

@@ -13,44 +13,44 @@
         v_standard = NonlinearVerbosity(SciMLLogging.Standard())
         v_detailed = NonlinearVerbosity(SciMLLogging.Detailed())
 
-        @test v_none.non_enclosing_interval isa SciMLLogging.Silent
-        @test v_none.threshold_state isa SciMLLogging.Silent
-        @test v_none.alias_u0_immutable isa SciMLLogging.Silent
-        @test v_none.sensitivity_vjp_choice isa SciMLLogging.Silent
-
-        @test v_minimal.non_enclosing_interval isa SciMLLogging.WarnLevel
-        @test v_minimal.alias_u0_immutable isa SciMLLogging.Silent
-        @test v_minimal.termination_condition isa SciMLLogging.Silent
-        @test v_minimal.sensitivity_vjp_choice isa SciMLLogging.Silent
-
-        @test v_standard.non_enclosing_interval isa SciMLLogging.WarnLevel
-        @test v_standard.threshold_state isa SciMLLogging.WarnLevel
-        @test v_standard.sensitivity_vjp_choice isa SciMLLogging.WarnLevel
-
-        @test v_detailed.alias_u0_immutable isa SciMLLogging.WarnLevel
-        @test v_detailed.termination_condition isa SciMLLogging.WarnLevel
-        @test v_detailed.sensitivity_vjp_choice isa SciMLLogging.WarnLevel
-
-        @test v_all.linsolve_failed_noncurrent isa SciMLLogging.WarnLevel
-        @test v_all.threshold_state isa SciMLLogging.InfoLevel
-        @test v_all.sensitivity_vjp_choice isa SciMLLogging.WarnLevel
+        @test v_none.non_enclosing_interval == SciMLLogging.Silent()
+        @test v_none.threshold_state == SciMLLogging.Silent()
+        @test v_none.alias_u0_immutable == SciMLLogging.Silent()
+        @test v_none.sensitivity_vjp_choice == SciMLLogging.Silent()
+
+        @test v_minimal.non_enclosing_interval == SciMLLogging.WarnLevel()
+        @test v_minimal.alias_u0_immutable == SciMLLogging.Silent()
+        @test v_minimal.termination_condition == SciMLLogging.Silent()
+        @test v_minimal.sensitivity_vjp_choice == SciMLLogging.Silent()
+
+        @test v_standard.non_enclosing_interval == SciMLLogging.WarnLevel()
+        @test v_standard.threshold_state == SciMLLogging.WarnLevel()
+        @test v_standard.sensitivity_vjp_choice == SciMLLogging.WarnLevel()
+
+        @test v_detailed.alias_u0_immutable == SciMLLogging.WarnLevel()
+        @test v_detailed.termination_condition == SciMLLogging.WarnLevel()
+        @test v_detailed.sensitivity_vjp_choice == SciMLLogging.WarnLevel()
+
+        @test v_all.linsolve_failed_noncurrent == SciMLLogging.WarnLevel()
+        @test v_all.threshold_state == SciMLLogging.InfoLevel()
+        @test v_all.sensitivity_vjp_choice == SciMLLogging.WarnLevel()
     end
 
     @testset "Group-level keyword constructors" begin
         v_error = NonlinearVerbosity(error_control = SciMLLogging.ErrorLevel())
-        @test v_error.alias_u0_immutable isa SciMLLogging.ErrorLevel
-        @test v_error.non_enclosing_interval isa SciMLLogging.ErrorLevel
-        @test v_error.termination_condition isa SciMLLogging.ErrorLevel
-        @test v_error.linsolve_failed_noncurrent isa SciMLLogging.ErrorLevel
+        @test v_error.alias_u0_immutable == SciMLLogging.ErrorLevel()
+        @test v_error.non_enclosing_interval == SciMLLogging.ErrorLevel()
+        @test v_error.termination_condition == SciMLLogging.ErrorLevel()
+        @test v_error.linsolve_failed_noncurrent == SciMLLogging.ErrorLevel()
 
         v_numerical = NonlinearVerbosity(numerical = SciMLLogging.Silent())
-        @test v_numerical.threshold_state isa SciMLLogging.Silent
+        @test v_numerical.threshold_state == SciMLLogging.Silent()
 
         v_sensitivity = NonlinearVerbosity(sensitivity = SciMLLogging.Silent())
-        @test v_sensitivity.sensitivity_vjp_choice isa SciMLLogging.Silent
+        @test v_sensitivity.sensitivity_vjp_choice == SciMLLogging.Silent()
 
         v_sensitivity2 = NonlinearVerbosity(sensitivity = SciMLLogging.InfoLevel())
-        @test v_sensitivity2.sensitivity_vjp_choice isa SciMLLogging.InfoLevel
+        @test v_sensitivity2.sensitivity_vjp_choice == SciMLLogging.InfoLevel()
     end
 
     @testset "Mixed group and individual settings" begin
@@ -60,10 +60,10 @@
             error_control = SciMLLogging.InfoLevel()
         )
         # Individual override should take precedence
-        @test v_mixed.threshold_state isa SciMLLogging.WarnLevel
+        @test v_mixed.threshold_state == SciMLLogging.WarnLevel()
         # Error control group setting should apply
-        @test v_mixed.alias_u0_immutable isa SciMLLogging.InfoLevel
-        @test v_mixed.linsolve_failed_noncurrent isa SciMLLogging.InfoLevel
+        @test v_mixed.alias_u0_immutable == SciMLLogging.InfoLevel()
+        @test v_mixed.linsolve_failed_noncurrent == SciMLLogging.InfoLevel()
     end
 
     @testset "Individual keyword arguments" begin
@@ -72,12 +72,12 @@
             threshold_state = SciMLLogging.InfoLevel(),
             termination_condition = SciMLLogging.Silent()
         )
-        @test v_individual.alias_u0_immutable isa SciMLLogging.ErrorLevel
-        @test v_individual.threshold_state isa SciMLLogging.InfoLevel
-        @test v_individual.termination_condition isa SciMLLogging.Silent
+        @test v_individual.alias_u0_immutable == SciMLLogging.ErrorLevel()
+        @test v_individual.threshold_state == SciMLLogging.InfoLevel()
+        @test v_individual.termination_condition == SciMLLogging.Silent()
         # Unspecified options should use defaults
-        @test v_individual.non_enclosing_interval isa SciMLLogging.WarnLevel
-        @test v_individual.linsolve_failed_noncurrent isa SciMLLogging.WarnLevel
+        @test v_individual.non_enclosing_interval == SciMLLogging.WarnLevel()
+        @test v_individual.linsolve_failed_noncurrent == SciMLLogging.WarnLevel()
     end
 
     g(u, p) = u^2 - 4
@@ -192,8 +192,8 @@
         # Test verbose = false converts to NonlinearVerbosity(None())
         cache2 = init(prob, verbose = false)
         @test cache2.verbose isa NonlinearVerbosity
-        @test cache2.verbose.threshold_state isa SciMLLogging.Silent
-        @test cache2.verbose.non_enclosing_interval isa SciMLLogging.Silent
+        @test cache2.verbose.threshold_state == SciMLLogging.Silent()
+        @test cache2.verbose.non_enclosing_interval == SciMLLogging.Silent()
     end
 
     @testset "init with Preset verbose" begin
@@ -205,12 +205,12 @@
         # Test verbose = SciMLLogging.None() converts to NonlinearVerbosity(None())
         cache2 = init(prob, verbose = SciMLLogging.None())
         @test cache2.verbose isa NonlinearVerbosity
-        @test cache2.verbose.threshold_state isa SciMLLogging.Silent
+        @test cache2.verbose.threshold_state == SciMLLogging.Silent()
 
         # Test verbose = SciMLLogging.Detailed()
         cache3 = init(prob, verbose = SciMLLogging.Detailed())
         @test cache3.verbose isa NonlinearVerbosity
-        @test cache3.verbose.linear_verbosity isa SciMLLogging.Detailed
+        @test cache3.verbose.linear_verbosity == SciMLLogging.Detailed()
 
         # Test verbose = SciMLLogging.All()
         cache4 = init(prob, verbose = SciMLLogging.All())
@@ -220,7 +220,7 @@
         # Test verbose = SciMLLogging.Minimal()
         cache5 = init(prob, verbose = SciMLLogging.Minimal())
         @test cache5.verbose isa NonlinearVerbosity
-        @test cache5.verbose.alias_u0_immutable isa SciMLLogging.Silent
+        @test cache5.verbose.alias_u0_immutable == SciMLLogging.Silent()
     end
 
     @testset "init then solve with converted verbose" begin
@@ -231,9 +231,9 @@
 
     @testset "NonlinearVerbosity with keyword message levels (issue #796)" begin
         # Regression test: constructing NonlinearVerbosity with keyword arguments
-        # that are AbstractMessageLevel subtypes should not throw UndefVarError
+        # that are MessageLevel subtypes should not throw UndefVarError
         verb = NonlinearVerbosity(non_enclosing_interval = SciMLLogging.ErrorLevel())
-        @test verb.non_enclosing_interval isa SciMLLogging.ErrorLevel
+        @test verb.non_enclosing_interval == SciMLLogging.ErrorLevel()
 
         # Test with the full solve pipeline from the issue MWE
         f_interval(x, p) = x^2 - p