Skip to content

Commit f64ccde

Browse files
fix(build): resolve queue dependency analysis findings
Prepare fallible listener collaborators before initializing the extensible listener, while retaining dynamic configuration lookups. Cover construction and reload behavior. Return defensive test-player lists and document the two intentional mutable configuration fixtures with narrowly scoped annotations.
1 parent dcb5285 commit f64ccde

6 files changed

Lines changed: 77 additions & 21 deletions

File tree

‎shared/src/main/java/net/pistonmaster/pistonqueue/shared/queue/QueueListenerShared.java‎

Lines changed: 29 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@
4141
import net.pistonmaster.pistonqueue.shared.queue.logic.UsernameValidator;
4242
import net.pistonmaster.pistonqueue.shared.wrapper.PlayerWrapper;
4343

44+
import java.util.Objects;
4445
import java.util.Set;
4546
import java.util.concurrent.ConcurrentHashMap;
4647

@@ -56,26 +57,45 @@ public abstract class QueueListenerShared {
5657
private final KickEventHandler kickEventHandler;
5758

5859
protected QueueListenerShared(PistonQueuePlugin plugin) {
59-
this.plugin = plugin;
60-
Config config = currentConfig();
61-
this.serverStatusManager = new ServerStatusManager(this::currentConfig);
62-
this.queueEnvironment = new QueueEnvironment(plugin, this::currentConfig, serverStatusManager::getOnlineServers);
63-
this.usernameValidator = new UsernameValidator(config);
64-
this.shadowBanKickHandler = new ShadowBanKickHandler(config);
60+
this(prepare(plugin));
61+
}
62+
63+
private QueueListenerShared(PreparedListener prepared) {
64+
this.plugin = prepared.plugin();
65+
this.serverStatusManager = prepared.serverStatusManager();
66+
this.queueEnvironment = prepared.queueEnvironment();
67+
this.queuePlacementCoordinator = prepared.queuePlacementCoordinator();
68+
this.queueMoveProcessor = prepared.queueMoveProcessor();
69+
this.usernameValidator = prepared.usernameValidator();
70+
this.shadowBanKickHandler = prepared.shadowBanKickHandler();
71+
this.kickEventHandler = prepared.kickEventHandler();
72+
}
73+
74+
private static PreparedListener prepare(PistonQueuePlugin plugin) {
75+
Objects.requireNonNull(plugin, "plugin");
76+
Config config = Objects.requireNonNull(plugin.getConfiguration(), "configuration");
77+
78+
ServerStatusManager serverStatusManager = new ServerStatusManager(plugin::getConfiguration);
79+
QueueEnvironment queueEnvironment = new QueueEnvironment(plugin, plugin::getConfiguration, serverStatusManager::getOnlineServers);
80+
UsernameValidator usernameValidator = new UsernameValidator(config);
81+
ShadowBanKickHandler shadowBanKickHandler = new ShadowBanKickHandler(config);
6582

6683
QueueServerSelector queueServerSelector = new QueueServerSelector(queueEnvironment);
67-
this.kickEventHandler = new KickEventHandler(config, queueEnvironment, queueServerSelector);
84+
KickEventHandler kickEventHandler = new KickEventHandler(config, queueEnvironment, queueServerSelector);
6885

6986
QueueAvailabilityCalculator availabilityCalculator = new QueueAvailabilityCalculator();
7087
QueueEntryFactory queueEntryFactory = new QueueEntryFactory(queueEnvironment, queueServerSelector);
7188
ShadowBanService shadowBanService = new StorageShadowBanService();
72-
this.queuePlacementCoordinator = new QueuePlacementCoordinator(queueEnvironment, availabilityCalculator, queueEntryFactory,shadowBanService);
89+
QueuePlacementCoordinator queuePlacementCoordinator = new QueuePlacementCoordinator(queueEnvironment, availabilityCalculator, queueEntryFactory,shadowBanService);
7390
QueueCleaner queueCleaner = new QueueCleaner(queueEnvironment);
7491
QueueRecoveryHandler recoveryHandler = new QueueRecoveryHandler(queueEnvironment);
7592
QueueConnector queueConnector = new QueueConnector(queueEnvironment, availabilityCalculator, shadowBanService);
76-
this.queueMoveProcessor = new QueueMoveProcessor(queueEnvironment, queueCleaner, recoveryHandler, queueConnector);
93+
QueueMoveProcessor queueMoveProcessor = new QueueMoveProcessor(queueEnvironment, queueCleaner, recoveryHandler, queueConnector);
94+
return new PreparedListener(plugin, serverStatusManager, queueEnvironment, queuePlacementCoordinator, queueMoveProcessor, usernameValidator, shadowBanKickHandler, kickEventHandler);
7795
}
7896

97+
private record PreparedListener(PistonQueuePlugin plugin, ServerStatusManager serverStatusManager, QueueEnvironment queueEnvironment, QueuePlacementCoordinator queuePlacementCoordinator, QueueMoveProcessor queueMoveProcessor, UsernameValidator usernameValidator, ShadowBanKickHandler shadowBanKickHandler, KickEventHandler kickEventHandler) {}
98+
7999
protected void onPreLogin(PQPreLoginEvent event) {
80100
usernameValidator.validateUsername(event);
81101
}
@@ -96,7 +116,4 @@ public void moveQueue() {
96116
queueMoveProcessor.processQueues();
97117
}
98118

99-
private Config currentConfig() {
100-
return plugin.getConfiguration();
101-
}
102119
}

