Require a minor version to be supplied when instantiating SoulseekClient by jpdillingham · Pull Request #893 · jpdillingham/Soulseek.NET

jpdillingham · 2026-02-07T21:58:02Z

Also updates the default server address to the preferred server.slsknet.org (from vps.slsknet.org)

…r version

Copilot

Pull request overview

This PR updates the Soulseek.NET client API to require callers to provide a minor version when constructing a SoulseekClient, and wires that value through to the server login message. It also updates the default server hostname and adjusts tests/examples/docs to match the new constructor requirement.

Changes:

Require minorVersion for SoulseekClient construction and expose it via SoulseekClient.MinorVersion.
Pass minorVersion into LoginRequest (removing the previous hardcoded default).
Update default server address to server.slsknet.org and adjust unit/integration tests, examples, and README accordingly.

Reviewed changes

Copilot reviewed 57 out of 57 changed files in this pull request and generated 54 comments.

Show a summary per file

File	Description
tests/Soulseek.Tests.Unit/SearchResponderTests.cs	Updates mocked client construction to pass `minorVersion`.
tests/Soulseek.Tests.Unit/Options/ProxyOptionsTests.cs	Updates client instantiation to pass required `minorVersion`.
tests/Soulseek.Tests.Unit/Network/PeerConnectionManagerTests.cs	Updates client instantiation/mocks to pass `minorVersion`.
tests/Soulseek.Tests.Unit/Network/ListenerHandlerTests.cs	Updates client instantiation/mocks to pass `minorVersion`.
tests/Soulseek.Tests.Unit/Network/DistributedConnectionManagerTests.cs	Updates client instantiation/mocks to pass `minorVersion`.
tests/Soulseek.Tests.Unit/Messaging/Messages/OutgoingTests.cs	Updates `LoginRequest` tests to supply `minorVersion`.
tests/Soulseek.Tests.Unit/Messaging/Handlers/ServerMessageHandlerTests.cs	Updates client instantiation/mocks to pass `minorVersion`.
tests/Soulseek.Tests.Unit/Messaging/Handlers/PeerMessageHandlerTests.cs	Updates client instantiation/mocks to pass `minorVersion`.
tests/Soulseek.Tests.Unit/Messaging/Handlers/DistributedMessageHandlerTests.cs	Updates client instantiation/mocks to pass `minorVersion`.
tests/Soulseek.Tests.Unit/Diagnostics/GlobalDiagnosticTests.cs	Adjusts `GlobalDiagnostic.Init` usage for consistent minimum level in tests.
tests/Soulseek.Tests.Unit/Client/WatchUserAsyncTests.cs	Updates client instantiation to pass required `minorVersion`.
tests/Soulseek.Tests.Unit/Client/UploadAsyncTests.cs	Updates client instantiation to pass required `minorVersion`.
tests/Soulseek.Tests.Unit/Client/UnwatchUserAsyncTests.cs	Updates client instantiation to pass required `minorVersion`.
tests/Soulseek.Tests.Unit/Client/StopPublicChatAsyncTests.cs	Updates client instantiation to pass required `minorVersion`.
tests/Soulseek.Tests.Unit/Client/StartPublicChatAsyncTests.cs	Updates client instantiation to pass required `minorVersion`.
tests/Soulseek.Tests.Unit/Client/SetStatusAsyncTests.cs	Updates client instantiation to pass required `minorVersion`.
tests/Soulseek.Tests.Unit/Client/SetSharedCountsAsyncTests.cs	Updates client instantiation to pass required `minorVersion`.
tests/Soulseek.Tests.Unit/Client/SetRoomTickerAsyncTests.cs	Updates client instantiation to pass required `minorVersion`.
tests/Soulseek.Tests.Unit/Client/SendUploadSpeedAsyncTests.cs	Updates client instantiation to pass required `minorVersion`.
tests/Soulseek.Tests.Unit/Client/SendRoomMessageAsyncTests.cs	Updates client instantiation to pass required `minorVersion`.
tests/Soulseek.Tests.Unit/Client/SendAcknowledgePrivateMessageAsyncTests.cs	Updates client instantiation to pass required `minorVersion`.
tests/Soulseek.Tests.Unit/Client/SearchAsyncTests.cs	Updates client instantiation to pass required `minorVersion`.
tests/Soulseek.Tests.Unit/Client/RemovePrivateRoomModeratorAsyncTests.cs	Updates client instantiation to pass required `minorVersion`.
tests/Soulseek.Tests.Unit/Client/RemovePrivateRoomMemberAsyncTests.cs	Updates client instantiation to pass required `minorVersion`.
tests/Soulseek.Tests.Unit/Client/ReconfigureOptionsAsyncTests.cs	Updates fixture client creation to pass required `minorVersion`.
tests/Soulseek.Tests.Unit/Client/PingServerAsyncTests.cs	Updates client instantiation to pass required `minorVersion`.
tests/Soulseek.Tests.Unit/Client/JoinLeaveRoomAsyncTests.cs	Updates client instantiation to pass required `minorVersion`.
tests/Soulseek.Tests.Unit/Client/GrantUserPrivilegesAsyncTests.cs	Updates client instantiation to pass required `minorVersion`.
tests/Soulseek.Tests.Unit/Client/GetUserStatusAsyncTests.cs	Updates client instantiation to pass required `minorVersion`.
tests/Soulseek.Tests.Unit/Client/GetUserStatisticsAsyncTests.cs	Updates client instantiation to pass required `minorVersion`.
tests/Soulseek.Tests.Unit/Client/GetUserPrivilegedAsyncTests.cs	Updates client instantiation to pass required `minorVersion`.
tests/Soulseek.Tests.Unit/Client/GetUserInfoAsyncTests.cs	Updates client instantiation to pass required `minorVersion`.
tests/Soulseek.Tests.Unit/Client/GetUserEndPointAsyncTests.cs	Updates client instantiation to pass required `minorVersion`.
tests/Soulseek.Tests.Unit/Client/GetRoomListAsyncTests.cs	Updates client instantiation to pass required `minorVersion`.
tests/Soulseek.Tests.Unit/Client/GetPrivilegesAsyncTests.cs	Updates client instantiation to pass required `minorVersion`.
tests/Soulseek.Tests.Unit/Client/GetDownloadPlaceInQueueAsyncTests.cs	Updates client instantiation to pass required `minorVersion`.
tests/Soulseek.Tests.Unit/Client/GetDirectoryContentsAsyncTests.cs	Updates client instantiation to pass required `minorVersion`.
tests/Soulseek.Tests.Unit/Client/EnqueueUploadAsyncTests.cs	Updates client instantiation to pass required `minorVersion`.
tests/Soulseek.Tests.Unit/Client/EnqueueDownloadAsyncTests.cs	Updates client instantiation to pass required `minorVersion` and cleans unused usings.
tests/Soulseek.Tests.Unit/Client/DropPrivateRoomOwnershipAsyncTests.cs	Updates client instantiation to pass required `minorVersion`.
tests/Soulseek.Tests.Unit/Client/DropPrivateRoomMembershipAsyncTests.cs	Updates client instantiation to pass required `minorVersion`.
tests/Soulseek.Tests.Unit/Client/DownloadAsyncTests.cs	Updates client instantiation to pass required `minorVersion`.
tests/Soulseek.Tests.Unit/Client/ConnectToUserAsyncTests.cs	Updates client instantiation/fixtures to pass required `minorVersion`.
tests/Soulseek.Tests.Unit/Client/ConnectAsyncTests.cs	Updates client construction and expected `LoginRequest` bytes to include `minorVersion`.
tests/Soulseek.Tests.Unit/Client/CleanupSemaphoresAsyncTests.cs	Updates client instantiation to pass required `minorVersion`.
tests/Soulseek.Tests.Unit/Client/ChangePasswordAsyncTests.cs	Updates client instantiation to pass required `minorVersion`.
tests/Soulseek.Tests.Unit/Client/BrowseAsyncTests.cs	Updates client instantiation to pass required `minorVersion`.
tests/Soulseek.Tests.Unit/Client/AddPrivateRoomModeratorAsyncTests.cs	Updates client instantiation to pass required `minorVersion`.
tests/Soulseek.Tests.Unit/Client/AddPrivateRoomMemberAsyncTests.cs	Updates client instantiation to pass required `minorVersion`.
tests/Soulseek.Tests.Unit/Client/AcknowledgePrivilegeNotificationAsyncTests.cs	Updates client instantiation to pass required `minorVersion`.
tests/Soulseek.Tests.Integration/SoulseekClientTests.cs	Updates integration tests to pass required `minorVersion`.
src/SoulseekClient.cs	Introduces required `minorVersion`, stores it on the client, uses it for `LoginRequest`, and updates default server hostname.
src/Messaging/Messages/Server/LoginRequest.cs	Makes `MinorVersion` provided by constructor (no longer hardcoded).
examples/Web/api/Startup.cs	Updates example app client construction to include `minorVersion`.
examples/Console/Program.cs	Updates console example client construction to include `minorVersion` and applies minor formatting cleanup.
README.md	Updates documentation to reflect required `minorVersion` and explains its purpose.

