Update identifier formats. Merge #123

### Added

- RUDP transport option for client connections.

### Changed

- Consistently Use strings for all ID types.

- Improve runtime hook lookup behaviour.

### [1.1.0] - 2017-10-17

### Added

- Advanced Matchmaking with custom filters and user properties.

/*

 * Copyright 2017 The Nakama Authors

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 * http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */

-- +migrate Up

ALTER TABLE IF EXISTS user_device DROP CONSTRAINT IF EXISTS fk_user_id_ref_users;

UPDATE users SET id = from_uuid(id)::BYTEA;

UPDATE user_device SET user_id = from_uuid(user_id)::BYTEA;

ALTER TABLE IF EXISTS user_device ADD CONSTRAINT fk_user_id_ref_users FOREIGN KEY (user_id) REFERENCES users(id);

UPDATE user_edge SET source_id = from_uuid(source_id)::BYTEA, destination_id = from_uuid(destination_id)::BYTEA;

UPDATE user_edge_metadata SET source_id = from_uuid(source_id)::BYTEA;

UPDATE groups SET id = from_uuid(id)::BYTEA, creator_id = from_uuid(creator_id)::BYTEA;

UPDATE group_edge SET source_id = from_uuid(source_id)::BYTEA, destination_id = from_uuid(destination_id)::BYTEA;

UPDATE message SET user_id = from_uuid(user_id)::BYTEA, message_id = from_uuid(message_id)::BYTEA;

UPDATE storage SET id = from_uuid(id)::BYTEA, user_id = from_uuid(user_id)::BYTEA;

UPDATE leaderboard_record SET id = from_uuid(id)::BYTEA, owner_id = from_uuid(owner_id)::BYTEA;

UPDATE purchase SET user_id = from_uuid(user_id)::BYTEA;

UPDATE notification SET id = from_uuid(id)::BYTEA, user_id = from_uuid(user_id)::BYTEA, sender_id = from_uuid(sender_id)::BYTEA;

-- +migrate Down

ALTER TABLE IF EXISTS user_device DROP CONSTRAINT IF EXISTS fk_user_id_ref_users;

UPDATE users SET id = to_uuid(id)::BYTEA;

UPDATE user_device SET user_id = to_uuid(user_id)::BYTEA;

ALTER TABLE IF EXISTS user_device ADD CONSTRAINT fk_user_id_ref_users FOREIGN KEY (user_id) REFERENCES users(id);

UPDATE user_edge SET source_id = to_uuid(source_id)::BYTEA, destination_id = to_uuid(destination_id)::BYTEA;

UPDATE user_edge_metadata SET source_id = to_uuid(source_id)::BYTEA;

UPDATE groups SET id = to_uuid(id)::BYTEA, creator_id = to_uuid(creator_id)::BYTEA;

UPDATE group_edge SET source_id = to_uuid(source_id)::BYTEA, destination_id = to_uuid(destination_id)::BYTEA;

UPDATE message SET user_id = to_uuid(user_id)::BYTEA, message_id = to_uuid(message_id)::BYTEA;

UPDATE storage SET id = to_uuid(id)::BYTEA, user_id = to_uuid(user_id)::BYTEA;

UPDATE leaderboard_record SET id = to_uuid(id)::BYTEA, owner_id = to_uuid(owner_id)::BYTEA;

UPDATE purchase SET user_id = to_uuid(user_id)::BYTEA;

UPDATE notification SET id = to_uuid(id)::BYTEA, user_id = to_uuid(user_id)::BYTEA, sender_id = to_uuid(sender_id)::BYTEA;

)

var ErrClientInstanceClosed = errors.New("client instance closed")

var ErrClientInstanceUnreliableDataTooLarge = errors.New("client instance unreliable data too large")

var ErrClientInstanceNotConnected = errors.New("client instance not connected")

var ErrClientInstanceSendBufferFull = errors.New("client instance reliable send buffer full")

//var ErrClientInstancePacketDataTooLarge = errors.New("client instance packet data too large")

