@chrrxs/robloxstudio-mcp-inspector 2.16.1 → 2.16.3

package/studio-plugin/src/modules/Communication.ts

@@ -18,6 +18,7 @@ import SerializationHandlers from "./handlers/SerializationHandlers";
 import MemoryHandlers from "./handlers/MemoryHandlers";
 import SceneAnalysisHandlers from "./handlers/SceneAnalysisHandlers";
 import EvalRuntimeHandlers from "./handlers/EvalRuntimeHandlers";
+import ClientBroker from "./ClientBroker";
 import ServerUrlSettings from "./ServerUrlSettings";
 import HttpDiagnostics from "./HttpDiagnostics";
 import { Connection, RequestPayload, PollResponse, ReadyResponse } from "../types";
@@ -47,11 +48,11 @@ function computeInstanceId(): string {
 	return `anon:${fresh}`;
 }
 
-const instanceId = computeInstanceId();
 let assignedRole: string | undefined;
 let duplicateInstanceRole = false;
 let hasVersionMismatch = false;
 let lastVersionMismatchWarningKey: string | undefined;
+let lastReadyInstanceId: string | undefined;
 const readyFailureLogKeys = new Set<string>();
 
 // Cache the published place name from MarketplaceService:GetProductInfo so
@@ -59,9 +60,12 @@ const readyFailureLogKeys = new Set<string>();
 // from game.Name (the DataModel name, often "Place1" in edit). We only fetch
 // once per plugin load; the published name doesn't change mid-session.
 let cachedPlaceName: string | undefined;
