Returning EditCell in EditRows (#302)

Instead of returning DbCellValues inside an EditRow, we should be returning EditCells. This way we can preserve dirty state when scrolling.

src/Microsoft.SqlTools.ServiceLayer/EditData/Contracts/EditRow.cs

@@ -25,7 +25,7 @@ namespace Microsoft.SqlTools.ServiceLayer.EditData.Contracts
         /// The cells in the row. If the row has pending changes, they will be represented in
         /// this list
         /// </summary>
-        public DbCellValue[] Cells { get; set; }
+        public EditCell[] Cells { get; set; }
 
         /// <summary>
         /// Internal ID of the row. This should be used whenever referencing a row in row edit operations.

src/Microsoft.SqlTools.ServiceLayer/EditData/EditSession.cs

@@ -283,7 +283,7 @@ namespace Microsoft.SqlTools.ServiceLayer.EditData
                     EditRow er = new EditRow
                     {
                         Id = rowId,
-                        Cells = cachedRows.Rows[i],
+                        Cells = cachedRows.Rows[i].Select(cell => new EditCell(cell, false)).ToArray(),
                         State = EditRow.EditRowState.Clean
                     };
                     editRows.Add(er);

src/Microsoft.SqlTools.ServiceLayer/EditData/UpdateManagement/RowCreate.cs

@@ -130,9 +130,13 @@ namespace Microsoft.SqlTools.ServiceLayer.EditData.UpdateManagement
         public override EditRow GetEditRow(DbCellValue[] cachedRow)
         {
             // Iterate over the new cells. If they are null, generate a blank value
-            DbCellValue[] editCells = newCells.Select(cell => cell == null
+            EditCell[] editCells = newCells.Select(cell =>
-                    ? new DbCellValue {DisplayValue = string.Empty, IsNull = false, RawObject = null}
+                {
-                    : cell.AsDbCellValue)
+                    DbCellValue dbCell = cell == null
+                        ? new DbCellValue {DisplayValue = string.Empty, IsNull = false, RawObject = null}
+                        : cell.AsDbCellValue;
+                    return new EditCell(dbCell, true);
+                })
                 .ToArray();
             return new EditRow
             {

src/Microsoft.SqlTools.ServiceLayer/EditData/UpdateManagement/RowDelete.cs

@@ -6,6 +6,7 @@
 using System;
 using System.Data.Common;
 using System.Globalization;
+using System.Linq;
 using System.Threading.Tasks;
 using Microsoft.SqlTools.ServiceLayer.EditData.Contracts;
 using Microsoft.SqlTools.ServiceLayer.QueryExecution;
@@ -86,7 +87,7 @@ namespace Microsoft.SqlTools.ServiceLayer.EditData.UpdateManagement
             return new EditRow
             {
                 Id = RowId,
-                Cells = cachedRow,
+                Cells = cachedRow.Select(cell => new EditCell(cell, true)).ToArray(),
                 State = EditRow.EditRowState.DirtyDelete
             };
         }

src/Microsoft.SqlTools.ServiceLayer/EditData/UpdateManagement/RowUpdate.cs

@@ -122,16 +122,19 @@ namespace Microsoft.SqlTools.ServiceLayer.EditData.UpdateManagement
         {
             Validate.IsNotNull(nameof(cachedRow), cachedRow);
 
-            // For each cell that is pending update, replace the db cell value with a new one
+            // Treat all the cells as clean initially
+            EditCell[] editCells = cachedRow.Select(cell => new EditCell(cell, false)).ToArray();
+
+            // For each cell that is pending update, replace the db cell value with a dirty one
             foreach (var cellUpdate in cellUpdates)
             {
-                cachedRow[cellUpdate.Key] = cellUpdate.Value.AsDbCellValue;
+                editCells[cellUpdate.Key] = cellUpdate.Value.AsEditCell;
             }
 
             return new EditRow
             {
                 Id = RowId,
-                Cells = cachedRow,
+                Cells = editCells,
                 State = EditRow.EditRowState.DirtyUpdate
             };
         }

test/Microsoft.SqlTools.ServiceLayer.UnitTests/EditData/CellUpdateTests.cs

@@ -6,6 +6,7 @@
 using System;
 using System.Collections.Generic;
 using System.Data.Common;
+using Microsoft.SqlTools.ServiceLayer.EditData.Contracts;
 using Microsoft.SqlTools.ServiceLayer.EditData.UpdateManagement;
 using Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts;
 using Xunit;
@@ -243,6 +244,36 @@ namespace Microsoft.SqlTools.ServiceLayer.UnitTests.EditData
             Assert.Equal(isNull ? (object)DBNull.Value : value, dbc.RawObject);
         }
 
+        [Theory]
+        [InlineData(true)]
+        [InlineData(false)]
+        public void AsEditCellValue(bool isNull)
+        {
+            // Setup: Create a cell update
+            var value = isNull ? "NULL" : "foo";
+            var col = GetWrapper<string>("NTEXT");
+            CellUpdate cu = new CellUpdate(col, value);
+
+            // If: I convert the cell update to an EditCell
+            EditCell ec = cu.AsEditCell;
+
+            // Then:
+            // ... It should not be null
+            Assert.NotNull(ec);
+
+            // ... The display value should be the same as the value we supplied
+            Assert.Equal(value, ec.DisplayValue);
+
+            // ... The null-ness of the value should be the same as what we supplied
+            Assert.Equal(isNull, ec.IsNull);
+
+            // ... We don't care *too* much about the raw value, but we'll check it anyhow
+            Assert.Equal(isNull ? (object)DBNull.Value : value, ec.RawObject);
+
+            // ... The edit cell should be dirty
+            Assert.True(ec.IsDirty);
+        }
+
         private static DbColumnWrapper GetWrapper<T>(string dataTypeName, bool allowNull = true)
         {
             return new DbColumnWrapper(new CellUpdateTestDbColumn(typeof(T), dataTypeName, allowNull));

test/Microsoft.SqlTools.ServiceLayer.UnitTests/EditData/RowCreateTests.cs

@@ -12,7 +12,6 @@ using Microsoft.SqlTools.ServiceLayer.EditData;
 using Microsoft.SqlTools.ServiceLayer.EditData.Contracts;
 using Microsoft.SqlTools.ServiceLayer.EditData.UpdateManagement;
 using Microsoft.SqlTools.ServiceLayer.QueryExecution;
-using Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts;
 using Microsoft.SqlTools.ServiceLayer.Test.Common;
 using Microsoft.SqlTools.ServiceLayer.UnitTests.Utility;
 using Xunit;
@@ -199,12 +198,13 @@ namespace Microsoft.SqlTools.ServiceLayer.UnitTests.EditData
             Assert.True(er.IsDirty);
             Assert.Equal(EditRow.EditRowState.DirtyInsert, er.State);
 
-            // ... The row should have a bunch of empty cells (equal to number of columns)
+            // ... The row should have a bunch of empty cells (equal to number of columns) and all are dirty
             Assert.Equal(rc.newCells.Length, er.Cells.Length);
-            Assert.All(er.Cells, dbc =>
+            Assert.All(er.Cells, ec =>
             {
-                Assert.Equal(string.Empty, dbc.DisplayValue);
+                Assert.Equal(string.Empty, ec.DisplayValue);
-                Assert.False(dbc.IsNull);
+                Assert.False(ec.IsNull);
+                Assert.True(ec.IsDirty);
             });
         }
 
@@ -227,16 +227,18 @@ namespace Microsoft.SqlTools.ServiceLayer.UnitTests.EditData
             Assert.True(er.IsDirty);
             Assert.Equal(EditRow.EditRowState.DirtyInsert, er.State);
 
-            // ... The row should have a single non-empty cell at the beginning
+            // ... The row should have a single non-empty cell at the beginning that is dirty
             Assert.Equal("foo", er.Cells[0].DisplayValue);
             Assert.False(er.Cells[0].IsNull);
+            Assert.True(er.Cells[0].IsDirty);
 
-            // ... The rest of the cells should be blank
+            // ... The rest of the cells should be blank, but dirty
             for (int i = 1; i < er.Cells.Length; i++)
             {
-                DbCellValue dbc = er.Cells[i];
+                EditCell ec = er.Cells[i];
-                Assert.Equal(string.Empty, dbc.DisplayValue);
+                Assert.Equal(string.Empty, ec.DisplayValue);
-                Assert.False(dbc.IsNull);
+                Assert.False(ec.IsNull);
+                Assert.True(ec.IsDirty);
             }
         }
 

test/Microsoft.SqlTools.ServiceLayer.UnitTests/EditData/RowDeleteTests.cs

@@ -159,15 +159,16 @@ namespace Microsoft.SqlTools.ServiceLayer.UnitTests.EditData
             // ... The ID should be the same as the one provided
             Assert.Equal(0, er.Id);
 
-            // ... The row should match the cells that were given
+            // ... The row should match the cells that were given and should be dirty
             Assert.Equal(cells.Length, er.Cells.Length);
             for (int i = 0; i < cells.Length; i++)
             {
                 DbCellValue originalCell = cells[i];
-                DbCellValue outputCell = er.Cells[i];
+                EditCell outputCell = er.Cells[i];
 
                 Assert.Equal(originalCell.DisplayValue, outputCell.DisplayValue);
                 Assert.Equal(originalCell.IsNull, outputCell.IsNull);
+                Assert.True(outputCell.IsDirty);
                 // Note: No real need to check the RawObject property
             }
         }

