Adds progress indicator to stash quickpicks

Author: eamodio

CHANGELOG.md

@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [Unreleased]
+### Added
+- Adds progress indicator to the `Show Stashed Changes` command (`gitlens.showQuickStashList`)
+- Adds progress indicator to the `Apply Stashed Changes` command (`gitlens.stashApply`)
+
 ## [6.3.0] - 2017-11-30
 ### Added
 - Adds support for files with staged changes
@@ -21,7 +26,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 - Fixes [#217](https://github.com/eamodio/vscode-gitlens/issues/217) - empty editor has git lens in status bar with old information
 - Fixes [#218](https://github.com/eamodio/vscode-gitlens/issues/218) - Cannot read property 'replace' of undefined
 - Fixes issue with feedback when searching for commits without any matches
-- Fixes issue where quickpick progress indicators could get stuck
+- Fixes issue where quick pick menu progress indicators could get stuck
 
 ## [6.2.0] - 2017-11-27
 ### Added

src/commands/showQuickStashList.ts

@@ -24,13 +24,17 @@ export class ShowQuickStashListCommand extends ActiveEditorCachedCommand {
     async execute(editor?: TextEditor, uri?: Uri, args: ShowQuickStashListCommandArgs = {}) {
         uri = getCommandUri(uri, editor);
 
+        const progressCancellation = StashListQuickPick.showProgress('list');
+
         try {
             const repoPath = await this.git.getRepoPath(uri);
             if (!repoPath) return Messages.showNoRepositoryWarningMessage(`Unable to show stashed changes`);
 
             const stash = await this.git.getStashList(repoPath);
             if (stash === undefined) return window.showWarningMessage(`Unable to show stashed changes`);
 
+            if (progressCancellation.token.isCancellationRequested) return undefined;
+
             // Create a command to get back to here
             const currentCommand = new CommandQuickPickItem({
                 label: `go back ${GlyphChars.ArrowBack}`,
@@ -42,7 +46,7 @@ export class ShowQuickStashListCommand extends ActiveEditorCachedCommand {
                     } as ShowQuickStashListCommandArgs
                 ]);
 
-            const pick = await StashListQuickPick.show(this.git, stash, 'list', args.goBackCommand, currentCommand);
+            const pick = await StashListQuickPick.show(this.git, stash, 'list', progressCancellation, args.goBackCommand, currentCommand);
             if (pick === undefined) return undefined;
 
             if (pick instanceof CommandQuickPickItem) return pick.execute();
@@ -59,5 +63,8 @@ export class ShowQuickStashListCommand extends ActiveEditorCachedCommand {
             Logger.error(ex, 'ShowQuickStashListCommand');
             return window.showErrorMessage(`Unable to show stashed changes. See output channel for more details`);
         }
+        finally {
+            progressCancellation.dispose();
+        }
     }
 }

src/commands/stashApply.ts

@@ -35,6 +35,7 @@ export class StashApplyCommand extends Command {
 
     async execute(args: StashApplyCommandArgs = { confirm: true, deleteAfter: false }) {
         args = { ...args };
+
         if (args.stashItem === undefined || args.stashItem.stashName === undefined) {
             let goBackToRepositoriesCommand: CommandQuickPickItem | undefined;
 
@@ -52,20 +53,29 @@ export class StashApplyCommand extends Command {
                 repoPath = pick.repoPath;
             }
 
-            const stash = await this.git.getStashList(repoPath);
-            if (stash === undefined) return window.showInformationMessage(`There are no stashed changes`);
+            const progressCancellation = StashListQuickPick.showProgress('apply');
 
-            const currentCommand = new CommandQuickPickItem({
-                label: `go back ${GlyphChars.ArrowBack}`,
-                description: `${Strings.pad(GlyphChars.Dash, 2, 3)} to apply stashed changes`
-            }, Commands.StashApply, [args]);
+            try {
+                const stash = await this.git.getStashList(repoPath);
+                if (stash === undefined) return window.showInformationMessage(`There are no stashed changes`);
 
-            const pick = await StashListQuickPick.show(this.git, stash, 'apply', goBackToRepositoriesCommand || args.goBackCommand, currentCommand);
-            if (pick instanceof CommandQuickPickItem) return pick.execute();
-            if (pick === undefined) return args.goBackCommand === undefined ? undefined : args.goBackCommand.execute();
+                if (progressCancellation.token.isCancellationRequested) return undefined;
 
-            args.goBackCommand = currentCommand;
-            args.stashItem = pick.commit as GitStashCommit;
+                const currentCommand = new CommandQuickPickItem({
+                    label: `go back ${GlyphChars.ArrowBack}`,
+                    description: `${Strings.pad(GlyphChars.Dash, 2, 3)} to apply stashed changes`
+                }, Commands.StashApply, [args]);
+
+                const pick = await StashListQuickPick.show(this.git, stash, 'apply', progressCancellation, goBackToRepositoriesCommand || args.goBackCommand, currentCommand);
+                if (pick instanceof CommandQuickPickItem) return pick.execute();
+                if (pick === undefined) return args.goBackCommand === undefined ? undefined : args.goBackCommand.execute();
+
+                args.goBackCommand = currentCommand;
+                args.stashItem = pick.commit as GitStashCommit;
+            }
+            finally {
+                progressCancellation.dispose();
+            }
         }
 
         try {

src/quickPicks/stashList.ts

@@ -1,15 +1,27 @@
 'use strict';
 import { Iterables, Strings } from '../system';
-import { QuickPickOptions, window } from 'vscode';
+import { CancellationTokenSource, QuickPickOptions, window } from 'vscode';
 import { Commands, StashSaveCommandArgs } from '../commands';
 import { GlyphChars } from '../constants';
 import { GitService, GitStash } from '../gitService';
-import { Keyboard } from '../keyboard';
-import { CommandQuickPickItem, CommitQuickPickItem, getQuickPickIgnoreFocusOut } from '../quickPicks';
+import { Keyboard, KeyNoopCommand } from '../keyboard';
+import { CommandQuickPickItem, CommitQuickPickItem, getQuickPickIgnoreFocusOut, showQuickPickProgress } from '../quickPicks';
 
 export class StashListQuickPick {
 
-    static async show(git: GitService, stash: GitStash, mode: 'list' | 'apply', goBackCommand?: CommandQuickPickItem, currentCommand?: CommandQuickPickItem): Promise<CommitQuickPickItem | CommandQuickPickItem | undefined> {
+    static showProgress(mode: 'list' | 'apply') {
+        const message = mode === 'apply'
+            ? `Apply stashed changes to your working tree${GlyphChars.Ellipsis}`
+            : `stashed changes ${GlyphChars.Dash} search by message, filename, or commit id`;
+        return showQuickPickProgress(message,
+            {
+                left: KeyNoopCommand,
+                ',': KeyNoopCommand,
+                '.': KeyNoopCommand
+            });
+    }
+
+    static async show(git: GitService, stash: GitStash, mode: 'list' | 'apply', progressCancellation: CancellationTokenSource, goBackCommand?: CommandQuickPickItem, currentCommand?: CommandQuickPickItem): Promise<CommitQuickPickItem | CommandQuickPickItem | undefined> {
         const items = ((stash && Array.from(Iterables.map(stash.commits.values(), c => new CommitQuickPickItem(c)))) || []) as (CommitQuickPickItem | CommandQuickPickItem)[];
 
         if (mode === 'list') {
@@ -27,8 +39,12 @@ export class StashListQuickPick {
             items.splice(0, 0, goBackCommand);
         }
 
+        if (progressCancellation.token.isCancellationRequested) return undefined;
+
         const scope = await Keyboard.instance.beginScope({ left: goBackCommand });
 
+        progressCancellation.cancel();
+
         const pick = await window.showQuickPick(items, {
             matchOnDescription: true,
             placeHolder: mode === 'apply'