ISceneRuntime.cs

using CrdtEcsBridge.JsModulesImplementation.Communications;
using CrdtEcsBridge.PoolsProviders;
using Cysharp.Threading.Tasks;
using DCL.Multiplayer.Connections.DecentralandUrls;
using DCL.Multiplayer.Connections.RoomHubs;
using DCL.Multiplayer.Profiles.Poses;
using DCL.Profiles;
using DCL.Profiling;
using DCL.Web3;
using DCL.Web3.Identities;
using DCL.WebRequests;
using ECS;
using Microsoft.ClearScript.V8;
using PortableExperiences.Controller;
using SceneRunner.Scene;
using SceneRunner.Scene.ExceptionsHandling;
using SceneRuntime.Apis.Modules;
using SceneRuntime.Apis.Modules.CommsApi;
using SceneRuntime.Apis.Modules.CommunicationsControllerApi;
using SceneRuntime.Apis.Modules.CommunicationsControllerApi.SDKMessageBus;
using SceneRuntime.Apis.Modules.EngineApi;
using SceneRuntime.Apis.Modules.EngineApi.SDKObservableEvents;
using SceneRuntime.Apis.Modules.Ethereums;
using SceneRuntime.Apis.Modules.FetchApi;
using SceneRuntime.Apis.Modules.Players;
using SceneRuntime.Apis.Modules.PortableExperiencesApi;
using SceneRuntime.Apis.Modules.RestrictedActionsApi;
using SceneRuntime.Apis.Modules.Runtime;
using SceneRuntime.Apis.Modules.SceneApi;
using SceneRuntime.Apis.Modules.SignedFetch;
using SceneRuntime.Apis.Modules.UserActions;
using SceneRuntime.Apis.Modules.UserIdentityApi;
using System;
using System.Threading;

namespace SceneRuntime
{
    public interface ISceneRuntime : IDisposable
    {
        internal CancellationTokenSource isDisposingTokenSource { get; }

        void Register<T>(string itemName, T target) where T: JsApiWrapper;

        UniTask StartScene();

        UniTask UpdateScene(float dt);

        void ApplyStaticMessages(ReadOnlyMemory<byte> data);

        /// <summary>
        ///     Forcibly interrupts a running JS execution by causing a <see cref="Microsoft.ClearScript.ScriptInterruptedException"/>
        ///     to be thrown from inside the engine. Safe to call from another thread.
        ///     After interrupt the engine state may be inconsistent — treat as terminal and dispose the scene.
        /// </summary>
        void Interrupt();

        void SetIsDisposing();

        void OnSceneIsCurrentChanged(bool isCurrent);

        void RegisterEngineAPIWrapper(EngineApiWrapper newWrapper);

        V8RuntimeHeapInfo RuntimeHeapInfo { get; }

        /// <summary>
        ///     Script-bound array operations of the underlying engine,
        ///     required by the API wrappers that marshal binary data back to the scene
        /// </summary>
        IJsOperations JsOperations { get; }
    }

