Rewrite User storage and UUID cache #4581

JRoy · 2021-10-17T14:14:55Z

A rewrite of user loading, user caching, uuid caching, and user memory management.

Closes #4512
Closes #4342
Closes #4566
Closes #4581

Technical Breakdown of `ModernUserMap` + `ModernUUIDCache`

TODO

Checklist;

Store username history more sanely
Rewrite the UUID cache
Rewrite the UserMap and replace the old UserMap
Add ABI backwards compatibility for certain hot methods in old UserMap

…rite

tadhgboyle · 2021-10-27T16:53:34Z

pop4959

//noinspection ConstantConditions

Essentials/src/main/java/com/earth2me/essentials/userstorage/ModernUUIDCache.java

# Conflicts: # Essentials/src/main/java/com/earth2me/essentials/commands/Commandessentials.java

…rite

Always call ModernUserMap#getUser(Player) during join to ensure the fetched/created User object has the most up-to-date name on the underlying Player object. Additionally, ensure that ModernUUIDCache#updateCache is always called during #getUser and not just when we generate a new User object (which always never happens by the time the call is made 💀).

Used to create User objects based on player objects for use from when before Bukkit places the user into its own internal usermap. Without this, ModernUserMap#loadUncachedUser(UUID) would attempt to fetch the player from the server only to not return null because we first try to create a user during PlayerLoginEvent which is before Bukkit puts the player into its internal usermap.

mdcfe

Side note: do we want an API interface for ModernUserMap? Just so there's an explicit (and limited) set of methods that plugins should expect to use, otherwise I anticipate people will just call internal methods

Essentials/src/main/java/com/earth2me/essentials/EssentialsPlayerListener.java

Essentials/src/main/java/com/earth2me/essentials/api/Economy.java

Essentials/src/main/java/com/earth2me/essentials/economy/vault/VaultEconomyProvider.java

Essentials/src/main/java/com/earth2me/essentials/userstorage/ModernUUIDCache.java

Essentials/src/main/java/com/earth2me/essentials/userstorage/ModernUserMap.java

Essentials/src/main/java/com/earth2me/essentials/commands/Commandessentials.java

.idea/checkstyle-idea.xml

Co-authored-by: triagonal <10545540+triagonal@users.noreply.github.com> Co-authored-by: MD <1917406+mdcfe@users.noreply.github.com>

mibby · 2022-09-17T13:45:54Z

@JRoy Not entirely sure where to leave feedback for this but noticed that every time Citizens loads an npc (server restarts, teleporting around), Essentials spams creating a user for them.
https://paste.gg/p/anonymous/e7fd399e9db6436d8ed3c5ee15dae70a/files/febeaa22bd6846a8aa7d8a93acb63b85/raw

EssentialsX-2.20.0-dev+5
https://ci.ender.zone/view/All/job/EssentialsX-Experimental/100007/
Citizens2 dev 2705
https://ci.citizensnpcs.co/job/Citizens2/

JeffP07 · 2022-09-18T17:23:00Z

@JRoy Not entirely sure where to leave feedback for this but noticed that every time Citizens loads an npc (server restarts, teleporting around), Essentials spams creating a user for them. https://paste.gg/p/anonymous/e7fd399e9db6436d8ed3c5ee15dae70a/files/febeaa22bd6846a8aa7d8a93acb63b85/raw

EssentialsX-2.20.0-dev+5 https://ci.ender.zone/view/All/job/EssentialsX-Experimental/100007/ Citizens2 dev 2705 https://ci.citizensnpcs.co/job/Citizens2/

I had this issue and found it was caused by jail.yml having old data that was formatted in a different way than new jails. Since I don't actually use the jails, removing the file contents worked for me.

Co-authored-by: triagonal <10545540+triagonal@users.noreply.github.com> Co-authored-by: MD <1917406+mdcfe@users.noreply.github.com>

JRoy added 5 commits October 14, 2021 00:11

Store username history inside userdata

eee82e4

Remove legacy uuidconvert and uuidtest subcommands

c8a39da

Remove legacy code from UserMap and UUIDMap

d963b25

Start work on ModernUUIDCache

1cedfb3

Also cache all uuids in seperate file

5887d7a

JRoy added type: enhancement Features and feature requests. type: bugfix PRs that fix bugs in EssentialsX. module: main Issues or PRs for the main Essentials module labels Oct 17, 2021

JRoy added this to the 2.19.1 milestone Oct 17, 2021

JRoy mentioned this pull request Oct 17, 2021

UUIDS Error #4578

Closed

JRoy changed the title ~~Rewrite UserMap~~ Rewrite User storage and UUID cache Oct 17, 2021

JRoy added 11 commits October 17, 2021 12:27

Complete first iteration of ModernUserMap

ea2b071

Replace uuid cache upgrade

3d6962d

Replace all usages of UserMap with ModernUserMap

1244f50

Backport some select methods to the old UserMap class

f2b6f4c

Forcefully save NPC names into uuid cache

1131574

Properly save the UUID/Name cache on shutdown

