Configuration parsing errors

Question

Configuration parsing errors

SlimeDog opened this issue 3 years ago · 23 comments

SlimeDog commented 3 years ago

Type of bug

Error in console

TabList version

version TabList [15:31:15] [Server thread/INFO]: TabList version 5.6.0
[15:31:15] [Server thread/INFO]: An ultimate animated tablist
[15:31:15] [Server thread/INFO]: Author: montlikadani

Software version

version [15:30:54] [Server thread/INFO]: This server is running CraftBukkit version 3369-Spigot-8965a50-2a2caa7 (MC: 1.18.1) (Implementing API version 1.18.1-R0.1-SNAPSHOT)
[15:30:54] [Server thread/INFO]: You are running the latest version

Relevant plugins

Irrelevant, but available on request.

Console error (if applicable)

[15:21:29] [Server thread/INFO]: [TabList] Enabling TabList v5.6.0
[15:21:29] [Server thread/ERROR]: Error occurred while enabling TabList v5.6.0 (Is it up to date?)
java.lang.StringIndexOutOfBoundsException: String index out of range: 0
        at java.lang.StringLatin1.charAt(StringLatin1.java:48) ~[?:?]
        at java.lang.String.charAt(String.java:1512) ~[?:?]
        at hu.montlikadani.tablist.config.CommentedConfig.insertComments(CommentedConfig.java:81) ~[?:?]
        at hu.montlikadani.tablist.config.CommentedConfig.save(CommentedConfig.java:62) ~[?:?]
        at hu.montlikadani.tablist.config.CommentedConfig.save(CommentedConfig.java:41) ~[?:?]
        at hu.montlikadani.tablist.config.constantsLoader.ConfigValues.loadValues(ConfigValues.java:261) ~[?:?]
        at hu.montlikadani.tablist.config.Configuration.loadFiles(Configuration.java:48) ~[?:?]
        at hu.montlikadani.tablist.TabList.onEnable(TabList.java:86) ~[?:?]
        at org.bukkit.plugin.java.JavaPlugin.setEnabled(JavaPlugin.java:264) ~[spigot-api-1.18.1-R0.1-SNAPSHOT.jar:?]
        at org.bukkit.plugin.java.JavaPluginLoader.enablePlugin(JavaPluginLoader.java:342) ~[spigot-api-1.18.1-R0.1-SNAPSHOT.jar:?]
        at org.bukkit.plugin.SimplePluginManager.enablePlugin(SimplePluginManager.java:480) ~[spigot-api-1.18.1-R0.1-SNAPSHOT.jar:?]
        at org.bukkit.craftbukkit.v1_18_R1.CraftServer.enablePlugin(CraftServer.java:526) ~[spigot-1.18.1-R0.1-SNAPSHOT.jar:3369-Spigot-8965a50-2a2caa7]
        at org.bukkit.craftbukkit.v1_18_R1.CraftServer.enablePlugins(CraftServer.java:440) ~[spigot-1.18.1-R0.1-SNAPSHOT.jar:3369-Spigot-8965a50-2a2caa7]
        at net.minecraft.server.MinecraftServer.loadWorld0(MinecraftServer.java:612) ~[spigot-1.18.1-R0.1-SNAPSHOT.jar:3369-Spigot-8965a50-2a2caa7]
        at net.minecraft.server.MinecraftServer.loadLevel(MinecraftServer.java:414) ~[spigot-1.18.1-R0.1-SNAPSHOT.jar:3369-Spigot-8965a50-2a2caa7]
        at net.minecraft.server.dedicated.DedicatedServer.e(DedicatedServer.java:262) ~[spigot-1.18.1-R0.1-SNAPSHOT.jar:3369-Spigot-8965a50-2a2caa7]
        at net.minecraft.server.MinecraftServer.w(MinecraftServer.java:994) ~[spigot-1.18.1-R0.1-SNAPSHOT.jar:3369-Spigot-8965a50-2a2caa7]
        at net.minecraft.server.MinecraftServer.lambda$0(MinecraftServer.java:304) ~[spigot-1.18.1-R0.1-SNAPSHOT.jar:3369-Spigot-8965a50-2a2caa7]
        at java.lang.Thread.run(Thread.java:833) [?:?]

TabList configuration files

No change.

Bug description

Just a heads-up.

Spigot 1.18.1-3369 introduced new configuration management.

On server start-up (ie, on plugin enable), the above error occurs. This error did not occur previously.

SlimeDog · Answer 1 · 2021-12-21T01:28:10.000Z

config.yml @ https://pastebin.com/enQ6dBmy
which is not much different from the default.

A bad side effect: on error, TabList deletes and rewrites config.yml, losing any changes. Of course, I have backups, but still.

SlimeDog · Answer 2 · 2021-12-21T01:52:48.000Z

