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

[Azure.Communication.Common] - Overridden operators for the CommunicationIdentifier #30075

Merged
merged 10 commits into from
Jul 29, 2022
Merged

[Azure.Communication.Common] - Overridden operators for the CommunicationIdentifier #30075

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
bb23489
overridden operators for the CommunicationIdentifier
petrsvihlik Jul 22, 2022
baed523
increase coverage
petrsvihlik Jul 22, 2022
1dfe968
exported new api
petrsvihlik Jul 22, 2022
1bf4f35
use expression bodies
petrsvihlik Jul 25, 2022
56f7f37
use explicit operator
petrsvihlik Jul 25, 2022
1c7facc
adjust tests with regards to the explicit operator
petrsvihlik Jul 25, 2022
2574324
exported api + fixed the order of ifs
petrsvihlik Jul 25, 2022
94d1879
remove the explicit conversion operator
petrsvihlik Jul 28, 2022
cbc74c6
update the api
petrsvihlik Jul 28, 2022
9a46bf3
Merge branch 'main' into override-operators
petrsvihlik Jul 29, 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
3 changes: 3 additions & 0 deletions ...communication/Azure.Communication.Common/api/Azure.Communication.Common.netstandard2.0.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ protected CommunicationIdentifier() { }
public override bool Equals(object obj) { throw null; }
public static Azure.Communication.CommunicationIdentifier FromRawId(string rawId) { throw null; }
public override int GetHashCode() { throw null; }
public static bool operator ==(Azure.Communication.CommunicationIdentifier left, Azure.Communication.CommunicationIdentifier right) { throw null; }
public static implicit operator Azure.Communication.CommunicationIdentifier (string value) { throw null; }
public static bool operator !=(Azure.Communication.CommunicationIdentifier left, Azure.Communication.CommunicationIdentifier right) { throw null; }
}
public sealed partial class CommunicationTokenCredential : System.IDisposable
{
Expand Down
25 changes: 25 additions & 0 deletions sdk/communication/Azure.Communication.Common/src/CommunicationIdentifier.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,31 @@ public abstract class CommunicationIdentifier : IEquatable<CommunicationIdentifi
public override bool Equals(object obj)
=> obj is CommunicationIdentifier other && Equals(other);

/// <summary>
/// Overrides the equality operator.
/// </summary>
/// <param name="left">The first identifier to compare.</param>
/// <param name="right">The second identifier to compare.</param>
/// <returns>True if the types and <see cref="RawId"/> match.</returns>
public static bool operator ==(CommunicationIdentifier left, CommunicationIdentifier right)
{
return Equals(left, right) && left.GetType() == right.GetType();
}

/// <summary>
/// Overrides the non-equality operator.
/// </summary>
/// <param name="left">The first identifier to compare.</param>
/// <param name="right">The second identifier to compare.</param>
/// <returns>True if the types or <see cref="RawId"/> values are different.</returns>
public static bool operator !=(CommunicationIdentifier left, CommunicationIdentifier right)
{
return !Equals(left, right) || left.GetType() != right.GetType();
}

/// <summary> Converts a string to a <see cref="CommunicationIdentifier"/>. </summary>
public static implicit operator CommunicationIdentifier(string value) => FromRawId(value);

/// <summary>
/// Creates a <see cref="CommunicationIdentifier"/> from a given rawId.
/// When storing rawIds, use this function to restore the identifier that was encoded in the rawId.
Expand Down
13 changes: 13 additions & 0 deletions sdk/communication/Azure.Communication.Common/tests/CommunicationIdentifierTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,8 @@ static void AssertIdentifier(string rawId, CommunicationIdentifier expectedIdent
{
Assert.AreEqual(CommunicationIdentifier.FromRawId(rawId), expectedIdentifier);
Assert.AreEqual(CommunicationIdentifier.FromRawId(rawId).GetHashCode(), expectedIdentifier.GetHashCode());
Assert.IsTrue(CommunicationIdentifier.FromRawId(rawId) == expectedIdentifier);
Assert.IsFalse(CommunicationIdentifier.FromRawId(rawId) != expectedIdentifier);
}

AssertIdentifier("8:acs:bbbcbc1e-9f06-482a-b5d8-20e3f26ef0cd_45ab2481-1c1c-4005-be24-0ffb879b1130", new CommunicationUserIdentifier("8:acs:bbbcbc1e-9f06-482a-b5d8-20e3f26ef0cd_45ab2481-1c1c-4005-be24-0ffb879b1130"));
Expand Down Expand Up @@ -99,6 +101,17 @@ public void RawIdStaysTheSameAfterConversionToIdentifierAndBack()
AssertRoundtrip("28:45ab2481-1c1c-4005-be24-0ffb879b1130");
}

[Test]
public void TestImplicitConversionOperator()
{
CommunicationIdentifier communicationUserIdentifier = "8:acs:bbbcbc1e-9f06-482a-b5d8-20e3f26ef0cd_45ab2481-1c1c-4005-be24-0ffb879b1130";
CommunicationIdentifier microsoftTeamsUserIdentifier = "8:orgid:45ab2481-1c1c-4005-be24-0ffb879b1130";
CommunicationIdentifier phoneNumberIdentifier = "4:112345556789";
Assert.IsInstanceOf(typeof(CommunicationUserIdentifier), communicationUserIdentifier);
Assert.IsInstanceOf(typeof(MicrosoftTeamsUserIdentifier), microsoftTeamsUserIdentifier);
Assert.IsInstanceOf(typeof(PhoneNumberIdentifier), phoneNumberIdentifier);
}

[Test]
public void RawIdIsOverriddenBySubTypes()
{
Expand Down