All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.microsoft.azure.servicebus.primitives.RequestResponseLink Maven / Gradle / Ivy

The newest version!
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

package com.microsoft.azure.servicebus.primitives;

import java.io.IOException;
import java.time.Duration;
import java.time.ZonedDateTime;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.Locale;
import java.util.Map;
import java.util.UUID;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ScheduledFuture;
import java.util.concurrent.atomic.AtomicInteger;

import com.microsoft.azure.servicebus.TransactionContext;
import org.apache.qpid.proton.amqp.Binary;
import org.apache.qpid.proton.amqp.Symbol;
import org.apache.qpid.proton.amqp.UnsignedInteger;
import org.apache.qpid.proton.amqp.messaging.Accepted;
import org.apache.qpid.proton.amqp.messaging.Released;
import org.apache.qpid.proton.amqp.messaging.Source;
import org.apache.qpid.proton.amqp.messaging.Target;
import org.apache.qpid.proton.amqp.transaction.TransactionalState;
import org.apache.qpid.proton.amqp.transport.ErrorCondition;
import org.apache.qpid.proton.amqp.transport.ReceiverSettleMode;
import org.apache.qpid.proton.amqp.transport.SenderSettleMode;
import org.apache.qpid.proton.engine.BaseHandler;
import org.apache.qpid.proton.engine.Connection;
import org.apache.qpid.proton.engine.Delivery;
import org.apache.qpid.proton.engine.EndpointState;
import org.apache.qpid.proton.engine.Receiver;
import org.apache.qpid.proton.engine.Sender;
import org.apache.qpid.proton.engine.Session;
import org.apache.qpid.proton.engine.impl.DeliveryImpl;
import org.apache.qpid.proton.message.Message;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.microsoft.azure.servicebus.amqp.AmqpConstants;
import com.microsoft.azure.servicebus.amqp.DispatchHandler;
import com.microsoft.azure.servicebus.amqp.IAmqpReceiver;
import com.microsoft.azure.servicebus.amqp.IAmqpSender;
import com.microsoft.azure.servicebus.amqp.ReceiveLinkHandler;
import com.microsoft.azure.servicebus.amqp.SendLinkHandler;
import com.microsoft.azure.servicebus.amqp.SessionHandler;

import static java.nio.charset.StandardCharsets.UTF_8;

class RequestResponseLink extends ClientEntity {
    private static final Logger TRACE_LOGGER = LoggerFactory.getLogger(RequestResponseLink.class);

    private final Object recreateLinksLock;
    private final MessagingFactory underlyingFactory;
    private final String linkPath;
    private final String sasTokenAudienceURI;
    private final String additionalAudienceURI;
    private final CompletableFuture createFuture;
    private final ConcurrentHashMap pendingRequests;
    private final AtomicInteger requestCounter;
    private final String replyTo;

    private ScheduledFuture sasTokenRenewTimerFuture;
    private InternalReceiver amqpReceiver;
    private InternalSender amqpSender;
    private boolean isRecreateLinksInProgress;
    private Map additionalProperties;
    private MessagingEntityType entityType;
    private boolean isInnerLinksCloseHandled;
    private int internalLinkGeneration;

    public static CompletableFuture createAsync(
            MessagingFactory messagingFactory,
            String linkName,
            String linkPath,
            String sasTokenAudienceURI,
            String additionalAudience,
            Map additionalProperties,
            MessagingEntityType entityType) {
        final RequestResponseLink requestReponseLink = new RequestResponseLink(
                messagingFactory,
                linkName,
                linkPath,
                sasTokenAudienceURI,
                additionalAudience,
                additionalProperties,
                entityType);

        Timer.schedule(
            () -> {
                if (!requestReponseLink.createFuture.isDone()) {
                    requestReponseLink.amqpSender.closeInternals(false);
                    requestReponseLink.amqpReceiver.closeInternals(false);
                    requestReponseLink.cancelSASTokenRenewTimer();

                    Exception operationTimedout = new TimeoutException(
                            String.format(Locale.US, "Open operation on RequestResponseLink(%s) on Entity(%s) timed out at %s.", requestReponseLink.getClientId(), requestReponseLink.linkPath, ZonedDateTime.now().toString()));
                    TRACE_LOGGER.info("RequestResponseLink open timed out.", operationTimedout);
                    AsyncUtil.completeFutureExceptionally(requestReponseLink.createFuture, operationTimedout);
                }
            },
            messagingFactory.getOperationTimeout(),
            TimerType.OneTimeRun);

        requestReponseLink.sendTokenAndSetRenewTimer(false).handleAsync((v, sasTokenEx) -> {
            if (sasTokenEx != null) {
                Throwable cause = ExceptionUtil.extractAsyncCompletionCause(sasTokenEx);
                TRACE_LOGGER.info("Sending SAS Token failed. RequestResponseLink path:{}", requestReponseLink.linkPath, cause);
                requestReponseLink.createFuture.completeExceptionally(cause);
            } else {
                try {
                    messagingFactory.scheduleOnReactorThread(new DispatchHandler() {
                        @Override
                        public void onEvent() {
                            requestReponseLink.createInternalLinks();
                        }
                    });
                } catch (IOException ioException) {
                    requestReponseLink.cancelSASTokenRenewTimer();
                    requestReponseLink.createFuture.completeExceptionally(new ServiceBusException(false, "Failed to create internal links, see cause for more details.", ioException));
                }
            }

            return null;
        }, MessagingFactory.INTERNAL_THREAD_POOL);

        CompletableFuture.allOf(requestReponseLink.amqpSender.openFuture, requestReponseLink.amqpReceiver.openFuture).handleAsync((v, ex) -> {
            if (ex == null) {
                TRACE_LOGGER.info("Opened requestresponselink to {}", requestReponseLink.linkPath);
                requestReponseLink.createFuture.complete(requestReponseLink);
            } else {
                requestReponseLink.cancelSASTokenRenewTimer();
                requestReponseLink.createFuture.completeExceptionally(ex);
            }

            return null;
        }, MessagingFactory.INTERNAL_THREAD_POOL);

        return requestReponseLink.createFuture;
    }