test/Microsoft.SqlTools.ServiceLayer.UnitTests/EditData/RowUpdateTests.cs

@@ -331,10 +331,11 @@ namespace Microsoft.SqlTools.ServiceLayer.UnitTests.EditData
                 // Note: No real need to check the RawObject property
             }
 
-            // ... The updated cell should match what it was set to
+            // ... The updated cell should match what it was set to and be dirty
-            DbCellValue newCell = er.Cells[0];
+            EditCell newCell = er.Cells[0];
-            Assert.Equal(newCell.DisplayValue, "foo");
+            Assert.Equal("foo", newCell.DisplayValue);
-            Assert.Equal(newCell.IsNull, false);
+            Assert.False(newCell.IsNull);
+            Assert.True(newCell.IsDirty);
         }
 
         [Fact]

test/Microsoft.SqlTools.ServiceLayer.UnitTests/EditData/SessionTests.cs

@@ -780,6 +780,7 @@ namespace Microsoft.SqlTools.ServiceLayer.UnitTests.EditData
                 {
                     Assert.Equal(cachedRow[j].DisplayValue, er.Cells[j].DisplayValue);
                     Assert.Equal(cachedRow[j].IsNull, er.Cells[j].IsNull);
+                    Assert.False(er.Cells[j].IsDirty);
                 }
 
                 // ... Be clean, since we didn't apply any updates