Deprecate User Robot Session in favour of using Graph and Agent (#1100)

Author: Affie

NEWS.md

@@ -1,12 +1,16 @@
 Listing news on any major breaking changes in DFG.  For regular changes, see integrated Github.com project milestones for DFG.
 
-# v0.24
+# v0.25
 - Deprecated nouns:
     SessionBlobEntry -> GraphBlobEntry
     RobotBlobEntry -> AgentBlobEntry
     UserBlobEntry -> AgentBlobEntry
     RobotData -> AgentMetadata
-    SessionData -> GraphMetadata 
+    SessionData -> GraphMetadata
+    UserLabel -> AgentLabel
+    RobotLabel -> AgentLabel
+    SessionLabel -> GraphLabel
+- v0.24 FileDFGs can be loaded with v0.25 with the exception of the User[Label/Data/BlobEntries]
 
 # v0.24
 

docs/src/GraphData.md

@@ -174,19 +174,17 @@ getSmallData(x0)
 ## Graph-Related Data
 
 DFG can store data in the graph itself (as opposed to inside graph elements).
-When you retrieve graphs from a database, this information is carried along. If
-you are working with an in-memory graph, the structure is flattened into the
-graph itself as `userData`, `robotData`, and `sessionData`.
+When you retrieve distributed factor graphs from a database, this information is carried along. If
+you are working with an in-memory graph, the DFG structure contains the graph itself as well as
+`Agent` and `Graph` data.
 
 Graphs reside inside a hierarchy made up in the following way:
-- User1
-  - Robot1
-    - Session1 (the graph itself)
-- User2
-  - Robot2
-  - Robot3
-    - Session2
-    - Session3
+- Agent
+  - Metadata
+  - BlobEntries
+- Graph
+  - Metadata
+  - BlobEntries
 
 This data can be retrieved with the follow functions:
 

ext/DFGPlots.jl

@@ -83,58 +83,4 @@ function gplot(dfg::GraphsDFG; keyargs...)
     return gplot(dfg.g; keyargs...)
 end
 
-#TODO decide if we want to overload show for display in juno, It's a bit annoying with development
-# function Base.show(io::IO, ::MIME"application/prs.juno.plotpane+html", dfg::AbstractDFG)
-function plotDFG(io::IO, ::MIME"application/prs.juno.plotpane+html", dfg::AbstractDFG)
-    if length(ls(dfg)) != 0
-        size = get(io, :juno_plotsize, [100, 100])
-
-        plot_output = IOBuffer()
-        GraphPlot.draw(
-            GraphPlot.SVGJS(
-                plot_output,
-                GraphPlot.Compose.default_graphic_width,
-                GraphPlot.Compose.default_graphic_width,
-                false,
-            ),
-            plotDFG(dfg),
-        )
-        plotsvg = String(take!(plot_output))
-
-        print(
-            io,
-            """
-                <div style="
-                background-color: #eee;
-                color: #222;
-                width: $(size[1]-40)px;
-                height: $(size[2]-40)px;
-                position: absolute;
-                top: 0;
-                left: 0;
-                padding: 20px;
-                margin: 0;
-                ">
-                $(typeof(dfg))
-                <ul>
-                    <li>$(getUserLabel(dfg))</li>
-                    <li>$(getRobotLabel(dfg))</li>
-                    <li>$(getSessionLabel(dfg))</li>
-                    <li>$(getDescription(dfg))</li>
-                </ul>
-                <script charset="utf-8">
-                    $(read(GraphPlot.Compose.snapsvgjs, String))
-                </script>
-                <script charset="utf-8">
-                    $(read(GraphPlot.gadflyjs, String))
-                </script>
-                $(plotsvg)
-                </div>
-            """,
-        )
-    else
-        Base.show(io, dfg)
-    end
-end
-
 end

src/Common.jl

@@ -72,24 +72,15 @@ sortDFG(vars::Vector{Symbol}; lt = natural_lt, kwargs...) = sort(vars; lt = lt,
 ##==============================================================================
 ## Validation of session, robot, and user labels.
 ##==============================================================================
-global _invalidIds = [
-    "USER",
-    "ROBOT",
-    "SESSION",
-    "AGENT",
-    "VARIABLE",
-    "FACTOR",
-    "PPE",
-    "BLOB_ENTRY",
-    "FACTORGRAPH",
-]
+global _invalidIds =
+    ["GRAPH", "AGENT", "VARIABLE", "FACTOR", "PPE", "BLOB_ENTRY", "FACTORGRAPH"]
 
 const global _validLabelRegex::Regex = r"^[a-zA-Z][-\w\.\@]*$"
 
 """
 $(SIGNATURES)
 
-Returns true if the label is valid for a session, robot, or user ID.
+Returns true if the label is valid for node.
 """
 function isValidLabel(id::Union{Symbol, String})
     if typeof(id) == Symbol

src/DataBlobs/entities/BlobEntry.jl

@@ -7,11 +7,10 @@
     $(TYPEDEF)
 
 A `BlobEntry` is a small about of structured data that holds reference information to find an actual blob. Many `BlobEntry`s 
-can exist on different graph nodes spanning Robots, and Sessions which can all reference the same `Blob`.  A `BlobEntry` 
-is also a equivalent to a bridging entry between local `.originId` and a remotely assigned `.blobIds`.
+can exist on different graph nodes spanning Agents and Factor Graphs which can all reference the same `Blob`.
 
 Notes:
-- All `.blobId`s are unique across the entire distributed system and are immutable.  The `.originId` should be globally unique except for stochastic `uuid4` collisions that cannot be checked from a main reference owing to practical limitations such as network connectivity.
+- `blobId`s should be unique within a blobstore and are immutable.
 """
 Base.@kwdef struct BlobEntry
     """ Remotely assigned and globally unique identifier for the `BlobEntry` itself (not the `.blobId`). """
@@ -26,7 +25,7 @@ Base.@kwdef struct BlobEntry
     blobstore::Symbol = :default
     """ A hash value to ensure data consistency which must correspond to the stored hash upon retrieval.  Use `bytes2hex(sha256(blob))`. [Legacy: some usage functions allow the check to be skipped if needed.] """
     hash::String = ""# Probably https://docs.julialang.org/en/v1/stdlib/SHA
-    """ Context from which a BlobEntry=>Blob was first created. E.g. user|robot|session|varlabel. """
+    """ Context from which a BlobEntry=>Blob was first created. E.g. agent|graph|varlabel. """
     origin::String = ""
     """ number of bytes in blob as a string"""
     size::Union{String, Nothing} = "" #TODO remove union, use "" as nothing

src/DataBlobs/services/BlobEntry.jl

@@ -15,10 +15,10 @@ end
 
 """
     $(SIGNATURES)
-Function to generate source string - userLabel|robotLabel|sessionLabel|varLabel
+Function to generate source string - agentLabel|graphLabel|varLabel
 """
 function buildSourceString(dfg::AbstractDFG, label::Symbol)
-    return "$(getUserLabel(dfg))|$(getRobotLabel(dfg))|$(getSessionLabel(dfg))|$label"
+    return "$(getAgentLabel(dfg))|$(getGraphLabel(dfg))|$label"
 end
 
 ##==============================================================================

src/Deprecated.jl

@@ -31,10 +31,13 @@
 @deprecate setRobotData!(args...) setAgentMetadata!(args...)
 @deprecate setSessionData!(args...) setGraphMetadata!(args...)
 
-#TODO 
-# @deprecate getUserLabel(dfg) getAgentLabel(dfg)
-# @deprecate getRobotLabel(dfg) getAgentLabel(dfg)
-# @deprecate getSessionLabel(dfg) getGraphLabel(dfg)
+@deprecate getUserLabel(dfg) getAgentLabel(dfg)
+@deprecate getRobotLabel(dfg) getAgentLabel(dfg)
+@deprecate getSessionLabel(dfg) getGraphLabel(dfg)
+
+export DFGSummary
+DFGSummary(args) = error("DFGSummary is deprecated")
+@deprecate getSummary(dfg::AbstractDFG) getSummaryGraph(dfg)
 
 ## ================================================================================
 ## Deprecated in v0.24

src/DistributedFactorGraphs.jl

@@ -64,7 +64,6 @@ export AbstractParams, NoSolverParams
 export AbstractBlobStore
 
 # accessors & crud
-export getUserLabel, getRobotLabel, getSessionLabel
 export getDFGInfo
 export getDescription,
     setDescription!,
@@ -95,9 +94,10 @@ export getBlobStore,
     addBlobStore!, updateBlobStore!, deleteBlobStore!, emptyBlobStore!, listBlobStores
 
 # TODO Not sure these are needed or should work everywhere, implement in cloud?
-export updateAgentMetadata!,
-    updateGraphMetadata!, deleteAgentMetadata!, deleteGraphMetadata!
-export emptyAgentMetadata!, emptyGraphMetadata!
+# NOTE not exporiting these for now. For consistency `get` and `set` might work better.
+# export updateAgentMetadata!,
+#     updateGraphMetadata!, deleteAgentMetadata!, deleteGraphMetadata!
+# export emptyAgentMetadata!, emptyGraphMetadata!
 
 # Graph Types: exported from modules or @reexport
 export InMemoryDFGTypes, LocalDFG
@@ -127,10 +127,7 @@ export isConnected
 
 export getBiadjacencyMatrix
 
-#summary structure
-export DFGSummary
-
-export getSummary, getSummaryGraph
+export getSummaryGraph
 
 # Abstract Nodes
 export DFGNode, AbstractDFGVariable, AbstractDFGFactor
@@ -148,6 +145,8 @@ export getVariableLabelNumber
 # accessors
 export getLabel, getTimestamp, setTimestamp, setTimestamp!, getTags, setTags!
 
+export getAgentLabel, getGraphLabel
+
 # Node Data
 export isSolveInProgress, getSolveInProgress
 
@@ -341,8 +340,6 @@ include("entities/DFGFactor.jl")
 
 include("entities/DFGVariable.jl")
 
-include("entities/AbstractDFGSummary.jl")
-
 include("entities/Agent.jl")
 
 include("services/AbstractDFG.jl")

src/GraphsDFG/FactorGraphs/FactorGraphs.jl

@@ -139,9 +139,8 @@ function addFactor!(
         (@error "Label $(factor.label) already in fg"; return false)
 
     for vlabel in variableLabels
-        !haskey(g.labels, vlabel) && (
-            throw(KeyError(vlabel))
-            # @error "Variable '$(vlabel)' not found in graph when creating Factor '$(factor.label)'"; return false
+        !haskey(g.labels, vlabel) && (throw(KeyError(vlabel))
+        # @error "Variable '$(vlabel)' not found in graph when creating Factor '$(factor.label)'"; return false
         ) #TODO debug error or exception?
     end
 

src/GraphsDFG/GraphsDFG.jl

@@ -8,8 +8,7 @@ using OrderedCollections
 using StructTypes
 
 using ...DistributedFactorGraphs
-
-# import ...DistributedFactorGraphs: AbstractDFG, DFGNode, AbstractDFGVariable, AbstractDFGFactor, DFGSummary, AbstractParams, NoSolverParams, DFGVariable, DFGFactor
+using ...DistributedFactorGraphs: Agent
 
 # import DFG functions to extend
 import ...DistributedFactorGraphs: