SyntaxGameServer/RCCService2020/ExtraContent/scripts/CoreScripts/Modules/DevConsoleMaster.lua

299 lines
8.9 KiB
Lua

local CoreGui = game:GetService("CoreGui")
local StarterGui = game:GetService("StarterGui")
local UserInputService = game:GetService("UserInputService")
local RunService = game:GetService('RunService')
local CorePackages = game:GetService("CorePackages")
local Players = game:GetService("Players")
local Roact = require(CorePackages.Roact)
local Rodux = require(CorePackages.Rodux)
local RoactRodux = require(CorePackages.RoactRodux)
local DevConsole = script.Parent.DevConsole
local Constants = require(DevConsole.Constants)
local Components = DevConsole.Components
local DevConsoleWindow = require(Components.DevConsoleWindow)
local DataProvider = require(Components.DataProvider)
local Log = require(Components.Log.MainViewLog)
local Memory = require(Components.Memory.MainViewMemory)
local Network = require(Components.Network.MainViewNetwork)
local Scripts = require(Components.Scripts.MainViewScripts)
local DataStores = require(Components.DataStores.MainViewDataStores)
local ServerStats = require(Components.ServerStats.MainViewServerStats)
local ActionBindings = require(Components.ActionBindings.MainViewActionBindings)
local ServerJobs = require(Components.ServerJobs.MainViewServerJobs)
local MicroProfiler = require(Components.MicroProfiler.MainViewMicroProfiler)
local RCCProfilerDataCompleteListener = require(Components.MicroProfiler.RCCProfilerDataCompleteListener)
local getClientReplicator = require(DevConsole.Util.getClientReplicator)
local MainView = require(DevConsole.Reducers.MainView)
local DevConsoleReducer = require(DevConsole.Reducers.DevConsoleReducer)
local Actions = DevConsole.Actions
local SetDevConsoleVisibility = require(Actions.SetDevConsoleVisibility)
local SetTabList = require(Actions.SetTabList)
local MiddleWare = DevConsole.MiddleWare
local DevConsoleAnalytics = require(MiddleWare.DevConsoleAnalytics)
local PolicyService = require(CoreGui.RobloxGui.Modules.Common.PolicyService)
local PlayerPermissionsModule = require(CoreGui.RobloxGui.Modules.PlayerPermissionsModule)
local DFFlagEnableRemoteProfilingForDevConsole = settings():GetFFlag("EnableRemoteProfilingForDevConsole")
local FFlagRespectDisplayOrderForOnTopOfCoreBlur = settings():GetFFlag("RespectDisplayOrderForOnTopOfCoreBlur")
local FFlagDevConsoleAnalyticsIncludeOwner = settings():GetFFlag("DevConsoleAnalyticsIncludeOwner")
local FFlagAdminServerLogs = settings():GetFFlag("AdminServerLogs")
local DEV_TAB_LIST = {
Log = {
tab = Log,
layoutOrder = 1,
hasClientServer = true,
},
Memory = {
tab = Memory,
layoutOrder = 2,
hasClientServer = true,
},
Network = {
tab = Network,
layoutOrder = 3,
hasClientServer = true,
},
Scripts = {
tab = Scripts,
layoutOrder = 4,
},
DataStores = {
tab = DataStores,
layoutOrder = 5,
},
ServerStats = {
tab = ServerStats,
layoutOrder = 6,
},
ActionBindings = {
tab = ActionBindings,
layoutOrder = 7,
},
ServerJobs = {
tab = ServerJobs,
layoutOrder = 8,
},
}
if DFFlagEnableRemoteProfilingForDevConsole then
DEV_TAB_LIST["MicroProfiler"] = {
tab = MicroProfiler,
layoutOrder = 9,
}
end
local PLAYER_TAB_LIST = {
Log = {
tab = Log,
layoutOrder = 1,
},
Memory = {
tab = Memory,
layoutOrder = 2,
},
}
local DevConsoleMaster = {}
DevConsoleMaster.__index = DevConsoleMaster
local platformConversion = {
[Enum.Platform.Windows] = Constants.FormFactor.Large,
[Enum.Platform.OSX] = Constants.FormFactor.Large,
[Enum.Platform.IOS] = Constants.FormFactor.Small,
[Enum.Platform.Android] = Constants.FormFactor.Small,
[Enum.Platform.XBoxOne] = Constants.FormFactor.Console,
[Enum.Platform.PS4] = Constants.FormFactor.Console,
[Enum.Platform.PS3] = Constants.FormFactor.Console,
[Enum.Platform.XBox360] = Constants.FormFactor.Console,
[Enum.Platform.WiiU] = Constants.FormFactor.Console,
[Enum.Platform.NX] = Constants.FormFactor.Console,
[Enum.Platform.Ouya] = Constants.FormFactor.Console,
[Enum.Platform.AndroidTV] = Constants.FormFactor.Console,
[Enum.Platform.Chromecast] = Constants.FormFactor.Console,
[Enum.Platform.Linux] = Constants.FormFactor.Large,
[Enum.Platform.SteamOS] = Constants.FormFactor.Console,
[Enum.Platform.WebOS] = Constants.FormFactor.Large,
[Enum.Platform.DOS] = Constants.FormFactor.Large,
[Enum.Platform.BeOS] = Constants.FormFactor.Large,
[Enum.Platform.UWP] = Constants.FormFactor.Large,
[Enum.Platform.None] = Constants.FormFactor.Large,
}
local function isDeveloper()
if RunService:IsStudio() then
return true
end
if PlayerPermissionsModule.CanPlayerManagePlaceAsync(Players.LocalPlayer) then
return true
end
return false
end
function DevConsoleMaster.new()
local self = {}
setmetatable(self, DevConsoleMaster)
self.init = false
self.waitForStart = true
self.waitForStartBindable = Instance.new("BindableEvent")
coroutine.wrap(function()
self:SetupDevConsole()
end)()
return self
end
function DevConsoleMaster:SetupDevConsole()
-- will need to decide on whether to use DPI and screensize or
-- to use Platform to distinguish between the different form factors
local platformEnum = UserInputService:GetPlatform()
local formFactor = platformConversion[platformEnum]
local isDev = isDeveloper()
local developerConsoleView = isDev
local initTabListForStore
if FFlagAdminServerLogs then
developerConsoleView = false
initTabListForStore = {
MainView = MainView(nil, SetTabList(PLAYER_TAB_LIST, "Log")),
}
else
initTabListForStore = {
MainView = MainView(nil, SetTabList(developerConsoleView and DEV_TAB_LIST or PLAYER_TAB_LIST, "Log")),
}
end
if DFFlagEnableRemoteProfilingForDevConsole and developerConsoleView then
-- we disable the microprofiler tab on non desktop devices.
if formFactor == Constants.FormFactor.Small or
formFactor == Constants.FormFactor.Console then
DEV_TAB_LIST["MicroProfiler"] = nil
end
end
-- create store
local middleWare
if FFlagDevConsoleAnalyticsIncludeOwner then
middleWare = { DevConsoleAnalytics(isDev) }
else
middleWare = { DevConsoleAnalytics }
end
self.store = Rodux.Store.new(DevConsoleReducer, initTabListForStore, middleWare)
local isVisible = self.store:getState().DisplayOptions.isVisible
-- use connector to wrap store and root together
self.root = Roact.createElement(RoactRodux.StoreProvider, {
store = self.store,
}, {
DataProvider = Roact.createElement(DataProvider, {
isDeveloperView = not FFlagAdminServerLogs and developerConsoleView, -- should default to false when FFlag is removed
}, {
App = Roact.createElement("ScreenGui", {
OnTopOfCoreBlur = true,
DisplayOrder = FFlagRespectDisplayOrderForOnTopOfCoreBlur and 10 or nil,
}, {
DevConsoleWindow = Roact.createElement(DevConsoleWindow, {
formFactor = formFactor,
isDeveloperView = developerConsoleView,
isVisible = isVisible, -- determines if visible or not
isMinimized = false, -- false means windowed, otherwise shows up as a minimized bar
position = Constants.MainWindowInit.Position,
size = Constants.MainWindowInit.Size,
tabList = developerConsoleView and DEV_TAB_LIST or PLAYER_TAB_LIST
}),
RCCProfilerDataCompleteListener = Roact.createElement(RCCProfilerDataCompleteListener),
}),
})
})
self.waitForStart = false
self.waitForStartBindable:Fire()
end
local master = DevConsoleMaster.new()
function DevConsoleMaster:Start()
if not self.init then
if self.waitForStart then
self.waitForStartBindable.Event:Wait()
end
self.init = true
self.element = Roact.mount(self.root, CoreGui, "DevConsoleMaster")
if FFlagAdminServerLogs then
local clientReplicator = getClientReplicator()
if clientReplicator then
self._statsConnector = clientReplicator.StatsReceived:connect(function(stats)
self._statsConnector:Disconnect()
self._statsConnector = nil
self.store:dispatch(SetTabList(DEV_TAB_LIST, "Log", true))
end)
clientReplicator:RequestServerStats(true)
end
end
end
end
function DevConsoleMaster:ToggleVisibility()
if PolicyService:IsSubjectToChinaPolicies() then return end
if not self.init then
master:Start()
end
local isVisible = not self.store:getState().DisplayOptions.isVisible
self.store:dispatch(SetDevConsoleVisibility(isVisible))
end
function DevConsoleMaster:GetVisibility()
local state = self.store:getState()
if state then
if state.DisplayOptions then
return state.DisplayOptions.isVisible and not state.DisplayOptions.isMinimized
end
end
end
function DevConsoleMaster:SetVisibility(value)
if type(value) == "boolean" then
if not self.init and value then
master:Start()
end
self.store:dispatch(SetDevConsoleVisibility(value))
end
end
StarterGui:RegisterGetCore("DevConsoleVisible", function()
if PolicyService:IsSubjectToChinaPolicies() then return false end
return master:GetVisibility()
end)
StarterGui:RegisterSetCore("DevConsoleVisible", function(visible)
if (type(visible) ~= "boolean") then
error("DevConsoleVisible must be given a boolean value.")
end
if PolicyService:IsSubjectToChinaPolicies() then return end
master:SetVisibility(visible)
end)
return master