New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: add MojangUtil.queueUsernameForUUID #444

Draft

My-Name-Is-Jeff wants to merge 1 commit into dev from feat/queueUsernameForUUID

Member

My-Name-Is-Jeff commented Feb 9, 2024

Queue usernames for UUID lookup and wait until completed

Run usernames in batch by waiting for at least 10? or max 3 seconds


          feat: add MojangUtil.queueUsernameForUUID

1c6a3f3

pull-request-quantifier-deprecated bot added the Extra Small label

pull-request-quantifier-deprecated bot commented Feb 9, 2024

This PR has 44 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!

Quantification details

Label      : Extra Small
Size       : +44 -0
Percentile : 17.6%

Total files changed: 1

Change summary by file extension:
.kt : +44 -0

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

Fast and predictable releases to production:
- Optimal size changes are more likely to be reviewed faster with fewer
  iterations.
- Similarity in low PR complexity drives similar review times.
Review quality is likely higher as complexity is lower:
- Bugs are more likely to be detected.
- Code inconsistencies are more likely to be detected.
Knowledge sharing is improved within the participants:
- Small portions can be assimilated better.
Better engineering practices are exercised:
- Solving big problems by dividing them in well contained, smaller problems.
- Exercising separation of concerns within the code changes.

What can I do to optimize my changes

Use the PullRequestQuantifier to quantify your PR accurately
- Create a context profile for your repo using the context generator
- Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
- Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
- Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
Change your engineering behaviors
- For PRs that fall outside of the desired spectrum, review the details and check if:
  - Your PR could be split in smaller, self-contained PRs instead
  - Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

One line was added: +1 -0
One line was deleted: +0 -1
One line was modified: +1 -1 (git diff doesn't know about modified, it will
interpret that line like one addition plus one deletion)
Change percentiles: Change characteristics (addition, deletion, modification)
of this PR in relation to all other PRs within the repository.

Was this comment helpful? 👍 :ok_hand: :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

My-Name-Is-Jeff requested a review from Sychic

February 9, 2024 05:35

My-Name-Is-Jeff commented

View reviewed changes

src/main/kotlin/gg/skytils/skytilsmod/utils/MojangUtil.kt

+                      val username = name.lowercase()
+                      usernameQueue.emit(username to System.currentTimeMillis())
+                      return uuidFlow.first { it.first == username }.second

Member Author

My-Name-Is-Jeff Feb 9, 2024

if 2 queue the same username what will happen?

Member

Sychic Feb 9, 2024

It should still emit. Only StateFlow will disregard repeated consecutive elements.

src/main/kotlin/gg/skytils/skytilsmod/utils/MojangUtil.kt

+                          val usernames = ArrayDeque<Pair<String, Long>>(10)
+                          usernameQueue.collect { name ->
+                              usernames.add(name)
+                              if (usernames.size >= 10 || usernames.isNotEmpty() && System.currentTimeMillis() - usernames.first().second >= 3000L) {

Member Author

My-Name-Is-Jeff Feb 9, 2024

this condition good?

Member

Sychic Feb 9, 2024

If you're trying to create what is effectively a bucket ratelimiter, there are probably better ways to handle this (see Levelhead). Otherwise, you'd probably want your usernameQueue flow to have a replay cache (and buffer) of 10 so you can access queued values more than once.
Also, It'd probably be nice to add qualifying parenthesis around the second condition because it's not very straightforward from a glance.

My-Name-Is-Jeff commented

View reviewed changes

src/main/kotlin/gg/skytils/skytilsmod/utils/MojangUtil.kt

+                          usernameQueue.collect { name ->
+                              usernames.add(name)
+                              if (usernames.size >= 10 || usernames.isNotEmpty() && System.currentTimeMillis() - usernames.first().second >= 3000L) {
+                                  getUUIDsFromUsernames(usernames.map { it.first }).forEach {

Member Author

My-Name-Is-Jeff Feb 9, 2024

would it be better to directly emit the API response?

Sychic reviewed

View reviewed changes

Member

Sychic left a comment

Overall looks fine but a few concerns.

src/main/kotlin/gg/skytils/skytilsmod/utils/MojangUtil.kt

+                      val username = name.lowercase()
+                      usernameQueue.emit(username to System.currentTimeMillis())
+                      return uuidFlow.first { it.first == username }.second

Member

Sychic Feb 9, 2024

It should still emit. Only StateFlow will disregard repeated consecutive elements.

src/main/kotlin/gg/skytils/skytilsmod/utils/MojangUtil.kt

+                          val usernames = ArrayDeque<Pair<String, Long>>(10)
+                          usernameQueue.collect { name ->
+                              usernames.add(name)
+                              if (usernames.size >= 10 || usernames.isNotEmpty() && System.currentTimeMillis() - usernames.first().second >= 3000L) {

Member

Sychic Feb 9, 2024

If you're trying to create what is effectively a bucket ratelimiter, there are probably better ways to handle this (see Levelhead). Otherwise, you'd probably want your usernameQueue flow to have a replay cache (and buffer) of 10 so you can access queued values more than once.
Also, It'd probably be nice to add qualifying parenthesis around the second condition because it's not very straightforward from a glance.

src/main/kotlin/gg/skytils/skytilsmod/utils/MojangUtil.kt

Comment on lines +76 to +81

+                  suspend fun queueUsernameForUUID(name: String): UUID? {
+                      val username = name.lowercase()
+                      usernameQueue.emit(username to System.currentTimeMillis())
+                      return uuidFlow.first { it.first == username }.second
+                  }

Member

Sychic Feb 9, 2024

Is there any guarantee that the username will be resolved? Afaict you need to pray someone else calls MojangUtil#getUsernameFromUUID.

My-Name-Is-Jeff marked this pull request as draft

February 29, 2024 23:50

My-Name-Is-Jeff force-pushed the dev branch 3 times, most recently from 142a4c5 to fdb45e9 Compare

March 13, 2024 20:12

My-Name-Is-Jeff force-pushed the dev branch from 9df2de8 to aa9199f Compare

April 20, 2024 18:39

My-Name-Is-Jeff force-pushed the dev branch from 45b16c7 to 856ded9 Compare

May 17, 2024 08:20

My-Name-Is-Jeff force-pushed the dev branch 4 times, most recently from 55917b7 to 9056242 Compare

August 9, 2024 03:22

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels