validate local schema during Handshake(). colyseus/schema#11

Author: endel

Assets/ColyseusClient.cs

@@ -21,7 +21,7 @@ public class ColyseusClient : MonoBehaviour {
 	protected Client client;
 	protected Room<State> room;
 
-	protected IndexedDictionary<Player, GameObject> players = new IndexedDictionary<Player, GameObject>();
+	protected IndexedDictionary<Entity, GameObject> entities = new IndexedDictionary<Entity, GameObject>();
 
 	// Use this for initialization
 	IEnumerator Start () {
@@ -85,9 +85,9 @@ void JoinRoom ()
 			Debug.Log("Joined room successfully.");
 			m_SessionIdText.text = "sessionId: " + room.SessionId;
 
-			room.State.players.OnAdd += OnPlayerAdd;
-			room.State.players.OnRemove += OnPlayerRemove;
-			room.State.players.OnChange += OnPlayerMove;
+			room.State.entities.OnAdd += OnEntityAdd;
+			room.State.entities.OnRemove += OnEntityRemove;
+			room.State.entities.OnChange += OnEntityMove;
 
 			PlayerPrefs.SetString("sessionId", room.SessionId);
 			PlayerPrefs.Save();
@@ -117,9 +117,9 @@ void ReJoinRoom ()
 			Debug.Log("Joined room successfully.");
 			m_SessionIdText.text = "sessionId: " + room.SessionId;
 
-			room.State.players.OnAdd += OnPlayerAdd;
-			room.State.players.OnRemove += OnPlayerRemove;
-			room.State.players.OnChange += OnPlayerMove;
+			room.State.entities.OnAdd += OnEntityAdd;
+			room.State.entities.OnRemove += OnEntityRemove;
+			room.State.entities.OnChange += OnEntityMove;
 		};
 
 		room.OnStateChange += OnStateChangeHandler;
@@ -131,12 +131,12 @@ void LeaveRoom()
 		room.Leave(false);
 
 		// Destroy player entities
-		foreach (KeyValuePair<Player, GameObject> entry in players)
+		foreach (KeyValuePair<Entity, GameObject> entry in entities)
 		{
 			Destroy(entry.Value);
 		}
 
-		players.Clear();
+		entities.Clear();
 	}
 
 	void SendMessage()
@@ -163,7 +163,7 @@ void OnStateChangeHandler (object sender, StateChangeEventArgs<State> e)
 		Debug.Log("State has been updated!");
 	}
 
-	void OnPlayerAdd(object sender, KeyValueEventArgs<Player, string> item)
+	void OnEntityAdd(object sender, KeyValueEventArgs<Entity, string> item)
 	{
 		GameObject cube = GameObject.CreatePrimitive(PrimitiveType.Cube);
 
@@ -172,23 +172,23 @@ void OnPlayerAdd(object sender, KeyValueEventArgs<Player, string> item)
 		cube.transform.position = new Vector3(item.Value.x, item.Value.y, 0);
 
 		// add "player" to map of players
-		players.Add(item.Value, cube);
+		entities.Add(item.Value, cube);
 	}
 
-	void OnPlayerRemove(object sender, KeyValueEventArgs<Player, string> item)
+	void OnEntityRemove(object sender, KeyValueEventArgs<Entity, string> item)
 	{
 		GameObject cube;
-		players.TryGetValue(item.Value, out cube);
+		entities.TryGetValue(item.Value, out cube);
 		Destroy(cube);
 
-		players.Remove(item.Value);
+		entities.Remove(item.Value);
 	}
 
 
