Forms system by Defective4 · Pull Request #524 · Java-Discord/JavaBot

Defective4 · 2025-09-10T11:36:47Z

This pull request adds the forms system to the bot.
The forms can be attached to any of the bot's messages. Users can fill in a form by clicking on the button added to the message the form is attached. After doing so, the user is presented with a modal dialog containing up to 5 fields defined in the form.
Upon submission, the contents of the fields are sent to a dedicated channel (configurable per form).

Included in this PR are commands to create, manage, and customize forms.
Forms can also be configured to accept only one submission per user. This was achieved by keeping track of who had submitted the form before in the dedicated forms repository.

Below is a video showcasing how the system works, along with most of the commands:
~~link~~ (the link is broken by now)

I'm aware this can be improved in some areas. I'm looking forward to your reviews!

A command to attach form buttons to bot's messages Form data deserialization Store forms in database Use an array of form fields instead of a form data object Move `FormsRepository` and `FormField` to different packages Reading forms from database Open modals on form button interaction Log submissions in a configured channel Allow setting a custom submission message Use an *Empty* value if user ommits a field Ignore case when parsing form field text input styles Store forms' origin messages, their channels, and expiration date Form delete command autocompletion Form delete command Forms closing and reopening commands Form details command Form modification command Check if the form is not closed or expired on submission Reword expiration command parameter description Additional checks in all form commands Don't accept raw JSON data and don't immediately attach forms Added `add-field` form command Form field remove command Form show command Put a limit of 5 components for forms Allow field inserting Forms attach and detach commands Prevent removing the last field from an attached form Javadocs Remove redundant checks from form commands Move some common methods to the form interaction manager Added `hasExpired` method to `FormData` Add `onetime` form parameter Logging form submissions to the database Add a repository method to query forms for a specific `closed` state Include total submissions count in the form details message Additional null checks in the forms repository Prevent further submissions to one-time forms A command to export all form submissions Delete form submissions on form deletion Command to delete user's submissions Fix checkstyle violations

danthe1st

This is my initial review which is about the model and database.

...ava/net/discordjug/javabot/systems/staff_commands/forms/commands/AddFieldFormSubcommand.java

src/main/resources/database/migrations/09-08-2025_forms.sql

src/main/java/net/discordjug/javabot/systems/staff_commands/forms/model/FormData.java

src/main/java/net/discordjug/javabot/systems/staff_commands/forms/model/FormField.java

src/main/java/net/discordjug/javabot/systems/staff_commands/forms/model/FormUser.java

danthe1st

Round 2 of reviewing, FormInteractionManager, /form add-field, /form attach

src/main/java/net/discordjug/javabot/systems/staff_commands/forms/commands/FormCommand.java

...ava/net/discordjug/javabot/systems/staff_commands/forms/commands/AddFieldFormSubcommand.java

src/main/java/net/discordjug/javabot/systems/staff_commands/forms/FormInteractionManager.java

danthe1st

With this, most of the changed files should be reviewed.

TODO for myself: check with spotbugs

...n/java/net/discordjug/javabot/systems/staff_commands/forms/commands/CloseFormSubcommand.java

...ava/net/discordjug/javabot/systems/staff_commands/forms/commands/AddFieldFormSubcommand.java

.../net/discordjug/javabot/systems/staff_commands/forms/commands/RemoveFieldFormSubcommand.java

.../java/net/discordjug/javabot/systems/staff_commands/forms/commands/ReopenFormSubcommand.java

danthe1st · 2025-09-11T17:32:23Z

.../java/net/discordjug/javabot/systems/staff_commands/forms/commands/ReopenFormSubcommand.java

+		if (!form.isClosed()) {
+			event.reply("This form is already opened").setEphemeral(true).queue();
+			return;
+		}


Maybe also add an error if the form is expired? After all, there isn't much of a point in reopening an expired form...

danthe1st

