Add /sf dump command with blockstorage initially #3738

Sefiraat · 2023-01-06T14:35:36Z

Description

Adds a new command /sf dump . This command just collects the blocks held in BlockStorage into a single file denoting the item ID and the amount held in storage.

Recently many servers have had issues with BlockStorage and a simple fix (for some) has been to show them just how many of a certain block they have to allow them to triage and tackle the amount. This has been very positive for servers with ExoticGarden where they have had upwards of millions of several of plants which, when they purged them, released a not insignificant amount of RAM.

Until now I have just offered this command as a separate JAR to server owners having issues and worked through the resolution with them but I think it makes sense to have the command here, regardless of the few use-cases.

Proposed changes

Add a new command that dumps contents into a file.

Related Issues (if applicable)

Checklist

I have fully tested the proposed changes and promise that they will not break everything into chaos.
I have also tested the proposed changes in combination with various popular addons and can confirm my changes do not break them.
I have made sure that the proposed changes do not break compatibility across the supported Minecraft versions (1.14.* - 1.19.*).
I followed the existing code standards and didn't mess up the formatting.
I did my best to add documentation to any public classes or methods I added.
I have added Nonnull and Nullable annotations to my methods to indicate their behaviour for null values
I added sufficient Unit Tests to cover my code.

WalshyDev

I kinda feel like this should be under a dump command so we can add more to it...

...n/java/io/github/thebusybiscuit/slimefun4/core/commands/subcommands/BlockStorageCommand.java

Sefiraat · 2023-01-06T17:58:30Z

I'm not a fan of the tab completer, but I think that thing may need some work in a separate PR, imo.

J3fftw1

The file isnt stored in Slimefun right but in the folder Slimefun\
Also wouldnt a dump folder be even better?

Sefiraat · 2023-01-06T18:05:13Z

The file isnt stored in Slimefun right but in the folder Slimefun
Also wouldnt a dump folder be even better?

Ah yeah it does make sense to have a dumps folder, and I think I’ll datetimestamp the file as well.

J3fftw1 · 2023-01-06T18:06:37Z

The file isnt stored in Slimefun right but in the folder Slimefun
Also wouldnt a dump folder be even better?

Ah yeah it does make sense to have a dumps folder, and I think I’ll datetimestamp the file as well.

If you are making changes anyways, mind adding the date to the top of the file aswell it helps to see how recent the files are when people send them in pastebins

Sefiraat · 2023-01-06T18:13:22Z

YARGH

booo

J3fftw1

LGTM, even though me approving doesnt matter

src/main/java/io/github/thebusybiscuit/slimefun4/core/commands/SlimefunTabCompleter.java

src/main/java/io/github/thebusybiscuit/slimefun4/core/commands/subcommands/DumpCommand.java

Sefiraat · 2023-01-07T08:48:56Z

All done :)

TheBusyBiscuit

Looks pretty good, I like it much better as a general /sf dump command that we can expand upon!

TheBusyBiscuit · 2023-01-07T12:05:19Z

src/main/java/io/github/thebusybiscuit/slimefun4/core/commands/subcommands/DumpCommand.java

