From 1ffd05db49ef9bdda40a133853c686e435aaa415 Mon Sep 17 00:00:00 2001
From: Patrik Nordwall <patrik.nordwall@gmail.com>
Date: Fri, 29 Aug 2014 11:17:33 +0200
Subject: [PATCH] =act #13981 Encode name of Balancing dispatcher config path

---
 .../scala/akka/routing/BalancingSpec.scala    | 23 +++++++++++++++++++
 .../main/scala/akka/routing/Balancing.scala   |  8 ++++++-
 .../docs/persistence/PersistenceDocSpec.scala | 12 +++++-----
 3 files changed, 36 insertions(+), 7 deletions(-)

diff --git a/akka-actor-tests/src/test/scala/akka/routing/BalancingSpec.scala b/akka-actor-tests/src/test/scala/akka/routing/BalancingSpec.scala
index bdf30abe5d..d5ee52b5a1 100644
--- a/akka-actor-tests/src/test/scala/akka/routing/BalancingSpec.scala
+++ b/akka-actor-tests/src/test/scala/akka/routing/BalancingSpec.scala
@@ -11,6 +11,7 @@ import akka.actor.{ Props, Actor }
 import akka.testkit.{ TestLatch, ImplicitSender, AkkaSpec }
 import akka.actor.ActorRef
 import org.scalatest.BeforeAndAfterEach
+import java.net.URLEncoder
 
 object BalancingSpec {
   val counter = new AtomicInteger(1)
@@ -24,6 +25,15 @@ object BalancingSpec {
         sender() ! id
     }
   }
+
+  class Parent extends Actor {
+    val pool = context.actorOf(BalancingPool(2).props(routeeProps =
+      Props(classOf[Worker], TestLatch(0)(context.system))))
+
+    def receive = {
+      case msg ⇒ pool.forward(msg)
+    }
+  }
 }
 
 @org.junit.runner.RunWith(classOf[org.scalatest.junit.JUnitRunner])
@@ -98,5 +108,18 @@ class BalancingSpec extends AkkaSpec(
       test(pool, latch)
     }
 
+    "work with anonymous actor names" in {
+      // the dispatcher-id must not contain invalid config key characters (e.g. $a) 
+      system.actorOf(Props[Parent]) ! "hello"
+      expectMsgType[Int]
+    }
+
+    "work with encoded actor names" in {
+      val encName = URLEncoder.encode("abcå6#$€xyz", "utf-8")
+      // % is a valid config key character (e.g. %C3%A5) 
+      system.actorOf(Props[Parent], encName) ! "hello"
+      expectMsgType[Int]
+    }
+
   }
 }
diff --git a/akka-actor/src/main/scala/akka/routing/Balancing.scala b/akka-actor/src/main/scala/akka/routing/Balancing.scala
index 7cd7042d22..bc4fd0372c 100644
--- a/akka-actor/src/main/scala/akka/routing/Balancing.scala
+++ b/akka-actor/src/main/scala/akka/routing/Balancing.scala
@@ -99,7 +99,10 @@ final case class BalancingPool(
    */
   override private[akka] def newRoutee(routeeProps: Props, context: ActorContext): Routee = {
 
-    val deployPath = context.self.path.elements.drop(1).mkString("/", "/", "")
+    val rawDeployPath = context.self.path.elements.drop(1).mkString("/", "/", "")
+    val deployPath = BalancingPool.invalidConfigKeyChars.foldLeft(rawDeployPath) { (replaced, c) ⇒
+      replaced.replace(c, '_')
+    }
     val dispatcherId = s"BalancingPool-$deployPath"
     def dispatchers = context.system.dispatchers
 
@@ -147,3 +150,6 @@ final case class BalancingPool(
 
 }
 
+object BalancingPool {
+  private val invalidConfigKeyChars = List('$', '@', ':')
+}
diff --git a/akka-docs/rst/scala/code/docs/persistence/PersistenceDocSpec.scala b/akka-docs/rst/scala/code/docs/persistence/PersistenceDocSpec.scala
index c09e1b87cb..11b442cbb5 100644
--- a/akka-docs/rst/scala/code/docs/persistence/PersistenceDocSpec.scala
+++ b/akka-docs/rst/scala/code/docs/persistence/PersistenceDocSpec.scala
@@ -4,7 +4,7 @@
 
 package docs.persistence
 
-import akka.actor.{Actor, ActorSystem, Props}
+import akka.actor.{ Actor, ActorSystem, Props }
 import akka.persistence._
 import com.typesafe.config.ConfigFactory
 
@@ -29,7 +29,7 @@ trait PersistenceDocSpec {
 
   new AnyRef {
     //#definition
-    import akka.persistence.{PersistenceFailure, Persistent, Processor}
+    import akka.persistence.{ PersistenceFailure, Persistent, Processor }
 
     class MyProcessor extends Processor {
       def receive = {
@@ -135,7 +135,7 @@ trait PersistenceDocSpec {
 
   new AnyRef {
     //#at-least-once-example
-    import akka.actor.{Actor, ActorPath}
+    import akka.actor.{ Actor, ActorPath }
     import akka.persistence.AtLeastOnceDelivery
 
     case class Msg(deliveryId: Long, s: String)
@@ -177,8 +177,8 @@ trait PersistenceDocSpec {
 
   new AnyRef {
     //#channel-example
-    import akka.actor.{Actor, Props}
-    import akka.persistence.{Channel, Deliver, Persistent, Processor}
+    import akka.actor.{ Actor, Props }
+    import akka.persistence.{ Channel, Deliver, Persistent, Processor }
 
     class MyProcessor extends Processor {
       val destination = context.actorOf(Props[MyDestination])
@@ -252,7 +252,7 @@ trait PersistenceDocSpec {
   new AnyRef {
     //#fsm-example
     import akka.actor.FSM
-    import akka.persistence.{Persistent, Processor}
+    import akka.persistence.{ Persistent, Processor }
 
     class PersistentDoor extends Processor with FSM[String, Int] {
       startWith("closed", 0)