[Fix-18274][Registry] Handle expired JDBC heartbeat sessions #18416
+287
−15
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,243 @@ | ||
| /* | ||
| * 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 org.apache.dolphinscheduler.plugin.registry.jdbc.server; | ||
|
|
||
| import org.apache.dolphinscheduler.plugin.registry.jdbc.JdbcRegistryProperties; | ||
| import org.apache.dolphinscheduler.plugin.registry.jdbc.client.IJdbcRegistryClient; | ||
| import org.apache.dolphinscheduler.plugin.registry.jdbc.client.JdbcRegistryClientIdentify; | ||
| import org.apache.dolphinscheduler.plugin.registry.jdbc.model.DTO.JdbcRegistryClientHeartbeatDTO; | ||
| import org.apache.dolphinscheduler.plugin.registry.jdbc.repository.JdbcRegistryClientRepository; | ||
| import org.apache.dolphinscheduler.plugin.registry.jdbc.repository.JdbcRegistryDataChangeEventRepository; | ||
| import org.apache.dolphinscheduler.plugin.registry.jdbc.repository.JdbcRegistryDataRepository; | ||
| import org.apache.dolphinscheduler.plugin.registry.jdbc.repository.JdbcRegistryLockRepository; | ||
|
|
||
| import java.time.Duration; | ||
| import java.util.concurrent.CountDownLatch; | ||
| import java.util.concurrent.ExecutorService; | ||
| import java.util.concurrent.Executors; | ||
| import java.util.concurrent.Future; | ||
| import java.util.concurrent.TimeUnit; | ||
| import java.util.concurrent.atomic.AtomicLong; | ||
|
|
||
| import org.junit.jupiter.api.AfterEach; | ||
| import org.junit.jupiter.api.BeforeEach; | ||
| import org.junit.jupiter.api.Test; | ||
| import org.junit.jupiter.api.extension.ExtendWith; | ||
| import org.mockito.ArgumentCaptor; | ||
| import org.mockito.Mock; | ||
| import org.mockito.Mockito; | ||
| import org.mockito.junit.jupiter.MockitoExtension; | ||
| import org.springframework.test.util.ReflectionTestUtils; | ||
| import org.springframework.transaction.support.TransactionTemplate; | ||
|
|
||
| import com.google.common.truth.Truth; | ||
|
|
||
| @ExtendWith(MockitoExtension.class) | ||
| class JdbcRegistryServerTest { | ||
|
|
||
| private static final JdbcRegistryClientIdentify CLIENT_IDENTIFY = | ||
| new JdbcRegistryClientIdentify(1L, "test-client"); | ||
|
|
||
| @Mock | ||
| private JdbcRegistryDataRepository jdbcRegistryDataRepository; | ||
|
|
||
| @Mock | ||
| private JdbcRegistryLockRepository jdbcRegistryLockRepository; | ||
|
|
||
| @Mock | ||
| private JdbcRegistryClientRepository jdbcRegistryClientRepository; | ||
|
|
||
| @Mock | ||
| private JdbcRegistryDataChangeEventRepository jdbcRegistryDataChangeEventRepository; | ||
|
|
||
| @Mock | ||
| private TransactionTemplate transactionTemplate; | ||
|
|
||
| @Mock | ||
| private IJdbcRegistryClient jdbcRegistryClient; | ||
|
|
||
| @Mock | ||
| private ConnectionStateListener connectionStateListener; | ||
|
|
||
| private JdbcRegistryServer jdbcRegistryServer; | ||
|
|
||
| @BeforeEach | ||
| void setUp() { | ||
| JdbcRegistryProperties jdbcRegistryProperties = new JdbcRegistryProperties(); | ||
| jdbcRegistryProperties.setSessionTimeout(Duration.ofSeconds(1)); | ||
| jdbcRegistryServer = new JdbcRegistryServer( | ||
| jdbcRegistryDataRepository, | ||
| jdbcRegistryLockRepository, | ||
| jdbcRegistryClientRepository, | ||
| jdbcRegistryDataChangeEventRepository, | ||
| jdbcRegistryProperties, | ||
| transactionTemplate); | ||
| Mockito.when(jdbcRegistryClient.getJdbcRegistryClientIdentify()).thenReturn(CLIENT_IDENTIFY); | ||
| jdbcRegistryServer.registerClient(jdbcRegistryClient); | ||
| jdbcRegistryServer.subscribeConnectionStateChange(connectionStateListener); | ||
| } | ||
|
|
||
| @AfterEach | ||
| void tearDown() { | ||
| jdbcRegistryServer.close(); | ||
| } | ||
|
|
||
| @Test | ||
| void refreshClientsHeartbeat_shouldDisconnectWhenHeartbeatRecordWasPurged() { | ||
| ReflectionTestUtils.setField(jdbcRegistryServer, "jdbcRegistryServerState", | ||
| JdbcRegistryServerState.SUSPENDED); | ||
| ReflectionTestUtils.setField(jdbcRegistryServer, "lastSuccessHeartbeat", 0L); | ||
| Mockito.when(jdbcRegistryClientRepository.updateById(Mockito.any())).thenReturn(false); | ||
|
|
||
| ReflectionTestUtils.invokeMethod(jdbcRegistryServer, "refreshClientsHeartbeat"); | ||
|
|
||
| Truth.assertThat(jdbcRegistryServer.getServerState()).isEqualTo(JdbcRegistryServerState.DISCONNECTED); | ||
| Mockito.verify(connectionStateListener).onDisConnected(); | ||
| } | ||
|
|
||
| @Test | ||
| void refreshClientsHeartbeat_shouldDisconnectImmediatelyWhenStartedHeartbeatRecordWasPurged() { | ||
| ReflectionTestUtils.setField(jdbcRegistryServer, "jdbcRegistryServerState", JdbcRegistryServerState.STARTED); | ||
| Mockito.when(jdbcRegistryClientRepository.updateById(Mockito.any())).thenReturn(false); | ||
|
|
||
| ReflectionTestUtils.invokeMethod(jdbcRegistryServer, "refreshClientsHeartbeat"); | ||
| ReflectionTestUtils.invokeMethod(jdbcRegistryServer, "refreshClientsHeartbeat"); | ||
|
|
||
| Truth.assertThat(jdbcRegistryServer.getServerState()).isEqualTo(JdbcRegistryServerState.DISCONNECTED); | ||
| Mockito.verify(jdbcRegistryClientRepository).updateById(Mockito.any()); | ||
| Mockito.verify(connectionStateListener).onDisConnected(); | ||
| } | ||
|
|
||
| @Test | ||
| void refreshClientsHeartbeat_shouldNotDisconnectWhenCloseWinsRace() throws Exception { | ||
| ReflectionTestUtils.setField(jdbcRegistryServer, "jdbcRegistryServerState", JdbcRegistryServerState.STARTED); | ||
| CountDownLatch heartbeatUpdateStarted = new CountDownLatch(1); | ||
| CountDownLatch allowHeartbeatUpdateToFinish = new CountDownLatch(1); | ||
| Mockito.when(jdbcRegistryClientRepository.updateById(Mockito.any())).thenAnswer(invocation -> { | ||
| heartbeatUpdateStarted.countDown(); | ||
| allowHeartbeatUpdateToFinish.await(5, TimeUnit.SECONDS); | ||
| return false; | ||
| }); | ||
| ExecutorService heartbeatExecutor = Executors.newSingleThreadExecutor(); | ||
| Future<?> heartbeatFuture = heartbeatExecutor.submit(() -> { | ||
| ReflectionTestUtils.invokeMethod(jdbcRegistryServer, "refreshClientsHeartbeat"); | ||
| }); | ||
|
|
||
| try { | ||
| Truth.assertThat(heartbeatUpdateStarted.await(5, TimeUnit.SECONDS)).isTrue(); | ||
| jdbcRegistryServer.close(); | ||
| allowHeartbeatUpdateToFinish.countDown(); | ||
| heartbeatFuture.get(5, TimeUnit.SECONDS); | ||
| } finally { | ||
| allowHeartbeatUpdateToFinish.countDown(); | ||
| heartbeatExecutor.shutdownNow(); | ||
| } | ||
|
|
||
| Truth.assertThat(jdbcRegistryServer.getServerState()).isEqualTo(JdbcRegistryServerState.STOPPED); | ||
| Mockito.verify(connectionStateListener, Mockito.never()).onDisConnected(); | ||
| } | ||
|
|
||
| @Test | ||
| void refreshClientsHeartbeat_shouldNotReconnectWhenCloseWinsSuccessfulHeartbeatRace() throws Exception { | ||
| ReflectionTestUtils.setField(jdbcRegistryServer, "jdbcRegistryServerState", | ||
| JdbcRegistryServerState.SUSPENDED); | ||
| CountDownLatch heartbeatUpdateStarted = new CountDownLatch(1); | ||
| CountDownLatch allowHeartbeatUpdateToFinish = new CountDownLatch(1); | ||
| Mockito.when(jdbcRegistryClientRepository.updateById(Mockito.any())).thenAnswer(invocation -> { | ||
| heartbeatUpdateStarted.countDown(); | ||
| allowHeartbeatUpdateToFinish.await(5, TimeUnit.SECONDS); | ||
| return true; | ||
| }); | ||
| ExecutorService heartbeatExecutor = Executors.newSingleThreadExecutor(); | ||
| Future<?> heartbeatFuture = heartbeatExecutor.submit(() -> { | ||
| ReflectionTestUtils.invokeMethod(jdbcRegistryServer, "refreshClientsHeartbeat"); | ||
| }); | ||
|
|
||
| try { | ||
| Truth.assertThat(heartbeatUpdateStarted.await(5, TimeUnit.SECONDS)).isTrue(); | ||
| jdbcRegistryServer.close(); | ||
| allowHeartbeatUpdateToFinish.countDown(); | ||
| heartbeatFuture.get(5, TimeUnit.SECONDS); | ||
| } finally { | ||
| allowHeartbeatUpdateToFinish.countDown(); | ||
| heartbeatExecutor.shutdownNow(); | ||
| } | ||
|
|
||
| Truth.assertThat(jdbcRegistryServer.getServerState()).isEqualTo(JdbcRegistryServerState.STOPPED); | ||
| Mockito.verify(connectionStateListener, Mockito.never()).onReconnected(); | ||
| Mockito.verify(connectionStateListener, Mockito.never()).onDisConnected(); | ||
| } | ||
|
|
||
| @Test | ||
| void refreshClientsHeartbeat_shouldNotSuspendWhenCloseWinsFailedHeartbeatRace() throws Exception { | ||
| ReflectionTestUtils.setField(jdbcRegistryServer, "jdbcRegistryServerState", JdbcRegistryServerState.STARTED); | ||
| CountDownLatch heartbeatUpdateStarted = new CountDownLatch(1); | ||
| CountDownLatch allowHeartbeatUpdateToFail = new CountDownLatch(1); | ||
| Mockito.when(jdbcRegistryClientRepository.updateById(Mockito.any())).thenAnswer(invocation -> { | ||
| heartbeatUpdateStarted.countDown(); | ||
| allowHeartbeatUpdateToFail.await(5, TimeUnit.SECONDS); | ||
| throw new RuntimeException("Heartbeat update failed"); | ||
| }); | ||
| ExecutorService heartbeatExecutor = Executors.newSingleThreadExecutor(); | ||
| Future<?> heartbeatFuture = heartbeatExecutor.submit(() -> { | ||
| ReflectionTestUtils.invokeMethod(jdbcRegistryServer, "refreshClientsHeartbeat"); | ||
| }); | ||
|
|
||
| try { | ||
| Truth.assertThat(heartbeatUpdateStarted.await(5, TimeUnit.SECONDS)).isTrue(); | ||
| jdbcRegistryServer.close(); | ||
| allowHeartbeatUpdateToFail.countDown(); | ||
| heartbeatFuture.get(5, TimeUnit.SECONDS); | ||
| } finally { | ||
| allowHeartbeatUpdateToFail.countDown(); | ||
| heartbeatExecutor.shutdownNow(); | ||
| } | ||
|
|
||
| Truth.assertThat(jdbcRegistryServer.getServerState()).isEqualTo(JdbcRegistryServerState.STOPPED); | ||
| Mockito.verify(connectionStateListener, Mockito.never()).onReconnected(); | ||
| Mockito.verify(connectionStateListener, Mockito.never()).onDisConnected(); | ||
| } | ||
|
|
||
| @Test | ||
| void refreshClientsHeartbeat_shouldPersistCurrentHeartbeatTimestamp() { | ||
| ArgumentCaptor<JdbcRegistryClientHeartbeatDTO> registeredHeartbeat = | ||
| ArgumentCaptor.forClass(JdbcRegistryClientHeartbeatDTO.class); | ||
| Mockito.verify(jdbcRegistryClientRepository).insert(registeredHeartbeat.capture()); | ||
| registeredHeartbeat.getValue().setLastHeartbeatTime(0L); | ||
| AtomicLong persistedHeartbeatTimestamp = new AtomicLong(-1L); | ||
| Mockito.when(jdbcRegistryClientRepository.updateById(Mockito.any())).thenAnswer(invocation -> { | ||
| JdbcRegistryClientHeartbeatDTO heartbeat = invocation.getArgument(0); | ||
| persistedHeartbeatTimestamp.set(heartbeat.getLastHeartbeatTime()); | ||
| return true; | ||
| }); | ||
|
|
||
| ReflectionTestUtils.invokeMethod(jdbcRegistryServer, "refreshClientsHeartbeat"); | ||
|
|
||
| Truth.assertThat(persistedHeartbeatTimestamp.get()).isGreaterThan(0L); | ||
| } | ||
|
|
||
| @Test | ||
| void refreshClientsHeartbeat_shouldNotRefreshAfterDisconnected() { | ||
| ReflectionTestUtils.setField(jdbcRegistryServer, "jdbcRegistryServerState", | ||
| JdbcRegistryServerState.DISCONNECTED); | ||
|
|
||
| ReflectionTestUtils.invokeMethod(jdbcRegistryServer, "refreshClientsHeartbeat"); | ||
|
|
||
| Mockito.verify(jdbcRegistryClientRepository, Mockito.never()).updateById(Mockito.any()); | ||
| } | ||
| } |
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.
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.
Avoid duplicate
close?