feat(platform): add clear methods to remove the audience provider cache

[Silthus]

Added [...]Audiences.clear() and [...]Audiences.clear(Plugin) to all three audiences. This will remove the audience from the static cache. This functionality may be needed by test environments.

This is related to this request on discord.

[zml2008]

this is not an audience cache, this is an AudienceProvider cache........ call things the right name

imo the correct solution is to make the AudienceProvders implement Closeable and have a close() method that removes them from the cache, not what's currently here

[Silthus]

this is not an audience cache, this is an AudienceProvider cache........ call things the right name

imo the correct solution is to make the AudienceProvders implement Closeable and have a close() method that removes them from the cache, not what's currently here

Mmh but shouldn't Closable, better AutoClosable be used for locking resources and releasing them, like IO operations? The AudienceProvider isn't really locking anything, it just holds a reference (cache) to the Audiences created. Also Autoclosable throws an Exception by default, which is not really the case here.

Maybe rename it to remove and keep the clear to match the overall Collection syntax?

[Silthus]

I have built a workaround in my testing library in the mean time:

Field instances = Class.forName("net.kyori.adventure.platform.bukkit.BukkitAudiencesImpl").getDeclaredField("INSTANCES");
instances.setAccessible(true);
((Map<String, BukkitAudiences>) instances.get(null)).clear();

Should this API addition still be added or should I close the PR and the users who need to clear the cache use the reflection code above?

[kezz]

I might be missing something, but why can't you just clear the instance from the static map when the existing close method is called?

[Silthus]

I might be missing something, but why can't you just clear the instance from the static map when the existing close method is called?

No you are right, I am the one that missed something ;)
I did not see the existing close method.

[Silthus]

Ok I updated the PR so that the AudienceProvider removes itself from the cache when close() is called. Thank you @kezz

[kezz]

This looks good to me now!