Merge pull request #965 from JuliaRobotics/23Q1/refac/dropabstbe

drop AbstractBlobEntry

Author: dehann

src/DataBlobs/entities/AbstractBlobEntries.jl

@@ -1,15 +1,3 @@
-##==============================================================================
-## AbstractBlobEntry - Defined in src/entities/AbstractDFG.jl
-##==============================================================================
-# Fields to be implemented
-# label
-# id
-
-getLabel(entry::AbstractBlobEntry) = entry.label
-getId(entry::AbstractBlobEntry) = entry.id
-getHash(entry::AbstractBlobEntry) = hex2bytes(entry.hash)
-getTimestamp(entry::AbstractBlobEntry) = entry.timestamp
-
 
 ##==============================================================================
 ## BlobStoreEntry
@@ -19,7 +7,7 @@ getTimestamp(entry::AbstractBlobEntry) = entry.timestamp
     $(TYPEDEF)
 General Data Store Entry.
 """
-@Base.kwdef struct BlobEntry <: AbstractBlobEntry
+@Base.kwdef struct BlobEntry
     """ This is created by server-side GraphQL """
     id::Union{UUID, Nothing}=nothing 
     """ This is the forced server generated blobId, or the filesystem blobId. """
@@ -38,8 +26,5 @@ General Data Store Entry.
     _version::String = string(_getDFGVersion()) # TBD consider upgrading to ::VersionNumber
 end
 
-# should be deprecated by v0.21
-export BlobStoreEntry
-const BlobStoreEntry = BlobEntry
 
 _fixtimezone(cts::NamedTuple) = ZonedDateTime(cts.utc_datetime*"+00")

src/DataBlobs/services/AbstractBlobEntries.jl

@@ -1,15 +1,15 @@
 ##==============================================================================
-## AbstractBlobEntry - compare
+## BlobEntry - compare
 ##==============================================================================
 
 import Base: ==
 
-@generated function ==(x::T, y::T) where T <: AbstractBlobEntry
+@generated function ==(x::T, y::T) where T <: BlobEntry
     mapreduce(n -> :(x.$n == y.$n), (a,b)->:($a && $b), fieldnames(x))
 end
 
 ##==============================================================================
-## AbstractBlobEntry - common
+## BlobEntry - common
 ##==============================================================================
 
 """
@@ -21,7 +21,7 @@ buildSourceString(dfg::AbstractDFG, label::Symbol) =
 
 
 ##==============================================================================
-## AbstractBlobEntry - CRUD
+## BlobEntry - CRUD
 ##==============================================================================
 
 """
@@ -69,13 +69,13 @@ Should be extended if DFG variable is not returned by reference.
 
 Also see: [`getBlobEntry`](@ref), [`addDataBlob`](@ref), [`mergeBlobEntries!`](@ref)
 """
-function addBlobEntry!(var::AbstractDFGVariable, bde::AbstractBlobEntry)
+function addBlobEntry!(var::AbstractDFGVariable, bde::BlobEntry)
     haskey(var.dataDict, bde.label) && error("Data entry $(bde.label) already exists in variable $(getLabel(var))")
     var.dataDict[bde.label] = bde
     return bde
 end
 
-function addBlobEntry!(dfg::AbstractDFG, label::Symbol, bde::AbstractBlobEntry)
+function addBlobEntry!(dfg::AbstractDFG, label::Symbol, bde::BlobEntry)
     return addBlobEntry!(getVariable(dfg, label), bde)
 end
 
