feat: add blame status bar item (#175)

tjkandala · web-flow · commit fc3e6d7e7570 · 2021-04-12T15:19:44.000-04:00
diff --git a/src/blame.test.ts b/src/blame.test.ts
@@ -3,6 +3,7 @@ import {
     getAllBlameDecorations,
     getBlameDecorations,
     getBlameDecorationsForSelections,
+    getBlameStatusBarItem,
     getDecorationFromHunk,
     Hunk,
 } from './blame'
@@ -229,14 +230,13 @@ describe('getAllBlameDecorations()', () => {
 describe('getBlameDecorations()', () => {
     it('gets decorations for all hunks if no selections are passed', async () => {
         expect(
-            await getBlameDecorations({
-                uri: 'a',
+            getBlameDecorations({
                 settings: {
                     'git.blame.decorations': 'line',
                 },
                 now: NOW,
                 selections: null,
-                queryHunks: () => Promise.resolve([FIXTURE_HUNK_1, FIXTURE_HUNK_2, FIXTURE_HUNK_3, FIXTURE_HUNK_4]),
+                hunks: [FIXTURE_HUNK_1, FIXTURE_HUNK_2, FIXTURE_HUNK_3, FIXTURE_HUNK_4],
                 sourcegraph: SOURCEGRAPH as any,
             })
         ).toEqual([
@@ -249,48 +249,45 @@ describe('getBlameDecorations()', () => {
 
     it('gets decorations for the selections if selections are passed', async () => {
         expect(
-            await getBlameDecorations({
-                uri: 'a',
+            getBlameDecorations({
                 settings: {
                     'git.blame.decorations': 'line',
                 },
                 now: NOW,
                 selections: [
                     new SOURCEGRAPH.Selection(new SOURCEGRAPH.Position(3, 0), new SOURCEGRAPH.Position(3, 0)) as any,
                 ],
-                queryHunks: () => Promise.resolve([FIXTURE_HUNK_1, FIXTURE_HUNK_2, FIXTURE_HUNK_3, FIXTURE_HUNK_4]),
+                hunks: [FIXTURE_HUNK_1, FIXTURE_HUNK_2, FIXTURE_HUNK_3, FIXTURE_HUNK_4],
                 sourcegraph: SOURCEGRAPH as any,
             })
         ).toEqual([getDecorationFromHunk(FIXTURE_HUNK_4, NOW, 3, SOURCEGRAPH as any)])
     })
 
     it('gets no decorations if git.blame.decorations is "none"', async () => {
         expect(
-            await getBlameDecorations({
-                uri: 'a',
+            getBlameDecorations({
                 settings: {
                     'git.blame.decorations': 'none',
                 },
                 now: NOW,
                 selections: null,
-                queryHunks: () => Promise.resolve([FIXTURE_HUNK_1, FIXTURE_HUNK_2, FIXTURE_HUNK_3, FIXTURE_HUNK_4]),
+                hunks: [FIXTURE_HUNK_1, FIXTURE_HUNK_2, FIXTURE_HUNK_3, FIXTURE_HUNK_4],
                 sourcegraph: SOURCEGRAPH as any,
             })
         ).toEqual([])
     })
 
     it('gets decorations for all hunks if git.blame.decorations is "file"', async () => {
         expect(
-            await getBlameDecorations({
-                uri: 'a',
+            getBlameDecorations({
                 settings: {
                     'git.blame.decorations': 'file',
                 },
                 now: NOW,
                 selections: [
                     new SOURCEGRAPH.Selection(new SOURCEGRAPH.Position(3, 0), new SOURCEGRAPH.Position(3, 0)) as any,
                 ],
-                queryHunks: () => Promise.resolve([FIXTURE_HUNK_1, FIXTURE_HUNK_2, FIXTURE_HUNK_3, FIXTURE_HUNK_4]),
+                hunks: [FIXTURE_HUNK_1, FIXTURE_HUNK_2, FIXTURE_HUNK_3, FIXTURE_HUNK_4],
                 sourcegraph: SOURCEGRAPH as any,
             })
         ).toEqual([
@@ -314,3 +311,38 @@ describe('getBlameDecorations()', () => {
         ).toBe(true)
     })
 })
+
+describe('getBlameStatusBarItem()', () => {
+    it('displays the hunk for the first selected line', () => {
+        expect(
+            getBlameStatusBarItem({
+                selections: [
+                    new SOURCEGRAPH.Selection(new SOURCEGRAPH.Position(3, 0), new SOURCEGRAPH.Position(3, 0)) as any,
+                ],
+                hunks: [FIXTURE_HUNK_1, FIXTURE_HUNK_2, FIXTURE_HUNK_3, FIXTURE_HUNK_4],
+                sourcegraph: SOURCEGRAPH as any,
+                now: NOW,
+            }).text
+        ).toBe('Blame: (testUserName) i, 2 months ago')
+    })
+
+    it('displays the most recent hunk if there are no selections', () => {
+        expect(
+            getBlameStatusBarItem({
+                selections: [],
+                hunks: [FIXTURE_HUNK_1, FIXTURE_HUNK_2, FIXTURE_HUNK_3, FIXTURE_HUNK_4],
+                sourcegraph: SOURCEGRAPH as any,
+                now: NOW,
+            }).text
+        ).toBe('Blame: e, 21 days ago')
+
+        expect(
+            getBlameStatusBarItem({
+                selections: null,
+                hunks: [FIXTURE_HUNK_1, FIXTURE_HUNK_2, FIXTURE_HUNK_3, FIXTURE_HUNK_4],
+                sourcegraph: SOURCEGRAPH as any,
+                now: NOW,
+            }).text
+        ).toBe('Blame: e, 21 days ago')
+    })
+})
diff --git a/src/blame.ts b/src/blame.ts
@@ -1,45 +1,49 @@
+import compareDesc from 'date-fns/compareDesc'
 import formatDistanceStrict from 'date-fns/formatDistanceStrict'
-import { Selection, TextDocumentDecoration } from 'sourcegraph'
+import { Selection, StatusBarItem, TextDocumentDecoration } from 'sourcegraph'
 import gql from 'tagged-template-noop'
 import { Settings } from './extension'
 import { resolveURI } from './uri'
 import { memoizeAsync } from './util/memoizeAsync'
 
-export const getDecorationFromHunk = (
-    { message, author, commit }: Hunk,
+/**
+ * Get display info shared between status bar items and text document decorations.
+ */
+const getDisplayInfoFromHunk = (
+    { author, commit, message }: Pick<Hunk, 'author' | 'commit' | 'message'>,
     now: number,
-    decoratedLine: number,
     sourcegraph: typeof import('sourcegraph')
-): TextDocumentDecoration => {
+): { displayName: string; username: string; distance: string; linkURL: string; hoverMessage: string } => {
     const displayName = truncate(author.person.displayName, 25)
     const username = author.person.user ? `(${author.person.user.username}) ` : ''
     const distance = formatDistanceStrict(author.date, now, { addSuffix: true })
+    const linkURL = new URL(commit.url, sourcegraph.internal.sourcegraphURL.toString()).href
+    const hoverMessage = `${author.person.email} • ${truncate(message, 1000)}`
+
     return {
-        range: new sourcegraph.Range(decoratedLine, 0, decoratedLine, 0),
-        isWholeLine: true,
-        after: {
-            light: {
-                color: 'rgba(0, 0, 25, 0.55)',
-                backgroundColor: 'rgba(193, 217, 255, 0.65)',
-            },
-            dark: {
-                color: 'rgba(235, 235, 255, 0.55)',
-                backgroundColor: 'rgba(15, 43, 89, 0.65)',
-            },
-            contentText: `${username}${displayName}, ${distance}: • ${truncate(message, 45)}`,
-            hoverMessage: `${author.person.email} • ${truncate(message, 1000)}`,
-            linkURL: new URL(commit.url, sourcegraph.internal.sourcegraphURL.toString()).href,
-        },
+        displayName,
+        username,
+        distance,
+        linkURL,
+        hoverMessage,
     }
 }
 
-export const getBlameDecorationsForSelections = (
+/**
+ * Get hunks and 0-indexed start lines for the given selections.
+ *
+ * @param selections If null, returns all hunks
+ */
+export const getHunksForSelections = (
     hunks: Hunk[],
-    selections: Selection[],
-    now: number,
-    sourcegraph: typeof import('sourcegraph')
-) => {
-    const decorations: TextDocumentDecoration[] = []
+    selections: Selection[] | null
+): { selectionStartLine: number; hunk: Hunk }[] => {
+    const hunksForSelections: { selectionStartLine: number; hunk: Hunk }[] = []
+
+    if (!selections) {
+        return hunks.map(hunk => ({ hunk, selectionStartLine: hunk.startLine - 1 }))
+    }
+
     for (const hunk of hunks) {
         // Hunk start and end lines are 1-indexed, but selection lines are zero-indexed
         const hunkStartLineZeroBased = hunk.startLine - 1
@@ -50,20 +54,59 @@ export const getBlameDecorationsForSelections = (
             if (selection.end.line < hunkStartLineZeroBased || selection.start.line > hunkEndLineZeroBased) {
                 continue
             }
+
             // Decorate the hunk's start line or, if the hunk's start line is
             // outside of the selection's boundaries, the start line of the selection.
-            const decoratedLine =
+            const selectionStartLine =
                 hunkStartLineZeroBased < selection.start.line ? selection.start.line : hunkStartLineZeroBased
-            decorations.push(getDecorationFromHunk(hunk, now, decoratedLine, sourcegraph))
+            hunksForSelections.push({ selectionStartLine, hunk })
         }
     }
-    return decorations
+
+    return hunksForSelections
+}
+
+export const getDecorationFromHunk = (
+    hunk: Hunk,
+    now: number,
+    decoratedLine: number,
+    sourcegraph: typeof import('sourcegraph')
+): TextDocumentDecoration => {
+    const { displayName, username, distance, linkURL, hoverMessage } = getDisplayInfoFromHunk(hunk, now, sourcegraph)
+
+    return {
+        range: new sourcegraph.Range(decoratedLine, 0, decoratedLine, 0),
+        isWholeLine: true,
+        after: {
+            light: {
+                color: 'rgba(0, 0, 25, 0.55)',
+                backgroundColor: 'rgba(193, 217, 255, 0.65)',
+            },
+            dark: {
+                color: 'rgba(235, 235, 255, 0.55)',
+                backgroundColor: 'rgba(15, 43, 89, 0.65)',
+            },
+            contentText: `${username}${displayName}, ${distance}: • ${truncate(hunk.message, 45)}`,
+            hoverMessage,
+            linkURL,
+        },
+    }
 }
 
+export const getBlameDecorationsForSelections = (
+    hunks: Hunk[],
+    selections: Selection[],
+    now: number,
+    sourcegraph: typeof import('sourcegraph')
+) =>
+    getHunksForSelections(hunks, selections).map(({ hunk, selectionStartLine }) =>
+        getDecorationFromHunk(hunk, now, selectionStartLine, sourcegraph)
+    )
+
 export const getAllBlameDecorations = (hunks: Hunk[], now: number, sourcegraph: typeof import('sourcegraph')) =>
     hunks.map(hunk => getDecorationFromHunk(hunk, now, hunk.startLine - 1, sourcegraph))
 
-const queryBlameHunks = memoizeAsync(
+export const queryBlameHunks = memoizeAsync(
     async ({ uri, sourcegraph }: { uri: string; sourcegraph: typeof import('sourcegraph') }): Promise<Hunk[]> => {
         const { repo, rev, path } = resolveURI(uri)
         const { data, errors } = await sourcegraph.commands.executeCommand(
@@ -111,39 +154,93 @@ const queryBlameHunks = memoizeAsync(
 )
 
 /**
- * Queries the blame hunks for the document at the provided URI,
- * and returns blame decorations for all provided selections,
+ * Returns blame decorations for all provided selections,
  * or for all hunks if `selections` is `null`.
- *
  */
-export const getBlameDecorations = async ({
-    uri,
+export const getBlameDecorations = ({
     settings,
     selections,
     now,
-    queryHunks = queryBlameHunks,
+    hunks,
     sourcegraph,
 }: {
-    uri: string
     settings: Settings
     selections: Selection[] | null
     now: number
-    queryHunks?: ({ uri, sourcegraph }: { uri: string; sourcegraph: typeof import('sourcegraph') }) => Promise<Hunk[]>
+    hunks: Hunk[]
     sourcegraph: typeof import('sourcegraph')
-}): Promise<TextDocumentDecoration[]> => {
+}): TextDocumentDecoration[] => {
     const decorations = settings['git.blame.decorations'] || 'none'
 
     if (decorations === 'none') {
         return []
     }
-    const hunks = await queryHunks({ uri, sourcegraph })
     if (selections !== null && decorations === 'line') {
         return getBlameDecorationsForSelections(hunks, selections, now, sourcegraph)
     } else {
         return getAllBlameDecorations(hunks, now, sourcegraph)
     }
 }
 
+export const getBlameStatusBarItem = ({
+    selections,
+    hunks,
+    now,
+    sourcegraph,
+}: {
+    selections: Selection[] | null
+    hunks: Hunk[]
+    now: number
+    sourcegraph: typeof import('sourcegraph')
+}): StatusBarItem => {
+    if (selections && selections.length > 0) {
+        const hunksForSelections = getHunksForSelections(hunks, selections)
+        if (hunksForSelections[0]) {
+            // Display the commit for the first selected hunk in the status bar.
+            const { displayName, username, distance, linkURL, hoverMessage } = getDisplayInfoFromHunk(
+                hunksForSelections[0].hunk,
+                now,
+                sourcegraph
+            )
+
+            return {
+                text: `Blame: ${username}${displayName}, ${distance}`,
+                command: { id: 'open', args: [linkURL] },
+                tooltip: hoverMessage,
+            }
+        }
+    }
+
+    // Since there are no selections, we want to determine the most
+    // recent change to this file to display in the status bar.
+
+    // Get all hunks
+    const hunksForSelections = getHunksForSelections(hunks, null)
+    const mostRecentHunk = hunksForSelections.sort((a, b) => compareDesc(a.hunk.author.date, b.hunk.author.date))[0]
+    if (!mostRecentHunk) {
+        // Probably a network error
+        return {
+            text: 'Blame: not found',
+        }
+    }
+    const { displayName, username, distance, linkURL, hoverMessage } = getDisplayInfoFromHunk(
+        mostRecentHunk.hunk,
+        now,
+        sourcegraph
+    )
+
+    return {
+        text: `Blame: ${username}${displayName}, ${distance}`,
+        command: { id: 'open', args: [linkURL] },
+        tooltip: hoverMessage,
+    }
+}
+
+export interface HunkForSelection {
+    hunk: Hunk
+    selectionStartLine: number
+}
+
 export interface Hunk {
     startLine: number
     endLine: number
diff --git a/src/extension.ts b/src/extension.ts
