Let's say that you have to write an API service. The service handles different types of API calls - calls coming from third parties, your company's apps, and your company's internal servers.
There will inevitably be call sites that behave differently for different services. Imagine some examples: third-party services use a different authorization method, internal-only responses get debugging headers, error payloads are formatted differently for apps. They all use different loggers. The list goes on.
By the end of implementation, many call sites will have logic that is conditional on the service type.
// This method has two different call sites that depend on the service:
// logging and the authorization handler.
public function handleAuthorization(Service $service, Request $request) {
$auth = ($service->type === Service::TYPE_THIRD_PARTY)
? new Service\Auth\ThirdParty()
: new Service\Auth\SomethingElse();
$logger = null;
switch($service->type) {
case Service::TYPE_THIRD_PARTY:
$logger = Service\Logger\ThirdParty();
break;
case Service::TYPE_APP:
$logger = Service\Logger\App();
break;
case Service::INTERNAL:
$logger = Service\Logger\Debug();
break;
default:
throw new Exception('Unrecognized logger');
}
try {
$auth->check($request);
} catch (Exception $e) {
$logger->logError($e, [/* some data */]);
throw $e;
}
$logger->logInfo('successful authorization', [/* some data */]);
}
When many call sites behave differently based on the same set of conditions, this can be considered a "two dimensional problem." I don't think there's an official definition to this. I just like to think about it this way. One dimension comprises each of the different conditions. The other dimension comprises all of the call sites depending on the service type. In the API service example, the service dimension has…
[third-party API calls, calls from company apps, calls from internal servers]
and the call site dimension has...
[Handling authorization, header response selection, response formatting, logging]
In this example, there are 12 combinations to be considered (three origins * four call sites). If a new call site is added, there are 15 total considerations. If a new origin is added after that, there are 20 considerations. This will likely grow geometrically over time.
It's tempting to say, "This example should be dependency-injected anyways." But this is just a demo of the problem. Dependency injection doesn't solve the real problem, which is that the service definitions have no cohesion. The service is a first-class concept within the API. But the definition of each service is scattered throughout the codebase, which leads to some problems.
Switching on types is error-prone across several usages.
Writing cases manually is error-prone. When adding a new type, the author must vet every call site that handles types. The new type might need to be specially handled in one of them. These call sites can be hard to enumerate: it could include all locations where any of the types are checked. Even worse, the list can include sites where the logic works because of secondary effects. For instance, "if this logger type also implements this other interface, do this other logic" might be attempting to define logic for the single service that provides that interface type.
Let's say that the whole API team gets hit by a bus. It's sad, but we must increase shareholder value nonetheless. The old team began a new project: adding an API service handling our new web app! So the replacement team defines authorization and response logging and launches the service into production. But they missed a few cases. A few weeks after launch, the new web service is down for two hours and no pages were fired. After some investigation, it turns out that the wrong logger was used and the monitoring service ignored errors from unrecognized services. Later, the company pays out a security bounty because internal-only debug headers were leaked. These are plausible outcomes of dealing with a low-cohesion definition - because the entire definition can't be considered at once, it's easy to overlook things that cause silent failures.
Switching on types has low cohesion.
When logic depends on the same conditions throughout the codebase, the cohesion of that particular concept is low or nonexistent. This makes sense: the service's definition is scattered throughout the codebase. It would be better if all of these definitions were grouped behind the same interface. This makes it easy to describe a service: a service is the collection of definitions inside an implementation of the interface.
Prefer plugin architectures
Marveling at the Painted Ladies on a recent trip to San Francisco. An obvious example of plugin architecture if I've ever seen one.
What does the code example look like within a plugin architecture?
// Provides a cohesive service definition.
interface ApiServicePlugin {
public function getType(): int;
public function getAuthService(): Service\Auth;
public function getLogger(): Service\Logger;
public function getResponseBuilder(): Api\ResponseBuilder;
}
// Allows per-service objects or functions to be retrieved.
class ApiServiceRegistry {
public function registerPlugin(ApiServicePlugin $plugin): void;
public function getAuthService(int $service_type): Service\Auth;
// Not shown: other getters
}
public function handleAuthorization(Service $service, Request $request) {
// Note: These would likely be dependency-injected.
$auth = $this->registry->getAuth($service->type);
$logger = $this->registry->getLogger($service->type);
try {
$auth->validate($request);
} catch (Exception $e) {
logger->logError($e, [/* some data */]);
throw $e;
}
$logger->logInfo('success', [/* some data */]);
}
The plugin interface improves cohesion.
The plugin provides a solid definition of an API service. It's the combination of authorization, logging, and the response builder. Every implementation will correspond to a service, and every service will have an implementation.
Plugins enforce that all cases are handled for each new service.
It's impossible to add a service without implementing the full plugin definition. Therefore, every single call site will be handled when a new service is added.
Adding a new call site means that every service will be considered.
When adding a new call site for the service, there are two options. Either it will use an existing method on the plugin interface, and all existing services will work. If a new concept needs to be added to the plugins, then every plugin will need to be considered.
Plugin registries make testing much easier.
Plugin registries provide an easy dependency injection method. If a plugin is not under test, simply register a "no-op" version of the plugin that does nothing or provides objects that do nothing. If something shouldn't be called, simply provide objects that throw exceptions when they are called. Because each of the call sites are no longer responsible for managing a fraction of the service, the tests can now focus on testing the logic around the call sites, instead of partially testing whether the correct service was used.
Avoid plugin registries when one of the dimensions is size one
Registry configs are great for reducing dimensionality. But what if there is either just a single service, or just a single call site? Then it would be overkill to make the full class and interface hierarchy. If there is just one call site, then write the basic switch statement or if/else chain. If there is only one mapping type that is being shared across a few call sites, then refactor it into a map or a helper function. The full plugin architecture is only useful when managing the complexity of many services used at many call sites.
