| b69ab31 | | | 1 | /** |
| b69ab31 | | | 2 | * Copyright (c) Meta Platforms, Inc. and affiliates. |
| b69ab31 | | | 3 | * |
| b69ab31 | | | 4 | * This source code is licensed under the MIT license found in the |
| b69ab31 | | | 5 | * LICENSE file in the root directory of this source tree. |
| b69ab31 | | | 6 | */ |
| b69ab31 | | | 7 | |
| b69ab31 | | | 8 | import type {Repository} from 'isl-server/src/Repository'; |
| b69ab31 | | | 9 | import type {RepositoryContext} from 'isl-server/src/serverTypes'; |
| b69ab31 | | | 10 | import type {Operation} from 'isl/src/operations/Operation'; |
| b69ab31 | | | 11 | import type {PartiallySelectedDiffCommit} from 'isl/src/stackEdit/diffSplitTypes'; |
| b69ab31 | | | 12 | import type {AbsolutePath, RepoRelativePath} from 'isl/src/types'; |
| b69ab31 | | | 13 | import type {Comparison} from 'shared/Comparison'; |
| b69ab31 | | | 14 | |
| b69ab31 | | | 15 | import {repoRelativePathForAbsolutePath} from 'isl-server/src/Repository'; |
| b69ab31 | | | 16 | import {repositoryCache} from 'isl-server/src/RepositoryCache'; |
| b69ab31 | | | 17 | import {findPublicAncestor} from 'isl-server/src/utils'; |
| b69ab31 | | | 18 | import {RevertOperation} from 'isl/src/operations/RevertOperation'; |
| b69ab31 | | | 19 | import fs from 'node:fs'; |
| b69ab31 | | | 20 | import path from 'node:path'; |
| b69ab31 | | | 21 | import { |
| b69ab31 | | | 22 | beforeRevsetForComparison, |
| b69ab31 | | | 23 | ComparisonType, |
| b69ab31 | | | 24 | currRevsetForComparison, |
| b69ab31 | | | 25 | labelForComparison, |
| b69ab31 | | | 26 | } from 'shared/Comparison'; |
| b69ab31 | | | 27 | import * as vscode from 'vscode'; |
| b69ab31 | | | 28 | import {encodeDeletedFileUri} from './DeletedFileContentProvider'; |
| b69ab31 | | | 29 | import {encodeSaplingDiffUri} from './DiffContentProvider'; |
| b69ab31 | | | 30 | import {shouldOpenBeside} from './config'; |
| b69ab31 | | | 31 | import {t} from './i18n'; |
| b69ab31 | | | 32 | |
| b69ab31 | | | 33 | /** |
| b69ab31 | | | 34 | * VS Code Commands registered by the Sapling extension. |
| b69ab31 | | | 35 | */ |
| b69ab31 | | | 36 | export const vscodeCommands = { |
| b69ab31 | | | 37 | ['sapling.open-file-diff-uncommitted']: commandWithUriOrResourceState((_, uri: vscode.Uri) => |
| b69ab31 | | | 38 | openDiffView(uri, {type: ComparisonType.UncommittedChanges}), |
| b69ab31 | | | 39 | ), |
| b69ab31 | | | 40 | ['sapling.open-file-diff-head']: commandWithUriOrResourceState((_, uri: vscode.Uri) => |
| b69ab31 | | | 41 | openDiffView(uri, {type: ComparisonType.HeadChanges}), |
| b69ab31 | | | 42 | ), |
| b69ab31 | | | 43 | ['sapling.open-file-diff-stack']: commandWithUriOrResourceState((_, uri: vscode.Uri) => |
| b69ab31 | | | 44 | openDiffView(uri, {type: ComparisonType.StackChanges}), |
| b69ab31 | | | 45 | ), |
| b69ab31 | | | 46 | ['sapling.open-file-diff']: (uri: vscode.Uri, comparison: Comparison) => |
| b69ab31 | | | 47 | openDiffView(uri, comparison), |
| b69ab31 | | | 48 | |
| b69ab31 | | | 49 | ['sapling.open-remote-file-link']: commandWithUriOrResourceState( |
| b69ab31 | | | 50 | (repo: Repository, uri, path: RepoRelativePath) => openRemoteFileLink(repo, uri, path), |
| b69ab31 | | | 51 | ), |
| b69ab31 | | | 52 | ['sapling.copy-remote-file-link']: commandWithUriOrResourceState( |
| b69ab31 | | | 53 | (repo: Repository, uri, path: RepoRelativePath) => openRemoteFileLink(repo, uri, path, true), |
| b69ab31 | | | 54 | ), |
| b69ab31 | | | 55 | |
| b69ab31 | | | 56 | ['sapling.revert-file']: commandWithUriOrResourceState(async function ( |
| b69ab31 | | | 57 | this: RepositoryContext, |
| b69ab31 | | | 58 | repo: Repository, |
| b69ab31 | | | 59 | _, |
| b69ab31 | | | 60 | path: RepoRelativePath, |
| b69ab31 | | | 61 | ) { |
| b69ab31 | | | 62 | const choice = await vscode.window.showWarningMessage( |
| b69ab31 | | | 63 | 'Are you sure you want to revert this file?', |
| b69ab31 | | | 64 | 'Cancel', |
| b69ab31 | | | 65 | 'Revert', |
| b69ab31 | | | 66 | ); |
| b69ab31 | | | 67 | if (choice !== 'Revert') { |
| b69ab31 | | | 68 | return; |
| b69ab31 | | | 69 | } |
| b69ab31 | | | 70 | return runOperation(this, repo, new RevertOperation([path])); |
| b69ab31 | | | 71 | }), |
| b69ab31 | | | 72 | }; |
| b69ab31 | | | 73 | |
| b69ab31 | | | 74 | type surveyMetaData = { |
| b69ab31 | | | 75 | diffId: string | undefined; |
| b69ab31 | | | 76 | }; |
| b69ab31 | | | 77 | |
| b69ab31 | | | 78 | /** Type definitions for built-in or third-party VS Code commands we want to execute programmatically. */ |
| b69ab31 | | | 79 | type ExternalVSCodeCommands = { |
| b69ab31 | | | 80 | 'vscode.diff': ( |
| b69ab31 | | | 81 | left: vscode.Uri, |
| b69ab31 | | | 82 | right: vscode.Uri, |
| b69ab31 | | | 83 | title: string, |
| b69ab31 | | | 84 | opts?: vscode.TextDocumentShowOptions, |
| b69ab31 | | | 85 | ) => Thenable<unknown>; |
| b69ab31 | | | 86 | 'workbench.action.closeSidebar': () => Thenable<void>; |
| b69ab31 | | | 87 | 'fb.survey.initStateUIByNamespace': ( |
| b69ab31 | | | 88 | surveyID: string, |
| b69ab31 | | | 89 | namespace: string, |
| b69ab31 | | | 90 | metadata: surveyMetaData, |
| b69ab31 | | | 91 | ) => Thenable<void>; |
| b69ab31 | | | 92 | 'workbench.action.pinEditor': () => Thenable<void>; |
| b69ab31 | | | 93 | 'sapling.open-isl': () => Thenable<void>; |
| b69ab31 | | | 94 | 'sapling.close-isl': () => Thenable<void>; |
| b69ab31 | | | 95 | 'sapling.isl.focus': () => Thenable<void>; |
| b69ab31 | | | 96 | 'sapling.open-isl-with-commit-message': ( |
| b69ab31 | | | 97 | title: string, |
| b69ab31 | | | 98 | description: string, |
| b69ab31 | | | 99 | mode?: 'commit' | 'amend', |
| b69ab31 | | | 100 | hash?: string, |
| b69ab31 | | | 101 | ) => Thenable<void>; |
| b69ab31 | | | 102 | 'sapling.open-split-view-with-commits': ( |
| b69ab31 | | | 103 | commits: Array<PartiallySelectedDiffCommit>, |
| b69ab31 | | | 104 | commitHash?: string, |
| b69ab31 | | | 105 | ) => Thenable<void>; |
| b69ab31 | | | 106 | 'sapling.open-comparison-view': (comparison: Comparison) => Thenable<void>; |
| b69ab31 | | | 107 | setContext: (key: string, value: unknown) => Thenable<void>; |
| b69ab31 | | | 108 | 'fb-hg.open-or-focus-interactive-smartlog': ( |
| b69ab31 | | | 109 | _: unknown, |
| b69ab31 | | | 110 | __?: unknown, |
| b69ab31 | | | 111 | forceNoSapling?: boolean, |
| b69ab31 | | | 112 | ) => Thenable<void>; |
| b69ab31 | | | 113 | }; |
| b69ab31 | | | 114 | |
| b69ab31 | | | 115 | export type VSCodeCommand = typeof vscodeCommands & ExternalVSCodeCommands; |
| b69ab31 | | | 116 | |
| b69ab31 | | | 117 | /** |
| b69ab31 | | | 118 | * Type-safe programmatic execution of VS Code commands (via `vscode.commands.executeCommand`). |
| b69ab31 | | | 119 | * Sapling-provided commands are defined in vscodeCommands. |
| b69ab31 | | | 120 | * Built-in or third-party commands may also be typed through this function, |
| b69ab31 | | | 121 | * just define them in ExternalVSCodeCommands. |
| b69ab31 | | | 122 | */ |
| b69ab31 | | | 123 | export function executeVSCodeCommand<K extends keyof VSCodeCommand>( |
| b69ab31 | | | 124 | id: K, |
| b69ab31 | | | 125 | ...args: Parameters<VSCodeCommand[K]> |
| b69ab31 | | | 126 | ): ReturnType<VSCodeCommand[K]> { |
| b69ab31 | | | 127 | // In tests 'vscode.commands' is not defined. |
| b69ab31 | | | 128 | return vscode.commands?.executeCommand(id, ...args) as ReturnType<VSCodeCommand[K]>; |
| b69ab31 | | | 129 | } |
| b69ab31 | | | 130 | |
| b69ab31 | | | 131 | const runOperation = ( |
| b69ab31 | | | 132 | ctx: RepositoryContext, |
| b69ab31 | | | 133 | repo: Repository, |
| b69ab31 | | | 134 | operation: Operation, |
| b69ab31 | | | 135 | ): undefined => { |
| b69ab31 | | | 136 | repo.runOrQueueOperation( |
| b69ab31 | | | 137 | ctx, |
| b69ab31 | | | 138 | { |
| b69ab31 | | | 139 | args: operation.getArgs(), |
| b69ab31 | | | 140 | id: operation.id, |
| b69ab31 | | | 141 | runner: operation.runner, |
| b69ab31 | | | 142 | trackEventName: operation.trackEventName, |
| b69ab31 | | | 143 | }, |
| b69ab31 | | | 144 | () => undefined, // TODO: Send this progress info to any existing ISL webview if there is one |
| b69ab31 | | | 145 | ); |
| b69ab31 | | | 146 | return undefined; |
| b69ab31 | | | 147 | }; |
| b69ab31 | | | 148 | |
| b69ab31 | | | 149 | export function registerCommands(ctx: RepositoryContext): Array<vscode.Disposable> { |
| b69ab31 | | | 150 | const disposables: Array<vscode.Disposable> = Object.entries(vscodeCommands).map( |
| b69ab31 | | | 151 | ([id, handler]) => |
| b69ab31 | | | 152 | vscode.commands.registerCommand(id, (...args: Parameters<typeof handler>) => |
| b69ab31 | | | 153 | ctx.tracker.operation( |
| b69ab31 | | | 154 | 'RunVSCodeCommand', |
| b69ab31 | | | 155 | 'VSCodeCommandError', |
| b69ab31 | | | 156 | {extras: {command: id}}, |
| b69ab31 | | | 157 | () => { |
| b69ab31 | | | 158 | return (handler as (...args: Array<unknown>) => unknown).apply(ctx, args); |
| b69ab31 | | | 159 | }, |
| b69ab31 | | | 160 | ), |
| b69ab31 | | | 161 | ), |
| b69ab31 | | | 162 | ); |
| b69ab31 | | | 163 | return disposables; |
| b69ab31 | | | 164 | } |
| b69ab31 | | | 165 | |
| b69ab31 | | | 166 | function fileExists(uri: vscode.Uri): Promise<boolean> { |
| b69ab31 | | | 167 | return fs.promises |
| b69ab31 | | | 168 | .access(uri.fsPath) |
| b69ab31 | | | 169 | .then(() => true) |
| b69ab31 | | | 170 | .catch(() => false); |
| b69ab31 | | | 171 | } |
| b69ab31 | | | 172 | |
| b69ab31 | | | 173 | async function openDiffView(uri: vscode.Uri, comparison: Comparison): Promise<unknown> { |
| b69ab31 | | | 174 | const leftUri = getLeftUri(uri, comparison); |
| b69ab31 | | | 175 | const rightUri = await getRightUri(uri, comparison); |
| b69ab31 | | | 176 | const title = `${path.basename(uri.fsPath)} (${t(labelForComparison(comparison))})`; |
| b69ab31 | | | 177 | const opts = {viewColumn: shouldOpenBeside() ? vscode.ViewColumn.Beside : undefined}; |
| b69ab31 | | | 178 | return executeVSCodeCommand('vscode.diff', leftUri, rightUri, title, opts); |
| b69ab31 | | | 179 | } |
| b69ab31 | | | 180 | |
| b69ab31 | | | 181 | function getLeftUri(uri: vscode.Uri, comparison: Comparison): vscode.Uri { |
| b69ab31 | | | 182 | const leftRev = beforeRevsetForComparison(comparison); |
| b69ab31 | | | 183 | return encodeSaplingDiffUri(uri, leftRev); |
| b69ab31 | | | 184 | } |
| b69ab31 | | | 185 | |
| b69ab31 | | | 186 | /** |
| b69ab31 | | | 187 | * Get the right side URI of the diff view. |
| b69ab31 | | | 188 | * |
| b69ab31 | | | 189 | * A raw file:// URI without encoding lets vscode directly open the file on disk. |
| b69ab31 | | | 190 | * This is desirable as users can edit the file on the right side of the diff view. |
| b69ab31 | | | 191 | * |
| b69ab31 | | | 192 | * There are cases, however, where editable right side does NOT make sense: |
| b69ab31 | | | 193 | * - comparing against a history commit (since changes on the right side may not be present) |
| b69ab31 | | | 194 | * - comparing submodule changes (since both side are commit hashes instead of file content) |
| b69ab31 | | | 195 | */ |
| b69ab31 | | | 196 | async function getRightUri(uri: vscode.Uri, comparison: Comparison): Promise<vscode.Uri> { |
| b69ab31 | | | 197 | const rightRev = currRevsetForComparison(comparison); |
| b69ab31 | | | 198 | if (comparison.type === ComparisonType.Committed || isSubmodule(uri.fsPath)) { |
| b69ab31 | | | 199 | return encodeSaplingDiffUri(uri, rightRev); |
| b69ab31 | | | 200 | } |
| b69ab31 | | | 201 | return (await fileExists(uri)) ? uri : encodeDeletedFileUri(uri); |
| b69ab31 | | | 202 | } |
| b69ab31 | | | 203 | |
| b69ab31 | | | 204 | function isSubmodule(path: AbsolutePath): boolean { |
| b69ab31 | | | 205 | const repo = repositoryCache.cachedRepositoryForPath(path); |
| b69ab31 | | | 206 | if (repo === undefined) { |
| b69ab31 | | | 207 | return false; |
| b69ab31 | | | 208 | } |
| b69ab31 | | | 209 | const submodulePaths = repo.getSubmodulePathCache(); |
| b69ab31 | | | 210 | const relPath = repoRelativePathForAbsolutePath(path, repo); |
| b69ab31 | | | 211 | return submodulePaths?.has(relPath) ?? false; |
| b69ab31 | | | 212 | } |
| b69ab31 | | | 213 | |
| b69ab31 | | | 214 | function openRemoteFileLink( |
| b69ab31 | | | 215 | repo: Repository, |
| b69ab31 | | | 216 | uri: vscode.Uri, |
| b69ab31 | | | 217 | path: RepoRelativePath, |
| b69ab31 | | | 218 | copyToClipboard = false, |
| b69ab31 | | | 219 | ): void { |
| b69ab31 | | | 220 | { |
| b69ab31 | | | 221 | if (!repo.codeReviewProvider?.getRemoteFileURL) { |
| b69ab31 | | | 222 | vscode.window.showErrorMessage( |
| b69ab31 | | | 223 | t(`Remote link unsupported for this code review provider ($provider)`).replace( |
| b69ab31 | | | 224 | '$provider', |
| b69ab31 | | | 225 | repo.codeReviewProvider?.getSummaryName() ?? t('none'), |
| b69ab31 | | | 226 | ), |
| b69ab31 | | | 227 | ); |
| b69ab31 | | | 228 | return; |
| b69ab31 | | | 229 | } |
| b69ab31 | | | 230 | |
| b69ab31 | | | 231 | // Grab the selection if the command is for the active file (may not be true if triggered via file explorer) |
| b69ab31 | | | 232 | const selection = |
| b69ab31 | | | 233 | vscode.window.activeTextEditor?.document.uri.fsPath === uri.fsPath |
| b69ab31 | | | 234 | ? vscode.window.activeTextEditor?.selection |
| b69ab31 | | | 235 | : null; |
| b69ab31 | | | 236 | |
| b69ab31 | | | 237 | const commits = repo.getSmartlogCommits()?.commits.value; |
| b69ab31 | | | 238 | const head = repo.getHeadCommit(); |
| b69ab31 | | | 239 | if (!commits || !head) { |
| b69ab31 | | | 240 | vscode.window.showErrorMessage(t(`No commits loaded in this repository yet`)); |
| b69ab31 | | | 241 | return; |
| b69ab31 | | | 242 | } |
| b69ab31 | | | 243 | const publicCommit = findPublicAncestor(commits, head); |
| b69ab31 | | | 244 | const url = repo.codeReviewProvider.getRemoteFileURL( |
| b69ab31 | | | 245 | path, |
| b69ab31 | | | 246 | publicCommit?.hash ?? null, |
| b69ab31 | | | 247 | selection ? {line: selection.start.line, char: selection.start.character} : undefined, |
| b69ab31 | | | 248 | selection ? {line: selection.end.line, char: selection.end.character} : undefined, |
| b69ab31 | | | 249 | ); |
| b69ab31 | | | 250 | |
| b69ab31 | | | 251 | if (copyToClipboard) { |
| b69ab31 | | | 252 | vscode.env.clipboard.writeText(url); |
| b69ab31 | | | 253 | } else { |
| b69ab31 | | | 254 | vscode.env.openExternal(vscode.Uri.parse(url)); |
| b69ab31 | | | 255 | } |
| b69ab31 | | | 256 | } |
| b69ab31 | | | 257 | } |
| b69ab31 | | | 258 | |
| b69ab31 | | | 259 | /** |
| b69ab31 | | | 260 | * Wrap a command implementation so it can be called with any of: |
| b69ab31 | | | 261 | * - current active file Uri for use from the command palette |
| b69ab31 | | | 262 | * - a vscode Uri for programmatic invocations |
| b69ab31 | | | 263 | * - a SourceControlResourceState for use from the VS Code SCM sidebar API |
| b69ab31 | | | 264 | */ |
| b69ab31 | | | 265 | function commandWithUriOrResourceState( |
| b69ab31 | | | 266 | handler: ( |
| b69ab31 | | | 267 | repo: Repository, |
| b69ab31 | | | 268 | uri: vscode.Uri, |
| b69ab31 | | | 269 | path: RepoRelativePath, |
| b69ab31 | | | 270 | ) => unknown | Thenable<unknown>, |
| b69ab31 | | | 271 | ) { |
| b69ab31 | | | 272 | return function ( |
| b69ab31 | | | 273 | this: RepositoryContext, |
| b69ab31 | | | 274 | uriOrResource: vscode.Uri | vscode.SourceControlResourceState | undefined, |
| b69ab31 | | | 275 | ) { |
| b69ab31 | | | 276 | const uri = |
| b69ab31 | | | 277 | uriOrResource == null |
| b69ab31 | | | 278 | ? vscode.window.activeTextEditor?.document.uri |
| b69ab31 | | | 279 | : uriOrResource instanceof vscode.Uri |
| b69ab31 | | | 280 | ? uriOrResource |
| b69ab31 | | | 281 | : uriOrResource.resourceUri; |
| b69ab31 | | | 282 | if (uri == null) { |
| b69ab31 | | | 283 | vscode.window.showErrorMessage(t(`No active file found`)); |
| b69ab31 | | | 284 | return; |
| b69ab31 | | | 285 | } |
| b69ab31 | | | 286 | |
| b69ab31 | | | 287 | const {fsPath} = uri; |
| b69ab31 | | | 288 | const repo = repositoryCache.cachedRepositoryForPath(fsPath); |
| b69ab31 | | | 289 | if (repo == null) { |
| b69ab31 | | | 290 | vscode.window.showErrorMessage(t(`No repository found for file ${fsPath}`)); |
| b69ab31 | | | 291 | return; |
| b69ab31 | | | 292 | } |
| b69ab31 | | | 293 | |
| b69ab31 | | | 294 | const repoRelativePath = repoRelativePathForAbsolutePath(uri.fsPath, repo); |
| b69ab31 | | | 295 | return handler.apply(this, [repo, uri, repoRelativePath]); |
| b69ab31 | | | 296 | }; |
| b69ab31 | | | 297 | } |