Skip to content
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

feat: order chunks on demand #4773

Closed
wants to merge 15 commits into from
Closed

feat: order chunks on demand #4773

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
29cce78
feat: order chunks on-demand during generation
naalit Jun 16, 2021
fbc652a
clean up unused imports
naalit Jun 16, 2021
f637a98
remove future from ChunkProcessingInfo
naalit Jun 16, 2021
1907954
fix engine tests
naalit Jun 17, 2021
a037898
Merge branch 'develop' into feat/order-chunks-on-demand
naalit Jun 17, 2021
1f6db11
don't interrupt chunk threads on pipeline shutdown
naalit Jun 17, 2021
c0aefbe
add documentation for new items
naalit Jun 17, 2021
d890029
enable multithreaded chunk generation
naalit Jun 17, 2021
a3cd2ea
clean up code based on feedback
naalit Jun 18, 2021
a67f4a1
add condition for waiting until generation finishes, for tests
naalit Jun 18, 2021
58ed505
fix java 8 build on Jenkins
naalit Jun 18, 2021
52ea11f
Merge branch 'develop' into feat/order-chunks-on-demand
skaldarnar Jun 20, 2021
87e8511
Merge branch 'develop' of github.com:MovingBlocks/Terasology into fea…
pollend Jun 20, 2021
d738be2
Merge branch 'feat/order-chunks-on-demand' of github.com:MovingBlocks…
pollend Jun 20, 2021
a229fea
Merge branch 'develop' into feat/order-chunks-on-demand
pollend Jun 28, 2021
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
59 changes: 34 additions & 25 deletions ...st/java/org/terasology/engine/world/chunks/localChunkProvider/LocalChunkProviderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
package org.terasology.engine.world.chunks.localChunkProvider;

import com.google.common.collect.Maps;
import org.joml.Vector3f;
import org.joml.Vector3i;
import org.joml.Vector3ic;
import org.junit.jupiter.api.AfterEach;
Expand All @@ -13,11 +14,11 @@
import org.terasology.engine.entitySystem.entity.EntityManager;
import org.terasology.engine.entitySystem.entity.EntityRef;
import org.terasology.engine.entitySystem.event.Event;
import org.terasology.engine.logic.location.LocationComponent;
import org.terasology.engine.world.BlockEntityRegistry;
import org.terasology.engine.world.block.BeforeDeactivateBlocks;
import org.terasology.engine.world.block.Block;
import org.terasology.engine.world.block.BlockManager;
import org.terasology.engine.world.block.BlockRegion;
import org.terasology.engine.world.block.OnActivatedBlocks;
import org.terasology.engine.world.block.OnAddedBlocks;
import org.terasology.engine.world.chunks.Chunk;
Expand All @@ -36,17 +37,16 @@
import java.util.Map;
import java.util.Optional;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.Future;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;

import static org.mockito.Mockito.atLeast;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

