sources/hv-collector-core/src/main/kotlin/org/onap/dcae/collectors/veshv/impl/socket/NettyTcpServer.kt

   1 /*
   2  * ============LICENSE_START=======================================================
   3  * dcaegen2-collectors-veshv
   4  * ================================================================================
   5  * Copyright (C) 2018 NOKIA
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20 package org.onap.dcae.collectors.veshv.impl.socket
  21
  22 import arrow.core.Option
  23 import arrow.core.getOrElse
  24 import arrow.effects.IO
  25 import io.netty.handler.ssl.SslContext
  26 import org.onap.dcae.collectors.veshv.boundary.Collector
  27 import org.onap.dcae.collectors.veshv.boundary.CollectorProvider
  28 import org.onap.dcae.collectors.veshv.boundary.Metrics
  29 import org.onap.dcae.collectors.veshv.boundary.Server
  30 import org.onap.dcae.collectors.veshv.config.api.model.ServerConfiguration
  31 import org.onap.dcae.collectors.veshv.impl.adapters.ClientContextLogging.debug
  32 import org.onap.dcae.collectors.veshv.impl.adapters.ClientContextLogging.info
  33 import org.onap.dcae.collectors.veshv.model.ClientContext
  34 import org.onap.dcae.collectors.veshv.model.ServiceContext
  35 import org.onap.dcae.collectors.veshv.utils.NettyServerHandle
  36 import org.onap.dcae.collectors.veshv.utils.ServerHandle
  37 import org.onap.dcae.collectors.veshv.utils.logging.Logger
  38 import org.onap.dcae.collectors.veshv.utils.logging.Marker
  39 import reactor.core.publisher.Mono
  40 import reactor.netty.Connection
  41 import reactor.netty.NettyInbound
  42 import reactor.netty.NettyOutbound
  43 import reactor.netty.tcp.TcpServer
  44 import java.net.InetAddress
  45 import java.net.InetSocketAddress
  46 import java.time.Duration
  47
  48
  49 /**
  50  * @author Piotr Jaszczyk <piotr.jaszczyk@nokia.com>
  51  * @since May 2018
  52  */
  53 internal class NettyTcpServer(private val serverConfiguration: ServerConfiguration,
  54                               private val sslContext: Option<SslContext>,
  55                               private val collectorProvider: CollectorProvider,
  56                               private val metrics: Metrics) : Server {
  57
  58     override fun start(): IO<ServerHandle> = IO {
  59         TcpServer.create()
  60                 .addressSupplier { InetSocketAddress(serverConfiguration.listenPort) }
  61                 .configureSsl()
  62                 .handle(this::handleConnection)
  63                 .doOnUnbound {
  64                     logger.info(ServiceContext::mdc) { "Netty TCP Server closed" }
  65                     collectorProvider.close().unsafeRunSync()
  66                 }
  67                 .let { NettyServerHandle(it.bindNow()) }
  68     }
  69
  70     private fun TcpServer.configureSsl() =
  71             sslContext
  72                     .map { serverContext ->
  73                         logger.info { "Collector configured with SSL enabled" }
  74                         this.secure { it.sslContext(serverContext) }
  75                     }.getOrElse {
  76                         logger.info { "Collector configured with SSL disabled" }
  77                         this
  78                     }
  79
  80     private fun handleConnection(nettyInbound: NettyInbound, nettyOutbound: NettyOutbound): Mono<Void> =
  81             messageHandlingStream(nettyInbound, nettyOutbound).run {
  82                 subscribe()
  83                 nettyOutbound.neverComplete()
  84             }
  85
  86     private fun messageHandlingStream(nettyInbound: NettyInbound, nettyOutbound: NettyOutbound): Mono<Void> =
  87             withNewClientContextFrom(nettyInbound, nettyOutbound)
  88             { clientContext ->
  89                 logger.debug(clientContext::fullMdc, Marker.Entry) { "Client connection request received" }
  90
  91                 clientContext.clientAddress
  92                         .map { acceptIfNotLocalConnection(it, clientContext, nettyInbound) }
  93                         .getOrElse {
  94                             logger.warn(clientContext::fullMdc) {
  95                                 "Client address could not be resolved. Discarding connection"
  96                             }
  97                             nettyInbound.closeConnectionAndReturn(Mono.empty())
  98                         }
  99             }
 100
 101     private fun acceptIfNotLocalConnection(address: InetAddress,
 102                                            clientContext: ClientContext,
 103                                            nettyInbound: NettyInbound): Mono<Void> =
 104             if (address.isLocalClientAddress()) {
 105                 logger.debug(clientContext) {
 106                     "Client address resolved to localhost. Discarding connection as suspected healthcheck"
 107                 }
 108                 nettyInbound.closeConnectionAndReturn(Mono.empty<Void>())
 109             } else {
 110                 acceptClientConnection(clientContext, nettyInbound)
 111             }
 112
 113     private fun acceptClientConnection(clientContext: ClientContext, nettyInbound: NettyInbound): Mono<Void> {
 114         metrics.notifyClientConnected()
 115         logger.info(clientContext::fullMdc) { "Handling new client connection" }
 116         val collector = collectorProvider(clientContext)
 117         return collector.handleClient(clientContext, nettyInbound)
 118     }
 119
 120     private fun Collector.handleClient(clientContext: ClientContext,
 121                              nettyInbound: NettyInbound) =
 122         withConnectionFrom(nettyInbound) { connection ->
 123             connection
 124                     .configureIdleTimeout(clientContext, serverConfiguration.idleTimeout)
 125                     .logConnectionClosed(clientContext)
 126         }.run {
 127             handleConnection(nettyInbound.createDataStream())
 128         }
 129
 130     private fun Connection.configureIdleTimeout(ctx: ClientContext, timeout: Duration): Connection =
 131             onReadIdle(timeout.toMillis()) {
 132                 logger.info(ctx) {
 133                     "Idle timeout of ${timeout.seconds} s reached. Closing connection from ${address()}..."
 134                 }
 135                 disconnectClient(ctx)
 136             }
 137
 138     private fun Connection.disconnectClient(ctx: ClientContext) =
 139             closeChannelAndThen {
 140                 if (it.isSuccess)
 141                     logger.debug(ctx::fullMdc, Marker.Exit) { "Channel closed successfully." }
 142                 else
 143                     logger.warn(ctx::fullMdc, Marker.Exit, { "Channel close failed" }, it.cause())
 144             }
 145
 146     private fun Connection.logConnectionClosed(ctx: ClientContext): Connection =
 147             onDispose {
 148                 metrics.notifyClientDisconnected()
 149                 logger.info(ctx::fullMdc, Marker.Exit) { "Connection has been closed" }
 150             }
 151
 152     companion object {
 153         private val logger = Logger(NettyTcpServer::class)
 154     }
 155 }