-	void OnPlayerMove (object sender, KeyValueEventArgs<Player, string> item)
+	void OnEntityMove (object sender, KeyValueEventArgs<Entity, string> item)
 	{
 		GameObject cube;
-		players.TryGetValue (item.Value, out cube);
+		entities.TryGetValue (item.Value, out cube);
 
 		Debug.Log(item.Value.x);
 

Assets/Player.cs

@@ -2,17 +2,13 @@
 // THIS FILE HAS BEEN GENERATED AUTOMATICALLY
 // DO NOT CHANGE IT MANUALLY UNLESS YOU KNOW WHAT YOU'RE DOING
 // 
+// GENERATED USING @colyseus/schema 0.4.25-alpha.0
+// 
 
 using Colyseus.Schema;
 
-public class Player : Schema {
-	[Type("number")]
-	public float x = 0;
-
-	[Type("number")]
-	public float y = 0;
-
-	[Type("boolean")]
+public class Player : Entity {
+	[Type(2, "boolean")]
 	public bool connected = false;
 }
 

Assets/Plugins/Colyseus/Serializer/Schema/Schema.cs

@@ -3,6 +3,9 @@
 using System.Collections.Specialized;
 using System.Collections.Generic;
 using System.Reflection;
+using System.Linq;
+
+using UnityEngine;
 
 /***
   Allowed primitive types:
@@ -28,15 +31,39 @@
 
 namespace Colyseus.Schema
 {
-  [AttributeUsage(AttributeTargets.Field)]
-  public class Type : Attribute
+  class Context 
   {
+    protected static Context instance = new Context();
+    protected List<System.Type> types = new List<System.Type>();
+    protected Dictionary<uint, System.Type> typeIds = new Dictionary<uint, System.Type>();
+
+    public static Context GetInstance()
+    {
+      return instance;
+    }
+
+    public void SetTypeId(System.Type type, uint typeid)
+    {
+			Debug.Log(">>>>>>> SET TYPE ID: " + typeid + ", Type => " + type.Name);
+      typeIds[typeid] = type;
+    }
+
+    public System.Type Get(uint typeid)
+    {
+      return typeIds[typeid];
+    }
+  }
 
+  [AttributeUsage(AttributeTargets.Field, AllowMultiple = false)]
+  public class Type : Attribute
+  {
+    public int Index;
     public string FieldType;
     public System.Type ChildType;
 
-    public Type(string type, System.Type childType = null)
+    public Type(int index, string type, System.Type childType = null)
     {
+      Index = index; // GetType().GetFields() doesn't guarantee order of fields, need to manually track them here!
       FieldType = type;
       ChildType = childType;
     }
@@ -51,6 +78,7 @@ public enum SPEC: byte
     END_OF_STRUCTURE = 0xc1, // (msgpack spec: never used)
     NIL = 0xc0,
     INDEX_CHANGE = 0xd4,
+    TYPE_ID = 0xd5
   }
 
   public class DataChange
@@ -86,12 +114,13 @@ public interface ISchemaCollection
     void InvokeOnAdd(object item, object index);
     void InvokeOnChange(object item, object index);
     void InvokeOnRemove(object item, object index);
-
-    object CreateItemInstance();
+    
     object GetItems();
     void SetItems(object items);
     void TriggerAll();
 
+    System.Type GetChildType();
+
     bool HasSchemaChild { get; }
     int Count { get; }
     object this[object key] { get; set; }
@@ -127,9 +156,9 @@ public ISchemaCollection Clone()
       return clone;
     }
 
-    public object CreateItemInstance()
+    public System.Type GetChildType()
     {
-      return (T) Activator.CreateInstance(typeof(T));
+      return typeof(T);
     }
 
     public bool HasSchemaChild
@@ -221,9 +250,9 @@ public ISchemaCollection Clone()
       return clone;
     }
 
-    public object CreateItemInstance()
+    public System.Type GetChildType()
     {
-      return (T) Activator.CreateInstance(typeof(T));
+      return typeof(T);
     }
 
     public bool HasSchemaChild
@@ -371,16 +400,14 @@ public class Schema
 
     public Schema()
     {
-      int index = 0;
-
       FieldInfo[] fields = GetType().GetFields();
       foreach (FieldInfo field in fields)
       {
         object[] typeAttributes = field.GetCustomAttributes(typeof(Type), true);
         for (var i=0; i<typeAttributes.Length; i++)
         {
           Type t = (Type)typeAttributes[i];
-          fieldsByIndex.Add(index++, field.Name);
+          fieldsByIndex.Add(t.Index, field.Name);
           fieldTypes.Add(field.Name, t.FieldType);
           if (t.FieldType == "ref" || t.FieldType == "array" || t.FieldType == "map")
           {
@@ -411,6 +438,12 @@ public void Decode(byte[] bytes, Iterator it = null)
       var changes = new List<DataChange>();
       var totalBytes = bytes.Length;
 
+      // skip TYPE_ID of existing instances
+      if (bytes[it.Offset] == (byte) SPEC.TYPE_ID)
+      {
+        it.Offset += 2;
+      }
+
       while (it.Offset < totalBytes)
       {
         var index = bytes[it.Offset++];
@@ -440,7 +473,7 @@ public void Decode(byte[] bytes, Iterator it = null)
           }
           else
           {
-            value = this[field] ?? Activator.CreateInstance(childType);
+            value = this[field] ?? CreateTypeInstance(bytes, it, childType);
             (value as Schema).Decode(bytes, it);
           }
 
@@ -500,7 +533,7 @@ public void Decode(byte[] bytes, Iterator it = null)
 
               if (isNew)
               {
-                item = (Schema)currentValue.CreateItemInstance();
+                item = (Schema)CreateTypeInstance(bytes, it, currentValue.GetChildType());
 
               }
               else if (indexChangedFrom != -1)
@@ -514,7 +547,7 @@ public void Decode(byte[] bytes, Iterator it = null)
 
               if (item == null)
               {
-                item = (Schema)currentValue.CreateItemInstance();
+                item = (Schema)CreateTypeInstance(bytes, it, currentValue.GetChildType());
                 isNew = true;
               }
 
@@ -592,7 +625,7 @@ public void Decode(byte[] bytes, Iterator it = null)
 
             if (isNew && isSchemaType)
             {
-              item = (Schema)currentValue.CreateItemInstance();
+              item = (Schema)CreateTypeInstance(bytes, it, currentValue.GetChildType());
 
             } else if (previousKey != null)
             {
@@ -686,5 +719,54 @@ public void TriggerAll()
 
       OnChange.Invoke(this, new OnChangeEventArgs(changes));
     }
+
+    protected object CreateTypeInstance(byte[] bytes, Iterator it, System.Type type)
+    {
+      if (bytes[it.Offset] == (byte) SPEC.TYPE_ID)
+      {
+        it.Offset++;
+        uint typeId = Decoder.GetInstance().DecodeUint8(bytes, it);
+        System.Type anotherType = Context.GetInstance().Get(typeId);
+				Debug.Log("CreateTypeInstance: (inherited) " + anotherType.Name);
+				return Activator.CreateInstance(anotherType);
+
+      } 
+      else 
+      {
+				Debug.Log("CreateTypeInstance: (default) " + type.Name);
+        return Activator.CreateInstance(type);
+      }
+    }
+  }
+
+  public class ReflectionField : Schema
+  {
+    [Type(0, "string")]
+    public string name;
+
+    [Type(1, "string")]
+    public string type;
+
+    [Type(2, "uint8")]
+    public uint referencedType;
+  }
+
+  public class ReflectionType : Schema
+  {
+    [Type(0, "uint8")]
+    public uint id;
+
+    [Type(1, "array", typeof(ArraySchema<ReflectionField>))]
+    public ArraySchema<ReflectionField> fields = new ArraySchema<ReflectionField>();
   }
+
+  public class Reflection : Schema
+  {
+    [Type(0, "array", typeof(ArraySchema<ReflectionType>))]
+    public ArraySchema<ReflectionType> types = new ArraySchema<ReflectionType>();
+
+    [Type(1, "uint8")]
+    public uint rootType;
+  }
+
 }