From be1e25f4d12f37f324bb8c46b7a47e9fb4350a70 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Johan=20Andr=C3=A9n?= <johan@markatta.com>
Date: Tue, 24 Oct 2017 11:10:57 +0200
Subject: [PATCH] Fail fast on null messages #23796

---
 .../test/scala/akka/typed/ActorContextSpec.scala   | 10 +++++++++-
 .../akka/typed/internal/ActorSystemSpec.scala      |  9 +++++++++
 .../akka/typed/internal/FunctionRefSpec.scala      | 14 +++++++++++++-
 .../akka/typed/scaladsl/adapter/AdapterSpec.scala  | 11 ++++++++++-
 .../src/main/scala/akka/typed/Behavior.scala       |  3 +++
 .../main/scala/akka/typed/internal/ActorCell.scala | 10 +++++++---
 .../scala/akka/typed/internal/ActorRefImpl.scala   | 14 +++++++++++---
 .../scala/akka/typed/internal/BehaviorImpl.scala   |  2 ++
 .../typed/internal/adapter/ActorRefAdapter.scala   |  6 +++++-
 .../internal/adapter/ActorSystemAdapter.scala      |  6 +++++-
 10 files changed, 74 insertions(+), 11 deletions(-)

diff --git a/akka-typed-tests/src/test/scala/akka/typed/ActorContextSpec.scala b/akka-typed-tests/src/test/scala/akka/typed/ActorContextSpec.scala
index ea35080556..374a30a55f 100644
--- a/akka-typed-tests/src/test/scala/akka/typed/ActorContextSpec.scala
+++ b/akka-typed-tests/src/test/scala/akka/typed/ActorContextSpec.scala
@@ -6,8 +6,9 @@ package akka.typed
 import scala.concurrent.duration._
 import scala.concurrent.Future
 import com.typesafe.config.ConfigFactory
-import akka.actor.DeadLetterSuppression
+import akka.actor.{ DeadLetterSuppression, InvalidMessageException }
 import akka.typed.scaladsl.Actor
+
 import scala.language.existentials
 
 object ActorContextSpec {
@@ -620,6 +621,13 @@ class ActorContextSpec extends TypedSpec(ConfigFactory.parseString(
         adapter.path.name should include("named")
       }
     })
+    def `42 must not allow null messages`(): Unit = sync(setup("ctx42") { (ctx, startWith) ⇒
+      startWith.keep { subj ⇒
+        intercept[InvalidMessageException] {
+          subj ! null
+        }
+      }
+    })
   }
 
   trait Normal extends Tests {
diff --git a/akka-typed-tests/src/test/scala/akka/typed/internal/ActorSystemSpec.scala b/akka-typed-tests/src/test/scala/akka/typed/internal/ActorSystemSpec.scala
index 182deccba5..cac549ef14 100644
--- a/akka-typed-tests/src/test/scala/akka/typed/internal/ActorSystemSpec.scala
+++ b/akka-typed-tests/src/test/scala/akka/typed/internal/ActorSystemSpec.scala
@@ -5,6 +5,7 @@ package akka.typed
 package internal
 
 import akka.Done
+import akka.actor.InvalidMessageException
 import akka.typed.scaladsl.Actor
 import akka.typed.scaladsl.Actor._
 import akka.typed.testkit.Inbox
@@ -97,6 +98,14 @@ class ActorSystemSpec extends Spec with Matchers with BeforeAndAfterAll with Sca
         f.futureValue should ===(42)
       }
 
+    def `must not allow null messages`(): Unit = {
+      withSystem("null-messages", Actor.empty[String]) { sys ⇒
+        intercept[InvalidMessageException] {
+          sys ! null
+        }
+      }
+    }
+
   }
 
   object `An ActorSystemImpl` extends CommonTests {
diff --git a/akka-typed-tests/src/test/scala/akka/typed/internal/FunctionRefSpec.scala b/akka-typed-tests/src/test/scala/akka/typed/internal/FunctionRefSpec.scala
index f9f0d83aa6..1748af92eb 100644
--- a/akka-typed-tests/src/test/scala/akka/typed/internal/FunctionRefSpec.scala
+++ b/akka-typed-tests/src/test/scala/akka/typed/internal/FunctionRefSpec.scala
@@ -4,7 +4,9 @@
 package akka.typed
 package internal
 
-import scala.concurrent.{ Promise, Future }
+import akka.actor.InvalidMessageException
+
+import scala.concurrent.{ Future, Promise }
 
 class FunctionRefSpec extends TypedSpecSetup {
 
@@ -159,6 +161,16 @@ class FunctionRefSpec extends TypedSpecSetup {
       client1.hasSomething should ===(false)
     }
 
+    def `must not allow null messages`(): Unit = {
+      val p = Promise[ActorRef[String]]
+      val ref = ActorRef(p.future)
+
+      intercept[InvalidMessageException] {
+        ref ! null
+      }
+
+    }
+
   }
 
 }
