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.

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

Jump to bottom

CosmosClientOptions: Adds validation for ApplicationName #3455

Merged
merged 18 commits into from
Sep 19, 2022
Merged

CosmosClientOptions: Adds validation for ApplicationName #3455

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
7aa8ac5
IGNORE ME
NaluTripician Sep 12, 2022
0f32758
IGNORE ME
NaluTripician Sep 12, 2022
28938d7
Implemented suggested changes, verify that application name does not …
NaluTripician Sep 13, 2022
7ea1be8
Cleaned up unnecessary code
NaluTripician Sep 13, 2022
76f11a6
Now using built-in NameValueHeaderValueParser
NaluTripician Sep 14, 2022
2175fc4
Clarified Exception message
NaluTripician Sep 14, 2022
3fdbd93
Fixed added bug
NaluTripician Sep 14, 2022
1664902
Updated Contracts
NaluTripician Sep 14, 2022
69c8e42
Wrapped Format Exception in Argument Exception
NaluTripician Sep 14, 2022
3e5b420
Moved test to unit tests, removed unused variable
NaluTripician Sep 14, 2022
6ebec43
Merge branch 'master' into users/nalutripician/ApplicationNameValidation
NaluTripician Sep 14, 2022
5951129
restored ClientTests.cs
NaluTripician Sep 14, 2022
655d47f
Now checking application name parse with a dummy http request to corr…
NaluTripician Sep 16, 2022
5747635
pushed accidentily unstaged changes
NaluTripician Sep 16, 2022
6bcfef8
Use Base HttpRequestMessage
NaluTripician Sep 19, 2022
238c060
Changed User Agent String to HttpConstant
NaluTripician Sep 19, 2022
c6ddf9d
Changed User Agent String to HttpConstant
NaluTripician Sep 19, 2022
50f2e05
Changed User Agent String to HttpConstant
NaluTripician Sep 19, 2022
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
22 changes: 20 additions & 2 deletions Microsoft.Azure.Cosmos/src/CosmosClientOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ namespace Microsoft.Azure.Cosmos
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Net.Http.Headers;
using Microsoft.Azure.Cosmos.Fluent;
using Microsoft.Azure.Documents;
using Microsoft.Azure.Documents.Client;
using Newtonsoft.Json;
using Telemetry;

/// <summary>
/// Defines all the configurable options that the CosmosClient requires.
Expand Down Expand Up @@ -69,6 +69,7 @@ public class CosmosClientOptions
private PortReuseMode? portReuseMode;
private IWebProxy webProxy;
private Func<HttpClient> httpClientFactory;
private string applicationName;

/// <summary>
/// Creates a new CosmosClientOptions
Expand All @@ -90,7 +91,24 @@ public CosmosClientOptions()
/// <remarks>
/// Setting this property after sending any request won't have any effect.
/// </remarks>
public string ApplicationName { get; set; }
public string ApplicationName
{
get => this.applicationName;
set
{
try
{
HttpRequestMessage dummyMessage = new HttpRequestMessage();
dummyMessage.Headers.Add(HttpConstants.HttpHeaders.UserAgent, value);
}
catch (FormatException fme)
{
throw new ArgumentException($"Application name '{value}' is invalid.", fme);
}

this.applicationName = value;
}
}