‎shared/src/test/java/net/pistonmaster/pistonqueue/shared/command/MainCommandSharedTest.java‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
*/
2020
package net.pistonmaster.pistonqueue.shared.command;
2121

22+
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
2223
import net.pistonmaster.pistonqueue.shared.chat.ComponentWrapper;
2324
import net.pistonmaster.pistonqueue.shared.chat.ComponentWrapperFactory;
2425
import net.pistonmaster.pistonqueue.shared.chat.MessageType;
@@ -387,7 +388,7 @@ void clearMessages() {
387388
}
388389
}
389390

390-
@edu.umd.cs.findbugs.annotations.SuppressFBWarnings(
391+
@SuppressFBWarnings(
391392
value = "CT_CONSTRUCTOR_THROW",
392393
justification = "Test class does not need protection from finalizer attacks"
393394
)
@@ -451,6 +452,7 @@ public Path getDataDirectory() {
451452
}
452453

453454
@Override
455+
@SuppressFBWarnings(value = "EI_EXPOSE_REP", justification = "Tests share mutable configuration to exercise reloads.")
454456
public Config getConfiguration() {
455457
return config;
456458
}
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
package net.pistonmaster.pistonqueue.shared.queue.logic;
2+
3+
import net.pistonmaster.pistonqueue.shared.plugin.PistonQueuePlugin;
4+
import net.pistonmaster.pistonqueue.shared.queue.QueueListenerShared;
5+
import org.junit.jupiter.api.Test;
6+
7+
import static org.junit.jupiter.api.Assertions.*;
8+
import static org.mockito.Mockito.mock;
9+
10+
class QueueListenerConstructionTest {
11+
@Test
12+
void statusChecksContinueToUseReloadedConfiguration() {
13+
var config = QueueTestUtils.createConfigWithSingleQueueType(10);
14+
config.setMinOnlineChecks(1);
15+
var plugin = new QueueTestUtils.TestQueuePlugin(config);
16+
var listener = new QueueListenerShared(plugin) {};
17+
var status = listener.getServerStatusManager();
18+
status.online("target");
19+
assertTrue(status.getOnlineServers().contains("target"));
20+
config.setMinOnlineChecks(2);
21+
assertFalse(status.getOnlineServers().contains("target"));
22+
status.online("target");
23+
assertTrue(status.getOnlineServers().contains("target"));
24+
}
25+
26+
@Test
27+
void rejectsMissingConfigurationDuringConstruction() {
28+
var plugin = mock(PistonQueuePlugin.class);
29+
assertThrows(NullPointerException.class, () -> new QueueListenerShared(plugin) {});
30+
}
31+
}

‎shared/src/test/java/net/pistonmaster/pistonqueue/shared/queue/logic/QueueMoveProcessorTest.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ void sendsXpSoundWhenMovingQueue() {
149149
TestPlayer player = context.plugin().registerPlayer("XP" + i);
150150
enqueue(context, player, "main");
151151
// Players need to be "connected" to the queue server for XP sound to be sent
152-
queueServer.getConnectedPlayers().add(player);
152+
queueServer.addConnectedPlayer(player);
153153
}
154154

155155
context.processor().processQueues();

‎shared/src/test/java/net/pistonmaster/pistonqueue/shared/queue/logic/QueueServerSelectorTest.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -114,10 +114,10 @@ void leastPlayersSelectsServerWithFewestPlayers() {
114114
plugin.registerServer("queue3"); // queue3 has no players
115115

116116
// Add players to servers
117-
queue1.getConnectedPlayers().add(plugin.registerPlayer("P1"));
118-
queue1.getConnectedPlayers().add(plugin.registerPlayer("P2"));
119-
queue1.getConnectedPlayers().add(plugin.registerPlayer("P3"));
120-
queue2.getConnectedPlayers().add(plugin.registerPlayer("P4"));
117+
queue1.addConnectedPlayer(plugin.registerPlayer("P1"));
118+
queue1.addConnectedPlayer(plugin.registerPlayer("P2"));
119+
queue1.addConnectedPlayer(plugin.registerPlayer("P3"));
120+
queue2.addConnectedPlayer(plugin.registerPlayer("P4"));
121121

122122
QueueGroup group = new QueueGroup("multi", List.of("queue1", "queue2", "queue3"), List.of("main"), List.of(), List.of());
123123

@@ -157,7 +157,7 @@ void leastPlayersTreatsOfflineServerAsFullest() {
157157

158158
// Only register queue2, so queue1 and queue3 are "offline" (not found)
159159
TestServer queue2 = plugin.registerServer("queue2");
160-
queue2.getConnectedPlayers().add(plugin.registerPlayer("P1"));
160+
queue2.addConnectedPlayer(plugin.registerPlayer("P1"));
161161

162162
QueueGroup group = new QueueGroup("multi", List.of("queue1", "queue2", "queue3"), List.of("main"), List.of(), List.of());
163163

@@ -216,7 +216,7 @@ void selectsCorrectlyAfterStrategyChange() {
216216

217217
TestServer queue1 = plugin.registerServer("queue1");
218218
plugin.registerServer("queue2"); // Register queue2 but we don't need to reference it
219-
queue1.getConnectedPlayers().add(plugin.registerPlayer("P1"));
219+
queue1.addConnectedPlayer(plugin.registerPlayer("P1"));
220220

221221
QueueGroup group = new QueueGroup("multi", List.of("queue1", "queue2"), List.of("main"), List.of(), List.of());
222222

‎shared/src/test/java/net/pistonmaster/pistonqueue/shared/queue/logic/QueueTestUtils.java‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
*/
2020
package net.pistonmaster.pistonqueue.shared.queue.logic;
2121

22+
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
2223
import net.pistonmaster.pistonqueue.shared.chat.MessageType;
2324
import net.pistonmaster.pistonqueue.shared.config.Config;
2425
import net.pistonmaster.pistonqueue.shared.events.PQKickedFromServerEvent;
@@ -211,6 +212,7 @@ public Path getDataDirectory() {
211212
}
212213

213214
@Override
215+
@SuppressFBWarnings(value = "EI_EXPOSE_REP", justification = "Tests share mutable configuration to exercise reloads.")
214216
public Config getConfiguration() {
215217
return config;
216218
}
@@ -328,7 +330,11 @@ static final class TestServer implements ServerInfoWrapper {
328330

329331
@Override
330332
public List<PlayerWrapper> getConnectedPlayers() {
331-
return connectedPlayers;
333+
return List.copyOf(connectedPlayers);
334+
}
335+
336+
void addConnectedPlayer(PlayerWrapper player) {
337+
connectedPlayers.add(player);
332338
}
333339

334340
@Override

0 commit comments

Comments
 (0)