finagle/finagle-thriftmux: Fix flakey thriftmux.MethodBuilder test

Problem When testing deadline application in the timeout filter, we expect a GlobalRequestTimeout to be thrown from the global timeout filter due to the short deadline. However, an IndividualRequestTimeoutException can also be thrown -- the filters set very similar timeouts due to the deadline being shorter than each of their respective timeouts, and hence the interrupts race. Solution Exception a generic RequestTimeoutException instead. JIRA Issues: CSL-12415 Differential Revision: https://phabricator.twitter.biz/D1108542
twitter · Nov 5, 2023 · 1609ebb · 1609ebb
1 parent 92c7d4d
commit 1609ebb
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/finagle-thriftmux/src/test/scala/BUILD b/finagle-thriftmux/src/test/scala/BUILD
@@ -4,7 +4,6 @@ junit_tests(
     platform = "java8",
     tags = [
         "bazel-compatible",
-        "known-to-fail-jira:CSL-12415",
     ],
     dependencies = [
         "3rdparty/jvm/junit",

diff --git a/finagle-thriftmux/src/test/scala/com/twitter/finagle/thriftmux/MethodBuilderTest.scala b/finagle-thriftmux/src/test/scala/com/twitter/finagle/thriftmux/MethodBuilderTest.scala
@@ -189,8 +189,11 @@ class MethodBuilderTest extends AnyFunSuite with Eventually {
 
     toggleOnCtx {
       Contexts.broadcast.let(Deadline, Deadline.ofTimeout(5.millis)) {
-        // short deadline should fire
-        intercept[GlobalRequestTimeoutException] {
+        // short deadline should fire. Note that the RequestTimeoutException that fires could be either
+        // an [[IndividualRequestTimeoutException]] or a [[GlobalRequestTimeoutException]], due to racing
+        // interrupts, since the global and individual filters have a very similar timeout after applying
+        // our deadline.
+        intercept[RequestTimeoutException] {
           await(shortTimeoutSvcPerEndpoint(TestService.Query.Args("shorty")))
         }
       }