class LocalChunkProviderTest {

private static final int WAIT_CHUNK_IS_READY_IN_SECONDS = 30;
private static final int WAIT_CHUNK_IS_READY_IN_SECONDS = 5;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks like a way more reasonable time to wait for chunks to be ready 👍


private LocalChunkProvider chunkProvider;
private EntityManager entityManager;
Expand All @@ -58,6 +58,8 @@ class LocalChunkProviderTest {
private Block blockAtBlockManager;
private TestStorageManager storageManager;
private TestWorldGenerator generator;
private RelevanceSystem relevanceSystem;
private EntityRef playerEntity;

@BeforeEach
public void setUp() {
Expand All @@ -81,36 +83,33 @@ public void setUp() {
chunkCache);
chunkProvider.setBlockEntityRegistry(blockEntityRegistry);
chunkProvider.setWorldEntity(worldEntity);
chunkProvider.setRelevanceSystem(new RelevanceSystem(chunkProvider)); // workaround. initialize loading pipeline
relevanceSystem = new RelevanceSystem(chunkProvider);
chunkProvider.setRelevanceSystem(relevanceSystem); // workaround. initialize loading pipeline
}

@AfterEach
public void tearDown() {
chunkProvider.shutdown();
}

private Future<Chunk> requestCreatingOrLoadingArea(Vector3ic chunkPosition, int radius) {
Future<Chunk> chunkFuture = chunkProvider.createOrLoadChunk(chunkPosition);
BlockRegion extentsRegion = new BlockRegion(
chunkPosition.x() - radius, chunkPosition.y() - radius, chunkPosition.z() - radius,
chunkPosition.x() + radius, chunkPosition.y() + radius, chunkPosition.z() + radius);

extentsRegion.iterator().forEachRemaining(pos -> {
if (!pos.equals(chunkPosition)) { // remove center. we takes future for it already.
chunkProvider.createOrLoadChunk(pos);
}
});
return chunkFuture;
private void requestCreatingOrLoadingArea(Vector3ic chunkPosition, int radius) {
playerEntity = mock(EntityRef.class);
when(playerEntity.exists()).thenReturn(true);
when(playerEntity.getComponent(LocationComponent.class)).thenReturn(new LocationComponent(new Vector3f(chunkPosition)));
Vector3i distance = new Vector3i(radius * 2, radius * 2, radius * 2);
relevanceSystem.addRelevanceEntity(playerEntity, distance, null);
}

private Future<Chunk> requestCreatingOrLoadingArea(Vector3ic chunkPosition) {
return requestCreatingOrLoadingArea(chunkPosition, 1);
private void requestCreatingOrLoadingArea(Vector3ic chunkPosition) {
requestCreatingOrLoadingArea(chunkPosition, 1);
}

@Test
void testGenerateSingleChunk() throws InterruptedException, ExecutionException, TimeoutException {
Vector3i chunkPosition = new Vector3i(0, 0, 0);
requestCreatingOrLoadingArea(chunkPosition).get(WAIT_CHUNK_IS_READY_IN_SECONDS, TimeUnit.SECONDS);
requestCreatingOrLoadingArea(chunkPosition);
chunkProvider.notifyRelevanceChanged();
chunkProvider.waitUntilGenerated(WAIT_CHUNK_IS_READY_IN_SECONDS * 1000);
chunkProvider.update();

final ArgumentCaptor<Event> eventArgumentCaptor = ArgumentCaptor.forClass(Event.class);
Expand Down Expand Up @@ -139,7 +138,9 @@ void testGenerateSingleChunkWithBlockLifeCycle() throws InterruptedException, Ex
Vector3i chunkPosition = new Vector3i(0, 0, 0);
blockAtBlockManager.setLifecycleEventsRequired(true);
blockAtBlockManager.setEntity(mock(EntityRef.class));
requestCreatingOrLoadingArea(chunkPosition).get(WAIT_CHUNK_IS_READY_IN_SECONDS, TimeUnit.SECONDS);
requestCreatingOrLoadingArea(chunkPosition);
chunkProvider.notifyRelevanceChanged();
chunkProvider.waitUntilGenerated(WAIT_CHUNK_IS_READY_IN_SECONDS * 1000);
chunkProvider.update();

final ArgumentCaptor<Event> worldEventCaptor = ArgumentCaptor.forClass(Event.class);
Expand Down Expand Up @@ -181,7 +182,9 @@ void testLoadSingleChunk() throws InterruptedException, ExecutionException, Time
generator.createChunk(chunk, null);
storageManager.add(chunk);

requestCreatingOrLoadingArea(chunkPosition).get(WAIT_CHUNK_IS_READY_IN_SECONDS, TimeUnit.SECONDS);
requestCreatingOrLoadingArea(chunkPosition);
chunkProvider.notifyRelevanceChanged();
chunkProvider.waitUntilGenerated(WAIT_CHUNK_IS_READY_IN_SECONDS * 1000);
chunkProvider.update();

Assertions.assertTrue(((TestChunkStore) storageManager.loadChunkStore(chunkPosition)).isEntityRestored(),
Expand All @@ -206,7 +209,9 @@ void testLoadSingleChunkWithBlockLifecycle() throws InterruptedException, Execut
blockAtBlockManager.setLifecycleEventsRequired(true);
blockAtBlockManager.setEntity(mock(EntityRef.class));

requestCreatingOrLoadingArea(chunkPosition).get(WAIT_CHUNK_IS_READY_IN_SECONDS, TimeUnit.SECONDS);
requestCreatingOrLoadingArea(chunkPosition);
chunkProvider.notifyRelevanceChanged();
chunkProvider.waitUntilGenerated(WAIT_CHUNK_IS_READY_IN_SECONDS * 1000);
chunkProvider.update();

Assertions.assertTrue(((TestChunkStore) storageManager.loadChunkStore(chunkPosition)).isEntityRestored(),
Expand Down Expand Up @@ -249,9 +254,13 @@ void testUnloadChunkAndDeactivationBlock() throws InterruptedException, TimeoutE
blockAtBlockManager.setLifecycleEventsRequired(true);
blockAtBlockManager.setEntity(mock(EntityRef.class));

requestCreatingOrLoadingArea(chunkPosition).get(WAIT_CHUNK_IS_READY_IN_SECONDS, TimeUnit.SECONDS);
requestCreatingOrLoadingArea(chunkPosition);
chunkProvider.notifyRelevanceChanged();
chunkProvider.waitUntilGenerated(WAIT_CHUNK_IS_READY_IN_SECONDS * 1000);
relevanceSystem.removeRelevanceEntity(playerEntity);
chunkProvider.notifyRelevanceChanged();

//Wait BeforeDeactivateBlocks event
// Wait for BeforeDeactivateBlocks event
Assertions.assertTimeoutPreemptively(Duration.of(WAIT_CHUNK_IS_READY_IN_SECONDS, ChronoUnit.SECONDS),
() -> {
ArgumentCaptor<Event> blockEventCaptor = ArgumentCaptor.forClass(Event.class);
Expand Down
Loading