fix: suspend inactive capture and bound remote discovery

Author: Pyseph

CONTRIBUTING.md

@@ -18,6 +18,8 @@ There exist different `project.json` files for different purposes:
 Please use the [issue tracker](https://github.com/Pyseph/PacketProfiler/issues) to report any bugs or file feature requests.
 
 ## Developing
+
+Run `lune run tests/performance.luau` with Lune 0.10.4 to check capture lifecycle, bounded discovery, remote subscription cleanup, and Studio bridge demand. These tests load the source modules with mocked engine signals and instance trees; verify UI behavior and frame times separately in Studio. Run `selene src build` and build both `buildplugin.project.json` and `buildrelease.project.json` with Rojo before release.
 Pull requests are welcome! For major changes, please open an issue first to discuss what you would like to change.
 
 ## Adding a new data type

README.md

@@ -22,6 +22,8 @@ The rolling timeline uses timestamped 60 Hz buckets, so its 256 bars consistentl
 
 The interface is rendered with Vide. The timeline is a mirrored cyclic strip: each commit writes one persistent bar slot and shifts the strip, so existing heights remain untouched until their frames genuinely leave the 256-frame window. This avoids full-chart reconciliation and render-frame polling.
 
+Capture runs while either profiler window is open and capture is unpaused. Closing both windows or pausing disconnects capture adapters, remote discovery, and the capture clock; reopening preserves committed frames and starts a fresh capture bucket. Hidden views unmount their contents. The Studio Edit instance does not discover remotes. Play-client remote discovery walks service children incrementally, with at most 256 instances per heartbeat and a 1 ms target budget, without `QueryDescendants` or `GetDescendants`. Existing remotes begin recording as discovery reaches them; newly added remotes connect immediately during capture.
+
 ![image](https://github.com/Pyseph/PacketProfiler/assets/45090858/9a68dc84-0ad5-4358-9e79-8750d9e40b2e)
 ![image](https://user-images.githubusercontent.com/45090858/181864397-9b9d5e82-72fe-4bee-b29f-9b8e5a16aa4d.png)
 
@@ -40,6 +42,8 @@ Requiring the in-game package returns the running profiler. In a Studio client w
 
 Layers describe a source of traffic and receive an `Emit` function. The value returned by `Start` is used as the layer's cleanup function.
 
+`Start` can run again after capture resumes. Return cleanup that disconnects the adapter's listeners and cancels its background work. Studio-bridged adapters follow capture demand from the Play and Edit windows, and only flush packets when a batch is pending. Update the plugin and in-game package together for bridge protocol version 4.
+
 ```luau
 local ReplicatedStorage = game:GetService("ReplicatedStorage")
 local PacketProfiler = require(ReplicatedStorage.Packages.PacketProfiler)

build/main.server.luau

@@ -25,8 +25,9 @@ local PacketProfiler = Toolbar:CreateButton("Open Profiler", "Open Profiler Grap
 local PacketChart = Toolbar:CreateButton("Open Chart", "Open Pie Chart", "rbxassetid://10283406077")
 
 local profiler = Profiler.new()
-profiler:RegisterLayer(RemoteLayer)
-profiler:Start()
+if isTestDataModel then
+	profiler:RegisterLayer(RemoteLayer)
+end
 local stopStudioBridge
 if isTestDataModel then
 	local StudioBridgeTransport = require(Modules.StudioBridgeTransport)

src/Components/MainPlugin.luau

@@ -11,14 +11,19 @@ local function MainPlugin(props)
 	return Vide.mount(function()
 		local theme = StudioTheme()
 		local state = UIState(props)
-		local profilerView = PacketProfilerView({ State = state, Theme = theme })
+		Vide.effect(function()
+			if state.ProfilerEnabled() then
+				Vide.cleanup(Vide.mount(function()
+					PacketProfilerView({ State = state, Theme = theme })
+				end))
+			end
+		end)
 		local chartView = PacketChart({
 			Plugin = props.Plugin,
 			State = state,
 			Theme = theme,
 		})
 
-		Vide.cleanup(profilerView)
 		Vide.cleanup(chartView)
 	end)
 end

src/Components/PacketChart.luau

@@ -23,7 +23,7 @@ local create = Vide.create
 local source = Vide.source
 local switch = Vide.switch
 
-local function PacketChart(props)
+local function PacketChartContents(props, target)
 	local state = props.State
 	local profiler = state.Profiler
 	local arcs = source({})
@@ -210,8 +210,14 @@ local function PacketChart(props)
 		})
 	end
 
+	return holder(target)
+end
+
+local function PacketChart(props)
+	local state = props.State
+	local parent
 	if Packages.IsPlugin then
-		local widget = StudioWidget({
+		parent = StudioWidget({
 			DefaultSize = Vector2.new(520, 420),
 			Enabled = state.ChartEnabled,
 			InitialDockState = Enum.InitialDockState.Float,
@@ -222,18 +228,23 @@ local function PacketChart(props)
 			WidgetTitle = "Packet details",
 			ZIndexBehavior = Enum.ZIndexBehavior.Sibling,
 		})
-		return holder(widget)
+	else
+		parent = create("ScreenGui")({
+			Enabled = state.ChartEnabled,
+			IgnoreGuiInset = true,
+			Parent = Players.LocalPlayer.PlayerGui,
+			ResetOnSpawn = false,
+			ZIndexBehavior = Enum.ZIndexBehavior.Sibling,
+		})
 	end
-
-	local screen = create("ScreenGui")({
-		Enabled = state.ChartEnabled,
-		IgnoreGuiInset = true,
-		Parent = Players.LocalPlayer.PlayerGui,
-		ResetOnSpawn = false,
-		ZIndexBehavior = Enum.ZIndexBehavior.Sibling,
-	})
-	holder(screen)
-	return screen
+	Vide.effect(function()
+		if state.ChartEnabled() then
+			cleanup(Vide.mount(function()
+				PacketChartContents(props, parent)
+			end))
+		end
+	end)
+	return parent
 end
 
 return PacketChart

src/Components/PacketCircleArcs.luau

@@ -118,13 +118,17 @@ local function PacketCircleArcs(props)
 	effect(function()
 		read(props.Arcs)
 		actualAlpha(0)
+		local elapsed = 0
+		local connection
+		connection = RunService.RenderStepped:Connect(function(deltaTime)
+			elapsed = math.min(elapsed + deltaTime * 2, 1)
+			actualAlpha(elapsed)
+			if elapsed == 1 then
+				connection:Disconnect()
+			end
+		end)
+		cleanup(connection)
 	end)
-	cleanup(RunService.RenderStepped:Connect(function(deltaTime)
-		local alpha = actualAlpha()
-		if alpha < 1 then
-			actualAlpha(math.min(alpha + deltaTime * 2, 1))
-		end
-	end))
 
 	return create("Frame")({
 		AnchorPoint = Vector2.new(0.5, 0.5),

src/Modules/BridgeProtocol.luau

@@ -5,7 +5,10 @@ local BridgeProtocol = {
 	OutboundName = "PacketProfilerBridgeOutbound.profiler",
 	OwnerAttribute = "PacketProfilerStudioBridge",
 	VersionAttribute = "PacketProfilerBridgeVersion",
-	Version = 3,
+	CaptureAttribute = "PacketProfilerCapturing",
+	CaptureChanged = "CaptureChanged",
+	RequestCaptureState = "RequestCaptureState",
+	Version = 4,
 	RegisterLayer = "RegisterLayer",
 	RegistrationResult = "RegistrationResult",
 	RecordBatch = "RecordBatch",

src/Modules/BridgeReceiver.luau

@@ -133,7 +133,7 @@ end
 function BridgeReceiver:Receive(ownerId, command, first, second, third)
 	if command == BridgeProtocol.RegisterLayer then
 		self:_registerLayer(ownerId, first, second, third)
-	elseif command == BridgeProtocol.RecordBatch and type(second) == "table" then
+	elseif command == BridgeProtocol.RecordBatch and self.Profiler:IsCapturing() and type(second) == "table" then
 		for _, item in second do
 			self:_record(ownerId, first, item)
 		end

src/Modules/Profiler.luau

@@ -44,6 +44,7 @@ function Profiler.new()
 		FrameBatchCommitted = Signal.new(),
 		LayersChanged = Signal.new(),
 		PauseChanged = Signal.new(),
+		CaptureChanged = Signal.new(),
 		ViewChanged = Signal.new(),
 		SelectionChanged = Signal.new(),
 		TopFramesChanged = Signal.new(),
@@ -159,7 +160,7 @@ function Profiler:RegisterAddon(addon)
 end
 
 function Profiler:Record(layerId, packet)
-	if self.Paused then
+	if not self:IsCapturing() then
 		return false
 	end
 	local layer = self._registry:Get(layerId)
@@ -216,69 +217,94 @@ function Profiler:SetPaused(paused)
 		return
 	end
 	self.Paused = paused
-	if not paused then
-		self._frames:Seek(os.clock())
-	end
+	self:_updateCapture()
 	self.PauseChanged:Fire(paused)
 end
 
+function Profiler:IsCapturing()
+	return self._running and not self.Paused
+end
+
 function Profiler:SelectFrame(frame)
 	self.SelectedFrame = frame
 	self.SelectionChanged:Fire(frame and self:GetViewFrame(frame) or nil)
 end
 
 function Profiler:_commitFrame()
-	if self.Paused then
+	if not self:IsCapturing() then
 		return nil
 	end
 
 	local frame = self._frames:Commit()
-	if
-		self._topFrames:Record(frame, self._registry:GetAll(), function(targetFrame, view)
+	local topFramesChanged = frame.PacketCount > 0
+		and self._topFrames:Record(frame, self._registry:GetAll(), function(targetFrame, view)
 			return self._frames:GetSize(targetFrame, view)
 		end)
-	then
-		self.TopFramesChanged:Fire()
-	end
 	self._hooks:Run("FrameCommitted", frame)
 	self.FrameCommitted:Fire(frame, self.Frames)
-	return frame
+	return frame, topFramesChanged
 end
 
 function Profiler:Start()
 	if self._running then
 		return
 	end
 	self._running = true
+	self:_updateCapture()
+end
+
+function Profiler:Stop()
+	if not self._running then
+		return
+	end
+	self._running = false
+	self:_updateCapture()
+end
+
+function Profiler:_updateCapture()
+	if self._stepConnection then
+		self._stepConnection:Disconnect()
+		self._stepConnection = nil
+	end
+	if not self:IsCapturing() then
+		self._registry:Stop()
+		self.CaptureChanged:Fire(false)
+		return
+	end
+	self._frames:Seek(os.clock())
 	self._registry:Start()
 
 	local stepSignal = RunService:IsClient() and RunService.RenderStepped or RunService.Heartbeat
 	local elapsed = 0
-	table.insert(
-		self._cleanup,
-		stepSignal:Connect(function(deltaTime)
-			elapsed += deltaTime
-			local framesDue = math.floor(elapsed / FRAME_INTERVAL)
-			if framesDue > 0 then
-				elapsed -= framesDue * FRAME_INTERVAL
-				local skippedFrames = math.max(framesDue - MAX_FRAMES, 0)
-				self._frames:Skip(skippedFrames)
-				local committedFrames = table.create(framesDue - skippedFrames)
-				for _ = 1, framesDue - skippedFrames do
-					local frame = self:_commitFrame()
-					if frame then
-						table.insert(committedFrames, frame)
-					end
-				end
-				if #committedFrames > 0 then
-					self.FrameBatchCommitted:Fire(committedFrames, self.Frames)
+	self._stepConnection = stepSignal:Connect(function(deltaTime)
+		elapsed += deltaTime
+		local framesDue = math.floor(elapsed / FRAME_INTERVAL)
+		if framesDue > 0 then
+			elapsed -= framesDue * FRAME_INTERVAL
+			local skippedFrames = math.max(framesDue - MAX_FRAMES, 0)
+			self._frames:Skip(skippedFrames)
+			local committedFrames = table.create(framesDue - skippedFrames)
+			local topFramesChanged = false
+			for _ = 1, framesDue - skippedFrames do
+				local frame, changed = self:_commitFrame()
+				topFramesChanged = topFramesChanged or changed
+				if frame then
+					table.insert(committedFrames, frame)
 				end
 			end
-		end)
-	)
+			if topFramesChanged then
+				self.TopFramesChanged:Fire()
+			end
+			if #committedFrames > 0 then
+				self.FrameBatchCommitted:Fire(committedFrames, self.Frames)
+			end
+		end
+	end)
+	self.CaptureChanged:Fire(true)
 end
 
 function Profiler:Destroy()
+	self:Stop()
 	for _, cleanup in self._addons do
 		if cleanup then
 			Cleanup.run(cleanup)
@@ -292,6 +318,7 @@ function Profiler:Destroy()
 	self.FrameBatchCommitted:DisconnectAll()
 	self.LayersChanged:DisconnectAll()
 	self.PauseChanged:DisconnectAll()
+	self.CaptureChanged:DisconnectAll()
 	self.ViewChanged:DisconnectAll()
 	self.SelectionChanged:DisconnectAll()
 	self.TopFramesChanged:DisconnectAll()