Comments suppressed due to low confidence (1)

src/Messaging/Messages/Server/LoginRequest.cs:38

LoginRequest now takes minorVersion but doesn’t validate it. Even if SoulseekClient validates, this type can still be instantiated internally/tests with invalid values. Consider adding a simple guard (e.g., throw ArgumentOutOfRangeException when <= 0) to keep message construction robust.

        public LoginRequest(int minorVersion, string username, string password)
        {
            MinorVersion = minorVersion;

            Username = username;
            Password = password;

            Hash = $"{Username}{Password}".ToMD5Hash();

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-07T22:02:29Z

@@ -99,6 +103,8 @@ internal SoulseekClient(
            ITokenBucket uploadTokenBucket = null,
            ITokenBucket downloadTokenBucket = null)
        {


minorVersion is accepted and assigned without any validation. Since this value is now required and sent over the wire in LoginRequest, please validate it here (e.g., throw ArgumentOutOfRangeException if <= 0, and consider documenting/validating an upper bound if the protocol expects one) so consumers get an immediate, actionable failure instead of undefined network behavior.

Suggested change

{

{

if (minorVersion <= 0)

{

throw new ArgumentOutOfRangeException(nameof(minorVersion), minorVersion, "minorVersion must be greater than 0.");

}

Copilot · 2026-02-07T22:02:30Z

+        private const string DefaultAddress = "server.slsknet.org";
        private const int DefaultPort = 2271;


PR description says the default server address is being updated from vpn.slsknet.org, but the code changes it from vps.slsknet.org to server.slsknet.org. Please reconcile the PR description with the actual change so it’s clear what’s being updated (and why).

Copilot · 2026-02-07T22:02:30Z

+Starting with version 9, the `minorVersion` constructor is required.  This version identifies your application on the Soulseek network,
+and provides a way for administrators to understand trafic and behavior patterns.  Choose a unique integer to supply.


The README states “Starting with version 9” but the current package version appears to still be 8.x, which is confusing for users. Consider rephrasing to “Starting with the next release / starting with vX.Y” (the library version), or avoid a specific version number and just describe the new requirement.

Suggested change

Starting with version 9, the `minorVersion` constructor is required. This version identifies your application on the Soulseek network,

and provides a way for administrators to understand trafic and behavior patterns. Choose a unique integer to supply.

The `minorVersion` constructor parameter is required. This value identifies your application on the Soulseek network,

and provides a way for administrators to understand trafic and behavior patterns. Choose a unique integer to supply.

codecov · 2026-02-07T22:02:53Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.84%. Comparing base (e221ead) to head (f8e6e04).
⚠️ Report is 15 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #893      +/-   ##
==========================================
- Coverage   98.95%   98.84%   -0.11%     
==========================================
  Files         184      184              
  Lines        6492     6499       +7     
  Branches      995      996       +1     
==========================================
  Hits         6424     6424              
- Misses         48       49       +1     
- Partials       20       26       +6

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

sonarqubecloud · 2026-02-07T22:28:17Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

jpdillingham added 7 commits February 7, 2026 13:00

change default address

a988f40

require minor version to be supplied in the login request

fdf5d04

update readme to reflect versioning change

77bf378

update constructors and login request to use externally supplied mino…

42f883f

…r version

update examples

fe33cc2

update tests

8b30f23

fix flaky test

ffd75b0

jpdillingham requested a review from Copilot February 7, 2026 21:58

Copilot started reviewing on behalf of jpdillingham February 7, 2026 21:58 View session

Copilot AI reviewed Feb 7, 2026

View reviewed changes

jpdillingham and others added 7 commits February 7, 2026 16:07

Update tests/Soulseek.Tests.Unit/Client/EnqueueDownloadAsyncTests.cs

3b215a1

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update README.md

b2d0f93

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

move major version to constants

cd0bd06

get major version from constants

58e1531

ensure minor version is greater than or equal to 100

d246602

add MajorVersion

26c3585

add tests for major and minor version

f8e6e04

jpdillingham merged commit 0dfe338 into master Feb 7, 2026
5 of 6 checks passed

jpdillingham deleted the server branch February 7, 2026 22:34

jpdillingham mentioned this pull request Mar 8, 2026

Breaking changes in 9.0.0 #899

Closed

slook mentioned this pull request Mar 26, 2026

Consider deterministically deriving the first three digits of minorVersion when instantiating SoulseekClient #909

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Require a minor version to be supplied when instantiating SoulseekClient#893

Require a minor version to be supplied when instantiating SoulseekClient#893
jpdillingham merged 14 commits intomasterfrom
server

jpdillingham commented Feb 7, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Feb 7, 2026

Uh oh!

Uh oh!

Copilot AI Feb 7, 2026

Uh oh!

Copilot AI Feb 7, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov Bot commented Feb 7, 2026 •

edited

Loading

Uh oh!

sonarqubecloud Bot commented Feb 7, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

-        {
+        {
+            if (minorVersion <= 0)
+            {
+                throw new ArgumentOutOfRangeException(nameof(minorVersion), minorVersion, "minorVersion must be greater than 0.");
+            }

		private const string DefaultAddress = "server.slsknet.org";
		private const int DefaultPort = 2271;

		Starting with version 9, the `minorVersion` constructor is required. This version identifies your application on the Soulseek network,
		and provides a way for administrators to understand trafic and behavior patterns. Choose a unique integer to supply.

Conversation

jpdillingham commented Feb 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 7, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Feb 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 7, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov Bot commented Feb 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

sonarqubecloud Bot commented Feb 7, 2026

Quality Gate passed

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

jpdillingham commented Feb 7, 2026 •

edited

Loading

codecov Bot commented Feb 7, 2026 •

edited

Loading