Add storage. (heroiclabs#169)

tchigher · Apr 22, 2018 · 093cf4a · 093cf4a
1 parent 97ac0c5
commit 093cf4a
Show file tree

Hide file tree

Showing 120 changed files with 25,955 additions and 448 deletions.
diff --git a/Gopkg.lock b/Gopkg.lock
diff --git a/Gopkg.toml b/Gopkg.toml
@@ -57,3 +57,7 @@
 [[constraint]]
   name = "github.com/gobuffalo/packr"
   revision = "6434a292ac52e6964adebfdce3f9ce6d9f16be01"
+
+[[constraint]]
+  name = "github.com/stretchr/testify"
+  version = "~1.1.4"
diff --git a/api/api.pb.go b/api/api.pb.go
diff --git a/api/api.pb.gw.go b/api/api.pb.gw.go
diff --git a/api/api.proto b/api/api.proto
@@ -173,7 +173,10 @@ service Nakama {
 
   // Delete one or more objects by ID or username.
   rpc DeleteStorageObjects (DeleteStorageObjectsRequest) returns (google.protobuf.Empty) {
-    option (google.api.http).delete = "/v2/storage";
+    option (google.api.http) = {
+      put: "/v2/storage/delete",
+      body: "*"
+    };
   }
 
   // Fetch the current user's account.
@@ -270,7 +273,7 @@ service Nakama {
     option (google.api.http).get = "/v2/notification";
   }
 
-  // List collections of storage objects.
+  // List publicly readable storage objects in a given collection.
   rpc ListStorageObjects (ListStorageObjectsRequest) returns (StorageObjectList) {
     option (google.api.http) = {
       get: "/v2/storage/{collection}",
@@ -601,7 +604,7 @@ message DeleteStorageObjectId {
 // Batch delete storage objects.
 message DeleteStorageObjectsRequest {
   // Batch of storage objects.
-  repeated DeleteStorageObjectId objectIds = 1;
+  repeated DeleteStorageObjectId object_ids = 1;
 }
 
 // A friend of a user.
@@ -711,7 +714,7 @@ message ListNotificationsRequest {
   string cacheable_cursor = 2; // value from NotificationList.cacheable_cursor.
 }
 
-// List storage objects by user ID or collection or both.
+// List publicly readable storage objects in a given collection.
 message ListStorageObjectsRequest {
   // ID of the user.
   string user_id = 1;
@@ -780,7 +783,7 @@ message ReadStorageObjectId {
 // Batch get storage objects.
 message ReadStorageObjectsRequest {
   // Batch of storage objects.
-  repeated ReadStorageObjectId objectIds = 1;
+  repeated ReadStorageObjectId object_ids = 1;
 }
 
 // Execute an Lua function on the server.
@@ -803,28 +806,6 @@ message Session {
   string udp_token = 3; // TODO(zyro): will we remove it?
 }
 
-// The read access permissions for a storage object.
-enum StoragePermissionRead {
-  // Default case. Assumed as OWNER_READ permission.
-  STORAGE_PERMISSION_READ_UNSPECIFIED = 0;
-  // The object does not have client read permissions.
-  NO_READ = 1;
-  // The object may be read by the user owner.
-  OWNER_READ = 2;
-  // The object may be read by any user.
-  PUBLIC_READ = 3;
-}
-
-// The write access permission for a storage object.
-enum StoragePermissionWrite {
-  // Default case. Assumed as OWNER_WRITE permission.
-  STORAGE_PERMISSION_WRITE_UNSPECIFIED = 0;
-  // The object does not have client write permissions.
-  NO_WRITE = 1;
-  // The object may be written by the user owner.
-  OWNER_WRITE = 2;
-}
-
 // An object within the storage engine.
 message StorageObject {
   // The collection which stores the object.
@@ -855,6 +836,8 @@ message StorageObjectAck {
   string key = 2;
   // The version hash of the object.
   string version = 3;
+  // The owner of the object.
+  string user_id = 4;
 }
 
 // Batch of acknowledgements for the storage object write.
@@ -946,9 +929,9 @@ message WriteStorageObject {
   // The version hash of the object to check. Possible values are: ["", "*", "#hash#"].
   string version = 4; // if-match and if-none-match
   // The read access permissions for the object.
-  int32 permission_read = 5;
+  google.protobuf.Int32Value permission_read = 5;
   // The write access permissions for the object.
-  int32 permission_write = 6;
+  google.protobuf.Int32Value permission_write = 6;
 }
 
 // Write objects to the storage engine.

diff --git a/api/api.swagger.json b/api/api.swagger.json
@@ -941,29 +941,39 @@
       }
     },
     "/v2/storage": {
-      "delete": {
-        "summary": "Delete one or more objects by ID or username.",
-        "operationId": "DeleteStorageObjects",
+      "post": {
+        "summary": "Get storage objects.",
+        "operationId": "ReadStorageObjects",
         "responses": {
           "200": {
             "description": "",
             "schema": {
-              "$ref": "#/definitions/protobufEmpty"
+              "$ref": "#/definitions/apiStorageObjects"
             }
           }
         },
+        "parameters": [
+          {
+            "name": "body",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/apiReadStorageObjectsRequest"
+            }
+          }
+        ],
         "tags": [
           "Nakama"
         ]
       },
-      "post": {
-        "summary": "Get storage objects.",
-        "operationId": "ReadStorageObjects",
+      "put": {
+        "summary": "Write objects into the storage engine.",
+        "operationId": "WriteStorageObjects",
         "responses": {
           "200": {
             "description": "",
             "schema": {
-              "$ref": "#/definitions/apiStorageObjects"
+              "$ref": "#/definitions/apiStorageObjectAcks"
             }
           }
         },
@@ -973,22 +983,24 @@
             "in": "body",
             "required": true,
             "schema": {
-              "$ref": "#/definitions/apiReadStorageObjectsRequest"
+              "$ref": "#/definitions/apiWriteStorageObjectsRequest"
             }
           }
         ],
         "tags": [
           "Nakama"
         ]
-      },
+      }
+    },
+    "/v2/storage/delete": {
       "put": {
-        "summary": "Write objects into the storage engine.",
-        "operationId": "WriteStorageObjects",
+        "summary": "Delete one or more objects by ID or username.",
+        "operationId": "DeleteStorageObjects",
         "responses": {
           "200": {
             "description": "",
             "schema": {
-              "$ref": "#/definitions/apiStorageObjectAcks"
+              "$ref": "#/definitions/protobufEmpty"
             }
           }
         },
@@ -998,7 +1010,7 @@
             "in": "body",
             "required": true,
             "schema": {
-              "$ref": "#/definitions/apiWriteStorageObjectsRequest"
+              "$ref": "#/definitions/apiDeleteStorageObjectsRequest"
             }
           }
         ],
@@ -1009,7 +1021,7 @@
     },
     "/v2/storage/{collection}": {
       "get": {
-        "summary": "List collections of storage objects.",
+        "summary": "List publicly readable storage objects in a given collection.",
         "operationId": "ListStorageObjects",
         "responses": {
           "200": {
@@ -1056,7 +1068,7 @@
     },
     "/v2/storage/{collection}/{user_id}": {
       "get": {
-        "summary": "List collections of storage objects.",
+        "summary": "List publicly readable storage objects in a given collection.",
         "operationId": "ListStorageObjects2",
         "responses": {
           "200": {
@@ -1342,6 +1354,19 @@
       },
       "description": "Storage objects to delete."
     },
+    "apiDeleteStorageObjectsRequest": {
+      "type": "object",
+      "properties": {
+        "object_ids": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/apiDeleteStorageObjectId"
+          },
+          "description": "Batch of storage objects."
+        }
+      },
+      "description": "Batch delete storage objects."
+    },
     "apiFriend": {
       "type": "object",
       "properties": {
@@ -1549,7 +1574,7 @@
     "apiReadStorageObjectsRequest": {
       "type": "object",
       "properties": {
-        "objectIds": {
+        "object_ids": {
           "type": "array",
           "items": {
             "$ref": "#/definitions/apiReadStorageObjectId"
@@ -1656,6 +1681,10 @@
         "version": {
           "type": "string",
           "description": "The version hash of the object."
+        },
+        "user_id": {
+          "type": "string",
+          "description": "The owner of the object."
         }
       },
       "description": "A storage acknowledgement."

diff --git a/migrate/migrate-packr.go b/migrate/migrate-packr.go
@@ -9,5 +9,5 @@ import "github.com/gobuffalo/packr"
 // Go binary. You can use the "packr clean" command to clean up this,
 // and any other packr generated files.
 func init() {
-	packr.PackJSONBytes("./sql", "20180103142001_initial_schema.sql", "\"H4sIAAAAAAAA/7RX33PithZ+5684k4cbvNcBwm7m7mxud8YBZ9ddYlJsdjd9YYR9sNXYkisJCO30f+/IP8AGEtJOy1MiffrOD30657j7pgVvYMCzjaBRrKDfu3wPfozgkkeSErCWKuZCtiDHjWiATGIISxaiABUjWBkJYqx2TPiKQlLOoN/pQVsDzsqtM+NaU2z4ElKyAcYVLCWCiqmEBU0Q8CnATAFlEPA0SyhhAcKaqji3U7J0NMdDycHnilAGBAKebYAv6kAgqnQ6Vir70O2u1+sOyZ3tcBF1kwImuyNnYLuefdHv9MoDU5aglCDw1yUVGMJ8AyTLEhqQeYKQkDVwASQSiCEorh1eC6ooi0yQfKHWRKCmCalUgs6XqpGvyj0qGwDOgDA4szxwvDO4sTzHMzXJN8f/PJ768M2aTCzXd2wPxhMYjN2h4ztj14PxLVjuA3xx3KEJSFWMAvApEzoCLoDqTGKYp81DbLiw4IVLMsOALmgACWHRkkQIEV+hYJRFkKFIqdQ3KoGwUNMkNKWKqHzpIC5tqNtqXVzAf1MaCaIQpllrMLEt3wbfuhnZ4NyCO/bB/u54vqc1ICS0WwAA9xPnzpo8wBf7Ado0NMxWvkxDqP2mU2e4+08zudPRyMyRmoyRFIu9r9Zk8NmatC/77w3QOfP8ieW4fmFzVoFnj7iBqev8NLX36EIqs4RsZgVlRde/ujKKfbIiiojZUiR1c7v9i4tcfPJDt6s4T2SHolrk6otVmnTnQfbufzlQJ36mSLTnt3YbhvatNR35cI7svKBNeJCnv4nOzWqT2Ik6cOYRBreCsIDKgJswsM7ys4qm+Btn+OLZe1LowacpQnvqwX9gQBgJiVGQpKhISBQpSH70xu7N9kK27v7+x/leOtckSVBVwFcfw5TQZAusuwzltRW4jEi55qIUy82Db1vbU4PP9uALtBNkkYrbFdKA/8Pbfq/XK+9rQQKcc/44yxXXlE/dUsR5lOCs1OULOJJigEyh0NjncVIhSSu6F3DBUiqenraLYYSzgC9ZnmyteDhIdK/KSQ388QfoGXvZDwQShTOtG51V51ONrmSoQz4eMiyz8BRDHXKEYYWCLjbHGQ7iqYOPBRRSqet4yXaCrAFusrWM69apwjYLcUUDfLa86dXb8cR2PrnFan6IhgZM7Ft7YrsDe1sh9erYhaE9sn0bBpY3sIb2XoVsSOKwNGrlNMrnX4pFC+VYJJIvRaBfgwlSEYUmZFxSXaCORbhFG4ULrw70gClEqSjLK+HfSNnWj8KNbVqaWasiKfO1VcsWpYvmVE9EuplKLhRwoVsiZyD4WnaOvIAdy+vU34zzOU/z1O+euXdnjUbayk7SDZ8XgiIL2z3DBMpWVGH7cvtn2O4bJswTHjxi2H5rmBBignr9nWECEUFMVxi2r4wik2XrrOtg72pOyYtxpftN0dTaVeu8db7f2R8g4MGj4CSIz/UEQpKNRKGnJz1ABgmu9LzD+DKKYR0ja9SrmEgY2t4AUh6ivhI9qFAW4lPnUMblAzEbDJY3MOFfeaqwP8rU5pN6PmY0fH5AqR71AdmeNpbzXzBQjRKR98+9Us+ZwqJnNLvzC8050Jnd1xzsvxAXI6LoCmFFkiVKIAJBbqTCFARKFKt8QtWeoh4oi5B0QCYc/DTddDQqHlzBkaKUJMLytdXvr1HeT7WrUzKVigtyvAYGPEkw0PdlgkASmvCIG7O6n39QPjtDL1Z7rZjq94qmUOmnbLf6ksrDr9XBqvzsqxt82zf2dJCGV/pRxvpbrbDCc2UWF6cTd1RLld3L6gpz5LHmrj/E8FUUBfLUxOM7d7bnW3f3/s8H3xq1qv0MrFEe6xJpiEPLrlSd4w7t73uq252b6bBn5TFdFGY0fNJK2QrzUIbbqvaIGy3v+ofZkK9ZazgZ3+/U3lT69fHdenl6BrIdGF7aL4ajFxDyuvVnAAAA///9ex2coBAAAA==\"")
+	packr.PackJSONBytes("./sql", "20180103142001_initial_schema.sql", "\"H4sIAAAAAAAA/7RX33PiuhV+5684k4eCbx0g7M30zqbdGQfMxl1iUmx2N31hhH2w1diSKwkI7fR/78g/wAYSMp1eP2SC9ek7vz4dHfd+acEvMOTZTtAoVjDo3/wGfozgkheSErDWKuZCtiDHTWiATGIIaxaiABUjWBkJYqxWTPiOQlLOYNDtQ0cDrsqlK+NOU+z4GlKyA8YVrCWCiqmEFU0Q8DXATAFlEPA0SyhhAcKWqji3U7J0NcdzycGXilAGBAKe7YCv6kAgqnQ6Vir73Ottt9suyZ3tchH1kgImexNnaLuefT3o9ssNc5aglCDwn2sqMITlDkiWJTQgywQhIVvgAkgkEENQXDu8FVRRFpkg+UptiUBNE1KpBF2uVSNflXtUNgCcAWFwZXngeFdwb3mOZ2qSH47/MJ378MOazSzXd2wPpjMYTt2R4ztT14PpGCz3Gb457sgEpCpGAfiaCR0BF0B1JjHM0+YhNlxY8cIlmWFAVzSAhLBoTSKEiG9QMMoiyFCkVOqKSiAs1DQJTakiKn91Epc21Gu1rq/hjymNBFEI86w1nNmWb4Nv3U9scMbgTn2wfzqe72kNCAmdFgDA08x5tGbP8M1+hg4NDbOVv6Yh1J753Bkdfmkmdz6ZmDlSkzGSYrH23ZoNH6xZ52bwmwE6Z54/sxzXL2wuKvDiBXcwd52/ze0jupDKLCG7RUFZ0Q1ub41inWyIImKxFknd3GH9+joXn/zc6ynOE9mlqFa5+mKVJr1lkP36pxyoE79QJDryW7sNI3tszSc+tJG1C9qEB3n6m+jcrDaJ3agLVx5hMBaEBVQG3IShdZXvVTTFf3GG7+59IoUefJoidOYe/AGGhJGQGAVJioqERJGC5K/e1L3fF2Tv7r//0z5K55YkCaoK+OFtmBKa7IF1l6EsW4HLiJRbLkqx3D/7trXfNXywh9+gkyCLVNypkAb8GT4N+v1+Wa8VCXDJ+csiV1xTPnVLEedRgotSl+/gSIoBMoVCY9/GSYUkrejewQVrqXh62S6GES4CvmZ5srXi4STR/SonNfCXv0DfOMp+IJAoXGjd6Kw6X2t0JUMd8uWUYZ2FlxjqkDMMGxR0tTvPcBJPHXwuoJBK3cdLtgtkDXCTrWXctVqO69kzX6d4WnUyGpr7PmTW02fWM2G0ihJO5rYHnXa/fK7P/Kmetgnttgk3JtwUu6eubmrjiTP0dbeE0VQ79+C4X+9al1ruIsQNDfDNxqvfjqcz2/nqFm/zTdrKzB7bM9sd2t4hYkP7MrIntm/D0PKG1sg+6t0NsZ42ba3pRmNvZPlSLFrC5yKRfC0CfU5NkIooNCHjkurWeS7CPdooXPhwoCdMIUpFWd6j/4eU7f0o3NinpZm1KpIyX3sd71G6nc/1rKavecmFAi70Zc0ZCL6V3TNn88DysXPZjPMtT/PUHxqQ92hNJtrK4bA1fF4Jiizs9A0TKNtQhZ2b/b9hZ2CYsEx48IJh55NhQogJ6ve/GiYQEcR0g2Hn1igyWV7qdR0cleaSvBhX+iYsrttOdamPnZ+P9mcIePAiOAnitp6NSLKTKPRcp0fbIMGNnsQYX0cxbGNkjU4aEwkj2xtCykPUJdEjFGUhvnZPZVwekEYzAcsbmvC7HFU4HrJqk1M9Hwsavj06VYf6hOxIG+vlPzBQjRaR3+xHlxBnCovbrDk3vDM2BDqzx5qD4xPiYkQU3SBsSLJGCUQgyJ1UmIJAiWKTz87aU9SjbhGSDsiEk0fTzSeT4sAVHClKSSIsT1u9fo2L59JFekmmUnFBzvfAgCcJBrpeJggkoQkvuDOr+vwf5XMw9G6314qpng9cChf0k1etXPmoMDblF2rdg08D40gYaXirT2msPysLKzyXalFJncmz4qrs3lQ1zZHn5hD9zYgfoiiQl4Yz33m0Pd96fPL/fvJZVGvjb8Aa/bKumYZatA5LGTruyP55JMPDvoUOe1Fu011iQcNXLZ29Uk91uW9zL7jTeq9/Q474lrVGs+nTQf5N6d+dX633qzcg+wnivfViWnoHIe9a/w0AAP//MUDbnEsRAAA=\"")
 }
diff --git a/migrate/sql/20180103142001_initial_schema.sql b/migrate/sql/20180103142001_initial_schema.sql
@@ -42,6 +42,10 @@ CREATE TABLE IF NOT EXISTS users (
     disable_time  BIGINT        DEFAULT 0 CHECK (disable_time >= 0) NOT NULL
 );
 
+INSERT INTO users (id, username, create_time, update_time)
+    VALUES ('00000000-0000-0000-0000-000000000000', '', 1, 1)
+    ON CONFLICT(id) DO NOTHING;
+
 CREATE TABLE IF NOT EXISTS user_device (
     PRIMARY KEY (id),
     FOREIGN KEY (user_id) REFERENCES users (id) ON DELETE CASCADE,
@@ -84,7 +88,7 @@ CREATE TABLE IF NOT EXISTS storage (
 
     collection  VARCHAR(128) NOT NULL,
     key         VARCHAR(128) NOT NULL,
-    user_id     UUID,
+    user_id     UUID         NOT NULL,
     value       JSONB        DEFAULT '{}' NOT NULL,
     version     VARCHAR(32)  NOT NULL, -- md5 hash of value object.
     read        SMALLINT     DEFAULT 1 CHECK (read >= 0) NOT NULL,