type ClientInstance struct {

	sync.Mutex

	logger  *zap.Logger

		incomingPacketCh:   make(chan netcode.Packet, netcode.PACKET_QUEUE_SIZE),

		outgoingPacketData: make([]byte, netcode.MAX_PACKET_BYTES),

		unreliableController:    NewReliablePacketController(maxPacketSize, maxPacketFragments),

		unreliableController:    NewReliablePacketController(1024, 1),

		unreliableReceiveBuffer: NewSequenceBufferReceived(256),

		reliableCh:            make(chan []byte, netcode.PACKET_QUEUE_SIZE),

// An external routine is expected to continuously call this, otherwise

// no input attributed to this client instance will be processed.

func (c *ClientInstance) Read() ([]byte, bool, error) {

readLoop:

	for {

		select {

		case reliableData := <-c.reliableCh:

							if err != nil {

								c.Unlock()

								c.logger.Debug("error processing reliable packet message ID", zap.Error(err))

								continue

								continue readLoop

							}

							messageLengthUint16, err := ReadVariableLengthUint16(rw)

							if err != nil {

								c.Unlock()

								c.logger.Debug("error processing reliable packet message length", zap.Error(err))

								continue

								continue readLoop

							}

							if messageLengthUint16 == 0 {

								c.Unlock()

								continue

								continue readLoop

							}

							messageLength := int(messageLengthUint16)

								if err != nil {

									c.Unlock()

									c.logger.Debug("error processing reliable packet read buffer", zap.Error(err))

									continue

									continue readLoop

								}

							} else {

								rw.SeekRead(rw.readPosition + messageLength)

// NOTE: Only for payload data packets, other protocol-level messages MUST be sent through other functions.

func (c *ClientInstance) Send(payloadData []byte, reliable bool) error {

	//if len(payloadData) > netcode.MAX_PACKET_BYTES {

	//	c.logger.Warn("server attempting to send packet data exceeding max length, dropping packet")

	//	return ErrClientInstancePacketDataTooLarge

	//}

	if !reliable && len(payloadData) > FRAGMENT_SIZE {

		c.logger.Warn("server attempting to send unreliable packet data exceeding unreliable max length, dropping packet")

		return ErrClientInstanceUnreliableDataTooLarge

	}

	c.Lock()

	if c.stopped || !c.connected {

    /// Authentication Token.

    string token = 1;

    /// UDP token.

    bytes udp_token = 2;

    string udp_token = 2;

  }

  /**

 */

message User {

  /// User ID.

  bytes id = 1;

  string id = 1;

  /// User Handle (username).

  string handle = 2;

  /// User's fullname.

  /// User's timezone.

  string timezone = 7;

  /// Custom user metadata.

  bytes metadata = 8;

  string metadata = 8;

  /// Unix timestamp when this user registered.

  int64 created_at = 9;

  /// Unix timestamp when user profile was last changed.

  /// Language tag corresponding to the BCP 47 spec

  string lang = 5;

  /// Set or remove User's metadata

  bytes metadata = 6;

  string metadata = 6;

  string avatar_url = 7;

}

message TUsersFetch {

  message UsersFetch {

    oneof id {

      bytes user_id = 1;

      string user_id = 1;

      string handle = 2;

    }

  }

message TFriendsAdd {

  message FriendsAdd {

    oneof id {

      bytes user_id = 1;

      string user_id = 1;

      string handle = 2;

    }

  }

 * This could be unfriending a friend, or removing a friend request.

 */

message TFriendsRemove {

  repeated bytes user_ids = 1;

  repeated string user_ids = 1;

}

/**

 * If the current user is a friend, relationship is removed bidirectionaly from both users and a new Block status is formed.

 */

message TFriendsBlock {

  repeated bytes user_ids = 1;

  repeated string user_ids = 1;

}

/**

 */

message Group {

  /// Group ID

  bytes id = 1;

  string id = 1;

  /// Whether the group is private or public. If private, group admins will accept user join requests.

  bool private = 2;

  /// User ID of the group creator.

  bytes creator_id = 3;

  string creator_id = 3;

  string name = 4;

  string description = 5;

  string avatar_url = 6;

  /// Offset time in millisecond from UTC.

  int64 utc_offset_ms = 8;

  /// Group metadata information.

  bytes metadata = 9;

  string metadata = 9;

  /// Current number of users in this group.

  int64 count = 10;

  int64 created_at = 11;

    /// Language tag corresponding to the BCP 47 spec. This is important and used for Group search.

    string lang = 4;

    /// Group metadata information.

    bytes metadata = 5;

    string metadata = 5;

    /// Whether the group is private or public. If private, group admins will accept user join requests.

    bool private = 6;

  }

 */

message TGroupsUpdate {

  message GroupUpdate {

    bytes group_id = 1;

    string group_id = 1;

    /// Whether the group is private or public. If private, group admins will accept user join requests.

    bool private = 2;

    /// Group name must be unique.

    /// Language tag corresponding to the BCP 47 spec. This is important and used for Group search.

    string lang = 6;

    /// Set or remove metadata information.

    bytes metadata = 7;

    string metadata = 7;

  }

  repeated GroupUpdate groups = 1;

 * NOTE: The server only processes the first item of the list, and will ignore and logs a warning message for other items.

 */

message TGroupsRemove {

  repeated bytes group_ids = 1;

  repeated string group_ids = 1;

}

/**

message TGroupsFetch {

  message GroupFetch {

    oneof id {

      bytes group_id = 1;

      string group_id = 1;

      string name = 2;

    }

  }

  }

  /// Binary cursor value used to paginate results.

  /// The value of this comes from TGroups.cursor.

  bytes cursor = 7; // gob(%{struct(int64/string, int64, bytes)})

  string cursor = 7; // gob(%{struct(int64/string, int64, bytes)})

}

/**

message TGroups {

  repeated Group groups = 1;

  /// Use cursor to paginate results.

  bytes cursor = 2;

  string cursor = 2;

}

/**

 * @returns TGroupUsers

 */

message TGroupUsersList {

  bytes group_id = 1;

  string group_id = 1;

}

/**

 * NOTE: The server only processes the first item of the list, and will ignore and logs a warning message for other items.

 */

message TGroupsJoin {

  repeated bytes group_ids = 1;

  repeated string group_ids = 1;

}

/**

 * NOTE: The server only processes the first item of the list, and will ignore and logs a warning message for other items.

 */

message TGroupsLeave {

  repeated bytes group_ids = 1;

  repeated string group_ids = 1;

}

/**

 */

message TGroupUsersAdd {

  message GroupUserAdd {

    bytes group_id = 1;

    bytes user_id = 2;

    string group_id = 1;

    string user_id = 2;

  }

  repeated GroupUserAdd group_users = 1;

 */

message TGroupUsersKick {

  message GroupUserKick {

    bytes group_id = 1;

    bytes user_id = 2;

    string group_id = 1;

    string user_id = 2;

  }

  repeated GroupUserKick group_users = 1;

}

 */

message TGroupUsersPromote {

  message GroupUserPromote {

    bytes group_id = 1;

    bytes user_id = 2;

    string group_id = 1;

    string user_id = 2;

  }

  repeated GroupUserPromote group_users = 1;

}

 */

message TopicId {

  oneof id {

    bytes dm = 1;

    bytes room = 2;

    bytes group_id = 3;

    string dm = 1;

    string room = 2;

    string group_id = 3;

  }

}

 */

message UserPresence {

  /// User ID

  bytes user_id = 1;

  string user_id = 1;

  /// Session ID

  bytes session_id = 2;

  string session_id = 2;

  /// User handle

  string handle = 3;

}

message TTopicsJoin {

  message TopicJoin {

    oneof id {

      bytes user_id = 1;

      bytes room = 2;

      bytes group_id = 3;

      string user_id = 1;

      string room = 2;

      string group_id = 3;

    }

  }

 */

message TTopicMessageSend {

  TopicId topic = 1;

  bytes data = 2;

  string data = 2;

}

/**

 * TTopicMessageAck sends an ack message to the topic

 */

message TTopicMessageAck {

  bytes message_id = 1;

  string message_id = 1;

  int64 created_at = 2;

  int64 expires_at = 3;

  string handle = 4;

 */

message TopicMessage {

  TopicId topic = 1;

  bytes user_id = 2;

  bytes message_id = 3;

  string user_id = 2;

  string message_id = 3;

  int64 created_at = 4;

  int64 expires_at = 5;

  string handle = 6;

  /// Group Kick (4) - Notification - a user was kicked from the group - send by the system

  /// Group Promoted (5) - Notification - a user was promoted to group admin - send by the system

  int64 type = 7;

  bytes data = 8;

  string data = 8;

}

/**

 */

message TTopicMessagesList {

  oneof id {

    bytes user_id = 1;

    bytes room = 2;

    bytes group_id = 3;

    string user_id = 1;

    string room = 2;

    string group_id = 3;

  }

  /// Use the cursor to paginate through more message.

  /// The value of this comes from TTopicMessages.cursor.

  bytes cursor = 4;

  string cursor = 4;

  bool forward = 5;

  int64 limit = 6;

}

 */

message TTopicMessages {

  repeated TopicMessage messages = 1;

  bytes cursor = 2;

  string cursor = 2;

}

/**

 * TMatchmakeTicket represents a matchmake ticket. Use the ticket to cancel matchmaking search.

 */

message TMatchmakeTicket {

  bytes ticket = 1;

  string ticket = 1;

}

/**

 * TMatchmakeRemove is used to cancel a matchmake search.

 */

message TMatchmakeRemove {

  bytes ticket = 1;

  string ticket = 1;

}

/**

message MatchmakeMatched {

  /// Matched user presence and properties

  message UserProperty {

    bytes user_id = 1;

    string user_id = 1;

    repeated PropertyPair properties = 2;

    repeated MatchmakeFilter filters = 3;

  }

  /// Matchmaking ticket. Use this to invalidate ticket cache on the client.

  bytes ticket = 1;

  string ticket = 1;

  /// Matchmaking token. Use this to accept the match. This is a onetime token which is only valid for a limited time.

  bytes token = 2;

  string token = 2;

  repeated UserPresence presences = 3;

  UserPresence self = 4;

  repeated UserProperty properties = 5;

 * Match is the core domain type representing an on-going match.

 */

message Match {

  bytes match_id = 1;

  string match_id = 1;

  repeated UserPresence presences = 2;

  UserPresence self = 3;

}

 * MatchPresence is the core domain type representing the users participating and leaving a match.

 */

message MatchPresence {

  bytes match_id = 1;

  string match_id = 1;

  repeated UserPresence joins = 2;

  repeated UserPresence leaves = 3;

}

message TMatchesJoin {

  message MatchJoin {

    oneof id {

      bytes match_id = 1;

      bytes token = 2;

      string match_id = 1;

      string token = 2;

    }

  }

 * MatchDataSend is used to send match data to the server.

 */

message MatchDataSend {

  bytes match_id = 1;

  string match_id = 1;

  /// Custom Op code to make disguishing different message types easier.

  int64 op_code = 2;

  bytes data = 3;

 * MatchData is the core domain type representing a match data.

 */

message MatchData {

  bytes match_id = 1;

  string match_id = 1;

  UserPresence presence = 2;

  int64 op_code = 3;

  bytes data = 4;

 * NOTE: The server only processes the first item of the list, and will ignore and logs a warning message for other items.

 */

message TMatchesLeave {

  repeated bytes match_ids = 1;

  repeated string match_ids = 1;

}

/**

 * @returns TStorageData

 */

message TStorageList {

  bytes user_id = 1;

  string user_id = 1;

  string bucket = 2;

  string collection = 3;

  int64 limit = 4;

  bytes cursor = 5;

  string cursor = 5;

}

/**

    string bucket = 1;

    string collection = 2;

    string record = 3;

    bytes user_id = 4;

    string user_id = 4;

  }

  repeated StorageKey keys = 1;

}

    string bucket = 1;

    string collection = 2;

    string record = 3;

    bytes user_id = 4;

    bytes value = 5;

    bytes version = 6;

    string user_id = 4;

    string value = 5;

    string version = 6;

    int32 permission_read = 7;

    int32 permission_write = 8;

    int64 created_at = 9;

  }

  repeated StorageData data = 1;

  bytes cursor = 2;

  string cursor = 2;

}

/**

    string bucket = 1;

    string collection = 2;

    string record = 3;

    bytes value = 4;

    bytes version = 5; // if-match and if-none-match

    string value = 4;

    string version = 5; // if-match and if-none-match

    int32 permission_read = 6;

    int32 permission_write = 7;

  }

      /// Update op code - must be one of the UpdateOpCode enums above.

      int32 op = 1;

      string path = 2;

      bytes value = 3;

      string value = 3;

      string from = 4;

      bool conditional = 5;

      int64 assert = 6;

      string bucket = 1;

      string collection = 2;

      string record = 3;

      bytes version = 4; // if-match and if-none-match

      string version = 4; // if-match and if-none-match

    }

    StorageKey key = 1;

    string bucket = 1;

    string collection = 2;

    string record = 3;

    bytes version = 4;

    string version = 4;

  }

  repeated StorageKey keys = 1;

    string bucket = 1;

    string collection = 2;

    string record = 3;

    bytes version = 4;

    string version = 4;

  }

  repeated StorageKey keys = 1;

}

 * Leaderboard is the core domain type representing a Leaderboard setup in the server.

 */

message Leaderboard {

  bytes id = 1;