|
| 1 | +/** |
| 2 | + * Session tracking for tabs created through the browser tool. |
| 3 | + */ |
| 4 | +import type { BrowserTabOwnership } from "./browser/client.types.js"; |
| 5 | + |
| 6 | +type SessionTabParams = { |
| 7 | + sessionKey?: string; |
| 8 | + targetId?: string; |
| 9 | + baseUrl?: string; |
| 10 | + profile?: string; |
| 11 | + profileAliases?: Array<string | undefined>; |
| 12 | + ownership?: BrowserTabOwnership; |
| 13 | + aliases?: Array<string | undefined>; |
| 14 | +}; |
| 15 | + |
| 16 | +type SessionTabRegistry = { |
| 17 | + trackSessionBrowserTab: (params: SessionTabParams) => void; |
| 18 | + touchSessionBrowserTab: (params: SessionTabParams) => void; |
| 19 | + untrackSessionBrowserTab: (params: SessionTabParams) => void; |
| 20 | +}; |
| 21 | + |
| 22 | +function readString(value: unknown): string | undefined { |
| 23 | + return typeof value === "string" && value.trim() ? value.trim() : undefined; |
| 24 | +} |
| 25 | + |
| 26 | +function readOpenedTab(result: unknown): { |
| 27 | + targetId?: string; |
| 28 | + aliases: string[]; |
| 29 | + profile?: string; |
| 30 | + ownership?: BrowserTabOwnership; |
| 31 | +} { |
| 32 | + if (!result || typeof result !== "object" || Array.isArray(result)) { |
| 33 | + return { aliases: [] }; |
| 34 | + } |
| 35 | + const opened = result as Record<string, unknown>; |
| 36 | + const targetId = readString(opened.targetId); |
| 37 | + const aliases = [ |
| 38 | + targetId, |
| 39 | + readString(opened.tabId), |
| 40 | + readString(opened.label), |
| 41 | + readString(opened.suggestedTargetId), |
| 42 | + ].filter((alias): alias is string => Boolean(alias)); |
| 43 | + const profile = readString(opened.resolvedProfile); |
| 44 | + const rawOwnership = |
| 45 | + opened.ownership && typeof opened.ownership === "object" |
| 46 | + ? (opened.ownership as BrowserTabOwnership) |
| 47 | + : undefined; |
| 48 | + // Older browser hosts do not return resolvedProfile. Their durable fingerprint |
| 49 | + // cannot prove which configured profile owns the tab, so keep that tab volatile. |
| 50 | + const ownership = rawOwnership?.status === "durable" && !profile ? undefined : rawOwnership; |
| 51 | + return { targetId, aliases: [...new Set(aliases)], profile, ownership }; |
| 52 | +} |
| 53 | + |
| 54 | +export function stripBrowserOpenInternalMetadata(value: unknown): unknown { |
| 55 | + if (!value || typeof value !== "object" || Array.isArray(value)) { |
| 56 | + return value; |
| 57 | + } |
| 58 | + const { |
| 59 | + ownership: _ownership, |
| 60 | + resolvedProfile: _resolvedProfile, |
| 61 | + ...agentVisible |
| 62 | + } = value as Record<string, unknown>; |
| 63 | + return agentVisible; |
| 64 | +} |
| 65 | + |
| 66 | +async function trackOpenedBrowserTab(params: { |
| 67 | + result: unknown; |
| 68 | + sessionKey?: string; |
| 69 | + fallbackProfile?: string; |
| 70 | + baseUrl?: string; |
| 71 | + track: SessionTabRegistry["trackSessionBrowserTab"]; |
| 72 | + closeTab: (targetId: string, profile?: string) => Promise<void>; |
| 73 | +}): Promise<void> { |
| 74 | + const opened = readOpenedTab(params.result); |
| 75 | + const profile = opened.profile ?? params.fallbackProfile; |
| 76 | + try { |
| 77 | + params.track({ |
| 78 | + sessionKey: params.sessionKey, |
| 79 | + targetId: opened.targetId, |
| 80 | + baseUrl: params.baseUrl, |
| 81 | + profile, |
| 82 | + ...(params.fallbackProfile && opened.profile && opened.profile !== params.fallbackProfile |
| 83 | + ? { profileAliases: [params.fallbackProfile] } |
| 84 | + : {}), |
| 85 | + // Sandbox/browser-bridge tabs belong to a different browser process. |
| 86 | + // Keep them process-local even if that server returned durable metadata. |
| 87 | + ownership: params.baseUrl ? undefined : opened.ownership, |
| 88 | + aliases: opened.aliases, |
| 89 | + }); |
| 90 | + } catch (trackingError) { |
| 91 | + if (!opened.targetId) { |
| 92 | + throw trackingError; |
| 93 | + } |
| 94 | + try { |
| 95 | + await params.closeTab(opened.targetId, profile); |
| 96 | + } catch (closeError) { |
| 97 | + throw Object.assign( |
| 98 | + new Error("Failed to register browser tab cleanup and close the newly opened tab", { |
| 99 | + cause: closeError, |
| 100 | + }), |
| 101 | + { |
| 102 | + name: "BrowserTabTrackingCompensationError", |
| 103 | + errors: [trackingError, closeError], |
| 104 | + }, |
| 105 | + ); |
| 106 | + } |
| 107 | + throw trackingError; |
| 108 | + } |
| 109 | +} |
| 110 | + |
| 111 | +export function createBrowserToolSessionTabs(params: { |
| 112 | + sessionKey?: string; |
| 113 | + requestedProfile?: string; |
| 114 | + defaultProfile: string; |
| 115 | + baseUrl?: string; |
| 116 | + isHostFallbackActive?: () => boolean; |
| 117 | + registry: SessionTabRegistry; |
| 118 | +}) { |
| 119 | + const profile = params.requestedProfile ?? params.defaultProfile; |
| 120 | + const isTrackedRoute = () => !params.isHostFallbackActive || params.isHostFallbackActive(); |
| 121 | + const trackedBaseUrl = () => (params.isHostFallbackActive ? undefined : params.baseUrl); |
| 122 | + const trackedProfile = () => (trackedBaseUrl() && !params.requestedProfile ? undefined : profile); |
| 123 | + const identity = (targetId: string) => ({ |
| 124 | + sessionKey: params.sessionKey, |
| 125 | + targetId, |
| 126 | + baseUrl: trackedBaseUrl(), |
| 127 | + profile: trackedProfile(), |
| 128 | + }); |
| 129 | + return { |
| 130 | + touch: (targetId: string | undefined): void => { |
| 131 | + if (targetId && isTrackedRoute()) { |
| 132 | + params.registry.touchSessionBrowserTab(identity(targetId)); |
| 133 | + } |
| 134 | + }, |
| 135 | + untrack: (targetId: string | undefined): void => { |
| 136 | + if (targetId && isTrackedRoute()) { |
| 137 | + params.registry.untrackSessionBrowserTab(identity(targetId)); |
| 138 | + } |
| 139 | + }, |
| 140 | + trackOpened: async ( |
| 141 | + result: unknown, |
| 142 | + closeTab: (targetId: string, openedProfile?: string) => Promise<void>, |
| 143 | + ): Promise<void> => { |
| 144 | + if (!isTrackedRoute()) { |
| 145 | + return; |
| 146 | + } |
| 147 | + const baseUrl = trackedBaseUrl(); |
| 148 | + await trackOpenedBrowserTab({ |
| 149 | + result, |
| 150 | + sessionKey: params.sessionKey, |
| 151 | + fallbackProfile: baseUrl && !params.requestedProfile ? undefined : profile, |
| 152 | + baseUrl, |
| 153 | + track: params.registry.trackSessionBrowserTab, |
| 154 | + closeTab, |
| 155 | + }); |
| 156 | + }, |
| 157 | + }; |
| 158 | +} |
0 commit comments