chibenwa commented on a change in pull request #519: URL: https://github.com/apache/james-project/pull/519#discussion_r663626037
########## File path: server/container/feature-checks/src/main/java/org/apache/james/healthcheck/MailReceptionCheck.java ########## @@ -0,0 +1,270 @@ +/**************************************************************** + * 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.healthcheck; + +import static reactor.core.publisher.Sinks.EmitFailureHandler.FAIL_FAST; + +import java.time.Duration; +import java.time.temporal.ChronoUnit; +import java.util.Objects; +import java.util.Optional; +import java.util.UUID; + +import javax.inject.Inject; +import javax.mail.internet.InternetAddress; + +import org.apache.commons.io.IOUtils; +import org.apache.james.core.Username; +import org.apache.james.core.builder.MimeMessageBuilder; +import org.apache.james.core.healthcheck.ComponentName; +import org.apache.james.core.healthcheck.HealthCheck; +import org.apache.james.core.healthcheck.Result; +import org.apache.james.events.Event; +import org.apache.james.events.EventBus; +import org.apache.james.events.EventListener; +import org.apache.james.mailbox.MailboxManager; +import org.apache.james.mailbox.MailboxSession; +import org.apache.james.mailbox.MessageManager; +import org.apache.james.mailbox.events.MailboxEvents.Added; +import org.apache.james.mailbox.events.MailboxIdRegistrationKey; +import org.apache.james.mailbox.exception.MailboxException; +import org.apache.james.mailbox.exception.MailboxNotFoundException; +import org.apache.james.mailbox.model.FetchGroup; +import org.apache.james.mailbox.model.MailboxPath; +import org.apache.james.mailbox.model.MessageRange; +import org.apache.james.server.core.MailImpl; +import org.apache.james.user.api.UsersRepository; +import org.apache.james.util.DurationParser; +import org.apache.mailet.MailetContext; +import org.reactivestreams.Publisher; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import com.github.fge.lambdas.Throwing; +import com.google.common.base.MoreObjects; +import com.google.common.collect.ImmutableList; + +import reactor.core.publisher.Flux; +import reactor.core.publisher.Mono; +import reactor.core.publisher.Sinks; +import reactor.core.scheduler.Schedulers; + +public class MailReceptionCheck implements HealthCheck { + public static class Configuration { + private static final Duration DEFAULT_TIMEOUT = Duration.ofMinutes(1); + public static final Configuration DEFAULT = new Configuration(Optional.empty(), DEFAULT_TIMEOUT); + + public static Configuration from(org.apache.commons.configuration2.Configuration configuration) { + Optional<Username> username = Optional.ofNullable(configuration.getString("reception.check.user", null)) + .map(Username::of); + Duration timeout = Optional.ofNullable(configuration.getString("reception.check.timeout", null)) + .map(s -> DurationParser.parse(s, ChronoUnit.SECONDS)) + .orElse(DEFAULT_TIMEOUT); + + return new Configuration(username, timeout); + } + + private final Optional<Username> testUser; + private final Duration timeout; + + public Configuration(Optional<Username> testUser, Duration timeout) { + this.testUser = testUser; + this.timeout = timeout; + } + + public Optional<Username> getTestUser() { + return testUser; + } + + public Duration getTimeout() { + return timeout; + } + + @Override + public final boolean equals(Object o) { + if (o instanceof Configuration) { + Configuration that = (Configuration) o; + return Objects.equals(testUser, that.testUser) + && Objects.equals(timeout, that.timeout); + } + return false; + } + + @Override + public final int hashCode() { + return Objects.hash(testUser, timeout); + } + + @Override + public String toString() { + return MoreObjects.toStringHelper(this) + .add("testUser", testUser) + .add("timeout", timeout) + .toString(); + } + } + + public static class Content { + public static Content generate() { + return new Content(UUID.randomUUID()); + } + + private final UUID uuid; + + private Content(UUID uuid) { + this.uuid = uuid; + } + + public String asString() { + return uuid.toString(); + } + + @Override + public final boolean equals(Object o) { + if (o instanceof Content) { + Content that = (Content) o; + return Objects.equals(uuid, that.uuid); + } + return false; + } + + @Override + public final int hashCode() { + return Objects.hash(uuid); + } + + @Override + public String toString() { + return asString(); + } + } + + public static class AwaitReceptionListener implements EventListener.ReactiveEventListener { + private final Sinks.Many<Added> sink; + + public AwaitReceptionListener() { + sink = Sinks.many().multicast().onBackpressureBuffer(); + } + + @Override + public Publisher<Void> reactiveEvent(Event event) { + if (event instanceof Added) { + return Mono.fromRunnable(() -> sink.emitNext((Added) event, FAIL_FAST)) + .subscribeOn(Schedulers.elastic()) + .then(); + } + return Mono.empty(); + } + + public Flux<Added> addedEvents() { + return sink.asFlux(); + } + } + + private static final Logger LOGGER = LoggerFactory.getLogger(MailReceptionCheck.class); + + private final MailetContext mailetContext; + private final MailboxManager mailboxManager; + private final EventBus eventBus; + private final UsersRepository usersRepository; + private final Configuration configuration; + + @Inject + public MailReceptionCheck(MailetContext mailetContext, MailboxManager mailboxManager, EventBus eventBus, UsersRepository usersRepository, Configuration configuration) { + this.mailetContext = mailetContext; + this.mailboxManager = mailboxManager; + this.eventBus = eventBus; + this.usersRepository = usersRepository; + this.configuration = configuration; + } + + @Override + public ComponentName componentName() { + return new ComponentName("MailReceptionCheck"); + } + + @Override + public Publisher<Result> check() { + return configuration.getTestUser() + .map(this::check) + .orElse(Mono.just(Result.healthy(componentName()))); + } + + private Mono<Result> check(Username username) { + MailboxSession session = mailboxManager.createSystemSession(username); + AwaitReceptionListener listener = new AwaitReceptionListener(); + + return retrieveInbox(username, session) + .flatMap(mailbox -> Mono.usingWhen( + Mono.from(eventBus.register(listener, new MailboxIdRegistrationKey(mailbox.getId()))), + registration -> sendMail(username) + .flatMap(content -> checkReceived(session, listener, mailbox, content)), + registration -> Mono.fromRunnable(registration::unregister))) + .subscribeOn(Schedulers.elastic()) + .timeout(configuration.getTimeout(), Mono.error(() -> new RuntimeException("HealthCheck email was not received after " + configuration.getTimeout().toMillis() + "ms"))) + .onErrorResume(e -> { + LOGGER.error("Mail reception check failed", e); + return Mono.just(Result.unhealthy(componentName(), e.getMessage())); + }); + } + + private Mono<MessageManager> retrieveInbox(Username username, MailboxSession session) { + MailboxPath mailboxPath = MailboxPath.inbox(username); + return Mono.from(mailboxManager.getMailboxReactive(mailboxPath, session)) + .onErrorResume(MailboxNotFoundException.class, e -> Mono.fromCallable(() -> mailboxManager.createMailbox(mailboxPath, session)) + .then(Mono.from(mailboxManager.getMailboxReactive(mailboxPath, session)))); + } + + private Mono<Result> checkReceived(MailboxSession session, AwaitReceptionListener listener, MessageManager mailbox, Content content) { + return listener.addedEvents() + .flatMapIterable(Added::getUids) + .flatMap(uid -> Mono.fromCallable(() -> mailbox.getMessages(MessageRange.one(uid), FetchGroup.FULL_CONTENT, session))) + .flatMapIterable(ImmutableList::copyOf) + .filter(Throwing.predicate(messageResult -> IOUtils.toString(messageResult.getBody().getInputStream()).contains(content.asString()))) + // Cleanup our testing mail + .doOnNext(messageResult -> { + try { + mailbox.delete(ImmutableList.of(messageResult.getUid()), session); + } catch (MailboxException e) { + LOGGER.warn("Faield to delete Health check testing email", e); + } + }) + .map(any -> Result.healthy(componentName())) + .next(); + } + + private Mono<Content> sendMail(Username username) { + Content content = Content.generate(); + + return Mono.fromCallable(() -> usersRepository.getMailAddressFor(username)) + .flatMap(address -> Mono.fromRunnable(Throwing.runnable(() -> + mailetContext.sendMail(MailImpl.builder() + .name(content.asString()) + .sender(address) + .addRecipient(address) + .mimeMessage(MimeMessageBuilder.mimeMessageBuilder() + .addFrom(new InternetAddress(address.asString())) + .addToRecipient(address.asString()) + .setSubject(content.asString()) Review comment: What do you mean? -- 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]
