Adds reset support to view & node refresh

eamodio · eamodio · commit c50bec867ac7 · 2018-12-21T01:41:13.000-05:00
diff --git a/src/views/compareView.ts b/src/views/compareView.ts
@@ -4,7 +4,7 @@ import { CompareViewConfig, configuration, ViewFilesLayout, ViewsConfig } from '
 import { CommandContext, setCommandContext, WorkspaceState } from '../constants';
 import { Container } from '../container';
 import { CompareNode, CompareResultsNode, NamedRef, ViewNode } from './nodes';
-import { RefreshReason, ViewBase } from './viewBase';
+import { ViewBase } from './viewBase';
 
 export class CompareView extends ViewBase<CompareNode> {
     constructor() {
@@ -24,7 +24,7 @@ export class CompareView extends ViewBase<CompareNode> {
     protected registerCommands() {
         void Container.viewCommands;
         commands.registerCommand(this.getQualifiedCommand('clear'), () => this.clear(), this);
-        commands.registerCommand(this.getQualifiedCommand('refresh'), () => this.refresh(), this);
+        commands.registerCommand(this.getQualifiedCommand('refresh'), () => this.refresh(true), this);
         commands.registerCommand(
             this.getQualifiedCommand('setFilesLayoutToAuto'),
             () => this.setFilesLayout(ViewFilesLayout.Auto),
@@ -66,7 +66,7 @@ export class CompareView extends ViewBase<CompareNode> {
         }
 
         if (!configuration.initializing(e) && this._root !== undefined) {
-            void this.refresh(RefreshReason.ConfigurationChanged);
+            void this.refresh(true);
         }
     }
 
diff --git a/src/views/fileHistoryView.ts b/src/views/fileHistoryView.ts
@@ -5,7 +5,7 @@ import { CommandContext, setCommandContext } from '../constants';
 import { Container } from '../container';
 import { GitUri } from '../git/gitUri';
 import { FileHistoryTrackerNode } from './nodes';
-import { RefreshReason, ViewBase } from './viewBase';
+import { ViewBase } from './viewBase';
 
 export class FileHistoryView extends ViewBase<FileHistoryTrackerNode> {
     constructor() {
@@ -22,7 +22,7 @@ export class FileHistoryView extends ViewBase<FileHistoryTrackerNode> {
 
     protected registerCommands() {
         void Container.viewCommands;
-        commands.registerCommand(this.getQualifiedCommand('refresh'), () => this.refresh(), this);
+        commands.registerCommand(this.getQualifiedCommand('refresh'), () => this.refresh(true), this);
         commands.registerCommand(this.getQualifiedCommand('changeBase'), () => this.changeBase(), this);
         commands.registerCommand(
             this.getQualifiedCommand('setEditorFollowingOn'),
@@ -65,7 +65,7 @@ export class FileHistoryView extends ViewBase<FileHistoryTrackerNode> {
         }
 
         if (!configuration.initializing(e) && this._root !== undefined) {
-            void this.refresh(RefreshReason.ConfigurationChanged);
+            void this.refresh(true);
         }
     }
 
diff --git a/src/views/lineHistoryView.ts b/src/views/lineHistoryView.ts
@@ -4,7 +4,7 @@ import { configuration, LineHistoryViewConfig, ViewsConfig } from '../configurat
 import { CommandContext, setCommandContext } from '../constants';
 import { Container } from '../container';
 import { LineHistoryTrackerNode } from './nodes';
-import { RefreshReason, ViewBase } from './viewBase';
+import { ViewBase } from './viewBase';
 
 export class LineHistoryView extends ViewBase<LineHistoryTrackerNode> {
     constructor() {
@@ -21,7 +21,7 @@ export class LineHistoryView extends ViewBase<LineHistoryTrackerNode> {
 
     protected registerCommands() {
         void Container.viewCommands;
-        commands.registerCommand(this.getQualifiedCommand('refresh'), () => this.refresh(), this);
+        commands.registerCommand(this.getQualifiedCommand('refresh'), () => this.refresh(true), this);
         commands.registerCommand(this.getQualifiedCommand('changeBase'), () => this.changeBase(), this);
         commands.registerCommand(
             this.getQualifiedCommand('setEditorFollowingOn'),
@@ -64,7 +64,7 @@ export class LineHistoryView extends ViewBase<LineHistoryTrackerNode> {
         }
 
         if (!configuration.initializing(e) && this._root !== undefined) {
-            void this.refresh(RefreshReason.ConfigurationChanged);
+            void this.refresh(true);
         }
     }
 
diff --git a/src/views/nodes/common.ts b/src/views/nodes/common.ts
@@ -166,7 +166,7 @@ export abstract class PagerNode extends ViewNode {
         return {
             title: 'Refresh',
             command: 'gitlens.views.refreshNode',
-            arguments: [this.parent, this._args]
+            arguments: [this.parent, false, this._args]
         } as Command;
     }
 }
diff --git a/src/views/nodes/fileHistoryTrackerNode.ts b/src/views/nodes/fileHistoryTrackerNode.ts
@@ -27,11 +27,11 @@ export class FileHistoryTrackerNode extends SubscribeableViewNode<FileHistoryVie
     }
 
     @debug()
-    resetChild() {
-        if (this._child !== undefined) {
-            this._child.dispose();
-            this._child = undefined;
-        }
+    private resetChild() {
+        if (this._child === undefined) return;
+
+        this._child.dispose();
+        this._child = undefined;
     }
 
     async getChildren(): Promise<ViewNode[]> {
@@ -84,7 +84,12 @@ export class FileHistoryTrackerNode extends SubscribeableViewNode<FileHistoryVie
 
     @gate()
     @debug()
-    async refresh() {
+    async refresh(reset: boolean = false) {
+        if (reset) {
+            this._uri = unknownGitUri;
+            this.resetChild();
+        }
+
         const editor = window.activeTextEditor;
         if (editor == null || !Container.git.isTrackable(editor.document.uri)) {
             if (
diff --git a/src/views/nodes/lineHistoryTrackerNode.ts b/src/views/nodes/lineHistoryTrackerNode.ts
@@ -28,11 +28,11 @@ export class LineHistoryTrackerNode extends SubscribeableViewNode<LineHistoryVie
     }
 
     @debug()
-    resetChild() {
-        if (this._child !== undefined) {
-            this._child.dispose();
-            this._child = undefined;
-        }
+    private resetChild() {
+        if (this._child === undefined) return;
+
+        this._child.dispose();
+        this._child = undefined;
     }
 
     async getChildren(): Promise<ViewNode[]> {
@@ -84,7 +84,13 @@ export class LineHistoryTrackerNode extends SubscribeableViewNode<LineHistoryVie
 
     @gate()
     @debug()
-    async refresh() {
+    async refresh(reset: boolean = false) {
+        if (reset) {
+            this._uri = unknownGitUri;
+            this._selection = undefined;
+            this.resetChild();
+        }
+
         const editor = window.activeTextEditor;
         if (editor == null || !Container.git.isTrackable(editor.document.uri)) {
             if (
diff --git a/src/views/nodes/repositoriesNode.ts b/src/views/nodes/repositoriesNode.ts
@@ -5,7 +5,6 @@ import { GitUri } from '../../git/gitService';
 import { Logger } from '../../logger';
 import { debug, Functions, gate } from '../../system';
 import { RepositoriesView } from '../repositoriesView';
-import { RefreshReason } from '../viewBase';
 import { MessageNode } from './common';
 import { RepositoryNode } from './repositoryNode';
 import { ResourceType, SubscribeableViewNode, unknownGitUri, ViewNode } from './viewNode';
@@ -20,14 +19,19 @@ export class RepositoriesNode extends SubscribeableViewNode<RepositoriesView> {
     dispose() {
         super.dispose();
 
-        if (this._children !== undefined) {
-            for (const child of this._children) {
-                if (child instanceof RepositoryNode) {
-                    child.dispose();
-                }
+        this.resetChildren();
+    }
+
+    @debug()
+    private resetChildren() {
+        if (this._children === undefined) return;
+
+        for (const child of this._children) {
+            if (child instanceof RepositoryNode) {
+                child.dispose();
             }
-            this._children = undefined;
         }
+        this._children = undefined;
     }
 
     async getChildren(): Promise<ViewNode[]> {
@@ -59,9 +63,17 @@ export class RepositoriesNode extends SubscribeableViewNode<RepositoriesView> {
 
     @gate()
     @debug()
-    async refresh(reason?: RefreshReason) {
+    async refresh(reset: boolean = false) {
         if (this._children === undefined) return;
 
+        if (reset) {
+            this.resetChildren();
+            await this.unsubscribe();
+            void this.ensureSubscription();
+
+            return;
+        }
+
         const repositories = await Container.git.getOrderedRepositories();
         if (repositories.length === 0 && (this._children === undefined || this._children.length === 0)) return;
 
@@ -93,11 +105,6 @@ export class RepositoriesNode extends SubscribeableViewNode<RepositoriesView> {
 
         this._children = children;
 
-        // Reset our subscription if the configuration changed
-        if (reason === RefreshReason.ConfigurationChanged) {
-            await this.unsubscribe();
-        }
-
         void this.ensureSubscription();
     }
 
diff --git a/src/views/nodes/viewNode.ts b/src/views/nodes/viewNode.ts
@@ -3,7 +3,7 @@ import { Command, Disposable, Event, TreeItem, TreeItemCollapsibleState, TreeVie
 import { GitUri } from '../../git/gitService';
 import { Logger } from '../../logger';
 import { debug, gate, logName } from '../../system';
-import { RefreshReason, TreeViewNodeStateChangeEvent, View } from '../viewBase';
+import { TreeViewNodeStateChangeEvent, View } from '../viewBase';
 
 export enum ResourceType {
     ActiveFileHistory = 'gitlens:history:active:file',
@@ -97,7 +97,7 @@ export abstract class ViewNode<TView extends View = View> {
 
     @gate()
     @debug()
-    refresh(reason?: RefreshReason): void | boolean | Promise<void> | Promise<boolean> {}
+    refresh(reset: boolean = false): void | boolean | Promise<void> | Promise<boolean> {}
 
     @gate()
     @debug()
diff --git a/src/views/repositoriesView.ts b/src/views/repositoriesView.ts
@@ -4,7 +4,7 @@ import { configuration, RepositoriesViewConfig, ViewFilesLayout, ViewsConfig } f
 import { CommandContext, setCommandContext, WorkspaceState } from '../constants';
 import { Container } from '../container';
 import { RepositoriesNode } from './nodes';
-import { RefreshReason, ViewBase } from './viewBase';
+import { ViewBase } from './viewBase';
 
 export class RepositoriesView extends ViewBase<RepositoriesNode> {
     constructor() {
@@ -27,7 +27,7 @@ export class RepositoriesView extends ViewBase<RepositoriesNode> {
     protected registerCommands() {
         void Container.viewCommands;
 
-        commands.registerCommand(this.getQualifiedCommand('refresh'), () => this.refresh(), this);
+        commands.registerCommand(this.getQualifiedCommand('refresh'), () => this.refresh(true), this);
         commands.registerCommand(
             this.getQualifiedCommand('setFilesLayoutToAuto'),
             () => this.setFilesLayout(ViewFilesLayout.Auto),
@@ -74,7 +74,7 @@ export class RepositoriesView extends ViewBase<RepositoriesNode> {
         }
 
         if (!configuration.initializing(e) && this._root !== undefined) {
-            void this.refresh(RefreshReason.ConfigurationChanged);
+            void this.refresh(true);
         }
     }
 
diff --git a/src/views/searchView.ts b/src/views/searchView.ts
@@ -6,7 +6,7 @@ import { Container } from '../container';
 import { GitLog, GitRepoSearchBy } from '../git/gitService';
 import { Functions, Strings } from '../system';
 import { SearchNode, SearchResultsCommitsNode, ViewNode } from './nodes';
-import { RefreshReason, ViewBase } from './viewBase';
+import { ViewBase } from './viewBase';
 
 interface SearchQueryResult {
     label: string;
@@ -31,7 +31,7 @@ export class SearchView extends ViewBase<SearchNode> {
     protected registerCommands() {
         void Container.viewCommands;
         commands.registerCommand(this.getQualifiedCommand('clear'), () => this.clear(), this);
-        commands.registerCommand(this.getQualifiedCommand('refresh'), () => this.refresh(), this);
+        commands.registerCommand(this.getQualifiedCommand('refresh'), () => this.refresh(true), this);
         commands.registerCommand(
             this.getQualifiedCommand('setFilesLayoutToAuto'),
             () => this.setFilesLayout(ViewFilesLayout.Auto),
@@ -69,7 +69,7 @@ export class SearchView extends ViewBase<SearchNode> {
         }
 
         if (!configuration.initializing(e) && this._root !== undefined) {
-            void this.refresh(RefreshReason.ConfigurationChanged);
+            void this.refresh(true);
         }
     }
 
diff --git a/src/views/viewBase.ts b/src/views/viewBase.ts
@@ -26,11 +26,6 @@ import { RepositoriesView } from './repositoriesView';
 import { SearchView } from './searchView';
 import { RefreshNodeCommandArgs } from './viewCommands';
 
-export enum RefreshReason {
-    ConfigurationChanged = 'ConfigurationChanged',
-    VisibilityChanged = 'VisibilityChanged'
-}
-
 export type View = RepositoriesView | FileHistoryView | LineHistoryView | CompareView | SearchView;
 
 export interface TreeViewNodeStateChangeEvent<T> extends TreeViewExpansionEvent<T> {
@@ -144,9 +139,9 @@ export abstract class ViewBase<TRoot extends ViewNode<View>> implements TreeData
     }
 
     @debug()
-    async refresh(reason?: RefreshReason) {
+    async refresh(reset: boolean = false) {
         if (this._root !== undefined) {
-            await this._root.refresh(reason);
+            await this._root.refresh(reset);
         }
 
         this.triggerNodeChange();
@@ -155,7 +150,7 @@ export abstract class ViewBase<TRoot extends ViewNode<View>> implements TreeData
     @debug({
         args: { 0: (n: ViewNode) => n.toString() }
     })
-    async refreshNode(node: ViewNode, args?: RefreshNodeCommandArgs) {
+    async refreshNode(node: ViewNode, reset: boolean = false, args?: RefreshNodeCommandArgs) {
         if (args !== undefined) {
             if (isPageable(node)) {
                 if (args.maxCount === undefined || args.maxCount === 0) {
@@ -167,7 +162,7 @@ export abstract class ViewBase<TRoot extends ViewNode<View>> implements TreeData
             }
         }
 
-        const cancel = await node.refresh();
+        const cancel = await node.refresh(reset);
         if (cancel === true) return;
 
         this.triggerNodeChange(node);
diff --git a/src/views/viewCommands.ts b/src/views/viewCommands.ts
@@ -52,7 +52,7 @@ export class ViewCommands implements Disposable {
     constructor() {
         commands.registerCommand(
             'gitlens.views.refreshNode',
-            (node: ViewNode, args?: RefreshNodeCommandArgs) => node.view.refreshNode(node, args),
+            (node: ViewNode, args?: RefreshNodeCommandArgs) => node.view.refreshNode(node, true, args),
             this
         );
         commands.registerCommand(

Original file line number	Diff line number	Diff line change
`@@ -166,7 +166,7 @@ export abstract class PagerNode extends ViewNode {`
`166`	`166`	`return {`
`167`	`167`	`title: 'Refresh',`
`168`	`168`	`command: 'gitlens.views.refreshNode',`
`169`		`- arguments: [this.parent, this._args]`
	`169`	`+ arguments: [this.parent, false, this._args]`
`170`	`170`	`} as Command;`
`171`	`171`	`}`
`172`	`172`	`}`