Upstream/LuckPerms
1
0
Fork 0
mirror of https://github.com/LuckPerms/LuckPerms.git synced 2024-11-24 03:25:19 +01:00
Code Issues Projects Releases Wiki Activity

Improve Vault sync lookup error message

Browse Source
This commit is contained in:
Luck 2021-03-04 14:58:00 +00:00
parent 2c636c5ac6
commit ba71345cbd
No known key found for this signature in database
GPG Key ID: EFA9B3EC5FD90F8B
2 changed files with 62 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
bukkit/src/main/java/me/lucko/luckperms/bukkit/vault/LuckPermsVaultPermission.java
View File

@ -113,15 +113,7 @@ public class LuckPermsVaultPermission extends AbstractVaultPermission {
// are we on the main thread?
if (!this.plugin.getBootstrap().isServerStarting() && this.plugin.getBootstrap().getServer().isPrimaryThread() && !this.plugin.getConfiguration().get(ConfigKeys.VAULT_UNSAFE_LOOKUPS)) {
throw new RuntimeException(
"The operation to lookup a UUID for '" + player + "' was cancelled by LuckPerms. This is NOT a bug. \n" +
"The lookup request was made on the main server thread. It is not safe to execute a request to \n" +
"load username data from the database in this context. \n" +
"If you are a plugin author, please either make your request asynchronously, \n" +
"or provide an 'OfflinePlayer' object with the UUID already populated. \n" +
"Alternatively, server admins can disable this catch by setting 'vault-unsafe-lookups' to true \n" +
"in the LP config, but should consider the consequences (lag) before doing so."
);
throw new ServerThreadLookupException(player);
}
// lookup a username from the database
@ -159,14 +151,7 @@ public class LuckPermsVaultPermission extends AbstractVaultPermission {
// are we on the main thread?
if (!this.plugin.getBootstrap().isServerStarting() && this.plugin.getBootstrap().getServer().isPrimaryThread() && !this.plugin.getConfiguration().get(ConfigKeys.VAULT_UNSAFE_LOOKUPS)) {
throw new RuntimeException(
"The operation to load user data for '" + uuid + "' was cancelled by LuckPerms. This is NOT a bug. \n" +
"The lookup request was made on the main server thread. It is not safe to execute a request to \n" +
"load data for offline players from the database in this context. \n" +
"If you are a plugin author, please consider making your request asynchronously. \n" +
"Alternatively, server admins can disable this catch by setting 'vault-unsafe-lookups' to true \n" +
"in the LP config, but should consider the consequences (lag) before doing so."
);
throw new ServerThreadLookupException(uuid);
}
// load an instance from the DB

60
bukkit/src/main/java/me/lucko/luckperms/bukkit/vault/ServerThreadLookupException.java Normal file
View File

@ -0,0 +1,60 @@
/*
* This file is part of LuckPerms, licensed under the MIT License.
*
* Copyright (c) lucko (Luck) <luck@lucko.me>
* Copyright (c) contributors
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package me.lucko.luckperms.bukkit.vault;
import java.util.UUID;
/**
* Exception thrown when an unsafe Vault request is made on the server thread.
*/
class ServerThreadLookupException extends RuntimeException {
private static String msg(String reason) {
return "A Vault API request has been made on the main server thread that LuckPerms cannot safely respond to.\n" +
"This is NOT a bug - please do not report it to LuckPerms.\n" +
"Instead, please carefully read the information given below.\n" +
"\n" +
"LuckPerms cannot respond to the request because to do so:\n" +
"- " + reason + "\n" +
"\n" +
"Performing this lookup on the main server thread would cause your server to lag.\n" +
"There are two solutions to this problem:\n" +
" a) Ask the author of the plugin making the request to perform Vault calls for\n" +
" offline players \"asynchronously\" (using the scheduler). Additionally, prefer\n" +
" using the methods that accept 'Player' or 'OfflinePlayer' instead of usernames.\n" +
" b) As a server admin, you can disable this exception by setting 'vault-unsafe-lookups'\n" +
" to false in the LuckPerms configuration file. However, please use this only as\n" +
" a last resort.";
}
ServerThreadLookupException(String player) {
super(msg("it needs to lookup a UUID for '" + player + "' (an offline player)"));
}
ServerThreadLookupException(UUID uniqueId) {
super(msg("it needs to lookup user data for '" + uniqueId + "' (an offline player) from the database"));
}
}