address new and old fitlog formats in serialization

Author: palday

src/serialization.jl

@@ -73,6 +73,7 @@ function restoreoptsum!(
 end
 
 function restoreoptsum!(ops::OptSummary{T}, dict::AbstractDict) where {T}
+    warn_old_version = true
     allowed_missing = (
         :lowerbd,       # never saved, -Inf not allowed in JSON
         :xtol_zero_abs, # added in v4.25.0
@@ -91,7 +92,9 @@ function restoreoptsum!(ops::OptSummary{T}, dict::AbstractDict) where {T}
         throw(ArgumentError(string("optsum names: ", nmdiff, " not found in io")))
     end
     if length(setdiff(allowed_missing, keys(dict))) > 1 # 1 because :lowerbd
-        @warn "optsum was saved with an older version of MixedModels.jl: consider resaving."
+        @debug "" setdiff(allowed_missing, keys(dict))
+        warn_old_version && @warn "optsum was saved with an older version of MixedModels.jl: consider resaving."
+        warn_old_version = false
     end
 
     if any(ops.lowerbd .> dict.initial) || any(ops.lowerbd .> dict.final)
@@ -116,13 +119,26 @@ function restoreoptsum!(ops::OptSummary{T}, dict::AbstractDict) where {T}
     fitlog = get(dict, :fitlog, nothing)
     ops.fitlog = if isnothing(fitlog)
         # compat with fits saved before fitlog
-        [(ops.initial, ops.finitial), (ops.final, ops.fmin)]
+        Table(; θ=(ops.initial, ops.finitial), objective=(ops.final, ops.fmin))
     else
-        [(convert(Vector{T}, first(entry)), T(last(entry))) for entry in fitlog]
+        _deserialize_fitlog(fitlog, T, warn_old_version)
     end
     return ops
 end
 
+# fitlog structure in MixedModels 4.x
+function _deserialize_fitlog(fitlog, T, warn_old_version::Bool)
+    warn_old_version && @warn "optsum was saved with an older version of MixedModels.jl: consider resaving."
+    warn_old_version = false
+    return Table(( (; θ=convert(Vector{T}, first(entry)),
+                      objective=T(last(entry))) for entry in fitlog))
+end
+
+function _deserialize_fitlog(fitlog::JSON3.Array{JSON3.Object}, T, ::Bool)
+    return Table(( (; θ=convert(Vector{T}, entry.θ),
+                      objective=T(entry.objective)) for entry in fitlog))
+end
+
 StructTypes.StructType(::Type{<:OptSummary}) = StructTypes.Mutable()
 StructTypes.excludes(::Type{<:OptSummary}) = (:lowerbd,)
 

test/pls.jl

@@ -626,7 +626,41 @@ end
         )
         @test_throws(ArgumentError("optsum names: [:ftol_abs] not found in io"),
             restoreoptsum!(m, seekstart(iob)))
-
+        # note that this contains a fitlog from an older version!
+        iob = IOBuffer(
+            """
+            {
+                "initial":[1.0,0.0,1.0],
+                "finitial":1784.642296192436,
+                "ftol_rel":1.0e-12,
+                "ftol_abs":1.0e-8,
+                "xtol_rel":0.0,
+                "xtol_abs":[1.0e-10,1.0e-10,1.0e-10],
+                "rhobeg":1.0,
+                "rhoend":1.0e-6,
+                "xtol_zero_abs":0.001,
+                "ftol_zero_abs":1.0e-5,
+                "backend": "nlopt",
+                "initial_step":[0.75,1.0,0.75],
+                "maxfeval":-1,
+                "maxtime":-1.0,
+                "feval":57,
+                "final":[0.9292213195402981,0.01816837807519162,0.22264487477788353],
+                "fmin":1751.9393444646712,
+                "optimizer":"LN_BOBYQA",
+                "returnvalue":"FTOL_REACHED",
+                "nAGQ":1,
+                "REML":false,
+                "sigma":null,
+                "fitlog":[[[1.0,0.0,1.0],1784.642296192436]]
+            }
+            """,
+        )
+        @test_logs(
+            (:warn,
+                r"optsum was saved with an older version of MixedModels.jl: consider resaving",
+            ),
+            restoreoptsum!(m, seekstart(iob)))
         #         iob = IOBuffer(
         # """
         # {