Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix issues with stored SQL or KQL queries not showing in variable explorer #2995

Merged
merged 1 commit into from
May 22, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -268,8 +268,8 @@ Microsoft.DotNet.Interactive.SqlServer
protected System.Boolean CanDeclareVariable(System.String name, System.Object value, ref System.String& msg)
public System.Threading.Tasks.Task ConnectAsync()
protected System.String CreateVariableDeclaration(System.String name, System.Object value)
protected System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.IReadOnlyCollection<Microsoft.DotNet.Interactive.Formatting.TabularData.TabularDataResource>> get_QueryResults()
protected System.Void StoreQueryResults(System.Collections.Generic.IReadOnlyCollection<Microsoft.DotNet.Interactive.Formatting.TabularData.TabularDataResource> results, System.CommandLine.Parsing.ParseResult commandKernelChooserParseResult)
protected System.Void StoreQueryResultSet(System.String name, System.Collections.Generic.IReadOnlyCollection<Microsoft.DotNet.Interactive.Formatting.TabularData.TabularDataResource> queryResultSet)
public System.Boolean TryGetValue<T>(System.String name, ref T& value)
public class VersionedTextDocumentIdentifier : TextDocumentIdentifier
.ctor()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -260,8 +260,8 @@ Microsoft.DotNet.Interactive.SqlServer
protected System.Boolean CanDeclareVariable(System.String name, System.Object value, ref System.String& msg)
public System.Threading.Tasks.Task ConnectAsync()
protected System.String CreateVariableDeclaration(System.String name, System.Object value)
protected System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.IReadOnlyCollection<Microsoft.DotNet.Interactive.Formatting.TabularData.TabularDataResource>> get_QueryResults()
protected System.Void StoreQueryResults(System.Collections.Generic.IReadOnlyCollection<Microsoft.DotNet.Interactive.Formatting.TabularData.TabularDataResource> results, System.CommandLine.Parsing.ParseResult commandKernelChooserParseResult)
protected System.Void StoreQueryResultSet(System.String name, System.Collections.Generic.IReadOnlyCollection<Microsoft.DotNet.Interactive.Formatting.TabularData.TabularDataResource> queryResultSet)
public System.Boolean TryGetValue<T>(System.String name, ref T& value)
public class VersionedTextDocumentIdentifier : TextDocumentIdentifier
.ctor()
Expand Down
27 changes: 27 additions & 0 deletions src/Microsoft.DotNet.Interactive.Kql.Tests/KqlConnectionTests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,33 @@ public async Task It_can_store_result_set_with_a_name()
.Which.Value.Should().BeAssignableTo<IEnumerable<TabularDataResource>>();
}

