< Summary

Class:WebSocketCommunication
Assembly:WebSocketCommunication
File(s):/tmp/workspace/unity-renderer/unity-renderer/Assets/Scripts/MainScripts/DCL/WorldRuntime/KernelCommunication/WebSocketCommunication/WebSocketCommunication.cs
Covered lines:0
Uncovered lines:166
Coverable lines:166
Total lines:293
Line coverage:0% (0 of 166)
Covered branches:0
Total branches:0

Metrics

MethodBranch coverage Crap Score Cyclomatic complexity NPath complexity Sequence coverage
WebSocketCommunication(...)0%2100%
WebSocketCommunication()0%2100%
StartServer(...)0%90900%
OnWebSocketLog(...)0%42600%
InitMessageTypeToBridgeName()0%2100%
ProcessMessages()0%3061700%
Dispose()0%2100%

File(s)

/tmp/workspace/unity-renderer/unity-renderer/Assets/Scripts/MainScripts/DCL/WorldRuntime/KernelCommunication/WebSocketCommunication/WebSocketCommunication.cs

#LineLine coverage
 1using System;
 2using System.Collections;
 3using System.Collections.Generic;
 4using System.Net.Sockets;
 5using DCL;
 6using UnityEngine;
 7using WebSocketSharp;
 8using WebSocketSharp.Server;
 9
 10public class WebSocketCommunication : IKernelCommunication
 11{
 12    public static event Action<DCLWebSocketService> OnWebSocketServiceAdded;
 13    public static DCLWebSocketService service;
 14
 15    WebSocketServer ws;
 16    private Coroutine updateCoroutine;
 17    private bool requestStop = false;
 18
 019    private Dictionary<string, GameObject> bridgeGameObjects = new Dictionary<string, GameObject>();
 20
 021    public Dictionary<string, string> messageTypeToBridgeName = new Dictionary<string, string>(); // Public to be able t
 22
 23    [System.NonSerialized]
 024    public static Queue<DCLWebSocketService.Message> queuedMessages = new Queue<DCLWebSocketService.Message>();
 25
 26    [System.NonSerialized]
 27    public static volatile bool queuedMessagesDirty;
 28
 029    public bool isServerReady => ws.IsListening;
 30
 31    private string StartServer(int port, int maxPort, bool withSSL, bool verbose = false)
 32    {
 033        if (port > maxPort)
 34        {
 035            throw new SocketException((int)SocketError.AddressAlreadyInUse);
 36        }
 37        string wssServerUrl;
 038        string wssServiceId = "dcl";
 39        try
 40        {
 041            if (withSSL)
 42            {
 043                wssServerUrl = $"wss://localhost:{port}/";
 044                ws = new WebSocketServer(wssServerUrl)
 45                {
 46                    SslConfiguration =
 47                    {
 48                        ServerCertificate = CertificateUtils.CreateSelfSignedCert(),
 49                        ClientCertificateRequired = false,
 50                        CheckCertificateRevocation = false,
 051                        ClientCertificateValidationCallback = (sender, certificate, chain, sslPolicyErrors) => true,
 52                        EnabledSslProtocols = System.Security.Authentication.SslProtocols.Tls12
 53                    },
 54                    KeepClean = false
 55                };
 56            }
 57            else
 58            {
 059                wssServerUrl = $"ws://localhost:{port}/";
 060                ws = new WebSocketServer(wssServerUrl);
 61            }
 62
 063            ws.AddWebSocketService("/" + wssServiceId, () =>
 64            {
 065                service = new DCLWebSocketService();
 066                OnWebSocketServiceAdded?.Invoke(service);
 067                return service;
 68            });
 69
 070            if (verbose)
 71            {
 072                ws.Log.Level = LogLevel.Debug;
 073                ws.Log.Output += OnWebSocketLog;
 74            }
 075            ws.Start();
 076        }
 077        catch (InvalidOperationException e)
 78        {
 079            ws.Stop();
 080            if (withSSL) // Search for available ports only if we're using SSL
 81            {
 082                SocketException se = (SocketException)e.InnerException;
 083                if (se is { SocketErrorCode: SocketError.AddressAlreadyInUse })
 84                {
 085                    return StartServer(port + 1, maxPort, withSSL);
 86                }
 87            }
 088            throw new InvalidOperationException(e.Message, e.InnerException);
 89        }
 90
 091        string wssUrl = wssServerUrl + wssServiceId;
 092        return wssUrl;
 093    }
 94    private void OnWebSocketLog(LogData logData, string message)
 95    {
 096        switch (logData.Level)
 97        {
 98            case LogLevel.Debug:
 099                Debug.Log($"[WebSocket] {logData.Message}");
 0100                break;
 101            case LogLevel.Warn:
 0102                Debug.LogWarning($"[WebSocket] {logData.Message}");
 0103                break;
 104            case LogLevel.Error:
 0105                Debug.LogError($"[WebSocket] {logData.Message}");
 0106                break;
 107            case LogLevel.Fatal:
 0108                Debug.LogError($"[WebSocket] {logData.Message}");
 109                break;
 110        }
 0111    }
 112
 0113    public WebSocketCommunication(bool withSSL = false, int startPort = 5000, int endPort = 5100)
 114    {
 0115        InitMessageTypeToBridgeName();
 116
 0117        DCL.DataStore.i.debugConfig.isWssDebugMode = true;
 118
 0119        string url = StartServer(startPort, endPort, withSSL, DataStore.i.debugConfig.logWs);
 120
 0121        Debug.Log("WebSocket Server URL: " + url);
 122
 0123        DataStore.i.wsCommunication.url = url;
 124
 0125        DataStore.i.wsCommunication.communicationReady.Set(true);
 126
 0127        updateCoroutine = CoroutineStarter.Start(ProcessMessages());
 0128    }
 129
 130    private void InitMessageTypeToBridgeName()
 131    {
 132        // Please, use `Bridges` as a bridge name, avoid adding messages here. The system will use `Bridges` as the defa
 0133        messageTypeToBridgeName["SetDebug"] = "Main";
 0134        messageTypeToBridgeName["SetSceneDebugPanel"] = "Main";
 0135        messageTypeToBridgeName["ShowFPSPanel"] = "Main";
 0136        messageTypeToBridgeName["HideFPSPanel"] = "Main";
 0137        messageTypeToBridgeName["SetEngineDebugPanel"] = "Main";
 0138        messageTypeToBridgeName["SendSceneMessage"] = "Main";
 0139        messageTypeToBridgeName["LoadParcelScenes"] = "Main";
 0140        messageTypeToBridgeName["UnloadScene"] = "Main";
 0141        messageTypeToBridgeName["Reset"] = "Main";
 0142        messageTypeToBridgeName["CreateGlobalScene"] = "Main";
 0143        messageTypeToBridgeName["BuilderReady"] = "Main";
 0144        messageTypeToBridgeName["UpdateParcelScenes"] = "Main";
 0145        messageTypeToBridgeName["LoadProfile"] = "Main";
 0146        messageTypeToBridgeName["AddUserProfileToCatalog"] = "Main";
 0147        messageTypeToBridgeName["AddUserProfilesToCatalog"] = "Main";
 0148        messageTypeToBridgeName["RemoveUserProfilesFromCatalog"] = "Main";
 0149        messageTypeToBridgeName["ActivateRendering"] = "Main";
 0150        messageTypeToBridgeName["DeactivateRendering"] = "Main";
 0151        messageTypeToBridgeName["ForceActivateRendering"] = "Main";
 0152        messageTypeToBridgeName["AddWearablesToCatalog"] = "Main";
 0153        messageTypeToBridgeName["WearablesRequestFailed"] = "Main";
 0154        messageTypeToBridgeName["RemoveWearablesFromCatalog"] = "Main";
 0155        messageTypeToBridgeName["ClearWearableCatalog"] = "Main";
 0156        messageTypeToBridgeName["InitializeFriends"] = "Main";
 0157        messageTypeToBridgeName["UpdateFriendshipStatus"] = "Main";
 0158        messageTypeToBridgeName["UpdateUserPresence"] = "Main";
 0159        messageTypeToBridgeName["FriendNotFound"] = "Main";
 0160        messageTypeToBridgeName["AddMessageToChatWindow"] = "Main";
 0161        messageTypeToBridgeName["UpdateMinimapSceneInformation"] = "Main";
 0162        messageTypeToBridgeName["UpdateHotScenesList"] = "Main";
 0163        messageTypeToBridgeName["SetRenderProfile"] = "Main";
 0164        messageTypeToBridgeName["CrashPayloadRequest"] = "Main";
 0165        messageTypeToBridgeName["SetDisableAssetBundles"] = "Main";
 0166        messageTypeToBridgeName["DumpRendererLockersInfo"] = "Main";
 0167        messageTypeToBridgeName["PublishSceneResult"] = "Main";
 0168        messageTypeToBridgeName["BuilderProjectInfo"] = "Main";
 0169        messageTypeToBridgeName["BuilderInWorldCatalogHeaders"] = "Main";
 0170        messageTypeToBridgeName["RequestedHeaders"] = "Main";
 0171        messageTypeToBridgeName["AddAssets"] = "Main";
 0172        messageTypeToBridgeName["RunPerformanceMeterTool"] = "Main";
 0173        messageTypeToBridgeName["InstantiateBotsAtWorldPos"] = "Main";
 0174        messageTypeToBridgeName["InstantiateBotsAtCoords"] = "Main";
 0175        messageTypeToBridgeName["StartBotsRandomizedMovement"] = "Main";
 0176        messageTypeToBridgeName["StopBotsMovement"] = "Main";
 0177        messageTypeToBridgeName["RemoveBot"] = "Main";
 0178        messageTypeToBridgeName["ClearBots"] = "Main";
 0179        messageTypeToBridgeName["ToggleSceneBoundingBoxes"] = "Main";
 0180        messageTypeToBridgeName["TogglePreviewMenu"] = "Main";
 0181        messageTypeToBridgeName["ToggleSceneSpawnPoints"] = "Main";
 182
 0183        messageTypeToBridgeName["Teleport"] = "CharacterController";
 184
 0185        messageTypeToBridgeName["SetRotation"] = "CameraController";
 186
 0187        messageTypeToBridgeName["ShowNotificationFromJson"] = "HUDController";
 0188        messageTypeToBridgeName["ConfigureHUDElement"] = "HUDController";
 0189        messageTypeToBridgeName["ShowTermsOfServices"] = "HUDController";
 0190        messageTypeToBridgeName["RequestTeleport"] = "HUDController";
 0191        messageTypeToBridgeName["ShowAvatarEditorInSignUp"] = "HUDController";
 0192        messageTypeToBridgeName["SetUserTalking"] = "HUDController";
 0193        messageTypeToBridgeName["SetUsersMuted"] = "HUDController";
 0194        messageTypeToBridgeName["ShowWelcomeNotification"] = "HUDController";
 0195        messageTypeToBridgeName["UpdateBalanceOfMANA"] = "HUDController";
 0196        messageTypeToBridgeName["SetPlayerTalking"] = "HUDController";
 0197        messageTypeToBridgeName["SetVoiceChatEnabledByScene"] = "HUDController";
 0198        messageTypeToBridgeName["TriggerSelfUserExpression"] = "HUDController";
 0199        messageTypeToBridgeName["AirdroppingRequest"] = "HUDController";
 200
 0201        messageTypeToBridgeName["GetMousePosition"] = "BuilderController";
 0202        messageTypeToBridgeName["SelectGizmo"] = "BuilderController";
 0203        messageTypeToBridgeName["ResetObject"] = "BuilderController";
 0204        messageTypeToBridgeName["ZoomDelta"] = "BuilderController";
 0205        messageTypeToBridgeName["SetPlayMode"] = "BuilderController";
 0206        messageTypeToBridgeName["TakeScreenshot"] = "BuilderController";
 0207        messageTypeToBridgeName["ResetBuilderScene"] = "BuilderController";
 0208        messageTypeToBridgeName["SetBuilderCameraPosition"] = "BuilderController";
 0209        messageTypeToBridgeName["SetBuilderCameraRotation"] = "BuilderController";
 0210        messageTypeToBridgeName["ResetBuilderCameraZoom"] = "BuilderController";
 0211        messageTypeToBridgeName["SetGridResolution"] = "BuilderController";
 0212        messageTypeToBridgeName["OnBuilderKeyDown"] = "BuilderController";
 0213        messageTypeToBridgeName["UnloadBuilderScene"] = "BuilderController";
 0214        messageTypeToBridgeName["SetSelectedEntities"] = "BuilderController";
 0215        messageTypeToBridgeName["GetCameraTargetBuilder"] = "BuilderController";
 0216        messageTypeToBridgeName["PreloadFile"] = "BuilderController";
 0217        messageTypeToBridgeName["SetBuilderConfiguration"] = "BuilderController";
 218
 0219        messageTypeToBridgeName["SetTutorialEnabled"] = "TutorialController";
 0220        messageTypeToBridgeName["SetTutorialEnabledForUsersThatAlreadyDidTheTutorial"] = "TutorialController";
 221
 0222        messageTypeToBridgeName["VoiceChatStatus"] = "VoiceChatController";
 0223    }
 224
 225    IEnumerator ProcessMessages()
 226    {
 0227        var hudControllerGO = GameObject.Find("HUDController");
 0228        var mainGO = GameObject.Find("Main");
 229
 0230        while (!requestStop)
 231        {
 0232            lock (queuedMessages)
 233            {
 0234                if (queuedMessagesDirty)
 235                {
 0236                    while (queuedMessages.Count > 0)
 237                    {
 0238                        DCLWebSocketService.Message msg = queuedMessages.Dequeue();
 239
 0240                        switch (msg.type)
 241                        {
 242                            // Add to this list the messages that are used a lot and you want better performance
 243                            case "SendSceneMessage":
 0244                                DCL.Environment.i.world.sceneController.SendSceneMessage(msg.payload);
 0245                                break;
 246                            case "Reset":
 0247                                DCL.Environment.i.world.sceneController.UnloadAllScenesQueued();
 0248                                break;
 249                            case "SetVoiceChatEnabledByScene":
 0250                                if (int.TryParse(msg.payload, out int value)) // The payload should be `string`, this wi
 251                                {
 0252                                    hudControllerGO.SendMessage(msg.type, value);
 253                                }
 0254                                break;
 255                            case "RunPerformanceMeterTool":
 0256                                if (float.TryParse(msg.payload, out float durationInSeconds)) // The payload should be `
 257                                {
 0258                                    mainGO.SendMessage(msg.type, durationInSeconds);
 259                                }
 0260                                break;
 261                            default:
 0262                                if (!messageTypeToBridgeName.TryGetValue(msg.type, out string bridgeName))
 263                                {
 0264                                    bridgeName = "Bridges"; // Default bridge
 265                                }
 266
 0267                                if (bridgeGameObjects.TryGetValue(bridgeName, out GameObject bridgeObject) == false)
 268                                {
 0269                                    bridgeObject = GameObject.Find(bridgeName);
 0270                                    bridgeGameObjects.Add(bridgeName, bridgeObject);
 271                                }
 272
 0273                                if (bridgeObject != null)
 274                                {
 0275                                    bridgeObject.SendMessage(msg.type, msg.payload);
 276                                }
 277                                break;
 278                        }
 279
 0280                        if (DCLWebSocketService.VERBOSE)
 281                        {
 0282                            Debug.Log(
 283                                "<b><color=#0000FF>WebSocketCommunication</color></b> >>> Got it! passing message of typ
 284                                msg.type);
 285                        }
 286                    }
 287                }
 0288            }
 0289            yield return null;
 290        }
 0291    }
 0292    public void Dispose() { ws.Stop(); }
 293}
Generated by: ReportGenerator 4.8.9.0
09/22/2022 - 09:24:52
GitHub | www.palmmedia.de

Methods/Properties

WebSocketCommunication(System.Boolean, System.Int32, System.Int32)
WebSocketCommunication()
isServerReady()
StartServer(System.Int32, System.Int32, System.Boolean, System.Boolean)
OnWebSocketLog(WebSocketSharp.LogData, System.String)
InitMessageTypeToBridgeName()
ProcessMessages()
Dispose()