Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -162,8 +162,16 @@ public CompletionStage<PreparedStatement> process(
});
}
}
// Return a defensive copy. So if a client cancels its request, the cache won't be impacted
// nor a potential concurrent request.
if (result.isDone()) {
// Once a CompletableFuture is completed, cancel(), complete(), and
// completeExceptionally() are no-ops (return false), so returning the cached
// instance directly is safe from concurrent callers. This also keeps the cache
// entry alive via the caller's strong reference, preventing premature weak-value
// eviction under GC pressure.
return result;
}
// Defensive copy for in-flight preparations only: protects the shared cached future
// from cancellation by one of multiple concurrent waiters.
return result.thenApply(x -> x); // copy() is available only since Java 9
} catch (ExecutionException e) {
return CompletableFutures.failedFuture(e.getCause());
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.datastax.oss.driver.internal.core.cql;

import static org.assertj.core.api.Assertions.assertThat;

import com.datastax.oss.driver.api.core.cql.PrepareRequest;
import com.datastax.oss.driver.api.core.cql.PreparedStatement;
import com.datastax.oss.driver.shaded.guava.common.cache.Cache;
import java.util.Optional;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.CompletionStage;
import org.junit.Before;
import org.junit.Test;
import org.mockito.Mockito;

/**
* Unit tests for {@link CqlPrepareAsyncProcessor} focusing on the caching behavior of {@link
* CqlPrepareAsyncProcessor#process} with respect to defensive copies and weak-value retention.
*/
public class CqlPrepareAsyncProcessorTest {

private CqlPrepareAsyncProcessor processor;
private Cache<PrepareRequest, CompletableFuture<PreparedStatement>> cache;

@Before
public void setup() {
processor = new CqlPrepareAsyncProcessor(Optional.empty());
cache = processor.getCache();
}

/**
* When the cached future is already completed, process() should return the exact same instance
* (identity). This ensures callers hold a strong reference to the cached CF, preventing
* weak-value eviction under GC pressure.
*/
@Test
public void should_return_cached_future_directly_when_already_completed() throws Exception {
PrepareRequest request = new DefaultPrepareRequest("SELECT 1");
PreparedStatement ps = Mockito.mock(PreparedStatement.class);

// Pre-populate cache with a completed future
CompletableFuture<PreparedStatement> completed = CompletableFuture.completedFuture(ps);
cache.put(request, completed);

// process() should return the exact same object
CompletionStage<PreparedStatement> returned = processor.process(request, null, null, "test");

assertThat(returned).isSameAs(completed);
}

/**
* When the cached future is still in-flight (not yet done), process() should return a defensive
* copy to protect the cache from cancellation by the caller.
*/
@Test
public void should_return_defensive_copy_when_future_is_in_flight() throws Exception {
PrepareRequest request = new DefaultPrepareRequest("SELECT 1");

// Pre-populate cache with an incomplete future
CompletableFuture<PreparedStatement> inFlight = new CompletableFuture<>();
cache.put(request, inFlight);

CompletionStage<PreparedStatement> returned = processor.process(request, null, null, "test");

// Should NOT be the same instance
assertThat(returned).isNotSameAs(inFlight);

// Cancelling the returned copy should NOT affect the cached future
returned.toCompletableFuture().cancel(false);
assertThat(inFlight.isCancelled()).isFalse();
}
}
Loading