ckaczor/sqltoolsservice
1
0
Fork 0
mirror of https://github.com/ckaczor/sqltoolsservice.git synced 2026-01-28 01:25:44 -05:00
Code Issues Packages Projects Releases Wiki Activity

use path to identify edit target (#1292)

Browse Source 
* use path to identify edit target

* async action

* revert RequestContext change

* comments

* address comments

* fix test
This commit is contained in:
Alan Ren
2021-11-10 17:39:48 -08:00
committed by GitHub
parent c738e3bdf7
commit a3c69f3dd2
14 changed files with 528 additions and 173 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
src/Microsoft.SqlTools.ServiceLayer/TableDesigner/Constants.cs
View File

@@ -3,12 +3,6 @@
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
//
using System;
using System.Threading.Tasks;
using Microsoft.SqlTools.Hosting.Protocol;
using Microsoft.SqlTools.ServiceLayer.Hosting;
using Microsoft.SqlTools.ServiceLayer.TableDesigner.Contracts;
namespace Microsoft.SqlTools.ServiceLayer.TableDesigner
{
public static class TablePropertyNames
@@ -29,5 +23,8 @@ namespace Microsoft.SqlTools.ServiceLayer.TableDesigner
public const string IsPrimaryKey = "isPrimaryKey";
public const string Precision = "precision";
public const string Scale = "scale";
public const string IsIdentity = "isIdentity";
public const string IdentityIncrement = "identityIncrement";
public const string IdentitySeed = "identitySeed";
}
}

24
src/Microsoft.SqlTools.ServiceLayer/TableDesigner/Contracts/DesignerDataPropertyInfo.cs
View File

@@ -3,6 +3,10 @@
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
//
using System.Runtime.Serialization;
using Newtonsoft.Json;
using Newtonsoft.Json.Converters;
namespace Microsoft.SqlTools.ServiceLayer.TableDesigner.Contracts
{
/// <summary>
@@ -23,17 +27,35 @@ namespace Microsoft.SqlTools.ServiceLayer.TableDesigner.Contracts
/// <summary>
/// The component type of the property
/// </summary>
public string ComponentType { get; set; }
public DesignerComponentType ComponentType { get; set; }
/// <summary>
/// The name of the group the property will be placed in whe displayed in
/// </summary>
public string Group { get; set; }
/// <summary>
/// The name of the group the property will be placed in whe displayed in
/// </summary>
public bool ShowInPropertiesView { get; set; }
/// <summary>
/// The properties of component
/// </summary>
public ComponentPropertiesBase ComponentProperties { get; set; }
}
[JsonConverter(typeof(StringEnumConverter))]
public enum DesignerComponentType
{
[EnumMember(Value = "checkbox")]
Checkbox,
[EnumMember(Value = "dropdown")]
Dropdown,
[EnumMember(Value = "input")]
Input,
[EnumMember(Value = "table")]
Table
}
}

35
src/Microsoft.SqlTools.ServiceLayer/TableDesigner/Contracts/TableChangeInfo.cs
View File

@@ -28,41 +28,8 @@ namespace Microsoft.SqlTools.ServiceLayer.TableDesigner.Contracts
{
public DesignerEditType Type { get; set; }
[JsonConverter(typeof(TableDesignerPropertyConverter))]
public object Property { get; set; }
public object[] Path { get; set; }
public object Value { get; set; }
}
/// <summary>
/// The property "Property" of <c>TableDesignerChangeInfo</c> could be string or <c>TableDesignerPropertyIdentifier</c>, use this custom converter to set the property value.
/// </summary>
public class TableDesignerPropertyConverter : JsonConverter
{
public override bool CanConvert(Type objectType)
{
return true;
}
public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
{
object property;
if (reader.TokenType == JsonToken.StartObject)
{
TableDesignerPropertyIdentifier obj = serializer.Deserialize(reader, typeof(TableDesignerPropertyIdentifier)) as TableDesignerPropertyIdentifier;
property = obj;
}
else
{
property = reader.Value;
}
return property;
}
public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
{
// We don't need to serialize this class.
throw new NotImplementedException();
}
}
}

19
src/Microsoft.SqlTools.ServiceLayer/TableDesigner/Contracts/TableDesignerPropertyIdentifier.cs
View File

