Add map preview cache by SadPencil · Pull Request #630 · CnCNet/xna-cncnet-client

SadPencil · 2025-01-08T03:58:56Z

No description provided.

github-actions · 2025-01-08T04:03:53Z

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 · 2025-02-02T12:35:06Z

+            return null;
+        }
+
+        private async Task MapTextureLoadingService(CancellationToken cancellationToken)


don't think the functions should be called like so, the functions is "do something", not "a thing"

will fix it

Metadorius · 2025-02-02T12:44:02Z

+
+        private readonly ConcurrentDictionary<Map, Image> mapTextures = [];
+
+        private readonly ConcurrentDictionary<Map, byte> missedMaps = [];


Why is this a dictionary when this should be a set? If the reason is that there's no concurrent set it's better to use some empty type like System.Reactive.Unit, for instance, as it better conveys the purpose.

IMO this should be brought higher and renamed to pendingMaps, it's not missing, the maps are just waiting to be processed.

So what do you suggest? I think we can't introduce RX here right now just because of introducing the unit type

Well, I don't see a big problem with introducing Rx, but I guess you could make an empty type or just copy the unit type from System.Reactive, and later we could just replace it when we introduce Rx.

Metadorius · 2025-02-02T12:44:48Z

+            if (mapTextures.TryGetValue(map, out Image image))
+                return image;
+
+            if (missedMaps.Count < MaxCacheSize)


Isn't this check redundant? There seems to be no point in regulating the input size.

Limiting RAM usage?

You missed the point. The RAM usage regulation is going to happen in the main dictionary which actually holds the map previews. AFAIK the map list is already in memory, so there wouldn't be a point to also regulate this as the most it will save is a few bytes. Also I don't think hitting 100 maps limit in 100ms is possible at all, and the "incoming" dictionary is drained regularly.

Then do you suggest also removing MaxCacheSize limits for the dictionary that holds bitmaps or not?

No, only from the pending/missing maps.

Metadorius · 2025-02-02T12:45:16Z

+        public void Dispose() =>
+            cancellationTokenSource?.Cancel();
+
+        public Image GetMapTextureIfAvailable(Map map)


Suggested change

public Image GetMapTextureIfAvailable(Map map)

public Image? GetMapTextureIfAvailable(Map map)

I will write #nullable enable on file MapTextureCacheManager.cs, if we decide to use nullable pattern for new files

IMO nullables should be enabled across all projects.

IMO nullables should be enabled across all projects.

Rans4cker once did that. And the majority objected because it introduces too many warning messages on existing codes. So to smoothly migrate (no one expects another .NET 6 migration PR) I suggest we enable that on new files as well as files being major revised

IIRC the main complaint was too strict StyleCop warnings, but alright. Those warnings are actually useful in this case IMO.

I know it's helpful. The point is there are too many warnings that would draw our attention from new warnings introduced

Metadorius · 2025-02-02T12:45:48Z

+                    }
+


Suggested change

}

}

huh? No changes were made

Ugh, I tried to remove the extra newline. Seems GitHub ate that.

Metadorius · 2025-02-02T12:49:07Z

        private GenericHostedGame game = null;

-        private bool disposeTextures = false;
+        private bool disposeTextures = true;


This just caught my attention, I don't think there should be such a flag, just the no map preview texture should be set as a singleton, and then when disposing the texture should be compared to the no map preview one.

The disposeTextures pattern is directly copied from MapPreviewBox class. In that class, PreloadMapPreviews is such a texture that should not be disposed.

I think we can leave this design as a future work since the client already has such a pattern for a long time?

I thought that's a trivial change to do so though, isn't that right?

Should be but it might require additional tests. Will try migrating it after I am available again

Metadorius · 2025-02-02T12:50:31Z

