chibenwa commented on code in PR #1812: URL: https://github.com/apache/james-project/pull/1812#discussion_r1405908909
########## mailbox/postgres/src/main/java/org/apache/james/mailbox/postgres/mail/dao/PostgresMailboxMessageDAO.java: ########## @@ -0,0 +1,420 @@ +/**************************************************************** + * 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.postgres.mail.dao; + + +import static org.apache.james.mailbox.postgres.mail.PostgresCommons.LOCAL_DATE_TIME_DATE_FUNCTION; +import static org.apache.james.mailbox.postgres.mail.PostgresCommons.TABLE_FIELD; +import static org.apache.james.mailbox.postgres.mail.PostgresMessageModule.MessageTable.BODY_START_OCTET; +import static org.apache.james.mailbox.postgres.mail.PostgresMessageModule.MessageToMailboxTable.IS_ANSWERED; +import static org.apache.james.mailbox.postgres.mail.PostgresMessageModule.MessageToMailboxTable.IS_DELETED; +import static org.apache.james.mailbox.postgres.mail.PostgresMessageModule.MessageToMailboxTable.IS_DRAFT; +import static org.apache.james.mailbox.postgres.mail.PostgresMessageModule.MessageToMailboxTable.IS_FLAGGED; +import static org.apache.james.mailbox.postgres.mail.PostgresMessageModule.MessageToMailboxTable.IS_RECENT; +import static org.apache.james.mailbox.postgres.mail.PostgresMessageModule.MessageToMailboxTable.IS_SEEN; +import static org.apache.james.mailbox.postgres.mail.PostgresMessageModule.MessageToMailboxTable.IS_USER; +import static org.apache.james.mailbox.postgres.mail.PostgresMessageModule.MessageToMailboxTable.MAILBOX_ID; +import static org.apache.james.mailbox.postgres.mail.PostgresMessageModule.MessageToMailboxTable.MESSAGE_ID; +import static org.apache.james.mailbox.postgres.mail.PostgresMessageModule.MessageToMailboxTable.MESSAGE_UID; +import static org.apache.james.mailbox.postgres.mail.PostgresMessageModule.MessageToMailboxTable.TABLE_NAME; +import static org.apache.james.mailbox.postgres.mail.PostgresMessageModule.MessageToMailboxTable.THREAD_ID; +import static org.apache.james.mailbox.postgres.mail.PostgresMessageModule.MessageToMailboxTable.USER_FLAGS; + +import java.io.ByteArrayInputStream; +import java.io.InputStream; +import java.time.LocalDateTime; +import java.util.Arrays; +import java.util.List; +import java.util.Optional; +import java.util.function.Function; + +import javax.mail.Flags; + +import org.apache.james.backends.postgres.utils.PostgresExecutor; +import org.apache.james.mailbox.MessageUid; +import org.apache.james.mailbox.model.ComposedMessageId; +import org.apache.james.mailbox.model.ComposedMessageIdWithMetaData; +import org.apache.james.mailbox.model.Content; +import org.apache.james.mailbox.model.MessageRange; +import org.apache.james.mailbox.model.ThreadId; +import org.apache.james.mailbox.model.UpdatedFlags; +import org.apache.james.mailbox.postgres.PostgresMailboxId; +import org.apache.james.mailbox.postgres.PostgresMessageId; +import org.apache.james.mailbox.postgres.mail.PostgresMessageModule.MessageTable; +import org.apache.james.mailbox.store.mail.model.MailboxMessage; +import org.apache.james.mailbox.store.mail.model.impl.PropertyBuilder; +import org.apache.james.mailbox.store.mail.model.impl.SimpleMailboxMessage; +import org.jooq.Condition; +import org.jooq.DSLContext; +import org.jooq.Record; +import org.jooq.Record1; +import org.jooq.SelectFinalStep; +import org.jooq.SelectSeekStep1; +import org.jooq.SortField; +import org.jooq.TableOnConditionStep; +import org.jooq.UpdateConditionStep; +import org.jooq.impl.DSL; + +import reactor.core.publisher.Flux; +import reactor.core.publisher.Mono; +import javax.mail.Flags.Flag; +public class PostgresMailboxMessageDAO { + private static final Function<Record, MessageUid> RECORD_TO_MESSAGE_UID_FUNCTION = record -> MessageUid.of(record.get(MESSAGE_UID)); + private static final Function<Record, Flags> RECORD_TO_FLAGS_FUNCTION = record -> { + Flags flags = new Flags(); + Optional.ofNullable(record.get(USER_FLAGS)).stream() + .flatMap(Arrays::stream) + .forEach(flags::add); + return flags; + }; + + private static final TableOnConditionStep<Record> MESSAGES_JOIN_MAILBOX_MESSAGES_CONDITION_STEP = TABLE_NAME.join(MessageTable.TABLE_NAME) + .on(TABLE_FIELD.of(TABLE_NAME, MESSAGE_ID).eq(TABLE_FIELD.of(MessageTable.TABLE_NAME, MessageTable.MESSAGE_ID))); + + public static final SortField<Long> DEFAULT_SORT_ORDER_BY = MESSAGE_UID.asc(); + + private static SelectFinalStep<Record1<Long>> selectMessageUidByMailboxIdAndExtraConditionQuery(PostgresMailboxId mailboxId, Condition extraCondition, Optional<Integer> limit, DSLContext dslContext) { + SelectSeekStep1<Record1<Long>, Long> queryWithoutLimit = dslContext.select(MESSAGE_UID) + .from(TABLE_NAME) + .where(MAILBOX_ID.eq((mailboxId.asUuid()))) + .and(extraCondition) + .orderBy(MESSAGE_UID.asc()); + return limit.map(limitValue -> (SelectFinalStep<Record1<Long>>) queryWithoutLimit.limit(limitValue)) + .orElse(queryWithoutLimit); + } + + private static final Content EMPTY_CONTENT = new Content() { + @Override + public InputStream getInputStream() { + return new ByteArrayInputStream(new byte[0]); + } + + @Override + public long size() { + return 0; + } + }; + + private final PostgresExecutor postgresExecutor; + + private final ThreadId.Factory threadIdFactory; + + public PostgresMailboxMessageDAO(PostgresExecutor postgresExecutor) { + this.postgresExecutor = postgresExecutor; + this.threadIdFactory = new ThreadId.Factory(new PostgresMessageId.Factory()); + } + + public Mono<MessageUid> findFirstUnseenMessageUid(PostgresMailboxId mailboxId) { + return postgresExecutor.executeRow(dslContext -> Mono.from(selectMessageUidByMailboxIdAndExtraConditionQuery(mailboxId, + IS_SEEN.eq(false), Optional.of(1), dslContext))) + .map(RECORD_TO_MESSAGE_UID_FUNCTION); + } + + public Flux<MessageUid> findAllRecentMessageUid(PostgresMailboxId mailboxId) { + return postgresExecutor.executeRows(dslContext -> Flux.from(selectMessageUidByMailboxIdAndExtraConditionQuery(mailboxId, + IS_SEEN.eq(true), Optional.empty(), dslContext))) + .map(RECORD_TO_MESSAGE_UID_FUNCTION); + } + + public Flux<MessageUid> listAllMessageUid(PostgresMailboxId mailboxId) { + return postgresExecutor.executeRows(dslContext -> Flux.from(selectMessageUidByMailboxIdAndExtraConditionQuery(mailboxId, + DSL.noCondition(), Optional.empty(), dslContext))) + .map(RECORD_TO_MESSAGE_UID_FUNCTION); + } + + public Mono<MessageUid> findLastMessageUid(PostgresMailboxId mailboxId) { + return postgresExecutor.executeRow(dslContext -> Mono.from(dslContext.select(MESSAGE_UID) + .from(TABLE_NAME) + .where(MAILBOX_ID.eq(mailboxId.asUuid())) + .orderBy(MESSAGE_UID.desc()) + .limit(1))) + .map(RECORD_TO_MESSAGE_UID_FUNCTION); + } + + public Mono<Void> deleteByMailboxId(PostgresMailboxId mailboxId) { + return postgresExecutor.executeVoid(dslContext -> Mono.from(dslContext.deleteFrom(TABLE_NAME) + .where(MAILBOX_ID.eq(mailboxId.asUuid())))); + } + + public Mono<Void> deleteByMailboxIdAndMessageUid(PostgresMailboxId mailboxId, MessageUid messageUid) { + return postgresExecutor.executeVoid(dslContext -> Mono.from(dslContext.deleteFrom(TABLE_NAME) + .where(MAILBOX_ID.eq(mailboxId.asUuid())) + .and(MESSAGE_UID.eq(messageUid.asLong())))); + } + + public Mono<Void> deleteByMailboxIdAndMessageUids(PostgresMailboxId mailboxId, List<MessageUid> uids) { + return postgresExecutor.executeVoid(dslContext -> Mono.from(dslContext.deleteFrom(TABLE_NAME) + .where(MAILBOX_ID.eq(mailboxId.asUuid())) + .and(MESSAGE_UID.in(uids.stream().map(MessageUid::asLong).toArray(Long[]::new))))); + } + + public Mono<Void> deleteByMailboxIdAndMessageUidBetween(PostgresMailboxId mailboxId, MessageUid from, MessageUid to) { + return postgresExecutor.executeVoid(dslContext -> Mono.from(dslContext.deleteFrom(TABLE_NAME) + .where(MAILBOX_ID.eq(mailboxId.asUuid())) + .and(MESSAGE_UID.greaterOrEqual(from.asLong())) + .and(MESSAGE_UID.lessOrEqual(to.asLong())))); + } + + public Mono<Void> deleteByMailboxIdAndMessageUidAfter(PostgresMailboxId mailboxId, MessageUid from) { + return postgresExecutor.executeVoid(dslContext -> Mono.from(dslContext.deleteFrom(TABLE_NAME) + .where(MAILBOX_ID.eq(mailboxId.asUuid())) + .and(MESSAGE_UID.greaterOrEqual(from.asLong())))); + } + + public Mono<Integer> countUnseenMessagesByMailboxId(PostgresMailboxId mailboxId) { + return postgresExecutor.executeCount(dslContext -> Mono.from(dslContext.selectCount() + .from(TABLE_NAME) + .where(MAILBOX_ID.eq(mailboxId.asUuid())) + .and(IS_SEEN.eq(false)))); + } + + public Mono<Integer> countTotalMessagesByMailboxId(PostgresMailboxId mailboxId) { + return postgresExecutor.executeCount(dslContext -> Mono.from(dslContext.selectCount() + .from(TABLE_NAME) + .where(MAILBOX_ID.eq(mailboxId.asUuid())))); + } + + public Flux<MailboxMessage> findMessagesByMailboxId(PostgresMailboxId mailboxId, int limit) { + return postgresExecutor.executeRows(dslContext -> Flux.from(dslContext.select() + .from(MESSAGES_JOIN_MAILBOX_MESSAGES_CONDITION_STEP) + .where(MAILBOX_ID.eq(mailboxId.asUuid())) + .orderBy(DEFAULT_SORT_ORDER_BY) + .limit(limit))) + .map(this::toMailboxMessage); + } + + public Flux<MailboxMessage> findMessagesByMailboxIdAndBetweenUIDs(PostgresMailboxId mailboxId, MessageUid from, MessageUid to, int limit) { + return postgresExecutor.executeRows(dslContext -> Flux.from(dslContext.select() + .from(MESSAGES_JOIN_MAILBOX_MESSAGES_CONDITION_STEP) + .where(MAILBOX_ID.eq(mailboxId.asUuid())) + .and(MESSAGE_UID.greaterOrEqual(from.asLong())) + .and(MESSAGE_UID.lessOrEqual(to.asLong())) + .orderBy(DEFAULT_SORT_ORDER_BY) + .limit(limit))) + .map(this::toMailboxMessage); + } + + public Mono<MailboxMessage> findMessageByMailboxIdAndUid(PostgresMailboxId mailboxId, MessageUid uid) { + return postgresExecutor.executeRow(dslContext -> Mono.from(dslContext.select() + .from(MESSAGES_JOIN_MAILBOX_MESSAGES_CONDITION_STEP) + .where(MAILBOX_ID.eq(mailboxId.asUuid())) + .and(MESSAGE_UID.eq(uid.asLong())))) + .map(this::toMailboxMessage); + } + + public Flux<MailboxMessage> findMessagesByMailboxIdAndAfterUID(PostgresMailboxId mailboxId, MessageUid from, int limit) { + return postgresExecutor.executeRows(dslContext -> Flux.from(dslContext.select() + .from(MESSAGES_JOIN_MAILBOX_MESSAGES_CONDITION_STEP) + .where(MAILBOX_ID.eq(mailboxId.asUuid())) + .and(MESSAGE_UID.greaterOrEqual(from.asLong())) + .orderBy(DEFAULT_SORT_ORDER_BY) + .limit(limit))) + .map(this::toMailboxMessage); + } + + public Flux<MailboxMessage> findMessagesByMailboxIdAndUIDs(PostgresMailboxId mailboxId, List<MessageUid> uids) { + return postgresExecutor.executeRows(dslContext -> Flux.from(dslContext.select() + .from(MESSAGES_JOIN_MAILBOX_MESSAGES_CONDITION_STEP) + .where(MAILBOX_ID.eq(mailboxId.asUuid())) + .and(MESSAGE_UID.in(uids.stream().map(MessageUid::asLong).toArray(Long[]::new))) + .orderBy(DEFAULT_SORT_ORDER_BY))) + .map(this::toMailboxMessage); + + } + + public Flux<MessageUid> findDeletedMessagesByMailboxId(PostgresMailboxId mailboxId) { + return postgresExecutor.executeRows(dslContext -> Flux.from(dslContext.select(MESSAGE_UID) + .from(MESSAGES_JOIN_MAILBOX_MESSAGES_CONDITION_STEP) + .where(MAILBOX_ID.eq(mailboxId.asUuid())) + .and(IS_DELETED.eq(true)) + .orderBy(DEFAULT_SORT_ORDER_BY))) + .map(RECORD_TO_MESSAGE_UID_FUNCTION); + } + + public Flux<MessageUid> findDeletedMessagesByMailboxIdAndBetweenUIDs(PostgresMailboxId mailboxId, MessageUid from, MessageUid to) { + return postgresExecutor.executeRows(dslContext -> Flux.from(dslContext.select(MESSAGE_UID) + .from(MESSAGES_JOIN_MAILBOX_MESSAGES_CONDITION_STEP) + .where(MAILBOX_ID.eq(mailboxId.asUuid())) + .and(IS_DELETED.eq(true)) + .and(MESSAGE_UID.greaterOrEqual(from.asLong())) + .and(MESSAGE_UID.lessOrEqual(to.asLong())) + .orderBy(DEFAULT_SORT_ORDER_BY))) + .map(RECORD_TO_MESSAGE_UID_FUNCTION); + } + + public Flux<MessageUid> findDeletedMessagesByMailboxIdAndAfterUID(PostgresMailboxId mailboxId, MessageUid from) { + return postgresExecutor.executeRows(dslContext -> Flux.from(dslContext.select(MESSAGE_UID) + .from(MESSAGES_JOIN_MAILBOX_MESSAGES_CONDITION_STEP) + .where(MAILBOX_ID.eq(mailboxId.asUuid())) + .and(IS_DELETED.eq(true)) + .and(MESSAGE_UID.greaterOrEqual(from.asLong())) + .orderBy(DEFAULT_SORT_ORDER_BY))) + .map(RECORD_TO_MESSAGE_UID_FUNCTION); + } + + public Mono<MessageUid> findDeletedMessageByMailboxIdAndUid(PostgresMailboxId mailboxId, MessageUid uid) { + return postgresExecutor.executeRow(dslContext -> Mono.from(dslContext.select(MESSAGE_UID) + .from(MESSAGES_JOIN_MAILBOX_MESSAGES_CONDITION_STEP) + .where(MAILBOX_ID.eq(mailboxId.asUuid())) + .and(IS_DELETED.eq(true)) + .and(MESSAGE_UID.eq(uid.asLong())))) + .map(RECORD_TO_MESSAGE_UID_FUNCTION); + } + + public Flux<ComposedMessageIdWithMetaData> findMessagesMetadata(PostgresMailboxId mailboxId, MessageRange range) { + return postgresExecutor.executeRows(dslContext -> Flux.from(dslContext.select() + .from(TABLE_NAME) + .where(MAILBOX_ID.eq(mailboxId.asUuid())) + .and(MESSAGE_UID.greaterOrEqual(range.getUidFrom().asLong())) + .and(MESSAGE_UID.lessOrEqual(range.getUidTo().asLong())) + .orderBy(DEFAULT_SORT_ORDER_BY))) + .map(recordToComposedMessageIdWithMetaData(mailboxId)); + } + + public Flux<ComposedMessageIdWithMetaData> findMessagesMetadata(PostgresMailboxId mailboxId, List<MessageUid> messageUids) { + return postgresExecutor.executeRows(dslContext -> Flux.from(dslContext.select() + .from(TABLE_NAME) + .where(MAILBOX_ID.eq(mailboxId.asUuid())) + .and(MESSAGE_UID.in(messageUids.stream().map(MessageUid::asLong).toArray(Long[]::new))) + .orderBy(DEFAULT_SORT_ORDER_BY))) + .map(recordToComposedMessageIdWithMetaData(mailboxId)); + } + + + public Flux<ComposedMessageIdWithMetaData> findAllRecentMessageMetadata(PostgresMailboxId mailboxId) { + return postgresExecutor.executeRows(dslContext -> Flux.from(dslContext.select() + .from(TABLE_NAME) + .where(MAILBOX_ID.eq(mailboxId.asUuid())) + .and(IS_RECENT.eq(true)) + .orderBy(DEFAULT_SORT_ORDER_BY))) + .map(recordToComposedMessageIdWithMetaData(mailboxId)); + } + + private Function<Record, ComposedMessageIdWithMetaData> recordToComposedMessageIdWithMetaData(PostgresMailboxId mailboxId) { + return record -> ComposedMessageIdWithMetaData + .builder() + .composedMessageId(new ComposedMessageId(mailboxId, + PostgresMessageId.Factory.of(record.get(MESSAGE_ID)), + MessageUid.of(record.get(MESSAGE_UID)))) + .threadId(extractThreadId(record)) + .flags(RECORD_TO_FLAGS_FUNCTION.apply(record)) + .build(); + } + + public Mono<Void> updateFlag(PostgresMailboxId mailboxId, MessageUid uid, UpdatedFlags updatedFlags) { + return postgresExecutor.executeVoid(dslContext -> + Mono.from(buildUpdateFlagStatement(dslContext, updatedFlags, mailboxId, uid))); + } + + public Mono<Flags> listDistinctUserFlags(PostgresMailboxId mailboxId) { + return postgresExecutor.executeRow(dslContext -> Mono.from(dslContext.selectDistinct(USER_FLAGS) + .from(TABLE_NAME) + .where(MAILBOX_ID.eq(mailboxId.asUuid())))) + .map(RECORD_TO_FLAGS_FUNCTION); + } + + private UpdateConditionStep<Record> buildUpdateFlagStatement(DSLContext dslContext, UpdatedFlags updatedFlags, + PostgresMailboxId mailboxId, MessageUid uid) { + return Optional.of(dslContext.update(TABLE_NAME)) + .map(updateStatement -> { + if (updatedFlags.isChanged(Flag.ANSWERED)) { + return updateStatement.set(IS_ANSWERED, updatedFlags.isModifiedToSet(Flag.ANSWERED)); + } else { + return updateStatement; + } + }).map(updateStatement -> { + if (updatedFlags.isChanged(Flag.DELETED)) { + return updateStatement.set(IS_DELETED, updatedFlags.isModifiedToSet(Flag.DELETED)); + } else { + return updateStatement; + } + }).map(updateStatement -> { + if (updatedFlags.isChanged(Flag.DRAFT)) { + return updateStatement.set(IS_DRAFT, updatedFlags.isModifiedToSet(Flag.DRAFT)); + } else { + return updateStatement; + } + }).map(updateStatement -> { + if (updatedFlags.isChanged(Flag.FLAGGED)) { + return updateStatement.set(IS_FLAGGED, updatedFlags.isModifiedToSet(Flag.FLAGGED)); + } else { + return updateStatement; + } + }).map(updateStatement -> { + if (updatedFlags.isChanged(Flag.RECENT)) { + return updateStatement.set(IS_RECENT, updatedFlags.getNewFlags().contains(Flag.RECENT)); + } else { + return updateStatement; + } + }).map(updateStatement -> { + if (updatedFlags.isChanged(Flag.SEEN)) { + return updateStatement.set(IS_SEEN, updatedFlags.isModifiedToSet(Flag.SEEN)); + } else { + return updateStatement; + } + }).map(updateStatement -> { + if (updatedFlags.isChanged(Flag.USER)) { + return updateStatement.set(IS_USER, updatedFlags.isModifiedToSet(Flag.USER)); + } else { + return updateStatement; + } + }) + .map(updateStatement -> updateStatement.set(USER_FLAGS, updatedFlags.getNewFlags().getUserFlags())) Review Comment: We also need to add a `WHERE` clause on the modseq with the old value of the modseq. This is used to ensure optimistic concurrency control on flag updates. We should then use RETURNING to see if the update was applied. And if not, the caller should retry. Implementing this IS tricky as we need to retry updates only for those who did not succeed... OR we just wrap the flag updates onto a transaction, AND use a dedicated connection pool for that. I am more in favor of the optimistic concurrency option but let's write an ADR on the topic. (Comment edited): This topic is very hard. I propose to NOT care about concurrency control for now. We know that we are able to do it (eventually) with concurrency control. So let's do it later. So just `@Ignore` test that fails and are related to concurrency updates... -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
