From f51e974ac17780c49fc0865de9826bf94af4b6f9 Mon Sep 17 00:00:00 2001
From: Jordan Dalton <jordan.8474@gmail.com>
Date: Thu, 2 Nov 2017 15:18:11 +0000
Subject: [PATCH] fix: async issues

Ok. So, last update broke when multiple people connected because the writelock wasn't being re-set to 0. Hopefully this design keeps everything in sync and doesn't crash.
---
 .travis.yml                   |   3 +
 CHANGELOG.rst                 |  62 ++++++++
 README.md                     |   3 +-
 src/Live Map.sln              |   2 +
 src/Live Map/Live Map.csproj  |   6 +
 src/Live Map/LiveMap.cs       |   1 +
 src/Live Map/SocketHandler.cs | 269 ++++++++++++++--------------------
 version.json                  |   2 +-
 8 files changed, 183 insertions(+), 165 deletions(-)

diff --git a/.travis.yml b/.travis.yml
index 33547eb..86c052d 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -5,3 +5,6 @@ script:
 notifications:
     webhooks:
         secure: "Fu1CjQiphlvok3BPJNFc4Xx7SP4DvZK84tItIHqCLIgF+VqiIZBkaVMtQ3ipeYMYPWTrZtHW+xdyUsTGaRkD85E+vVijAYDmBDh3ewf0nmcNLHx639cLBAttPBieH11KrICAZOMvabzhVic0cQSDcn0+V1aRsv+XMF45pLPaMwCdW9Kz/eeE7PsbNR7GWL2fxsYKsFSvaVE+lXEyOk89rOxuHJmXje794YeS0EcZPdwKQggL27mW09QObwm27PGOWeD3ngxBoZ3dR6EHDUVdlvJitH4EzbUUiHi458oddhL3HxyOjYcjsv2sGyex0+ItxAqVrgB6bWgjRhwHQWXfSC6D5+JN7icT3ZVn+X9viUwPMMht/B/knYNb/j6YbsBqtoTBR8s5DJp5r0J6Ku1wT+RW7mSEIUTwGpQO4Zd9449cZUP5/zA77HMzhmCqFSDByah6xKucKPicAxPFLYSS7wxy3qcbNXoMKSlOoZ0McL4CYjilnIhY9apJ086OvoCy5YlfzvsDTVeJLgL62j6aQNiuFsOdxkggWS/Lfwchc0joGopPKHpj5LgueQ+oQDsRKdb0EkeiWB3W3P54RqBz1UeeViVc5H4ua5DUlDU3U/gUda4TRT0T7jfGKt8uWiKiUyvWhC8OonQfJEoBTayb4g3Hilc4e12MMf+GixQ5CNo="
+branches:
+    only:
+        - master
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
index 5a173e8..163470d 100644
--- a/CHANGELOG.rst
+++ b/CHANGELOG.rst
@@ -2,9 +2,71 @@ Changelog
 =========
 
 
+v2.2.3 (02-11-2017)
+-------------------
+
+Changes
+~~~~~~~
+- Update changelog. [Jordan Dalton]
+
+  Now it just shows the master build status as that's all we're building.
+- Update travis.yml. [Jordan Dalton]
+
+  Hopefully this makes it only build the master branch and merge/PRs.
+
+Fix
+~~~
+- Fixed async issues. [Jordan Dalton]
+
+  Ok. So, last update broke when multiple people connected because the writelock wasn't being re-set to 0. Hopefully this design keeps everything in sync and doesn't crash.
+
+
+v2.2.2 (02-11-2017)
+-------------------
+
+New
+~~~
+- Add more null checks to the API. [Jordan Dalton]
+
+  Someone complained that they were crashing when null data was being sent to the API (specifically the `RemovePlayer`) so, I've added null checks to hopefully catch any null data being passed and not do anything with it.
+- Add Discord notifications for builds. [Jordan Dalton]
+
+  Hopefully this works...
+- Add build status to Readme. [Jordan Dalton]
+- Add Unix configuration for building. [Jordan Dalton]
+- Add CitizenFX library to source files. [Jordan Dalton]
+
+Changes
+~~~~~~~
+- Update changelog. [Jordan Dalton]
+- Update version.json. [Jordan Dalton]
+
+  Now it's 2.2.2
+
+Fix
+~~~
+- Fixed travis webhook. [Jordan Dalton]
+- Fixed post-build events being tiggered on Linux. [Jordan Dalton]
+
+Other
+~~~~~
+- Merge branch 'develop' [Jordan Dalton]
+- Changed CI to Travis. [Jordan Dalton]
+
+  Travis is more secure and I trust it more..
+- Create .travis.yml. [Jordan Dalton]
+- Changed the post-build parameters. [Jordan Dalton]
+- Getting ready for Jenkins! [Jordan Dalton]
+- Merge branch 'develop' [Jordan Dalton]
+
+
 v2.2.1 (01-11-2017)
 -------------------
 
