Switch to KeyAndBuilderValuesHystrixPropertiesStrategy

app/com/m3/octoparts/Global.scala

@@ -7,7 +7,7 @@ import _root_.controllers.ControllersModule
 import com.kenshoo.play.metrics.MetricsFilter
 import com.m3.octoparts.cache.CacheModule
 import com.m3.octoparts.http.HttpModule
-import com.m3.octoparts.hystrix.{ CachelessHystrixPropertiesStrategy, HystrixMetricsLogger, HystrixModule }
+import com.m3.octoparts.hystrix.{ KeyAndBuilderValuesHystrixPropertiesStrategy, HystrixMetricsLogger, HystrixModule }
 import com.m3.octoparts.logging.PartRequestLogger
 import com.beachape.logging.LTSVLogger
 import com.m3.octoparts.repository.RepositoriesModule
@@ -101,24 +101,24 @@ object Global extends WithFilters(MetricsFilter) with ScaldiSupport {
   }
 
   /**
-   * Tries to set the Hystrix properties strategy to CachelessHystrixPropertiesStrategy
+   * Tries to set the Hystrix properties strategy to [[KeyAndBuilderValuesHystrixPropertiesStrategy]]
    *
    * Resist the temptation to do a HystrixPlugins.getInstance().getPropertiesStrategy first to do
    * checking, as that actually also sets the strategy if it isn't already set.
    */
   def setHystrixPropertiesStrategy(app: Application): Unit = {
     // If it's defined, we don't need to set anything
     if (sys.props.get("hystrix.plugin.HystrixPropertiesStrategy.implementation").isEmpty) {
-      LTSVLogger.warn("-Dhystrix.plugin.HystrixPropertiesStrategy.implementation is not set. It should be" -> "com.m3.octoparts.hystrix.CachelessHystrixPropertiesStrategy")
+      LTSVLogger.warn("-Dhystrix.plugin.HystrixPropertiesStrategy.implementation is not set. It should be" -> "com.m3.octoparts.hystrix.KeyAndBuilderValuesHystrixPropertiesStrategy")
       try {
-        HystrixPlugins.getInstance().registerPropertiesStrategy(new CachelessHystrixPropertiesStrategy)
+        HystrixPlugins.getInstance().registerPropertiesStrategy(new KeyAndBuilderValuesHystrixPropertiesStrategy)
       } catch {
         case NonFatal(e) => {
           val currentStrategy = HystrixPlugins.getInstance().getPropertiesStrategy.getClass
-          if (currentStrategy != classOf[CachelessHystrixPropertiesStrategy]) {
+          if (currentStrategy != classOf[KeyAndBuilderValuesHystrixPropertiesStrategy]) {
             LTSVLogger.error(e, "Current Hystrix Properties Strategy:" -> currentStrategy)
             if (Play.mode(app) != Mode.Test)
-              sys.error("Tried but failed to set CachelessHystrixPropertiesStrategy as HystrixPropertiesStrategy")
+              sys.error("Tried but failed to set KeyAndBuilderValuesHystrixPropertiesStrategy as HystrixPropertiesStrategy")
           }
         }
       }

app/com/m3/octoparts/hystrix/KeyAndBuilderValuesHystrixPropertiesStrategy.scala

@@ -0,0 +1,20 @@
+package com.m3.octoparts.hystrix
+
+import com.fasterxml.jackson.databind.ObjectMapper
+import com.netflix.hystrix.{ HystrixCommandKey, HystrixCommandProperties }
+import com.netflix.hystrix.strategy.properties.HystrixPropertiesStrategy
+
+/**
+ * Custom [[HystrixPropertiesStrategy]] implementation
+ */
+class KeyAndBuilderValuesHystrixPropertiesStrategy extends HystrixPropertiesStrategy {
+  private val mapper = new ObjectMapper()
+
+  /**
+   * Overriden to return a [[String]] that is a combination of the commandKey name and a JSON string
+   * of the builder values
+   */
+  override def getCommandPropertiesCacheKey(commandKey: HystrixCommandKey, builder: HystrixCommandProperties.Setter): String =
+    s"${commandKey.name()}-${mapper.writeValueAsString(builder)}"
+
+}

project/Build.scala

@@ -72,7 +72,7 @@ object OctopartsBuild extends Build {
       sonatypeSettings ++
       coverallsSettings ++
       Seq(
-        javaOptions += "-Dhystrix.plugin.HystrixPropertiesStrategy.implementation=com.m3.octoparts.hystrix.CachelessHystrixPropertiesStrategy",
+        javaOptions += "-Dhystrix.plugin.HystrixPropertiesStrategy.implementation=com.m3.octoparts.hystrix.KeyAndBuilderValuesHystrixPropertiesStrategy",
         publishArtifact := false,
         libraryDependencies ++= Seq(
           // Logging

test/com/m3/octoparts/hystrix/CachelessHystrixPropertiesStrategySpec.scala → test/com/m3/octoparts/hystrix/KeyAndBuilderValuesHystrixPropertiesStrategySpec.scala

@@ -5,15 +5,15 @@ import com.netflix.hystrix.strategy.properties.HystrixPropertiesFactory
 import com.netflix.hystrix.{ HystrixCommandProperties, HystrixCommandKey }
 import org.scalatest.{ Matchers, FunSpec }
 
-class CachelessHystrixPropertiesStrategySpec extends FunSpec with Matchers {
+class KeyAndBuilderValuesHystrixPropertiesStrategySpec extends FunSpec with Matchers {
 
-  val subject = new CachelessHystrixPropertiesStrategy
+  val subject = new KeyAndBuilderValuesHystrixPropertiesStrategy
   val commandKey = HystrixCommandKey.Factory.asKey("hello")
   val commandProps = HystrixCommandProperties.Setter()
   describe("getCommandPropertiesCacheKey") {
-    it("should return null") {
+    it("should return a combination of the commandKey name and commandProps JSON value") {
       val r = subject.getCommandPropertiesCacheKey(commandKey, commandProps)
-      r should be(null)
+      r should be("""hello-{"circuitBreakerEnabled":null,"circuitBreakerErrorThresholdPercentage":null,"circuitBreakerForceClosed":null,"circuitBreakerForceOpen":null,"circuitBreakerRequestVolumeThreshold":null,"circuitBreakerSleepWindowInMilliseconds":null,"executionIsolationSemaphoreMaxConcurrentRequests":null,"executionIsolationStrategy":null,"executionIsolationThreadInterruptOnTimeout":null,"executionIsolationThreadTimeoutInMilliseconds":null,"fallbackIsolationSemaphoreMaxConcurrentRequests":null,"fallbackEnabled":null,"metricsHealthSnapshotIntervalInMilliseconds":null,"metricsRollingPercentileBucketSize":null,"metricsRollingPercentileEnabled":null,"metricsRollingPercentileWindowInMilliseconds":null,"metricsRollingPercentileWindowBuckets":null,"metricsRollingStatisticalWindowInMilliseconds":null,"metricsRollingStatisticalWindowBuckets":null,"requestCacheEnabled":null,"requestLogEnabled":null}""")
     }
   }
 
@@ -22,7 +22,7 @@ class CachelessHystrixPropertiesStrategySpec extends FunSpec with Matchers {
 
     it("should allow HystrixPropertiesFactory.getCommandProperties to instantiate different HystrixCommandProperties for the same command key") {
       if (HystrixPlugins.getInstance().getPropertiesStrategy.getClass != subject.getClass) {
-        fail("HystrixPlugins.getPropertiesStrategy did not return CachelessHystrixPropertiesStrategy")
+        fail("HystrixPlugins.getPropertiesStrategy did not return KeyAndBuilderValuesHystrixPropertiesStrategy")
       }
       val properties1 = HystrixPropertiesFactory.getCommandProperties(
         commandKey,