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.

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

Fix recreate sessions when server restarts #563

Merged
merged 1 commit into from
Jan 5, 2021
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
3 changes: 3 additions & 0 deletions broker/src/main/java/io/moquette/broker/IQueueRepository.java
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
package io.moquette.broker;

import java.util.Map;
import java.util.Queue;

public interface IQueueRepository {

Queue<SessionRegistry.EnqueuedMessage> createQueue(String cli, boolean clean);

Map<String, Queue<SessionRegistry.EnqueuedMessage>> listAllQueues();
}
Original file line number Diff line number Diff line change
@@ -1,12 +1,24 @@
package io.moquette.broker;

import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import java.util.Queue;
import java.util.concurrent.ConcurrentLinkedQueue;

public class MemoryQueueRepository implements IQueueRepository {

private Map<String, Queue<SessionRegistry.EnqueuedMessage>> queues = new HashMap<>();

@Override
public Queue<SessionRegistry.EnqueuedMessage> createQueue(String cli, boolean clean) {
return new ConcurrentLinkedQueue<>();
final ConcurrentLinkedQueue<SessionRegistry.EnqueuedMessage> queue = new ConcurrentLinkedQueue<>();
queues.put(cli, queue);
return queue;
}

@Override
public Map<String, Queue<SessionRegistry.EnqueuedMessage>> listAllQueues() {
return Collections.unmodifiableMap(queues);
}
}
5 changes: 4 additions & 1 deletion broker/src/main/java/io/moquette/broker/Session.java
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ static final class Will {
private final String clientId;
private boolean clean;
private Will will;
private Queue<SessionRegistry.EnqueuedMessage> sessionQueue;
private final Queue<SessionRegistry.EnqueuedMessage> sessionQueue;
private final AtomicReference<SessionStatus> status = new AtomicReference<>(SessionStatus.DISCONNECTED);
private MQTTConnection mqttConnection;
private List<Subscription> subscriptions = new ArrayList<>();
Expand All @@ -103,6 +103,9 @@ static final class Will {
}

Session(String clientId, boolean clean, Queue<SessionRegistry.EnqueuedMessage> sessionQueue) {
if (sessionQueue == null) {
throw new IllegalArgumentException("sessionQueue parameter can't be null");
}
this.clientId = clientId;
this.clean = clean;
this.sessionQueue = sessionQueue;
Expand Down
22 changes: 21 additions & 1 deletion broker/src/main/java/io/moquette/broker/SessionRegistry.java
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@

import java.net.InetSocketAddress;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Queue;
import java.util.concurrent.ConcurrentHashMap;
Expand Down Expand Up @@ -56,7 +58,7 @@ static final class PubRelMarker extends EnqueuedMessage {
}

public enum CreationModeEnum {
CREATED_CLEAN_NEW, REOPEN_EXISTING, DROP_EXISTING;
CREATED_CLEAN_NEW, REOPEN_EXISTING, DROP_EXISTING
}

public static class SessionCreationResult {
Expand Down Expand Up @@ -86,6 +88,24 @@ public SessionCreationResult(Session session, CreationModeEnum mode, boolean alr
this.subscriptionsDirectory = subscriptionsDirectory;
this.queueRepository = queueRepository;
this.authorizator = authorizator;
reloadPersistentQueues();
recreateSessionPool();
}

private void reloadPersistentQueues() {
final Map<String, Queue<EnqueuedMessage>> persistentQueues = queueRepository.listAllQueues();
persistentQueues.forEach(queues::put);
}

private void recreateSessionPool() {
for (String clientId : subscriptionsDirectory.listAllSessionIds()) {
// if the subscriptions are present is obviously false
final Queue<EnqueuedMessage> persistentQueue = queues.get(clientId);
if (persistentQueue != null) {
Session rehydrated = new Session(clientId, false, persistentQueue);
pool.put(clientId, rehydrated);
}
}
}

SessionCreationResult createOrReopenSession(MqttConnectMessage msg, String clientId, String username) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,19 @@ public void init(ISubscriptionsRepository subscriptionsRepository) {
}
}

/**
* @return the list of client ids that has a subscription stored.
*/
@Override
public Set<String> listAllSessionIds() {
final List<Subscription> subscriptions = subscriptionsRepository.listAllSubscriptions();
final Set<String> clientIds = new HashSet<>(subscriptions.size());
for (Subscription subscription : subscriptions) {
clientIds.add(subscription.clientId);
}
return clientIds;
}

Optional<CNode> lookup(Topic topic) {
return ctrie.lookup(topic);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ public interface ISubscriptionsDirectory {

void init(ISubscriptionsRepository sessionsRepository);

Set<String> listAllSessionIds();

Set<Subscription> matchWithoutQosSharpening(Topic topic);

Set<Subscription> matchQosSharpening(Topic topic);
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
package io.moquette.persistence;

import io.moquette.broker.IQueueRepository;
import io.moquette.broker.SessionRegistry;
import io.moquette.broker.SessionRegistry.EnqueuedMessage;
import org.h2.mvstore.MVStore;

import java.util.HashMap;
import java.util.Map;
import java.util.Queue;
import java.util.concurrent.ConcurrentLinkedQueue;

Expand All @@ -16,10 +18,20 @@ public H2QueueRepository(MVStore mvStore) {
}

@Override
public Queue<SessionRegistry.EnqueuedMessage> createQueue(String cli, boolean clean) {
public Queue<EnqueuedMessage> createQueue(String cli, boolean clean) {
if (!clean) {
return new H2PersistentQueue<>(mvStore, cli);
}
return new ConcurrentLinkedQueue<>();
}

@Override
public Map<String, Queue<EnqueuedMessage>> listAllQueues() {
Map<String, Queue<EnqueuedMessage>> result = new HashMap<>();
mvStore.getMapNames().stream()
.filter(name -> name.startsWith("queue_") && !name.endsWith("_meta"))
.map(name -> name.substring("queue_".length()))
.forEach(name -> result.put(name, new H2PersistentQueue<EnqueuedMessage>(mvStore, name)));
return result;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,6 @@ public void checkSubscribersGetCorrectQosNotifications() throws Exception {

@Test
public void testSubcriptionDoesntStayActiveAfterARestart() throws Exception {
LOG.info("*** testSubcriptionDoesntStayActiveAfterARestart ***");
// clientForSubscribe1 connect and subscribe to /topic QoS2
MqttClientPersistence dsSubscriberA = new MqttDefaultFilePersistence(
IntegrationUtils.newFolder(tempFolder, "clientForSubscribe1").getAbsolutePath());
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.io.TempDir;

Expand Down Expand Up @@ -93,6 +94,27 @@ public void tearDown() throws Exception {
m_server.stopServer();
}

@DisplayName("given not clean session then after a server restart the session should be present")
@Test
public void testNotCleanSessionIsVisibleAfterServerRestart() throws Exception {
m_subscriber.connect(CLEAN_SESSION_OPT);
m_subscriber.subscribe("/topic", 1);
m_subscriber.disconnect();

m_server.stopServer();
m_server.startServer(IntegrationUtils.prepareTestProperties(dbPath));

//publish a message
m_publisher.connect();
m_publisher.publish("/topic", "Hello world MQTT!!".getBytes(UTF_8), 1, false);

//reconnect subscriber and topic should be sent
m_subscriber.connect(CLEAN_SESSION_OPT);
// verify the sent message while offline is read
MqttMessage msg = m_messageCollector.waitMessage(1);
assertEquals("Hello world MQTT!!", new String(msg.getPayload(), UTF_8));
}

@Test
public void checkRestartCleanSubscriptionTree() throws Exception {
// subscribe to /topic
Expand Down