Skip to content

Support for escaping curly braces in embedded expression #3962

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.

Sign up for GitHub

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

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Support for escaping curly braces in embedded expression #3962

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
639e4f9
Support for escaping curly braces in embedded expression
bleaphar Jun 5, 2025
3bce799
Merge branch 'dotnet:main' into main
bleaphar Jul 1, 2025
31d8469
Better tests nomenclature and nit
bleaphar Jul 3, 2025
0c44d92
Variable combinatorials
bleaphar Jul 14, 2025
4fdf463
Update HttpRequestNodeSyntaxSpec.cs
bleaphar Jul 14, 2025
ef14f09
Nixed repeat section
bleaphar Jul 17, 2025
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
100 changes: 92 additions & 8 deletions src/Microsoft.DotNet.Interactive.Http.Tests/ParserTests.Combinatorial.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,7 @@ public static IEnumerable<object[]> GenerateValidRequests()
var generationNumber = 0;

foreach(var namedRequest in ValidNamedRequests())
foreach (var variables in ValidVariableDeclarations())
foreach (var method in ValidMethods())
foreach (var url in ValidUrls())
foreach (var version in ValidVersions())
Expand All @@ -115,7 +116,7 @@ public static IEnumerable<object[]> GenerateValidRequests()
++generationNumber;
yield return new object[]
{
new HttpRequestNodeSyntaxSpec(namedRequest, method, url, version, headerSection, bodySection),
new HttpRequestNodeSyntaxSpec(namedRequest, variables, method, url, version, headerSection, bodySection),
generationNumber
};
}
Expand All @@ -125,6 +126,7 @@ public static IEnumerable<object[]> GenerateValidRequestsWithExtraTrivia()
{
var generationNumber = 0;

foreach(var variables in ValidVariableDeclarations())
foreach (var namedRequest in ValidNamedRequests())
foreach (var method in ValidMethods())
foreach (var url in ValidUrls())
Expand All @@ -135,7 +137,7 @@ public static IEnumerable<object[]> GenerateValidRequestsWithExtraTrivia()
++generationNumber;
yield return new object[]
{
new HttpRequestNodeSyntaxSpec(namedRequest, method, url, version, headerSection, bodySection)
new HttpRequestNodeSyntaxSpec(namedRequest, variables, method, url, version, headerSection, bodySection)
{
Randomizer = new Random(1)
},
Expand All @@ -149,6 +151,7 @@ public static IEnumerable<object[]> GenerateInvalidRequests()
var generationNumber = 0;

foreach (var namedRequest in ValidNamedRequests())
foreach (var variables in ValidVariableDeclarations())
foreach (var method in InvalidMethods())
foreach (var url in ValidUrls())
foreach (var version in ValidVersions())
Expand All @@ -158,12 +161,13 @@ public static IEnumerable<object[]> GenerateInvalidRequests()
++generationNumber;
yield return new object[]
{
new HttpRequestNodeSyntaxSpec(namedRequest, method, url, version, headerSection, bodySection),
new HttpRequestNodeSyntaxSpec(namedRequest, variables, method, url, version, headerSection, bodySection),
generationNumber
};
}

foreach (var namedRequest in ValidNamedRequests())
foreach (var variables in ValidVariableDeclarations())
foreach (var method in ValidMethods())
foreach (var url in InvalidUrls())
foreach (var version in ValidVersions())
Expand All @@ -173,12 +177,13 @@ public static IEnumerable<object[]> GenerateInvalidRequests()
++generationNumber;
yield return new object[]
{
new HttpRequestNodeSyntaxSpec(namedRequest, method, url, version, headerSection, bodySection),
new HttpRequestNodeSyntaxSpec(namedRequest, variables, method, url, version, headerSection, bodySection),
generationNumber
};
}