@@ -1,19 +0,0 @@
//
// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
//
namespace Microsoft.SqlTools.ServiceLayer.TableDesigner.Contracts
{
/// <summary>
/// The information that can identify a property in a collection.
/// </summary>
public class TableDesignerPropertyIdentifier
{
public string ParentProperty { get; set; }
public int Index { get; set; }
public string Property { get; set; }
}
}

12
src/Microsoft.SqlTools.ServiceLayer/TableDesigner/Contracts/TableDesignerView.cs
View File

@@ -3,6 +3,8 @@
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
//
using System.Collections.Generic;
namespace Microsoft.SqlTools.ServiceLayer.TableDesigner.Contracts
{
/// <summary>
@@ -11,8 +13,14 @@ namespace Microsoft.SqlTools.ServiceLayer.TableDesigner.Contracts
/// </summary>
public class TableDesignerView
{
public DesignerDataPropertyInfo[] AdditionalTableProperties { get; set; }
public List<DesignerDataPropertyInfo> AdditionalTableProperties { get; set; } = new List<DesignerDataPropertyInfo>();
public DesignerDataPropertyInfo[] AdditionalTableColumnProperties { get; set; }
public List<DesignerDataPropertyInfo> AdditionalTableColumnProperties { get; set; } = new List<DesignerDataPropertyInfo>();
public List<string> ColumnsTableProperties { get; set; } = new List<string>();
public bool CanAddColumns { get; set; }
public bool CanRemoveColumns { get; set; }
}
}

6
src/Microsoft.SqlTools.ServiceLayer/TableDesigner/Contracts/ViewModel/TableColumnViewModel.cs
View File

@@ -25,5 +25,11 @@ namespace Microsoft.SqlTools.ServiceLayer.TableDesigner.Contracts
public InputBoxProperties DefaultValue { get; set; } = new InputBoxProperties();
public CheckBoxProperties IsPrimaryKey { get; set; } = new CheckBoxProperties();
public CheckBoxProperties IsIdentity { get; set; } = new CheckBoxProperties();
public InputBoxProperties IdentitySeed { get; set; } = new InputBoxProperties();
public InputBoxProperties IdentityIncrement { get; set; } = new InputBoxProperties();
}
}

80
src/Microsoft.SqlTools.ServiceLayer/TableDesigner/DesignerPathUtils.cs Normal file
View File

@@ -0,0 +1,80 @@
//
// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
//
using System;
using System.Collections;
using System.Linq;
using Microsoft.SqlTools.ServiceLayer.TableDesigner.Contracts;
namespace Microsoft.SqlTools.ServiceLayer.TableDesigner
{
public static class DesignerPathUtils
{
///<summary>
/// validate the path in the table designer change information.
/// Below are the 3 scenarios and their expected path.
/// Note: 'index-{x}' in the description below are numbers represent the index of the object in the list.
/// 1. 'Add' scenario
/// a. ['propertyName1']. Example: add a column to the columns property: ['columns'].
/// b. ['propertyName1',index-1,'propertyName2']. Example: add a column mapping to the first foreign key: ['foreignKeys',0,'mappings'].
/// 2. 'Update' scenario
/// a. ['propertyName1']. Example: update the name of the table: ['name'].
/// b. ['propertyName1',index-1,'propertyName2']. Example: update the name of a column: ['columns',0,'name'].
/// c. ['propertyName1',index-1,'propertyName2',index-2,'propertyName3']. Example: update the source column of an entry in a foreign key's column mapping table: ['foreignKeys',0,'mappings',0,'source'].
/// 3. 'Remove' scenario
/// a. ['propertyName1',index-1]. Example: remove a column from the columns property: ['columns',0'].
/// b. ['propertyName1',index-1,'propertyName2',index-2]. Example: remove a column mapping from a foreign key's column mapping table: ['foreignKeys',0,'mappings',0].
///<summary>
public static void Validate(object[] path, DesignerEditType editType)
{
if (path == null || path.Length == 0)
{
throw new ArgumentException(SR.TableEditPathNotProvidedException);
}
// Length validation
int[] validLengthList;
if (editType == DesignerEditType.Add)
{
validLengthList = new int[] { 1, 3 };
}
else if (editType == DesignerEditType.Update)
{
validLengthList = new int[] { 1, 3, 5 };
}
else
{
validLengthList = new int[] { 2, 4 };
}
bool isValid = validLengthList.ToList<int>().Contains(path.Length);
if (isValid)
{
for (int i = 0; i < path.Length; i++)
{
// On odd number positions, the value must be a number.
if (i % 2 != 0)
{
int val;
isValid = Int32.TryParse(path[i]?.ToString(), out val);
}
else
{
isValid = path[i] is string;
}
if (!isValid)
{
break;
}
}
}
if (!isValid)
{
throw new ArgumentException(SR.InvalidTableEditPathException(string.Join(',', path), editType.ToString()));
}
}
}
}

