Add Saved status to workspace documents

Agent-Logs-Url: https://github.com/PowerShell/PowerShellEditorServices/sessions/3e87bc0c-ffcc-4ce4-9b08-22d248a3f5db

Co-authored-by: JustinGrote <15258962+JustinGrote@users.noreply.github.com>

Author: Copilot

src/PowerShellEditorServices/Extensions/EditorWorkspace.cs

@@ -10,10 +10,11 @@ public sealed class EditorWorkspaceDocument
     {
         private readonly EditorWorkspace _workspace;
 
-        internal EditorWorkspaceDocument(EditorWorkspace workspace, string path)
+        internal EditorWorkspaceDocument(EditorWorkspace workspace, string path, bool saved)
         {
             _workspace = workspace;
             Path = path;
+            Saved = saved;
         }
 
         /// <summary>
@@ -22,10 +23,19 @@ internal EditorWorkspaceDocument(EditorWorkspace workspace, string path)
         public string Path { get; }
 
         /// <summary>
-        /// Gets the full path of this document.
+        /// Gets whether the document has unsaved changes.
         /// </summary>
-        /// <returns>The full document path.</returns>
-        public override string ToString() => Path;
+        public bool Saved { get; }
+
+        /// <summary>
+        /// Gets the display name of this document and unsaved status.
+        /// </summary>
+        /// <returns>The display name of this document.</returns>
+        public override string ToString()
+        {
+            string fileName = System.IO.Path.GetFileName(Path);
+            return Saved ? fileName : fileName + " [Unsaved]";
+        }
 
         /// <summary>
         /// Opens this document in the editor.
@@ -75,11 +85,11 @@ public EditorWorkspaceDocument[] Documents
         {
             get
             {
-                string[] openDocumentPaths = editorOperations.GetWorkspaceOpenDocumentPaths();
-                EditorWorkspaceDocument[] documents = new EditorWorkspaceDocument[openDocumentPaths.Length];
-                for (int i = 0; i < openDocumentPaths.Length; i++)
+                WorkspaceOpenDocument[] openDocuments = editorOperations.GetWorkspaceOpenDocuments();
+                EditorWorkspaceDocument[] documents = new EditorWorkspaceDocument[openDocuments.Length];
+                for (int i = 0; i < openDocuments.Length; i++)
                 {
-                    documents[i] = new EditorWorkspaceDocument(this, openDocumentPaths[i]);
+                    documents[i] = new EditorWorkspaceDocument(this, openDocuments[i].Path, openDocuments[i].Saved);
                 }
 
                 return documents;

src/PowerShellEditorServices/Extensions/IEditorOperations.cs

@@ -6,6 +6,19 @@
 
 namespace Microsoft.PowerShell.EditorServices.Extensions
 {
+    internal readonly struct WorkspaceOpenDocument
+    {
+        internal WorkspaceOpenDocument(string path, bool saved)
+        {
+            Path = path;
+            Saved = saved;
+        }
+
+        public string Path { get; }
+
+        public bool Saved { get; }
+    }
+
     /// <summary>
     /// Provides an interface that must be implemented by an editor
     /// host to perform operations invoked by extensions written in
@@ -33,10 +46,10 @@ internal interface IEditorOperations
         string[] GetWorkspacePaths();
 
         /// <summary>
-        /// Get all open document paths in the current workspace session.
+        /// Get all open documents in the current workspace session.
         /// </summary>
-        /// <returns>All currently open document paths.</returns>
-        string[] GetWorkspaceOpenDocumentPaths();
+        /// <returns>All currently open documents.</returns>
+        WorkspaceOpenDocument[] GetWorkspaceOpenDocuments();
 
         /// <summary>
         /// Resolves the given file path relative to the current workspace path.

src/PowerShellEditorServices/Services/Extension/EditorOperationsService.cs

@@ -198,7 +198,10 @@ public async Task SaveFileAsync(string currentPath, string newSavePath)
 
         public string[] GetWorkspacePaths() => _workspaceService.WorkspacePaths.ToArray();
 
-        public string[] GetWorkspaceOpenDocumentPaths() => _workspaceService.GetOpenedFiles().Select(static scriptFile => scriptFile.FilePath).ToArray();
+        public WorkspaceOpenDocument[] GetWorkspaceOpenDocuments()
+            => _workspaceService.GetOpenedFiles()
+                .Select(static scriptFile => new WorkspaceOpenDocument(scriptFile.FilePath, scriptFile.IsSaved))
+                .ToArray();
 
         public string GetWorkspaceRelativePath(ScriptFile scriptFile) => _workspaceService.GetRelativePath(scriptFile);
 

src/PowerShellEditorServices/Services/TextDocument/Handlers/TextDocumentHandler.cs

@@ -136,6 +136,8 @@ public override async Task<Unit> Handle(DidSaveTextDocumentParams notification,
                 {
                     await _remoteFileManagerService.SaveRemoteFileAsync(savedFile.FilePath).ConfigureAwait(false);
                 }
+
+                savedFile.IsSaved = true;
             }
             return Unit.Value;
         }

src/PowerShellEditorServices/Services/TextDocument/ScriptFile.cs

@@ -55,6 +55,11 @@ internal sealed class ScriptFile
         /// </summary>
         public bool IsInMemory { get; }
 
+        /// <summary>
+        /// Gets or sets whether this file has no unsaved changes.
+        /// </summary>
+        public bool IsSaved { get; internal set; }
+
         /// <summary>
         /// Gets a string containing the full contents of the file.
         /// </summary>
@@ -137,6 +142,7 @@ internal ScriptFile(
 
             // SetFileContents() calls ParseFileContents() which initializes the rest of the properties.
             SetFileContents(textReader.ReadToEnd());
+            IsSaved = !IsInMemory;
             References = new ReferenceTable(this);
         }
 
@@ -364,6 +370,7 @@ public void ApplyChange(FileChange fileChange)
 
             // Parse the script again to be up-to-date
             ParseFileContents();
+            IsSaved = false;
             References.TagAsChanged();
         }
 

test/PowerShellEditorServices.Test/Extensions/EditorWorkspaceTests.cs

@@ -18,7 +18,11 @@ public void DocumentsReturnsOpenWorkspaceDocuments()
         {
             TestEditorOperations editorOperations = new()
             {
-                OpenDocumentPaths = new[] { @"C:\test\one.ps1", @"C:\test\two.ps1" }
+                OpenDocuments = new[]
+                {
+                    new WorkspaceOpenDocument(@"C:\test\one.ps1", saved: true),
+                    new WorkspaceOpenDocument(@"C:\test\two.ps1", saved: true)
+                }
             };
 
             EditorWorkspace workspace = new(editorOperations);
@@ -27,8 +31,16 @@ public void DocumentsReturnsOpenWorkspaceDocuments()
 
             Assert.Collection(
                 documents,
-                document => Assert.Equal(@"C:\test\one.ps1", document.Path),
-                document => Assert.Equal(@"C:\test\two.ps1", document.Path));
+                document =>
+                {
+                    Assert.Equal(@"C:\test\one.ps1", document.Path);
+                    Assert.True(document.Saved);
+                },
+                document =>
+                {
+                    Assert.Equal(@"C:\test\two.ps1", document.Path);
+                    Assert.True(document.Saved);
+                });
         }
 
         [Fact]
@@ -37,7 +49,7 @@ public void DocumentOpenSaveAndCloseUseWorkspaceOperations()
             const string filePath = @"C:\test\file.ps1";
             TestEditorOperations editorOperations = new()
             {
-                OpenDocumentPaths = new[] { filePath }
+                OpenDocuments = new[] { new WorkspaceOpenDocument(filePath, saved: true) }
             };
 
             EditorWorkspace workspace = new(editorOperations);
@@ -55,23 +67,52 @@ public void DocumentOpenSaveAndCloseUseWorkspaceOperations()
         }
 
         [Fact]