foreach(var namedRequest in ValidNamedRequests())
foreach (var variables in ValidVariableDeclarations())
foreach (var method in ValidMethods())
foreach (var url in ValidUrls())
foreach (var version in InvalidVersions())
Expand All @@ -188,12 +193,13 @@ public static IEnumerable<object[]> GenerateInvalidRequests()
++generationNumber;
yield return new object[]
{
new HttpRequestNodeSyntaxSpec(namedRequest, method, url, version, headerSection, bodySection),
new HttpRequestNodeSyntaxSpec(namedRequest, variables, method, url, version, headerSection, bodySection),
generationNumber
};
}

foreach(var namedRequest in ValidNamedRequests())
foreach (var variables in ValidVariableDeclarations())
foreach (var method in ValidMethods())
foreach (var url in ValidUrls())
foreach (var version in ValidVersions())
Expand All @@ -203,12 +209,14 @@ public static IEnumerable<object[]> GenerateInvalidRequests()
++generationNumber;
yield return new object[]
{
new HttpRequestNodeSyntaxSpec(namedRequest, method, url, version, headerSection, bodySection),
new HttpRequestNodeSyntaxSpec(namedRequest, variables, method, url, version, headerSection, bodySection),
generationNumber
};
}


foreach (var namedRequest in InvalidNamedRequests())
foreach (var variables in ValidVariableDeclarations())
foreach (var method in ValidMethods())
foreach (var url in ValidUrls())
foreach (var version in ValidVersions())
Expand All @@ -218,11 +226,28 @@ public static IEnumerable<object[]> GenerateInvalidRequests()
++generationNumber;
yield return new object[]
{
new HttpRequestNodeSyntaxSpec(namedRequest, method, url, version, headerSection, bodySection),
new HttpRequestNodeSyntaxSpec(namedRequest, variables, method, url, version, headerSection, bodySection),
generationNumber
};
}

foreach (var namedRequest in ValidNamedRequests())
foreach (var variables in InvalidVariableDeclarations())
foreach (var method in ValidMethods())
foreach (var url in ValidUrls())
foreach (var version in ValidVersions())
foreach (var headerSection in ValidHeaderSections())
foreach (var bodySection in ValidBodySections())
{
++generationNumber;
yield return new object[]
{
new HttpRequestNodeSyntaxSpec(namedRequest, variables, method, url, version, headerSection, bodySection),
Copy link
Contributor

@jonsequitur jonsequitur Jul 15, 2025

Choose a reason for hiding this comment

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

Did you intend to repeat this section?

generationNumber
};
}
}
}

private static IEnumerable<HttpMethodNodeSyntaxSpec> ValidMethods()
{
Expand Down Expand Up @@ -355,5 +380,64 @@ with XML.</description>
.Should().BeEquivalentTo("numberValue", "stringValue");
});
}

private static IEnumerable<HttpVariableDeclarationAndAssignmentNodeSyntaxSpec> ValidVariableDeclarations()
Copy link
Contributor

@jonsequitur jonsequitur Jul 15, 2025

Choose a reason for hiding this comment

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

It might not be necessary to add so many cases. The goal of these tests is generally not to test every detail of the feature. The unit tests already cover that. They tend to be useful for catching issues with different combinations of syntax (e.g. does the parser move correctly from one node type to another) as well as incomplete syntax (e.g. does the parser handle it gracefully when the user is typing and the syntax is malformed in various normal ways.)

{
yield return null;

yield return new HttpVariableDeclarationAndAssignmentNodeSyntaxSpec("@host=localhost");

yield return new HttpVariableDeclarationAndAssignmentNodeSyntaxSpec("@host=https://example.com");

yield return new HttpVariableDeclarationAndAssignmentNodeSyntaxSpec("@api_key=secret123");

yield return new HttpVariableDeclarationAndAssignmentNodeSyntaxSpec("@base_url=https://{{host}}/api", node =>
{
node.ValueNode.DescendantNodesAndTokens().OfType<HttpEmbeddedExpressionNode>()
.Should().ContainSingle()
.Which.ExpressionNode.Text.Should().Be("host");
});

yield return new HttpVariableDeclarationAndAssignmentNodeSyntaxSpec("@escaped=\\{\\{text\\}\\}", node =>
{
node.ValueNode.Text.Should().Be("{{text}}");
});

yield return new HttpVariableDeclarationAndAssignmentNodeSyntaxSpec("@with_spaces=one two three");

yield return new HttpVariableDeclarationAndAssignmentNodeSyntaxSpec("@quoted=\"hello world\"");

yield return new HttpVariableDeclarationAndAssignmentNodeSyntaxSpec("@single_quoted='hello world'");

yield return new HttpVariableDeclarationAndAssignmentNodeSyntaxSpec("@user.name=john_doe");

yield return new HttpVariableDeclarationAndAssignmentNodeSyntaxSpec("@dynamic={{$guid}}", node =>
{
node.ValueNode.DescendantNodesAndTokens().OfType<HttpEmbeddedExpressionNode>()
.Should().ContainSingle()
.Which.ExpressionNode.Text.Should().Be("$guid");
});
}