    public static String getManagementNodeLinkPath(String entityPath) {
        return String.format("%s/%s", entityPath,  AmqpConstants.MANAGEMENT_NODE_ADDRESS_SEGMENT);
    }

    public static String getCBSNodeLinkPath() {
        return AmqpConstants.CBS_NODE_ADDRESS_SEGMENT;
    }

    private RequestResponseLink(
            MessagingFactory messagingFactory,
            String linkName,
            String linkPath,
            String sasTokenAudienceURI,
            String additionalAudience,
            Map additionalProperties,
            MessagingEntityType entityType) {
        super(linkName);

        this.internalLinkGeneration = 1;
        this.recreateLinksLock = new Object();
        this.isRecreateLinksInProgress = false;
        this.underlyingFactory = messagingFactory;
        this.linkPath = linkPath;
        this.sasTokenAudienceURI = sasTokenAudienceURI;
        this.additionalAudienceURI = additionalAudience;
        this.additionalProperties = additionalProperties;
        this.amqpSender = new InternalSender(linkName + ":internalSender", this, null);
        this.amqpReceiver = new InternalReceiver(linkName + ":interalReceiver", this);
        this.pendingRequests = new ConcurrentHashMap<>();
        this.requestCounter = new AtomicInteger();
        this.replyTo = UUID.randomUUID().toString();
        this.createFuture = new CompletableFuture();
        this.entityType = entityType;
        this.isInnerLinksCloseHandled = false;
    }

    public String getLinkPath() {
        return this.linkPath;
    }

    private CompletableFuture sendTokenAndSetRenewTimer(boolean retryOnFailure) {
        if (this.getIsClosingOrClosed() || this.sasTokenAudienceURI == null) {
            return CompletableFuture.completedFuture(null);
        } else {
            CompletableFuture> sendTokenFuture = this.underlyingFactory.sendSecurityTokenAndSetRenewTimer(this.sasTokenAudienceURI, retryOnFailure, () -> this.sendTokenAndSetRenewTimer(true));
            CompletableFuture sasTokenFuture = sendTokenFuture.thenAccept((f) -> this.sasTokenRenewTimerFuture = f);

            if (additionalAudienceURI != null) {
                CompletableFuture transferSendTokenFuture = this.underlyingFactory.sendSecurityToken(this.additionalAudienceURI);
                return CompletableFuture.allOf(sasTokenFuture, transferSendTokenFuture);
            }

            return sasTokenFuture;
        }
    }

    private void onInnerLinksClosed(int linkGeneration, Exception exception) {
        // Ignore exceptions from last generation links
        if (this.internalLinkGeneration == linkGeneration) {
            // This method is called twice once when inner receive link is closed and again when inner send link is closed.
            // Both of them happen in succession anyway, not concurrently as all these happen on the reactor thread.
            if (!this.isInnerLinksCloseHandled) {
                // Set it here and Reset the flag only before recreating inner links
                this.isInnerLinksCloseHandled = true;
                this.cancelSASTokenRenewTimer();
                if (this.pendingRequests.size() > 0) {
                    if (exception != null && exception instanceof ServiceBusException && ((ServiceBusException) exception).getIsTransient()) {
                        Duration nextRetryInterval = this.underlyingFactory.getRetryPolicy().getNextRetryInterval(this.getClientId(), exception, this.underlyingFactory.getOperationTimeout());
                        if (nextRetryInterval != null) {
                            Timer.schedule(() -> RequestResponseLink.this.ensureUniqueLinkRecreation(), nextRetryInterval, TimerType.OneTimeRun);
                        } else {
                            this.completeAllPendingRequestsWithException(exception);
                        }
                    } else {
                        this.completeAllPendingRequestsWithException(exception);
                    }
                }
            }
        }
    }

    private void cancelSASTokenRenewTimer() {
        if (this.sasTokenRenewTimerFuture != null && !this.sasTokenRenewTimerFuture.isDone()) {
            TRACE_LOGGER.debug("Cancelling SAS Token renew timer");
            this.sasTokenRenewTimerFuture.cancel(true);
        }
    }

