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

PartitionKey: Fixes NullRef in toString handling for None for PartitionKey.ToString() #3498

Merged
merged 4 commits into from
Oct 11, 2022
Merged

PartitionKey: Fixes NullRef in toString handling for None for PartitionKey.ToString() #3498

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e9eaf05
Added toString handling for None in addition to existing null
Oct 11, 2022
27fe2e6
Added const string representation of None
Oct 11, 2022
5176a7e
Unnecessary using added - removed
Oct 11, 2022
3a0b7d0
Consistent handling of None for both references to PartitionKey.None.…
Oct 11, 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
2 changes: 1 addition & 1 deletion Microsoft.Azure.Cosmos/src/FeedRange/FeedRanges/FeedRangePartitionKey.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ public override string ToString()
{
if (this.PartitionKey.IsNone)
{
return "None";
return PartitionKey.NoneString;
}

return this.PartitionKey.InternalKey.ToJsonString();
Expand Down
10 changes: 10 additions & 0 deletions Microsoft.Azure.Cosmos/src/PartitionKey.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,11 @@ namespace Microsoft.Azure.Cosmos
/// </summary>
internal bool IsNone { get; }

/// <summary>
/// String representation of None for use when representing Partition Key as none.
/// </summary>
internal const string NoneString = "None";

/// <summary>
/// Creates a new partition key value.
/// </summary>
Expand Down Expand Up @@ -173,6 +178,11 @@ public bool Equals(PartitionKey other)
/// <returns>The string representation of the partition key value</returns>
public override string ToString()
{
if (this.IsNone)
{
return NoneString;
}

if (this.InternalKey == null)
{
return PartitionKey.NullPartitionKeyInternal.ToJsonString();
Expand Down
9 changes: 9 additions & 0 deletions Microsoft.Azure.Cosmos/tests/Microsoft.Azure.Cosmos.Tests/PartitionKeyTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,15 @@ public void TestPartitionKeyDefinitionAreEquivalent()
Assert.IsTrue(PartitionKeyDefinition.AreEquivalent(definition1, definition2));
}

[TestMethod]
public void NoneToStringNotNullRef()
{
const string noneString = "None";
Cosmos.PartitionKey noneKey = Cosmos.PartitionKey.None;

Assert.AreEqual(noneString, noneKey.ToString());
}

[TestMethod]
public void RoundTripTests()
{
Expand Down