206
src/Microsoft.SqlTools.ServiceLayer/TableDesigner/TableDesignerService.cs
View File

@@ -57,102 +57,92 @@ namespace Microsoft.SqlTools.ServiceLayer.TableDesigner
this.ServiceHost.SetRequestHandler(SaveTableChangesRequest.Type, HandleSaveTableChangesRequest);
this.ServiceHost.SetRequestHandler(DisposeTableDesignerRequest.Type, HandleDisposeTableDesignerRequest);
}
private async Task HandleGetTableDesignerInfoRequest(TableInfo tableInfo, RequestContext<TableDesignerInfo> requestContext)
private Task HandleRequest<T>(RequestContext<T> requestContext, Func<Task> action)
{
await Task.Run(async () =>
{
try
{
var schemas = this.GetSchemas(tableInfo);
var viewModel = this.GetTableViewModel(tableInfo, schemas);
var view = this.GetDesignerViewInfo(tableInfo);
await requestContext.SendResult(new TableDesignerInfo()
{
ViewModel = viewModel,
View = view,
ColumnTypes = this.GetSupportedColumnTypes(tableInfo),
Schemas = schemas
});
}
catch (Exception e)
{
await requestContext.SendError(e);
}
});
// The request handling will take some time to return, we need to use a separate task to run the request handler so that it won't block the main thread.
// For any specific table designer instance, ADS UI can make sure there are at most one request being processed at any given time, so we don't have to worry about race conditions.
Task.Run(async () =>
{
try
{
await action();
}
catch (Exception e)
{
await requestContext.SendError(e);
}
});
return Task.CompletedTask;
}
private async Task HandleProcessTableDesignerEditRequest(ProcessTableDesignerEditRequestParams requestParams, RequestContext<ProcessTableDesignerEditResponse> requestContext)
private Task HandleGetTableDesignerInfoRequest(TableInfo tableInfo, RequestContext<TableDesignerInfo> requestContext)
{
await Task.Run(async () =>
{
try
{
switch (requestParams.TableChangeInfo.Type)
{
case DesignerEditType.Add:
this.HandleAddItemRequest(requestParams);
break;
case DesignerEditType.Remove:
// TODO: Handle 'Remove' request
break;
default:
// TODO: Handle 'Update' request
break;
}
await requestContext.SendResult(new ProcessTableDesignerEditResponse()
{
ViewModel = requestParams.ViewModel,
IsValid = true
});
}
catch (Exception e)
{
await requestContext.SendError(e);
}
});
return this.HandleRequest<TableDesignerInfo>(requestContext, async () =>
{
var schemas = this.GetSchemas(tableInfo);
var viewModel = this.GetTableViewModel(tableInfo, schemas);
var view = this.GetDesignerViewInfo(tableInfo);
await requestContext.SendResult(new TableDesignerInfo()
{
ViewModel = viewModel,
View = view,
ColumnTypes = this.GetSupportedColumnTypes(tableInfo),
Schemas = schemas
});
});
}
private async Task HandleSaveTableChangesRequest(SaveTableChangesRequestParams requestParams, RequestContext<SaveTableChangesResponse> requestContext)
private Task HandleProcessTableDesignerEditRequest(ProcessTableDesignerEditRequestParams requestParams, RequestContext<ProcessTableDesignerEditResponse> requestContext)
{
await Task.Run(async () =>
{
try
{
// TODO: Handle the save changes request.
await requestContext.SendResult(new SaveTableChangesResponse());
}
catch (Exception e)
{
await requestContext.SendError(e);
}
});
return this.HandleRequest<ProcessTableDesignerEditResponse>(requestContext, async () =>
{
DesignerPathUtils.Validate(requestParams.TableChangeInfo.Path, requestParams.TableChangeInfo.Type);
switch (requestParams.TableChangeInfo.Type)
{
case DesignerEditType.Add:
this.HandleAddItemRequest(requestParams);
break;
case DesignerEditType.Remove:
this.HandleRemoveItemRequest(requestParams);
break;
default:
// TODO: Handle 'Update' request
break;
}
await requestContext.SendResult(new ProcessTableDesignerEditResponse()
{
ViewModel = requestParams.ViewModel,
IsValid = true
});
});
}
private Task HandleSaveTableChangesRequest(SaveTableChangesRequestParams requestParams, RequestContext<SaveTableChangesResponse> requestContext)
{
return this.HandleRequest<SaveTableChangesResponse>(requestContext, async () =>
{
// TODO: Handle the save changes request.
await requestContext.SendResult(new SaveTableChangesResponse());
});
}
private async Task HandleDisposeTableDesignerRequest(TableInfo tableInfo, RequestContext<DisposeTableDesignerResponse> requestContext)
private Task HandleDisposeTableDesignerRequest(TableInfo tableInfo, RequestContext<DisposeTableDesignerResponse> requestContext)
{
await Task.Run(async () =>
{
try
{
// TODO: Handle the dispose table designer request.
await requestContext.SendResult(new DisposeTableDesignerResponse());
}
catch (Exception e)
{
await requestContext.SendError(e);
}
});
return this.HandleRequest<DisposeTableDesignerResponse>(requestContext, async () =>
{
// TODO: Handle the save changes request.
await requestContext.SendResult(new DisposeTableDesignerResponse());
});
}
private void HandleAddItemRequest(ProcessTableDesignerEditRequestParams requestParams)
{
var property = requestParams.TableChangeInfo.Property;
var path = requestParams.TableChangeInfo.Path;
// Handle the add item request on top level table properties, e.g. Columns, Indexes.
if (property.GetType() == typeof(string))
if (path.Length == 1)
{
string propertyName = property as string;
var propertyName = path[0] as string;
switch (propertyName)
{
case TablePropertyNames.Columns:
@@ -168,6 +158,28 @@ namespace Microsoft.SqlTools.ServiceLayer.TableDesigner
}
}
private void HandleRemoveItemRequest(ProcessTableDesignerEditRequestParams requestParams)
{
var path = requestParams.TableChangeInfo.Path;
// Handle the add item request on top level table properties, e.g. Columns, Indexes.
if (path.Length == 2)
{
var propertyName = path[0] as string;
switch (propertyName)
{
case TablePropertyNames.Columns:
requestParams.ViewModel.Columns.Data.RemoveAt(Convert.ToInt32(path[1]));
break;
default:
break;
}
}
else
{
// TODO: Handle the add item request on second level properties, e.g. Adding a column to an index
}
}
private List<string> GetSupportedColumnTypes(TableInfo tableInfo)
{
//TODO: get the supported column types.
@@ -200,8 +212,42 @@ namespace Microsoft.SqlTools.ServiceLayer.TableDesigner
private TableDesignerView GetDesignerViewInfo(TableInfo tableInfo)
{
// TODO: set the view information
var view = new TableDesignerView();
view.AdditionalTableColumnProperties.Add(new DesignerDataPropertyInfo()
{
PropertyName = TableColumnPropertyNames.IsIdentity,
Description = SR.TableColumnIsIdentityPropertyDescription,
Group = SR.TableColumnIdentityGroupName,
ComponentType = DesignerComponentType.Checkbox,
ComponentProperties = new CheckBoxProperties()
{
Title = SR.TableColumnIsIdentityPropertyTitle
}
});
view.AdditionalTableColumnProperties.Add(new DesignerDataPropertyInfo()
{
PropertyName = TableColumnPropertyNames.IdentitySeed,
Description = SR.TableColumnIdentitySeedPropertyDescription,
Group = SR.TableColumnIdentityGroupName,
ComponentType = DesignerComponentType.Input,
ComponentProperties = new InputBoxProperties()
{
Title = SR.TableColumnIdentitySeedPropertyTitle
}
});
view.AdditionalTableColumnProperties.Add(new DesignerDataPropertyInfo()
{
PropertyName = TableColumnPropertyNames.IdentityIncrement,
Description = SR.TableColumnIdentityIncrementPropertyDescription,
Group = SR.TableColumnIdentityGroupName,
ComponentType = DesignerComponentType.Input,
ComponentProperties = new InputBoxProperties()
{
Title = SR.TableColumnIdentityIncrementPropertyTitle
}
});
view.CanAddColumns = true;
view.CanRemoveColumns = true;
return view;
}