Populate authorDate when parsing reflog

This allows us to greatly simplify several components and will allow implementing branch sorting options

Author: pol-rivero

app/src/lib/git/for-each-ref.ts

@@ -21,6 +21,7 @@ export async function getBranches(
     upstreamTrackingBranch: '%(upstream:track)',
     sha: '%(objectname)',
     symRef: '%(symref)',
+    authorDate: '%(authordate:iso8601)',
   })
 
   if (!prefixes || !prefixes.length) {
@@ -41,15 +42,20 @@ export async function getBranches(
     return []
   }
 
-  const branches = []
+  const branches: Branch[] = []
 
   for (const ref of parse(result.stdout)) {
     // excude symbolic refs from the branch list
     if (ref.symRef.length > 0) {
       continue
     }
 
-    const tip: IBranchTip = { sha: ref.sha }
+    const tip: IBranchTip = {
+      sha: ref.sha,
+      author: {
+        date: new Date(ref.authorDate),
+      },
+    }
 
     const type = ref.fullName.startsWith('refs/heads')
       ? BranchType.Local

app/src/models/branch.ts

@@ -28,9 +28,14 @@ export interface ITrackingBranch {
   readonly upstreamSha: string
 }
 
+export interface IAuthor {
+  readonly date: Date
+}
+
 /** Basic data about the latest commit on the branch. */
 export interface IBranchTip {
   readonly sha: string
+  readonly author: IAuthor
 }
 
 /** Default rules for where to create a branch from */

app/src/ui/branches/branch-list.tsx

@@ -24,7 +24,6 @@ import { SectionFilterList } from '../lib/section-filter-list'
 import { Octicon } from '../octicons'
 import * as octicons from '../octicons/octicons.generated'
 import memoizeOne from 'memoize-one'
-import { getAuthors } from '../../lib/git/log'
 import { Repository } from '../../models/repository'
 import { formatDate } from '../../lib/format-date'
 
@@ -107,18 +106,14 @@ interface IBranchListProps {
   readonly textbox?: TextBox
 
   /** Aria label for a specific row */
-  readonly getBranchAriaLabel: (
-    item: IBranchListItem,
-    authorDate: Date | undefined
-  ) => string | undefined
+  readonly getBranchAriaLabel: (item: IBranchListItem) => string | undefined
 
   /**
    * Render function to apply to each branch in the list
    */
   readonly renderBranch: (
     item: IBranchListItem,
-    matches: IMatches,
-    authorDate: Date | undefined
+    matches: IMatches
   ) => JSX.Element
 
   /**
@@ -145,17 +140,8 @@ interface IBranchListProps {
   readonly onDeleteBranch?: (branchName: string) => void
 }
 
-interface IBranchListState {
-  readonly commitAuthorDates: ReadonlyMap<string, Date>
-}
-
-const commitDateCache = new Map<string, Date>()
-
 /** The Branches list component. */
-export class BranchList extends React.Component<
-  IBranchListProps,
-  IBranchListState
-> {
+export class BranchList extends React.Component<IBranchListProps> {
   private branchFilterList: SectionFilterList<IBranchListItem> | null = null
 
   private getGroups = memoizeOne(groupBranches)
@@ -167,7 +153,7 @@ export class BranchList extends React.Component<
   )
 
   /**
-   * Generate a new object any time groups or commitAuthorDates changes
+   * Generate a new object any time groups changes
    * in order to force the list to re-render.
    *
    * Note, change is determined by reference equality. This opaque object
@@ -179,14 +165,11 @@ export class BranchList extends React.Component<
    * Using a guid which we used to do works but is overkill.
    */
   private getInvalidationProp = memoizeOne(
-    (
-      _groups: ReturnType<typeof groupBranches>,
-      _commitAuthorDates: IBranchListState['commitAuthorDates']
-    ) => ({})
+    (_groups: ReturnType<typeof groupBranches>) => ({})
   )
 
   private get invalidationProp() {
-    return this.getInvalidationProp(this.groups, this.state.commitAuthorDates)
+    return this.getInvalidationProp(this.groups)
   }
 
   private get groups() {
@@ -203,62 +186,11 @@ export class BranchList extends React.Component<
     return this.getSelectedItem(this.groups, this.props.selectedBranch)
   }
 
-  public constructor(props: IBranchListProps) {
-    super(props)
-    this.state = {
-      commitAuthorDates: new Map<string, Date>(),
-    }
-  }
-
   public selectNextItem(focus: boolean = false, direction: SelectionDirection) {
     if (this.branchFilterList !== null) {
       this.branchFilterList.selectNextItem(focus, direction)
     }
   }
-
-  public componentDidUpdate(prevProps: IBranchListProps) {
-    if (prevProps.allBranches !== this.props.allBranches) {
-      this.populateCommitDates()
-    }
-  }
-
-  private populateCommitDates = () => {
-    const cached = new Map<string, Date>()
-    const missing = new Array<string>()
-    const uniqShas = new Set(this.props.allBranches.map(b => b.tip.sha))
-
-    for (const sha of uniqShas) {
-      const date = commitDateCache.get(sha)
-      if (date) {
-        cached.set(sha, date)
-      } else {
-        missing.push(sha)
-      }
-    }
-
-    // Clean up the cache
-    for (const sha of commitDateCache.keys()) {
-      if (!uniqShas.has(sha)) {
-        commitDateCache.delete(sha)
-      }
-    }
-
-    this.setState({ commitAuthorDates: cached })
-
-    if (missing.length > 0) {
-      getAuthors(this.props.repository, missing)
-        .then(x => {
-          x.forEach(({ date }, i) => commitDateCache.set(missing[i], date))
-          this.populateCommitDates()
-        })
-        .catch(e => log.error(`Failed to populate commit dates`, e))
-    }
-  }
-
-  public componentDidMount() {
-    this.populateCommitDates()
-  }
-
   public render() {
     return (
       <SectionFilterList<IBranchListItem>
@@ -334,25 +266,18 @@ export class BranchList extends React.Component<
   }
 
   private renderItem = (item: IBranchListItem, matches: IMatches) => {
-    return this.props.renderBranch(
-      item,
-      matches,
-      this.state.commitAuthorDates.get(item.branch.tip.sha)
-    )
+    return this.props.renderBranch(item, matches)
   }
 
   private renderRowFocusTooltip = (
     item: IBranchListItem
   ): JSX.Element | string | null => {
     const { tip, name } = item.branch
-    const authorDate = this.state.commitAuthorDates.get(tip.sha)
 
-    const absoluteDate = authorDate
-      ? formatDate(authorDate, {
-          dateStyle: 'full',
-          timeStyle: 'short',
-        })
-      : null
+    const absoluteDate = formatDate(tip.author.date, {
+      dateStyle: 'full',
+      timeStyle: 'short',
+    })
 
     const otherWorktreeName = this.inUseByOtherWorktreeName(item)
     return (
@@ -400,10 +325,7 @@ export class BranchList extends React.Component<
   }
 
   private getItemAriaLabel = (item: IBranchListItem) => {
-    return this.props.getBranchAriaLabel(
-      item,
-      this.state.commitAuthorDates.get(item.branch.tip.sha)
-    )
+    return this.props.getBranchAriaLabel(item)
   }
 
   private getGroupAriaLabel = (group: number) => {

app/src/ui/branches/branch-renderer.tsx

@@ -12,7 +12,6 @@ export function renderDefaultBranch(
   item: IBranchListItem,
   matches: IMatches,
   currentBranch: Branch | null,
-  authorDate: Date | undefined,
   onDropOntoBranch?: (branchName: string) => void,
   onDropOntoCurrentBranch?: () => void
 ): JSX.Element {
@@ -29,7 +28,7 @@ export function renderDefaultBranch(
     <BranchListItem
       name={branch.name}
       isCurrentBranch={branch.name === currentBranchName}
-      authorDate={authorDate}
+      authorDate={branch.tip.author.date}
       isLocalOnly={isLocalOnly}
       matches={matches}
       worktreeName={worktreeName}
@@ -39,11 +38,9 @@ export function renderDefaultBranch(
   )
 }
 
-export function getDefaultAriaLabelForBranch(
-  item: IBranchListItem,
-  authorDate: Date | undefined
-): string {
+export function getDefaultAriaLabelForBranch(item: IBranchListItem): string {
   const branch = item.branch
+  const authorDate = branch.tip.author.date
 
   if (!authorDate) {
     return branch.name

app/src/ui/branches/branch-select.tsx

@@ -67,24 +67,12 @@ export class BranchSelect extends React.Component<
     }
   }
 
-  private renderBranch = (
-    item: IBranchListItem,
-    matches: IMatches,
-    authorDate: Date | undefined
-  ) => {
-    return renderDefaultBranch(
-      item,
-      matches,
-      this.props.currentBranch,
-      authorDate
-    )
+  private renderBranch = (item: IBranchListItem, matches: IMatches) => {
+    return renderDefaultBranch(item, matches, this.props.currentBranch)
   }
 
-  private getBranchAriaLabel = (
-    item: IBranchListItem,
-    authorDate: Date | undefined
-  ): string => {
-    return getDefaultAriaLabelForBranch(item, authorDate)
+  private getBranchAriaLabel = (item: IBranchListItem): string => {
+    return getDefaultAriaLabelForBranch(item)
   }
 
   private onItemClick = (branch: Branch, source: ClickSource) => {

app/src/ui/branches/branches-container.tsx

@@ -223,26 +223,18 @@ export class BranchesContainer extends React.Component<
     )
   }
 
-  private renderBranch = (
-    item: IBranchListItem,
-    matches: IMatches,
-    authorDate: Date | undefined
-  ) => {
+  private renderBranch = (item: IBranchListItem, matches: IMatches) => {
     return renderDefaultBranch(
       item,
       matches,
       this.props.currentBranch,
-      authorDate,
       this.onDropOntoBranch,
       this.onDropOntoCurrentBranch
     )
   }
 
-  private getBranchAriaLabel = (
-    item: IBranchListItem,
-    authorDate: Date | undefined
-  ): string => {
-    return getDefaultAriaLabelForBranch(item, authorDate)
+  private getBranchAriaLabel = (item: IBranchListItem): string => {
+    return getDefaultAriaLabelForBranch(item)
   }
 
   private renderSelectedTab() {

app/src/ui/multi-commit-operation/choose-branch/base-choose-branch-dialog.tsx

@@ -202,24 +202,12 @@ export class ChooseBranchDialog extends React.Component<
     return <div className="merge-status-component">{children}</div>
   }
 
-  private renderBranch = (
-    item: IBranchListItem,
-    matches: IMatches,
-    authorDate: Date | undefined
-  ) => {
-    return renderDefaultBranch(
-      item,
-      matches,
-      this.props.currentBranch,
-      authorDate
-    )
+  private renderBranch = (item: IBranchListItem, matches: IMatches) => {
+    return renderDefaultBranch(item, matches, this.props.currentBranch)
   }
 
-  private getBranchAriaLabel = (
-    item: IBranchListItem,
-    authorDate: Date | undefined
-  ): string => {
-    return getDefaultAriaLabelForBranch(item, authorDate)
+  private getBranchAriaLabel = (item: IBranchListItem): string => {
+    return getDefaultAriaLabelForBranch(item)
   }
 
   public render() {

app/src/ui/multi-commit-operation/choose-branch/choose-target-branch.tsx

@@ -95,24 +95,12 @@ export class ChooseTargetBranchDialog extends React.Component<
     this.setState({ selectedBranch })
   }
 
-  private renderBranch = (
-    item: IBranchListItem,
-    matches: IMatches,
-    authorDate: Date | undefined
-  ) => {
-    return renderDefaultBranch(
-      item,
-      matches,
-      this.props.currentBranch,
-      authorDate
-    )
+  private renderBranch = (item: IBranchListItem, matches: IMatches) => {
+    return renderDefaultBranch(item, matches, this.props.currentBranch)
   }
 
-  private getBranchAriaLabel = (
-    item: IBranchListItem,
-    authorDate: Date | undefined
-  ): string => {
-    return getDefaultAriaLabelForBranch(item, authorDate)
+  private getBranchAriaLabel = (item: IBranchListItem): string => {
+    return getDefaultAriaLabelForBranch(item)
   }
 
   private onEnterPressed = (branch: Branch, source: ClickSource) => {

app/test/unit/create-branch-test.ts

@@ -11,6 +11,7 @@ import {
 
 const stubTip: IBranchTip = {
   sha: 'deadbeef',
+  author: { date: new Date(0) },
 }
 
 const defaultBranch: Branch = {

app/test/unit/git/checkout-test.ts

@@ -29,7 +29,7 @@ describe('git/checkout', () => {
       isGone: false,
       upstreamWithoutRemote: null,
       type: BranchType.Local,
-      tip: { sha: '' },
+      tip: { sha: '', author: { date: new Date(0) } },
       remoteName: null,
       upstreamRemoteName: null,
       isDesktopForkRemoteBranch: false,