private static IEnumerable<HttpVariableDeclarationAndAssignmentNodeSyntaxSpec> InvalidVariableDeclarations()
{
// Missing variable name
yield return new HttpVariableDeclarationAndAssignmentNodeSyntaxSpec("@=value");

// Variable name starting with number
yield return new HttpVariableDeclarationAndAssignmentNodeSyntaxSpec("@123invalid=value");

// Invalid character in variable name (hyphen)
yield return new HttpVariableDeclarationAndAssignmentNodeSyntaxSpec("@my-var=value");

// Space in variable name
yield return new HttpVariableDeclarationAndAssignmentNodeSyntaxSpec("@var name=value");

// Missing equals sign
yield return new HttpVariableDeclarationAndAssignmentNodeSyntaxSpec("@host value");

// Special characters in variable name
yield return new HttpVariableDeclarationAndAssignmentNodeSyntaxSpec("@host!name=value");
}
}
}

22 changes: 22 additions & 0 deletions src/Microsoft.DotNet.Interactive.Http.Tests/Utility/HttpBodyNodeSyntaxSpec.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,4 +65,26 @@ internal class HttpHeadersNodeSyntaxSpec : SyntaxSpecBase<HttpHeadersNode>
public HttpHeadersNodeSyntaxSpec(string text, params Action<HttpHeadersNode>[] assertions) : base(text, assertions)
{
}
}

internal class HttpVariableDeclarationAndAssignmentNodeSyntaxSpec : SyntaxSpecBase<HttpVariableDeclarationAndAssignmentNode>
{
public HttpVariableDeclarationAndAssignmentNodeSyntaxSpec(string text, params Action<HttpVariableDeclarationAndAssignmentNode>[] assertions)
: base(text, assertions)
{
}

public override void Validate(HttpVariableDeclarationAndAssignmentNode syntaxNode)
{
base.Validate(syntaxNode);

// Additional validation specific to variable declarations
syntaxNode.DeclarationNode.Should().NotBeNull();
syntaxNode.AssignmentNode.Should().NotBeNull();

if (!syntaxNode.GetDiagnostics().Any())
{
syntaxNode.ValueNode.Should().NotBeNull();
}
}
}
3 changes: 3 additions & 0 deletions src/Microsoft.DotNet.Interactive.Http.Tests/Utility/HttpRequestNodeSyntaxSpec.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ internal class HttpRequestNodeSyntaxSpec : SyntaxSpecBase<HttpRequestNode>
{
public HttpRequestNodeSyntaxSpec(
HttpCommentNodeSyntaxSpec commentNamedRequest,
HttpVariableDeclarationAndAssignmentNodeSyntaxSpec variableDeclarationAndAssignment,
HttpMethodNodeSyntaxSpec method,
HttpUrlNodeSyntaxSpec url,
HttpVersionNodeSyntaxSpec version = null,
Expand All @@ -37,6 +38,8 @@ public HttpRequestNodeSyntaxSpec(

public HttpCommentNodeSyntaxSpec CommentNamedRequest { get; }

public HttpVariableDeclarationAndAssignmentNodeSyntaxSpec VariableDeclarationAndAssignment { get; }

public HttpMethodNodeSyntaxSpec Method { get; }

public HttpUrlNodeSyntaxSpec Url { get; }
Expand Down