/// <summary>
/// Get or set session container for the client
Expand Down
41 changes: 41 additions & 0 deletions ...sts/BaselineTest/TestBaseline/PassThroughQueryBaselineTests.NegativePassThroughOutput.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
<Results>
<Result>
<Input>
<Description>Null Partition Key Value</Description>
ealsur marked this conversation as resolved.
Show resolved Hide resolved
<Query>SELECT * FROM c</Query>
<PartitionKeys>
<Key>/pk</Key>
</PartitionKeys>
<PartitionKeyType>Hash</PartitionKeyType>
</Input>
<Output>
<ExecuteAsPassThrough>false</ExecuteAsPassThrough>
</Output>
</Result>
<Result>
<Input>
<Description>None Partition Key Value</Description>
<Query>SELECT * FROM c</Query>
<PartitionKeys>
<Key>/pk</Key>
</PartitionKeys>
<PartitionKeyType>Hash</PartitionKeyType>
</Input>
<Output>
<ExecuteAsPassThrough>false</ExecuteAsPassThrough>
</Output>
</Result>
<Result>
<Input>
<Description>C# Null Partition Key Value</Description>
<Query>SELECT * FROM c</Query>
<PartitionKeys>
<Key>/pk</Key>
</PartitionKeys>
<PartitionKeyType>Hash</PartitionKeyType>
</Input>
<Output>
<ExecuteAsPassThrough>false</ExecuteAsPassThrough>
</Output>
</Result>
</Results>
41 changes: 41 additions & 0 deletions ...sts/BaselineTest/TestBaseline/PassThroughQueryBaselineTests.PositivePassThroughOutput.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
<Results>
<Result>
<Input>
<Description>Partition Key + Value and Distinct</Description>
<Query>SELECT DISTINCT c.key FROM c</Query>
<PartitionKeys>
<Key>/pk</Key>
</PartitionKeys>
<PartitionKeyType>Hash</PartitionKeyType>
</Input>
<Output>
<ExecuteAsPassThrough>true</ExecuteAsPassThrough>
</Output>
</Result>
<Result>
<Input>
<Description>Partition Key + Value and Min Aggregate</Description>
<Query>SELECT VALUE MIN(c.key) FROM c</Query>
<PartitionKeys>
<Key>/pk</Key>
</PartitionKeys>
<PartitionKeyType>Hash</PartitionKeyType>
</Input>
<Output>
<ExecuteAsPassThrough>true</ExecuteAsPassThrough>
</Output>
</Result>
<Result>
<Input>
<Description>Partition Key + Value Fields</Description>
<Query>SELECT c.key FROM c</Query>
<PartitionKeys>
<Key>/pk</Key>
</PartitionKeys>
<PartitionKeyType>Hash</PartitionKeyType>
</Input>
<Output>
<ExecuteAsPassThrough>true</ExecuteAsPassThrough>
</Output>
</Result>
</Results>
12 changes: 4 additions & 8 deletions Microsoft.Azure.Cosmos/tests/Microsoft.Azure.Cosmos.Tests/Contracts/DotNetSDKAPI.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2896,11 +2896,9 @@
"Attributes": [],
"MethodInfo": "System.String ApplicationRegion;CanRead:True;CanWrite:True;System.String get_ApplicationRegion();IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;Void set_ApplicationRegion(System.String);IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;"
},
"System.String get_ApplicationName()[System.Runtime.CompilerServices.CompilerGeneratedAttribute()]": {
"System.String get_ApplicationName()": {
"Type": "Method",
"Attributes": [
"CompilerGeneratedAttribute"
],
"Attributes": [],
"MethodInfo": "System.String get_ApplicationName();IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;"
},
"System.String get_ApplicationRegion()[System.Runtime.CompilerServices.CompilerGeneratedAttribute()]": {
Expand Down Expand Up @@ -2934,11 +2932,9 @@
],
"MethodInfo": "Void set_AllowBulkExecution(Boolean);IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;"
},
"Void set_ApplicationName(System.String)[System.Runtime.CompilerServices.CompilerGeneratedAttribute()]": {
"Void set_ApplicationName(System.String)": {
"Type": "Method",
"Attributes": [
"CompilerGeneratedAttribute"
],
"Attributes": [],
"MethodInfo": "Void set_ApplicationName(System.String);IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;"
},
"Void set_ApplicationPreferredRegions(System.Collections.Generic.IReadOnlyList`1[System.String])[System.Runtime.CompilerServices.CompilerGeneratedAttribute()]": {
Expand Down
27 changes: 27 additions & 0 deletions Microsoft.Azure.Cosmos/tests/Microsoft.Azure.Cosmos.Tests/CosmosClientOptionsUnitTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -539,6 +539,33 @@ public void WithQuorumReadWithEventualConsistencyAccount()
Assert.IsTrue(cosmosClientOptions.EnableUpgradeConsistencyToLocalQuorum);
}

[TestMethod]
public void InvalidApplicationNameCatchTest()
{

string[] illegalChars = new string[] { "<", ">", "\"", "{", "}", "\\", "[", "]", ";", ":", "@", "=", "(", ")", "," };
string baseName = "illegal";

foreach (string illegal in illegalChars)
{
Assert.ThrowsException<ArgumentException>(() => new CosmosClientOptions
{
ApplicationName = baseName + illegal
});


Assert.ThrowsException<ArgumentException>(() => new CosmosClientOptions
{
ApplicationName = illegal + baseName
});

Assert.ThrowsException<ArgumentException>(() => new CosmosClientOptions
{
ApplicationName = illegal
});
}
}

private class TestWebProxy : IWebProxy
{
public ICredentials Credentials { get; set; }
Expand Down