    private void createInternalLinks() {
        this.isInnerLinksCloseHandled = false;
        Map commonLinkProperties = new HashMap<>();
        // ServiceBus expects timeout to be of type unsignedint
        commonLinkProperties.put(ClientConstants.LINK_TIMEOUT_PROPERTY, UnsignedInteger.valueOf(Util.adjustServerTimeout(this.underlyingFactory.getOperationTimeout()).toMillis()));
        if (this.entityType != null) {
            commonLinkProperties.put(ClientConstants.ENTITY_TYPE_PROPERTY, this.entityType.getIntValue());
        }
        if (this.additionalProperties != null) {
            commonLinkProperties.putAll(this.additionalProperties);
        }

        Connection connection;
		if(this.sasTokenAudienceURI == null) {
			// CBS link. Doesn't have to send SAS token
			connection = this.underlyingFactory.getActiveConnectionCreateIfNecessary();
		}
		else {
			connection = this.underlyingFactory.getActiveConnectionOrNothing();
			if (connection == null) {
				// Connection closed after sending CBS token. Happens only in the rare case of azure service bus closing idle connection, just right after sending
				// CBS token but before opening a link.
				TRACE_LOGGER.warn("Idle connection closed by service just after sending CBS token. Very rare case. Will retry.");
				ServiceBusException exception = new ServiceBusException(true, "Idle connection closed by service just after sending CBS token. Please retry.");
				AsyncUtil.completeFutureExceptionally(this.amqpSender.openFuture, exception);
				AsyncUtil.completeFutureExceptionally(this.amqpReceiver.openFuture, exception);
				// Retry with little delay so that link recreation in progress flag is reset
				Timer.schedule(() -> {RequestResponseLink.this.ensureUniqueLinkRecreation();}, Duration.ofMillis(1000), TimerType.OneTimeRun);
				return;
			}
		}
		
        // Create send link
        Session session = connection.session();
        session.setOutgoingWindow(Integer.MAX_VALUE);
        session.open();
        BaseHandler.setHandler(session, new SessionHandler(this.linkPath));

        String sendLinkNamePrefix = "RequestResponseLink-Sender".concat(TrackingUtil.TRACKING_ID_TOKEN_SEPARATOR).concat(StringUtil.getShortRandomString());
        String sendLinkName = !StringUtil.isNullOrEmpty(connection.getRemoteContainer())
                ? sendLinkNamePrefix.concat(TrackingUtil.TRACKING_ID_TOKEN_SEPARATOR).concat(connection.getRemoteContainer())
                : sendLinkNamePrefix;

        Sender sender = session.sender(sendLinkName);
        Target sednerTarget = new Target();
        sednerTarget.setAddress(this.linkPath);
        sender.setTarget(sednerTarget);
        Source senderSource = new Source();
        senderSource.setAddress(this.replyTo);
        sender.setSource(senderSource);
        sender.setSenderSettleMode(SenderSettleMode.SETTLED);
        sender.setProperties(commonLinkProperties);
        SendLinkHandler sendLinkHandler = new SendLinkHandler(this.amqpSender);
        BaseHandler.setHandler(sender, sendLinkHandler);

        // Create receive link
        session = connection.session();
        session.setOutgoingWindow(Integer.MAX_VALUE);
        session.open();
        BaseHandler.setHandler(session, new SessionHandler(this.linkPath));

        String receiveLinkNamePrefix = "RequestResponseLink-Receiver".concat(TrackingUtil.TRACKING_ID_TOKEN_SEPARATOR).concat(StringUtil.getShortRandomString());
        String receiveLinkName = !StringUtil.isNullOrEmpty(connection.getRemoteContainer())
                ? receiveLinkNamePrefix.concat(TrackingUtil.TRACKING_ID_TOKEN_SEPARATOR).concat(connection.getRemoteContainer())
                : receiveLinkNamePrefix;
        Receiver receiver = session.receiver(receiveLinkName);
        Source receiverSource = new Source();
        receiverSource.setAddress(this.linkPath);
        receiver.setSource(receiverSource);
        Target receiverTarget = new Target();
        receiverTarget.setAddress(this.replyTo);
        receiver.setTarget(receiverTarget);

        // Set settle modes
        receiver.setSenderSettleMode(SenderSettleMode.SETTLED);
        receiver.setReceiverSettleMode(ReceiverSettleMode.FIRST);
        receiver.setProperties(commonLinkProperties);

        final ReceiveLinkHandler receiveLinkHandler = new ReceiveLinkHandler(this.amqpReceiver);
        BaseHandler.setHandler(receiver, receiveLinkHandler);

        this.amqpSender.setLinks(sender, receiver);
        this.amqpReceiver.setLinks(sender, receiver);

        TRACE_LOGGER.debug("RequestReponseLink - opening send link to {}", this.linkPath);
        sender.open();
        this.underlyingFactory.registerForConnectionError(sender);
        TRACE_LOGGER.debug("RequestReponseLink - opening receive link to {}", this.linkPath);
        receiver.open();
        this.underlyingFactory.registerForConnectionError(receiver);
    }

    private void ensureUniqueLinkRecreation() {
        synchronized (this.recreateLinksLock) {
            if (!this.isRecreateLinksInProgress) {
                this.isRecreateLinksInProgress = true;
                this.recreateInternalLinks().handleAsync((v, recreationEx) -> {
                    if (recreationEx != null) {
                        TRACE_LOGGER.info("Recreating internal links of reqestresponselink '{}' failed.", this.linkPath, ExceptionUtil.extractAsyncCompletionCause(recreationEx));
                    }
                    
                    synchronized (this.recreateLinksLock) {
                        this.isRecreateLinksInProgress = false;
                    }
                    
                    return null;
                }, MessagingFactory.INTERNAL_THREAD_POOL);
            }
        }
    }