+                    }
+                    else
+                    {
+                        mapTexture = AssetLoader.TextureFromImage(mapLoader.MapTextureCacheManager.GetMapTextureIfAvailable(map));


Does this mean the first show of the preview will always show null texture? When will it be updated? IMO there should be a callback that will update the info upon loading the map.

Yes. Currently it will be updated the second time it is visited.

Will trying implementing a callback after I am available again (~weeks perhaps)

Metadorius · 2025-02-02T12:53:01Z

+        private readonly CancellationTokenSource cancellationTokenSource = new();
+
+        public MapTextureCacheManager() =>
+            Task.Run(() => MapTextureLoadingService(cancellationTokenSource.Token));


There's no error handling and no task tracking. If your task errors out - there won't be any map previews anymore provided and the exception will not be caught.

Will fix it by catching and recording exceptions in the while loop

Metadorius

Actually hold on, maybe it would be better to use something like a weak reference for the cache instead of manually doing it?

Also I am not sure if clearing all of the maps when the limit is reached is a good idea, I would shave off the not used ones. Some maps are going to appear more frequently so they won't be deleted.

SadPencil · 2025-02-02T16:12:32Z

Actually hold on, maybe it would be better to use something like a weak reference for the cache instead of manually doing it?

Also I am not sure if clearing all of the maps when the limit is reached is a good idea, I would shave off the not used ones. Some maps are going to appear more frequently so they won't be deleted.

Thanks for letting me know WeakReference. Will investigate

pzhlkj6612 · 2025-02-03T21:32:11Z

... I would shave off the not used ones. Some maps are going to appear more frequently so they won't be deleted.

LRU.

SadPencil · 2025-02-04T05:14:18Z

... I would shave off the not used ones. Some maps are going to appear more frequently so they won't be deleted.

LRU.

I would prefer leaving GC to decide using WeakReference

Metadorius · 2025-02-04T09:35:39Z

No, he has a point. GC doesn't care about time of last use, but we do. LRU cache seems to be a common technique and an effective measure for keeping only actually used things in memory, so why not?

SadPencil · 2025-02-04T10:32:42Z

No, he has a point. GC doesn't care about time of last use, but we do. LRU cache seems to be a common technique and an effective measure for keeping only actually used things in memory, so why not?

Okay. I just searched and find out WeakReference will be cleared out at every collection. Will implement an LRU

Add map preview cache

5cae363

Update MapTextureCacheManager.cs

eee4261

SadPencil requested a review from Metadorius January 8, 2025 04:16

SadPencil added 3 commits January 8, 2025 12:21

Update MapTextureCacheManager.cs

cc24bcb

Update MapTextureCacheManager.cs

ec2aec8

Merge branch 'develop' into feat-add-map-preview-cache

100d5bb

SadPencil linked an issue Jan 13, 2025 that may be closed by this pull request

Map preview lagging/ crashing for some users #626

Closed

Update GameModeMap.cs

dad5fdc

SadPencil added this to the 2.11.7.0 milestone Jan 25, 2025

Metadorius requested changes Feb 2, 2025

View reviewed changes

Metadorius reviewed Feb 2, 2025

View reviewed changes

Comment thread DXMainClient/DXGUI/Multiplayer/GameInformationPanel.cs

Metadorius reviewed Feb 2, 2025

View reviewed changes

SadPencil modified the milestones: 2.11.7.0, long term Feb 3, 2025

SadPencil marked this pull request as draft May 16, 2025 20:54

SadPencil force-pushed the develop branch from 47e2851 to 2597f10 Compare November 6, 2025 13:28

SadPencil force-pushed the develop branch from 9db87a8 to e0d174c Compare November 14, 2025 16:50

SadPencil mentioned this pull request Dec 7, 2025

Greatly reduce RAM usage in loading custom map #892

Merged

Merge branch 'develop' into feat-add-map-preview-cache

7acac1b

SadPencil mentioned this pull request Feb 17, 2026

Add MapPreviewCacheManager for concurrent-safe image caching with LRU eviction #934

Merged

SadPencil closed this in #934 Feb 21, 2026

github-project-automation Bot moved this from In Progress to Done in Yuri’s Revenge Client Development Board Feb 21, 2026

SadPencil deleted the feat-add-map-preview-cache branch March 26, 2026 04:25


		private readonly ConcurrentDictionary<Map, Image> mapTextures = [];

		private readonly ConcurrentDictionary<Map, byte> missedMaps = [];

	public Image GetMapTextureIfAvailable(Map map)
	public Image? GetMapTextureIfAvailable(Map map)

Uh oh!

Conversation

SadPencil commented Jan 8, 2025

Uh oh!

github-actions Bot commented Jan 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

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!

Choose a reason for hiding this comment

Uh oh!

SadPencil Feb 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

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!

SadPencil Feb 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

Metadorius left a comment

Choose a reason for hiding this comment

Uh oh!

SadPencil commented Feb 2, 2025

Uh oh!

pzhlkj6612 commented Feb 3, 2025

Uh oh!

SadPencil commented Feb 4, 2025

Uh oh!

Metadorius commented Feb 4, 2025

Uh oh!

SadPencil commented Feb 4, 2025

Uh oh!

Reviewers

github-actions Bot commented Jan 8, 2025 •

edited

Loading

SadPencil Feb 2, 2025 •

edited

Loading

SadPencil Feb 2, 2025 •

edited

Loading