+Changes
+~~~~~~~
+- Update version and changelog. [Jordan Dalton]
+
 Fix
 ~~~
 - Fixed typo in README.md. [Tom Grobbe]
diff --git a/README.md b/README.md
index 95d7910..d876c45 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,6 @@
 # fivem-live_map
 
-Master: [![Master Build](https://travis-ci.org/TGRHavoc/live_map.svg?branch=master)](https://travis-ci.org/TGRHavoc/live_map)
-Develop: [![Develop Build](https://travis-ci.org/TGRHavoc/live_map.svg?branch=develop)](https://travis-ci.org/TGRHavoc/live_map)
+[![Master Build](https://travis-ci.org/TGRHavoc/live_map.svg?branch=master)](https://travis-ci.org/TGRHavoc/live_map)
 
 This is the "backend" code for the live_map addon for FiveM that is ran on the
 game server.
diff --git a/src/Live Map.sln b/src/Live Map.sln
index 8f446a8..24bd414 100644
--- a/src/Live Map.sln	
+++ b/src/Live Map.sln	
@@ -8,12 +8,14 @@ EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
+		Debug|Unix = Debug|Unix
 		Release|Any CPU = Release|Any CPU
 		Release|Unix = Release|Unix
 	EndGlobalSection
 	GlobalSection(ProjectConfigurationPlatforms) = postSolution
 		{15269C18-91AF-4129-8FA0-3601D1B0C6D2}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{15269C18-91AF-4129-8FA0-3601D1B0C6D2}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{15269C18-91AF-4129-8FA0-3601D1B0C6D2}.Debug|Unix.ActiveCfg = Debug|Any CPU
 		{15269C18-91AF-4129-8FA0-3601D1B0C6D2}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{15269C18-91AF-4129-8FA0-3601D1B0C6D2}.Release|Any CPU.Build.0 = Release|Any CPU
 		{15269C18-91AF-4129-8FA0-3601D1B0C6D2}.Release|Unix.ActiveCfg = Release|Unix
diff --git a/src/Live Map/Live Map.csproj b/src/Live Map/Live Map.csproj
index 4cf04f4..5d5aca7 100644
--- a/src/Live Map/Live Map.csproj	
+++ b/src/Live Map/Live Map.csproj	
@@ -80,6 +80,12 @@
     COPY /Y "$(TargetDir)\Newtonsoft.Json.dll" "F:\fx-server\resources\live_map"
 	</PostBuildEvent>
   </PropertyGroup>
+  <PropertyGroup>
+    <PostBuildEvent>COPY /Y "$(TargetPath)" "F:\fx-server\resources\live_map\server"
+COPY /Y "$(TargetDir)\deniszykov.WebSocketListener.dll" "F:\fx-server\resources\live_map"
+COPY /Y "$(TargetDir)\Newtonsoft.Json.dll" "F:\fx-server\resources\live_map"
+	</PostBuildEvent>
+  </PropertyGroup>
   <!-- To modify your build process, add your task inside one of the targets below and uncomment it. 
        Other similar extension points exist, see Microsoft.Common.targets.
   <Target Name="BeforeBuild">
diff --git a/src/Live Map/LiveMap.cs b/src/Live Map/LiveMap.cs
index 16a22ef..2fc2c5f 100644
--- a/src/Live Map/LiveMap.cs	
+++ b/src/Live Map/LiveMap.cs	
@@ -92,6 +92,7 @@ public void OnStart(string name)
                 {
                     server.Start();
                     Tick += server.ListenAsync;
+
                     Tick += handler.SendWebsocketData;
 
                 }catch(Exception e)
diff --git a/src/Live Map/SocketHandler.cs b/src/Live Map/SocketHandler.cs
index b88afa5..c0c8f73 100644
--- a/src/Live Map/SocketHandler.cs	
+++ b/src/Live Map/SocketHandler.cs	
@@ -36,7 +36,9 @@ class SocketHandler
         JObject playerData;
 
         ConcurrentDictionary<string, WebSocket> clients = new ConcurrentDictionary<string, WebSocket>();
-        static double writeLock = 0;
+
+        ConcurrentQueue<JObject> sendQueue = new ConcurrentQueue<JObject>();
+
 
         public SocketHandler(WebSocketServer server)
         {
@@ -84,11 +86,11 @@ private void Server_OnDisconnect(WebSocket ws)
             if (clients.TryRemove(ws.RemoteEndpoint.ToString(), out destory))
             {
                 destory.Dispose();
-                LiveMap.Log(LiveMap.LogLevel.All, "Removed {0} socket because it disconnected", ws.RemoteEndpoint.ToString());
+                LiveMap.Log(LiveMap.LogLevel.Basic, "Removed {0} socket because it disconnected", ws.RemoteEndpoint.ToString());
             }
             else
             {
-                LiveMap.Log(LiveMap.LogLevel.All, "Couldn't remove {0} from the clients dic.", ws.RemoteEndpoint.ToString());
+                LiveMap.Log(LiveMap.LogLevel.Basic, "Couldn't remove {0} from the clients dic.", ws.RemoteEndpoint.ToString());
             }
         }
 
@@ -98,7 +100,7 @@ private void Server_OnConnect(WebSocket ws)
 
             if (clients.TryAdd(ws.RemoteEndpoint.ToString(), ws))
             {
-                LiveMap.Log(LiveMap.LogLevel.All, "Added client {0} to the client dictionary", ws.RemoteEndpoint.ToString());
+                LiveMap.Log(LiveMap.LogLevel.Basic, "Added client {0} to the client dictionary", ws.RemoteEndpoint.ToString());
             }
             else
             {
@@ -111,7 +113,6 @@ private void MakeSurePlayerExists(string identifier)
         {
             lock (playerData)
             {
-
                 if (playerData[identifier] == null)
                 {
                     playerData[identifier] = new JObject();
@@ -126,60 +127,48 @@ public async Task SendWebsocketData()
                 // Only send the data every .5 seconds
                 await Task.Delay(TimeSpan.FromMilliseconds(LiveMap.waitSeconds)).ConfigureAwait(false);
 
-                // Generate the payload
-                JObject payload = new JObject();
-                JArray playerDataArray = new JArray();
-                lock (playerData)
+                if (sendQueue.Count != 0)
                 {
-                    foreach (KeyValuePair<string, JToken> data in playerData)
-                    {
-                        playerDataArray.Add(data.Value);
-                    }
-                }
 
-                if(playerDataArray.Count == 0)
-                {
-                    continue;
-                }
-                payload["type"] = "playerData";
-                payload["payload"] = playerDataArray;
+                    JObject payload;
+                    if (sendQueue.TryDequeue(out payload))
+                    {
 
+                        foreach (KeyValuePair<string, WebSocket> pair in clients)
+                        {
+                            string endpoint = pair.Key;
+                            WebSocket ws = pair.Value;
 
-                foreach (KeyValuePair<string, WebSocket> keyPair in clients)
-                {
-                    string endpoint = keyPair.Key;
-                    WebSocket socket = keyPair.Value;
-                    LiveMap.Log(LiveMap.LogLevel.All, "Sending data to {0}", endpoint);
+                            LiveMap.Log(LiveMap.LogLevel.All, "Sending payload of \"{0}\" to {1}", payload["type"], endpoint);
 
-                    if (!socket.IsConnected)
-                    {
-                        LiveMap.Log(LiveMap.LogLevel.All, "Disposing of websocket {0} because it's closed..", endpoint);
-                        socket.Dispose();
-                        return;
-                    }
+                            await ws.WriteStringAsync(payload.ToString(Newtonsoft.Json.Formatting.None)).ConfigureAwait(false);
 
-                    if(Interlocked.CompareExchange(ref writeLock, 1, 0) == 1)
-                    {
-                       while(Interlocked.CompareExchange(ref writeLock, 1, 0) == 1)
-                        {
-                            LiveMap.Log(LiveMap.LogLevel.All, "Waiting untill writelock is 0");
-                            await Task.Delay(100);
                         }
-                    }
 
-                    try
-                    {
-                        await socket.WriteStringAsync(payload.ToString(Newtonsoft.Json.Formatting.None)).ConfigureAwait(true);
                     }
-                    catch (Exception)
+                    else
                     {
-                        LiveMap.Log(LiveMap.LogLevel.Basic, "Couldn't send playerData because of read/write stuff");
+                        LiveMap.Log(LiveMap.LogLevel.Basic, "Couldn't get the latest payload to send.");
                     }
+
+                }else
+                {
+                    //LiveMap.Log(LiveMap.LogLevel.All, "No payload to send... Waiting..");
                 }
+            }
+        }
 
-                writeLock = 0;
+        private void PlayerHadBeenUpdated(string identifier, JToken playerData)
+        {
+            JObject payload = new JObject();
 
-            }
+            payload["type"] = "playerData";
+
+            JArray arr = new JArray();
+            arr.Add(playerData);
+            payload["payload"] = arr;
+
+            sendQueue.Enqueue(payload);
         }
 
         public void AddPlayerData(string identifier, string key, object data)
@@ -187,6 +176,17 @@ public void AddPlayerData(string identifier, string key, object data)
             LiveMap.Log(LiveMap.LogLevel.All, "Adding player {0}'s \"{1}\"", identifier, key);
             MakeSurePlayerExists(identifier);
 
+            if (string.IsNullOrEmpty(identifier))
+            {
+                LiveMap.Log(LiveMap.LogLevel.Basic, "Identifier is null or empty");
+                return;
+            }
+            if (string.IsNullOrEmpty(key))
+            {
+                LiveMap.Log(LiveMap.LogLevel.Basic, "Cannot add key to player ({0}) because it's null or empty", identifier);
+                return;
+            }
+
             if (data == null)
             {
                 LiveMap.Log(LiveMap.LogLevel.Basic, "Cannot add \"{1}\" to player ({0}) because it's null.", identifier, key);
@@ -199,6 +199,8 @@ public void AddPlayerData(string identifier, string key, object data)
 
                 if(playerObj[key] == null)
                     playerObj.Add(key, JToken.FromObject(data));
+
+                PlayerHadBeenUpdated(identifier, playerObj);
             }
 
             LiveMap.Log(LiveMap.LogLevel.Basic, "Added \"{1}\" to player {0} with value of \"{2}\"", identifier, key, data);
@@ -209,6 +211,17 @@ public void UpdatePlayerData(string identifier, string key, object newData)
             LiveMap.Log(LiveMap.LogLevel.All, "Updating player {0}'s \"{1}\"", identifier, key);
             MakeSurePlayerExists(identifier);
 
+            if (string.IsNullOrEmpty(identifier))
+            {
+                LiveMap.Log(LiveMap.LogLevel.Basic, "Identifier is null or empty. Cannot update player data");
+                return;
+            }
+            if (string.IsNullOrEmpty(key))
+            {
+                LiveMap.Log(LiveMap.LogLevel.Basic, "Cannot update player ({0}) because key is null or empty", identifier);
+                return;
+            }
+
             // Check if `data` is null
             if (newData == null)
             {
@@ -221,6 +234,8 @@ public void UpdatePlayerData(string identifier, string key, object newData)
                 JObject playerObj = (JObject)playerData[identifier];
                 playerObj[key] = JToken.FromObject(newData);
                 playerData[identifier] = playerObj;
+
+                PlayerHadBeenUpdated(identifier, playerObj);
             }
 
             LiveMap.Log(LiveMap.LogLevel.All, "Updated player {0}'s \"{1}\" to \"{2}\"", identifier, key, newData);
@@ -228,6 +243,18 @@ public void UpdatePlayerData(string identifier, string key, object newData)
 
         public void RemovePlayerData(string identifier, string key)
         {
+
+            if (string.IsNullOrEmpty(identifier))
+            {
+                LiveMap.Log(LiveMap.LogLevel.Basic, "Identifier is null or empty.. Cannot remove player data");
+                return;
+            }
+            if (string.IsNullOrEmpty(key))
+            {
+                LiveMap.Log(LiveMap.LogLevel.Basic, "Cannot remove data from player ({0}) because key is null or empty", identifier);
+                return;
+            }
+
             MakeSurePlayerExists(identifier);
             lock (playerData)
             {
@@ -237,7 +264,10 @@ public void RemovePlayerData(string identifier, string key)
                     if (playerObj.Remove(key))
                     {
                         LiveMap.Log(LiveMap.LogLevel.Basic, "Removed \"{0}\" from player {1}", key, identifier);
-                    }else
+                        PlayerHadBeenUpdated(identifier, playerObj);
+
+                    }
+                    else
                     {
                         LiveMap.Log(LiveMap.LogLevel.Basic, "Couldn't remove \"{0}\" from player {1}", key, identifier);
                     }
@@ -245,8 +275,14 @@ public void RemovePlayerData(string identifier, string key)
             }
         }
 
-        public async void RemovePlayer(string identifier)
+        public void RemovePlayer(string identifier)
         {
+            if (string.IsNullOrEmpty(identifier))
+            {
+                LiveMap.Log(LiveMap.LogLevel.Basic, "Identifier is null or empty. Cannot remove player");
+                return;
+            }
+
             bool playerLeftBool = false;
             lock (playerData)
             {
@@ -268,39 +304,13 @@ public async void RemovePlayer(string identifier)
 
             if (playerLeftBool)
             {
-                // Tell the client's that someone has left
-
                 JObject payload = new JObject();
                 payload["type"] = "playerLeft";
                 payload["payload"] = identifier;
 
-                if (Interlocked.CompareExchange(ref writeLock, 1, 0) == 1)
-                {
-                    while (Interlocked.CompareExchange(ref writeLock, 1, 0) == 1)
-                    {
-                        LiveMap.Log(LiveMap.LogLevel.All, "RemovePlayer waiting..");
-                        await Task.Delay(100);
-                    }
-                }
-
-                foreach (KeyValuePair<string, WebSocket> pair in clients)
-                {
-                    string endpoint = pair.Key;
-                    WebSocket ws = pair.Value;
-
-                    if (!ws.IsConnected)
-                    {
-                        LiveMap.Log(LiveMap.LogLevel.All, "Disposing of websocket {0} because it's closed..", endpoint);
-                        ws.Dispose();
-                        return;
-                    }
-
-                    await ws.WriteStringAsync(payload.ToString(Newtonsoft.Json.Formatting.None)).ConfigureAwait(false);
-
-                }
-
-                writeLock = 0;
+                sendQueue.Enqueue(payload);
             }
+
         }
 
         private JObject ConvertBlip(dynamic blip)
@@ -332,115 +342,50 @@ private JObject ConvertBlip(dynamic blip)
             return obj;
         }
 
-        public async void AddBlip(dynamic blip)
+        public void AddBlip(dynamic blip)
         {
+            if(blip == null)
+            {
+                LiveMap.Log(LiveMap.LogLevel.Basic, "Cannot add blip as it's null");
+                return;
+            }
+
             JObject payload = new JObject();
             payload["type"] = "addBlip";
             payload["payload"] = ConvertBlip(blip);
 
-            if (Interlocked.CompareExchange(ref writeLock, 1, 0) == 1)
-            {
-                while (Interlocked.CompareExchange(ref writeLock, 1, 0) == 1)
-                {
-                    LiveMap.Log(LiveMap.LogLevel.All, "AddBlip waiting..");
-                    await Task.Delay(100);
-                }
-            }
+            sendQueue.Enqueue(payload);
+        }
 
-            foreach (KeyValuePair<string, WebSocket> pair in clients)
+        public void RemoveBlip(dynamic blip)
+        {
+            if (blip == null)
             {
-                string endpoint = pair.Key;
-                WebSocket ws = pair.Value;
-
-                LiveMap.Log(LiveMap.LogLevel.Basic, "addBlip for blip with id {0} to {1}", blip.type, endpoint);
-
-                if (!ws.IsConnected)
-                {
-                    LiveMap.Log(LiveMap.LogLevel.All, "Disposing of websocket {0} because it's closed..", endpoint);
-                    ws.Dispose();
-                    return;
-                }
-
-                await ws.WriteStringAsync(payload.ToString(Newtonsoft.Json.Formatting.None)).ConfigureAwait(false);
-                //ws.WriteStringAsync(payload.ToString(Newtonsoft.Json.Formatting.None)).Wait(500); 
+                LiveMap.Log(LiveMap.LogLevel.Basic, "Cannot remove blip as it's null");
+                return;
             }
 
-            writeLock = 0;
-
-        }
-
-        public async void RemoveBlip(dynamic blip)
-        {
             JObject payload = new JObject();
             payload["type"] = "removeBlip";
             payload["payload"] = ConvertBlip(blip);
 
-            if(Interlocked.CompareExchange(ref writeLock, 1, 0) == 1)
-            {
-                while(Interlocked.CompareExchange(ref writeLock, 1, 0) == 1)
-                {
-                    LiveMap.Log(LiveMap.LogLevel.All, "RemoveBlip waiting..");
-                    await Task.Delay(100);
-                }
-            }
+            sendQueue.Enqueue(payload);
+        }
 
-            foreach (KeyValuePair<string, WebSocket> pair in clients)
+        public void UpdateBlip(dynamic blip)
+        {
+            if (blip == null)
             {
-                string endpoint = pair.Key;
-                WebSocket ws = pair.Value;
-
-                LiveMap.Log(LiveMap.LogLevel.Basic, "removeBlip for blip with id {0} to {1}", blip.type, endpoint);
-
-                if (!ws.IsConnected)
-                {
-                    LiveMap.Log(LiveMap.LogLevel.All, "Disposing of websocket {0} because it's closed..", endpoint);
-                    ws.Dispose();
-                    return;
-                }
-
-                await ws.WriteStringAsync(payload.ToString(Newtonsoft.Json.Formatting.None)).ConfigureAwait(false);
-
-                //ws.WriteStringAsync(payload.ToString(Newtonsoft.Json.Formatting.None)).Wait(500);
+                LiveMap.Log(LiveMap.LogLevel.Basic, "Cannot update blip as it's null");
+                return;
             }
 
-            writeLock = 0;
-
-        }
-
-        public async void UpdateBlip(dynamic blip)
-        {
             JObject payload = new JObject();
             payload["type"] = "updateBlip";
             payload["payload"] = ConvertBlip(blip);
 
-            if (Interlocked.CompareExchange(ref writeLock, 1, 0) == 1)
-            {
-                while (Interlocked.CompareExchange(ref writeLock, 1, 0) == 1)
-                {
-                    LiveMap.Log(LiveMap.LogLevel.All, "UpdateBlip waiting..");
-                    await Task.Delay(100);
-                }
-            }
+            sendQueue.Enqueue(payload);
 
-            foreach (KeyValuePair<string, WebSocket> pair in clients)
-            {
-                string endpoint = pair.Key;
-                WebSocket ws = pair.Value;
-
-                LiveMap.Log(LiveMap.LogLevel.Basic, "updateBlip for blip with id {0} to {1}", blip.type, endpoint);
-
-                if (!ws.IsConnected)
-                {
-                    LiveMap.Log(LiveMap.LogLevel.All, "Disposing of websocket {0} because it's closed..", endpoint);
-                    ws.Dispose();
-                    return;
-                }
-
-                ws.WriteStringAsync(payload.ToString(Newtonsoft.Json.Formatting.None)).Wait(2000);
-
-                //ws.WriteStringAsync(payload.ToString(Newtonsoft.Json.Formatting.None)).Wait();
-            }
-            writeLock = 0;
         }
 
     }
diff --git a/version.json b/version.json
index 5436ff6..d79467f 100644
--- a/version.json
+++ b/version.json
@@ -1,3 +1,3 @@
 {
-  "resource" : "2.2.1"
+  "resource" : "2.2.3"
 }