    private CompletableFuture recreateInternalLinks() {
        TRACE_LOGGER.info("RequestResponseLink - recreating internal send and receive links to {}", this.linkPath);
        this.amqpSender.closeInternals(false);
        this.amqpReceiver.closeInternals(false);
        this.cancelSASTokenRenewTimer();

        // Create new internal sender and receiver objects, as old ones are closed
        this.internalLinkGeneration++;
        this.amqpSender = new InternalSender(this.getClientId() + ":internalSender", this, this.amqpSender);
        this.amqpReceiver = new InternalReceiver(this.getClientId() + ":interalReceiver", this);
        CompletableFuture recreateInternalLinksFuture = new CompletableFuture();
        this.sendTokenAndSetRenewTimer(false).handleAsync((v, sasTokenEx) -> {
            if (sasTokenEx != null) {
                Throwable cause = ExceptionUtil.extractAsyncCompletionCause(sasTokenEx);
                TRACE_LOGGER.info("Sending SAS Token failed. RequestResponseLink path:{}", this.linkPath, cause);
                recreateInternalLinksFuture.completeExceptionally(cause);
                this.completeAllPendingRequestsWithException(cause);
            } else {
                try {
                    this.underlyingFactory.scheduleOnReactorThread(new DispatchHandler() {
                        @Override
                        public void onEvent() {
                            RequestResponseLink.this.createInternalLinks();
                        }
                    });
                } catch (IOException ioException) {
                    this.cancelSASTokenRenewTimer();
                    recreateInternalLinksFuture.completeExceptionally(new ServiceBusException(false, "Failed to create internal links, see cause for more details.", ioException));
                }
            }

            return null;
        }, MessagingFactory.INTERNAL_THREAD_POOL);

        CompletableFuture.allOf(this.amqpSender.openFuture, this.amqpReceiver.openFuture).handleAsync((v, ex) -> {
            if (ex == null) {
                TRACE_LOGGER.info("Recreated internal links to {}", this.linkPath);
                this.underlyingFactory.getRetryPolicy().resetRetryCount(this.getClientId());
                recreateInternalLinksFuture.complete(null);
            } else {
                this.cancelSASTokenRenewTimer();
                recreateInternalLinksFuture.completeExceptionally(ex);
            }

            return null;
        }, MessagingFactory.INTERNAL_THREAD_POOL);

        Timer.schedule(
            () -> {
                if (!recreateInternalLinksFuture.isDone()) {
                    Exception operationTimedout = new TimeoutException(
                            String.format(Locale.US, "Recreating internal links of requestresponselink to %s timed out.", RequestResponseLink.this.linkPath));
                    TRACE_LOGGER.info("Recreating internal links of requestresponselink timed out.", operationTimedout);
                    RequestResponseLink.this.cancelSASTokenRenewTimer();
                    AsyncUtil.completeFutureExceptionally(recreateInternalLinksFuture, operationTimedout);
                }
            },
            this.underlyingFactory.getOperationTimeout(),
            TimerType.OneTimeRun);

        return recreateInternalLinksFuture;
    }

    private void completeAllPendingRequestsWithException(Throwable exception) {
        TRACE_LOGGER.info("Completing all pending requests with exception in request response link to {}", this.linkPath);
        for (RequestResponseWorkItem workItem : this.pendingRequests.values()) {
            AsyncUtil.completeFutureExceptionally(workItem.getWork(), exception);
            workItem.cancelTimeoutTask(true);
        }

        this.pendingRequests.clear();
    }

    public CompletableFuture requestAysnc(Message requestMessage, TransactionContext transaction, Duration timeout) {
        this.throwIfClosed(null);

        CompletableFuture responseFuture = new CompletableFuture<>();
        RequestResponseWorkItem workItem = new RequestResponseWorkItem(requestMessage, transaction, responseFuture, timeout);
        String requestId = "request:" +  this.requestCounter.incrementAndGet();
        requestMessage.setMessageId(requestId);
        requestMessage.setReplyTo(this.replyTo);
        this.pendingRequests.put(requestId, workItem);
        workItem.setTimeoutTask(this.scheduleRequestTimeout(requestId, timeout));
        TRACE_LOGGER.debug("Sending request with id:{}", requestId);
        this.amqpSender.sendRequest(requestId, false);

        // Check and recreate links if necessary
        if (!((this.amqpSender.sendLink != null && this.amqpSender.sendLink.getLocalState() == EndpointState.ACTIVE && this.amqpSender.sendLink.getRemoteState() == EndpointState.ACTIVE)
                && (this.amqpReceiver.receiveLink != null && this.amqpReceiver.receiveLink.getLocalState() == EndpointState.ACTIVE && this.amqpReceiver.receiveLink.getRemoteState() == EndpointState.ACTIVE))) {
            this.ensureUniqueLinkRecreation();
        }
        
        return responseFuture;
    }

