Skip to content

Add validation to the usage service #54617

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 2, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ public AutoIdHandler(ClusterService clusterService) {

@Override
public String getName() {
return "document_create_action";
return "document_create_action_auto_id";
}

@Override
Expand Down
31 changes: 25 additions & 6 deletions server/src/main/java/org/elasticsearch/usage/UsageService.java
Original file line number Diff line number Diff line change
Expand Up @@ -42,21 +42,21 @@
import org.elasticsearch.cluster.node.DiscoveryNode;
import org.elasticsearch.rest.BaseRestHandler;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Objects;

/**
* A service to monitor usage of Elasticsearch features.
*/
public class UsageService {

private final List<BaseRestHandler> handlers;
private final Map<String, BaseRestHandler> handlers;
private final long sinceTime;

public UsageService() {
this.handlers = new ArrayList<>();
this.handlers = new HashMap<>();
this.sinceTime = System.currentTimeMillis();
}

Expand All @@ -67,7 +67,26 @@ public UsageService() {
* the {@link BaseRestHandler} to add to the usage service.
*/
public void addRestHandler(BaseRestHandler handler) {
handlers.add(handler);
Objects.requireNonNull(handler);
if (handler.getName() == null) {
throw new IllegalArgumentException("handler of type [" + handler.getClass().getName() + "] does not have a name");
}
final BaseRestHandler maybeHandler = handlers.put(handler.getName(), handler);
/*
* Handlers will be registered multiple times, once for each route that the handler handles. This means that we will see handlers
* multiple times, so we do not have a conflict if we are seeing the same instance multiple times. So, we only reject if a handler
* with the same name was registered before, and it is not the same instance as before.
*/
if (maybeHandler != null && maybeHandler != handler) {
final String message = String.format(
Locale.ROOT,
"handler of type [%s] conflicts with handler of type [%s] as they both have the same name [%s]",
handler.getClass().getName(),
maybeHandler.getClass().getName(),
handler.getName()
);
throw new IllegalArgumentException(message);
}
}

/**
Expand All @@ -85,7 +104,7 @@ public NodeUsage getUsageStats(DiscoveryNode localNode, boolean restActions) {
Map<String, Long> restUsageMap;
if (restActions) {
restUsageMap = new HashMap<>();
handlers.forEach(handler -> {
handlers.values().forEach(handler -> {
long usageCount = handler.getUsageCount();
if (usageCount > 0) {
restUsageMap.put(handler.getName(), usageCount);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,14 @@ public void testPluginCantOverwriteBuiltinRestHandler() throws IOException {
public List<RestHandler> getRestHandlers(Settings settings, RestController restController, ClusterSettings clusterSettings,
IndexScopedSettings indexScopedSettings, SettingsFilter settingsFilter,
IndexNameExpressionResolver indexNameExpressionResolver, Supplier<DiscoveryNodes> nodesInCluster) {
return singletonList(new RestMainAction());
return singletonList(new RestMainAction() {

@Override
public String getName() {
return "duplicated_" + super.getName();
}

});
}
};
SettingsModule settings = new SettingsModule(Settings.EMPTY);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
import java.net.InetAddress;
import java.util.Collections;
import java.util.List;
import java.util.Locale;
import java.util.Map;

import static org.hamcrest.Matchers.equalTo;
Expand All @@ -41,6 +42,58 @@

public class UsageServiceTests extends ESTestCase {

/**
* Test that we can not add a null reference to a {@link org.elasticsearch.rest.RestHandler} to the {@link UsageService}.
*/
public void testHandlerCanNotBeNull() {
final UsageService service = new UsageService();
expectThrows(NullPointerException.class, () -> service.addRestHandler(null));
}

/**
* Test that we can not add an instance of a {@link org.elasticsearch.rest.RestHandler} with no name to the {@link UsageService}.
*/
public void testAHandlerWithNoName() {
final UsageService service = new UsageService();
final BaseRestHandler horse = new MockRestHandler(null);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Quality variable name! 👍🐴

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Little slice of American pie right there. 😉

final IllegalArgumentException e = expectThrows(IllegalArgumentException.class, () -> service.addRestHandler(horse));
assertThat(
e.getMessage(),
equalTo("handler of type [org.elasticsearch.usage.UsageServiceTests$MockRestHandler] does not have a name"));
}

/**
* Test that we can add the same instance of a {@link org.elasticsearch.rest.RestHandler} to the {@link UsageService} multiple times.
*/
public void testHandlerWithConflictingNamesButSameInstance() {
final UsageService service = new UsageService();
final String name = randomAlphaOfLength(8);
final BaseRestHandler first = new MockRestHandler(name);
service.addRestHandler(first);
// nothing bad ever happens to me
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤣

service.addRestHandler(first);
}

/**
* Test that we can not add different instances of {@link org.elasticsearch.rest.RestHandler} with the same name to the
* {@link UsageService}.
*/
public void testHandlersWithConflictingNamesButDifferentInstances() {
final UsageService service = new UsageService();
final String name = randomAlphaOfLength(8);
final BaseRestHandler first = new MockRestHandler(name);
final BaseRestHandler second = new MockRestHandler(name);
service.addRestHandler(first);
final IllegalArgumentException e = expectThrows(IllegalArgumentException.class, () -> service.addRestHandler(second));
final String expected = String.format(
Locale.ROOT,
"handler of type [%s] conflicts with handler of type [%1$s] as they both have the same name [%s]",
"org.elasticsearch.usage.UsageServiceTests$MockRestHandler",
name
);
assertThat(e.getMessage(), equalTo(expected));
}

public void testRestUsage() throws Exception {
DiscoveryNode discoveryNode = new DiscoveryNode("foo", new TransportAddress(InetAddress.getByName("localhost"), 12345),
Version.CURRENT);
Expand Down