    public static class SceneRuntimeExtensions
    {
        public static void RegisterAll(this ISceneRuntime sceneRuntime,
            IEngineApi engineApi,
            ISceneExceptionsHandler exceptionsHandler,
            IRoomHub roomHub,
            IProfileRepository profileRepository,
            ISceneApi sceneApi,
            IWebRequestController webRequestController,
            IRestrictedActionsAPI restrictedActionsAPI,
            DecentralandEnvironment dclEnvironment,
            IRuntime runtime,
            IEthereumApi ethereumApi,
            IWebSocketApi webSocketApi,
            IWeb3IdentityCache web3IdentityCache,
            ICommunicationsControllerAPI communicationsControllerAPI,
            IInstancePoolsProvider instancePoolsProvider,
            ISimpleFetchApi simpleFetchApi,
            ISceneData sceneData,
            IRealmData realmData,
            IPortableExperiencesController portableExperiencesController,
            IRemoteMetadata remoteMetadata,
            ISceneCommunicationPipe sceneCommunicationPipe,
            SceneRuntimeMetrics runtimeMetrics
        )
        {
            sceneRuntime.RegisterEngineAPI(sceneData, engineApi, instancePoolsProvider, exceptionsHandler, runtimeMetrics);
            sceneRuntime.RegisterPlayers(roomHub, profileRepository, remoteMetadata);
            sceneRuntime.RegisterSceneApi(sceneApi);
            sceneRuntime.RegisterCommsApi(roomHub, sceneCommunicationPipe, sceneData, exceptionsHandler);
            sceneRuntime.RegisterSignedFetch(webRequestController, dclEnvironment, sceneData, realmData, web3IdentityCache);
            sceneRuntime.RegisterRestrictedActionsApi(restrictedActionsAPI);
            sceneRuntime.RegisterUserActions(restrictedActionsAPI);
            sceneRuntime.RegisterRuntime(runtime, exceptionsHandler);
            sceneRuntime.RegisterEthereumApi(ethereumApi, web3IdentityCache, exceptionsHandler);
            sceneRuntime.RegisterUserIdentityApi(profileRepository, web3IdentityCache, exceptionsHandler);
            sceneRuntime.RegisterWebSocketApi(webSocketApi, exceptionsHandler, realmData.IsLocalSceneDevelopment);
            sceneRuntime.RegisterSimpleFetchApi(simpleFetchApi, webRequestController, realmData.IsLocalSceneDevelopment);
            sceneRuntime.RegisterCommunicationsControllerApi(communicationsControllerAPI, instancePoolsProvider, exceptionsHandler, realmData.IsLocalSceneDevelopment);
            sceneRuntime.RegisterPortableExperiencesApi(portableExperiencesController, exceptionsHandler);
        }

        public static void RegisterAll(this ISceneRuntime sceneRuntime,
            ISDKObservableEventsEngineApi engineApi,
            ISDKMessageBusCommsControllerAPI commsApiImplementation,
            ISceneExceptionsHandler exceptionsHandler,
            IRoomHub roomHub,
            IProfileRepository profileRepository,
            ISceneApi sceneApi,
            IWebRequestController webRequestController,
            IRestrictedActionsAPI restrictedActionsAPI,
            IRuntime runtime,
            IEthereumApi ethereumApi,
            IWebSocketApi webSocketApi,
            IWeb3IdentityCache web3IdentityCache,
            DecentralandEnvironment dclEnvironment,
            ICommunicationsControllerAPI communicationsControllerAPI,
            IInstancePoolsProvider instancePoolsProvider,
            ISimpleFetchApi simpleFetchApi,
            ISceneData sceneData,
            IRealmData realmData,
            IPortableExperiencesController portableExperiencesController,
            IRemoteMetadata remoteMetadata,
            ISceneCommunicationPipe sceneCommunicationPipe,
            SceneRuntimeMetrics runtimeMetrics
        )
        {
            sceneRuntime.RegisterEngineAPI( sceneData, engineApi, commsApiImplementation, instancePoolsProvider, exceptionsHandler, runtimeMetrics);
            sceneRuntime.RegisterPlayers(roomHub, profileRepository, remoteMetadata);
            sceneRuntime.RegisterSceneApi(sceneApi);
            sceneRuntime.RegisterCommsApi(roomHub, sceneCommunicationPipe, sceneData, exceptionsHandler);
            sceneRuntime.RegisterSignedFetch(webRequestController, dclEnvironment, sceneData, realmData, web3IdentityCache);
            sceneRuntime.RegisterRestrictedActionsApi(restrictedActionsAPI);
            sceneRuntime.RegisterUserActions(restrictedActionsAPI);
            sceneRuntime.RegisterRuntime(runtime, exceptionsHandler);
            sceneRuntime.RegisterEthereumApi(ethereumApi, web3IdentityCache, exceptionsHandler);
            sceneRuntime.RegisterUserIdentityApi(profileRepository, web3IdentityCache, exceptionsHandler);
            sceneRuntime.RegisterWebSocketApi(webSocketApi, exceptionsHandler, realmData.IsLocalSceneDevelopment);
            sceneRuntime.RegisterSimpleFetchApi(simpleFetchApi, webRequestController, realmData.IsLocalSceneDevelopment);
            sceneRuntime.RegisterCommunicationsControllerApi(communicationsControllerAPI, instancePoolsProvider, exceptionsHandler, realmData.IsLocalSceneDevelopment);
            sceneRuntime.RegisterPortableExperiencesApi(portableExperiencesController, exceptionsHandler);
        }

