Merge pull request #550 from JuliaRobotics/maint/20Q3/datablob_concepts

DataEntry and BlobStore API Standardization

Author: Affie

Project.toml

@@ -16,6 +16,7 @@ LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 Neo4j = "d2adbeaf-5838-5367-8a2f-e46d570981db"
 Reexport = "189a3867-3050-52da-a836-e630ba90ab69"
 Requires = "ae029012-a4dd-5104-9daa-d747884805df"
+SHA = "ea8e919c-243c-51af-8825-aaa63cd721ce"
 SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
 TimeZones = "f269a46b-ccf7-5d73-abea-4c690281aa53"
 Unmarshal = "cbff2730-442d-58d7-89d1-8e530c41eb02"

src/DataBlobs/DataBlobs.jl

@@ -1,18 +1,24 @@
-include("entities/AbstractDataStore.jl")
+# using DataFrames
+# using CSV
+using JSON
+using SHA
+
 include("entities/AbstractDataEntries.jl")
-include("entities/InMemoryDataStore.jl")
-include("entities/FileDataStore.jl")
+# include("entities/BlobStores.jl")
 
-include("services/AbstractDataStore.jl")
 include("services/AbstractDataEntries.jl")
-include("services/InMemoryDataStore.jl")
-include("services/FileDataStore.jl")
+include("services/DataEntryBlob.jl")
+include("services/BlobStores.jl")
+
+include("services/FileDataEntryBlob.jl")
+include("services/InMemoryDataEntryBlob.jl")
 
-export AbstractDataStore
 
 export AbstractDataEntry, GeneralDataEntry, MongodbDataEntry, FileDataEntry
 export InMemoryDataStore, FileDataStore
 
 export getData, addData!, updateData!, deleteData!, listStoreEntries
 export getDataBlob, addDataBlob!, updateDataBlob!, deleteDataBlob!, listDataBlobs
 export copyStore
+
+export getId, getHash, getCreatedTimestamp

src/DataBlobs/entities/AbstractDataEntries.jl

@@ -1,54 +1,50 @@
-"""
-    $(TYPEDEF)
-GeneralDataEntry is a generic multipurpose data entry that creates a unique
-reproducible key using userId_robotId_sessionId_variableId_key.
-"""
-mutable struct GeneralDataEntry <: AbstractDataEntry
-    key::Symbol
-    storeKey::Symbol # Could swap this to string, but using it as an index later, so better as a symbol I believe.
-    createdTimestamp::DateTime
-    lastUpdatedTimestamp::DateTime
-    mimeType::String
-end
+##==============================================================================
+## AbstractDataEntry - Defined in src/entities/AbstractDFG.jl
+##==============================================================================
+# Fields to be implemented
+# label
+# id
 
-"""
-    $(SIGNATURES)
-Internal function to generate a unique key for the entry - userId_robotId_sessionId_variable_key.
-Simple symbol.
-"""
-function _uniqueKey(dfg::G, v::V, key::Symbol)::Symbol where {G <: AbstractDFG, V <: AbstractDFGVariable}
-    key = join(String.([dfg.userId, dfg.robotId, dfg.sessionId, getLabel(v), String(key)]), "_")
-    return Symbol(key)
-end
+getLabel(entry::AbstractDataEntry) = entry.label
+getId(entry::AbstractDataEntry) = entry.id
+getHash(entry::AbstractDataEntry) = hex2bytes(entry.hash)
+getCreatedTimestamp(entry::AbstractDataEntry) = entry.createdTimestamp
 
 
-GeneralDataEntry(key::Symbol, storeKey::Symbol;
-                    mimeType::String="application/octet-stream") =
-                    GeneralDataEntry(key, storeKey, now(), now(), mimeType)
+##==============================================================================
+## BlobStoreEntry
+##==============================================================================
+export BlobStoreEntry
 
-function GeneralDataEntry(dfg::G, var::V, key::Symbol;
-                             mimeType::String="application/octet-stream") where {G <: AbstractDFG, V <: AbstractDFGVariable}
-    return GeneralDataEntry(key, _uniqueKey(dfg, var, key), mimeType=mimeType)
+"""
+    $(TYPEDEF)
+Genaral Data Store Entry.
+"""
+struct BlobStoreEntry <: AbstractDataEntry
+    label::Symbol
+    id::UUID
+    blobstore::Symbol
+    hash::String # Probably https://docs.julialang.org/en/v1/stdlib/SHA
+    origin::String # E.g. user|robot|session|varlabel
+    description::String
+    mimeType::String
+    createdTimestamp::ZonedDateTime # of when the entry was created
 end
 
+# TODO
 """
     $(TYPEDEF)
 Data Entry in MongoDB.
 """
 struct MongodbDataEntry <: AbstractDataEntry
-    key::Symbol
-    oid::NTuple{12, UInt8} #mongodb object id
+    label::Symbol
+    id::UUID
+    oid::NTuple{12, UInt8} #mongodb object id - TODO Not needed with id::UUID unique, but perhaps usefull
+    hash::String
+    createdTimestamp::ZonedDateTime
+    # mongodb
+    # mongoConfig::MongoConfig
     #maybe other fields such as:
     #flags::Bool ready, valid, locked, permissions
     #MIMEType::String
 end
-
-
-"""
-    $(TYPEDEF)
-Data Entry in a file.
-"""
-struct FileDataEntry <: AbstractDataEntry
-    key::Symbol
-    filename::String
-end