This should be the last review of your initial version.
Overall, the structure is mostly good but there are quite a few things I found.
I think you could use JDA's capabilities more in some places and you are repeating yourself quite a bit between all of the subcommands. This can be refactored using a superclass for form subcommands that operate on a form. This would allow you using common handling for autocomplete, addition (the constructor in the superclass can accept FormRepository (if necessary), the description and the OptionDatas (or similar) of the subcommand) and extraction of the form-id (or form) argument and the loading of the FormData. If the FormData is present, you could call an abstract method, e.g. protected abstract execute(SlashCommandInteractionEvent event, FormData form)
This would also allow you using Optional#ifPresentOrElse for the FormData instead of Optional#get.

...in/java/net/discordjug/javabot/systems/staff_commands/forms/commands/ShowFormSubcommand.java

...iscordjug/javabot/systems/staff_commands/forms/commands/SubmissionsDeleteFormSubcommand.java

...iscordjug/javabot/systems/staff_commands/forms/commands/SubmissionsExportFormSubcommand.java

danthe1st

TODO for myself: test with native-image - there shouldn't be any issues but just in case...

danthe1st

Please still act on the other requested changes like unifying autocomplete.

src/main/resources/database/migrations/09-08-2025_forms.sql

danthe1st · 2025-09-17T16:38:48Z

src/main/resources/database/migrations/09-08-2025_forms.sql