        internal static void RegisterEngineAPI(this ISceneRuntime sceneRuntime, ISceneData sceneData, IEngineApi engineApi, IInstancePoolsProvider instancePoolsProvider, ISceneExceptionsHandler sceneExceptionsHandler, SceneRuntimeMetrics runtimeMetrics)
        {
            var newWrapper = new EngineApiWrapper(engineApi, sceneData, instancePoolsProvider, sceneRuntime.JsOperations, sceneExceptionsHandler, runtimeMetrics, sceneRuntime.isDisposingTokenSource);
            sceneRuntime.Register("UnityEngineApi", newWrapper);
            sceneRuntime.RegisterEngineAPIWrapper(newWrapper);
        }

        internal static void RegisterEngineAPI(this ISceneRuntime sceneRuntime, ISceneData sceneData,  ISDKObservableEventsEngineApi engineApi, ISDKMessageBusCommsControllerAPI commsApiImplementation, IInstancePoolsProvider instancePoolsProvider, ISceneExceptionsHandler sceneExceptionsHandler, SceneRuntimeMetrics runtimeMetrics)
        {
            var newWrapper = new SDKObservableEventsEngineApiWrapper(engineApi, sceneData, commsApiImplementation, instancePoolsProvider, sceneRuntime.JsOperations, sceneExceptionsHandler, runtimeMetrics, sceneRuntime.isDisposingTokenSource);
            sceneRuntime.Register("UnityEngineApi", newWrapper);
            sceneRuntime.RegisterEngineAPIWrapper(newWrapper);
        }

        private static void RegisterPlayers(this ISceneRuntime sceneRuntime, IRoomHub roomHub, IProfileRepository profileRepository, IRemoteMetadata remoteMetadata)
        {
            sceneRuntime.Register("UnityPlayers", new PlayersWrap(roomHub, profileRepository, remoteMetadata, sceneRuntime.isDisposingTokenSource));
        }

        private static void RegisterSceneApi(this ISceneRuntime sceneRuntime, ISceneApi api)
        {
            sceneRuntime.Register("UnitySceneApi", new SceneApiWrapper(api, sceneRuntime.isDisposingTokenSource));
        }

        private static void RegisterCommsApi(this ISceneRuntime sceneRuntime, IRoomHub roomHub, ISceneCommunicationPipe sceneCommunicationPipe, ISceneData sceneData, ISceneExceptionsHandler sceneExceptionsHandler)
        {
            sceneRuntime.Register("CommsApi", new CommsApiWrap(roomHub, sceneCommunicationPipe, sceneData, sceneExceptionsHandler, sceneRuntime.isDisposingTokenSource));
        }

        private static void RegisterSignedFetch(
            this ISceneRuntime sceneRuntime,
            IWebRequestController webRequestController,
            DecentralandEnvironment dclEnvironment,
            ISceneData sceneData,
            IRealmData realmData,
            IWeb3IdentityCache web3IdentityCache
        )
        {
            sceneRuntime.Register("UnitySignedFetch", new SignedFetchWrap(webRequestController, dclEnvironment, sceneData, realmData, web3IdentityCache, sceneRuntime.isDisposingTokenSource));
        }

