Merge branch 'use-transactional-db-api' into 'master'

Use transactional database API in Bramble

See merge request briar/briar!974

bramble-api/src/main/java/org/briarproject/bramble/api/Pair.java

+package org.briarproject.bramble.api;
+
+import org.briarproject.bramble.api.nullsafety.NotNullByDefault;
+
+import javax.annotation.concurrent.Immutable;
+
+@Immutable
+@NotNullByDefault
+public class Pair<A, B> {
+
+	private final A first;
+	private final B second;
+
+	public Pair(A first, B second) {
+		this.first = first;
+		this.second = second;
+	}
+
+	public A getFirst() {
+		return first;
+	}
+
+	public B getSecond() {
+		return second;
+	}
+}

bramble-api/src/main/java/org/briarproject/bramble/api/db/DatabaseComponent.java

@@ -89,6 +89,14 @@ public interface DatabaseComponent {
 	<R, E extends Exception> R transactionWithResult(boolean readOnly,
 			DbCallable<R, E> task) throws DbException, E;
 
+	/**
+	 * Runs the given task within a transaction and returns the result of the
+	 * task, which may be null.
+	 */
+	@Nullable
+	<R, E extends Exception> R transactionWithNullableResult(boolean readOnly,
+			DbCallable<R, E> task) throws DbException, E;
+
 	/**
 	 * Stores a contact associated with the given local and remote pseudonyms,
 	 * and returns an ID for the contact.

bramble-api/src/main/java/org/briarproject/bramble/api/db/DbCallable.java

 package org.briarproject.bramble.api.db;
 
+import org.briarproject.bramble.api.nullsafety.NotNullByDefault;
+
+import javax.annotation.Nullable;
+
+@NotNullByDefault
 public interface DbCallable<R, E extends Exception> {
 
+	@Nullable
 	R call(Transaction txn) throws DbException, E;
 }

bramble-api/src/main/java/org/briarproject/bramble/api/db/DbRunnable.java

 package org.briarproject.bramble.api.db;
 
+import org.briarproject.bramble.api.nullsafety.NotNullByDefault;
+
+@NotNullByDefault
 public interface DbRunnable<E extends Exception> {
 
 	void run(Transaction txn) throws DbException, E;

bramble-core/src/main/java/org/briarproject/bramble/client/ClientHelperImpl.java

@@ -82,13 +82,7 @@ class ClientHelperImpl implements ClientHelper {
 	@Override
 	public void addLocalMessage(Message m, BdfDictionary metadata,
 			boolean shared) throws DbException, FormatException {
-		Transaction txn = db.startTransaction(false);
-		try {
-			addLocalMessage(txn, m, metadata, shared);
-			db.commitTransaction(txn);
-		} finally {
-			db.endTransaction(txn);
-		}
+		db.transaction(false, txn -> addLocalMessage(txn, m, metadata, shared));
 	}
 
 	@Override
@@ -113,15 +107,7 @@ class ClientHelperImpl implements ClientHelper {
 
 	@Override
 	public Message getMessage(MessageId m) throws DbException {
-		Message message;
-		Transaction txn = db.startTransaction(true);
-		try {
-			message = getMessage(txn, m);
-			db.commitTransaction(txn);
-		} finally {
-			db.endTransaction(txn);
-		}
-		return message;
+		return db.transactionWithResult(true, txn -> getMessage(txn, m));
 	}
 
 	@Override
@@ -132,15 +118,7 @@ class ClientHelperImpl implements ClientHelper {
 	@Override
 	public BdfList getMessageAsList(MessageId m) throws DbException,
 			FormatException {
-		BdfList list;
-		Transaction txn = db.startTransaction(true);
-		try {
-			list = getMessageAsList(txn, m);
-			db.commitTransaction(txn);
-		} finally {
-			db.endTransaction(txn);
-		}
-		return list;
+		return db.transactionWithResult(true, txn -> getMessageAsList(txn, m));
 	}
 
 	@Override
@@ -152,15 +130,8 @@ class ClientHelperImpl implements ClientHelper {
 	@Override
 	public BdfDictionary getGroupMetadataAsDictionary(GroupId g)
 			throws DbException, FormatException {
-		BdfDictionary dictionary;
-		Transaction txn = db.startTransaction(true);
-		try {
-			dictionary = getGroupMetadataAsDictionary(txn, g);
-			db.commitTransaction(txn);
-		} finally {
-			db.endTransaction(txn);
-		}
-		return dictionary;
+		return db.transactionWithResult(true, txn ->
+				getGroupMetadataAsDictionary(txn, g));
 	}
 
 	@Override
@@ -173,15 +144,8 @@ class ClientHelperImpl implements ClientHelper {
 	@Override
 	public BdfDictionary getMessageMetadataAsDictionary(MessageId m)
 			throws DbException, FormatException {
-		BdfDictionary dictionary;
-		Transaction txn = db.startTransaction(true);
-		try {
-			dictionary = getMessageMetadataAsDictionary(txn, m);
-			db.commitTransaction(txn);
-		} finally {
-			db.endTransaction(txn);
-		}
-		return dictionary;
+		return db.transactionWithResult(true, txn ->
+				getMessageMetadataAsDictionary(txn, m));
 	}
 
 	@Override
@@ -194,15 +158,8 @@ class ClientHelperImpl implements ClientHelper {
 	@Override
 	public Map<MessageId, BdfDictionary> getMessageMetadataAsDictionary(
 			GroupId g) throws DbException, FormatException {
-		Map<MessageId, BdfDictionary> map;
-		Transaction txn = db.startTransaction(true);
-		try {
-			map = getMessageMetadataAsDictionary(txn, g);
-			db.commitTransaction(txn);
-		} finally {
-			db.endTransaction(txn);
-		}
-		return map;
+		return db.transactionWithResult(true, txn ->
+				getMessageMetadataAsDictionary(txn, g));
 	}
 
 	@Override
@@ -219,15 +176,8 @@ class ClientHelperImpl implements ClientHelper {
 	public Map<MessageId, BdfDictionary> getMessageMetadataAsDictionary(
 			GroupId g, BdfDictionary query) throws DbException,
 			FormatException {
-		Map<MessageId, BdfDictionary> map;
-		Transaction txn = db.startTransaction(true);
-		try {
-			map = getMessageMetadataAsDictionary(txn, g, query);
-			db.commitTransaction(txn);
-		} finally {
-			db.endTransaction(txn);
-		}
-		return map;
+		return db.transactionWithResult(true, txn ->
+				getMessageMetadataAsDictionary(txn, g, query));
 	}
 
 	@Override
@@ -245,13 +195,7 @@ class ClientHelperImpl implements ClientHelper {
 	@Override
 	public void mergeGroupMetadata(GroupId g, BdfDictionary metadata)
 			throws DbException, FormatException {
-		Transaction txn = db.startTransaction(false);
-		try {
-			mergeGroupMetadata(txn, g, metadata);
-			db.commitTransaction(txn);
-		} finally {
-			db.endTransaction(txn);
-		}
+		db.transaction(false, txn -> mergeGroupMetadata(txn, g, metadata));
 	}
 
 	@Override
@@ -263,13 +207,7 @@ class ClientHelperImpl implements ClientHelper {
 	@Override
 	public void mergeMessageMetadata(MessageId m, BdfDictionary metadata)
 			throws DbException, FormatException {
-		Transaction txn = db.startTransaction(false);
-		try {
-			mergeMessageMetadata(txn, m, metadata);
-			db.commitTransaction(txn);
-		} finally {
-			db.endTransaction(txn);
-		}
+		db.transaction(false, txn -> mergeMessageMetadata(txn, m, metadata));
 	}
 
 	@Override

bramble-core/src/main/java/org/briarproject/bramble/contact/ContactExchangeTaskImpl.java

@@ -13,7 +13,6 @@ import org.briarproject.bramble.api.data.BdfList;
 import org.briarproject.bramble.api.db.ContactExistsException;
 import org.briarproject.bramble.api.db.DatabaseComponent;
 import org.briarproject.bramble.api.db.DbException;
-import org.briarproject.bramble.api.db.Transaction;
 import org.briarproject.bramble.api.identity.Author;
 import org.briarproject.bramble.api.identity.LocalAuthor;
 import org.briarproject.bramble.api.nullsafety.MethodsNotNullByDefault;
@@ -158,7 +157,8 @@ class ContactExchangeTaskImpl extends Thread implements ContactExchangeTask {
 				streamWriterFactory.createContactExchangeStreamWriter(out,
 						alice ? aliceHeaderKey : bobHeaderKey);
 		RecordWriter recordWriter =
-				recordWriterFactory.createRecordWriter(streamWriter.getOutputStream());
+				recordWriterFactory
+						.createRecordWriter(streamWriter.getOutputStream());
 
 		// Derive the nonces to be signed
 		byte[] aliceNonce = crypto.mac(ALICE_NONCE_LABEL, masterSecret,
@@ -287,19 +287,14 @@ class ContactExchangeTaskImpl extends Thread implements ContactExchangeTask {
 	private ContactId addContact(Author remoteAuthor, long timestamp,
 			Map<TransportId, TransportProperties> remoteProperties)
 			throws DbException {
-		ContactId contactId;
-		Transaction txn = db.startTransaction(false);
-		try {
-			contactId = contactManager.addContact(txn, remoteAuthor,
+		return db.transactionWithResult(false, txn -> {
+			ContactId contactId = contactManager.addContact(txn, remoteAuthor,
 					localAuthor.getId(), masterSecret, timestamp, alice,
 					true, true);
 			transportPropertyManager.addRemoteProperties(txn, contactId,
 					remoteProperties);
-			db.commitTransaction(txn);
-		} finally {
-			db.endTransaction(txn);
-		}
-		return contactId;
+			return contactId;
+		});
 	}
 
 	private void tryToClose(DuplexTransportConnection conn) {

bramble-core/src/main/java/org/briarproject/bramble/contact/ContactManagerImpl.java

@@ -79,42 +79,21 @@ class ContactManagerImpl implements ContactManager {
 	public ContactId addContact(Author remote, AuthorId local, SecretKey master,
 			long timestamp, boolean alice, boolean verified, boolean active)
 			throws DbException {
-		ContactId c;
-		Transaction txn = db.startTransaction(false);
-		try {
-			c = addContact(txn, remote, local, master, timestamp, alice,
-					verified, active);
-			db.commitTransaction(txn);
-		} finally {
-			db.endTransaction(txn);
-		}
-		return c;
+		return db.transactionWithResult(false, txn ->
+				addContact(txn, remote, local, master, timestamp, alice,
+						verified, active));
 	}
 
 	@Override
 	public Contact getContact(ContactId c) throws DbException {
-		Contact contact;
-		Transaction txn = db.startTransaction(true);
-		try {
-			contact = db.getContact(txn, c);
-			db.commitTransaction(txn);
-		} finally {
-			db.endTransaction(txn);
-		}
-		return contact;
+		return db.transactionWithResult(true, txn -> db.getContact(txn, c));
 	}
 
 	@Override
 	public Contact getContact(AuthorId remoteAuthorId, AuthorId localAuthorId)
 			throws DbException {
-		Transaction txn = db.startTransaction(true);
-		try {
-			Contact c = getContact(txn, remoteAuthorId, localAuthorId);
-			db.commitTransaction(txn);
-			return c;
-		} finally {
-			db.endTransaction(txn);
-		}
+		return db.transactionWithResult(true, txn ->
+				getContact(txn, remoteAuthorId, localAuthorId));
 	}
 
 	@Override
@@ -132,14 +111,8 @@ class ContactManagerImpl implements ContactManager {
 
 	@Override
 	public Collection<Contact> getActiveContacts() throws DbException {
-		Collection<Contact> contacts;
-		Transaction txn = db.startTransaction(true);
-		try {
-			contacts = db.getContacts(txn);
-			db.commitTransaction(txn);
-		} finally {
-			db.endTransaction(txn);
-		}
+		Collection<Contact> contacts =
+				db.transactionWithResult(true, db::getContacts);
 		List<Contact> active = new ArrayList<>(contacts.size());
 		for (Contact c : contacts) if (c.isActive()) active.add(c);
 		return active;
@@ -147,13 +120,7 @@ class ContactManagerImpl implements ContactManager {
 
 	@Override
 	public void removeContact(ContactId c) throws DbException {
-		Transaction txn = db.startTransaction(false);
-		try {
-			removeContact(txn, c);
-			db.commitTransaction(txn);
-		} finally {
-			db.endTransaction(txn);
-		}
+		db.transaction(false, txn -> removeContact(txn, c));
 	}
 
 	@Override
@@ -188,15 +155,8 @@ class ContactManagerImpl implements ContactManager {
 	@Override
 	public boolean contactExists(AuthorId remoteAuthorId,
 			AuthorId localAuthorId) throws DbException {
-		boolean exists;
-		Transaction txn = db.startTransaction(true);
-		try {
-			exists = contactExists(txn, remoteAuthorId, localAuthorId);
-			db.commitTransaction(txn);
-		} finally {
-			db.endTransaction(txn);
-		}
-		return exists;
+		return db.transactionWithResult(true, txn ->
+				contactExists(txn, remoteAuthorId, localAuthorId));
 	}
 
 	@Override

bramble-core/src/main/java/org/briarproject/bramble/db/DatabaseComponentImpl.java

@@ -183,6 +183,14 @@ class DatabaseComponentImpl<T> implements DatabaseComponent {
 	@Override
 	public <R, E extends Exception> R transactionWithResult(boolean readOnly,
 			DbCallable<R, E> task) throws DbException, E {
+		R result = transactionWithNullableResult(readOnly, task);
+		if (result == null) throw new NullPointerException();
+		return result;
+	}
+
+	@Override
+	public <R, E extends Exception> R transactionWithNullableResult(
+			boolean readOnly, DbCallable<R, E> task) throws DbException, E {
 		Transaction txn = startTransaction(readOnly);
 		try {
 			R result = task.call(txn);
@@ -861,7 +869,7 @@ class DatabaseComponentImpl<T> implements DatabaseComponent {
 
 	@Override
 	public void setContactAlias(Transaction transaction, ContactId c,
-			String alias) throws DbException {
+			@Nullable String alias) throws DbException {
 		if (transaction.isReadOnly()) throw new IllegalArgumentException();
 		T txn = unbox(transaction);
 		if (!db.containsContact(txn, c))

bramble-core/src/main/java/org/briarproject/bramble/identity/IdentityManagerImpl.java

@@ -67,27 +67,16 @@ class IdentityManagerImpl implements IdentityManager {
 			LOG.info("No local author to store");
 			return;
 		}
-		Transaction txn = db.startTransaction(false);
-		try {
-			db.addLocalAuthor(txn, cached);
-			db.commitTransaction(txn);
-			LOG.info("Local author stored");
-		} finally {
-			db.endTransaction(txn);
-		}
+		db.transaction(false, txn -> db.addLocalAuthor(txn, cached));
+		LOG.info("Local author stored");
 	}
 
 	@Override
 	public LocalAuthor getLocalAuthor() throws DbException {
 		if (cachedAuthor == null) {
-			Transaction txn = db.startTransaction(true);
-			try {
-				cachedAuthor = loadLocalAuthor(txn);
-				LOG.info("Local author loaded");
-				db.commitTransaction(txn);
-			} finally {
-				db.endTransaction(txn);
-			}
+			cachedAuthor =
+					db.transactionWithResult(true, this::loadLocalAuthor);
+			LOG.info("Local author loaded");
 		}
 		LocalAuthor cached = cachedAuthor;
 		if (cached == null) throw new AssertionError();

bramble-core/src/main/java/org/briarproject/bramble/lifecycle/LifecycleManagerImpl.java

@@ -6,7 +6,6 @@ import org.briarproject.bramble.api.db.DataTooOldException;
 import org.briarproject.bramble.api.db.DatabaseComponent;
 import org.briarproject.bramble.api.db.DbException;
 import org.briarproject.bramble.api.db.MigrationListener;
-import org.briarproject.bramble.api.db.Transaction;
 import org.briarproject.bramble.api.event.EventBus;
 import org.briarproject.bramble.api.identity.IdentityManager;
 import org.briarproject.bramble.api.lifecycle.LifecycleManager;
@@ -115,20 +114,16 @@ class LifecycleManagerImpl implements LifecycleManager, MigrationListener {
 			dbLatch.countDown();
 			eventBus.broadcast(new LifecycleEvent(STARTING_SERVICES));
 
-			Transaction txn = db.startTransaction(false);
-			try {
+			db.transaction(false, txn -> {
 				for (Client c : clients) {
-					start = now();
+					long start1 = now();
 					c.createLocalState(txn);
 					if (LOG.isLoggable(FINE)) {
 						logDuration(LOG, "Starting client "
-								+ c.getClass().getSimpleName(), start);
+								+ c.getClass().getSimpleName(), start1);
 					}
 				}
-				db.commitTransaction(txn);
-			} finally {
-				db.endTransaction(txn);
-			}
+			});
 			for (Service s : services) {
 				start = now();
 				s.startService();

bramble-core/src/main/java/org/briarproject/bramble/properties/TransportPropertyManagerImpl.java

@@ -142,15 +142,7 @@ class TransportPropertyManagerImpl implements TransportPropertyManager,
 	@Override
 	public Map<TransportId, TransportProperties> getLocalProperties()
 			throws DbException {
-		Map<TransportId, TransportProperties> local;
-		Transaction txn = db.startTransaction(true);
-		try {
-			local = getLocalProperties(txn);
-			db.commitTransaction(txn);
-		} finally {
-			db.endTransaction(txn);
-		}
-		return local;
+		return db.transactionWithResult(true, this::getLocalProperties);
 	}
 
 	@Override
@@ -176,9 +168,8 @@ class TransportPropertyManagerImpl implements TransportPropertyManager,
 	public TransportProperties getLocalProperties(TransportId t)
 			throws DbException {
 		try {
-			TransportProperties p = null;
-			Transaction txn = db.startTransaction(true);
-			try {
+			return db.transactionWithResult(true, txn -> {
+				TransportProperties p = null;
 				// Find the latest local update
 				LatestUpdate latest = findLatest(txn, localGroup.getId(), t,
 						true);
@@ -188,11 +179,8 @@ class TransportPropertyManagerImpl implements TransportPropertyManager,
 							latest.messageId);
 					p = parseProperties(message);
 				}
-				db.commitTransaction(txn);
-			} finally {
-				db.endTransaction(txn);
-			}
-			return p == null ? new TransportProperties() : p;
+				return p == null ? new TransportProperties() : p;
+			});
 		} catch (FormatException e) {
 			throw new DbException(e);
 		}
@@ -201,16 +189,12 @@ class TransportPropertyManagerImpl implements TransportPropertyManager,
 	@Override
 	public Map<ContactId, TransportProperties> getRemoteProperties(
 			TransportId t) throws DbException {
-		Map<ContactId, TransportProperties> remote = new HashMap<>();
-		Transaction txn = db.startTransaction(true);
-		try {
+		return db.transactionWithResult(true, txn -> {
+			Map<ContactId, TransportProperties> remote = new HashMap<>();
 			for (Contact c : db.getContacts(txn))
 				remote.put(c.getId(), getRemoteProperties(txn, c, t));
-			db.commitTransaction(txn);
-		} finally {
-			db.endTransaction(txn);
-		}
-		return remote;
+			return remote;
+		});
 	}
 
 	private TransportProperties getRemoteProperties(Transaction txn, Contact c,
@@ -234,23 +218,15 @@ class TransportPropertyManagerImpl implements TransportPropertyManager,
 	@Override
 	public TransportProperties getRemoteProperties(ContactId c, TransportId t)
 			throws DbException {
-		TransportProperties p;
-		Transaction txn = db.startTransaction(true);
-		try {
-			p = getRemoteProperties(txn, db.getContact(txn, c), t);
-			db.commitTransaction(txn);
-		} finally {
-			db.endTransaction(txn);
-		}
-		return p;
+		return db.transactionWithResult(true, txn ->
+				getRemoteProperties(txn, db.getContact(txn, c), t));
 	}
 
 	@Override
 	public void mergeLocalProperties(TransportId t, TransportProperties p)
 			throws DbException {
 		try {
-			Transaction txn = db.startTransaction(false);
-			try {
+			db.transaction(false, txn -> {
 				// Merge the new properties with any existing properties
 				TransportProperties merged;
 				boolean changed;
@@ -287,10 +263,7 @@ class TransportPropertyManagerImpl implements TransportPropertyManager,
 							db.removeMessage(txn, latest.messageId);
 					}
 				}
-				db.commitTransaction(txn);
-			} finally {
-				db.endTransaction(txn);
-			}
+			});
 		} catch (FormatException e) {
 			throw new DbException(e);
 		}

bramble-core/src/main/java/org/briarproject/bramble/settings/SettingsManagerImpl.java

@@ -23,15 +23,8 @@ class SettingsManagerImpl implements SettingsManager {
 
 	@Override
 	public Settings getSettings(String namespace) throws DbException {
-		Settings s;
-		Transaction txn = db.startTransaction(true);
-		try {
-			s = db.getSettings(txn, namespace);
-			db.commitTransaction(txn);
-		} finally {
-			db.endTransaction(txn);
-		}
-		return s;
+		return db.transactionWithResult(true, txn ->
+				db.getSettings(txn, namespace));
 	}
 
 	@Override
@@ -42,12 +35,6 @@ class SettingsManagerImpl implements SettingsManager {
 
 	@Override
 	public void mergeSettings(Settings s, String namespace) throws DbException {
-		Transaction txn = db.startTransaction(false);
-		try {
-			db.mergeSettings(txn,