feat: disabling components programmatically #153
Conversation
| @@ -202,7 +203,7 @@ public static class Settings { | |||
| /** | |||
| * Default settings for testkit. | |||
| */ | |||
| public static Settings DEFAULT = new Settings("self", true, TEST_BROKER, MockedEventing.EMPTY, Optional.empty(), ConfigFactory.empty()); | |||
| public static Settings DEFAULT = new Settings("self", true, TEST_BROKER, MockedEventing.EMPTY, Optional.empty(), ConfigFactory.empty(), Set.of()); | |||
There was a problem hiding this comment.
Any advantages? The current option is a bit shorter :)
There was a problem hiding this comment.
Doesn't matter here, but otherwise I would guess that emptySet is a singleton instance and the other would create a new instance.
Leave it as is.
There was a problem hiding this comment.
FYI, both are singletons
| } | ||
|
|
||
| /** | ||
| * Disable components from running, useful for testing components in isolation. This set of disabled components will be added to {@link ServiceSetup#disabledComponents()} if configured. |
| @@ -660,6 +664,15 @@ private final class Sdk( | |||
| healthCheck = () => SdkRunner.FutureDone) | |||
| } | |||
|
|
|||
| private def isDisabled(disabledComponents: Set[Class[_]])(componentDescriptor: spi.ComponentDescriptor): Boolean = { | |||
| val className = componentDescriptor.implementationName | |||
| if (disabledComponents.map(_.getName).contains(className)) { | |||
There was a problem hiding this comment.
move disabledComponents.map(_.getName) to the call site so that it's only done once, i.e.
def isDisabled(disabledComponents: Set[String]
| private def isDisabled(disabledComponents: Set[Class[_]])(componentDescriptor: spi.ComponentDescriptor): Boolean = { | ||
| val className = componentDescriptor.implementationName | ||
| if (disabledComponents.map(_.getName).contains(className)) { | ||
| logger.info("Ignoring component [{}] as it is disabled in the configuration", className) |
There was a problem hiding this comment.
Technically, this could be a Setup or Integration test configuration. Maybe I should log both options separately?
There was a problem hiding this comment.
probably not important to have that detail, might be enough with
"Ignoring component [{}] as it is disabled
Co-authored-by: Patrik Nordwall <[email protected]>
aludwiko
changed the title
| @@ -202,7 +203,7 @@ public static class Settings { | |||
| /** | |||
| * Default settings for testkit. | |||
| */ | |||
| public static Settings DEFAULT = new Settings("self", true, TEST_BROKER, MockedEventing.EMPTY, Optional.empty(), ConfigFactory.empty()); | |||
| public static Settings DEFAULT = new Settings("self", true, TEST_BROKER, MockedEventing.EMPTY, Optional.empty(), ConfigFactory.empty(), Set.of()); | |||
There was a problem hiding this comment.
Doesn't matter here, but otherwise I would guess that emptySet is a singleton instance and the other would create a new instance.
Leave it as is.
| @@ -23,6 +23,19 @@ It is important to remember that an Akka service consists of one to many distrib | |||
| individually and independently, for example during a rolling upgrade. Each such instance starting up will invoke | |||
| `onStartup` when starting up, even if other instances run it before. | |||
|
|
|||
| == Disabling components | |||
|
|
|||
| Users can use `ServiceSetup` to disable components by overriding `disabledComponents` and returning a set of component classes to disable. | |||
There was a problem hiding this comment.
"Users" is written from our (Akka's) perspective, but we should write from the reader's perspective. We are targeting developers so I think this would be better as "You can use"
| ---- | ||
| <1> Override `disabledComponents` | ||
| <2> Provide a set of component classes to disable | ||
|
|
There was a problem hiding this comment.
I think we should also mention that the method can use appConfig or environment variables to control which set of components that should be disabled.
There was a problem hiding this comment.
Good point, added a more sophisticated code sample, should be good enough.
No description provided.