+
+CREATE TABLE FORM_SUBMISSIONS (
+    ID BIGINT NOT NULL AUTO_INCREMENT,
+    MESSAGE_ID BIGINT NOT NULL,


If you are storing a message ID, is there a need to add a distinct ID for the primary key?

Right, I guess not

.../java/net/discordjug/javabot/systems/staff_commands/forms/commands/DeleteFormSubcommand.java

src/main/java/net/discordjug/javabot/systems/staff_commands/forms/dao/FormsRepository.java

src/main/java/net/discordjug/javabot/systems/staff_commands/forms/model/FormData.java

src/main/java/net/discordjug/javabot/systems/staff_commands/forms/model/FormField.java

src/main/java/net/discordjug/javabot/systems/staff_commands/forms/model/FormData.java

...iscordjug/javabot/systems/staff_commands/forms/commands/SubmissionsDeleteFormSubcommand.java

danthe1st · 2025-09-17T17:22:39Z

By the way, the last build failed because of checkstyle.

Defective4 · 2025-09-17T17:40:07Z

By the way, the last build failed because of checkstyle.

I know. I will take care of checkstyle once I'm done writing the actual code.

Signed-off-by: Defective <def3ctive4@gmail.com>

Defective4 · 2025-09-18T10:29:36Z

Also, please keep in mind that even though I'm pushing new commits, I'm still not done addressing most of the issues. I have a habit of pushing immediately after committing new changes to the code.

danthe1st · 2025-09-18T14:15:46Z

Also, please keep in mind that even though I'm pushing new commits, I'm still not done addressing most of the issues. I have a habit of pushing immediately after committing new changes to the code.

Just comment when you think I should re-review it.

Defective4 · 2026-03-16T14:51:18Z

Okay, the PR should be ready to re-review.
I might add a few new commits in the meantime if I find something.

danthe1st

Most of these comments are fairly minor details.
Overall, it looks pretty good.

danthe1st · 2026-03-16T16:25:50Z

...ava/net/discordjug/javabot/systems/staff_commands/forms/commands/AddFieldFormSubcommand.java

 		FormData form = formOpt.get();

-		if (form.getFields().size() >= 5) {
+		if (form.fields().size() >= 5) {


I think you could use Message.MAX_COMPONENT_COUNT for this.

danthe1st · 2026-03-16T16:33:09Z

...ava/net/discordjug/javabot/systems/staff_commands/forms/commands/AddFieldFormSubcommand.java

 						"Whether or not the user has to input data in this field. Default: false")
-				.addOption(OptionType.STRING, "style", "Input style. Default: SHORT", false, true)
-				.addOption(OptionType.STRING, "value", "Initial field value"));
+				.addOption(OptionType.STRING, FORM_STYLE_FIELD, "Input style. Default: SHORT", false, true)


I think there are only two possible styles. Hence, you could use OptionData#addOption to specify a predefined amount of options and Discord should ensure that only these options can be used.

danthe1st · 2026-03-16T16:35:05Z

.../java/net/discordjug/javabot/systems/staff_commands/forms/commands/AttachFormSubcommand.java

 /**
- * The `/form attach` command.
+ * The `/form attach` command. This command can be used to attach a form to an
+ * existing message. "Attaching" a form to message in this case mean that the


Grammar: "Attaching" a form to a message means

danthe1st · 2026-03-16T16:38:26Z

.../java/net/discordjug/javabot/systems/staff_commands/forms/commands/AttachFormSubcommand.java

-			}
-		});
+		String buttonLabel = event.getOption(FORM_BUTTON_LABEL_FIELD, "Submit", OptionMapping::getAsString);
+		net.dv8tion.jda.api.components.buttons.ButtonStyle style = event.getOption(FORM_BUTTON_STYLE_FIELD,


I think the fully qualified name is not necessary here.

danthe1st · 2026-03-16T16:39:25Z

.../java/net/discordjug/javabot/systems/staff_commands/forms/commands/AttachFormSubcommand.java

-						true)));
+				new OptionData(OptionType.STRING, FORM_BUTTON_LABEL_FIELD,
+						"Label of the submit button. Default is \"Submit\""),
+				new OptionData(OptionType.STRING, FORM_BUTTON_STYLE_FIELD, "Submit button style. Defaults to primary",


Given there is a limited amount of possibilities for this option, I think using OptionData#addChoice is better than autocomplete.

danthe1st · 2026-03-16T18:05:22Z

src/main/java/net/discordjug/javabot/systems/staff_commands/forms/dao/FormsRepository.java

+	public boolean removeField(FormData form, int index) {
+		List<FormField> fields = form.fields();
+		if (index < 0 || index >= fields.size()) return false;
+		return jdbcTemplate.update("delete from `form_fields` where `id` = ?", fields.get(index).id()) > 0;


This needs to check the form ID as well, not just the field index.

danthe1st · 2026-03-16T18:14:32Z

src/main/java/net/discordjug/javabot/systems/staff_commands/forms/dao/FormsRepository.java

The part about failing silently isn't really true any more with it returning a boolean.

By the way, you can use @CheckReturnValue if you want to make sure the return value is used.

danthe1st · 2026-03-16T18:20:58Z

src/main/java/net/discordjug/javabot/systems/staff_commands/forms/model/FormData.java

-		return messageChannel != null && messageId != null;
+	/**
+	 * Get information about the form's attachment state. If the form is attached to
+	 * a message, this method will return a non-empty optional containin information


Typo: containing

danthe1st · 2026-03-16T18:26:37Z

src/main/java/net/discordjug/javabot/systems/staff_commands/forms/model/FormUser.java

-	}
+public record FormUser(long id, String username) {
+
+//	@Override


I think this commented out code should be removed.

danthe1st · 2026-03-16T18:29:00Z

src/main/java/net/discordjug/javabot/systems/staff_commands/forms/FormInteractionManager.java

+		form.getAttachmentInfo().ifPresent(info -> {
+			long messageChannelId = info.messageChannelId();
+			long messageId = info.messageId();
+			TextChannel formChannel = guild.getTextChannelById(messageChannelId);


As mentioned before, this may not be a text channel.

Defective4 · 2026-03-16T19:09:23Z

Okay, I've committed changes addressing all of the new review comments, except for this one

Defective4 · 2026-03-16T20:07:20Z

If I didn't omit anything, I've addressed all of the old issues. I reacted with 👍 to every comment I've seen. The PR should be ready for review.

Defective4 requested a review from a team as a code owner September 10, 2025 11:36

danthe1st requested changes Sep 10, 2025

View reviewed changes

danthe1st requested changes Sep 11, 2025

View reviewed changes

danthe1st reviewed Sep 11, 2025

View reviewed changes

Defective4 added 8 commits September 17, 2025 15:58

Store form fields in a separate table

bdf0b1a

Use default values for all NOT NULL fields

b62574d

Store form's message channel and id as longs instead of Strings

2c97172

Changed submissions table structure to use unique ids

7db911a

Correct FormsRepository javadoc

e2c6372

Adjustments to the FormsRepository class

7cb72ed

Fix javadoc spelling mistakes

61d7e36

Make the FormField into a record

21d9a42

danthe1st requested changes Sep 17, 2025

View reviewed changes

Convert FormData into a record and use Instants for expiration

3425fa0

Signed-off-by: Defective <def3ctive4@gmail.com>

Defective4 force-pushed the forms-feature branch from b1b596f to 3425fa0 Compare September 18, 2025 10:26

Defective4 added 4 commits September 20, 2025 11:01

Form field javadoc

fdd328e

Convert FormUser to a record

123282b

FormCommand javadoc

7fccf8e

Fix checkstyle

385820d

This was referenced Feb 15, 2026

unban form via API #533

Open

Mandatory job channel form #534

Open

Defective4 added 2 commits March 15, 2026 18:27

Merge branch 'Java-Discord:main' into forms-feature

2763a57

Migrate forms feature to new JDA and Java version

f6f2149

Defective4 added 9 commits March 16, 2026 01:14

Fix checkstyle errors

af0c407

Update form export subcommand javadoc

1e2e788

Use Map#forEach in form export subcommand

2ddea7d

Correct javadoc in forms repository

e2a54ab

Change components array in FormData to an unmodifiable list

fd0b13f

Use optional for form attachment info

f03aa15

Fix form submissions delete subcommand description

037061d

Add missing javadoc comments

cc20300

Resolve TODO comments in forms feature classes

40728f5

Defective4 requested a review from danthe1st March 16, 2026 14:51

Defective4 force-pushed the forms-feature branch from 992be05 to 06d724b Compare March 16, 2026 15:29

Extract subcommand field ids to constants

f43f7df

Defective4 force-pushed the forms-feature branch from 06d724b to f43f7df Compare March 16, 2026 15:31

Defective4 added 2 commits March 16, 2026 16:34

Fix an issue with form fields not being added to the modal

4ef2c89

Improve form commands descriptions and add missing javadocs

d03f90d

danthe1st requested changes Mar 16, 2026

View reviewed changes

Make changes requested in the review

15dee0b

Defective4 added 5 commits March 16, 2026 20:43

Use DateTimeFormatter in forms

ed3b3d3

Change time format in forms

1786843

Change the button "mapping" method name

ac9e2ff

Log failed form submission attempts

90e8a37

Log form submission errors

00102a1

Defective4 force-pushed the forms-feature branch from c080ab8 to 00102a1 Compare March 16, 2026 20:01

Defective4 added 3 commits March 16, 2026 21:02

Fix javadoc type in form interaction manager

23a38e8

Rename createFormModal

fa3c43e

Fix checkstyle errors

0a0c877

Defective4 requested a review from danthe1st March 16, 2026 20:07

Conversation

Defective4 commented Sep 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

danthe1st 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!

danthe1st 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!

danthe1st 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!

Choose a reason for hiding this comment

Uh oh!

danthe1st 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!

danthe1st left a comment

Choose a reason for hiding this comment

Uh oh!

danthe1st left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

danthe1st commented Sep 17, 2025

Uh oh!

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

Uh oh!

Uh oh!

Defective4 commented Sep 18, 2025

Uh oh!

Defective4 commented Sep 10, 2025 •

edited

Loading

Defective4 commented Sep 17, 2025 •

edited

Loading

Defective4 commented Mar 16, 2026 •

edited

Loading

Defective4 commented Mar 16, 2026 •

edited

Loading