+ */
+class DumpCommand extends SubCommand {
+
+    private static final String PATH = Paths.get(Slimefun.instance().getDataFolder().getAbsolutePath(), "dumps").toString();


No reason for this to be static as this should be a singleton class.

TheBusyBiscuit · 2023-01-07T12:06:00Z

src/main/java/io/github/thebusybiscuit/slimefun4/core/commands/subcommands/DumpCommand.java

+
+    @ParametersAreNonnullByDefault
+    private void createDump(CommandSender sender, String filePrefix, Supplier<List<String>> dump) {
+        String dateTimeStamp = new SimpleDateFormat("'_'yyyyMMddHHmm'.txt'").format(new Date());


Store the SimpleDateFormat as a class member, no need to instantiate it everytime.

TheBusyBiscuit · 2023-01-07T12:06:34Z

src/main/java/io/github/thebusybiscuit/slimefun4/core/commands/subcommands/DumpCommand.java

+        }
+    }
+
+    private List<String> dumpBlockStorage() {


Suggested change

private List<String> dumpBlockStorage() {

private @Nonnull List<String> dumpBlockStorage() {

TheBusyBiscuit · 2023-01-07T12:07:23Z

src/main/resources/languages/en/messages.yml

@@ -39,6 +39,10 @@ commands:
    running: '&7Running debug mode with test: &6%test%'
    disabled: '&7Disabled debug mode.'

+  dump:
+    description: 'Contains commands to dump data to files'


Might want to specify that it is a dev/debug tool

Suggested change

description: 'Contains commands to dump data to files'

description: 'Debugging tool to dump data to files'

WalshyDev · 2023-01-07T16:08:57Z

src/main/java/io/github/thebusybiscuit/slimefun4/core/commands/subcommands/DumpCommand.java

+        }
+
+        try (BufferedWriter writer = new BufferedWriter(new FileWriter(fullPath))) {
+            writer.write("Dump created at: " + dateTimeStamp + "\n");


Kinda weird to have Dump created at: _20220101.txt. This should probably be a more pretty date anyway

Phoenix-Starlight · 2023-01-07T18:57:56Z

src/main/java/io/github/thebusybiscuit/slimefun4/core/commands/subcommands/DumpCommand.java

+
+    @ParametersAreNonnullByDefault
+    private void createDump(CommandSender sender, String filePrefix, Supplier<List<String>> dump) {
+        String dateTimeStamp = new SimpleDateFormat("'_'yyyyMMddHHmm'.txt'").format(new Date());


Suggested change

String dateTimeStamp = new SimpleDateFormat("'_'yyyyMMddHHmm'.txt'").format(new Date());

String dateTimeStamp = new SimpleDateFormat("'_'yyyy-MM-dd-HH:mm'.txt'").format(new Date());

Readability.

Phoenix-Starlight · 2023-01-07T19:11:52Z

src/main/java/io/github/thebusybiscuit/slimefun4/core/commands/subcommands/DumpCommand.java

+import java.io.File;
+import java.io.FileWriter;
+import java.io.IOException;
+import java.nio.file.Path;


Suggested change

import java.nio.file.Path;

Path doesn't seem to be needed.

J3fftw1 · 2023-07-29T16:53:33Z

Messaged @Sefiraat privately if he still wants to work on it.
Closing it later if no response

Add /sf blockstorage command

1509619

Sefiraat requested a review from a team as a code owner January 6, 2023 14:35

WalshyDev previously requested changes Jan 6, 2023

View reviewed changes

...n/java/io/github/thebusybiscuit/slimefun4/core/commands/subcommands/BlockStorageCommand.java Outdated Show resolved Hide resolved

...n/java/io/github/thebusybiscuit/slimefun4/core/commands/subcommands/BlockStorageCommand.java Outdated Show resolved Hide resolved

Move to /sf dump, remove comment and make async

17f6089

Sefiraat requested a review from WalshyDev January 6, 2023 17:58

J3fftw1 suggested changes Jan 6, 2023

View reviewed changes

Change class name

e1fb324

Sefiraat added 2 commits January 6, 2023 18:28

Move to a dedicated folder, timestamped name and headers

2b08931

Generalised methods for future dump-types, sort output

87339ee

Sefiraat requested a review from J3fftw1 January 6, 2023 19:23

J3fftw1 previously approved these changes Jan 6, 2023

View reviewed changes

Sefiraat requested a review from svr333 January 6, 2023 19:35

WalshyDev requested changes Jan 7, 2023

View reviewed changes

Implementing review

99f053e

Sefiraat dismissed J3fftw1’s stale review via 99f053e January 7, 2023 08:48

Sefiraat requested a review from WalshyDev January 7, 2023 08:48

TheBusyBiscuit added the 🎈 Feature This Pull Request adds a new feature. label Jan 7, 2023

TheBusyBiscuit requested changes Jan 7, 2023

View reviewed changes

TheBusyBiscuit assigned TheBusyBiscuit, WalshyDev and svr333 Jan 7, 2023

Sefiraat changed the title ~~Add /sf blockstorage command~~ Add /sf dump command with blockstorage initially Jan 7, 2023

WalshyDev reviewed Jan 7, 2023

View reviewed changes

Phoenix-Starlight suggested changes Jan 7, 2023

View reviewed changes

TheBusyBiscuit added the ⏰ Waiting for response We are waiting for a response. label Mar 25, 2023

J3fftw1 added the Stale Marks a PR as stale. label Jul 29, 2023

J3fftw1 closed this Sep 16, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add /sf dump command with blockstorage initially #3738

Add /sf dump command with blockstorage initially #3738

Sefiraat commented Jan 6, 2023 •

edited

Loading

WalshyDev left a comment

Sefiraat commented Jan 6, 2023 •

edited

Loading

J3fftw1 left a comment •

edited

Loading

Sefiraat commented Jan 6, 2023

J3fftw1 commented Jan 6, 2023

Sefiraat commented Jan 6, 2023

J3fftw1 left a comment

Sefiraat commented Jan 7, 2023

TheBusyBiscuit left a comment

TheBusyBiscuit Jan 7, 2023

TheBusyBiscuit Jan 7, 2023

TheBusyBiscuit Jan 7, 2023

TheBusyBiscuit Jan 7, 2023

WalshyDev Jan 7, 2023

Phoenix-Starlight Jan 7, 2023

Phoenix-Starlight Jan 7, 2023

J3fftw1 commented Jul 29, 2023

	private List<String> dumpBlockStorage() {
	private @Nonnull List<String> dumpBlockStorage() {

	description: 'Contains commands to dump data to files'
	description: 'Debugging tool to dump data to files'

	String dateTimeStamp = new SimpleDateFormat("'_'yyyyMMddHHmm'.txt'").format(new Date());
	String dateTimeStamp = new SimpleDateFormat("'_'yyyy-MM-dd-HH:mm'.txt'").format(new Date());

Add /sf dump command with blockstorage initially #3738

Add /sf dump command with blockstorage initially #3738

Conversation

Sefiraat commented Jan 6, 2023 • edited Loading

Description

Proposed changes

Related Issues (if applicable)

Checklist

WalshyDev left a comment

Choose a reason for hiding this comment

Sefiraat commented Jan 6, 2023 • edited Loading

J3fftw1 left a comment • edited Loading

Choose a reason for hiding this comment

Sefiraat commented Jan 6, 2023

J3fftw1 commented Jan 6, 2023

Sefiraat commented Jan 6, 2023

J3fftw1 left a comment

Choose a reason for hiding this comment

Sefiraat commented Jan 7, 2023

TheBusyBiscuit left a comment

Choose a reason for hiding this comment

TheBusyBiscuit Jan 7, 2023

Choose a reason for hiding this comment

TheBusyBiscuit Jan 7, 2023

Choose a reason for hiding this comment

TheBusyBiscuit Jan 7, 2023

Choose a reason for hiding this comment

TheBusyBiscuit Jan 7, 2023

Choose a reason for hiding this comment

WalshyDev Jan 7, 2023

Choose a reason for hiding this comment

Phoenix-Starlight Jan 7, 2023

Choose a reason for hiding this comment

Phoenix-Starlight Jan 7, 2023

Choose a reason for hiding this comment

J3fftw1 commented Jul 29, 2023

Sefiraat commented Jan 6, 2023 •

edited

Loading

Sefiraat commented Jan 6, 2023 •

edited

Loading

J3fftw1 left a comment •

edited

Loading