+let cachedPlaceNamePlaceId: number | undefined;
 
 function resolvePlaceName(): string {
-	if (cachedPlaceName !== undefined) return cachedPlaceName;
+	if (cachedPlaceName !== undefined && cachedPlaceNamePlaceId === game.PlaceId) return cachedPlaceName;
+	cachedPlaceName = undefined;
+	cachedPlaceNamePlaceId = game.PlaceId;
 	if (game.PlaceId === 0) {
 		cachedPlaceName = game.Name;
 		return cachedPlaceName;
@@ -86,6 +90,8 @@ function detectRole(): string {
 	return "client";
 }
 
+const initialRole = detectRole();
+
 type Handler = (data: Record<string, unknown>) => unknown;
 
 const routeMap: Record<string, Handler> = {
@@ -209,21 +215,31 @@ function getConnectionStatus(connIndex: number): string {
 // restarted but hasn't seen our re-ready yet would fire a duplicate /ready.
 let lastReadyPostAt = 0;
 
-// game.Name is sometimes "Place1" at plugin-load time and only settles to
-// the real DataModel name (e.g. "Game" once playtest spawns the play DM)
-// after Studio finishes wiring things up. Re-fire /ready when it changes so
-// get_connected_instances doesn't show a stale dataModelName forever. Set
-// up once per plugin load — the connection passed in is whichever was
-// active when activatePlugin was first called.
+// game.Name and game.PlaceId can both settle after plugin load. PlaceId also
+// changes when an unpublished file is published while MCP is already active.
+// Re-fire /ready so the bridge can migrate anon:<uuid> to place:<PlaceId>.
 let nameChangeConn: RBXScriptConnection | undefined;
-function ensureNameChangeWatcher(conn: Connection): void {
-	if (nameChangeConn) return;
-	const [okSig, signal] = pcall(() => game.GetPropertyChangedSignal("Name"));
-	if (!okSig || !signal) return;
-	nameChangeConn = signal.Connect(() => {
-		// sendReady has its own 2s throttle, so rapid burst changes coalesce.
-		sendReady(conn);
-	});
+let placeIdChangeConn: RBXScriptConnection | undefined;
+function ensureIdentityWatcher(conn: Connection): void {
+	if (!nameChangeConn) {
+		const [okSig, signal] = pcall(() => game.GetPropertyChangedSignal("Name"));
+		if (okSig && signal) {
+			nameChangeConn = signal.Connect(() => {
+				// sendReady has its own 2s throttle, so rapid burst changes coalesce.
+				sendReady(conn);
+			});
+		}
+	}
+	if (!placeIdChangeConn) {
+		const [okSig, signal] = pcall(() => game.GetPropertyChangedSignal("PlaceId"));
+		if (okSig && signal) {
+			placeIdChangeConn = signal.Connect(() => {
+				cachedPlaceName = undefined;
+				cachedPlaceNamePlaceId = undefined;
+				sendReady(conn);
+			});
+		}
+	}
 }
 
 function sendReady(conn: Connection): void {
@@ -231,6 +247,7 @@ function sendReady(conn: Connection): void {
 	const now = tick();
 	if (now - lastReadyPostAt < 2) return; // throttle to ≤1 /ready every 2s
 	lastReadyPostAt = now;
+	const instanceId = computeInstanceId();
 	task.spawn(() => {
 		const [readyOk, readyResult] = pcall(() => {
 			return HttpService.RequestAsync({
@@ -286,6 +303,9 @@ function sendReady(conn: Connection): void {
 		if (parseOk && readyData.assignedRole) {
 			assignedRole = readyData.assignedRole;
 		}
+		lastReadyInstanceId = parseOk && typeIs(readyData.instanceId, "string") && readyData.instanceId !== ""
+			? readyData.instanceId
+			: instanceId;
 		const connectedRole = assignedRole ?? detectRole();
 		if (readyFailureLogKeys.has(readyLogKey)) {
 			readyFailureLogKeys.delete(readyLogKey);
@@ -493,6 +513,17 @@ function activatePlugin(connIndex?: number) {
 	if (!conn.heartbeatConnection) {
 		conn.heartbeatConnection = RunService.Heartbeat.Connect(() => {
 			const now = tick();
+			if (initialRole === "server" && !RunService.IsRunning()) {
+				ClientBroker.disconnectAllProxies();
+				deactivatePlugin(idx);
+				return;
+			}
+			const currentInstanceId = computeInstanceId();
+			if (lastReadyInstanceId !== undefined && currentInstanceId !== lastReadyInstanceId) {
+				cachedPlaceName = undefined;
+				cachedPlaceNamePlaceId = undefined;
+				sendReady(conn);
+			}
 			const currentInterval = conn.consecutiveFailures > 5 ? conn.currentRetryDelay : conn.pollInterval;
 			if (now - conn.lastPoll > currentInterval) {
 				conn.lastPoll = now;
@@ -511,9 +542,8 @@ function activatePlugin(connIndex?: number) {
 		task.spawn(cleanupLegacyEditBridges);
 	}
 
-	// Watch for game.Name updates so a stale "Place1" captured at first
-	// /ready gets refreshed once Studio settles on the real DM name.
-	ensureNameChangeWatcher(conn);
+	// Watch identity fields so stale name or anon instance ids are refreshed.
+	ensureIdentityWatcher(conn);
 }
 
 function deactivatePlugin(connIndex?: number) {

package/studio-plugin/src/modules/ServerUrlSettings.ts

@@ -8,17 +8,26 @@ function init(p: Plugin): void {
 	pluginRef = p;
 }
 
-function computeInstanceId(): string {
+function addUnique(values: string[], value: string): void {
+	if (!values.includes(value)) {
+		values.push(value);
+	}
+}
+
+function computeInstanceIds(): string[] {
+	const ids: string[] = [];
 	if (game.PlaceId !== 0) {
-		return `place:${tostring(game.PlaceId)}`;
+		addUnique(ids, `place:${tostring(game.PlaceId)}`);
 	}
 	const existing = ServerStorage.GetAttribute("__MCPPlaceId");
 	if (typeIs(existing, "string") && existing !== "") {
-		return `anon:${existing as string}`;
+		addUnique(ids, `anon:${existing as string}`);
+	} else if (game.PlaceId === 0) {
+		const fresh = HttpService.GenerateGUID(false);
+		pcall(() => ServerStorage.SetAttribute("__MCPPlaceId", fresh));
+		addUnique(ids, `anon:${fresh}`);
 	}
-	const fresh = HttpService.GenerateGUID(false);
-	pcall(() => ServerStorage.SetAttribute("__MCPPlaceId", fresh));
-	return `anon:${fresh}`;
+	return ids;
 }
 
 function settingKey(instanceId: string): string {
@@ -27,16 +36,20 @@ function settingKey(instanceId: string): string {
 
 function rememberServerUrl(serverUrl: string): void {
 	if (!pluginRef || serverUrl === "") return;
-	const key = settingKey(computeInstanceId());
-	pcall(() => pluginRef!.SetSetting(key, serverUrl));
+	for (const instanceId of computeInstanceIds()) {
+		const key = settingKey(instanceId);
+		pcall(() => pluginRef!.SetSetting(key, serverUrl));
+	}
 }
 
 function readServerUrl(): string | undefined {
 	if (!pluginRef) return undefined;
-	const key = settingKey(computeInstanceId());
-	const [ok, value] = pcall(() => pluginRef!.GetSetting(key));
-	if (ok && typeIs(value, "string") && value !== "") {
-		return value as string;
+	for (const instanceId of computeInstanceIds()) {
+		const key = settingKey(instanceId);
+		const [ok, value] = pcall(() => pluginRef!.GetSetting(key));
+		if (ok && typeIs(value, "string") && value !== "") {
+			return value as string;
+		}
 	}
 	return undefined;
 }

package/studio-plugin/src/modules/StopPlayMonitor.ts

@@ -1,6 +1,9 @@
 // Cross-DM stop_playtest signaling via plugin:SetSetting, scoped by
 // per-instance setting key so the same Studio process can host playtests
 // for multiple places without one place's stop_playtest yanking another's.
+// During publish-after-connect, both "anon:<uuid>" and "place:<PlaceId>"
+// can refer to the same Studio place, so stop requests are mirrored across
+// both keys while the monitor waits for a matching result on either key.
 //
 // `plugin:SetSetting` / `plugin:GetSetting` is a per-plugin persistent store
 // shared across every DataModel the plugin runs in (edit DMs, play-server
@@ -71,23 +74,36 @@ function init(p: Plugin): void {
 // agree on the place identifier (published places: placeId; unpublished:
 // UUID on ServerStorage's __MCPPlaceId attribute, travels with the .rbxl
 // into the play DM).
-function computeInstanceId(): string {
+function addUnique(values: string[], value: string): void {
+	if (!values.includes(value)) {
+		values.push(value);
+	}
+}
+
+function computeInstanceIds(): string[] {
+	const ids: string[] = [];
 	if (game.PlaceId !== 0) {
-		return `place:${tostring(game.PlaceId)}`;
+		addUnique(ids, `place:${tostring(game.PlaceId)}`);
 	}
 	const existing = ServerStorage.GetAttribute("__MCPPlaceId");
 	if (typeIs(existing, "string") && existing !== "") {
-		return `anon:${existing as string}`;
+		addUnique(ids, `anon:${existing as string}`);
+	} else if (game.PlaceId === 0) {
+		const fresh = HttpService.GenerateGUID(false);
+		pcall(() => ServerStorage.SetAttribute("__MCPPlaceId", fresh));
+		addUnique(ids, `anon:${fresh}`);
 	}
-	const fresh = HttpService.GenerateGUID(false);
-	pcall(() => ServerStorage.SetAttribute("__MCPPlaceId", fresh));
-	return `anon:${fresh}`;
+	return ids;
 }
 
 function settingKey(instanceId: string): string {
 	return SETTING_KEY_PREFIX + instanceId;
 }
 
+function settingKeys(): string[] {
+	return computeInstanceIds().map((instanceId) => settingKey(instanceId));
+}
+
 function readSetting(key: string): unknown {
 	if (!pluginRef) return undefined;
 	const [ok, value] = pcall(() => pluginRef!.GetSetting(key));
@@ -146,7 +162,12 @@ function handleStopRequest(key: string, request: StopPayload): void {
 	}
 
 	if (endTestIssued) {
-		writeResult(key, request, true);
+		writeResult(
+			key,
+			request,
+			false,
+			"StudioTestService:EndTest was already issued for this play session, but the runtime DataModel is still alive.",
+		);
 		return;
 	}
 
@@ -168,18 +189,19 @@ function startMonitor(): void {
 		warn("[robloxstudio-mcp] StopPlayMonitor.startMonitor called before init; skipping");
 		return;
 	}
-	const myKey = settingKey(computeInstanceId());
 	task.spawn(() => {
 		while (true) {
-			const value = readSetting(myKey);
-			if (value === true) {
-				// Legacy boolean requests are ambiguous and may be stale from
-				// a prior crashed session. New stop requests use token payloads.
-				writeSetting(myKey, false);
-			} else {
-				const payload = decodePayload(value);
-				if (payload) {
-					handleStopRequest(myKey, payload);
+			for (const myKey of settingKeys()) {
+				const value = readSetting(myKey);
+				if (value === true) {
+					// Legacy boolean requests are ambiguous and may be stale from
+					// a prior crashed session. New stop requests use token payloads.
+					writeSetting(myKey, false);
+				} else {
+					const payload = decodePayload(value);
+					if (payload) {
+						handleStopRequest(myKey, payload);
+					}
 				}
 			}
 			task.wait(POLL_INTERVAL_SEC);
@@ -189,28 +211,32 @@ function startMonitor(): void {
 
 function requestStop(): StopRequestResult {
 	if (!pluginRef) return { ok: false };
-	const myKey = settingKey(computeInstanceId());
 	const requestId = HttpService.GenerateGUID(false);
-	const ok = writePayload(myKey, {
+	const payload: StopPayload = {
 		kind: "request",
 		id: requestId,
 		requestedAt: tick(),
-	});
+	};
+	let ok = false;
+	for (const myKey of settingKeys()) {
+		ok = writePayload(myKey, payload) || ok;
+	}
 	return { ok, requestId: ok ? requestId : undefined };
 }
 
 function waitForConsumption(requestId: string): StopConsumptionResult {
 	if (!pluginRef) return { ok: false, consumed: false, error: "Plugin reference is not initialized." };
-	const myKey = settingKey(computeInstanceId());
 	const start = tick();
 	while (tick() - start < WAIT_FOR_CONSUMPTION_TIMEOUT_SEC) {
-		const payload = decodePayload(readSetting(myKey));
-		if (payload && payload.kind === "result" && payload.id === requestId) {
-			return {
-				ok: payload.ok === true,
-				consumed: true,
-				error: payload.error,
-			};
+		for (const myKey of settingKeys()) {
+			const payload = decodePayload(readSetting(myKey));
+			if (payload && payload.kind === "result" && payload.id === requestId) {
+				return {
+					ok: payload.ok === true,
+					consumed: true,
+					error: payload.error,
+				};
+			}
 		}
 		task.wait(WAIT_POLL_SEC);
 	}
@@ -223,12 +249,13 @@ function waitForConsumption(requestId: string): StopConsumptionResult {
 
 function clearPending(requestId?: string): void {
 	if (!pluginRef) return;
-	const myKey = settingKey(computeInstanceId());
-	if (requestId !== undefined) {
-		const payload = decodePayload(readSetting(myKey));
-		if (payload && payload.id !== requestId) return;
+	for (const myKey of settingKeys()) {
+		if (requestId !== undefined) {
+			const payload = decodePayload(readSetting(myKey));
+			if (payload && payload.id !== requestId) continue;
+		}
+		writeSetting(myKey, false);
 	}
-	writeSetting(myKey, false);
 }
 
 export = {