Query budgets (debugger)

example/src/client/systems/stressTest.luau

@@ -0,0 +1,9 @@
+local ReplicatedStorage = game:GetService("ReplicatedStorage")
+local Components = require(ReplicatedStorage.Shared.components)
+
+local function stressTest(world, _, ui)
+	for id in world:query(Components.Test) do
+	end
+end
+
+return stressTest

example/src/game.client.luau

@@ -1,4 +1,5 @@
 local ReplicatedStorage = game:GetService("ReplicatedStorage")
+local StarterPlayer = game:GetService("StarterPlayer")
 local start = require(ReplicatedStorage.Shared.start)
 local receiveReplication = require(ReplicatedStorage.Client.receiveReplication)
 
@@ -8,3 +9,9 @@ local world, state = start({
 })
 
 receiveReplication(world, state)
+
+local components = require(ReplicatedStorage.Shared.components)
+
+for i = 1, 1000 do
+	world:spawn(components.Test())
+end

example/src/shared/components.luau

@@ -12,6 +12,7 @@ local COMPONENTS = {
 	"Lasering",
 	"DebugLabel",
 	"Spinner",
+	"Test",
 }
 
 local components = {}

lib/Loop.luau

@@ -57,6 +57,7 @@ function Loop.new(...)
 		_middlewares = {},
 		_systemErrors = {},
 		_systemLogs = {},
+		_debugger = nil,
 		profiling = nil,
 		trackErrors = false,
 	}, Loop)
@@ -400,7 +401,22 @@ function Loop:begin(events)
 							profiling[system] = {}
 						end
 
-						rollingAverage.addSample(profiling[system], duration)
+						local debugger = self._debugger
+
+						if debugger and debugger.debugSystem == system and debugger._queries then
+							local totalQueryTime = 0
+
+							for _, query in debugger._queries do
+								totalQueryTime += query.averageDuration
+							end
+
+							rollingAverage.addSample(
+								profiling[system],
+								if debugger.debugSystem then duration - totalQueryTime else duration
+							)
+						else
+							rollingAverage.addSample(profiling[system], duration)
+						end
 					end
 
 					if coroutine.status(thread) ~= "dead" then

lib/debugger/debugger.luau

@@ -168,6 +168,7 @@ function Debugger.new(plasma)
 		componentRefreshFrequency = 3,
 		_windowCount = 0,
 		_queries = {},
+		_queryDurationSamples = {},
 		_seenEvents = {},
 		_eventOrder = {},
 		_eventBridge = EventBridge.new(function(...)
@@ -344,6 +345,7 @@ end
 ]=]
 function Debugger:autoInitialize(loop)
 	self.loop = loop
+	loop._debugger = self
 
 	self.loop.trackErrors = true
 

lib/debugger/hookWorld.luau

@@ -1,14 +1,37 @@
+--#selene:allow(empty_loop)
 local useCurrentSystem = require(script.Parent.Parent.topoRuntime).useCurrentSystem
 local World = require(script.Parent.Parent.World)
+local rollingAverage = require(script.Parent.Parent.rollingAverage)
 
 local originalQuery = World.query
 
 local function hookWorld(debugger)
 	World.query = function(world, ...)
 		if useCurrentSystem() == debugger.debugSystem then
+			local start = os.clock()
+
+			for _ in originalQuery(world, ...) do
+			end
+
+			local duration = os.clock() - start
+			local file, line = debug.info(2, "sl")
+
+			if debugger._queryDurationSamples[file .. line] == nil then
+				debugger._queryDurationSamples[file .. line] = {}
+			end
+
+			rollingAverage.addSample(debugger._queryDurationSamples[file .. line], duration)
+
+			local averageDuration = rollingAverage.getAverage(debugger._queryDurationSamples[file .. line])
+
+			local componentNames = {}
+			for i = 1, select("#", ...) do
+				table.insert(componentNames, tostring((select(i, ...))))
+			end
+
 			table.insert(debugger._queries, {
-				components = { ... },
-				result = originalQuery(world, ...),
+				averageDuration = averageDuration,
+				componentNames = componentNames,
 			})
 		end
 

lib/debugger/ui.luau

@@ -144,7 +144,6 @@ local function ui(debugger, loop)
 					local samples = loop.profiling[system]
 					if samples then
 						local duration = rollingAverage.getAverage(samples)
-
 						durations[system] = duration
 						longestDuration = math.max(longestDuration, duration)
 					end
@@ -178,7 +177,6 @@ local function ui(debugger, loop)
 				end
 
 				local selected = custom.selectionList(items):selected()
-
 				if selected then
 					if selected.system == debugger.debugSystem then
 						debugger.debugSystem = nil
@@ -187,6 +185,12 @@ local function ui(debugger, loop)
 					end
 				end
 
+				if debugger.debugSystem then
+					debugger.debugSystemRuntime = durations[debugger.debugSystem]
+				else
+					debugger.debugSystemRuntime = nil
+				end
+
 				plasma.space(10)
 			end
 		end)

lib/debugger/widgets/queryInspect.luau

@@ -1,5 +1,3 @@
-local format = require(script.Parent.Parent.formatTable)
-
 return function(plasma)
 	return plasma.widget(function(debugger)
 		return plasma
@@ -20,43 +18,11 @@ return function(plasma)
 						continue
 					end
 
-					plasma.heading(string.format("Query %d", i))
-
-					local componentNames = {}
-
-					for _, component in query.components do
-						table.insert(componentNames, tostring(component))
-					end
-
-					plasma.label(table.concat(componentNames, ", "))
-
-					local items = { { "ID", unpack(componentNames) } }
-
-					while #items <= 10 do
-						local data = { query.result:next() }
+					local budgetUsed =
+						math.clamp(math.floor((query.averageDuration / debugger.debugSystemRuntime) * 100), 0, 100)
 
-						if #data == 0 then
-							break
-						end
-
-						for index, value in data do
-							if type(value) == "table" then
-								data[index] = format.formatTable(value)
-							else
-								data[index] = tostring(value)
-							end
-						end
-
-						table.insert(items, data)
-					end
-
-					plasma.table(items, {
-						headings = true,
-					})
-
-					if #items > 10 and query.result:next() then
-						plasma.label("(further results truncated)")
-					end
+					plasma.heading(`<b>Query {i} - {budgetUsed}%</b>`)
+					plasma.label(table.concat(query.componentNames, ", "))
 				end
 				return nil
 			end)