Add history to Edit Code window (#380)

This PR adds support for historical entries in the Edit Code window.
Entries are stored in the `./.vs/Cody.EditCode.History.json` file. A
maximum of 40 recent prompts are retained. You can navigate between
prompts using the `Alt+Up/Down` keyboard shortcuts.
## Test plan
1. Open the solution in VS
2. From the editor's pop-up menu, select Cody -> Edit Code
3. Enter the prompt and confirm it
4. Reopen the Edit Code window
5. Use the `Alt+Up` keyboard shortcut to replay the last used prompt
<!-- REQUIRED; info at
https://docs-legacy.sourcegraph.com/dev/background-information/testing_principles
-->

---------

Co-authored-by: Tomasz Gołębiowski <tgolebiowski@virtuslab.com>

Author: tomaszgolebiowski

src/Cody.Core/Cody.Core.csproj

@@ -130,6 +130,7 @@
     <Compile Include="Infrastructure\ISecretStorageService.cs" />
     <Compile Include="Infrastructure\IProgressService.cs" />
     <Compile Include="Infrastructure\IToastNotificationService.cs" />
+    <Compile Include="Infrastructure\IVsFolderStoreService.cs" />
     <Compile Include="Logging\ISentryLog.cs" />
     <Compile Include="Logging\ITestLogger.cs" />
     <Compile Include="Logging\SentryLog.cs" />

src/Cody.Core/Infrastructure/IVsFolderStoreService.cs

@@ -0,0 +1,14 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace Cody.Core.Infrastructure
+{
+    public interface IVsFolderStoreService
+    {
+        bool SaveData(string fileName, object data);
+        T LoadData<T>(string fileName) where T : class;
+    }
+}

src/Cody.UI/ViewModels/EditCodeViewModel.cs

@@ -11,7 +11,10 @@ namespace Cody.UI.ViewModels
 {
     public class EditCodeViewModel : NotifyPropertyChangedBase
     {
-        public EditCodeViewModel(IEnumerable<Model> models, string selectedModelId, string instruction)
+        private List<string> instructionsHistory;
+        private int currentHistoryItem;
+
+        public EditCodeViewModel(IEnumerable<Model> models, string selectedModelId, string instruction, List<string> instructionsHistory)
         {
             var collection = new ObservableCollection<Model>(models);
             var modelsSource = new CollectionViewSource();
@@ -21,6 +24,9 @@ public EditCodeViewModel(IEnumerable<Model> models, string selectedModelId, stri
             Models = modelsSource;
 
             SelectedModel = collection.FirstOrDefault(x => x.Id == selectedModelId);
+
+            this.instructionsHistory = instructionsHistory;
+            currentHistoryItem = instructionsHistory.Count;
             Instruction = instruction;
         }
 
@@ -41,10 +47,40 @@ public string Instruction
             {
                 SetProperty(ref instruction, value);
                 OnNotifyPropertyChanged(nameof(EditButtonIsEnabled));
+                currentHistoryItem = instructionsHistory.Count;
             }
         }
 
         public bool EditButtonIsEnabled => !string.IsNullOrWhiteSpace(instruction);
+
+        private DelegateCommand historyUpCommand;
+        public DelegateCommand HistoryUpCommand => historyUpCommand = historyUpCommand ?? new DelegateCommand(OnHistoryUp);
+
+        private DelegateCommand historyDownCommand;
+        public DelegateCommand HistoryDownCommand => historyDownCommand = historyDownCommand ?? new DelegateCommand(OnHistoryDown);
+
+        private void OnHistoryUp()
+        {
+            if (currentHistoryItem - 1 >= 0)
+            {
+                currentHistoryItem--;
+                SetProperty(ref instruction, instructionsHistory[currentHistoryItem], nameof(Instruction));
+                OnNotifyPropertyChanged(nameof(EditButtonIsEnabled));
+            }
+        }
+
+        private void OnHistoryDown()
+        {
+            if (currentHistoryItem + 1 <= instructionsHistory.Count)
+            {
+                currentHistoryItem++;
+                var inst = string.Empty;
+                if (currentHistoryItem != instructionsHistory.Count) inst = instructionsHistory[currentHistoryItem];
+
+                SetProperty(ref instruction, inst, nameof(Instruction));
+                OnNotifyPropertyChanged(nameof(EditButtonIsEnabled));
+            }
+        }
     }
 
     public class Model

src/Cody.UI/Views/EditCodeView.xaml

@@ -1,6 +1,6 @@
 <platformui:DialogWindow        
         xmlns:platformui="clr-namespace:Microsoft.VisualStudio.PlatformUI;assembly=Microsoft.VisualStudio.Shell.15.0"        
-        xmlns:theme="clr-namespace:Community.VisualStudio.Toolkit"        
+        xmlns:theme="clr-namespace:Community.VisualStudio.Toolkit"
         xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"        
         xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"        
         x:Class="Cody.UI.Views.EditCodeView"        
@@ -14,6 +14,10 @@
         ShowInTaskbar="False"        
         theme:Themes.UseVsTheme="True"        
         FocusManager.FocusedElement="{Binding ElementName=InputTextBox}">
+    <Window.InputBindings>
+        <KeyBinding Command="{Binding HistoryUpCommand}" Gesture="ALT+UP" />
+        <KeyBinding Command="{Binding HistoryDownCommand}" Gesture="ALT+DOWN" />
+    </Window.InputBindings>
     <Grid>
         <Grid.RowDefinitions>
             <RowDefinition Height="*"/>
@@ -35,7 +39,7 @@
                    />
             <TextBox Grid.Row="1"
                      x:Name="InputTextBox"                     
-                     Text="{Binding Instruction, UpdateSourceTrigger=PropertyChanged}"                     
+                     Text="{Binding Instruction, UpdateSourceTrigger=PropertyChanged}"                  
                      TextWrapping="Wrap"                     
                      VerticalScrollBarVisibility="Auto"
                      Margin="0,0,0,12"/>
@@ -59,25 +63,37 @@
             </ComboBox>
         </Grid>
         <!-- Button Area -->
-        <StackPanel Grid.Row="1"                     
-                     Orientation="Horizontal"                     
-                     HorizontalAlignment="Right"                     
-                     Margin="12">
-            <Button x:Name="EditButton"                    
-                    IsDefault="True"                    
-                    Content="Edit Code"                     
-                    Width="75"                     
-                    Height="23"                     
-                    Margin="0,0,6,0"                    
-                    IsEnabled="{Binding EditButtonIsEnabled}"                    
-                    Click="OnEditCodeClick"                    
-                    />
-            <Button x:Name="CancelButton"                     
-                    Content="Cancel"                    
-                    IsCancel="True"                    
-                    Width="75"                     
-                    Height="23"                    
-                    />
-        </StackPanel>
+        <Grid Grid.Row="1" Margin="12">
+            <Grid.ColumnDefinitions>
+                <ColumnDefinition Width="*"/>
+                <ColumnDefinition Width="Auto"/>
+                <ColumnDefinition Width="Auto"/>
+            </Grid.ColumnDefinitions>
+
+            <TextBlock Grid.Column="0" 
+               Text="Alt+🡡🡣 for history" 
+               Foreground="Gray"
+               VerticalAlignment="Center">
+            </TextBlock>
+
+            <Button Grid.Column="1"
+            x:Name="EditButton"
+            IsDefault="True"
+            Content="Edit Code"
+            Width="75"
+            Height="23"
+            Margin="0,0,6,0"
+            IsEnabled="{Binding EditButtonIsEnabled}"
+            Click="OnEditCodeClick"
+            />
+
+            <Button Grid.Column="2"
+            x:Name="CancelButton"
+            Content="Cancel"
+            IsCancel="True"
+            Width="75"
+            Height="23"
+            />
+        </Grid>
     </Grid>
 </platformui:DialogWindow>

src/Cody.VisualStudio/Cody.VisualStudio.csproj

@@ -80,6 +80,7 @@
     <Compile Include="Services\StatusbarService.cs" />
     <Compile Include="Services\ToastNotificationService.cs" />
     <Compile Include="Services\UserSettingsProvider.cs" />
+    <Compile Include="Services\VsFolderStoreService.cs" />
     <Compile Include="Services\VsVersionService.cs" />
     <Compile Include="Utilities\FilePathHelper.cs" />
     <Compile Include="Utilities\UIHelper.cs" />

src/Cody.VisualStudio/CodyPackage.cs

@@ -71,6 +71,7 @@ public sealed partial class CodyPackage : AsyncPackage
         public IFileDialogService FileDialogService;
         public IEditCodeService EditCodeService;
         public IToastNotificationService ToastNotificationService;
+        public IVsFolderStoreService VsFolderStoreService;
 
         private IInfobarNotifications InfobarNotifications;
 
@@ -193,10 +194,11 @@ private void InitializeServices(LoggerFactory loggerFactory)
 
             var runningDocumentTable = this.GetService<SVsRunningDocumentTable, IVsRunningDocumentTable>();
 
-
             VsUIShell = this.GetService<SVsUIShell, IVsUIShell>();
             FileDialogService = new FileDialogService(SolutionService, Logger);
-            EditCodeService = new EditCodeService();
+            VsFolderStoreService = new VsFolderStoreService(vsSolution, Logger);
+            EditCodeService = new EditCodeService(VsFolderStoreService);
+
 
             ProgressNotificationHandlers = new ProgressNotificationHandlers(ProgressService);
             TextDocumentNotificationHandlers = new TextDocumentNotificationHandlers(DocumentService, FileDialogService, StatusbarService, Logger);

src/Cody.VisualStudio/Services/EditCodeService.cs

@@ -12,19 +12,41 @@ namespace Cody.VisualStudio.Services
 {
     public class EditCodeService : IEditCodeService
     {
+        private readonly IVsFolderStoreService vsFolderStoreService;
+        private List<string> instructionsHistory;
+
+        private const string InstructionsHistoryFile = "Cody.EditCode.History.json";
+        private const int MaxHistoryItems = 40;
+
+        public EditCodeService(IVsFolderStoreService vsFolderStoreService)
+        {
+            this.vsFolderStoreService = vsFolderStoreService;
+        }
+
         public EditCodeResult ShowEditCodeDialog(IEnumerable<EditModel> models, string defaultModelId, string instruction)
         {
+            if (instructionsHistory == null)
+            {
+                var historyFromFile = vsFolderStoreService.LoadData<List<string>>(InstructionsHistoryFile);
+                instructionsHistory = historyFromFile ?? new List<string>();
+            }
+
             var result = ThreadHelper.JoinableTaskFactory.Run(async delegate
             {
                 await ThreadHelper.JoinableTaskFactory.SwitchToMainThreadAsync();
 
                 var vm = new EditCodeViewModel(models.Select(x => new Model { Id = x.Id, Name = x.Name, Provider = x.Provider }),
-                    defaultModelId, instruction);
+                    defaultModelId, instruction, instructionsHistory);
                 var window = new EditCodeView();
 
                 window.DataContext = vm;
                 if (window.ShowModal() == true)
                 {
+                    if (!string.IsNullOrWhiteSpace(vm.Instruction) && instructionsHistory.LastOrDefault() != vm.Instruction)
+                    {
+                        SaveInstructionInHistory(vm.Instruction);
+                    }
+
                     return new EditCodeResult { Instruction = vm.Instruction, ModelId = vm.SelectedModel.Id };
                 }
 
@@ -33,6 +55,15 @@ public EditCodeResult ShowEditCodeDialog(IEnumerable<EditModel> models, string d
 
             return result;
         }
+
+        private void SaveInstructionInHistory(string instruction)
+        {
+            instructionsHistory.Add(instruction);
+            var itemsToRemove = instructionsHistory.Count - MaxHistoryItems;
+            if (itemsToRemove > 0) instructionsHistory.RemoveRange(0, itemsToRemove);
+
+            vsFolderStoreService.SaveData(InstructionsHistoryFile, instructionsHistory);
+        }
     }
 
 

src/Cody.VisualStudio/Services/VsFolderStoreService.cs

@@ -0,0 +1,80 @@
+using Cody.Core.Infrastructure;
+using Cody.Core.Logging;
+using Microsoft.VisualStudio.Shell.Interop;
+using Newtonsoft.Json;
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace Cody.VisualStudio.Services
+{
+    public class VsFolderStoreService : IVsFolderStoreService
+    {
+        private readonly IVsSolution vsSolution;
+        private readonly ILog logger;
+
+        public VsFolderStoreService(IVsSolution vsSolution, ILog logger)
+        {
+            this.vsSolution = vsSolution;
+            this.logger = logger;
+        }
+
+        private string GetVsFolder()
+        {
+            vsSolution.GetProperty((int)__VSPROPID.VSPROPID_SolutionDirectory, out object value);
+
+            if (value == null) return null;
+
+            return Path.Combine((string)value, ".vs");
+        }
+
+        public bool SaveData(string fileName, object data)
+        {
+            try
+            {
+                var path = GetVsFolder();
+                if (path == null) return false;
+                var json = JsonConvert.SerializeObject(data);
+                var filePath = Path.Combine(path, fileName);
+                File.WriteAllText(filePath, json);
+
+                return true;
+            }
+            catch (Exception ex)
+            {
+                logger.Error("Can't save data in .vs folder", ex);
+            }
+
+            return false;
+
+        }
+
+        public T LoadData<T>(string fileName) where T : class
+        {
+            try
+            {
+                var path = GetVsFolder();
+                if (path == null) return null;
+                var filePath = Path.Combine(path, fileName);
+                if (File.Exists(filePath))
+                {
+                    var json = File.ReadAllText(filePath);
+                    var obj = JsonConvert.DeserializeObject<T>(json);
+
+                    return obj;
+                }
+
+                logger.Info($"File '{filePath}' does not exist");
+            }
+            catch (Exception ex)
+            {
+                logger.Error("Can't load data from .vs folder", ex);
+            }
+
+            return null;
+        }
+    }
+}