The same content does not fail on Paper 1.18.1-84, which presumably has the same methods from upstream.

SlimeDog · Answer 3 · 2021-12-21T01:46:05.000Z

The default config.yml fails similarly.

montlikadani · Answer 4 · 2021-12-21T14:36:33.000Z

Thanks for your report. The above commit will fixes this issue.

SlimeDog · Answer 5 · 2021-12-21T15:05:27.000Z

TabList-5.6.0-b261

Not a good solution. It duplicates may comments and adds blank lines (actually two spaces and newline) as it rewrites config.yml (why does it rewrite it, anyway?).

Original starts

hook:
  # Hook to PlaceholderAPI to use custom placeholders.
  placeholderapi: true

# Fake players that can be added to the player list.
fake-players:
  enabled: false

  # Do we count the added fake players to the %online-players% placeholder?
  count-fake-players-to-online-players: false
  
# If enabled, the gray color will not appear to other players when the player's game mode is spectator.
# The gray color will only show for the spectator player.
# Requires ProtocolLib!
remove-gray-color-from-tab-in-spectator: false
  
# true - does not count vanished players in %online-players% placeholder.
# Requires Essentials, SuperVanish, PremiumVanish or CMI plugin!
ignore-vanished-players-in-online-players: false

# true - count vanished staff in %staff-online% placeholder,
# but they need to have "tablist.onlinestaff" permission set.
# false - does not count vanished staff in the %staff-online% placeholder
# Requires Essentials, SuperVanish, PremiumVanish or CMI plugin!
count-vanished-staffs: true

# Hide player from player list when a player is AFK?
# Requires Essentials or CMI plugin!
hide-player-from-tab-when-afk: false

# Hide all players from the player list?
# This removes all players from the player list, but the player that has the
# group set is retained as it is not changed during removal, so your group
# will be restored if this option is disabled.
# Requires ProtocolLib to fix view distance issue! (https://github.com/montlikadani/TabList/issues/147)
hide-players-from-tablist: false

# Different player list in different world.
per-world-player-list:
  enabled: false
...

becomes with the addition of 114 extra lines

hook:
  
  # Hook to PlaceholderAPI to use custom placeholders.

  # Hook to PlaceholderAPI to use custom placeholders.
  placeholderapi: true
  

# Fake players that can be added to the player list.
fake-players:
  enabled: false
  
  # Do we count the added fake players to the %online-players% placeholder?

  # Do we count the added fake players to the %online-players% placeholder?
  count-fake-players-to-online-players: false


# If enabled, the gray color will not appear to other players when the player's game mode is spectator.
# The gray color will only show for the spectator player.
# Requires ProtocolLib! 
remove-gray-color-from-tab-in-spectator: false


# true - does not count vanished players in %online-players% placeholder.
# Requires Essentials, SuperVanish, PremiumVanish or CMI plugin!
ignore-vanished-players-in-online-players: false


# true - count vanished staff in %staff-online% placeholder,
# but they need to have "tablist.onlinestaff" permission set.
# false - does not count vanished staff in the %staff-online% placeholder
# Requires Essentials, SuperVanish, PremiumVanish or CMI plugin!
count-vanished-staffs: true


# Hide player from player list when a player is AFK?
# Requires Essentials or CMI plugin! 
hide-player-from-tab-when-afk: false
  

# Hide all players from the player list?
# This removes all players from the player list, but the player that has the
# group set is retained as it is not changed during removal, so your group
# will be restored if this option is disabled.
# Requires ProtocolLib to fix view distance issue! (https://github.com/montlikadani/TabList/issues/147)
hide-players-from-tablist: false

    
# Different player list in different world.
per-world-player-list:
  enabled: false
...

SlimeDog · Answer 6 · 2021-12-21T15:13:19.000Z

Shouldn't this issue be fixed more generally (like in Spigot) rather than in each plugin that encounters it?

montlikadani · Answer 7 · 2021-12-21T15:53:06.000Z

Since this is a "fresh" implementation in the upstream (Spigot), it probably is. After a thorough examination and testing, it appears that the saveToString method does not gather the contents of the file into a single text (String) in the reading order of the file (so from top to bottom). prior to this commit, writing comments to the file worked properly.

I simply printed this saveToString method out to the console as proof.
This is the current return value on the upstream (Spigot) and with the last commit:

	     use-as-whitelist: false
	     list:
	     - myWorldWithUpper
	
	   # Automatically add groups from another plugins to the tablist groups.yml on every reload?
	   # If a plugin does not support Vault, it will not be added.
	
	     # Automatically add groups from another plugins to the tablist groups.yml on every reload?
	   # If a plugin does not support Vault, it will not be added.
	   sync-plugins-groups-with-tablist: false