    private ScheduledFuture scheduleRequestTimeout(String requestId, Duration timeout) {
        return Timer.schedule(() -> {
            TRACE_LOGGER.info("Request with id:{} timed out", requestId);
            RequestResponseWorkItem completedWorkItem = RequestResponseLink.this.exceptionallyCompleteRequest(requestId, new TimeoutException("Request timed out."), true);
            boolean isRetriedWorkItem = completedWorkItem.getLastKnownException() != null;
            RequestResponseLink.this.amqpSender.removeEnqueuedRequest(requestId, isRetriedWorkItem);
        }, timeout, TimerType.OneTimeRun);
    }

    private RequestResponseWorkItem exceptionallyCompleteRequest(String requestId, Exception exception, boolean useLastKnownException) {
        RequestResponseWorkItem workItem = this.pendingRequests.remove(requestId);
        if (workItem != null) {
            Exception exceptionToReport = exception;
            if (useLastKnownException && workItem.getLastKnownException() != null) {
                exceptionToReport = workItem.getLastKnownException();
            }

            workItem.getWork().completeExceptionally(exceptionToReport);
            AsyncUtil.completeFutureExceptionally(workItem.getWork(), exceptionToReport);
            workItem.cancelTimeoutTask(true);
        }

        return workItem;
    }

    private RequestResponseWorkItem completeRequestWithResponse(String requestId, Message responseMessage) {
        RequestResponseWorkItem workItem = this.pendingRequests.get(requestId);
        if (workItem != null) {
            int statusCode = RequestResponseUtils.getResponseStatusCode(responseMessage);
            TRACE_LOGGER.debug("Response for request with id:{} has status code:{}", requestId, statusCode);
            // Retry on server busy and other retry-able status codes (what are other codes??)
            if (statusCode == ClientConstants.REQUEST_RESPONSE_SERVER_BUSY_STATUS_CODE) {
                TRACE_LOGGER.info("Request with id:{} received ServerBusy response from '{}'", requestId, this.linkPath);
                // error response
                Exception responseException = RequestResponseUtils.genereateExceptionFromResponse(responseMessage);
                this.underlyingFactory.getRetryPolicy().incrementRetryCount(this.getClientId());
                Duration retryInterval = this.underlyingFactory.getRetryPolicy().getNextRetryInterval(this.getClientId(), responseException, workItem.getTimeoutTracker().remaining());
                if (retryInterval == null) {
                    // Either not retry-able or not enough time to retry
                    TRACE_LOGGER.info("Request with id:{} cannot be retried. So completing with excetion.", requestId, responseException);
                    this.exceptionallyCompleteRequest(requestId, responseException, false);
                } else {
                    // Retry
                    TRACE_LOGGER.info("Request with id:{} will be retried after {}.", requestId, retryInterval);
                    workItem.setLastKnownException(responseException);
                    try {
                        this.underlyingFactory.scheduleOnReactorThread((int) retryInterval.toMillis(),
                                new DispatchHandler() {
                                    @Override
                                    public void onEvent() {
                                        RequestResponseLink.this.amqpSender.sendRequest(requestId, true);
                                    }
                                });
                    } catch (IOException e) {
                        this.exceptionallyCompleteRequest(requestId, responseException, false);
                    }
                }
            } else {
                TRACE_LOGGER.debug("Completing request with id:{}", requestId);
                this.underlyingFactory.getRetryPolicy().resetRetryCount(this.getClientId());
                this.pendingRequests.remove(requestId);
                workItem.getWork().complete(responseMessage);
                workItem.cancelTimeoutTask(true);
            }
        } else {
            TRACE_LOGGER.info("Request with id:{} not found in the requestresponse link.", requestId);
        }

        return workItem;
    }

    @Override
    protected CompletableFuture onClose() {
        TRACE_LOGGER.info("Closing requestresponselink to {} by closing both internal sender and receiver links.", this.linkPath);
        this.cancelSASTokenRenewTimer();
        CompletableFuture senderCloseFuture = this.amqpSender.closeAsync();
        CompletableFuture receiverCloseFuture = this.amqpReceiver.closeAsync();
        return CompletableFuture.allOf(senderCloseFuture, receiverCloseFuture);
    }

    private static void scheduleLinkCloseTimeout(CompletableFuture closeFuture, Duration timeout, String linkName) {
        Timer.schedule(
            () -> {
                if (!closeFuture.isDone()) {
                    Exception operationTimedout = new TimeoutException(String.format(Locale.US, "%s operation on Link(%s) timed out at %s", "Close", linkName, ZonedDateTime.now()));
                    TRACE_LOGGER.info("Closing link timed out", operationTimedout);

                    AsyncUtil.completeFutureExceptionally(closeFuture, operationTimedout);
                }
            },
            timeout,
            TimerType.OneTimeRun);
    }

    private class InternalReceiver extends ClientEntity implements IAmqpReceiver {
        private RequestResponseLink parent;
        private Receiver receiveLink;
        private Sender matchingSendLink;
        private CompletableFuture openFuture;
        private CompletableFuture closeFuture;
        private int linkGeneration;

        protected InternalReceiver(String clientId, RequestResponseLink parent) {
            super(clientId);
            this.parent = parent;
            this.linkGeneration = parent.internalLinkGeneration; // Read it in the constructor as it may change later
            this.openFuture = new CompletableFuture<>();
            this.closeFuture = new CompletableFuture<>();
        }

