DB defaults update, friend and group state cleanup.

Author: zyro

CHANGELOG.md

@@ -4,7 +4,17 @@ All notable changes to this project are documented below.
 The format is based on [keep a changelog](http://keepachangelog.com) and this project uses [semantic versioning](http://semver.org).
 
 ## [Unreleased]
+### Added
+- New runtime function to send raw realtime envelope data through streams.
+
+### Changed
+- Change error message on database errors raised during authentication operations.
+- New default for maximum number of open database connections.
+- Friend state indicators are no longer offset when sent to clients.
+- Group state indicators are no longer offset when sent to clients.
+
 ### Fixed
+- Correctly handle optional parameters in runtime functions to update account information.
 - Correctly handle context cancellation in single-statement database operations.
 
 ## [2.1.3] - 2018-11-02

api/api.pb.go

@@ -292,22 +292,20 @@ message DeleteStorageObjectsRequest {
 message Friend {
   // The friendship status.
   enum State {
-    // Default case. Assumed as FRIEND state.
-    STATE_UNSPECIFIED = 0;
     // The user is a friend of the current user.
-    FRIEND = 1;
-    // The user has sent an invite to the current user.
-    INVITE_SENT = 2;
-    // The current user has sent an invite to this user.
-    INVITE_RECEIVED = 3;
+    FRIEND = 0;
+    // The current user has sent an invite to the user.
+    INVITE_SENT = 1;
+    // The current user has received an invite from this user.
+    INVITE_RECEIVED = 2;
     // The current user has blocked this user.
-    BLOCKED = 4;
+    BLOCKED = 3;
   }
 
   // The user object.
   User user = 1;
   // The friend status.
-  int32 state = 2; // one of "Friend.State".
+  google.protobuf.Int32Value state = 2; // one of "Friend.State".
 }
 
 // A collection of zero or more friends of the user.
@@ -368,22 +366,20 @@ message GroupUserList {
   message GroupUser {
     // The group role status.
     enum State {
-      // Default case. Assumed as SUPERADMIN state.
-      STATE_UNSPECIFIED = 0;
       // The user is a superadmin with full control of the group.
-      SUPERADMIN = 1;
+      SUPERADMIN = 0;
       // The user is an admin with additional privileges.
-      ADMIN = 2;
+      ADMIN = 1;
       // The user is a regular member.
-      MEMBER = 3;
+      MEMBER = 2;
       // The user has requested to join the group
-      JOIN_REQUEST = 4;
+      JOIN_REQUEST = 3;
     }
 
     // User.
     User user = 1;
     // Their relationship to the group.
-    int32 state = 2;
+    google.protobuf.Int32Value state = 2;
   }
 
   // User-role pairs for a group.
@@ -872,22 +868,20 @@ message UserGroupList {
   message UserGroup {
     // The group role status.
     enum State {
-      // Default case. Assumed as SUPERADMIN state.
-      STATE_UNSPECIFIED = 0;
       // The user is a superadmin with full control of the group.
-      SUPERADMIN = 1;
+      SUPERADMIN = 0;
       // The user is an admin with additional privileges.
-      ADMIN = 2;
+      ADMIN = 1;
       // The user is a regular member.
-      MEMBER = 3;
+      MEMBER = 2;
       // The user has requested to join the group
-      JOIN_REQUEST = 4;
+      JOIN_REQUEST = 3;
     }
 
     // Group.
     Group group = 1;
     // The user's relationship to the group.
-    int32 state = 2;
+    google.protobuf.Int32Value state = 2;
   }
 
   // Group-role pairs for a user.

api/api.proto

@@ -1371,6 +1371,7 @@
     },
     "/v2/leaderboard/{leaderboard_id}/owner/{owner_id}": {
       "get": {
+        "summary": "List leaderboard records that belong to a user.",
         "operationId": "ListLeaderboardRecordsAroundOwner",
         "responses": {
           "200": {
@@ -1947,6 +1948,7 @@
     },
     "/v2/tournament/{tournament_id}/join": {
       "post": {
+        "summary": "Attempt to join an open and running tournament.",
         "operationId": "JoinTournament",
         "responses": {
           "200": {
@@ -1972,6 +1974,7 @@
     },
     "/v2/tournament/{tournament_id}/owner/{owner_id}": {
       "get": {
+        "summary": "List tournament records for a given owner.",
         "operationId": "ListTournamentRecordsAroundOwner",
         "responses": {
           "200": {

apigrpc/apigrpc.pb.go

@@ -64,7 +64,7 @@ CREATE TABLE IF NOT EXISTS user_edge (
     position       BIGINT      NOT NULL, -- Used for sort order on rows.
     update_time    TIMESTAMPTZ DEFAULT now() NOT NULL,
     destination_id UUID        NOT NULL,
-    state          SMALLINT    DEFAULT 0 NOT NULL, -- friend(0), invite(1), invited(2), blocked(3), deleted(4), archived(5)
+    state          SMALLINT    DEFAULT 0 NOT NULL, -- friend(0), invite_sent(1), invite_received(2), blocked(3), deleted(4), archived(5)
 
     UNIQUE (source_id, destination_id)
 );

apigrpc/apigrpc.swagger.json

@@ -390,18 +390,18 @@ func NewSocketConfig() *SocketConfig {
 
 // DatabaseConfig is configuration relevant to the Database storage.
 type DatabaseConfig struct {
-	Addresses         []string `yaml:"address" json:"address" usage:"List of CockroachDB servers (username:password@address:port/dbname)."`
-	ConnMaxLifetimeMs int      `yaml:"conn_max_lifetime_ms" json:"conn_max_lifetime_ms" usage:"Time in milliseconds to reuse a database connection before the connection is killed and a new one is created."`
-	MaxOpenConns      int      `yaml:"max_open_conns" json:"max_open_conns" usage:"Maximum number of allowed open connections to the database."`
-	MaxIdleConns      int      `yaml:"max_idle_conns" json:"max_idle_conns" usage:"Maximum number of allowed open but unused connections to the database."`
+	Addresses         []string `yaml:"address" json:"address" usage:"List of database servers (username:password@address:port/dbname). Default '[email protected]:26257'."`
+	ConnMaxLifetimeMs int      `yaml:"conn_max_lifetime_ms" json:"conn_max_lifetime_ms" usage:"Time in milliseconds to reuse a database connection before the connection is killed and a new one is created. Default 0 (unlimited)."`
+	MaxOpenConns      int      `yaml:"max_open_conns" json:"max_open_conns" usage:"Maximum number of allowed open connections to the database. Default 100."`
+	MaxIdleConns      int      `yaml:"max_idle_conns" json:"max_idle_conns" usage:"Maximum number of allowed open but unused connections to the database. Default 100."`
 }
 
 // NewDatabaseConfig creates a new DatabaseConfig struct.
 func NewDatabaseConfig() *DatabaseConfig {
 	return &DatabaseConfig{
 		Addresses:         []string{"[email protected]:26257"},
 		ConnMaxLifetimeMs: 0,
-		MaxOpenConns:      0,
+		MaxOpenConns:      100,
 		MaxIdleConns:      100,
 	}
 }

migrate/sql/20180103142001_initial_schema.sql

@@ -51,7 +51,7 @@ func AuthenticateCustom(ctx context.Context, logger *zap.Logger, db *sql.DB, cus
 		if err == sql.ErrNoRows {
 			found = false
 		} else {
-			logger.Error("Cannot find user with custom ID.", zap.Error(err), zap.String("customID", customID), zap.String("username", username), zap.Bool("create", create))
+			logger.Error("Error looking up user by custom ID.", zap.Error(err), zap.String("customID", customID), zap.String("username", username), zap.Bool("create", create))
 			return "", "", false, status.Error(codes.Internal, "Error finding user account.")
 		}
 	}
@@ -112,7 +112,7 @@ func AuthenticateDevice(ctx context.Context, logger *zap.Logger, db *sql.DB, dev
 			// No user account found.
 			//return "", "", status.Error(codes.NotFound, "Device ID not found.")
 		} else {
-			logger.Error("Cannot find user with device ID.", zap.Error(err), zap.String("deviceID", deviceID), zap.String("username", username), zap.Bool("create", create))
+			logger.Error("Error looking up user by device ID.", zap.Error(err), zap.String("deviceID", deviceID), zap.String("username", username), zap.Bool("create", create))
 			return "", "", false, status.Error(codes.Internal, "Error finding user account.")
 		}
 	}
@@ -125,7 +125,7 @@ func AuthenticateDevice(ctx context.Context, logger *zap.Logger, db *sql.DB, dev
 		var dbDisableTime pq.NullTime
 		err = db.QueryRowContext(ctx, query, dbUserID).Scan(&dbUsername, &dbDisableTime)
 		if err != nil {
-			logger.Error("Cannot find user with device ID.", zap.Error(err), zap.String("deviceID", deviceID), zap.String("username", username), zap.Bool("create", create))
+			logger.Error("Error looking up user by device ID.", zap.Error(err), zap.String("deviceID", deviceID), zap.String("username", username), zap.Bool("create", create))
 			return "", "", false, status.Error(codes.Internal, "Error finding user account.")
 		}
 
@@ -221,7 +221,7 @@ func AuthenticateEmail(ctx context.Context, logger *zap.Logger, db *sql.DB, emai
 		if err == sql.ErrNoRows {
 			found = false
 		} else {
-			logger.Error("Cannot find user with email.", zap.Error(err), zap.String("email", email), zap.String("username", username), zap.Bool("create", create))
+			logger.Error("Error looking up user by email.", zap.Error(err), zap.String("email", email), zap.String("username", username), zap.Bool("create", create))
 			return "", "", false, status.Error(codes.Internal, "Error finding user account.")
 		}
 	}
@@ -293,7 +293,7 @@ func AuthenticateFacebook(ctx context.Context, logger *zap.Logger, db *sql.DB, c
 		if err == sql.ErrNoRows {
 			found = false
 		} else {
-			logger.Error("Cannot find user with Facebook ID.", zap.Error(err), zap.String("facebookID", facebookProfile.ID), zap.String("username", username), zap.Bool("create", create))
+			logger.Error("Error looking up user by Facebook ID.", zap.Error(err), zap.String("facebookID", facebookProfile.ID), zap.String("username", username), zap.Bool("create", create))
 			return "", "", false, status.Error(codes.Internal, "Error finding user account.")
 		}
 	}
@@ -359,7 +359,7 @@ func AuthenticateGameCenter(ctx context.Context, logger *zap.Logger, db *sql.DB,
 		if err == sql.ErrNoRows {
 			found = false
 		} else {
-			logger.Error("Cannot find user with GameCenter ID.", zap.Error(err), zap.String("gameCenterID", playerID), zap.String("username", username), zap.Bool("create", create))
+			logger.Error("Error looking up user by GameCenter ID.", zap.Error(err), zap.String("gameCenterID", playerID), zap.String("username", username), zap.Bool("create", create))
 			return "", "", false, status.Error(codes.Internal, "Error finding user account.")
 		}
 	}
@@ -425,7 +425,7 @@ func AuthenticateGoogle(ctx context.Context, logger *zap.Logger, db *sql.DB, cli
 		if err == sql.ErrNoRows {
 			found = false
 		} else {
-			logger.Error("Cannot find user with Google ID.", zap.Error(err), zap.String("googleID", googleProfile.Sub), zap.String("username", username), zap.Bool("create", create))
+			logger.Error("Error looking up user by Google ID.", zap.Error(err), zap.String("googleID", googleProfile.Sub), zap.String("username", username), zap.Bool("create", create))
 			return "", "", false, status.Error(codes.Internal, "Error finding user account.")
 		}
 	}
@@ -492,7 +492,7 @@ func AuthenticateSteam(ctx context.Context, logger *zap.Logger, db *sql.DB, clie
 		if err == sql.ErrNoRows {
 			found = false
 		} else {
-			logger.Error("Cannot find user with Steam ID.", zap.Error(err), zap.String("steamID", steamID), zap.String("username", username), zap.Bool("create", create))
+			logger.Error("Error looking up user by Steam ID.", zap.Error(err), zap.String("steamID", steamID), zap.String("username", username), zap.Bool("create", create))
 			return "", "", false, status.Error(codes.Internal, "Error finding user account.")
 		}
 	}

server/config.go

@@ -19,6 +19,7 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
+	"github.com/golang/protobuf/ptypes/wrappers"
 	"time"
 
 	"context"
@@ -60,8 +61,10 @@ FROM users, user_edge WHERE id = destination_id AND source_id = $1`
 		}
 
 		friends = append(friends, &api.Friend{
-			User:  user,
-			State: int32(state.Int64),
+			User: user,
+			State: &wrappers.Int32Value{
+				Value: int32(state.Int64),
+			},
 		})
 	}
 	if err = rows.Err(); err != nil {
@@ -127,8 +130,10 @@ FROM users, user_edge WHERE id = destination_id AND source_id = $1`
 		}
 
 		friends = append(friends, &api.Friend{
-			User:  user,
-			State: int32(state.Int64) + 1,
+			User: user,
+			State: &wrappers.Int32Value{
+				Value: int32(state.Int64),
+			},
 		})
 	}
 	if err = rows.Err(); err != nil {

server/core_authenticate.go

@@ -773,17 +773,13 @@ WHERE u.id = ge.source_id AND ge.destination_id = $1 AND u.disable_time = '1970-
 			Online:       tracker.StreamExists(PresenceStream{Mode: StreamModeNotifications, Subject: userID}),
 		}
 
-		groupUser := &api.GroupUserList_GroupUser{User: user}
-		switch state.Int64 {
-		case 0:
-			groupUser.State = int32(api.GroupUserList_GroupUser_SUPERADMIN)
-		case 1:
-			groupUser.State = int32(api.GroupUserList_GroupUser_ADMIN)
-		case 2:
-			groupUser.State = int32(api.GroupUserList_GroupUser_MEMBER)
-		case 3:
-			groupUser.State = int32(api.GroupUserList_GroupUser_JOIN_REQUEST)
+		groupUser := &api.GroupUserList_GroupUser{
+			User: user,
+			State: &wrappers.Int32Value{
+				Value: int32(state.Int64),
+			},
 		}
+
 		groupUsers = append(groupUsers, groupUser)
 	}
 
@@ -855,16 +851,11 @@ WHERE group_edge.destination_id = $1 AND disable_time = '1970-01-01 00:00:00'`
 			UpdateTime:  &timestamp.Timestamp{Seconds: updateTime.Time.Unix()},
 		}
 
-		userGroup := &api.UserGroupList_UserGroup{Group: group}
-		switch userState.Int64 {
-		case 0:
-			userGroup.State = int32(api.UserGroupList_UserGroup_SUPERADMIN)
-		case 1:
-			userGroup.State = int32(api.UserGroupList_UserGroup_ADMIN)
-		case 2:
-			userGroup.State = int32(api.UserGroupList_UserGroup_MEMBER)
-		case 3:
-			userGroup.State = int32(api.UserGroupList_UserGroup_JOIN_REQUEST)
+		userGroup := &api.UserGroupList_UserGroup{
+			Group: group,
+			State: &wrappers.Int32Value{
+				Value: int32(userState.Int64),
+			},
 		}
 
 		userGroups = append(userGroups, userGroup)