< 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:155
Coverable lines:155
Total lines:268
Line coverage:0% (0 of 155)
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%72800%
InitMessageTypeToBridgeName()0%2100%
ProcessMessages()0%3421800%
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.Server;
 8
 9public class WebSocketCommunication : IKernelCommunication
 10{
 11    public static event Action<DCLWebSocketService> OnWebSocketServiceAdded;
 12    public static DCLWebSocketService service;
 13
 14    WebSocketServer ws;
 15    private Coroutine updateCoroutine;
 16    private bool requestStop = false;
 17
 018    private Dictionary<string, GameObject> bridgeGameObjects = new Dictionary<string, GameObject>();
 19
 020    public Dictionary<string, string> messageTypeToBridgeName = new Dictionary<string, string>(); // Public to be able t
 21
 22    [System.NonSerialized]
 023    public static Queue<DCLWebSocketService.Message> queuedMessages = new Queue<DCLWebSocketService.Message>();
 24
 25    [System.NonSerialized]
 26    public static volatile bool queuedMessagesDirty;
 27
 028    public bool isServerReady => ws.IsListening;
 29
 30    private string StartServer(int port, int maxPort, bool withSSL)
 31    {
 032        if (port > maxPort)
 33        {
 034            throw new SocketException((int)SocketError.AddressAlreadyInUse);
 35        }
 36        string wssServerUrl;
 037        string wssServiceId = "dcl";
 38        try
 39        {
 040            if (withSSL)
 41            {
 042                wssServerUrl = $"wss://localhost:{port}/";
 043                ws = new WebSocketServer(wssServerUrl)
 44                {
 45                    SslConfiguration =
 46                    {
 47                        ServerCertificate = CertificateUtils.CreateSelfSignedCert(),
 48                        ClientCertificateRequired = false,
 49                        CheckCertificateRevocation = false,
 050                        ClientCertificateValidationCallback = (sender, certificate, chain, sslPolicyErrors) => true,
 51                        EnabledSslProtocols = System.Security.Authentication.SslProtocols.Tls12
 52                    },
 53                    KeepClean = false
 54                };
 055            }
 56            else
 57            {
 058                wssServerUrl = $"ws://localhost:{port}/";
 059                ws = new WebSocketServer(wssServerUrl);
 60            }
 61
 062            ws.AddWebSocketService("/" + wssServiceId, () =>
 63            {
 064                service = new DCLWebSocketService();
 065                OnWebSocketServiceAdded?.Invoke(service);
 066                return service;
 67            });
 068            ws.Start();
 069        }
 070        catch (InvalidOperationException e)
 71        {
 072            ws.Stop();
 073            if (withSSL) // Search for available ports only if we're using SSL
 74            {
 075                SocketException se = (SocketException)e.InnerException;
 076                if (se is { SocketErrorCode: SocketError.AddressAlreadyInUse })
 77                {
 078                    return StartServer(port + 1, maxPort, withSSL);
 79                }
 80            }
 081            throw new InvalidOperationException(e.Message, e.InnerException);
 82        }
 83
 084        string wssUrl = wssServerUrl + wssServiceId;
 085        return wssUrl;
 086    }
 87
 088    public WebSocketCommunication(bool withSSL = false, int startPort = 5000, int endPort = 5100)
 89    {
 090        InitMessageTypeToBridgeName();
 91
 092        DCL.DataStore.i.debugConfig.isWssDebugMode = true;
 93
 094        string url = StartServer(startPort, endPort, withSSL);
 95
 096        Debug.Log("WebSocket Server URL: " + url);
 97
 098        DataStore.i.wsCommunication.url = url;
 99
 0100        DataStore.i.wsCommunication.communicationReady.Set(true);
 101
 0102        updateCoroutine = CoroutineStarter.Start(ProcessMessages());
 0103    }
 104
 105    private void InitMessageTypeToBridgeName()
 106    {
 107        // Please, use `Bridges` as a bridge name, avoid adding messages here. The system will use `Bridges` as the defa
 0108        messageTypeToBridgeName["SetDebug"] = "Main";
 0109        messageTypeToBridgeName["SetSceneDebugPanel"] = "Main";
 0110        messageTypeToBridgeName["ShowFPSPanel"] = "Main";
 0111        messageTypeToBridgeName["HideFPSPanel"] = "Main";
 0112        messageTypeToBridgeName["SetEngineDebugPanel"] = "Main";
 0113        messageTypeToBridgeName["SendSceneMessage"] = "Main";
 0114        messageTypeToBridgeName["LoadParcelScenes"] = "Main";
 0115        messageTypeToBridgeName["UnloadScene"] = "Main";
 0116        messageTypeToBridgeName["Reset"] = "Main";
 0117        messageTypeToBridgeName["CreateGlobalScene"] = "Main";
 0118        messageTypeToBridgeName["BuilderReady"] = "Main";
 0119        messageTypeToBridgeName["UpdateParcelScenes"] = "Main";
 0120        messageTypeToBridgeName["LoadProfile"] = "Main";
 0121        messageTypeToBridgeName["AddUserProfileToCatalog"] = "Main";
 0122        messageTypeToBridgeName["AddUserProfilesToCatalog"] = "Main";
 0123        messageTypeToBridgeName["RemoveUserProfilesFromCatalog"] = "Main";
 0124        messageTypeToBridgeName["ActivateRendering"] = "Main";
 0125        messageTypeToBridgeName["DeactivateRendering"] = "Main";
 0126        messageTypeToBridgeName["ForceActivateRendering"] = "Main";
 0127        messageTypeToBridgeName["AddWearablesToCatalog"] = "Main";
 0128        messageTypeToBridgeName["WearablesRequestFailed"] = "Main";
 0129        messageTypeToBridgeName["RemoveWearablesFromCatalog"] = "Main";
 0130        messageTypeToBridgeName["ClearWearableCatalog"] = "Main";
 0131        messageTypeToBridgeName["InitializeFriends"] = "Main";
 0132        messageTypeToBridgeName["UpdateFriendshipStatus"] = "Main";
 0133        messageTypeToBridgeName["UpdateUserPresence"] = "Main";
 0134        messageTypeToBridgeName["FriendNotFound"] = "Main";
 0135        messageTypeToBridgeName["AddMessageToChatWindow"] = "Main";
 0136        messageTypeToBridgeName["UpdateMinimapSceneInformation"] = "Main";
 0137        messageTypeToBridgeName["UpdateHotScenesList"] = "Main";
 0138        messageTypeToBridgeName["SetRenderProfile"] = "Main";
 0139        messageTypeToBridgeName["CrashPayloadRequest"] = "Main";
 0140        messageTypeToBridgeName["SetDisableAssetBundles"] = "Main";
 0141        messageTypeToBridgeName["DumpRendererLockersInfo"] = "Main";
 0142        messageTypeToBridgeName["PublishSceneResult"] = "Main";
 0143        messageTypeToBridgeName["BuilderProjectInfo"] = "Main";
 0144        messageTypeToBridgeName["BuilderInWorldCatalogHeaders"] = "Main";
 0145        messageTypeToBridgeName["RequestedHeaders"] = "Main";
 0146        messageTypeToBridgeName["AddAssets"] = "Main";
 0147        messageTypeToBridgeName["RunPerformanceMeterTool"] = "Main";
 0148        messageTypeToBridgeName["InstantiateBotsAtWorldPos"] = "Main";
 0149        messageTypeToBridgeName["InstantiateBotsAtCoords"] = "Main";
 0150        messageTypeToBridgeName["StartBotsRandomizedMovement"] = "Main";
 0151        messageTypeToBridgeName["StopBotsMovement"] = "Main";
 0152        messageTypeToBridgeName["RemoveBot"] = "Main";
 0153        messageTypeToBridgeName["ClearBots"] = "Main";
 0154        messageTypeToBridgeName["ToggleSceneBoundingBoxes"] = "Main";
 0155        messageTypeToBridgeName["TogglePreviewMenu"] = "Main";
 0156        messageTypeToBridgeName["ToggleSceneSpawnPoints"] = "Main";
 157
 0158        messageTypeToBridgeName["Teleport"] = "CharacterController";
 159
 0160        messageTypeToBridgeName["SetRotation"] = "CameraController";
 161
 0162        messageTypeToBridgeName["ShowNotificationFromJson"] = "HUDController";
 0163        messageTypeToBridgeName["ConfigureHUDElement"] = "HUDController";
 0164        messageTypeToBridgeName["ShowTermsOfServices"] = "HUDController";
 0165        messageTypeToBridgeName["RequestTeleport"] = "HUDController";
 0166        messageTypeToBridgeName["ShowAvatarEditorInSignUp"] = "HUDController";
 0167        messageTypeToBridgeName["SetUserTalking"] = "HUDController";
 0168        messageTypeToBridgeName["SetUsersMuted"] = "HUDController";
 0169        messageTypeToBridgeName["ShowWelcomeNotification"] = "HUDController";
 0170        messageTypeToBridgeName["UpdateBalanceOfMANA"] = "HUDController";
 0171        messageTypeToBridgeName["SetPlayerTalking"] = "HUDController";
 0172        messageTypeToBridgeName["SetVoiceChatEnabledByScene"] = "HUDController";
 0173        messageTypeToBridgeName["TriggerSelfUserExpression"] = "HUDController";
 0174        messageTypeToBridgeName["AirdroppingRequest"] = "HUDController";
 175
 0176        messageTypeToBridgeName["GetMousePosition"] = "BuilderController";
 0177        messageTypeToBridgeName["SelectGizmo"] = "BuilderController";
 0178        messageTypeToBridgeName["ResetObject"] = "BuilderController";
 0179        messageTypeToBridgeName["ZoomDelta"] = "BuilderController";
 0180        messageTypeToBridgeName["SetPlayMode"] = "BuilderController";
 0181        messageTypeToBridgeName["TakeScreenshot"] = "BuilderController";
 0182        messageTypeToBridgeName["ResetBuilderScene"] = "BuilderController";
 0183        messageTypeToBridgeName["SetBuilderCameraPosition"] = "BuilderController";
 0184        messageTypeToBridgeName["SetBuilderCameraRotation"] = "BuilderController";
 0185        messageTypeToBridgeName["ResetBuilderCameraZoom"] = "BuilderController";
 0186        messageTypeToBridgeName["SetGridResolution"] = "BuilderController";
 0187        messageTypeToBridgeName["OnBuilderKeyDown"] = "BuilderController";
 0188        messageTypeToBridgeName["UnloadBuilderScene"] = "BuilderController";
 0189        messageTypeToBridgeName["SetSelectedEntities"] = "BuilderController";
 0190        messageTypeToBridgeName["GetCameraTargetBuilder"] = "BuilderController";
 0191        messageTypeToBridgeName["PreloadFile"] = "BuilderController";
 0192        messageTypeToBridgeName["SetBuilderConfiguration"] = "BuilderController";
 193
 0194        messageTypeToBridgeName["SetTutorialEnabled"] = "TutorialController";
 0195        messageTypeToBridgeName["SetTutorialEnabledForUsersThatAlreadyDidTheTutorial"] = "TutorialController";
 196
 0197        messageTypeToBridgeName["VoiceChatStatus"] = "VoiceChatController";
 0198    }
 199
 200    IEnumerator ProcessMessages()
 201    {
 0202        var hudControllerGO = GameObject.Find("HUDController");
 0203        var mainGO = GameObject.Find("Main");
 204
 0205        while (!requestStop)
 206        {
 0207            lock (queuedMessages)
 208            {
 0209                if (queuedMessagesDirty)
 210                {
 0211                    while (queuedMessages.Count > 0)
 212                    {
 0213                        DCLWebSocketService.Message msg = queuedMessages.Dequeue();
 214
 0215                        switch (msg.type)
 216                        {
 217                            // Add to this list the messages that are used a lot and you want better performance
 218                            case "SendSceneMessage":
 0219                                DCL.Environment.i.world.sceneController.SendSceneMessage(msg.payload);
 0220                                break;
 221                            case "Reset":
 0222                                DCL.Environment.i.world.sceneController.UnloadAllScenesQueued();
 0223                                break;
 224                            case "SetVoiceChatEnabledByScene":
 0225                                if (int.TryParse(msg.payload, out int value)) // The payload should be `string`, this wi
 226                                {
 0227                                    hudControllerGO.SendMessage(msg.type, value);
 228                                }
 0229                                break;
 230                            case "RunPerformanceMeterTool":
 0231                                if (float.TryParse(msg.payload, out float durationInSeconds)) // The payload should be `
 232                                {
 0233                                    mainGO.SendMessage(msg.type, durationInSeconds);
 234                                }
 0235                                break;
 236                            default:
 0237                                if (!messageTypeToBridgeName.TryGetValue(msg.type, out string bridgeName))
 238                                {
 0239                                    bridgeName = "Bridges"; // Default bridge
 240                                }
 241
 0242                                if (bridgeGameObjects.TryGetValue(bridgeName, out GameObject bridgeObject) == false)
 243                                {
 0244                                    bridgeObject = GameObject.Find(bridgeName);
 0245                                    bridgeGameObjects.Add(bridgeName, bridgeObject);
 246                                }
 247
 0248                                if (bridgeObject != null)
 249                                {
 0250                                    bridgeObject.SendMessage(msg.type, msg.payload);
 251                                }
 252                                break;
 253                        }
 254
 0255                        if (DCLWebSocketService.VERBOSE)
 256                        {
 0257                            Debug.Log(
 258                                "<b><color=#0000FF>WebSocketCommunication</color></b> >>> Got it! passing message of typ
 259                                msg.type);
 260                        }
 261                    }
 262                }
 0263            }
 0264            yield return null;
 265        }
 0266    }
 0267    public void Dispose() { ws.Stop(); }
 268}