        @Override
        protected CompletableFuture onClose() {
            this.closeInternals(true);
            return this.closeFuture;
        }

        void closeInternals(boolean waitForCloseCompletion) {
            if (!this.getIsClosed()) {
                if (this.receiveLink != null && this.receiveLink.getLocalState() != EndpointState.CLOSED) {
                    try {
                        this.parent.underlyingFactory.scheduleOnReactorThread(new DispatchHandler() {

                            @Override
                            public void onEvent() {
                                if (InternalReceiver.this.receiveLink != null && InternalReceiver.this.receiveLink.getLocalState() != EndpointState.CLOSED) {
                                    TRACE_LOGGER.debug("Closing internal receive link of requestresponselink to {}", RequestResponseLink.this.linkPath);
                                    InternalReceiver.this.receiveLink.close();
                                    InternalReceiver.this.parent.underlyingFactory.deregisterForConnectionError(InternalReceiver.this.receiveLink);
                                    if (waitForCloseCompletion) {
                                        RequestResponseLink.scheduleLinkCloseTimeout(InternalReceiver.this.closeFuture, InternalReceiver.this.parent.underlyingFactory.getOperationTimeout(), InternalReceiver.this.receiveLink.getName());
                                    } else {
                                        AsyncUtil.completeFuture(InternalReceiver.this.closeFuture, null);
                                    }
                                }
                            }
                        });
                    } catch (IOException e) {
                        AsyncUtil.completeFutureExceptionally(this.closeFuture, e);
                    }
                } else {
                    AsyncUtil.completeFuture(this.closeFuture, null);
                }
            }
        }

        @Override
        public void onOpenComplete(Exception completionException) {
            if (completionException == null) {
                TRACE_LOGGER.debug("Opened internal receive link of requestresponselink to {}", parent.linkPath);
                AsyncUtil.completeFuture(this.openFuture, null);

                // Send unlimited credit
                this.receiveLink.flow(Integer.MAX_VALUE);
            } else {
                TRACE_LOGGER.info("Opening internal receive link '{}' of requestresponselink to {} failed.", this.receiveLink.getName(), this.parent.linkPath, completionException);
                this.setClosed();
                AsyncUtil.completeFuture(this.closeFuture, null);
                AsyncUtil.completeFutureExceptionally(this.openFuture, completionException);
            }
        }

        @Override
        public void onError(Exception exception) {
            if (!this.openFuture.isDone()) {
                this.onOpenComplete(exception);
            }

            if (this.getIsClosingOrClosed()) {
                if (!this.closeFuture.isDone()) {
                    TRACE_LOGGER.info("Closing internal receive link '{}' of requestresponselink to {} failed.", this.receiveLink.getName(), this.parent.linkPath, exception);
                    AsyncUtil.completeFutureExceptionally(this.closeFuture, exception);
                }
            } else {
                TRACE_LOGGER.info("Internal receive link '{}' of requestresponselink to '{}' encountered error.", this.receiveLink.getName(), this.parent.linkPath, exception);
                this.parent.underlyingFactory.deregisterForConnectionError(this.receiveLink);
                this.matchingSendLink.close();
                this.parent.underlyingFactory.deregisterForConnectionError(this.matchingSendLink);
                this.parent.onInnerLinksClosed(this.linkGeneration, exception);
            }
        }

        @Override
        public void onClose(ErrorCondition condition) {
            if (condition == null || condition.getCondition() == null) {
                if (this.getIsClosingOrClosed() && !this.closeFuture.isDone()) {
                    TRACE_LOGGER.info("Closed internal receive link of requestresponselink to {}", parent.linkPath);
                    AsyncUtil.completeFuture(this.closeFuture, null);
                }
            } else {
                Exception exception = ExceptionUtil.toException(condition);
                this.onError(exception);
            }
        }

        @Override
        public void onReceiveComplete(Delivery delivery) {
            Message responseMessage;
            try {
                responseMessage = Util.readMessageFromDelivery(this.receiveLink, delivery);
                delivery.disposition(Accepted.getInstance());
                delivery.settle();
            } catch (Exception e) {
                TRACE_LOGGER.info("Reading message from delivery failed with unexpected exception.", e);

                // release the delivery ??
                delivery.disposition(Released.getInstance());
                delivery.settle();
                return;
            }

            // Return response in a separate thread so reactor thread is free to handle reactor events
            final Message finalResponseMessage = responseMessage;
            MessagingFactory.INTERNAL_THREAD_POOL.submit(() -> {
                String requestMessageId = (String) finalResponseMessage.getCorrelationId();
                if (requestMessageId != null) {
                    TRACE_LOGGER.debug("RequestRespnseLink received response for request with id :{}", requestMessageId);
                    this.parent.completeRequestWithResponse(requestMessageId, finalResponseMessage);
                } else {
                    TRACE_LOGGER.info("RequestRespnseLink received a message with null correlationId");
                }
            });
        }

        public void setLinks(Sender sendLink, Receiver receiveLink) {
            this.receiveLink = receiveLink;
            this.matchingSendLink = sendLink;
        }
    }

