Fix thread safety issues in Communicator, Session, and AsyncPromiseFulfillerDecorator #433
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,184 @@ | ||
| package eu.chargetime.ocpp.test; | ||
|
|
||
| /* | ||
| ChargeTime.eu - Java-OCA-OCPP | ||
|
|
||
| MIT License | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. | ||
| */ | ||
|
|
||
| import static org.junit.Assert.assertTrue; | ||
| import static org.mockito.Mockito.*; | ||
|
|
||
| import eu.chargetime.ocpp.AsyncPromiseFulfillerDecorator; | ||
| import eu.chargetime.ocpp.PromiseFulfiller; | ||
| import eu.chargetime.ocpp.SessionEvents; | ||
| import eu.chargetime.ocpp.model.Confirmation; | ||
| import eu.chargetime.ocpp.model.Request; | ||
| import java.util.concurrent.CompletableFuture; | ||
| import java.util.concurrent.CountDownLatch; | ||
| import java.util.concurrent.ExecutorService; | ||
| import java.util.concurrent.Executors; | ||
| import java.util.concurrent.TimeUnit; | ||
| import org.junit.Before; | ||
| import org.junit.Test; | ||
| import org.junit.runner.RunWith; | ||
| import org.mockito.Mock; | ||
| import org.mockito.junit.MockitoJUnitRunner; | ||
|
|
||
| @RunWith(MockitoJUnitRunner.class) | ||
| public class AsyncPromiseFulfillerDecoratorTest { | ||
|
|
||
| @Mock private PromiseFulfiller innerFulfiller; | ||
| @Mock private SessionEvents sessionEvents; | ||
| @Mock private Request request; | ||
|
|
||
| private AsyncPromiseFulfillerDecorator decorator; | ||
|
|
||
| @Before | ||
| public void setup() { | ||
| // Reset to a fresh default executor before each test to avoid cross-test pollution | ||
| AsyncPromiseFulfillerDecorator.setExecutor(createFreshExecutor()); | ||
| decorator = new AsyncPromiseFulfillerDecorator(innerFulfiller); | ||
| } | ||
|
|
||
| private static ExecutorService createFreshExecutor() { | ||
| int coreSize = Runtime.getRuntime().availableProcessors(); | ||
| int maxSize = coreSize * 2; | ||
| return new java.util.concurrent.ThreadPoolExecutor( | ||
| coreSize, | ||
| maxSize, | ||
| 60L, | ||
| TimeUnit.SECONDS, | ||
| new java.util.concurrent.LinkedBlockingQueue<>(1000), | ||
| new java.util.concurrent.ThreadPoolExecutor.CallerRunsPolicy()); | ||
| } | ||
|
|
||
| @Test | ||
| public void fulfill_delegatesToInnerFulfiller() throws Exception { | ||
| CompletableFuture<Confirmation> promise = new CompletableFuture<>(); | ||
| CountDownLatch latch = new CountDownLatch(1); | ||
|
|
||
| doAnswer( | ||
| invocation -> { | ||
| latch.countDown(); | ||
| return null; | ||
| }) | ||
| .when(innerFulfiller) | ||
| .fulfill(any(), any(), any()); | ||
|
|
||
| decorator.fulfill(promise, sessionEvents, request); | ||
|
|
||
| assertTrue("Inner fulfiller was not called within timeout", latch.await(5, TimeUnit.SECONDS)); | ||
| verify(innerFulfiller).fulfill(promise, sessionEvents, request); | ||
| } | ||
|
|
||
| @Test | ||
| public void fulfill_executesAsynchronously_doesNotBlockCaller() throws Exception { | ||
| CountDownLatch blockingLatch = new CountDownLatch(1); | ||
| CountDownLatch callerReturned = new CountDownLatch(1); | ||
|
|
||
| doAnswer( | ||
| invocation -> { | ||
| // Block the inner fulfiller until we signal | ||
| blockingLatch.await(5, TimeUnit.SECONDS); | ||
| return null; | ||
| }) | ||
| .when(innerFulfiller) | ||
| .fulfill(any(), any(), any()); | ||
|
|
||
| // fulfill() should return immediately without blocking | ||
| decorator.fulfill(null, sessionEvents, request); | ||
| callerReturned.countDown(); | ||
|
|
||
| assertTrue("fulfill() blocked the caller thread", callerReturned.getCount() == 0); | ||
|
|
||
| // Release the blocked task | ||
| blockingLatch.countDown(); | ||
| } | ||
|
|
||
| @Test | ||
| public void fulfill_withCustomExecutor_usesCustomExecutor() throws Exception { | ||
| ExecutorService customExecutor = Executors.newSingleThreadExecutor(); | ||
| AsyncPromiseFulfillerDecorator.setExecutor(customExecutor); | ||
|
|
||
| CountDownLatch latch = new CountDownLatch(1); | ||
| doAnswer( | ||
| invocation -> { | ||
| latch.countDown(); | ||
| return null; | ||
| }) | ||
| .when(innerFulfiller) | ||
| .fulfill(any(), any(), any()); | ||
|
|
||
| decorator.fulfill(null, sessionEvents, request); | ||
|
|
||
| assertTrue("Task was not executed on custom executor", latch.await(5, TimeUnit.SECONDS)); | ||
| verify(innerFulfiller).fulfill(null, sessionEvents, request); | ||
|
|
||
| customExecutor.shutdown(); | ||
| } | ||
|
|
||
| @Test | ||
| public void fulfill_multipleConcurrentCalls_allExecuted() throws Exception { | ||
| int callCount = 20; | ||
| CountDownLatch latch = new CountDownLatch(callCount); | ||
|
|
||
| doAnswer( | ||
| invocation -> { | ||
| latch.countDown(); | ||
| return null; | ||
| }) | ||
| .when(innerFulfiller) | ||
| .fulfill(any(), any(), any()); | ||
|
|
||
| for (int i = 0; i < callCount; i++) { | ||
| decorator.fulfill(null, sessionEvents, request); | ||
| } | ||
|
|
||
| assertTrue("Not all concurrent fulfill calls were executed", latch.await(10, TimeUnit.SECONDS)); | ||
| verify(innerFulfiller, times(callCount)).fulfill(any(), any(), any()); | ||
| } | ||
|
|
||
| @Test | ||
| public void fulfill_whenInnerFulfillerThrows_doesNotCrashExecutor() throws Exception { | ||
| doThrow(new RuntimeException("handler error")) | ||
| .when(innerFulfiller) | ||
| .fulfill(any(), any(), any()); | ||
|
|
||
| // First call triggers exception | ||
| decorator.fulfill(null, sessionEvents, request); | ||
| Thread.sleep(200); | ||
|
|
||
| // Second call should still work (executor not dead) | ||
| CountDownLatch latch = new CountDownLatch(1); | ||
| doAnswer( | ||
| invocation -> { | ||
| latch.countDown(); | ||
| return null; | ||
| }) | ||
| .when(innerFulfiller) | ||
| .fulfill(any(), any(), any()); | ||
|
|
||
| decorator.fulfill(null, sessionEvents, request); | ||
|
|
||
| assertTrue("Executor died after exception in fulfiller", latch.await(5, TimeUnit.SECONDS)); | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure about the effects of this. Note that this also affects the request handling on the charging station side, and I've seen CSMS "bomb" charging stations with parallel ChangeConfigurationRequests for all read-write configuration settings. Would this still work the same as before?
Also, I gather that once the threads are exhausted (which may be only 2 on a single-core charging station), the executor switches to executing the request handler within the onCall() caller's thread. But if then an exception is thrown in the request handler, it would not result in the same response as when it was thrown in a separate thread, would it?