614a0e6

Actually read more than one user/uuid

da79e8c

Add /ess usermap command for information on the usermap

65c2d08

Add usermap.bin and uuids.bin to .gitignore

6e67a0a

Make StringUtil#safeString null-safe

79318a1

Move config save hook to contructor

289fee4

JRoy marked this pull request as ready for review October 18, 2021 03:04

JRoy added 3 commits October 18, 2021 15:16

Initialize legacy user map

b6097e7

Merge branch '2.x' into refactor/usermap-rewrite

cfc1346

Merge remote-tracking branch 'upstream/2.x' into refactor/usermap-rew…

4514831

…rite

pop4959 previously approved these changes Oct 28, 2021

View reviewed changes

JRoy mentioned this pull request Nov 4, 2021

EssentialsX is flooding my console with UUID errors! #4609

Closed

JRoy commented Nov 4, 2021

View reviewed changes

Essentials/src/main/java/com/earth2me/essentials/userstorage/ModernUUIDCache.java Outdated Show resolved Hide resolved

JRoy added 11 commits July 23, 2022 19:11

Merge branch '2.x' into refactor/usermap-rewrite

32b6184

Don't cache users into map for luckperms contexts

d7a2834

Merge branch '2.x' into refactor/usermap-rewrite

16c4ee8

# Conflicts: # Essentials/src/main/java/com/earth2me/essentials/commands/Commandessentials.java

Merge remote-tracking branch 'upstream/2.x' into refactor/usermap-rew…

07a3980

…rite

if i broke one more damn thing, i'm reverting everything

eb5c42d

Merge branch '2.x' into refactor/usermap-rewrite

2f20b82

Merge branch '2.x' into refactor/usermap-rewrite

9531e33

Merge branch '2.x' into refactor/usermap-rewrite

0a5b4d6

Merge branch '2.x' into refactor/usermap-rewrite

4685ac9

mdcfe requested changes Aug 24, 2022

View reviewed changes

JRoy added 3 commits August 25, 2022 17:14

Use safe string for Economy and VaultEconomyProvider always

6fcd963

Change some method visibility, create IUserMap

0dc9200

Misc review items

1d86993

JRoy requested a review from mdcfe August 25, 2022 21:42

mdcfe reviewed Aug 31, 2022

View reviewed changes

.idea/checkstyle-idea.xml Outdated Show resolved Hide resolved

mdcfe changed the base branch from 2.x to dev/2.20 August 31, 2022 14:29

mdcfe and others added 2 commits August 31, 2022 15:32

Merge branch 'dev/2.20' into refactor/usermap-rewrite

967678b

Restore checkstyle-idea.xml

988dd78

JRoy requested a review from mdcfe August 31, 2022 22:41

Add npc-name property for generated NPC accounts

09f864e

mdcfe approved these changes Sep 4, 2022

View reviewed changes

mdcfe merged commit be91573 into dev/2.20 Sep 4, 2022

mdcfe deleted the refactor/usermap-rewrite branch September 4, 2022 14:42

JRoy added a commit that referenced this pull request Sep 4, 2022

Rewrite User storage and UUID cache (#4581)

b1e9a98

Co-authored-by: triagonal <10545540+triagonal@users.noreply.github.com> Co-authored-by: MD <1917406+mdcfe@users.noreply.github.com>

JRoy added a commit that referenced this pull request Sep 9, 2022

Rewrite User storage and UUID cache (#4581)

0ca58ce

Co-authored-by: triagonal <10545540+triagonal@users.noreply.github.com> Co-authored-by: MD <1917406+mdcfe@users.noreply.github.com>

ressidell pushed a commit to ressidell/Essentials that referenced this pull request Apr 27, 2025

Rewrite User storage and UUID cache (EssentialsX#4581)

f017888

Co-authored-by: triagonal <10545540+triagonal@users.noreply.github.com> Co-authored-by: MD <1917406+mdcfe@users.noreply.github.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Rewrite User storage and UUID cache #4581

Rewrite User storage and UUID cache #4581

Uh oh!

JRoy commented Oct 17, 2021 •

edited

Loading

Uh oh!

tadhgboyle commented Oct 27, 2021

Uh oh!

pop4959 left a comment

Uh oh!

Uh oh!

mdcfe left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mibby commented Sep 17, 2022 •

edited

Loading

Uh oh!

JeffP07 commented Sep 18, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants

Uh oh!

Rewrite User storage and UUID cache #4581

Rewrite User storage and UUID cache #4581

Uh oh!

Conversation

JRoy commented Oct 17, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Technical Breakdown of ModernUserMap + ModernUUIDCache

Uh oh!

tadhgboyle commented Oct 27, 2021

Uh oh!

pop4959 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mdcfe left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mibby commented Sep 17, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

JeffP07 commented Sep 18, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants

JRoy commented Oct 17, 2021 •

edited

Loading

Technical Breakdown of `ModernUserMap` + `ModernUUIDCache`

mibby commented Sep 17, 2022 •

edited

Loading