    private class InternalSender extends ClientEntity implements IAmqpSender {
        private Sender sendLink;
        private Receiver matchingReceiveLink;
        private RequestResponseLink parent;
        private CompletableFuture openFuture;
        private CompletableFuture closeFuture;
        private AtomicInteger availableCredit;
        private LinkedList pendingFreshSends;
        private LinkedList pendingRetrySends;
        private Object pendingSendsSyncLock;
        private boolean isSendLoopRunning;
        private int maxMessageSize;
        private int linkGeneration;

        protected InternalSender(String clientId, RequestResponseLink parent, InternalSender senderToBeCopied) {
            super(clientId);
            this.parent = parent;
            this.linkGeneration = parent.internalLinkGeneration; // Read it in the constructor as it may change later
            this.availableCredit = new AtomicInteger(0);
            this.pendingSendsSyncLock = new Object();
            this.isSendLoopRunning = false;
            this.openFuture = new CompletableFuture<>();
            this.closeFuture = new CompletableFuture<>();

            if (senderToBeCopied == null) {
                this.pendingFreshSends = new LinkedList<>();
                this.pendingRetrySends = new LinkedList<>();
            } else {
                this.pendingFreshSends = senderToBeCopied.pendingFreshSends;
                this.pendingRetrySends = senderToBeCopied.pendingRetrySends;
            }
        }

        @Override
        protected CompletableFuture onClose() {
            this.closeInternals(true);
            return this.closeFuture;
        }

        void closeInternals(boolean waitForCloseCompletion) {
            if (!this.getIsClosed()) {
                if (this.sendLink != null && this.sendLink.getLocalState() != EndpointState.CLOSED) {
                    try {
                        this.parent.underlyingFactory.scheduleOnReactorThread(new DispatchHandler() {

                            @Override
                            public void onEvent() {
                                if (InternalSender.this.sendLink != null && InternalSender.this.sendLink.getLocalState() != EndpointState.CLOSED) {
                                    TRACE_LOGGER.debug("Closing internal send link of requestresponselink to {}", RequestResponseLink.this.linkPath);
                                    InternalSender.this.sendLink.close();
                                    InternalSender.this.parent.underlyingFactory.deregisterForConnectionError(InternalSender.this.sendLink);
                                    if (waitForCloseCompletion) {
                                        RequestResponseLink.scheduleLinkCloseTimeout(InternalSender.this.closeFuture, InternalSender.this.parent.underlyingFactory.getOperationTimeout(), InternalSender.this.sendLink.getName());
                                    } else {
                                        AsyncUtil.completeFuture(InternalSender.this.closeFuture, null);
                                    }
                                }
                            }
                        });
                    } catch (IOException e) {
                        AsyncUtil.completeFutureExceptionally(this.closeFuture, e);
                    }
                } else {
                    AsyncUtil.completeFuture(this.closeFuture, null);
                }
            }
        }

        @Override
        public void onOpenComplete(Exception completionException) {
            if (completionException == null) {
                TRACE_LOGGER.debug("Opened internal send link of requestresponselink to {}", parent.linkPath);
                this.maxMessageSize = Util.getMaxMessageSizeFromLink(this.sendLink);
                AsyncUtil.completeFuture(this.openFuture, null);
                this.runSendLoop();
            } else {
                TRACE_LOGGER.info("Opening internal send link '{}' of requestresponselink to {} failed.", this.sendLink.getName(), this.parent.linkPath, completionException);
                this.setClosed();
                AsyncUtil.completeFuture(this.closeFuture, null);
                AsyncUtil.completeFutureExceptionally(this.openFuture, completionException);
            }
        }

        @Override
        public void onError(Exception exception) {
            if (!this.openFuture.isDone()) {
                this.onOpenComplete(exception);
            }

            if (this.getIsClosingOrClosed()) {
                if (!this.closeFuture.isDone()) {
                    TRACE_LOGGER.info("Closing internal send link '{}' of requestresponselink to {} failed.", this.sendLink.getName(), this.parent.linkPath, exception);
                    AsyncUtil.completeFutureExceptionally(this.closeFuture, exception);
                }
            } else {
                TRACE_LOGGER.info("Internal send link '{}' of requestresponselink to '{}' encountered error.", this.sendLink.getName(), this.parent.linkPath, exception);
                this.parent.underlyingFactory.deregisterForConnectionError(this.sendLink);
                this.matchingReceiveLink.close();
                this.parent.underlyingFactory.deregisterForConnectionError(this.matchingReceiveLink);
                this.parent.onInnerLinksClosed(this.linkGeneration, exception);
            }
        }

        @Override
        public void onClose(ErrorCondition condition) {
            if (condition == null || condition.getCondition() == null) {
                if (!this.closeFuture.isDone() && !this.closeFuture.isDone()) {
                    TRACE_LOGGER.info("Closed internal send link of requestresponselink to {}", this.parent.linkPath);
                    AsyncUtil.completeFuture(this.closeFuture, null);
                }
            } else {
                Exception exception = ExceptionUtil.toException(condition);
                this.onError(exception);
            }
        }

