Skip to content

fix: allow queues to not generate chunks #4599

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
NotMyFault merged 1 commit into from
Feb 23, 2025
Merged

fix: allow queues to not generate chunks #4599

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 17 additions & 5 deletions Bukkit/src/main/java/com/plotsquared/bukkit/queue/BukkitChunkCoordinator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@
import com.sk89q.worldedit.math.BlockVector2;
import com.sk89q.worldedit.world.World;
import io.papermc.lib.PaperLib;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.bukkit.Bukkit;
import org.bukkit.Chunk;
import org.bukkit.plugin.Plugin;
Expand All @@ -41,6 +43,7 @@
import java.util.List;
import java.util.Queue;
import java.util.concurrent.LinkedBlockingQueue;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.function.Consumer;

Expand All @@ -55,6 +58,8 @@
**/
public final class BukkitChunkCoordinator extends ChunkCoordinator {

private static final Logger LOGGER = LogManager.getLogger("PlotSquared/" + BukkitChunkCoordinator.class.getSimpleName());

private final List<ProgressSubscriber> progressSubscribers = new LinkedList<>();

private final Queue<BlockVector2> requestedChunks;
Expand All @@ -70,6 +75,7 @@ public final class BukkitChunkCoordinator extends ChunkCoordinator {
private final AtomicInteger expectedSize;
private final AtomicInteger loadingChunks = new AtomicInteger();
private final boolean forceSync;
private final boolean shouldGen;

private int batchSize;
private PlotSquaredTask task;
Expand All @@ -87,7 +93,8 @@ private BukkitChunkCoordinator(
@Assisted final @NonNull Consumer<Throwable> throwableConsumer,
@Assisted("unloadAfter") final boolean unloadAfter,
@Assisted final @NonNull Collection<ProgressSubscriber> progressSubscribers,
@Assisted("forceSync") final boolean forceSync
@Assisted("forceSync") final boolean forceSync,
@Assisted("shouldGen") final boolean shouldGen
) {
this.requestedChunks = new LinkedBlockingQueue<>(requestedChunks);
this.availableChunks = new LinkedBlockingQueue<>();
Expand All @@ -103,6 +110,7 @@ private BukkitChunkCoordinator(
this.bukkitWorld = Bukkit.getWorld(world.getName());
this.progressSubscribers.addAll(progressSubscribers);
this.forceSync = forceSync;
this.shouldGen = shouldGen;
}

@Override
Expand Down Expand Up @@ -212,18 +220,22 @@ public void run() {
* Requests a batch of chunks to be loaded
*/
private void requestBatch() {
BlockVector2 chunk;
for (int i = 0; i < this.batchSize && (chunk = this.requestedChunks.poll()) != null; i++) {
for (int i = 0; i < this.batchSize && this.requestedChunks.peek() != null; i++) {
// This required PaperLib to be bumped to version 1.0.4 to mark the request as urgent
final BlockVector2 chunk = this.requestedChunks.poll();
loadingChunks.incrementAndGet();
PaperLib
.getChunkAtAsync(this.bukkitWorld, chunk.getX(), chunk.getZ(), true, true)
.getChunkAtAsync(this.bukkitWorld, chunk.getX(), chunk.getZ(), shouldGen, true)
.completeOnTimeout(null, 10L, TimeUnit.SECONDS)
.whenComplete((chunkObject, throwable) -> {
loadingChunks.decrementAndGet();
if (throwable != null) {
throwable.printStackTrace();
LOGGER.error("Failed to load chunk {}", chunk, throwable);
// We want one less because this couldn't be processed
this.expectedSize.decrementAndGet();
} else if (chunkObject == null) {
LOGGER.warn("Timed out awaiting chunk load {}", chunk);
this.requestedChunks.offer(chunk);
} else if (PlotSquared.get().isMainThread(Thread.currentThread())) {
this.processChunk(chunkObject);
} else {
Expand Down
1 change: 1 addition & 0 deletions Bukkit/src/main/java/com/plotsquared/bukkit/queue/BukkitQueueCoordinator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,7 @@ public boolean enqueue() {
.unloadAfter(isUnloadAfter())
.withProgressSubscribers(getProgressSubscribers())
.forceSync(isForceSync())
.shouldGen(isShouldGen())
.build();
return super.enqueue();
}
Expand Down
9 changes: 6 additions & 3 deletions Core/src/main/java/com/plotsquared/core/generator/HybridUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -432,6 +432,7 @@ public void run() {
if (!UPDATE) {
Iterator<BlockVector2> iter = chunks.iterator();
QueueCoordinator queue = blockQueue.getNewQueue(worldUtil.getWeWorld(area.getWorldName()));
queue.setShouldGen(false);
while (iter.hasNext()) {
BlockVector2 chunk = iter.next();
iter.remove();
Expand Down Expand Up @@ -474,6 +475,7 @@ public void run() {
Iterator<BlockVector2> iterator = chunks.iterator();
if (chunks.size() >= 32) {
QueueCoordinator queue = blockQueue.getNewQueue(worldUtil.getWeWorld(area.getWorldName()));
queue.setShouldGen(false);
for (int i = 0; i < 32; i++) {
final BlockVector2 chunk = iterator.next();
iterator.remove();
Expand All @@ -487,6 +489,7 @@ public void run() {
return null;
}
QueueCoordinator queue = blockQueue.getNewQueue(worldUtil.getWeWorld(area.getWorldName()));
queue.setShouldGen(false);
while (!chunks.isEmpty()) {
final BlockVector2 chunk = iterator.next();
iterator.remove();
Expand All @@ -502,15 +505,15 @@ public void run() {
return;
}
} catch (Exception e) {
e.printStackTrace();
Iterator<BlockVector2> iterator = HybridUtils.regions.iterator();
BlockVector2 loc = iterator.next();
iterator.remove();
LOGGER.error(
"Error! Could not update '{}/region/r.{}.{}.mca' (Corrupt chunk?)",
area.getWorldHash(),
loc.getX(),
loc.getZ()
loc.getZ(),
e
);
}
TaskManager.runTaskLater(task, TaskTime.seconds(1L));
Expand Down Expand Up @@ -558,7 +561,7 @@ public boolean setupRoadSchematic(Plot plot) {
try {
plotworld.setupSchematics();
} catch (SchematicHandler.UnsupportedFormatException e) {
e.printStackTrace();
LOGGER.error(e);
}
});
});
Expand Down
3 changes: 2 additions & 1 deletion Core/src/main/java/com/plotsquared/core/inject/factory/ChunkCoordinatorFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,8 @@ public interface ChunkCoordinatorFactory {
final @NonNull Consumer<Throwable> throwableConsumer,
@Assisted("unloadAfter") final boolean unloadAfter,
final @NonNull Collection<ProgressSubscriber> progressSubscribers,
@Assisted("forceSync") final boolean forceSync
@Assisted("forceSync") final boolean forceSync,
@Assisted("shouldGen") final boolean shouldGen
);

}
17 changes: 16 additions & 1 deletion Core/src/main/java/com/plotsquared/core/queue/ChunkCoordinatorBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ public class ChunkCoordinatorBuilder {
private int initialBatchSize = Settings.QUEUE.INITIAL_BATCH_SIZE;
private boolean unloadAfter = true;
private boolean forceSync = false;
private boolean shouldGen = true;

@Inject
public ChunkCoordinatorBuilder(@NonNull ChunkCoordinatorFactory chunkCoordinatorFactory) {
Expand Down Expand Up @@ -203,6 +204,19 @@ public ChunkCoordinatorBuilder(@NonNull ChunkCoordinatorFactory chunkCoordinator
return this;
}

/**
* Set whether chunks should be generated as part of this operation. Default is true. Disabling this may not be supported
* depending on server implementation. (i.e. setting to false may not actually disable generation as part of this operation
* - this is just a catch-all in case of future differing server implementations; the option will work on Spigot/Paper).
*
* @param shouldGen should generate new chunks or not
* @since TODO
*/
public @NonNull ChunkCoordinatorBuilder shouldGen(final boolean shouldGen) {
this.shouldGen = shouldGen;
return this;
}

public @NonNull ChunkCoordinatorBuilder withProgressSubscriber(ProgressSubscriber progressSubscriber) {
this.progressSubscribers.add(progressSubscriber);
return this;
Expand Down Expand Up @@ -234,7 +248,8 @@ public ChunkCoordinatorBuilder(@NonNull ChunkCoordinatorFactory chunkCoordinator
this.throwableConsumer,
this.unloadAfter,
this.progressSubscribers,
this.forceSync
this.forceSync,
this.shouldGen
);
}

Expand Down
1 change: 1 addition & 0 deletions Core/src/main/java/com/plotsquared/core/queue/DelegateQueueCoordinator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ public DelegateQueueCoordinator(QueueCoordinator parent) {

if (parent != null) {
this.setForceSync(parent.isForceSync());
this.setShouldGen(parent.isShouldGen());
}
}

Expand Down
25 changes: 25 additions & 0 deletions Core/src/main/java/com/plotsquared/core/queue/QueueCoordinator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ public abstract class QueueCoordinator {

private final AtomicBoolean enqueued = new AtomicBoolean();
private boolean forceSync = false;
private boolean shouldGen = true;
@Nullable
private Object chunkObject;
@SuppressWarnings({"unused", "FieldCanBeLocal"})
Expand Down Expand Up @@ -110,6 +111,30 @@ public void setForceSync(boolean forceSync) {
this.forceSync = forceSync;
}


/**
* Get whether chunks should be generated as part of this operation. Default is true. Disabling this may not be supported
* depending on server implementation. (i.e. setting to false may not actually disable generation as part of this operation
* - this is just a catch-all in case of future differing server implementations; the option will work on Spigot/Paper).
*
* @since TODO
*/
public boolean isShouldGen() {
return shouldGen;
}

/**
* Set whether chunks should be generated as part of this operation. Default is true. Disabling this may not be supported
* depending on server implementation. (i.e. setting to false may not actually disable generation as part of this operation
* - this is just a catch-all in case of future differing server implementations; the option will work on Spigot/Paper).
*
* @param shouldGen should generate new chunks or not
* @since TODO
*/
public void setShouldGen(boolean shouldGen) {
this.shouldGen = shouldGen;
}

/**
* Get the Chunk Object set to the queue
*
Expand Down
Loading