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

Prevent duplicate package reporting #1197

Merged
merged 8 commits into from
Sep 20, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
25 changes: 25 additions & 0 deletions src/Sentry/Package.cs
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
using System;
using System.Collections.Generic;
using System.Text.Json;
using Sentry.Internal.Extensions;

Expand Down Expand Up @@ -57,5 +59,28 @@ public static Package FromJson(JsonElement json)

return new Package(name, version);
}

public override int GetHashCode()
{
unchecked
{
return (Name.GetHashCode() * 397) ^ Version.GetHashCode();
josh-degraw marked this conversation as resolved.
Show resolved Hide resolved
}
}

public override bool Equals(object? obj)
{
if (ReferenceEquals(this, obj))
{
return true;
}

if (obj is Package package)
{
return Name == package.Name && Version == package.Version;
}

return false;
}
}
}
2 changes: 1 addition & 1 deletion src/Sentry/SdkVersion.cs
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ public void WriteTo(Utf8JsonWriter writer)
{
writer.WriteStartObject();

writer.WriteArrayIfNotEmpty("packages", InternalPackages);
writer.WriteArrayIfNotEmpty("packages", InternalPackages.Distinct());
writer.WriteStringIfNotWhiteSpace("name", Name);
writer.WriteStringIfNotWhiteSpace("version", Version);

Expand Down
21 changes: 21 additions & 0 deletions test/Sentry.Tests/Protocol/SdkVersionTests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -57,5 +57,26 @@ public static IEnumerable<object[]> TestCases()
sdk.AddPackage("a", "1");
yield return new object[] { (sdk, "{\"packages\":[{\"name\":\"a\",\"version\":\"1\"},{\"name\":\"b\",\"version\":\"2\"}]}") };
}

[Fact]
public void SerializeObject_IgnoresDuplicatePackages()
{
var sdkVersion = new SdkVersion
{
Name = "Sentry.Test.SDK",
Version = "3.9.2"
};
sdkVersion.AddPackage("nuget:Sentry.Extensions.Logging", "3.9.2");
sdkVersion.AddPackage("nuget:Sentry", "3.9.2");
sdkVersion.AddPackage("nuget:Sentry.Extensions.Logging", "3.9.2");
sdkVersion.AddPackage("nuget:Sentry", "3.9.2");
var actual = sdkVersion.ToJsonString();
Assert.Equal(
"{\"packages\":[{\"name\":\"nuget:Sentry.Extensions.Logging\",\"version\":\"3.9.2\"},{\"name\":\"nuget:Sentry\",\"version\":\"3.9.2\"}]," +
"\"name\":\"Sentry.Test.SDK\"," +
"\"version\":\"3.9.2\"}",
actual);

}
}
}