Add a web label by 11EJDE11 · Pull Request #883 · CnCNet/xna-cncnet-client

11EJDE11 · 2025-11-17T20:22:57Z

This PR adds a label that can query JSON data from a datasource. We can use this for the online player count, for ladder ranking, or news. INI datasources are also supported.

Datasources are specified in ClientDefinitions.ini

[DataSources]
DataSourceID=URL,RefreshIntervalSeconds,TimeoutSeconds,Format ;example: TopPlayers=https://ladder.cncnet.org/api/v1/qm/ladder/rankings,300,10,json|ini

Labels then point to a datasource and can query the JSON.

[ExtraControls]
1=lblTopPlayer1:XNAClientJSONLabel

[lblTopPlayer1]
$Type=XNAClientJSONLabel
DataSourceID=TopPlayers
Template=1. {YR[0].player_name} - {YR[0].points:N0} pts
LoadingText=Loading...
FallbackText=---
FontIndex=1
RemapColor=230,230,230
Location=360,166

See INISytem.md for more info.

Excuse the crappy screenshot.

github-actions · 2025-11-17T20:27:55Z

Nightly build for this pull request:

artifacts.zip
This comment is automatic and is meant to allow guests to get latest automatic builds without registering. It is updated on every successful build.

Metadorius

Nice! Gave you some feedback.

Generally though while this approach definitely has it's place, I am not sure if we should do an explicit separate data source manager? My thoughts were more about something like an implicit manager class; different labels could have content URL endpoints specified right in place, and the response will be shared between them by that class (say, if the requests came to the manager in span of half a minute, then give the same data to every subscriber; if something updates the URL -- then all of the consumers of that URL will receive that).

Not fully set on the above, what are your thoughts?

cc @SadPencil @MahBoiDeveloper @Starkku @Rampastring

Metadorius · 2025-11-17T20:52:25Z

ClientGUI/XNAClientJSONLabel.cs

+    private List<string> ParseJSONPath(string json, string path)
+    {
+        try
+        {
+            var root = Newtonsoft.Json.Linq.JToken.Parse(json);
+            var results = new List<string>();
+
+            var tokens = root.SelectTokens(path);
+
+            if (tokens != null)
+                foreach (var token in tokens)
+                    if (token != null)
+                        results.Add(token.ToString());
+
+            return results.Count > 0 ? results : null;
+        }
+        catch (Exception ex)
+        {
+            Logger.Log($"JSONPath error: {ex.Message}");
+            return null;
+        }
+    }


I think this should happen way earlier at manager stage, and the control should only receive a parsed json and do template substitution, otherwise we're duplicating work.

Also we already use System.Text.Json, I see that it has no support for JSON Path for some reason, maybe this extension to System.Text.Json would do better? https://www.nuget.org/packages/JsonPath.Net Just so we don't introduce two similar libraries.

Metadorius · 2025-11-17T20:54:12Z

ClientGUI/XNAClientJSONLabel.cs

+    public string Template { get; set; }
+    public string LoadingText { get; set; }
+    public int MaxResults { get; set; } = 0;
+    public string FallbackText { get; set; } = "N/A";


missing .L10N call

ClientCore/JSONDataSourceManager.cs

Metadorius · 2025-11-17T21:10:52Z

ClientCore/JSONDataSourceManager.cs

+        private readonly string _url;
+        private readonly int _refreshIntervalSeconds;
+        private readonly int _timeoutSeconds;
+        private readonly string _format;


I think this _format should be either an enum and/or maybe even a tiny simple interface/class with one method that converts input value (stream?) and gives JSON for arbitrary data representation.

I agree with an interface. So we can decouple some string parsing logic from the UI logic. My recent editing experience on LAN lobby shows that it might waste a huge amount of time to maintain codes if different kinds of logics are not decoupled

Metadorius · 2025-11-17T21:14:58Z

ClientCore/JSONDataSourceManager.cs

+    {
+        private readonly string _id;
+        private readonly string _url;
+        private readonly int _refreshIntervalSeconds;


does it run even in background or when controls using it is not active?

although I realise now that it will probably complicate the code a lot, so I don't think there's a big need in doing it exactly. but if there is a lot of players that don't go online -- maybe autorefresh isn't something we may want to do? it will strain our servers quite a bit, maybe we should update just when the control is shown for the first time? (or sth in this direction)

Metadorius · 2025-11-17T21:16:45Z

ClientGUI/XNAClientJSONLabel.cs

+
+namespace ClientGUI;
+
+public class XNAClientJSONLabel : XNALabel


Perhaps let's name it XNAClientWebLabel, because it's not just JSON anymore?

also maybe it could be good to have it as a descendant of XNALinkLabel? in case the users want to see details

Renamed 65229d1
Will look into the LinkLabel.

Fix crash when no datasources specified

ClientGUI/XNAClientJSONLabel.cs

Update datasources format in ClientDefintions Add localisation Change to XNAClientWebLabel

11EJDE11 added 2 commits November 18, 2025 08:55

Add XNAClientJSONLabel

57f3f18

Extras

bcd8122

Metadorius requested changes Nov 17, 2025

View reviewed changes

Merge branch 'develop' into feat-web-label-2

57065e1

11EJDE11 mentioned this pull request Dec 10, 2025

Use a shorter timeout for CnCNet player count retrieval #896

Merged

11EJDE11 added 3 commits December 26, 2025 23:59

Merge remote-tracking branch 'origin/develop' into feat-web-label-2

3335b2c

Switch to RS for INI files

dc37f28

Fix crash when no datasources specified

Fixup

1dd82b1

SadPencil reviewed Feb 8, 2026

View reviewed changes

ClientGUI/XNAClientJSONLabel.cs Outdated Show resolved Hide resolved

11EJDE11 added 3 commits February 28, 2026 09:29

Merge develop into feat-web-label-2

1b6279d

Update docs

65229d1

Update datasources format in ClientDefintions Add localisation Change to XNAClientWebLabel

Move to DI

a19f21c


		namespace ClientGUI;

		public class XNAClientJSONLabel : XNALabel

Uh oh!

Conversation

11EJDE11 commented Nov 17, 2025

Uh oh!

github-actions bot commented Nov 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Metadorius left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

github-actions bot commented Nov 17, 2025 •

edited

Loading