|
| 1 | +import * as vscode from "vscode"; |
| 2 | + |
| 3 | +import { errToStr } from "../api/api-helper"; |
| 4 | +import { type Commands } from "../commands"; |
| 5 | +import { type ServiceContainer } from "../core/container"; |
| 6 | +import { type DeploymentManager } from "../deployment/deploymentManager"; |
| 7 | +import { maybeAskUrl } from "../promptUtils"; |
| 8 | +import { toSafeHost } from "../util"; |
| 9 | + |
| 10 | +interface UriRouteContext { |
| 11 | + params: URLSearchParams; |
| 12 | + serviceContainer: ServiceContainer; |
| 13 | + deploymentManager: DeploymentManager; |
| 14 | + commands: Commands; |
| 15 | +} |
| 16 | + |
| 17 | +type UriRouteHandler = (ctx: UriRouteContext) => Promise<void>; |
| 18 | + |
| 19 | +const routes: Record<string, UriRouteHandler> = { |
| 20 | + "/open": handleOpen, |
| 21 | + "/openDevContainer": handleOpenDevContainer, |
| 22 | +}; |
| 23 | + |
| 24 | +/** |
| 25 | + * Registers the URI handler for `{vscode.env.uriScheme}://coder.coder-remote`... URIs. |
| 26 | + */ |
| 27 | +export function registerUriHandler( |
| 28 | + serviceContainer: ServiceContainer, |
| 29 | + deploymentManager: DeploymentManager, |
| 30 | + commands: Commands, |
| 31 | + vscodeProposed: typeof vscode, |
| 32 | +): vscode.Disposable { |
| 33 | + const output = serviceContainer.getLogger(); |
| 34 | + |
| 35 | + return vscode.window.registerUriHandler({ |
| 36 | + handleUri: async (uri) => { |
| 37 | + try { |
| 38 | + await routeUri(uri, serviceContainer, deploymentManager, commands); |
| 39 | + } catch (error) { |
| 40 | + const message = errToStr(error, "No error message was provided"); |
| 41 | + output.warn(`Failed to handle URI ${uri.toString()}: ${message}`); |
| 42 | + vscodeProposed.window.showErrorMessage("Failed to handle URI", { |
| 43 | + detail: message, |
| 44 | + modal: true, |
| 45 | + useCustom: true, |
| 46 | + }); |
| 47 | + } |
| 48 | + }, |
| 49 | + }); |
| 50 | +} |
| 51 | + |
| 52 | +async function routeUri( |
| 53 | + uri: vscode.Uri, |
| 54 | + serviceContainer: ServiceContainer, |
| 55 | + deploymentManager: DeploymentManager, |
| 56 | + commands: Commands, |
| 57 | +): Promise<void> { |
| 58 | + const handler = routes[uri.path]; |
| 59 | + if (!handler) { |
| 60 | + throw new Error(`Unknown path ${uri.path}`); |
| 61 | + } |
| 62 | + |
| 63 | + await handler({ |
| 64 | + params: new URLSearchParams(uri.query), |
| 65 | + serviceContainer, |
| 66 | + deploymentManager, |
| 67 | + commands, |
| 68 | + }); |
| 69 | +} |
| 70 | + |
| 71 | +function getRequiredParam(params: URLSearchParams, name: string): string { |
| 72 | + const value = params.get(name); |
| 73 | + if (!value) { |
| 74 | + throw new Error(`${name} must be specified as a query parameter`); |
| 75 | + } |
| 76 | + return value; |
| 77 | +} |
| 78 | + |
| 79 | +async function handleOpen(ctx: UriRouteContext): Promise<void> { |
| 80 | + const { params, serviceContainer, deploymentManager, commands } = ctx; |
| 81 | + |
| 82 | + const owner = getRequiredParam(params, "owner"); |
| 83 | + const workspace = getRequiredParam(params, "workspace"); |
| 84 | + const agent = params.get("agent"); |
| 85 | + const folder = params.get("folder"); |
| 86 | + const openRecent = |
| 87 | + params.has("openRecent") && |
| 88 | + (!params.get("openRecent") || params.get("openRecent") === "true"); |
| 89 | + |
| 90 | + await setupDeployment(params, serviceContainer, deploymentManager); |
| 91 | + |
| 92 | + await commands.open( |
| 93 | + owner, |
| 94 | + workspace, |
| 95 | + agent ?? undefined, |
| 96 | + folder ?? undefined, |
| 97 | + openRecent, |
| 98 | + ); |
| 99 | +} |
| 100 | + |
| 101 | +async function handleOpenDevContainer(ctx: UriRouteContext): Promise<void> { |
| 102 | + const { params, serviceContainer, deploymentManager, commands } = ctx; |
| 103 | + |
| 104 | + const owner = getRequiredParam(params, "owner"); |
| 105 | + const workspace = getRequiredParam(params, "workspace"); |
| 106 | + const agent = getRequiredParam(params, "agent"); |
| 107 | + const devContainerName = getRequiredParam(params, "devContainerName"); |
| 108 | + const devContainerFolder = getRequiredParam(params, "devContainerFolder"); |
| 109 | + const localWorkspaceFolder = params.get("localWorkspaceFolder"); |
| 110 | + const localConfigFile = params.get("localConfigFile"); |
| 111 | + |
| 112 | + if (localConfigFile && !localWorkspaceFolder) { |
| 113 | + throw new Error( |
| 114 | + "localWorkspaceFolder must be specified as a query parameter if localConfigFile is provided", |
| 115 | + ); |
| 116 | + } |
| 117 | + |
| 118 | + await setupDeployment(params, serviceContainer, deploymentManager); |
| 119 | + |
| 120 | + await commands.openDevContainer( |
| 121 | + owner, |
| 122 | + workspace, |
| 123 | + agent, |
| 124 | + devContainerName, |
| 125 | + devContainerFolder, |
| 126 | + localWorkspaceFolder ?? "", |
| 127 | + localConfigFile ?? "", |
| 128 | + ); |
| 129 | +} |
| 130 | + |
| 131 | +/** |
| 132 | + * Sets up deployment from URI parameters. Handles URL prompting, client setup, |
| 133 | + * and token storage. Throws if user cancels URL input or login fails. |
| 134 | + */ |
| 135 | +async function setupDeployment( |
| 136 | + params: URLSearchParams, |
| 137 | + serviceContainer: ServiceContainer, |
| 138 | + deploymentManager: DeploymentManager, |
| 139 | +): Promise<void> { |
| 140 | + const secretsManager = serviceContainer.getSecretsManager(); |
| 141 | + const mementoManager = serviceContainer.getMementoManager(); |
| 142 | + const loginCoordinator = serviceContainer.getLoginCoordinator(); |
| 143 | + |
| 144 | + const currentDeployment = await secretsManager.getCurrentDeployment(); |
| 145 | + |
| 146 | + // We are not guaranteed that the URL we currently have is for the URL |
| 147 | + // this workspace belongs to, or that we even have a URL at all (the |
| 148 | + // queries will default to localhost) so ask for it if missing. |
| 149 | + // Pre-populate in case we do have the right URL so the user can just |
| 150 | + // hit enter and move on. |
| 151 | + const url = await maybeAskUrl( |
| 152 | + mementoManager, |
| 153 | + params.get("url"), |
| 154 | + currentDeployment?.url, |
| 155 | + ); |
| 156 | + if (!url) { |
| 157 | + throw new Error("url must be provided or specified as a query parameter"); |
| 158 | + } |
| 159 | + |
| 160 | + const safeHostname = toSafeHost(url); |
| 161 | + |
| 162 | + const token: string | null = params.get("token"); |
| 163 | + if (token !== null) { |
| 164 | + await secretsManager.setSessionAuth(safeHostname, { url, token }); |
| 165 | + } |
| 166 | + |
| 167 | + const result = await loginCoordinator.ensureLoggedIn({ |
| 168 | + safeHostname, |
| 169 | + url, |
| 170 | + }); |
| 171 | + |
| 172 | + if (!result.success) { |
| 173 | + throw new Error("Failed to login to deployment from URI"); |
| 174 | + } |
| 175 | + |
| 176 | + await deploymentManager.setDeploymentIfValid({ |
| 177 | + safeHostname, |
| 178 | + url, |
| 179 | + token: result.token, |
| 180 | + user: result.user, |
| 181 | + }); |
| 182 | +} |
0 commit comments