While in 1.17

	 #
	 # Fake players that can be added to the player list.
	 hook:
	   placeholderapi: true
	 fake-players:
	   enabled: false
	   count-fake-players-to-online-players: false

So this is an upstream problem, especially with the saveToString method. ? (Edit: unsure)

SlimeDog · Answer 8 · 2021-12-21T16:02:18.000Z

You understand this much better than I. Please file an issue with Spigot.

SlimeDog · Answer 9 · 2021-12-21T16:04:59.000Z

BTW, this affects only one other configuration file, of 165+ plugins on our test servers. What is different about how configuration files are handled by TabList?

montlikadani · Answer 10 · 2021-12-21T16:22:16.000Z

Previously, it was not possible to save the comments in the configuration (with # character) above a specific option. I implemented a way to save these comments, each time the file is reloaded, the contents of the file will be saved (cached) and deleted, to remove the non-existent settings or invalid entries, then the cached content within the resource will be put again, including the comments into the file. These comments have different indexes for each setting, so they are not lost when reloading. But now that the upstream has again made a configuration change without running a test, it will break.

SlimeDog · Answer 11 · 2021-12-21T16:35:19.000Z

I manage my configuration files very carefully. I appreciate that you implemented your own methods, but if nothing substantive changes in the configuration -- no new or outdated nodes -- there is no reason to rewrite it.

I would prefer to be warned if something isn't right, so that I can fix it myself. I appreciate that many people do not check for warnings and errors in the console/log, but I do.

SlimeDog · Answer 12 · 2021-12-22T00:30:56.000Z

You might want to look at https://hub.spigotmc.org/jira/browse/SPIGOT-3247

montlikadani · Answer 13 · 2021-12-22T12:13:31.000Z

I reopen and keep opened while this issue fixed in upstream or in the source of TL.

Edit: Did the console error fixed that you reported before?

SlimeDog · Answer 14 · 2021-12-22T20:45:28.000Z

Did the console error fixed that you reported before?

Yes, the console error was resolved, but the mangled file remains. I have reverted to Spigot 1.18.1-3368 and TabList 5.6.0-b253 (equivalent to the 5.6.0 release) until this issue is resolved.

SlimeDog · Answer 15 · 2021-12-23T01:31:53.000Z

On Spigot 1.18.1-3372, which reinvigorated some removed variables (but deprecated them), on server start-up (ie., TabList enable) an error is thrown

[17:21:19] [Server thread/INFO]: [TabList] Enabling TabList v5.6.0
[17:21:19] [Server thread/ERROR]: Error occurred while enabling TabList v5.6.0 (Is it up to date?)
java.lang.StringIndexOutOfBoundsException: String index out of range: 0
        at java.lang.StringLatin1.charAt(StringLatin1.java:48) ~[?:?]
        at java.lang.String.charAt(String.java:1512) ~[?:?]
        at hu.montlikadani.tablist.config.CommentedConfig.insertComments(CommentedConfig.java:81) ~[?:?]
        at hu.montlikadani.tablist.config.CommentedConfig.save(CommentedConfig.java:62) ~[?:?]
        at hu.montlikadani.tablist.config.CommentedConfig.save(CommentedConfig.java:41) ~[?:?]
        at hu.montlikadani.tablist.config.constantsLoader.ConfigValues.loadValues(ConfigValues.java:261) ~[?:?]
        at hu.montlikadani.tablist.config.Configuration.loadFiles(Configuration.java:48) ~[?:?]
        at hu.montlikadani.tablist.TabList.onEnable(TabList.java:86) ~[?:?]
        at org.bukkit.plugin.java.JavaPlugin.setEnabled(JavaPlugin.java:264) ~[spigot-api-1.18.1-R0.1-SNAPSHOT.jar:?]
        at org.bukkit.plugin.java.JavaPluginLoader.enablePlugin(JavaPluginLoader.java:342) ~[spigot-api-1.18.1-R0.1-SNAPSHOT.jar:?]
        at org.bukkit.plugin.SimplePluginManager.enablePlugin(SimplePluginManager.java:480) ~[spigot-api-1.18.1-R0.1-SNAPSHOT.jar:?]
        at org.bukkit.craftbukkit.v1_18_R1.CraftServer.enablePlugin(CraftServer.java:526) ~[spigot-1.18.1-R0.1-SNAPSHOT.jar:3372-Spigot-8965a50-c59b0ca]
        at org.bukkit.craftbukkit.v1_18_R1.CraftServer.enablePlugins(CraftServer.java:440) ~[spigot-1.18.1-R0.1-SNAPSHOT.jar:3372-Spigot-8965a50-c59b0ca]
        at net.minecraft.server.MinecraftServer.loadWorld0(MinecraftServer.java:612) ~[spigot-1.18.1-R0.1-SNAPSHOT.jar:3372-Spigot-8965a50-c59b0ca]
        at net.minecraft.server.MinecraftServer.loadLevel(MinecraftServer.java:414) ~[spigot-1.18.1-R0.1-SNAPSHOT.jar:3372-Spigot-8965a50-c59b0ca]
        at net.minecraft.server.dedicated.DedicatedServer.e(DedicatedServer.java:262) ~[spigot-1.18.1-R0.1-SNAPSHOT.jar:3372-Spigot-8965a50-c59b0ca]
        at net.minecraft.server.MinecraftServer.w(MinecraftServer.java:994) ~[spigot-1.18.1-R0.1-SNAPSHOT.jar:3372-Spigot-8965a50-c59b0ca]
        at net.minecraft.server.MinecraftServer.lambda$0(MinecraftServer.java:304) ~[spigot-1.18.1-R0.1-SNAPSHOT.jar:3372-Spigot-8965a50-c59b0ca]
        at java.lang.Thread.run(Thread.java:833) [?:?]

montlikadani · Answer 16 · 2021-12-23T07:12:10.000Z

This is the same as you reported before.

SlimeDog · Answer 17 · 2021-12-23T07:34:21.000Z

Sorry, but this is with the Spigot version that supposedly reverted the missing variables.

montlikadani · Answer 18 · 2021-12-23T17:28:12.000Z

Right, the above commit will fixes this issue (tested now and works as before).

SlimeDog · Answer 19 · 2021-12-23T18:18:12.000Z

Thanks. On Spigot prior to the snakeyaml changes (which I reverted to, until the myriad Spigot snakeyaml issues get sorted), I get on server start-up

[09:56:22] [Server thread/WARN]: java.lang.NoSuchMethodException: org.bukkit.configuration.file.YamlConfigurationOptions.parseComments(boolean)
[09:56:22] [Server thread/WARN]: 	at java.base/java.lang.Class.getDeclaredMethod(Class.java:2675)
[09:56:22] [Server thread/WARN]: 	at hu.montlikadani.tablist.config.constantsLoader.ConfigValues.loadValues(ConfigValues.java:41)
[09:56:22] [Server thread/WARN]: 	at hu.montlikadani.tablist.config.Configuration.loadFiles(Configuration.java:48)
[09:56:22] [Server thread/WARN]: 	at hu.montlikadani.tablist.TabList.onEnable(TabList.java:86)
[09:56:22] [Server thread/WARN]: 	at org.bukkit.plugin.java.JavaPlugin.setEnabled(JavaPlugin.java:264)
[09:56:22] [Server thread/WARN]: 	at org.bukkit.plugin.java.JavaPluginLoader.enablePlugin(JavaPluginLoader.java:342)
[09:56:22] [Server thread/WARN]: 	at org.bukkit.plugin.SimplePluginManager.enablePlugin(SimplePluginManager.java:480)
[09:56:22] [Server thread/WARN]: 	at org.bukkit.craftbukkit.v1_18_R1.CraftServer.enablePlugin(CraftServer.java:526)
[09:56:22] [Server thread/WARN]: 	at org.bukkit.craftbukkit.v1_18_R1.CraftServer.enablePlugins(CraftServer.java:440)
[09:56:22] [Server thread/WARN]: 	at net.minecraft.server.MinecraftServer.loadWorld0(MinecraftServer.java:612)
[09:56:22] [Server thread/WARN]: 	at net.minecraft.server.MinecraftServer.loadLevel(MinecraftServer.java:414)
[09:56:22] [Server thread/WARN]: 	at net.minecraft.server.dedicated.DedicatedServer.e(DedicatedServer.java:262)
[09:56:22] [Server thread/WARN]: 	at net.minecraft.server.MinecraftServer.w(MinecraftServer.java:994)
[09:56:22] [Server thread/WARN]: 	at net.minecraft.server.MinecraftServer.lambda$0(MinecraftServer.java:304)
[09:56:22] [Server thread/WARN]: 	at java.base/java.lang.Thread.run(Thread.java:833)

but TabList seems to work. So just a heads up, if that is unexpected.

montlikadani · Answer 20 · 2021-12-23T18:22:13.000Z

Yea, for this to resolve needs at least the newest Spigot build.

SlimeDog · Answer 21 · 2021-12-23T19:25:29.000Z

OK, great. Thanks for staying on top of it. Crazy.

SlimeDog · Answer 22 · 2021-12-29T16:23:35.000Z

Unfortunately, there is no evidence that Paper is going to incorporate the Spigot snakeyaml changes. :(

montlikadani · Answer 23 · 2021-12-29T16:30:46.000Z

Not yet, as they will wait until the reported issues are fixed. It is summarized in this comment.

Share to