JAMES-1945 Introduce CassandraFirstUnseenDAO and its tests
Project: http://git-wip-us.apache.org/repos/asf/james-project/repo Commit: http://git-wip-us.apache.org/repos/asf/james-project/commit/62c21537 Tree: http://git-wip-us.apache.org/repos/asf/james-project/tree/62c21537 Diff: http://git-wip-us.apache.org/repos/asf/james-project/diff/62c21537 Branch: refs/heads/master Commit: 62c215377ba0893b9380281f270c554618f847c6 Parents: fda6bc6 Author: Benoit Tellier <[email protected]> Authored: Tue Feb 21 14:54:04 2017 +0700 Committer: Antoine Duprat <[email protected]> Committed: Tue Feb 21 16:41:54 2017 +0100 ---------------------------------------------------------------------- .../cassandra/mail/CassandraFirstUnseenDAO.java | 99 +++++++++++++ .../mail/CassandraFirstUnseenDAOTest.java | 147 +++++++++++++++++++ .../modules/mailbox/CassandraMailboxModule.java | 1 + 3 files changed, 247 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/james-project/blob/62c21537/mailbox/cassandra/src/main/java/org/apache/james/mailbox/cassandra/mail/CassandraFirstUnseenDAO.java ---------------------------------------------------------------------- diff --git a/mailbox/cassandra/src/main/java/org/apache/james/mailbox/cassandra/mail/CassandraFirstUnseenDAO.java b/mailbox/cassandra/src/main/java/org/apache/james/mailbox/cassandra/mail/CassandraFirstUnseenDAO.java new file mode 100644 index 0000000..436efd6 --- /dev/null +++ b/mailbox/cassandra/src/main/java/org/apache/james/mailbox/cassandra/mail/CassandraFirstUnseenDAO.java @@ -0,0 +1,99 @@ +/**************************************************************** + * 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.james.mailbox.cassandra.mail; + +import static com.datastax.driver.core.querybuilder.QueryBuilder.asc; +import static com.datastax.driver.core.querybuilder.QueryBuilder.bindMarker; +import static com.datastax.driver.core.querybuilder.QueryBuilder.delete; +import static com.datastax.driver.core.querybuilder.QueryBuilder.eq; +import static com.datastax.driver.core.querybuilder.QueryBuilder.insertInto; +import static com.datastax.driver.core.querybuilder.QueryBuilder.select; +import static org.apache.james.mailbox.cassandra.table.CassandraFirstUnseenTable.MAILBOX_ID; +import static org.apache.james.mailbox.cassandra.table.CassandraFirstUnseenTable.TABLE_NAME; +import static org.apache.james.mailbox.cassandra.table.CassandraFirstUnseenTable.UID; + +import java.util.Optional; +import java.util.concurrent.CompletableFuture; + +import javax.inject.Inject; + +import org.apache.james.backends.cassandra.utils.CassandraAsyncExecutor; +import org.apache.james.mailbox.MessageUid; +import org.apache.james.mailbox.cassandra.CassandraId; + +import com.datastax.driver.core.PreparedStatement; +import com.datastax.driver.core.Session; + +public class CassandraFirstUnseenDAO { + private final CassandraAsyncExecutor cassandraAsyncExecutor; + private final PreparedStatement addStatement; + private final PreparedStatement deleteStatement; + private final PreparedStatement readStatement; + + @Inject + public CassandraFirstUnseenDAO(Session session) { + this.cassandraAsyncExecutor = new CassandraAsyncExecutor(session); + this.addStatement = prepareAddStatement(session); + this.deleteStatement = prepareDeleteStatement(session); + this.readStatement = prepareReadStatement(session); + } + + private PreparedStatement prepareReadStatement(Session session) { + return session.prepare(select(UID) + .from(TABLE_NAME) + .where(eq(MAILBOX_ID, bindMarker(MAILBOX_ID))) + .orderBy(asc(UID)) + .limit(1)); + } + + private PreparedStatement prepareDeleteStatement(Session session) { + return session.prepare(delete() + .from(TABLE_NAME) + .where(eq(MAILBOX_ID, bindMarker(MAILBOX_ID))) + .and(eq(UID, bindMarker(UID)))); + } + + private PreparedStatement prepareAddStatement(Session session) { + return session.prepare(insertInto(TABLE_NAME) + .value(MAILBOX_ID, bindMarker(MAILBOX_ID)) + .value(UID, bindMarker(UID))); + } + + public CompletableFuture<Void> addUnread(CassandraId cassandraId, MessageUid uid) { + return cassandraAsyncExecutor.executeVoid( + addStatement.bind() + .setUUID(MAILBOX_ID, cassandraId.asUuid()) + .setLong(UID, uid.asLong())); + } + + public CompletableFuture<Void> removeUnread(CassandraId cassandraId, MessageUid uid) { + return cassandraAsyncExecutor.executeVoid(deleteStatement.bind() + .setUUID(MAILBOX_ID, cassandraId.asUuid()) + .setLong(UID, uid.asLong())); + } + + public CompletableFuture<Optional<MessageUid>> retrieveFirstUnread(CassandraId cassandraId) { + return cassandraAsyncExecutor.executeSingleRow( + readStatement.bind() + .setUUID(MAILBOX_ID, cassandraId.asUuid())) + .thenApply(optional -> optional.map(row -> MessageUid.of(row.getLong(UID)))); + } + +} http://git-wip-us.apache.org/repos/asf/james-project/blob/62c21537/mailbox/cassandra/src/test/java/org/apache/james/mailbox/cassandra/mail/CassandraFirstUnseenDAOTest.java ---------------------------------------------------------------------- diff --git a/mailbox/cassandra/src/test/java/org/apache/james/mailbox/cassandra/mail/CassandraFirstUnseenDAOTest.java b/mailbox/cassandra/src/test/java/org/apache/james/mailbox/cassandra/mail/CassandraFirstUnseenDAOTest.java new file mode 100644 index 0000000..d87f220 --- /dev/null +++ b/mailbox/cassandra/src/test/java/org/apache/james/mailbox/cassandra/mail/CassandraFirstUnseenDAOTest.java @@ -0,0 +1,147 @@ +/**************************************************************** + * 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.james.mailbox.cassandra.mail; + +import static org.assertj.core.api.Assertions.assertThat; + +import java.util.Optional; + +import org.apache.james.backends.cassandra.CassandraCluster; +import org.apache.james.mailbox.MessageUid; +import org.apache.james.mailbox.cassandra.CassandraId; +import org.apache.james.mailbox.cassandra.modules.CassandraFirstUnseenModule; +import org.junit.After; +import org.junit.Before; +import org.junit.Test; + +public class CassandraFirstUnseenDAOTest { + public static final CassandraId MAILBOX_ID = CassandraId.timeBased(); + public static final MessageUid UID_1 = MessageUid.of(1); + public static final MessageUid UID_2 = MessageUid.of(2); + + private CassandraCluster cassandra; + private CassandraFirstUnseenDAO testee; + + @Before + public void setUp() { + cassandra = CassandraCluster.create( + new CassandraFirstUnseenModule()); + cassandra.ensureAllTables(); + + testee = new CassandraFirstUnseenDAO(cassandra.getConf()); + } + + @After + public void tearDown() { + cassandra.clearAllTables(); + } + + @Test + public void retrieveFirstUnreadShouldReturnEmptyByDefault() { + assertThat(testee.retrieveFirstUnread(MAILBOX_ID).join().isPresent()) + .isFalse(); + } + + @Test + public void addUnreadShouldThenBeReportedAsFirstUnseen() { + testee.addUnread(MAILBOX_ID, UID_1).join(); + + Optional<MessageUid> firstUnseen = testee.retrieveFirstUnread(MAILBOX_ID).join(); + + assertThat(firstUnseen.isPresent()).isTrue(); + assertThat(firstUnseen.get()).isEqualTo(UID_1); + } + + @Test + public void retrieveFirstUnreadShouldReturnLowestUnreadUid() { + testee.addUnread(MAILBOX_ID, UID_1).join(); + + testee.addUnread(MAILBOX_ID, UID_2).join(); + + Optional<MessageUid> firstUnseen = testee.retrieveFirstUnread(MAILBOX_ID).join(); + assertThat(firstUnseen.isPresent()).isTrue(); + assertThat(firstUnseen.get()).isEqualTo(UID_1); + } + + @Test + public void retrieveFirstUnreadShouldBeOrderIndependent() { + testee.addUnread(MAILBOX_ID, UID_2).join(); + + testee.addUnread(MAILBOX_ID, UID_1).join(); + + Optional<MessageUid> firstUnseen = testee.retrieveFirstUnread(MAILBOX_ID).join(); + assertThat(firstUnseen.isPresent()).isTrue(); + assertThat(firstUnseen.get()).isEqualTo(UID_1); + } + + @Test + public void addUnreadShouldBeIdempotent() { + testee.addUnread(MAILBOX_ID, UID_1).join(); + + testee.addUnread(MAILBOX_ID, UID_1).join(); + + Optional<MessageUid> firstUnseen = testee.retrieveFirstUnread(MAILBOX_ID).join(); + assertThat(firstUnseen.isPresent()).isTrue(); + assertThat(firstUnseen.get()).isEqualTo(UID_1); + } + + + @Test + public void removeUnreadShouldReturnWhenNoData() { + testee.removeUnread(MAILBOX_ID, UID_1).join(); + + Optional<MessageUid> firstUnseen = testee.retrieveFirstUnread(MAILBOX_ID).join(); + assertThat(firstUnseen.isPresent()).isFalse(); + } + + @Test + public void removeUnreadShouldRemoveOnlyUnread() { + testee.addUnread(MAILBOX_ID, UID_1).join(); + + testee.removeUnread(MAILBOX_ID, UID_1).join(); + + Optional<MessageUid> firstUnseen = testee.retrieveFirstUnread(MAILBOX_ID).join(); + assertThat(firstUnseen.isPresent()).isFalse(); + } + + @Test + public void removeUnreadShouldRemoveLastUnread() { + testee.addUnread(MAILBOX_ID, UID_1).join(); + testee.addUnread(MAILBOX_ID, UID_2).join(); + + testee.removeUnread(MAILBOX_ID, UID_2).join(); + + Optional<MessageUid> firstUnseen = testee.retrieveFirstUnread(MAILBOX_ID).join(); + assertThat(firstUnseen.isPresent()).isTrue(); + assertThat(firstUnseen.get()).isEqualTo(UID_1); + } + + @Test + public void removeUnreadShouldHaveNoEffectWhenNotLast() { + testee.addUnread(MAILBOX_ID, UID_1).join(); + testee.addUnread(MAILBOX_ID, UID_2).join(); + + testee.removeUnread(MAILBOX_ID, UID_1).join(); + + Optional<MessageUid> firstUnseen = testee.retrieveFirstUnread(MAILBOX_ID).join(); + assertThat(firstUnseen.isPresent()).isTrue(); + assertThat(firstUnseen.get()).isEqualTo(UID_2); + } +} http://git-wip-us.apache.org/repos/asf/james-project/blob/62c21537/server/container/guice/cassandra-guice/src/main/java/org/apache/james/modules/mailbox/CassandraMailboxModule.java ---------------------------------------------------------------------- diff --git a/server/container/guice/cassandra-guice/src/main/java/org/apache/james/modules/mailbox/CassandraMailboxModule.java b/server/container/guice/cassandra-guice/src/main/java/org/apache/james/modules/mailbox/CassandraMailboxModule.java index a786964..cbc6575 100644 --- a/server/container/guice/cassandra-guice/src/main/java/org/apache/james/modules/mailbox/CassandraMailboxModule.java +++ b/server/container/guice/cassandra-guice/src/main/java/org/apache/james/modules/mailbox/CassandraMailboxModule.java @@ -108,6 +108,7 @@ public class CassandraMailboxModule extends AbstractModule { cassandraDataDefinitions.addBinding().to(org.apache.james.mailbox.cassandra.modules.CassandraAclModule.class); cassandraDataDefinitions.addBinding().to(org.apache.james.mailbox.cassandra.modules.CassandraMailboxCounterModule.class); cassandraDataDefinitions.addBinding().to(org.apache.james.mailbox.cassandra.modules.CassandraMailboxRecentsModule.class); + cassandraDataDefinitions.addBinding().to(org.apache.james.mailbox.cassandra.modules.CassandraFirstUnseenModule.class); cassandraDataDefinitions.addBinding().to(org.apache.james.mailbox.cassandra.modules.CassandraMailboxModule.class); cassandraDataDefinitions.addBinding().to(org.apache.james.mailbox.cassandra.modules.CassandraMessageModule.class); cassandraDataDefinitions.addBinding().to(org.apache.james.mailbox.cassandra.modules.CassandraSubscriptionModule.class); --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
