version navigation (#231)

Author: marcellourbani

.github/workflows/build_and_publish.yml

@@ -15,7 +15,7 @@ jobs:
       - name: Install Node.js
         uses: actions/setup-node@v1
         with:
-          node-version: 14.x
+          node-version: 20
       - run: npm install
       - name: Run tests
         run: npm test

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## [1.7.17] 2024-10-30
+
+### Added
+
+- previous/next versions in diff
+
 ## [1.7.16] 2024-10-29
 
 ### Added

client/src/commands/registry.ts

@@ -46,6 +46,10 @@ export const AbapFsCommands = {
   opendiff: "abapfs.opendiff",
   opendiffNormalized: "abapfs.opendiffNormalized",
   togglediffNormalize: "abapfs.togglediffNormalize",
+  prevRevLeft: "abapfs.prevRevLeft",
+  nextRevLeft: "abapfs.nextRevLeft",
+  prevRevRight: "abapfs.prevRevRight",
+  nextRevRight: "abapfs.nextRevRight",
   changequickdiff: "abapfs.changequickdiff",
   remotediff: "abapfs.remotediff",
   comparediff: "abapfs.comparediff",

client/src/context.ts

@@ -0,0 +1,16 @@
+import { commands } from "vscode"
+
+export type AbapFsContexts = "abapfs:showActivate" |
+    "abapfs:atc:autorefreshOn" |
+    "abapfs:atc:exemptFilterOn" |
+    "abapfs:atcdoc:navigation:back" |
+    "abapfs:atcdoc:navigation:next" |
+    "abapfs:extensionActive" |
+    "abapfs:extensionActive" |
+    "abapfs:showTableContentIcon" |
+    "abapfs:enableLeftPrevRev" |
+    "abapfs:enableLeftNextRev" |
+    "abapfs:enableRightPrevRev" |
+    "abapfs:enableRightNextRev"
+
+export const setContext = (key: AbapFsContexts, value: unknown) => commands.executeCommand("setContext", key, value)

client/src/extension.ts

@@ -4,7 +4,6 @@ import { atcProvider, registerSCIDecorator } from "./views/abaptestcockpit"
 import { FsProvider } from "./fs/FsProvider"
 import {
   window,
-  commands,
   workspace,
   ExtensionContext,
   languages
@@ -33,6 +32,7 @@ import { dumpProvider } from "./views/dumps/dumps"
 import { registerAbapDebugger } from "./adt/debugger"
 import { ATCDocumentation } from "./views/abaptestcockpit/documentation"
 import { tracesProvider } from "./views/traces"
+import { setContext } from "./context"
 
 export let context: ExtensionContext
 
@@ -102,7 +102,7 @@ export async function activate(ctx: ExtensionContext): Promise<AbapFsApi> {
 
   LanguageCommands.start(context)
 
-  commands.executeCommand("setContext", "abapfs:extensionActive", true)
+  setContext("abapfs:extensionActive", true)
   restoreLocks()
   registerAbapGit(context)
 
@@ -123,6 +123,6 @@ export async function deactivate() {
     window.showInformationMessage(
       "Locks will be dropped now. If the relevant editors are still open they will be restored later"
     )
-  commands.executeCommand("setContext", "abapfs:extensionActive", false)
+  setContext("abapfs:extensionActive", false)
   return disconnect()
 }

client/src/lib/vscodefunctions.ts

@@ -10,7 +10,8 @@ import {
   Position,
   Range,
   OpenDialogOptions,
-  QuickPickOptions
+  QuickPickOptions,
+  commands
 } from "vscode"
 import { splitAdtUriInternal, isUnDefined, isFn, isNonNullable, caughtToString, isString } from "./functions"
 import { Range as ApiRange, UriParts } from "abap-adt-api"

client/src/listeners.ts

@@ -8,7 +8,8 @@ import {
   Disposable,
   Event,
   TextDocumentWillSaveEvent,
-  workspace
+  workspace,
+  TabInputTextDiff
 } from "vscode"
 
 import { caughtToString, debounce, log, viewableObjecttypes } from "./lib"
@@ -17,8 +18,9 @@ import { AbapObject } from "abapobject"
 import { isAbapStat } from "abapfs"
 import { isCsrfError } from "abap-adt-api"
 import { LockStatus } from "abapfs/out/lockObject"
-import { IncludeProvider } from "./adt/includes"
 import { uriAbapFile } from "./adt/operations/AdtObjectFinder"
+import { versionRevisions } from "./scm/abaprevisions"
+import { setContext } from "./context"
 
 export const listenersubscribers: ((...x: any[]) => Disposable)[] = []
 
@@ -151,7 +153,7 @@ function isInactive(obj: AbapObject): boolean {
 function showHidedbIcon(editor?: TextEditor) {
   try {
     const type = uriAbapFile(editor?.document.uri)?.object.type
-    commands.executeCommand("setContext", "abapfs:showTableContentIcon", viewableObjecttypes.has(type))
+    setContext("abapfs:showTableContentIcon", viewableObjecttypes.has(type))
   } catch (error) { }
 }
 
@@ -175,7 +177,7 @@ export async function showHideActivate(editor?: TextEditor, refresh = false) {
   }
   // race condition, active editor might have changed while async operation was pending
   if (editor !== window.activeTextEditor) return
-  await commands.executeCommand("setContext", "abapfs:showActivate", shouldShow)
+  await setContext("abapfs:showActivate", shouldShow)
 }
 export async function activationStateListener(uri: Uri) {
   const editor = window.activeTextEditor
@@ -185,11 +187,42 @@ export async function activationStateListener(uri: Uri) {
     await showHideActivate(editor)
   }
 }
-
+const setRevisionContext = (leftprev: boolean, leftnext: boolean, rightprev: boolean, rightnext: boolean) => {
+  setContext("abapfs:enableLeftNextRev", leftnext)
+  setContext("abapfs:enableLeftPrevRev", leftprev)
+  setContext("abapfs:enableRightNextRev", rightnext)
+  setContext("abapfs:enableRightPrevRev", rightprev)
+}
+const enableRevNavigation = async (editor: TextEditor | undefined) => {
+  if (editor) {
+    const firstlast = async (u: Uri): Promise<[boolean, boolean]> => {
+      const v = await versionRevisions(u)
+      if (!v) return [false, false]
+      const { revision, revisions } = v
+      const idx = revisions.findIndex(r => r.uri === revision.uri)
+      const hasNext = idx > 0
+      const hasprev = idx >= 0 && idx < revisions.length - 1
+      return [hasprev, hasNext]
+    }
+    try {
+      const tab = window.tabGroups.activeTabGroup.activeTab
+      if (tab?.input instanceof TabInputTextDiff) {
+        const { original, modified } = tab.input
+        const lefts = await firstlast(original)
+        const rights = await firstlast(modified)
+        if (rights && lefts) return setRevisionContext(...lefts, ...rights)
+      }
+    } catch (error) {
+      // on error just disable all
+    }
+  }
+  return setRevisionContext(false, false, false, false)
+}
 export async function activeTextEditorChangedListener(
   editor: TextEditor | undefined
 ) {
   showHidedbIcon(editor)
+  enableRevNavigation(editor)
   try {
     if (editor && editor.document.uri.scheme === ADTSCHEME) {
       await showHideActivate(editor)

client/src/scm/abaprevisions/commands.ts

@@ -4,7 +4,7 @@ import { abapUri, uriRoot, getOrCreateRoot, getClient, ADTSCHEME, rootIsConnecte
 import { AbapRevisionService, revLabel } from "./abaprevisionservice"
 import { ADTClient, Revision } from "abap-adt-api"
 import { AbapQuickDiff } from "./quickdiff"
-import { revisionUri } from "./documentprovider"
+import { decodeRevisioUrl, revisionUri } from "./documentprovider"
 import { RemoteManager, formatKey } from "../../config"
 import { isAbapFile } from "abapfs"
 import { AGroup, AState } from "./abapscm"
@@ -47,6 +47,31 @@ const loadRevisions = async (uri: Uri, withRefresh = true) => {
   const revisions = await service.uriRevisions(uri, withRefresh)
   return revisions || []
 }
+interface UriRevisions { uri: Uri, normalized: boolean, revision: Revision, revisions: Revision[] }
+export const versionRevisions = async (v: Uri, refresh = false): Promise<UriRevisions | undefined> => {
+  const decoded = decodeRevisioUrl(v)
+  if (decoded) {
+    const { uri, revision, normalized } = decoded
+    const revisions = await loadRevisions(uri, refresh)
+    const found = revisions.find(r => r.uri === revision.uri)
+    if (found) return { uri, revision, revisions, normalized }
+  }
+}
+
+const currentRevisions = async () => {
+  const tab = window.tabGroups.activeTabGroup.activeTab
+  if (tab?.input instanceof TabInputTextDiff) {
+    const { original, modified } = tab.input
+    const lefts = await versionRevisions(original)
+    const leftindex = lefts?.revisions.findIndex(r => r.uri === lefts.revision.uri) ?? -1
+    const rights = leftindex >= 0 ? await versionRevisions(modified) : undefined
+    const rightindex = rights?.revisions.findIndex(r => r.uri === rights.revision.uri) ?? -1
+    if (!lefts || !rights || rightindex < 0 || leftindex < 0) return
+
+    return { lefts, rights, leftindex, rightindex }
+  }
+
+}
 
 const pickRevision = async (revisions: Revision[], title = "Select version") => {
   if (!revisions.length) return
@@ -161,10 +186,47 @@ export class AbapRevisionCommands {
     if (!abapUri(uri)) return
     const leftRev = await selectRevision(uri, "Select version for left pane")
     if (!leftRev) return
-    const rightRev = await selectRevision(uri, "Select version for right pane")
+    const rightRev = await selectRevision(uri, "Select version for right pane", false)
     if (!rightRev) return
     displayRevDiff(rightRev, leftRev, uri)
   }
+  @command(AbapFsCommands.prevRevLeft)
+  private async prevLeft() {
+    const current = await currentRevisions()
+    if (current) {
+      const left = current.lefts.revisions[current.leftindex + 1]
+      if (left) return displayRevDiff(current.rights.revision, left, current.lefts.uri, current.lefts.normalized)
+    }
+    return window.showWarningMessage("Failed to determine version")
+  }
+  @command(AbapFsCommands.prevRevRight)
+  private async prevRight() {
+    const current = await currentRevisions()
+    if (current) {
+      const right = current.rights.revisions[current.rightindex + 1]
+      if (right) return displayRevDiff(right, current.lefts.revision, current.lefts.uri, current.lefts.normalized)
+    }
+    return window.showWarningMessage("Failed to determine version")
+  }
+  @command(AbapFsCommands.nextRevLeft)
+  private async nextLeft() {
+    const current = await currentRevisions()
+    if (current) {
+      const left = current.lefts.revisions[current.leftindex - 1]
+      if (left) return displayRevDiff(current.rights.revision, left, current.lefts.uri, current.lefts.normalized)
+    }
+    return window.showWarningMessage("Failed to determine version")
+
+  }
+  @command(AbapFsCommands.nextRevRight)
+  private async nextRight() {
+    const current = await currentRevisions()
+    if (current) {
+      const right = current.rights.revisions[current.rightindex - 1]
+      if (right) return displayRevDiff(right, current.lefts.revision, current.lefts.uri, current.lefts.normalized)
+    }
+    return window.showWarningMessage("Failed to determine version")
+  }
 
   private static async showMerge(uri: Uri, incomingUri: Uri, incomings: Revision[], locals: Revision[], incoming: Revision, conflict: Revision) {
     const baseVer = await pickCommonAncestor(locals, conflict, incomings, incoming)

client/src/scm/abaprevisions/documentprovider.ts

@@ -23,6 +23,12 @@ type Selector = SimpleSelector | QuickDiffSelector
 const isQuickDiff = (s: Selector): s is QuickDiffSelector =>
   s.type === "quickdiff"
 
+interface RevisionDetails {
+  uri: Uri,
+  revision: Revision,
+  normalized: boolean
+}
+
 export function revisionUri(uri: Uri, revision?: Revision, normalized = false) {
   if (!abapUri(uri)) return
   const selector: SimpleSelector = {
@@ -35,6 +41,18 @@ export function revisionUri(uri: Uri, revision?: Revision, normalized = false) {
   return uri.with({ scheme: ADTREVISIONSCHEME, fragment })
 }
 
+export const decodeRevisioUrl = (uri: Uri): RevisionDetails | undefined => {
+  if (uri.scheme !== ADTREVISIONSCHEME) return
+  try {
+    const selector: Selector = JSON.parse(atob(uri.fragment))
+    if (isQuickDiff(selector) || !selector.revision) return
+    const { revision, normalized } = selector
+    return { uri: uri.with({ scheme: ADTSCHEME, fragment: selector.origFragment }), revision, normalized }
+  } catch (error) {
+    return
+  }
+}
+
 export const quickDiffUri = (uri: Uri) => {
   if (!abapUri(uri)) return
   const selector: Selector = {

client/src/scm/abaprevisions/index.ts

@@ -1,4 +1,4 @@
 export { registerRevisionModel } from "./abapscm"
 export { AbapRevisionLens } from "./lenses"
 export { AbapScm } from "./abapscm"
-export { displayRevDiff } from "./commands"
+export { displayRevDiff, versionRevisions } from "./commands"