-
Notifications
You must be signed in to change notification settings - Fork 14
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: support Eureka discovery #242
Draft
Roiocam
wants to merge
15
commits into
apache:main
Choose a base branch
from
Roiocam:eureka-discovery
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from 2 commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
d8e2647
feat: support Eureka discovery
Roiocam a31e2b8
add discovery implementation and test
Roiocam 24977a8
addition tests and fix compile
Roiocam d765993
scalafmt
Roiocam 962e9bc
add manifest
Roiocam aefba17
scala 2.12 compile issues
pjfanning 8e5a615
scalafmt
pjfanning 84e90c3
disable mima check
pjfanning c228476
try to use embedded-eureka (not working yet)
pjfanning c13c172
Update EurekaServiceDiscoverySpec.scala
pjfanning 6a6d81d
Update link-validator.conf
pjfanning 812a322
Update link-validator.conf
pjfanning 81530cd
remove unused config settings
pjfanning bb0b424
remove secureVipAddress (not in response)
pjfanning 003671d
make tests pass
pjfanning File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
# SPDX-License-Identifier: Apache-2.0 | ||
|
||
###################################################### | ||
# Apache Pekko Service Discovery Eureka Config # | ||
###################################################### | ||
|
||
pekko.discovery { | ||
|
||
eureka { | ||
class = org.apache.pekko.discovery.eureka.EurekaServiceDiscovery | ||
# default eureka schema | ||
eureka-schema = "http" | ||
# default eureka host | ||
eureka-host = "127.0.0.1" | ||
# default eureka port | ||
eureka-port = 8761 | ||
# default eureka-path | ||
eureka-path = "eureka" | ||
# default discovery service group. | ||
group-name = "DEFAULT_GROUP" | ||
# default eureka registration status page url | ||
status-page-url = "" | ||
# default eureka registration health page url | ||
health-page-url ="" | ||
# default eureka registration home page url | ||
home-page-url ="" | ||
# default eureka registration service port | ||
service-port = 80 | ||
# default eureka renew interval millis | ||
renew-interval = 30000 | ||
} | ||
} |
32 changes: 32 additions & 0 deletions
32
discovery-eureka/src/main/scala/org/apache/pekko/discovery/eureka/EurekaResponse.scala
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
/* | ||
* 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.pekko.discovery.eureka | ||
|
||
object EurekaResponse { | ||
case class Application(name: String, instance: Seq[Instance]) | ||
case class Instance(hostName: String, app: String, vipAddress: String, secureVipAddress: String, ipAddr: String, status: String, port: PortWrapper, securePort: PortWrapper, healthCheckUrl: String, statusPageUrl: String, homePageUrl: String, appGroupName: String, dataCenterInfo: DataCenterInfo, lastDirtyTimestamp: String) | ||
case class Status() | ||
case class PortWrapper(port: Int, enabled: Boolean) | ||
case class DataCenterInfo(name: String = "MyOwn", clz : String = "com.netflix.appinfo.InstanceInfo$DefaultDataCenterInfo") | ||
} | ||
|
||
import EurekaResponse._ | ||
|
||
case class EurekaResponse(application: Application, errorCode: Option[String]) |
89 changes: 89 additions & 0 deletions
89
...very-eureka/src/main/scala/org/apache/pekko/discovery/eureka/EurekaServiceDiscovery.scala
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,89 @@ | ||
/* | ||
* 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.pekko.discovery.eureka | ||
|
||
import org.apache.pekko.actor.ActorSystem | ||
import org.apache.pekko.discovery.ServiceDiscovery.{Resolved, ResolvedTarget} | ||
import org.apache.pekko.discovery.eureka.JsonFormat._ | ||
import org.apache.pekko.discovery.{Lookup, ServiceDiscovery} | ||
import org.apache.pekko.event.{LogSource, Logging} | ||
import org.apache.pekko.http.scaladsl.Http | ||
import org.apache.pekko.http.scaladsl.model.headers._ | ||
import org.apache.pekko.http.scaladsl.model.{HttpRequest, MediaRange, MediaTypes, Uri} | ||
import org.apache.pekko.http.scaladsl.unmarshalling.Unmarshal | ||
|
||
import java.net.InetAddress | ||
import scala.concurrent.Future | ||
import scala.concurrent.duration.FiniteDuration | ||
import scala.util.Try | ||
|
||
class EurekaServiceDiscovery(implicit system: ActorSystem) extends ServiceDiscovery { | ||
|
||
import system.dispatcher | ||
|
||
private val log = Logging(system, getClass)(LogSource.fromClass) | ||
private val settings = EurekaSettings(system) | ||
private val (schema, host, port, path, group) = (settings.schema, settings.host, settings.port, settings.path, settings.groupName) | ||
private val http = Http() | ||
|
||
override def lookup(lookup: Lookup, resolveTimeout: FiniteDuration): Future[ServiceDiscovery.Resolved] = { | ||
|
||
val uriPath = Uri.Path.Empty / path / "apps" / lookup.serviceName | ||
val uri = Uri.from(scheme = schema, host = host, port = port).withPath(uriPath) | ||
val request = HttpRequest(uri = uri, headers = Seq(`Accept-Encoding`(HttpEncodings.gzip), Accept(MediaRange(MediaTypes.`application/json`)))) | ||
|
||
log.info("Requesting seed nodes by: {}", request.uri) | ||
|
||
for { | ||
response <- http.singleRequest(request) | ||
entity <- response.entity.toStrict(resolveTimeout) | ||
response <- { | ||
log.debug("Eureka response: [{}]", entity.data.utf8String) | ||
val unmarshalled = Unmarshal(entity).to[EurekaResponse] | ||
unmarshalled.failed.foreach { _ => | ||
log.error( | ||
"Failed to unmarshal Eureka response status [{}], entity: [{}], uri: [{}]", | ||
response.status.value, | ||
entity.data.utf8String, | ||
uri) | ||
} | ||
unmarshalled | ||
} | ||
instances <- pick(response.application.instance) | ||
} yield Resolved(lookup.serviceName, targets(instances)) | ||
|
||
} | ||
|
||
private[eureka] def pick(instances: Seq[EurekaResponse.Instance]): Future[Seq[EurekaResponse.Instance]] = { | ||
Future.successful(instances.collect({ | ||
case instance if instance.status == "UP" && instance.appGroupName == group => instance | ||
})) | ||
} | ||
|
||
private[eureka] def targets(instances: Seq[EurekaResponse.Instance]): Seq[ResolvedTarget] = { | ||
instances.map { instance => | ||
ResolvedTarget( | ||
host = instance.ipAddr, | ||
port = Some(instance.port.port), | ||
address = Try(InetAddress.getByName(instance.ipAddr)).toOption) | ||
} | ||
} | ||
|
||
} |
59 changes: 59 additions & 0 deletions
59
discovery-eureka/src/main/scala/org/apache/pekko/discovery/eureka/EurekaSettings.scala
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
/* | ||
* 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.pekko.discovery.eureka | ||
|
||
import org.apache.pekko | ||
import pekko.actor.{ | ||
ActorSystem, | ||
ClassicActorSystemProvider, | ||
ExtendedActorSystem, | ||
Extension, | ||
ExtensionId, | ||
ExtensionIdProvider | ||
} | ||
import pekko.annotation.ApiMayChange | ||
|
||
@ApiMayChange | ||
final class EurekaSettings(system: ExtendedActorSystem) extends Extension { | ||
private val eurekaConfig = system.settings.config.getConfig("pekko.discovery.eureka") | ||
|
||
val schema: String = eurekaConfig.getString("eureka-schema") | ||
val host: String = eurekaConfig.getString("eureka-host") | ||
val port: Int = eurekaConfig.getInt("eureka-port") | ||
val path: String = eurekaConfig.getString("eureka-path") | ||
val groupName: String = eurekaConfig.getString("group-name") | ||
val statusPageUrl: String = eurekaConfig.getString("status-page-url") | ||
val healthCheckUrl: String = eurekaConfig.getString("health-page-url") | ||
val homePageUrl: String = eurekaConfig.getString("home-page-url") | ||
val servicePort: Int = eurekaConfig.getInt("service-port") | ||
val serviceName: String = system.name | ||
val renewInterval: Long = eurekaConfig.getLong("renew-interval") | ||
} | ||
|
||
@ApiMayChange | ||
object EurekaSettings extends ExtensionId[EurekaSettings] with ExtensionIdProvider { | ||
override def get(system: ActorSystem): EurekaSettings = super.get(system) | ||
|
||
override def get(system: ClassicActorSystemProvider): EurekaSettings = super.get(system) | ||
|
||
override def lookup: EurekaSettings.type = EurekaSettings | ||
|
||
override def createExtension(system: ExtendedActorSystem): EurekaSettings = new EurekaSettings(system) | ||
} |
50 changes: 50 additions & 0 deletions
50
discovery-eureka/src/main/scala/org/apache/pekko/discovery/eureka/JsonFormat.scala
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
/* | ||
* Licensed to the Apache Software Foundation (ASF) under one or more | ||
* license agreements; and to You under the Apache License, version 2.0: | ||
* | ||
* https://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* This file is part of the Apache Pekko project, which was derived from Akka. | ||
*/ | ||
|
||
/* | ||
* Copyright (C) 2017-2021 Lightbend Inc. <https://www.lightbend.com> | ||
*/ | ||
|
||
package org.apache.pekko.discovery.eureka | ||
|
||
import org.apache.pekko.discovery.eureka.EurekaResponse.{Application, DataCenterInfo, Instance, PortWrapper} | ||
import org.apache.pekko.http.scaladsl.marshallers.sprayjson.SprayJsonSupport | ||
import spray.json._ | ||
|
||
object JsonFormat extends SprayJsonSupport with DefaultJsonProtocol { | ||
implicit val portFormat: JsonFormat[PortWrapper] = new JsonFormat[PortWrapper] { | ||
|
||
override def read(json: JsValue): PortWrapper = { | ||
json.asJsObject.getFields("$", "@enabled") match { | ||
case Seq(JsNumber(port), JsString(enabled)) => PortWrapper(port.toInt, enabled.toBoolean) | ||
case _ => throw DeserializationException("PortWrapper expected") | ||
} | ||
} | ||
|
||
override def write(obj: PortWrapper): JsValue = JsObject( | ||
"$" -> JsNumber(obj.port), | ||
"@enabled" -> JsString(obj.enabled.toString)) | ||
} | ||
implicit val dataCenterInfoFormat: JsonFormat[DataCenterInfo] = new JsonFormat[DataCenterInfo] { | ||
|
||
override def read(json: JsValue): DataCenterInfo = { | ||
json.asJsObject.getFields("name","@class") match { | ||
case Seq(JsString(name), JsString(clz)) => DataCenterInfo(name, clz) | ||
case _ => throw DeserializationException("DataCenterInfo expected") | ||
} | ||
} | ||
|
||
override def write(obj: DataCenterInfo): JsValue = JsObject( | ||
"name" -> JsString(obj.name), | ||
"@class" -> JsString(obj.clz)) | ||
} | ||
implicit val instanceFormat: JsonFormat[Instance] = jsonFormat14(Instance.apply) | ||
implicit val applicationFormat: JsonFormat[Application] = jsonFormat2(Application.apply) | ||
implicit val rootFormat: RootJsonFormat[EurekaResponse] = jsonFormat2(EurekaResponse.apply) | ||
} |
85 changes: 85 additions & 0 deletions
85
discovery-eureka/src/test/scala/EurekaServiceDiscoverySpec.scala
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,85 @@ | ||
/* | ||
* 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. | ||
*/ | ||
|
||
import org.apache.pekko.actor.ActorSystem | ||
import org.apache.pekko.discovery.ServiceDiscovery.ResolvedTarget | ||
import org.apache.pekko.discovery.eureka.EurekaServiceDiscovery | ||
import org.apache.pekko.testkit.TestKitBase | ||
import org.scalatest.BeforeAndAfterAll | ||
import org.scalatest.concurrent.ScalaFutures | ||
import org.scalatest.matchers.should.Matchers | ||
import org.scalatest.time.{Millis, Seconds, Span} | ||
import org.scalatest.wordspec.AnyWordSpecLike | ||
|
||
import java.net.InetAddress | ||
import scala.concurrent.duration.DurationInt | ||
import scala.io.Source | ||
import scala.util.Try | ||
|
||
/* | ||
* 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. | ||
*/ | ||
|
||
|
||
class EurekaServiceDiscoverySpec | ||
extends AnyWordSpecLike | ||
with Matchers | ||
with BeforeAndAfterAll | ||
with TestKitBase | ||
with ScalaFutures { | ||
"Eureka Discovery" should { | ||
"work for defaults" in { | ||
|
||
val lookupService = new EurekaServiceDiscovery() | ||
val resolved = lookupService.lookup("BANK-ACCOUNT", 10.seconds).futureValue | ||
resolved.addresses should contain( | ||
ResolvedTarget( | ||
host = "127.0.0.1", | ||
port = Some(8558), | ||
address = Try(InetAddress.getByName("127.0.0.1")).toOption)) | ||
|
||
} | ||
} | ||
|
||
private def resourceAsString(name: String): String = | ||
Source.fromInputStream(getClass.getClassLoader.getResourceAsStream(name)).mkString | ||
|
||
override def afterAll(): Unit = { | ||
super.afterAll() | ||
print("clean up \n") | ||
} | ||
|
||
override implicit lazy val system: ActorSystem = ActorSystem("test") | ||
|
||
implicit override val patienceConfig: PatienceConfig = | ||
PatienceConfig(timeout = scaled(Span(30, Seconds)), interval = scaled(Span(50, Millis))) | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Roiocam most of these configs are unused - can we remove the unused ones?