rename and test Neo4jDFG

Author: dehann

LICENSE

@@ -5,7 +5,7 @@ NOTICE: this license will be relaxed to be much more permissive soon.
 The source code in this repository is separated into two parts 
 that are licensed separately.  The Neo4jDFG library/driver
 is licensed separately.  For more details see: 
-https://github.com/JuliaRobotics/DistributedFactorGraphs.jl/blob/develop/src/CloudGraphsDFG/LICENSE
+https://github.com/JuliaRobotics/DistributedFactorGraphs.jl/blob/develop/src/Neo4jDFG/LICENSE
 
 DistributedFactorGraphs.jl, is not licensed for hosted, webservice or cloud 
 solutions (public or private).  Please contact NavAbility via email at 

docs/make.jl

@@ -18,7 +18,7 @@ makedocs(
         ],
         # "DistributedFactorGraph API's" => [
         #     "LightDFGs" => "apis/LightGraphs.md",
-        #     "CloudGraphsDFGs" => "apis/CloudGraphs.md",
+        #     "Neo4jDFGs" => "apis/CloudGraphs.md",
         # ],
         "Function Reference" => "func_ref.md"
     ]

src/Neo4jDFG/Neo4jDFG.jl

@@ -1,4 +1,4 @@
-module CloudGraphsDFGs
+module Neo4jDFGs
 
 using ...DistributedFactorGraphs
 
@@ -105,13 +105,13 @@ using SparseArrays
 using UUIDs
 
 # Entities
-include("entities/CloudGraphsDFG.jl")
+include("entities/Neo4jDFG.jl")
 include("entities/CGStructure.jl")
 
 # Services
 include("services/CommonFunctions.jl")
 include("services/CGStructure.jl")
-include("services/CloudGraphsDFG.jl")
+include("services/Neo4jDFG.jl")
 
 # Exports
 export Neo4jInstance, Neo4jDFG
@@ -127,4 +127,7 @@ export getSession, getRobot, getUser
 export updateSession, updateRobot, updateUser
 export lsSessions, lsRobots, lsUsers
 
+const CloudGraphsDFG = Neo4jDFG
+# const CloudGraphsDFG{T} = Neo4jDFG{T}
+
 end

src/Neo4jDFG/entities/Neo4jDFG.jl

@@ -5,7 +5,7 @@ mutable struct Neo4jInstance
   graph::Neo4j.Graph
 end
 
-mutable struct CloudGraphsDFG{T <: AbstractParams} <: AbstractDFG{T}
+mutable struct Neo4jDFG{T <: AbstractParams} <: AbstractDFG{T}
     neo4jInstance::Neo4jInstance
     userId::String
     robotId::String
@@ -16,7 +16,7 @@ mutable struct CloudGraphsDFG{T <: AbstractParams} <: AbstractDFG{T}
     blobStores::Dict{Symbol, AbstractBlobStore}
 
     # inner constructor for all constructors in common