-        public void DocumentToStringReturnsDocumentPath()
+        public void DocumentToStringReturnsFileNameAndSavedStatus()
         {
-            const string filePath = @"C:\test\file.ps1";
+            const string savedFilePath = @"C:\test\file.ps1";
+            const string unsavedFilePath = @"C:\test\other.ps1";
             TestEditorOperations editorOperations = new()
             {
-                OpenDocumentPaths = new[] { filePath }
+                OpenDocuments = new[]
+                {
+                    new WorkspaceOpenDocument(savedFilePath, saved: true),
+                    new WorkspaceOpenDocument(unsavedFilePath, saved: false)
+                }
             };
 
             EditorWorkspace workspace = new(editorOperations);
-            EditorWorkspaceDocument document = Assert.Single(workspace.Documents);
+            EditorWorkspaceDocument[] documents = workspace.Documents;
+
+            Assert.Collection(
+                documents,
+                document => Assert.Equal("file.ps1", document.ToString()),
+                document => Assert.Equal("other.ps1 [Unsaved]", document.ToString()));
+        }
+
+        [Fact]
+        public void DocumentSavedReturnsWorkspaceSavedState()
+        {
+            TestEditorOperations editorOperations = new()
+            {
+                OpenDocuments = new[]
+                {
+                    new WorkspaceOpenDocument(@"C:\test\saved.ps1", saved: true),
+                    new WorkspaceOpenDocument(@"C:\test\unsaved.ps1", saved: false)
+                }
+            };
 
-            Assert.Equal(filePath, document.ToString());
+            EditorWorkspace workspace = new(editorOperations);
+            EditorWorkspaceDocument[] documents = workspace.Documents;
+
+            Assert.Collection(
+                documents,
+                document => Assert.True(document.Saved),
+                document => Assert.False(document.Saved));
         }
 
         private sealed class TestEditorOperations : IEditorOperations
         {
-            public string[] OpenDocumentPaths { get; set; } = Array.Empty<string>();
+            public WorkspaceOpenDocument[] OpenDocuments { get; set; } = Array.Empty<WorkspaceOpenDocument>();
 
             public List<string> Calls { get; } = new();
 
@@ -81,7 +122,7 @@ private sealed class TestEditorOperations : IEditorOperations
 
             public string[] GetWorkspacePaths() => new[] { @"C:\test" };
 
-            public string[] GetWorkspaceOpenDocumentPaths() => OpenDocumentPaths;
+            public WorkspaceOpenDocument[] GetWorkspaceOpenDocuments() => OpenDocuments;
 
             public string GetWorkspaceRelativePath(ScriptFile scriptFile) => scriptFile.FilePath;