[KqlFact]
public async Task Stored_query_results_are_listed_in_ValueInfos()
{
var cluster = KqlFactAttribute.GetClusterForTests();
using var kernel = await CreateKernelAsync();
var result = await kernel.SubmitCodeAsync(
$"#!connect kql --kernel-name KustoHelp --cluster \"{cluster}\" --database \"Samples\"");

result.Events
.Should()
.NotContainErrors();

result = await kernel.SubmitCodeAsync(@"
#!kql-KustoHelp --name my_data_result
StormEvents | take 10
");

var kqlKernel = kernel.FindKernelByName("kql-KustoHelp");

result = await kqlKernel.SendAsync(new RequestValueInfos());

var valueInfos = result.Events.Should().ContainSingle<ValueInfosProduced>()
.Which.ValueInfos;

valueInfos.Should().Contain(v => v.Name == "my_data_result");
}

[KqlFact]
public async Task When_variable_does_not_exist_then_an_error_is_returned()
{
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
<ProjectConfiguration>
<Settings>
<IgnoredTests>
<FixtureTestSelector>
<FixtureName>Microsoft.DotNet.Interactive.Kql.Tests.KqlConnectionTests</FixtureName>
</FixtureTestSelector>
</IgnoredTests>
</Settings>
<Settings />
</ProjectConfiguration>
2 changes: 1 addition & 1 deletion src/Microsoft.DotNet.Interactive.Kql/MsKqlKernel.cs
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ protected override void StoreQueryResults(IReadOnlyCollection<TabularDataResourc
var name = commandKernelChooserParseResult?.GetValueForOption(chooser.NameOption);
if (!string.IsNullOrWhiteSpace(name))
{
QueryResults[name] = results;
StoreQueryResultSet(name, results);
}
}
}
Original file line number Diff line number Diff line change
@@ -1,37 +1,5 @@
<ProjectConfiguration>
<Settings>
<DefaultTestTimeout>15000</DefaultTestTimeout>
<IgnoredTests>
<FixtureTestSelector>
<FixtureName>Microsoft.DotNet.Interactive.SqlServer.Tests.MsSqlServiceClientTests</FixtureName>
</FixtureTestSelector>
<NamedTestSelector>
<TestName>Microsoft.DotNet.Interactive.SqlServer.Tests.MsSqlConnectionTests.An_input_type_hint_is_set_for_connection_strings</TestName>
</NamedTestSelector>
<NamedTestSelector>
<TestName>Microsoft.DotNet.Interactive.SqlServer.Tests.MsSqlConnectionTests.Empty_results_are_displayed_correctly</TestName>
</NamedTestSelector>
<NamedTestSelector>
<TestName>Microsoft.DotNet.Interactive.SqlServer.Tests.MsSqlConnectionTests.Field_types_are_deserialized_correctly</TestName>
</NamedTestSelector>
<NamedTestSelector>
<TestName>Microsoft.DotNet.Interactive.SqlServer.Tests.MsSqlConnectionTests.It_can_connect_and_query_data</TestName>
</NamedTestSelector>
<NamedTestSelector>
<TestName>Microsoft.DotNet.Interactive.SqlServer.Tests.MsSqlConnectionTests.It_can_scaffold_a_DbContext_in_a_CSharpKernel</TestName>
</NamedTestSelector>
<NamedTestSelector>
<TestName>Microsoft.DotNet.Interactive.SqlServer.Tests.MsSqlConnectionTests.It_can_store_multiple_result_set_with_a_name</TestName>
</NamedTestSelector>
<NamedTestSelector>
<TestName>Microsoft.DotNet.Interactive.SqlServer.Tests.MsSqlConnectionTests.It_can_store_result_set_with_a_name</TestName>
</NamedTestSelector>
<NamedTestSelector>
<TestName>Microsoft.DotNet.Interactive.SqlServer.Tests.MsSqlConnectionTests.query_produces_expected_formatted_values</TestName>
</NamedTestSelector>
<NamedTestSelector>
<TestName>Microsoft.DotNet.Interactive.SqlServer.Tests.MsSqlConnectionTests.sending_query_to_sql_will_generate_suggestions</TestName>
</NamedTestSelector>
</IgnoredTests>
</Settings>
</ProjectConfiguration>
Original file line number Diff line number Diff line change
Expand Up @@ -183,16 +183,14 @@ SELECT TOP 100 * FROM Person.Person

result.Events
.Should()
.NotContainErrors()
.And
.ContainSingle<DisplayedValueProduced>(e =>
e.FormattedValues.Any(f => f.MimeType == HtmlFormatter.MimeType))
.Which.FormattedValues.Single(f => f.MimeType == HtmlFormatter.MimeType)
.Value
.Should()
.Contain("#!sql-adventureworks")
.And
.Contain(" SELECT TOP * FROM");
.Contain("SELECT TOP 100 * FROM Person.Person");

}

Expand Down Expand Up @@ -336,6 +334,30 @@ await kernel.SubmitCodeAsync($@"
.Be(1);
}