        private static void RegisterRestrictedActionsApi(this ISceneRuntime sceneRuntime, IRestrictedActionsAPI api)
        {
            sceneRuntime.Register("UnityRestrictedActionsApi", new RestrictedActionsAPIWrapper(api, sceneRuntime.isDisposingTokenSource));
        }

        private static void RegisterUserActions(this ISceneRuntime sceneRuntime, IRestrictedActionsAPI api)
        {
            sceneRuntime.Register("UnityUserActions", new UserActionsWrapper(api, sceneRuntime.isDisposingTokenSource));
        }

        private static void RegisterRuntime(this ISceneRuntime sceneRuntime, IRuntime api, ISceneExceptionsHandler sceneExceptionsHandler)
        {
            sceneRuntime.Register("UnityRuntime", new RuntimeWrapper(api, sceneExceptionsHandler, sceneRuntime.isDisposingTokenSource));
        }

        private static void RegisterEthereumApi(this ISceneRuntime sceneRuntime, IEthereumApi ethereumApi, IWeb3IdentityCache web3IdentityCache, ISceneExceptionsHandler sceneExceptionsHandler)
        {
            sceneRuntime.Register("UnityEthereumApi", new EthereumApiWrapper(ethereumApi, sceneExceptionsHandler, web3IdentityCache, sceneRuntime.isDisposingTokenSource));
        }

        private static void RegisterUserIdentityApi(this ISceneRuntime sceneRuntime, IProfileRepository profileRepository, IWeb3IdentityCache identityCache, ISceneExceptionsHandler sceneExceptionsHandler)
        {
            sceneRuntime.Register("UnityUserIdentityApi", new UserIdentityApiWrapper(profileRepository, identityCache, sceneExceptionsHandler, sceneRuntime.isDisposingTokenSource));
        }

        private static void RegisterWebSocketApi(this ISceneRuntime sceneRuntime, IWebSocketApi webSocketApi, ISceneExceptionsHandler sceneExceptionsHandler, bool isLocalSceneDevelopment)
        {
            sceneRuntime.Register("UnityWebSocketApi", new WebSocketApiWrapper(webSocketApi, sceneExceptionsHandler, sceneRuntime.isDisposingTokenSource, isLocalSceneDevelopment));
        }

        private static void RegisterCommunicationsControllerApi(this ISceneRuntime sceneRuntime, ICommunicationsControllerAPI api, IInstancePoolsProvider instancePoolsProvider, ISceneExceptionsHandler sceneExceptionsHandler, bool isLocalSceneDevelopment)
        {
            sceneRuntime.Register("UnityCommunicationsControllerApi", new CommunicationsControllerAPIWrapper(api, instancePoolsProvider, sceneExceptionsHandler, sceneRuntime.isDisposingTokenSource));
        }

        private static void RegisterSimpleFetchApi(this ISceneRuntime sceneRuntime, ISimpleFetchApi simpleFetchApi, IWebRequestController webRequestController, bool isLocalSceneDevelopment)
        {
            sceneRuntime.Register("UnitySimpleFetchApi", new SimpleFetchApiWrapper(simpleFetchApi, webRequestController, sceneRuntime.isDisposingTokenSource, isLocalSceneDevelopment));
        }

        public static void RegisterSDKMessageBusCommsApi(this ISceneRuntime sceneRuntime, ISDKMessageBusCommsControllerAPI api)
        {
            sceneRuntime.Register("UnitySDKMessageBusCommsControllerApi", new SDKMessageBusCommsControllerAPIWrapper(api, sceneRuntime.isDisposingTokenSource));
        }

        private static void RegisterPortableExperiencesApi(this ISceneRuntime sceneRuntime, IPortableExperiencesController portableExperiencesController, ISceneExceptionsHandler sceneExceptionsHandler)
        {
            sceneRuntime.Register("UnityPortableExperiencesApi", new PortableExperiencesApiWrapper(portableExperiencesController, sceneExceptionsHandler, sceneRuntime.isDisposingTokenSource));
        }
    }
}