Merge pull request #917 from JuliaRobotics/22Q4/enh/incrdesuff

incrDataLabelSuffix

Author: dehann

Project.toml

@@ -1,6 +1,6 @@
 name = "DistributedFactorGraphs"
 uuid = "b5cc3c7e-6572-11e9-2517-99fb8daf2f04"
-version = "0.18.8"
+version = "0.18.9"
 
 [deps]
 Base64 = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"

src/DataBlobs/services/AbstractDataEntries.jl

@@ -217,4 +217,47 @@ function mergeDataEntries!(
     if 0  < length(des)
         union(((s->mergeDataEntries!(dst, dlbl, src, slbl, s.id)).(des))...)
     end
-end
+end
+
+"""
+    $SIGNATURES
+
+If the blob label `datalabel` already exists, then this function will return the name `datalabel_1`.
+If the blob label `datalabel_1` already exists, then this function will return the name `datalabel_2`.
+"""
+function incrDataLabelSuffix(
+    dfg::AbstractDFG,
+    vla,
+    bllb::S; 
+    datalabel=Ref("")
+) where {S <: Union{Symbol, <:AbstractString}}
+    count = 1
+    hasund = false
+    len = 0
+    try
+        de,_ = getData(dfg, Symbol(vla), bllb)
+        bllb = string(bllb)
+        # bllb *= bllb[end] != '_' ? "_" : ""
+        datalabel[] = string(de.label)
+        dlb = match(r"\d*", reverse(datalabel[]))
+        # slightly complicated search if blob name already has an underscore number suffix, e.g. `_4`
+        count, hasund, len = if occursin(Regex(dlb.match*"_"), reverse(datalabel[]))
+            parse(Int, dlb.match |> reverse)+1, true, length(dlb.match)
+        else
+            1, datalabel[][end] == '_', 0
+        end
+    catch err
+        # append latest count
+        if !(err isa KeyError)
+        throw(err)
+        end
+    end
+    # the piece from old label without the suffix count number
+    bllb = datalabel[][1:(end-len)]
+    if !hasund || bllb[end] != '_'
+        bllb *= "_"
+    end
+    bllb *= string(count)
+
+    S(bllb)
+end

src/DistributedFactorGraphs.jl

@@ -192,12 +192,14 @@ export getSolvedCount, isSolved, setSolvedCount!, isInitialized, isMarginalized,
 export getNeighborhood, getNeighbors, _getDuplicatedEmptyDFG
 export findFactorsBetweenNaive
 export copyGraph!, deepcopyGraph, deepcopyGraph!, buildSubgraph, mergeGraph!
-# Big Data
+
+# Entry Blob Data
 ##------------------------------------------------------------------------------
 export addDataEntry!, getDataEntry, updateDataEntry!, deleteDataEntry!, getDataEntries, listDataEntries, hasDataEntry, hasDataEntry
 export listDataEntrySequence
 # convenience wrappers
 export addDataEntry!, mergeDataEntries!
+export incrDataLabelSuffix
 # aliases
 export addData!
 

test/consol_DataEntryBlobTests.jl

@@ -92,8 +92,16 @@ ds = FolderStore{Vector{UInt8}}(:filestore, "/tmp/dfgFolderStore")
 addBlobStore!(dfg, ds)
 
 ade,adb = addData!(dfg, :filestore, :x1, :random, dataset1)
+_,_     = addData!(dfg, :filestore, :x1, :another_1, dataset1)
 gde,gdb = getData(dfg, :x1, :random)
+
+@test incrDataLabelSuffix(dfg,:x1,:random) == :random_1
+@test incrDataLabelSuffix(dfg,:x1,:another_1) == :another_2
+# @test incrDataLabelSuffix(dfg,:x1,:another) == :another_2 # TODO exand support for Regex likely search on labels
+# @test incrDataLabelSuffix(dfg,:x1,"random") == "random_1" # TODO expand support for label::String
+
 dde,ddb = deleteData!(dfg, :x1, :random)
+_,_     = deleteData!(dfg, :x1, :another_1)
 
 @test ade == gde == dde
 @test adb == gdb == ddb

test/testBlocks.jl

@@ -1437,6 +1437,10 @@ function ProducingDotFiles(testDFGAPI,
 
     addVariable!(dotdfg, v1)
     addVariable!(dotdfg, v2)
+    # FIXME, fix deprecation
+    # ┌ Warning: addFactor!(dfg, variables, factor) is deprecated, use addFactor!(dfg, factor)
+    # │   caller = ProducingDotFiles(testDFGAPI::Type{GraphsDFG}, v1::Nothing, v2::Nothing, f1::Nothing; VARTYPE::Type{DFGVariable}, FACTYPE::Type{DFGFactor}) at testBlocks.jl:1440
+    # └ @ Main ~/.julia/dev/DistributedFactorGraphs/test/testBlocks.jl:1440
     addFactor!(dotdfg, [v1, v2], f1)
     #NOTE hardcoded toDot will have different results so test LightGraphs seperately
     if testDFGAPI <: LightDFG || testDFGAPI <: GraphsDFG || testDFGAPI <: Neo4jDFG
@@ -1490,7 +1494,8 @@ function CopyFunctionsTest(testDFGAPI; kwargs...)
     @test issetequal(lsf(dcdfg_part), flbls)
 
     # deepcopy subgraph ignoring orphans
-    @test_logs (:warn, r"orphan") dcdfg_part = deepcopyGraph(LightDFG, dfg, vlbls, union(flbls, [:x1x2f1]))
+    # @test_logs (:warn, r"orphan") # orphan warning has been suppressed given overwhelming printouts
+    dcdfg_part = deepcopyGraph(LightDFG, dfg, vlbls, union(flbls, [:x1x2f1]))
     @test issetequal(ls(dcdfg_part), vlbls)
     @test issetequal(lsf(dcdfg_part), flbls)