Add ability to delete or export user info for compliance purposes. he…

…roiclabs#182
ant642507com · Apr 22, 2018 · 5fd576f · 5fd576f
1 parent 447c07c
commit 5fd576f
Show file tree

Hide file tree

Showing 16 changed files with 599 additions and 50 deletions.
diff --git a/Gopkg.lock b/Gopkg.lock
diff --git a/console/console.pb.go b/console/console.pb.go
diff --git a/console/console.proto b/console/console.proto
@@ -74,8 +74,14 @@ service Console {
 message AccountExport {
   // The user's account details.
   nakama.api.Account account = 1;
+  // The user's storage.
+  repeated nakama.api.StorageObject objects = 2;
+  // The user's friends.
+  repeated nakama.api.Friend friends = 3;
   // The user's groups.
-  repeated nakama.api.Group groups = 2;
+  repeated nakama.api.Group groups = 4;
+  // The user's notifications.
+  repeated nakama.api.Notification notifications = 5;
 }
 
 /**

diff --git a/console/console.swagger.json b/console/console.swagger.json
@@ -142,6 +142,21 @@
       },
       "description": "Send a device to the server. Used with authenticate/link/unlink and user."
     },
+    "apiFriend": {
+      "type": "object",
+      "properties": {
+        "user": {
+          "$ref": "#/definitions/apiUser",
+          "description": "The user object."
+        },
+        "state": {
+          "type": "integer",
+          "format": "int32",
+          "description": "The friend status."
+        }
+      },
+      "description": "A friend of a user."
+    },
     "apiGroup": {
       "type": "object",
       "properties": {
@@ -196,6 +211,89 @@
       },
       "description": "A group in the server."
     },
+    "apiNotification": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "ID of the Notification."
+        },
+        "subject": {
+          "type": "string",
+          "description": "Subject of the notification."
+        },
+        "content": {
+          "type": "string",
+          "description": "Content of the notification in JSON."
+        },
+        "code": {
+          "type": "integer",
+          "format": "int32",
+          "description": "Category code for this notification."
+        },
+        "sender_id": {
+          "type": "string",
+          "description": "ID of the sender, if a user. Otherwise 'null'."
+        },
+        "create_time": {
+          "type": "string",
+          "format": "date-time",
+          "description": "The UNIX time when the notification was created."
+        },
+        "persistent": {
+          "type": "boolean",
+          "format": "boolean",
+          "description": "True if this notification was persisted to the database."
+        }
+      },
+      "description": "A notification in the server."
+    },
+    "apiStorageObject": {
+      "type": "object",
+      "properties": {
+        "collection": {
+          "type": "string",
+          "description": "The collection which stores the object."
+        },
+        "key": {
+          "type": "string",
+          "description": "The key of the object within the collection."
+        },
+        "user_id": {
+          "type": "string",
+          "description": "The user owner of the object."
+        },
+        "value": {
+          "type": "string",
+          "description": "The value of the object."
+        },
+        "version": {
+          "type": "string",
+          "description": "The version hash of the object."
+        },
+        "permission_read": {
+          "type": "integer",
+          "format": "int32",
+          "description": "The read access permissions for the object."
+        },
+        "permission_write": {
+          "type": "integer",
+          "format": "int32",
+          "description": "The write access permissions for the object."
+        },
+        "create_time": {
+          "type": "string",
+          "format": "date-time",
+          "description": "The UNIX time when the object was created."
+        },
+        "update_time": {
+          "type": "string",
+          "format": "date-time",
+          "description": "The UNIX time when the object was last updated."
+        }
+      },
+      "description": "An object within the storage engine."
+    },
     "apiUser": {
       "type": "object",
       "properties": {
@@ -277,12 +375,33 @@
           "$ref": "#/definitions/apiAccount",
           "description": "The user's account details."
         },
+        "objects": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/apiStorageObject"
+          },
+          "description": "The user's storage."
+        },
+        "friends": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/apiFriend"
+          },
+          "description": "The user's friends."
+        },
         "groups": {
           "type": "array",
           "items": {
             "$ref": "#/definitions/apiGroup"
           },
           "description": "The user's groups."
+        },
+        "notifications": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/apiNotification"
+          },
+          "description": "The user's notifications."
         }
       },
       "description": "*\nAn export of all information stored for a user account."

diff --git a/main.go b/main.go
@@ -27,6 +27,9 @@ import (
 	"syscall"
 	"time"
 
+	"io/ioutil"
+	"path/filepath"
+
 	"github.com/golang/protobuf/jsonpb"
 	"github.com/heroiclabs/nakama/ga"
 	"github.com/heroiclabs/nakama/migrate"
@@ -35,8 +38,6 @@ import (
 	_ "github.com/lib/pq"
 	"github.com/satori/go.uuid"
 	"go.uber.org/zap"
-	"io/ioutil"
-	"path/filepath"
 )
 
 const cookieFilename = ".cookie"
@@ -115,6 +116,8 @@ func main() {
 	runtimePool := server.NewRuntimePool(jsonLogger, multiLogger, db, config, socialClient, sessionRegistry, matchRegistry, tracker, router, stdLibs, modules, regCallbacks, once)
 	pipeline := server.NewPipeline(config, db, jsonpbMarshaler, jsonpbUnmarshaler, sessionRegistry, matchRegistry, tracker, router, runtimePool)
 	metrics := server.NewMetrics(multiLogger, config)
+
+	consoleServer := server.StartConsoleServer(jsonLogger, multiLogger, config, db)
 	apiServer := server.StartApiServer(jsonLogger, multiLogger, db, jsonpbMarshaler, jsonpbUnmarshaler, config, socialClient, sessionRegistry, matchRegistry, tracker, router, pipeline, runtimePool)
 
 	gaenabled := len(os.Getenv("NAKAMA_TELEMETRY")) < 1
@@ -136,6 +139,7 @@ func main() {
 
 	// Gracefully stop server components.
 	apiServer.Stop()
+	consoleServer.Stop()
 	metrics.Stop(jsonLogger)
 	matchRegistry.Stop()
 	tracker.Stop()