[MsSqlFact]
public async Task Stored_query_results_are_listed_in_ValueInfos()
{
var connectionString = MsSqlFactAttribute.GetConnectionStringForTests();
using var kernel = await CreateKernelAsync();
await kernel.SubmitCodeAsync(
$"#!connect mssql --kernel-name adventureworks \"{connectionString}\"");

// Run query with result set
await kernel.SubmitCodeAsync($@"
#!sql-adventureworks --name my_data_result
select * from sys.databases
");

var sqlKernel = kernel.FindKernelByName("sql-adventureworks");

var result = await sqlKernel.SendAsync(new RequestValueInfos());

var valueInfos = result.Events.Should().ContainSingle<ValueInfosProduced>()
.Which.ValueInfos;

valueInfos.Should().Contain(v => v.Name == "my_data_result");
}

[MsSqlFact]
public async Task When_variable_does_not_exist_then_an_error_is_returned()
{
Expand Down
3 changes: 2 additions & 1 deletion src/Microsoft.DotNet.Interactive.SqlServer/MsSqlKernel.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@

using Microsoft.Data.SqlClient.Server;
using Microsoft.DotNet.Interactive.Formatting.TabularData;
using Microsoft.EntityFrameworkCore.Metadata;

namespace Microsoft.DotNet.Interactive.SqlServer;

Expand Down Expand Up @@ -103,7 +104,7 @@ protected override void StoreQueryResults(IReadOnlyCollection<TabularDataResourc
var name = commandKernelChooserParseResult?.GetValueForOption(chooser.NameOption);
if (!string.IsNullOrWhiteSpace(name))
{
QueryResults[name] = results;
StoreQueryResultSet(name, results);
}
}
}
21 changes: 8 additions & 13 deletions src/Microsoft.DotNet.Interactive.SqlServer/ToolsServiceKernel.cs
Original file line number Diff line number Diff line change
Expand Up @@ -31,17 +31,7 @@ public abstract class ToolsServiceKernel :
private bool _intellisenseReady;
protected bool Connected;
protected readonly ToolsServiceClient ServiceClient;

/// <summary>
/// The set of query result lists to save for sharing later.
/// The key will be the name of the value.
/// The value is a list of result sets (multiple if multiple queries are ran as a batch)
/// </summary>
protected Dictionary<string, IReadOnlyCollection<TabularDataResource>> QueryResults { get; } = new();
/// <summary>
/// Used to store incoming variables passed in via #!share
/// </summary>
private readonly Dictionary<string, object> _variables = new(StringComparer.Ordinal);
private readonly Dictionary<string, object> _variables = new(StringComparer.Ordinal);


protected ToolsServiceKernel(string name, ToolsServiceClient client, string languageName) : base(name)
Expand Down Expand Up @@ -345,7 +335,7 @@ async Task IKernelCommandHandler<RequestCompletions>.HandleAsync(RequestCompleti

public bool TryGetValue<T>(string name, out T value)
{
if (QueryResults.TryGetValue(name, out var resultSet) &&
if (_variables.TryGetValue(name, out var resultSet) &&
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah was the bug basically that we (inadvertently) used the wrong dictionary?

resultSet is T resultSetT)
{
value = resultSetT;
Expand All @@ -371,7 +361,7 @@ Task IKernelCommandHandler<RequestValue>.HandleAsync(RequestValue command, Kerne

Task IKernelCommandHandler<RequestValueInfos>.HandleAsync(RequestValueInfos command, KernelInvocationContext context)
{
var valueInfos = QueryResults.Keys.Select(key =>
var valueInfos = _variables.Keys.Select(key =>
{
var formattedValues = FormattedValue.CreateSingleFromObject(
_variables[key],
Expand Down Expand Up @@ -438,4 +428,9 @@ await SetValueAsync(command, context, (name, value, declaredType) =>
return Task.CompletedTask;
});
}

protected void StoreQueryResultSet(string name, IReadOnlyCollection<TabularDataResource> queryResultSet)
{
_variables[name] = queryResultSet;
}
}