Skip to content

Open-source AI teammates in Slack, Teams, Discord, Telegram and Mattermost. Self-host it, with any agent harness and any model.

perf: fewer managed-agent requests from Console, and one query for their machines (#702)

Louis Amaudruz5e8bd6863105
diff --git a/console/apps/switch-console-desktop/src/main/core/managed-agents/controller.ts b/console/apps/switch-console-desktop/src/main/core/managed-agents/controller.ts
index 8f6caf7ff..1e7fac80d 100644
--- a/console/apps/switch-console-desktop/src/main/core/managed-agents/controller.ts
+++ b/console/apps/switch-console-desktop/src/main/core/managed-agents/controller.ts
@@ -18,6 +18,7 @@ import type {
AdvancedConfigField,
ManagedAgentChanges,
ManagedAgentView,
+ ManagedMachine,
OwnedMachine,
} from '@shared/core/managed-agents/managed-agents';
import { createRPCController } from '@shared/lib/ipc/rpc';
@@ -33,19 +34,28 @@ export const managedAgentsController = createRPCController({
const workspace = await requireWorkspaceForServer(serverId);
return withReachableServerWorkspaceSession(serverId, async (server) => {
let agents;
- let controllers;
+ let machines = new Map<string, ManagedMachine>();
try {
- [agents, controllers] = await Promise.all([
- fetchManagedAgents(server),
- fetchManagementControllers(server),
- ]);
+ agents = await fetchManagedAgents(server);
+ // A server that does not send each agent's machine with it is asked for its machines.
+ if (agents.some((agent) => agent.machine === undefined))
+ machines = new Map(
+ (await fetchManagementControllers(server)).map((controller) => [
+ controller.id,
+ controller,
+ ])
+ );
} catch (error) {
if (error instanceof AgentManagementUnavailableError) return null;
throw error;
}
- const machines = new Map(controllers.map((controller) => [controller.id, controller]));
return agents.map((agent): ManagedAgentView => {
- const machine = agent.controllerId ? machines.get(agent.controllerId) : undefined;
+ const machine =
+ agent.machine !== undefined
+ ? agent.machine
+ : agent.controllerId
+ ? machines.get(agent.controllerId)
+ : undefined;
return {
serverId,
workspaceId: workspace.id,
diff --git a/console/apps/switch-console-desktop/src/main/core/switch-servers/gateway-client.test.ts b/console/apps/switch-console-desktop/src/main/core/switch-servers/gateway-client.test.ts
index 6a2827bf8..b7dd970db 100644
--- a/console/apps/switch-console-desktop/src/main/core/switch-servers/gateway-client.test.ts
+++ b/console/apps/switch-console-desktop/src/main/core/switch-servers/gateway-client.test.ts
@@ -1830,6 +1830,9 @@ describe('agent management calls', () => {
display_name: 'Scout',
icon_url: 'https://icons.example.test/scout.png',
description: 'Finds things',
+ controller_name: 'build-box',
+ controller_kind: 'console',
+ controller_state: 'online',
controller_id: 'controller-1',
desired_state: 'running',
revision: 3,
@@ -1878,6 +1881,7 @@ describe('agent management calls', () => {
iconUrl: 'https://icons.example.test/scout.png',
description: 'Finds things',
controllerId: 'controller-1',
+ machine: { id: 'controller-1', name: 'build-box', kind: 'console', state: 'online' },
desiredState: 'running',
revision: 3,
provider: 'claude',
@@ -1920,6 +1924,7 @@ describe('agent management calls', () => {
iconUrl: null,
description: '',
controllerId: null,
+ machine: null,
desiredState: 'stopped',
revision: 0,
provider: 'unknown',
@@ -1932,6 +1937,8 @@ describe('agent management calls', () => {
status: null,
},
]);
+ const [, older] = await fetchManagedAgents(SERVER);
+ expect(older!.machine).toBeUndefined();
});
it('refuses an advanced configuration of a shape no field takes rather than dropping it', async () => {
diff --git a/console/apps/switch-console-desktop/src/main/core/switch-servers/gateway-client.ts b/console/apps/switch-console-desktop/src/main/core/switch-servers/gateway-client.ts
index a1afbc752..934571659 100644
--- a/console/apps/switch-console-desktop/src/main/core/switch-servers/gateway-client.ts
+++ b/console/apps/switch-console-desktop/src/main/core/switch-servers/gateway-client.ts
@@ -8,7 +8,10 @@ import {
} from '@main/core/managed-switch-server/managed-server-status';
import { assertedTenant } from '@main/core/workspaces/asserted-tenant';
import { cloudLaunchSchema, cloudMachineSchema } from '@shared/core/cloud-agents/cloud-agents';
-import type { AdvancedConfigField } from '@shared/core/managed-agents/managed-agents';
+import type {
+ AdvancedConfigField,
+ ManagedMachine,
+} from '@shared/core/managed-agents/managed-agents';
import { ManagedServerStoppedError } from '@shared/core/managed-switch-server/managed-switch-server';
import type { AgentProviderId } from '@shared/core/providers/agent-provider-registry';
import { HostUnreachableError } from '@shared/core/remote-hosts/reachability';
@@ -2638,6 +2641,12 @@ export type ManagedAgent = {
iconUrl: string | null;
description: string;
controllerId: string | null;
+ /**
+ * The machine it is placed on, as the server sent it with the agent: null
+ * when placed on none, and undefined from a server that does not send it,
+ * whose machines are read from `/controllers` instead.
+ */
+ machine?: ManagedMachine | null;
desiredState: 'running' | 'stopped';
revision: number;
provider: string;
@@ -2680,6 +2689,10 @@ type ManagedAgentJson = {
display_name: string | null;
icon_url?: string | null;
controller_id: string | null;
+ /** Absent from servers older than the machine being sent with the agent. */
+ controller_name?: string | null;
+ controller_kind?: string | null;
+ controller_state?: 'online' | 'offline' | 'unknown' | 'revoked' | null;
desired_state: 'running' | 'stopped';
description?: string;
revision?: number;
@@ -2796,6 +2809,19 @@ function advancedConfigOf(agentId: string, value: unknown): Record<string, Advan
);
}
+function machineOf(json: ManagedAgentJson): ManagedMachine | null | undefined {
+ if (json.controller_id === null) return null;
+ if (json.controller_name === undefined) return undefined;
+ // Placed on a controller the server no longer has a row for: shown as on no machine, as before.
+ if (json.controller_name === null || !json.controller_kind || !json.controller_state) return null;
+ return {
+ id: json.controller_id,
+ name: json.controller_name,
+ kind: json.controller_kind,
+ state: json.controller_state,
+ };
+}
+
function toManagedAgent(json: ManagedAgentJson): ManagedAgent {
return {
agentId: json.agent_id,
@@ -2804,6 +2830,7 @@ function toManagedAgent(json: ManagedAgentJson): ManagedAgent {
iconUrl: json.icon_url ?? null,
description: json.description ?? '',
controllerId: json.controller_id,
+ machine: machineOf(json),
desiredState: json.desired_state,
revision: json.revision ?? 0,
provider: typeof json.definition?.provider === 'string' ? json.definition.provider : 'unknown',
diff --git a/console/apps/switch-console-desktop/src/renderer/features/managed-agents/use-managed-agents.ts b/console/apps/switch-console-desktop/src/renderer/features/managed-agents/use-managed-agents.ts
index 5dc95b912..d7ab5a650 100644
--- a/console/apps/switch-console-desktop/src/renderer/features/managed-agents/use-managed-agents.ts
+++ b/console/apps/switch-console-desktop/src/renderer/features/managed-agents/use-managed-agents.ts
@@ -1,23 +1,42 @@
-import { useQuery } from '@tanstack/react-query';
+import { useQuery, useQueryClient } from '@tanstack/react-query';
+import { useEffect } from 'react';
import { switchServersStore } from '@renderer/features/switch-servers/switch-servers-store';
-import { rpc } from '@renderer/lib/ipc';
+import { events, rpc } from '@renderer/lib/ipc';
import type { ManagedAgentView } from '@shared/core/managed-agents/managed-agents';
+import { agentMigrationChannel } from '@shared/events/agentMigrationEvents';
export const MANAGED_AGENTS_KEY = 'managed-agents';
+/**
+ * How often the list is read again on its own. Changes made from this Console
+ * (an edit, a new agent, a move) refresh it straight away, and react-query
+ * reads it again when the window regains focus and pauses while it is hidden,
+ * so this only bounds how long a change made elsewhere takes to show.
+ */
+const MANAGED_AGENTS_REFRESH_MS = 30_000;
+
/**
* The signed-in user's managed agents on the server, as the server holds them,
* whatever machine each runs on. `null` means the server runs no agent
* management.
*/
export function useManagedAgents(serverId: string | null) {
+ const queryClient = useQueryClient();
const signedIn = serverId !== null && switchServersStore.isConnected(serverId);
const user = serverId === null ? null : (switchServersStore.statusFor(serverId)?.user ?? null);
+ useEffect(
+ () =>
+ events.on(agentMigrationChannel, (event) => {
+ if (event.operation === null)
+ void queryClient.invalidateQueries({ queryKey: [MANAGED_AGENTS_KEY, serverId] });
+ }),
+ [queryClient, serverId]
+ );
return useQuery({
queryKey: [MANAGED_AGENTS_KEY, serverId, user?.id ?? null],
queryFn: () => rpc.managedAgents.list(serverId!),
enabled: signedIn,
- refetchInterval: (query) => (query.state.data === null ? false : 5000),
+ refetchInterval: (query) => (query.state.data === null ? false : MANAGED_AGENTS_REFRESH_MS),
retry: false,
});
}
diff --git a/core/switch_core/management/schemas.py b/core/switch_core/management/schemas.py
index 7a475dec1..3e66a7bb6 100644
--- a/core/switch_core/management/schemas.py
+++ b/core/switch_core/management/schemas.py
@@ -566,6 +566,8 @@ def managed_agent_view(
"icon_url": agent.icon_url,
"description": agent.description,
"controller_id": row.controller_id,
+ "controller_name": controller.name if controller is not None else None,
+ "controller_kind": controller.kind if controller is not None else None,
"controller_state": controller_state,
"desired_state": row.desired_state,
"revision": row.revision,
diff --git a/core/switch_core/management/service.py b/core/switch_core/management/service.py
index bef779ab2..a92ab7ee4 100644
--- a/core/switch_core/management/service.py
+++ b/core/switch_core/management/service.py
@@ -656,7 +656,12 @@ class ManagementService:
async def list_managed_agents(
self, session: AsyncSession, tenant_id: str, owner_id: str
) -> list[dict[str, Any]]:
- controllers: dict[str, AgentController] = {}
+ controllers = {
+ controller.id: controller
+ for controller in await self.controllers.list_for_owner(
+ session, tenant_id, owner_id
+ )
+ }
leases = await self.leases(session)
return [
await self._view(session, tenant_id, row, agent, controllers, leases)
diff --git a/core/tests/switch_core/management/test_gateway_routes.py b/core/tests/switch_core/management/test_gateway_routes.py
index 69c3650b0..26472e07c 100644
--- a/core/tests/switch_core/management/test_gateway_routes.py
+++ b/core/tests/switch_core/management/test_gateway_routes.py
@@ -266,6 +266,7 @@ class TestPlacement:
assert unplace.status_code == 200
assert unplace.json()["controller_id"] is None
assert unplace.json()["controller_state"] is None
+ assert unplace.json()["controller_name"] is None
class TestManagedAgents:
@@ -765,6 +766,8 @@ class TestRevocation:
[agent] = agents.json()
assert agent["agent_id"] == created.json()["agent_id"]
assert agent["controller_state"] == "revoked"
+ assert agent["controller_name"] == listed.json()[0]["name"]
+ assert agent["controller_kind"] == listed.json()[0]["kind"]
assert refused.status_code == 401
assert refused.json()["error"]["code"] == "controller_revoked"