diff --git a/akka-typed-tests/src/test/scala/akka/typed/scaladsl/adapter/AdapterSpec.scala b/akka-typed-tests/src/test/scala/akka/typed/scaladsl/adapter/AdapterSpec.scala
index 8a6f04c389..f0515d1f52 100644
--- a/akka-typed-tests/src/test/scala/akka/typed/scaladsl/adapter/AdapterSpec.scala
+++ b/akka-typed-tests/src/test/scala/akka/typed/scaladsl/adapter/AdapterSpec.scala
@@ -6,7 +6,7 @@ package akka.typed.scaladsl.adapter
 import scala.concurrent.duration._
 import scala.util.control.NoStackTrace
 import akka.typed.ActorRef
-import akka.actor.Props
+import akka.actor.{ InvalidMessageException, Props }
 import akka.typed.Behavior
 import akka.typed.Terminated
 import akka.typed.scaladsl.Actor
@@ -169,6 +169,15 @@ class AdapterSpec extends AkkaSpec {
       probe.expectMsg("ok")
     }
 
+    "not send null message from typed to untyped" in {
+      val probe = TestProbe()
+      val untypedRef = system.actorOf(untyped1)
+      val typedRef = system.spawnAnonymous(typed1(untypedRef, probe.ref))
+      intercept[InvalidMessageException] {
+        typedRef ! null
+      }
+    }
+
     "send message from untyped to typed" in {
       val probe = TestProbe()
       val typedRef = system.spawnAnonymous(typed2)
diff --git a/akka-typed/src/main/scala/akka/typed/Behavior.scala b/akka-typed/src/main/scala/akka/typed/Behavior.scala
index 5888bedf38..f765418f22 100644
--- a/akka-typed/src/main/scala/akka/typed/Behavior.scala
+++ b/akka-typed/src/main/scala/akka/typed/Behavior.scala
@@ -3,6 +3,8 @@
  */
 package akka.typed
 
+import akka.actor.InvalidMessageException
+
 import scala.annotation.tailrec
 import akka.util.LineNumbers
 import akka.annotation.{ DoNotInherit, InternalApi }
@@ -275,6 +277,7 @@ object Behavior {
 
   private def interpret[T](behavior: Behavior[T], ctx: ActorContext[T], msg: Any): Behavior[T] =
     behavior match {
+      case null ⇒ throw new InvalidMessageException("[null] is not an allowed message")
       case SameBehavior | UnhandledBehavior ⇒
         throw new IllegalArgumentException(s"cannot execute with [$behavior] as behavior")
       case _: UntypedBehavior[_] ⇒
diff --git a/akka-typed/src/main/scala/akka/typed/internal/ActorCell.scala b/akka-typed/src/main/scala/akka/typed/internal/ActorCell.scala
index 2bf0f8511a..845c1b9620 100644
--- a/akka-typed/src/main/scala/akka/typed/internal/ActorCell.scala
+++ b/akka-typed/src/main/scala/akka/typed/internal/ActorCell.scala
@@ -4,15 +4,17 @@
 package akka.typed
 package internal
 
-import akka.actor.InvalidActorNameException
+import akka.actor.{ Cancellable, InvalidActorNameException, InvalidMessageException }
 import akka.util.Helpers
+
 import scala.concurrent.duration.FiniteDuration
 import akka.dispatch.ExecutionContexts
+
 import scala.concurrent.ExecutionContextExecutor
-import akka.actor.Cancellable
 import akka.util.Unsafe.{ instance ⇒ unsafe }
 import java.util.concurrent.ConcurrentLinkedQueue
 import java.util.Queue
+
 import scala.annotation.tailrec
 import scala.util.control.NonFatal
 import scala.util.control.Exception.Catcher
@@ -198,7 +200,8 @@ private[typed] class ActorCell[T](
       publish(Error(e, self.path.toString, getClass, "swallowing exception during message send"))
   }
 
-  def send(msg: T): Unit =
+  def send(msg: T): Unit = {
+    if (msg == null) throw new InvalidMessageException("[null] is not an allowed message")
     try {
       val old = unsafe.getAndAddInt(this, statusOffset, 1)
       val oldActivations = activations(old)
@@ -224,6 +227,7 @@ private[typed] class ActorCell[T](
         }
       }
     } catch handleException
+  }
 
   def sendSystem(signal: SystemMessage): Unit = {
     @tailrec def needToActivate(): Boolean = {
diff --git a/akka-typed/src/main/scala/akka/typed/internal/ActorRefImpl.scala b/akka-typed/src/main/scala/akka/typed/internal/ActorRefImpl.scala
index 5f5766925f..34afd94656 100644
--- a/akka-typed/src/main/scala/akka/typed/internal/ActorRefImpl.scala
+++ b/akka-typed/src/main/scala/akka/typed/internal/ActorRefImpl.scala
@@ -7,11 +7,15 @@ package internal
 import akka.{ actor ⇒ a }
 import akka.dispatch.sysmsg._
 import akka.util.Unsafe.{ instance ⇒ unsafe }
+
 import scala.annotation.tailrec
 import scala.util.control.NonFatal
 import scala.concurrent.Future
 import java.util.ArrayList
-import scala.util.{ Success, Failure }
+
+import akka.actor.InvalidMessageException
+
+import scala.util.{ Failure, Success }
 import scala.annotation.unchecked.uncheckedVariance
 
 /**
@@ -85,12 +89,14 @@ private[typed] final class FunctionRef[-T](
   _terminate: FunctionRef[T] ⇒ Unit)
   extends WatchableRef[T](_path) {
 
-  override def tell(msg: T): Unit =
+  override def tell(msg: T): Unit = {
+    if (msg == null) throw new InvalidMessageException("[null] is not an allowed message")
     if (isAlive)
       try send(msg, this) catch {
         case NonFatal(ex) ⇒ // nothing we can do here
       }
     else () // we don’t have deadLetters available
+  }
 
   override def sendSystem(signal: SystemMessage): Unit = signal match {
     case Create()                           ⇒ // nothing to do
@@ -193,7 +199,8 @@ private[typed] class FutureRef[-T](_path: a.ActorPath, bufferSize: Int, f: Futur
     }
   }
 
-  override def tell(msg: T): Unit =
+  override def tell(msg: T): Unit = {
+    if (msg == null) throw new InvalidMessageException("[null] is not an allowed message")
     _target match {
       case Left(list) ⇒
         list.synchronized {
@@ -202,6 +209,7 @@ private[typed] class FutureRef[-T](_path: a.ActorPath, bufferSize: Int, f: Futur
         }
       case Right(ref) ⇒ ref ! msg
     }
+  }
 
   override def sendSystem(signal: SystemMessage): Unit = signal match {
     case Create() ⇒ // nothing to do
diff --git a/akka-typed/src/main/scala/akka/typed/internal/BehaviorImpl.scala b/akka-typed/src/main/scala/akka/typed/internal/BehaviorImpl.scala
index 2cad783a62..11571afcfe 100644
--- a/akka-typed/src/main/scala/akka/typed/internal/BehaviorImpl.scala
+++ b/akka-typed/src/main/scala/akka/typed/internal/BehaviorImpl.scala
@@ -4,11 +4,13 @@
 package akka.typed
 package internal
 
+import akka.actor.InvalidMessageException
 import akka.util.LineNumbers
 import akka.annotation.InternalApi
 import akka.typed.{ ActorContext ⇒ AC }
 import akka.typed.scaladsl.{ ActorContext ⇒ SAC }
 import akka.typed.scaladsl.Actor
+
 import scala.reflect.ClassTag
 import scala.annotation.tailrec
 
diff --git a/akka-typed/src/main/scala/akka/typed/internal/adapter/ActorRefAdapter.scala b/akka-typed/src/main/scala/akka/typed/internal/adapter/ActorRefAdapter.scala
index fd151b05de..e823fd0fc6 100644
--- a/akka-typed/src/main/scala/akka/typed/internal/adapter/ActorRefAdapter.scala
+++ b/akka-typed/src/main/scala/akka/typed/internal/adapter/ActorRefAdapter.scala
@@ -5,6 +5,7 @@ package akka.typed
 package internal
 package adapter
 
+import akka.actor.InvalidMessageException
 import akka.{ actor ⇒ a }
 import akka.annotation.InternalApi
 import akka.dispatch.sysmsg
@@ -16,7 +17,10 @@ import akka.dispatch.sysmsg
   extends ActorRef[T] with internal.ActorRefImpl[T] {
 
   override def path: a.ActorPath = untyped.path
-  override def tell(msg: T): Unit = untyped ! msg
+  override def tell(msg: T): Unit = {
+    if (msg == null) throw new InvalidMessageException("[null] is not an allowed message")
+    untyped ! msg
+  }
   override def isLocal: Boolean = untyped.isLocal
   override def sendSystem(signal: internal.SystemMessage): Unit =
     ActorRefAdapter.sendSystemMessage(untyped, signal)
diff --git a/akka-typed/src/main/scala/akka/typed/internal/adapter/ActorSystemAdapter.scala b/akka-typed/src/main/scala/akka/typed/internal/adapter/ActorSystemAdapter.scala
index 3a9ebc6319..8cab131876 100644
--- a/akka-typed/src/main/scala/akka/typed/internal/adapter/ActorSystemAdapter.scala
+++ b/akka-typed/src/main/scala/akka/typed/internal/adapter/ActorSystemAdapter.scala
@@ -5,6 +5,7 @@ package akka.typed
 package internal
 package adapter
 
+import akka.actor.InvalidMessageException
 import akka.{ actor ⇒ a }
 
 import scala.concurrent.ExecutionContextExecutor
@@ -26,7 +27,10 @@ import akka.annotation.InternalApi
   import ActorRefAdapter.sendSystemMessage
 
   // Members declared in akka.typed.ActorRef
-  override def tell(msg: T): Unit = untyped.guardian ! msg
+  override def tell(msg: T): Unit = {
+    if (msg == null) throw new InvalidMessageException("[null] is not an allowed message")
+    untyped.guardian ! msg
+  }
   override def isLocal: Boolean = true
   override def sendSystem(signal: internal.SystemMessage): Unit = sendSystemMessage(untyped.guardian, signal)
   final override val path: a.ActorPath = a.RootActorPath(a.Address("akka", untyped.name)) / "user"