-    function CloudGraphsDFG{T}(neo4jInstance::Neo4jInstance,
+    function Neo4jDFG{T}(neo4jInstance::Neo4jInstance,
                                userId::String,
                                robotId::String,
                                sessionId::String,
@@ -55,7 +55,7 @@ end
     $(SIGNATURES)
 Create a new CloudGraphs-based DFG factor graph using a Neo4j.Connection or by specifying the Neo4j connection information
 """
-function CloudGraphsDFG{T}(neo4jConnection::Neo4j.Connection,
+function Neo4jDFG{T}(neo4jConnection::Neo4j.Connection,
                            userId::String,
                            robotId::String,
                            sessionId::String,
@@ -66,11 +66,11 @@ function CloudGraphsDFG{T}(neo4jConnection::Neo4j.Connection,
     graph = Neo4j.getgraph(neo4jConnection)
     neo4jInstance = Neo4jInstance(neo4jConnection, graph)
 
-    return CloudGraphsDFG{T}(neo4jInstance, userId, robotId, sessionId, description, Symbol[], solverParams; kwargs...)
+    return Neo4jDFG{T}(neo4jInstance, userId, robotId, sessionId, description, Symbol[], solverParams; kwargs...)
 
 end
 
-function CloudGraphsDFG{T}(host::String,
+function Neo4jDFG{T}(host::String,
                            port::Int,
                            dbUser::String,
                            dbPassword::String,
@@ -80,22 +80,22 @@ function CloudGraphsDFG{T}(host::String,
                            description::String;
                            kwargs...) where T <: AbstractParams
     neo4jConnection = Neo4j.Connection(host, port=port, user=dbUser, password=dbPassword)
-    return CloudGraphsDFG{T}(neo4jConnection, userId, robotId, sessionId, description; kwargs...)
+    return Neo4jDFG{T}(neo4jConnection, userId, robotId, sessionId, description; kwargs...)
 end
 
 # construct using the default settings for localhost
-function CloudGraphsDFG(; hostname="localhost",
+function Neo4jDFG(; hostname="localhost",
                           port=7474,
                           username="neo4j",
                           password="test",
                           userId::String="DefaultUser",
                           robotId::String="DefaultRobot",
                           sessionId::String="Session_$(string(uuid4())[1:6])", #TODO randstring(['a':'z';'A':'Z'],1) ipv Session
-                          description::String="CloudGraphsDFG implementation",
+                          description::String="Neo4jDFG implementation",
                           solverParams::T=NoSolverParams(),
                           kwargs...) where T <: AbstractParams
 
-    return CloudGraphsDFG{T}(hostname,
+    return Neo4jDFG{T}(hostname,
                              port,
                              username,
                              password,
@@ -107,7 +107,7 @@ function CloudGraphsDFG(; hostname="localhost",
                              kwargs...)
 end
 
-function CloudGraphsDFG(description::String,
+function Neo4jDFG(description::String,
                         userId::String,
                         robotId::String,
                         sessionId::String,
@@ -120,7 +120,7 @@ function CloudGraphsDFG(description::String,
                         dbUser::String = "neo4j",
                         dbPassword::String = "test")
 
-    return CloudGraphsDFG{typeof(solverParams)}(host,
+    return Neo4jDFG{typeof(solverParams)}(host,
                                                 port,
                                                 dbUser,
                                                 dbPassword,
@@ -136,8 +136,8 @@ function CloudGraphsDFG(description::String,
 
 end
 
-function show(io::IO, ::MIME"text/plain", c::CloudGraphsDFG)
-    println(io, "CloudGraphsDFG:")
+function show(io::IO, ::MIME"text/plain", c::Neo4jDFG)
+    println(io, "Neo4jDFG:")
     println(io, " - Neo4J instance: $(c.neo4jInstance.connection.host)")
     println(io, " - Session: $(c.userId):$(c.robotId):$(c.sessionId)")
     println(io, " - Description: ", c.description)

src/Neo4jDFG/services/CGStructure.jl

@@ -54,7 +54,7 @@ function _convertDictToUser(dict::Dict{String, Any})::User
     return user
 end
 
-function createUser(dfg::CloudGraphsDFG, user::User)::User
+function createUser(dfg::Neo4jDFG, user::User)::User
     Symbol(dfg.userId) != user.id && error("DFG user ID must match user's ID")
     !isValidLabel(user) && error("Node cannot have an ID '$(user.id)'.")
 
@@ -64,7 +64,7 @@ function createUser(dfg::CloudGraphsDFG, user::User)::User
     return user
 end
 
-function createRobot(dfg::CloudGraphsDFG, robot::Robot)::Robot
+function createRobot(dfg::Neo4jDFG, robot::Robot)::Robot
     Symbol(dfg.robotId) != robot.id && error("DFG robot ID must match robot's ID")
     Symbol(dfg.userId) != robot.userId && error("DFG user ID must match robot's user ID")
     !isValidLabel(robot) && error("Node cannot have an ID '$(robot.id)'.")
@@ -84,7 +84,7 @@ function createRobot(dfg::CloudGraphsDFG, robot::Robot)::Robot
     return robot
 end
 
-function createSession(dfg::CloudGraphsDFG, session::Session)::Session
+function createSession(dfg::Neo4jDFG, session::Session)::Session
     Symbol(dfg.robotId) != session.robotId && error("DFG robot ID must match session's robot ID")
     Symbol(dfg.userId) != session.userId && error("DFG user ID must match session's->robot's->user ID")
     !isValidLabel(session) && error("Node cannot have an ID '$(session.id)'.")
@@ -108,7 +108,7 @@ end
 $(SIGNATURES)
 Shortcut method to create the user, robot, and session if it doesn't already exist.
 """
-function createDfgSessionIfNotExist(dfg::CloudGraphsDFG)::Session
+function createDfgSessionIfNotExist(dfg::Neo4jDFG)::Session
     strip(dfg.userId) == "" && error("User ID is not populated in DFG.")
     strip(dfg.robotId) == "" && error("Robot ID is not populated in DFG.")
     strip(dfg.sessionId) == "" && error("Session ID is not populated in DFG.")
@@ -130,7 +130,7 @@ $(SIGNATURES)
 List all sessions for the specified DFG's robot and user.
 Returns nothing if it isn't found.
 """
-function lsSessions(dfg::CloudGraphsDFG)::Vector{Session}
+function lsSessions(dfg::Neo4jDFG)::Vector{Session}
     sessionNodes = _getNeoNodesFromCyphonQuery(dfg.neo4jInstance, "(node:SESSION:$(dfg.robotId):$(dfg.userId))")
     return map(s -> _convertDictToSession(Neo4j.getnodeproperties(s)), sessionNodes)
 end
@@ -140,7 +140,7 @@ $(SIGNATURES)
 List all robots for the specified DFG's user.
 Returns nothing if it isn't found.
 """
-function lsRobots(dfg::CloudGraphsDFG)::Vector{Robot}
+function lsRobots(dfg::Neo4jDFG)::Vector{Robot}
     robotNodes = _getNeoNodesFromCyphonQuery(dfg.neo4jInstance, "(node:ROBOT:$(dfg.userId))")
     return map(s -> _convertDictToRobot(Neo4j.getnodeproperties(s)), robotNodes)
 end
@@ -150,7 +150,7 @@ $(SIGNATURES)
 List all users.
 Returns nothing if it isn't found.
 """
-function lsUsers(dfg::CloudGraphsDFG)::Vector{User}
+function lsUsers(dfg::Neo4jDFG)::Vector{User}
     userNodes = _getNeoNodesFromCyphonQuery(dfg.neo4jInstance, "(node:USER)")
     return map(s -> _convertDictToUser(Neo4j.getnodeproperties(s)), userNodes)
 end
@@ -160,7 +160,7 @@ $(SIGNATURES)
 Get a session specified by userId:robotId:sessionId.
 Returns nothing if it isn't found.
 """
-function getSession(dfg::CloudGraphsDFG, userId::Symbol, robotId::Symbol, sessionId::Symbol)::Union{Session, Nothing}
+function getSession(dfg::Neo4jDFG, userId::Symbol, robotId::Symbol, sessionId::Symbol)::Union{Session, Nothing}
     !isValidLabel(userId) && error("Can't retrieve session with user ID '$(userId)'.")
     !isValidLabel(robotId) && error("Can't retrieve session with robot ID '$(robotId)'.")
     !isValidLabel(sessionId) && error("Can't retrieve session with session ID '$(sessionId)'.")
@@ -175,7 +175,7 @@ $(SIGNATURES)
 Get the session specified by the DFG object.
 Returns nothing if it isn't found.
 """
-function getSession(dfg::CloudGraphsDFG)::Union{Nothing, Session}
+function getSession(dfg::Neo4jDFG)::Union{Nothing, Session}
     return getSession(dfg, Symbol(dfg.userId), Symbol(dfg.robotId), Symbol(dfg.sessionId))
 end
 
@@ -184,7 +184,7 @@ $(SIGNATURES)
 Get a robot specified by userId:robotId.
 Returns nothing if it isn't found.
 """
-function getRobot(dfg::CloudGraphsDFG, userId::Symbol, robotId::Symbol)::Union{Robot, Nothing}
+function getRobot(dfg::Neo4jDFG, userId::Symbol, robotId::Symbol)::Union{Robot, Nothing}
     !isValidLabel(userId) && error("Can't retrieve robot with user ID '$(userId)'.")
     !isValidLabel(robotId) && error("Can't retrieve robot with robot ID '$(robotId)'.")
     robotNode = _getNeoNodesFromCyphonQuery(dfg.neo4jInstance, "(node:ROBOT:$(robotId):$(userId))")
@@ -198,7 +198,7 @@ $(SIGNATURES)
 Get the robot specified by the DFG object.
 Returns nothing if it isn't found.
 """
-function getRobot(dfg::CloudGraphsDFG)::Union{Nothing, Robot}
+function getRobot(dfg::Neo4jDFG)::Union{Nothing, Robot}
     return getRobot(dfg, Symbol(dfg.userId), Symbol(dfg.robotId))
 end
 
@@ -207,7 +207,7 @@ $(SIGNATURES)
 Get a user specified by userId.
 Returns nothing if it isn't found.
 """
-function getUser(dfg::CloudGraphsDFG, userId::Symbol)::Union{User, Nothing}
+function getUser(dfg::Neo4jDFG, userId::Symbol)::Union{User, Nothing}
     !isValidLabel(userId) && error("Can't retrieve user with user ID '$(userId)'.")
     userNode = _getNeoNodesFromCyphonQuery(dfg.neo4jInstance, "(node:USER:$(userId))")
     length(userNode) == 0 && return nothing
@@ -220,7 +220,7 @@ $(SIGNATURES)
 Get the user specified by the DFG object.
 Returns nothing if it isn't found.
 """
-function getUser(dfg::CloudGraphsDFG)::Union{Nothing, User}
+function getUser(dfg::Neo4jDFG)::Union{Nothing, User}
     return getUser(dfg, Symbol(dfg.userId))
 end
 
@@ -229,7 +229,7 @@ end
     $(SIGNATURES)
 DANGER: Clears the whole session from the database.
 """
-function clearSession!!(dfg::CloudGraphsDFG)::Nothing
+function clearSession!!(dfg::Neo4jDFG)::Nothing
     # Perform detach+deletion
     _queryNeo4j(dfg.neo4jInstance, "match (node:$(dfg.userId):$(dfg.robotId):$(dfg.sessionId)) detach delete node ")
 
@@ -242,7 +242,7 @@ end
     $(SIGNATURES)
 DANGER: Clears the whole robot + sessions from the database.
 """
-function clearRobot!!(dfg::CloudGraphsDFG)::Nothing
+function clearRobot!!(dfg::Neo4jDFG)::Nothing
     # Perform detach+deletion
     _queryNeo4j(dfg.neo4jInstance, "match (node:$(dfg.userId):$(dfg.robotId)) detach delete node ")
 
@@ -255,7 +255,7 @@ end
     $(SIGNATURES)
 DANGER: Clears the whole user + robot + sessions from the database.
 """
-function clearUser!!(dfg::CloudGraphsDFG)::Nothing
+function clearUser!!(dfg::Neo4jDFG)::Nothing
     # Perform detach+deletion
     _queryNeo4j(dfg.neo4jInstance, "match (node:$(dfg.userId)) detach delete node ")
 
@@ -269,7 +269,7 @@ end
 DANGER: Copies and overwrites the destination session.
 If no destination specified then it creates a unique one.
 """
-function copySession!(sourceDFG::CloudGraphsDFG, destDFG::Union{Nothing, CloudGraphsDFG})::CloudGraphsDFG
+function copySession!(sourceDFG::Neo4jDFG, destDFG::Union{Nothing, Neo4jDFG})::Neo4jDFG
     if destDFG == nothing
         destDFG = _getDuplicatedEmptyDFG(sourceDFG)
     end
@@ -280,4 +280,4 @@ end
     $(SIGNATURES)
 DANGER: Copies the source to a new unique destination.
 """
-copySession!(sourceDFG::CloudGraphsDFG)::CloudGraphsDFG = copySession!(sourceDFG, nothing)
+copySession!(sourceDFG::Neo4jDFG)::Neo4jDFG = copySession!(sourceDFG, nothing)

src/Neo4jDFG/services/CommonFunctions.jl

@@ -209,7 +209,7 @@ $(SIGNATURES)
 
 Get the Neo4j labels for any node type.
 """
-function _getLabelsForType(dfg::CloudGraphsDFG,
+function _getLabelsForType(dfg::Neo4jDFG,
         type::Type;
         parentKey::Union{Nothing, Symbol}=nothing)
     # Simple validation
@@ -241,7 +241,7 @@ $(SIGNATURES)
 
 Get the Neo4j labels for any node instance.
 """
-function _getLabelsForInst(dfg::CloudGraphsDFG,
+function _getLabelsForInst(dfg::Neo4jDFG,
                             inst::Union{User, Robot, Session, VariableNodeData, N, APPE, ABDE};
                             parentKey::Union{Nothing, Symbol}=nothing)::Vector{String} where
                             {N <: DFGNode, APPE <: AbstractPointParametricEst, ABDE <: AbstractDataEntry}
@@ -256,7 +256,7 @@ end
 
 ## Common CRUD calls for subnode types (PPEs, VariableSolverData, BigData)
 
-function _listVarSubnodesForType(dfg::CloudGraphsDFG, variablekey::Symbol, dfgType::Type, keyToReturn::String; currentTransaction::Union{Nothing, Neo4j.Transaction}=nothing)
+function _listVarSubnodesForType(dfg::Neo4jDFG, variablekey::Symbol, dfgType::Type, keyToReturn::String; currentTransaction::Union{Nothing, Neo4j.Transaction}=nothing)
     query = "match (subnode:$(join(_getLabelsForType(dfg, dfgType, parentKey=variablekey),':'))) return subnode.$keyToReturn"
     @debug "[Query] _listVarSubnodesForType query:\r\n$query"
     result = nothing
@@ -272,7 +272,7 @@ function _listVarSubnodesForType(dfg::CloudGraphsDFG, variablekey::Symbol, dfgTy
     return Symbol.(vals)
 end
 
-function _getVarSubnodeProperties(dfg::CloudGraphsDFG, variablekey::Symbol, dfgType::Type, nodeKey::Symbol; currentTransaction::Union{Nothing, Neo4j.Transaction}=nothing)
+function _getVarSubnodeProperties(dfg::Neo4jDFG, variablekey::Symbol, dfgType::Type, nodeKey::Symbol; currentTransaction::Union{Nothing, Neo4j.Transaction}=nothing)
     query = "match (subnode:$(join(_getLabelsForType(dfg, dfgType, parentKey=variablekey),':')):$nodeKey) return properties(subnode)"
     @debug "[Query] _getVarSubnodeProperties query:\r\n$query"
     result = nothing
@@ -290,7 +290,7 @@ function _getVarSubnodeProperties(dfg::CloudGraphsDFG, variablekey::Symbol, dfgT
 end
 
 function _matchmergeVariableSubnode!(
-        dfg::CloudGraphsDFG,
+        dfg::Neo4jDFG,
         variablekey::Symbol,
         nodeLabels::Vector{String},
         subnode::Union{APPE, ABDE, PVND},
@@ -321,7 +321,7 @@ function _matchmergeVariableSubnode!(
 end
 
 function _deleteVarSubnode!(
-        dfg::CloudGraphsDFG,
+        dfg::Neo4jDFG,
         variablekey::Symbol,
         relationshipKey::Symbol,
         nodeLabels::Vector{String},