Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
*/
import * as vscode from 'vscode'
import { AuthController } from 'aws-core-vscode/amazonq'
import { getLogger, placeholder, i18n, openUrl, fs, TabTypeDataMap, randomUUID } from 'aws-core-vscode/shared'
import { getLogger, placeholder, i18n, openWebLink, fs, TabTypeDataMap, randomUUID } from 'aws-core-vscode/shared'
import { ScanChatControllerEventEmitters, Session, ChatSessionManager } from 'aws-core-vscode/amazonqScan'
import {
AggregatedCodeScanIssue,
Expand Down Expand Up @@ -344,7 +344,7 @@ export class ScanController {
}

private processLink(message: any) {
void openUrl(vscode.Uri.parse(message.link))
void openWebLink(message.link)
}

private async processFileClick(message: any) {
Expand Down
4 changes: 2 additions & 2 deletions packages/amazonq/src/lsp/chat/messages.ts
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ import {
SecurityIssueTreeViewProvider,
CodeWhispererConstants,
} from 'aws-core-vscode/codewhisperer'
import { AmazonQPromptSettings, messages, openUrl, isTextEditor, globals, setContext } from 'aws-core-vscode/shared'
import { AmazonQPromptSettings, messages, openWebLink, isTextEditor, globals, setContext } from 'aws-core-vscode/shared'
import { DefaultAmazonQAppInitContext, messageDispatcher, referenceLogText } from 'aws-core-vscode/amazonq'
import { telemetry } from 'aws-core-vscode/telemetry'
import { isValidResponseError } from './error'
Expand Down Expand Up @@ -267,7 +267,7 @@ export function registerMessageListeners(
case INFO_LINK_CLICK_NOTIFICATION_METHOD:
case LINK_CLICK_NOTIFICATION_METHOD: {
const linkParams = message.params as LinkClickParams
void openUrl(vscode.Uri.parse(linkParams.link))
void openWebLink(linkParams.link)
break
}
case STOP_CHAT_RESPONSE: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,14 @@
* SPDX-License-Identifier: Apache-2.0
*/

import { Uri } from 'vscode'
import { MessagePublisher } from '../../messages/messagePublisher'
import { TabType } from '../ui/storages/tabsStorage'
import { amazonqMark } from '../../../shared/performance/marks'
import { telemetry } from '../../../shared/telemetry/telemetry'
import { AmazonQChatMessageDuration } from '../../messages/chatMessageDuration'
import { isClickTelemetry, isOpenAgentTelemetry } from '../ui/telemetry/actions'
import globals from '../../../shared/extensionGlobals'
import { openUrl } from '../../../shared/utilities/vsCodeUtils'
import { openWebLink } from '../../../shared/utilities/vsCodeUtils'
import { DefaultAmazonQAppInitContext } from '../../apps/initContext'
import { AmazonQPromptSettings } from '../../../shared/settings'

Expand Down Expand Up @@ -64,7 +63,7 @@ export function handleWebviewEvent(msg: any, webViewToAppsMessagePublishers: Map
}
case 'open-link': {
const { link } = msg
void openUrl(Uri.parse(link))
void openWebLink(link)
return
}
case 'send-telemetry': {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ import {
import * as CodeWhispererConstants from '../../../codewhisperer/models/constants'
import MessengerUtils, { ButtonActions, GumbyCommands } from './messenger/messengerUtils'
import { CancelActionPositions } from '../../telemetry/codeTransformTelemetry'
import { openUrl } from '../../../shared/utilities/vsCodeUtils'
import { openWebLink } from '../../../shared/utilities/vsCodeUtils'
import { telemetry } from '../../../shared/telemetry/telemetry'
import { CodeTransformTelemetryState } from '../../telemetry/codeTransformTelemetryState'
import DependencyVersions from '../../models/dependencies'
Expand Down Expand Up @@ -732,7 +732,7 @@ export class GumbyController {
}

private openLink(message: { link: string }) {
void openUrl(vscode.Uri.parse(message.link))
void openWebLink(message.link)
}

private async handleError(message: { error: Error; tabID: string }) {
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/shared/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ export { RegionProvider } from './regions/regionProvider'
export { Commands } from './vscode/commands2'
export { getMachineId, getServiceEnvVarConfig, isAmazonLinux2 } from './vscode/env'
export { getLogger } from './logger/logger'
export { activateExtension, openUrl } from './utilities/vsCodeUtils'
export { activateExtension, openUrl, openWebLink } from './utilities/vsCodeUtils'
export { waitUntil, sleep, Timeout } from './utilities/timeoutUtils'
export * as timeoutUtils from './utilities/timeoutUtils'
export { Prompter } from './ui/prompter'
Expand Down
22 changes: 22 additions & 0 deletions packages/core/src/shared/utilities/vsCodeUtils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,28 @@ export async function openUrl(url: vscode.Uri, source?: string): Promise<boolean
})
}

/**
* Opens a link clicked in a chat/webview in the system web browser, only if its scheme is http or https.
* Other links (scheme-less, protocol-relative, `file:`, `vscode:`, `command:`, ...) are ignored, because
* `vscode.Uri.parse` turns scheme-less paths into `file:` URIs that `openExternal` would hand to the OS.
*
* @returns true if the link was opened, false if it was ignored.
*/
export async function openWebLink(link: string, source?: string): Promise<boolean> {
let url: vscode.Uri | undefined
try {
url = vscode.Uri.parse(link, true)
} catch {
url = undefined
}
const scheme = url?.scheme.toLowerCase()
if (!url || (scheme !== 'http' && scheme !== 'https') || !url.authority) {
getLogger().warn('openWebLink: ignored link with scheme "%s", only http(s) links are opened', scheme ?? '')
return false
}
return openUrl(url, source)
}

export function isToolkitActive(): boolean {
return isExtensionActive(VSCODE_EXTENSION_ID.awstoolkit)
}
Expand Down
33 changes: 33 additions & 0 deletions packages/core/src/test/shared/utilities/vscodeUtils.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import { VSCODE_EXTENSION_ID } from '../../../shared/extensions'
import * as vscodeUtil from '../../../shared/utilities/vsCodeUtils'
import * as vscode from 'vscode'
import { getExcludePattern } from '../../../shared/fs/watchedFiles'
import { getOpenExternalStub } from '../../globalSetup.test'

describe('vscodeUtils', async function () {
it('activateExtension(), isExtensionActive()', async function () {
Expand Down Expand Up @@ -119,3 +120,35 @@ describe('buildMissingExtensionMessage()', function () {
)
})
})

describe('openWebLink()', function () {
beforeEach(function () {
getOpenExternalStub().resolves(true)
})

for (const link of ['https://aws.amazon.com/q/', 'http://example.com/path?a=1#b', 'HTTPS://example.com']) {
it(`opens ${link}`, async function () {
assert.strictEqual(await vscodeUtil.openWebLink(link), true)
assert.ok(getOpenExternalStub().calledOnce)
assert.strictEqual(getOpenExternalStub().args[0][0].toString(), vscode.Uri.parse(link).toString())
})
}

for (const link of [
'//host/x',
'//host/share/x.exe',
'file:///etc/passwd',
'\\\\host\\share',
'vscode://x',
'command:x',
'foo/bar',
'/foo/bar',
'https:foo',
'',
]) {
it(`does not open ${JSON.stringify(link)}`, async function () {
assert.strictEqual(await vscodeUtil.openWebLink(link), false)
assert.ok(getOpenExternalStub().notCalled)
})
}
})
Loading