@@ -87,12 +87,12 @@ Update data entry
 DevNote
 - DF, unclear if `update` verb is applicable in this case, see #404
 """
-function updateBlobEntry!(var::AbstractDFGVariable,  bde::AbstractBlobEntry)
+function updateBlobEntry!(var::AbstractDFGVariable,  bde::BlobEntry)
     !haskey(var.dataDict, bde.label) && (@warn "$(bde.label) does not exist in variable $(getLabel(var)), adding")
     var.dataDict[bde.label] = bde
     return bde
 end
-function updateBlobEntry!(dfg::AbstractDFG, label::Symbol,  bde::AbstractBlobEntry)
+function updateBlobEntry!(dfg::AbstractDFG, label::Symbol,  bde::BlobEntry)
     # !isVariable(dfg, label) && return nothing
     return updateBlobEntry!(getVariable(dfg, label), bde)
 end
@@ -114,13 +114,13 @@ function deleteBlobEntry!(dfg::AbstractDFG, label::Symbol, key::Symbol)
     return deleteBlobEntry!(getVariable(dfg, label), key)
 end
 
-function deleteBlobEntry!(var::AbstractDFGVariable, entry::AbstractBlobEntry)
+function deleteBlobEntry!(var::AbstractDFGVariable, entry::BlobEntry)
     #users responsibility to delete data in db before deleting entry
     return deleteBlobEntry!(var, entry.label)
 end
 
 ##==============================================================================
-## AbstractBlobEntry - Helper functions, Lists, etc
+## BlobEntry - Helper functions, Lists, etc
 ##==============================================================================
 
 """
@@ -133,15 +133,15 @@ hasBlobEntry(var::AbstractDFGVariable, key::Symbol) = haskey(var.dataDict, key)
 
 """
     $(SIGNATURES)
-Get data entries, Vector{AbstractBlobEntry}
+Get data entries, Vector{BlobEntry}
 """
 function getBlobEntries(var::AbstractDFGVariable)
-    #or should we return the iterator, Base.ValueIterator{Dict{Symbol,AbstractBlobEntry}}?
+    #or should we return the iterator, Base.ValueIterator{Dict{Symbol,BlobEntry}}?
     collect(values(var.dataDict))
 end
 function getBlobEntries(dfg::AbstractDFG, label::Symbol)
     # !isVariable(dfg, label) && return nothing
-    #or should we return the iterator, Base.ValueIterator{Dict{Symbol,AbstractBlobEntry}}?
+    #or should we return the iterator, Base.ValueIterator{Dict{Symbol,BlobEntry}}?
     getBlobEntries(getVariable(dfg, label))
 end
 