        public void sendRequest(String requestId, boolean isRetry) {
            synchronized (this.pendingSendsSyncLock) {
                if (isRetry) {
                    this.pendingRetrySends.add(requestId);
                } else {
                    this.pendingFreshSends.add(requestId);
                }

                // This check must be done inside lock
                if (this.isSendLoopRunning) {
                    return;
                }
            }

            try {
                this.parent.underlyingFactory.scheduleOnReactorThread(new DispatchHandler() {
                    @Override
                    public void onEvent() {
                        InternalSender.this.runSendLoop();
                    }
                });
            } catch (IOException e) {
                this.parent.exceptionallyCompleteRequest(requestId, e, true);
            }
        }

        public void removeEnqueuedRequest(String requestId, boolean isRetry) {
            synchronized (this.pendingSendsSyncLock) {
                // Collections are more likely to be very small. So remove() shouldn't be a problem.
                if (isRetry) {
                    this.pendingRetrySends.remove(requestId);
                } else {
                    this.pendingFreshSends.remove(requestId);
                }
            }
        }

        @Override
        public void onFlow(int creditIssued) {
            TRACE_LOGGER.debug("RequestResonseLink {} internal sender received credit :{}", this.parent.linkPath, creditIssued);
            this.availableCredit.addAndGet(creditIssued);
            TRACE_LOGGER.debug("RequestResonseLink {} internal sender available credit :{}", this.parent.linkPath, this.availableCredit.get());
            this.runSendLoop();
        }

        @Override
        public void onSendComplete(Delivery delivery) {
            // Doesn't happen as sends are settled on send
        }

        public void setLinks(Sender sendLink, Receiver receiveLink) {
            this.sendLink = sendLink;
            this.matchingReceiveLink = receiveLink;
            this.availableCredit = new AtomicInteger(0);
        }

        private void runSendLoop() {
            synchronized (this.pendingSendsSyncLock) {
                if (this.isSendLoopRunning) {
                    return;
                } else {
                    this.isSendLoopRunning = true;
                }
            }

            TRACE_LOGGER.debug("Starting requestResponseLink {} internal sender send loop", this.parent.linkPath);

            try {
                while (this.sendLink != null && this.sendLink.getLocalState() == EndpointState.ACTIVE && this.sendLink.getRemoteState() == EndpointState.ACTIVE && this.availableCredit.get() > 0) {
                    String requestIdToBeSent;
                    synchronized (pendingSendsSyncLock) {
                        // First send retries and then fresh ones
                        requestIdToBeSent = this.pendingRetrySends.poll();
                        if (requestIdToBeSent == null) {
                            requestIdToBeSent = this.pendingFreshSends.poll();
                            if (requestIdToBeSent == null) {
                                // Set to false inside the synchronized block to avoid race condition
                                this.isSendLoopRunning = false;
                                TRACE_LOGGER.debug("RequestResponseLink {} internal sender send loop ending as there are no more requests enqueued.", this.parent.linkPath);
                                break;
                            }
                        }
                    }

                    RequestResponseWorkItem requestToBeSent = this.parent.pendingRequests.get(requestIdToBeSent);
                    if (requestToBeSent != null) {
                        Delivery delivery = this.sendLink.delivery(UUID.randomUUID().toString().getBytes(UTF_8));
                        delivery.setMessageFormat(DeliveryImpl.DEFAULT_MESSAGE_FORMAT);
                        TransactionContext transaction = requestToBeSent.getTransaction();
                        if (transaction != TransactionContext.NULL_TXN) {
                            TransactionalState transactionalState = new TransactionalState();
                            transactionalState.setTxnId(new Binary(transaction.getTransactionId().array()));
                            delivery.disposition(transactionalState);
                        }

                        Pair encodedPair = null;
                        try {
                            encodedPair = Util.encodeMessageToOptimalSizeArray(requestToBeSent.getRequest(), this.maxMessageSize);
                        } catch (PayloadSizeExceededException exception) {
                            this.parent.exceptionallyCompleteRequest((String) requestToBeSent.getRequest().getMessageId(), new PayloadSizeExceededException(String.format("Size of the payload exceeded Maximum message size: %s kb", this.maxMessageSize / 1024), exception), false);
                        }

                        try {
                            int sentMsgSize = this.sendLink.send(encodedPair.getFirstItem(), 0, encodedPair.getSecondItem());
                            assert sentMsgSize == encodedPair.getSecondItem() : "Contract of the ProtonJ library for Sender.Send API changed";
                            delivery.settle();
                            this.availableCredit.decrementAndGet();
                            TRACE_LOGGER.debug("RequestResponseLink {} internal sender sent a request. available credit :{}", this.parent.linkPath, this.availableCredit.get());
                        } catch (Exception e) {
                            TRACE_LOGGER.info("RequestResponseLink {} failed to send request with request id:{}.", this.parent.linkPath, requestIdToBeSent, e);
                            this.parent.exceptionallyCompleteRequest(requestIdToBeSent, e, false);
                        }
                    } else {
                        TRACE_LOGGER.info("Request with id:{} not found in the requestresponse link.", requestIdToBeSent);
                    }
                }
            } finally {
                synchronized (this.pendingSendsSyncLock) {
                    if (this.isSendLoopRunning) {
                        this.isSendLoopRunning = false;
                    }
                }

                TRACE_LOGGER.debug("RequestResponseLink {} internal sender send loop stopped.", this.parent.linkPath);
            }
        }
    }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy