Use client version to register validators, delivery hooks.

This commit is contained in:
akwizgran
2018-04-13 16:11:03 +01:00
parent 1197d65d8d
commit 114044ee5f
13 changed files with 88 additions and 62 deletions

View File

@@ -15,6 +15,7 @@ import dagger.Module;
import dagger.Provides;
import static org.briarproject.bramble.api.properties.TransportPropertyManager.CLIENT_ID;
import static org.briarproject.bramble.api.properties.TransportPropertyManager.CLIENT_VERSION;
@Module
public class PropertiesModule {
@@ -33,7 +34,8 @@ public class PropertiesModule {
Clock clock) {
TransportPropertyValidator validator = new TransportPropertyValidator(
clientHelper, metadataEncoder, clock);
validationManager.registerMessageValidator(CLIENT_ID, validator);
validationManager.registerMessageValidator(CLIENT_ID, CLIENT_VERSION,
validator);
return validator;
}
@@ -44,7 +46,7 @@ public class PropertiesModule {
ValidationManager validationManager, ContactManager contactManager,
TransportPropertyManagerImpl transportPropertyManager) {
lifecycleManager.registerClient(transportPropertyManager);
validationManager.registerIncomingMessageHook(CLIENT_ID,
validationManager.registerIncomingMessageHook(CLIENT_ID, CLIENT_VERSION,
transportPropertyManager);
contactManager.registerContactHook(transportPropertyManager);
return transportPropertyManager;

View File

@@ -38,5 +38,10 @@ class ClientVersion implements Comparable<ClientVersion> {
if (compare != 0) return compare;
return clientVersion - c.clientVersion;
}
@Override
public String toString() {
return clientId.getString() + ":" + clientVersion;
}
}

View File

@@ -28,6 +28,7 @@ import dagger.Module;
import dagger.Provides;
import static org.briarproject.bramble.api.sync.ClientVersioningManager.CLIENT_ID;
import static org.briarproject.bramble.api.sync.ClientVersioningManager.CLIENT_VERSION;
@Module
public class SyncModule {
@@ -110,7 +111,7 @@ public class SyncModule {
lifecycleManager.registerClient(clientVersioningManager);
lifecycleManager.registerService(clientVersioningManager);
contactManager.registerContactHook(clientVersioningManager);
validationManager.registerIncomingMessageHook(CLIENT_ID,
validationManager.registerIncomingMessageHook(CLIENT_ID, CLIENT_VERSION,
clientVersioningManager);
return clientVersioningManager;
}
@@ -122,7 +123,8 @@ public class SyncModule {
Clock clock, ValidationManager validationManager) {
ClientVersioningValidator validator = new ClientVersioningValidator(
clientHelper, metadataEncoder, clock);
validationManager.registerMessageValidator(CLIENT_ID, validator);
validationManager.registerMessageValidator(CLIENT_ID, CLIENT_VERSION,
validator);
return validator;
}
}

View File

@@ -51,8 +51,8 @@ class ValidationManagerImpl implements ValidationManager, Service,
private final DatabaseComponent db;
private final Executor dbExecutor, validationExecutor;
private final MessageFactory messageFactory;
private final Map<ClientId, MessageValidator> validators;
private final Map<ClientId, IncomingMessageHook> hooks;
private final Map<ClientVersion, MessageValidator> validators;
private final Map<ClientVersion, IncomingMessageHook> hooks;
private final AtomicBoolean used = new AtomicBoolean(false);
@Inject
@@ -81,14 +81,15 @@ class ValidationManagerImpl implements ValidationManager, Service,
}
@Override
public void registerMessageValidator(ClientId c, MessageValidator v) {
validators.put(c, v);
public void registerMessageValidator(ClientId c, int clientVersion,
MessageValidator v) {
validators.put(new ClientVersion(c, clientVersion), v);
}
@Override
public void registerIncomingMessageHook(ClientId c,
public void registerIncomingMessageHook(ClientId c, int clientVersion,
IncomingMessageHook hook) {
hooks.put(c, hook);
hooks.put(new ClientVersion(c, clientVersion), hook);
}
private void validateOutstandingMessagesAsync() {
@@ -199,9 +200,11 @@ class ValidationManagerImpl implements ValidationManager, Service,
Message m = messageFactory.createMessage(id, raw);
Group g = db.getGroup(txn, m.getGroupId());
ClientId c = g.getClientId();
int clientVersion = g.getClientVersion();
Metadata meta =
db.getMessageMetadataForValidator(txn, id);
DeliveryResult result = deliverMessage(txn, m, c, meta);
DeliveryResult result =
deliverMessage(txn, m, c, clientVersion, meta);
if (result.valid) {
pending.addAll(getPendingDependents(txn, id));
if (result.share) {
@@ -237,14 +240,16 @@ class ValidationManagerImpl implements ValidationManager, Service,
@ValidationExecutor
private void validateMessage(Message m, Group g) {
MessageValidator v = validators.get(g.getClientId());
ClientVersion cv =
new ClientVersion(g.getClientId(), g.getClientVersion());
MessageValidator v = validators.get(cv);
if (v == null) {
if (LOG.isLoggable(WARNING))
LOG.warning("No validator for " + g.getClientId().getString());
if (LOG.isLoggable(WARNING)) LOG.warning("No validator for " + cv);
} else {
try {
MessageContext context = v.validateMessage(m, g);
storeMessageContextAsync(m, g.getClientId(), context);
storeMessageContextAsync(m, g.getClientId(),
g.getClientVersion(), context);
} catch (InvalidMessageException e) {
if (LOG.isLoggable(INFO))
LOG.log(INFO, e.toString(), e);
@@ -256,12 +261,13 @@ class ValidationManagerImpl implements ValidationManager, Service,
}
private void storeMessageContextAsync(Message m, ClientId c,
MessageContext result) {
dbExecutor.execute(() -> storeMessageContext(m, c, result));
int clientVersion, MessageContext result) {
dbExecutor.execute(() ->
storeMessageContext(m, c, clientVersion, result));
}
@DatabaseExecutor
private void storeMessageContext(Message m, ClientId c,
private void storeMessageContext(Message m, ClientId c, int clientVersion,
MessageContext context) {
try {
MessageId id = m.getId();
@@ -292,7 +298,8 @@ class ValidationManagerImpl implements ValidationManager, Service,
Metadata meta = context.getMetadata();
db.mergeMessageMetadata(txn, id, meta);
if (allDelivered) {
DeliveryResult result = deliverMessage(txn, m, c, meta);
DeliveryResult result =
deliverMessage(txn, m, c, clientVersion, meta);
if (result.valid) {
pending = getPendingDependents(txn, id);
if (result.share) {
@@ -324,10 +331,11 @@ class ValidationManagerImpl implements ValidationManager, Service,
@DatabaseExecutor
private DeliveryResult deliverMessage(Transaction txn, Message m,
ClientId c, Metadata meta) throws DbException {
ClientId c, int clientVersion, Metadata meta) throws DbException {
// Deliver the message to the client if it's registered a hook
boolean shareMsg = false;
IncomingMessageHook hook = hooks.get(c);
ClientVersion cv = new ClientVersion(c, clientVersion);
IncomingMessageHook hook = hooks.get(cv);
if (hook != null) {
try {
shareMsg = hook.incomingMessage(txn, m, meta);

View File

@@ -53,10 +53,11 @@ public class ValidationManagerImplTest extends BrambleMockTestCase {
private final Executor dbExecutor = new ImmediateExecutor();
private final Executor validationExecutor = new ImmediateExecutor();
private final ClientId clientId = getClientId();
private final int clientVersion = 123;
private final MessageId messageId = new MessageId(getRandomId());
private final MessageId messageId1 = new MessageId(getRandomId());
private final MessageId messageId2 = new MessageId(getRandomId());
private final Group group = getGroup(clientId, 123);
private final Group group = getGroup(clientId, clientVersion);
private final GroupId groupId = group.getId();
private final long timestamp = System.currentTimeMillis();
private final byte[] raw = new byte[123];
@@ -85,8 +86,8 @@ public class ValidationManagerImplTest extends BrambleMockTestCase {
public void setUp() {
vm = new ValidationManagerImpl(db, dbExecutor, validationExecutor,
messageFactory);
vm.registerMessageValidator(clientId, validator);
vm.registerIncomingMessageHook(clientId, hook);
vm.registerMessageValidator(clientId, clientVersion, validator);
vm.registerIncomingMessageHook(clientId, clientVersion, hook);
}
@Test