@@ -212,7 +212,7 @@ function mergeBlobEntries!(
     dde = listBlobEntries(dst, dlbl)
         # HACK, verb list should just return vector of Symbol. NCE36
         _getid(s) = s
-        _getid(s::AbstractBlobEntry) = s.id
+        _getid(s::BlobEntry) = s.id
     uids = _getid.(dde) # (s->s.id).(dde)
     filter!(s -> !(_getid(s) in uids), des)
     # add any data entries not already in the destination variable, by uuid
@@ -231,7 +231,7 @@ function mergeBlobEntries!(
     dde = listBlobEntries(dst, dlbl)
         # HACK, verb list should just return vector of Symbol. NCE36
         _getid(s) = s
-        _getid(s::AbstractBlobEntry) = s.id    
+        _getid(s::BlobEntry) = s.id    
     uids = _getid.(dde) # (s->s.id).(dde)
     filter!(s -> !(_getid(s) in uids), des)
     if 0  < length(des)

src/DataBlobs/services/BlobEntry.jl

@@ -1,6 +1,20 @@
 
+##==============================================================================
+## BlobEntry - Defined in src/entities/AbstractDFG.jl
+##==============================================================================
+# Fields to be implemented
+# label
+# id
+
+getLabel(entry::BlobEntry) = entry.label
+getId(entry::BlobEntry) = entry.id
+getHash(entry::BlobEntry) = hex2bytes(entry.hash)
+getTimestamp(entry::BlobEntry) = entry.timestamp
+
+
+
 function assertHash(
-    de::AbstractBlobEntry, 
+    de::BlobEntry, 
     db::AbstractVector{UInt8}; 
     hashfunction::Function = sha256
 )
@@ -12,6 +26,7 @@ function assertHash(
     end
 end
 
+
 ##==============================================================================
 ## DFG BlobBlob CRUD
 ##==============================================================================
@@ -90,24 +105,25 @@ $(METHODLIST)
 function deleteBlob! end
 
 #
-# addBlob!(dfg::AbstractDFG,  entry::AbstractBlobEntry, blob)
-# updateBlob!(dfg::AbstractDFG,  entry::AbstractBlobEntry, blob)
-# deleteBlob!(dfg::AbstractDFG,  entry::AbstractBlobEntry)
+# addBlob!(dfg::AbstractDFG,  entry::BlobEntry, blob)
+# updateBlob!(dfg::AbstractDFG,  entry::BlobEntry, blob)
+# deleteBlob!(dfg::AbstractDFG,  entry::BlobEntry)
+
 
 
-function getBlob(dfg::AbstractDFG, entry::AbstractBlobEntry)
+function getBlob(dfg::AbstractDFG, entry::BlobEntry)
     error("$(typeof(dfg)) doesn't override 'getBlob', with $(typeof(entry)).")
 end
 
-function addBlob!(dfg::AbstractDFG, entry::AbstractBlobEntry, data::T) where T
+function addBlob!(dfg::AbstractDFG, entry::BlobEntry, data::T) where T
     error("$(typeof(dfg)) doesn't override 'addBlob!'.")
 end
 
-function updateBlob!(dfg::AbstractDFG,  entry::AbstractBlobEntry, data::T) where T
+function updateBlob!(dfg::AbstractDFG,  entry::BlobEntry, data::T) where T
     error("$(typeof(dfg)) doesn't override 'updateBlob!'.")
 end
 
-function deleteBlob!(dfg::AbstractDFG, entry::AbstractBlobEntry)
+function deleteBlob!(dfg::AbstractDFG, entry::BlobEntry)
     error("$(typeof(dfg)) doesn't override 'deleteBlob!'.")
 end
 
@@ -147,7 +163,7 @@ end
 function addBlob!(
     dfg::AbstractDFG, 
     label::Symbol, 
-    entry::AbstractBlobEntry, 
+    entry::BlobEntry, 
     blob::Vector{UInt8}; 
     hashfunction = sha256,
     checkhash::Bool=true
@@ -176,7 +192,7 @@ end
 function updateBlob!(
     dfg::AbstractDFG, 
     label::Symbol, 
-    entry::AbstractBlobEntry, 
+    entry::BlobEntry, 
     blob::Vector{UInt8};
     hashfunction = sha256,
     checkhash::Bool=true

src/DataBlobs/services/BlobStores.jl

@@ -63,7 +63,7 @@ end
 # Can specify which entries to copy with the `sourceEntries` parameter.
 # Returns the list of copied entries.
 # """
-# function copyBlobStore(sourceStore::D1, destStore::D2; sourceEntries=listEntries(sourceStore))::Vector{E} where {T, D1 <: AbstractDataStore{T}, D2 <: AbstractDataStore{T}, E <: AbstractBlobEntry}
+# function copyBlobStore(sourceStore::D1, destStore::D2; sourceEntries=listEntries(sourceStore))::Vector{E} where {T, D1 <: AbstractDataStore{T}, D2 <: AbstractDataStore{T}, E <: BlobEntry}
 #     # Quick check
 #     destEntries = listBlobs(destStore)
 #     typeof(sourceEntries) != typeof(destEntries) && error("Can't copy stores, source has entries of type $(typeof(sourceEntries)), destination has entries of type $(typeof(destEntries)).")
@@ -94,14 +94,14 @@ function getBlob(
     return de=>db
 end
 
-function addBlob!(dfg::AbstractDFG, blobstore::AbstractBlobStore, label::Symbol, entry::AbstractBlobEntry, blob::Vector{UInt8}; hashfunction = sha256)
+function addBlob!(dfg::AbstractDFG, blobstore::AbstractBlobStore, label::Symbol, entry::BlobEntry, blob::Vector{UInt8}; hashfunction = sha256)
     assertHash(entry, blob; hashfunction)
     de = addBlobEntry!(dfg, label, entry)
     db = addBlob!(blobstore, de, blob)
     return de=>db
 end
 
-function updateBlob!(dfg::AbstractDFG, blobstore::AbstractBlobStore, label::Symbol,  entry::AbstractBlobEntry, blob::Vector{UInt8}; hashfunction = sha256)
+function updateBlob!(dfg::AbstractDFG, blobstore::AbstractBlobStore, label::Symbol,  entry::BlobEntry, blob::Vector{UInt8}; hashfunction = sha256)
     # Recalculate the hash - NOTE Assuming that this is going to be a BlobEntry. TBD.
     newEntry = BlobEntry(entry.id, entry.blobId, entry.originId, entry.label, blobstore.key, bytes2hex(hashfunction(blob)),
         buildSourceString(dfg, label),
@@ -112,7 +112,7 @@ function updateBlob!(dfg::AbstractDFG, blobstore::AbstractBlobStore, label::Symb
     return de=>db
 end
 
-deleteBlob!(dfg::AbstractDFG, blobstore::AbstractBlobStore, label::Symbol, entry::AbstractBlobEntry) =
+deleteBlob!(dfg::AbstractDFG, blobstore::AbstractBlobStore, label::Symbol, entry::BlobEntry) =
             deleteBlob!(dfg, blobstore, label, entry.label)
 
 function deleteBlob!(dfg::AbstractDFG, blobstore::AbstractBlobStore, label::Symbol, key::Symbol)

src/Deprecated.jl

@@ -3,6 +3,17 @@
 ## Remove in v0.21
 ##=================================================================================
 
+
+"""
+$(TYPEDEF)
+Abstract parent struct for big data entry.
+"""
+abstract type AbstractBlobEntry end
+
+# should be deprecated by v0.21
+export BlobStoreEntry
+const BlobStoreEntry = BlobEntry
+
 @deprecate hasDataEntry(w...;kw...) hasBlobEntry(w...;kw...)
 @deprecate getBlobEntry(w...;kw...) getBlobEntry(w...;kw...)
 @deprecate addDataEntry!(w...;kw...) addBlobEntry!(w...;kw...)

src/entities/AbstractDFG.jl

@@ -40,12 +40,6 @@ Empty structure for solver parameters.
 struct NoSolverParams <: AbstractParams
 end
 
-"""
-$(TYPEDEF)
-Abstract parent struct for big data entry.
-"""
-abstract type AbstractBlobEntry end
-
 """
 Types valid for small data.
 """

src/entities/DFGVariable.jl

@@ -234,7 +234,7 @@ Base.@kwdef struct DFGVariable{T<:InferenceVariable} <: AbstractDFGVariable
     smallData::Dict{Symbol, SmallDataTypes}
     """Dictionary of large data associated with this variable.
     Accessors: [`addDataEntry!`](@ref), [`getBlobEntry`](@ref), [`updateDataEntry!`](@ref), and [`deleteDataEntry!`](@ref)"""
-    dataDict::Dict{Symbol, AbstractBlobEntry}
+    dataDict::Dict{Symbol, BlobEntry}
     """Solvable flag for the variable.
     Accessors: [`getSolvable`](@ref), [`setSolvable!`](@ref)"""
     solvable::Base.RefValue{Int}
@@ -255,7 +255,7 @@ function DFGVariable(label::Symbol, variableType::Type{T};
             estimateDict::Dict{Symbol, <: AbstractPointParametricEst}=Dict{Symbol, MeanMaxPPE}(),
             solverDataDict::Dict{Symbol, VariableNodeData{T,P}}=Dict{Symbol, VariableNodeData{T,getPointType(T)}}(),
             smallData::Dict{Symbol, SmallDataTypes}=Dict{Symbol, SmallDataTypes}(),
-            dataDict::Dict{Symbol, AbstractBlobEntry}=Dict{Symbol,AbstractBlobEntry}(),
+            dataDict::Dict{Symbol, BlobEntry}=Dict{Symbol,BlobEntry}(),
             solvable::Int=1) where {T <: InferenceVariable, P}
     #
     DFGVariable{T}(id, label, timestamp, nstime, tags, estimateDict, solverDataDict, smallData, dataDict, Ref(solvable))
@@ -278,7 +278,7 @@ function DFGVariable(label::Symbol,
             tags::Set{Symbol}=Set{Symbol}(),
             estimateDict::Dict{Symbol, <: AbstractPointParametricEst}=Dict{Symbol, MeanMaxPPE}(),
             smallData::Dict{Symbol, SmallDataTypes}=Dict{Symbol, SmallDataTypes}(),
-            dataDict::Dict{Symbol, <: AbstractBlobEntry}=Dict{Symbol,AbstractBlobEntry}(),
+            dataDict::Dict{Symbol, <: BlobEntry}=Dict{Symbol,BlobEntry}(),
             solvable::Int=1) where {T <: InferenceVariable}
     #
     DFGVariable{T}(id, label, timestamp, nstime, tags, estimateDict, Dict{Symbol, VariableNodeData{T, getPointType(T)}}(:default=>solverData), smallData, dataDict, Ref(solvable))
@@ -341,7 +341,7 @@ Base.@kwdef struct DFGVariableSummary <: AbstractDFGVariable
     variableTypeName::Symbol
     """Dictionary of large data associated with this variable.
     Accessors: [`addDataEntry!`](@ref), [`getBlobEntry`](@ref), [`updateDataEntry!`](@ref), and [`deleteDataEntry!`](@ref)"""
-    dataDict::Dict{Symbol, AbstractBlobEntry}
+    dataDict::Dict{Symbol, BlobEntry}
 end
 
 

src/services/Serialization.jl

@@ -174,7 +174,7 @@ function unpackVariable(variable::PackedVariable; skipVersionCheck::Bool=false)
     solverDict = Dict{Symbol, VariableNodeData{variableType, pointType}}(
         map(sd -> sd.solveKey, variable.solverData) .=> 
         map(sd -> DFG.unpackVariableNodeData(sd), variable.solverData))
-    dataDict = Dict{Symbol, AbstractBlobEntry}(map(de -> de.label, variable.dataEntries) .=> variable.dataEntries)
+    dataDict = Dict{Symbol, BlobEntry}(map(de -> de.label, variable.dataEntries) .=> variable.dataEntries)
     metadata = JSON3.read(base64decode(variable.metadata), Dict{Symbol, DFG.SmallDataTypes})
 
     return DFGVariable(

test/interfaceTests.jl

@@ -61,7 +61,11 @@ end
     @test printVariable(iobuf, var1, skipfields=[:timestamp, :solver, :ppe, :nstime]) === nothing
 
     # for julia v1.6
-    @test String(take!(iobuf)) == "DFGVariable{TestVariableType1}\nid:\nnothing\nlabel:\n:a\ntags:\nSet([:VARIABLE, :POSE])\nsmallData:\nDict{Symbol, Union{Bool, Float64, Int64, Vector{Bool}, Vector{Float64}, Vector{Int64}, Vector{String}, String}}(:small=>\"data\")\ndataDict:\nDict{Symbol, DistributedFactorGraphs.AbstractBlobEntry}()\nsolvable:\n0\n"   
+    if DistributedFactorGraphs._getDFGVersion() < v"0.19"
+        @test String(take!(iobuf)) == "DFGVariable{TestVariableType1}\nid:\nnothing\nlabel:\n:a\ntags:\nSet([:VARIABLE, :POSE])\nsmallData:\nDict{Symbol, Union{Bool, Float64, Int64, Vector{Bool}, Vector{Float64}, Vector{Int64}, Vector{String}, String}}(:small=>\"data\")\ndataDict:\nDict{Symbol, DistributedFactorGraphs.BlobEntry}()\nsolvable:\n0\n"   
+    else
+        @test String(take!(iobuf)) == "DFGVariable{TestVariableType1}\nid:\nnothing\nlabel:\n:a\ntags:\nSet([:VARIABLE, :POSE])\nsmallData:\nDict{Symbol, Union{Bool, Float64, Int64, Vector{Bool}, Vector{Float64}, Vector{Int64}, Vector{String}, String}}(:small=>\"data\")\ndataDict:\nDict{Symbol, BlobEntry}()\nsolvable:\n0\n"   
+    end
 
     @test printVariable(iobuf, var1, short=true) === nothing
     varstr = String(take!(iobuf))