zydronium/google-nomulus
1
0
Fork 0
mirror of https://github.com/google/nomulus.git synced 2025-05-16 09:27:16 +02:00
Code Issues Projects Releases Packages Wiki Activity

Change Router to do reflective setAccessible() calls itself

Browse source 
This change moves the reflective setAccessible() calls on the request component
methods (needed so that they can be invoked reflectively from RequestHandler)
to within Router itself, eliminating the need to manually call this from each
Servlet class and then pass in the resulting Method objects.  Instead, we just
pass in the request component class and let Router do the rest.

Old comments say that cross-package reflection is not allowed on AppEngine, but
while it's quite possible this was once the case, I can't reproduce that
limitation, and the documentation seems to contradict any such restriction:

"""
An application is allowed full, unrestricted, reflective access to its own
classes.  It can query any private members, call the method
java.lang.reflect.AccessibleObject.setAccessible(), and read/set private
members.
"""
https://cloud.google.com/appengine/docs/java/runtime#reflection

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=138693006
This commit is contained in:
nickfelt 2016-11-09 15:23:47 -08:00 • committed by Ben McIlwain
parent 59c213c66f
commit 9122372e38
7 changed files with 34 additions and 87 deletions
Download patch file Download diff file Expand all files Collapse all files

14
java/google/registry/module/backend/BackendServlet.java
View file

@ -14,16 +14,11 @@
package google.registry.module.backend;
import static java.util.Arrays.asList;
import com.google.common.base.Function;
import com.google.common.collect.FluentIterable;
import google.registry.monitoring.metrics.MetricReporter;
import google.registry.request.RequestHandler;
import google.registry.request.RequestModule;
import google.registry.util.FormattingLogger;
import java.io.IOException;
import java.lang.reflect.Method;
import java.security.Security;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
@ -40,14 +35,7 @@ public final class BackendServlet extends HttpServlet {
private static final FormattingLogger logger = FormattingLogger.getLoggerForCallerClass();
private static final RequestHandler<BackendRequestComponent> requestHandler =
RequestHandler.create(BackendRequestComponent.class, FluentIterable
.from(asList(BackendRequestComponent.class.getMethods()))
.transform(new Function<Method, Method>() {
@Override
public Method apply(Method method) {
method.setAccessible(true); // Make App Engine's security manager happy.
return method;
}}));
RequestHandler.create(BackendRequestComponent.class);
@Override
public void init() {

14
java/google/registry/module/frontend/FrontendServlet.java
View file

@ -14,16 +14,11 @@
package google.registry.module.frontend;
import static java.util.Arrays.asList;
import com.google.common.base.Function;
import com.google.common.collect.FluentIterable;
import google.registry.monitoring.metrics.MetricReporter;
import google.registry.request.RequestHandler;
import google.registry.request.RequestModule;
import google.registry.util.FormattingLogger;
import java.io.IOException;
import java.lang.reflect.Method;
import java.security.Security;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
@ -40,14 +35,7 @@ public final class FrontendServlet extends HttpServlet {
private static final FormattingLogger logger = FormattingLogger.getLoggerForCallerClass();
private static final RequestHandler<FrontendRequestComponent> requestHandler =
RequestHandler.create(FrontendRequestComponent.class, FluentIterable
.from(asList(FrontendRequestComponent.class.getMethods()))
.transform(new Function<Method, Method>() {
@Override
public Method apply(Method method) {
method.setAccessible(true); // Make App Engine's security manager happy.
return method;
}}));
RequestHandler.create(FrontendRequestComponent.class);
@Override
public void init() {

14
java/google/registry/module/tools/ToolsServlet.java
View file

@ -14,14 +14,9 @@
package google.registry.module.tools;
import static java.util.Arrays.asList;
import com.google.common.base.Function;
import com.google.common.collect.FluentIterable;
import google.registry.request.RequestHandler;
import google.registry.request.RequestModule;
import java.io.IOException;
import java.lang.reflect.Method;
import java.security.Security;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
@ -34,14 +29,7 @@ public final class ToolsServlet extends HttpServlet {
private static final ToolsComponent component = DaggerToolsComponent.create();
private static final RequestHandler<ToolsRequestComponent> requestHandler =
RequestHandler.create(ToolsRequestComponent.class, FluentIterable
.from(asList(ToolsRequestComponent.class.getMethods()))
.transform(new Function<Method, Method>() {
@Override
public Method apply(Method method) {
method.setAccessible(true); // Make App Engine's security manager happy.
return method;
}}));
RequestHandler.create(ToolsRequestComponent.class);
@Override
public void init() {

21
java/google/registry/request/RequestHandler.java
View file

@ -31,7 +31,6 @@ import com.google.common.base.Optional;
import google.registry.util.FormattingLogger;
import google.registry.util.NonFinalForTesting;
import java.io.IOException;
import java.lang.reflect.Method;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.joda.time.Duration;
@ -76,20 +75,9 @@ public final class RequestHandler<C> {
@NonFinalForTesting
private static UserService userService = UserServiceFactory.getUserService();
/**
* Creates a new request processor based off your component methods.
*
* <p><b>Warning:</b> When using the App Engine platform, you must call
* {@link Method#setAccessible(boolean) setAccessible(true)} on all your component {@link Method}
* instances, from within the same package as the component. This is due to cross-package
* reflection restrictions.
*
* @param methods is the result of calling {@link Class#getMethods()} on {@code component}, which
* are filtered to only include those with no arguments returning a {@link Runnable} with an
* {@link Action} annotation
*/
public static <C> RequestHandler<C> create(Class<C> component, Iterable<Method> methods) {
return new RequestHandler<>(component, Router.create(methods));
/** Creates a new request processor based off your component methods. */
public static <C> RequestHandler<C> create(Class<C> component) {
return new RequestHandler<>(component, Router.create(component));
}
private final Router router;
@ -102,8 +90,7 @@ public final class RequestHandler<C> {
/**
* Runs the appropriate action for a servlet request.
*
* @param component is an instance of the component type whose methods were passed to
* {@link #create(Class, Iterable)}
* @param component is an instance of the component type passed to {@link #create(Class)}
*/
public void handleRequest(HttpServletRequest req, HttpServletResponse rsp, C component)
throws IOException {

17
java/google/registry/request/Router.java
View file

@ -25,7 +25,7 @@ import java.util.Map;
import java.util.TreeMap;
/**
* Path prefix request router for Nomulus.
* Path prefix request router.
*
* <p>See the documentation of {@link RequestHandler} for more information.
*
@ -37,14 +37,15 @@ import java.util.TreeMap;
*/
final class Router {
static Router create(Iterable<Method> componentMethods) {
return new Router(extractRoutesFromComponent(componentMethods));
/** Create a new Router for the given component class. */
static Router create(Class<?> componentClass) {
return new Router(componentClass);
}
private final ImmutableSortedMap<String, Route> routes;
private Router(ImmutableSortedMap<String, Route> routes) {
this.routes = routes;
private Router(Class<?> componentClass) {
this.routes = extractRoutesFromComponent(componentClass);
}
/** Returns the appropriate action route for a request. */
@ -61,10 +62,12 @@ final class Router {
}
private static
ImmutableSortedMap<String, Route> extractRoutesFromComponent(Iterable<Method> methods) {
ImmutableSortedMap<String, Route> extractRoutesFromComponent(Class<?> componentClass) {
ImmutableSortedMap.Builder<String, Route> routes =
new ImmutableSortedMap.Builder<>(Ordering.natural());
for (Method method : methods) {
for (Method method : componentClass.getMethods()) {
// Make App Engine's security manager happy.
method.setAccessible(true);
if (!isDaggerInstantiatorOfType(Runnable.class, method)) {
continue;
}

4
javatests/google/registry/request/RequestHandlerTest.java
View file

@ -24,7 +24,6 @@ import static org.mockito.Mockito.verifyZeroInteractions;
import static org.mockito.Mockito.when;
import com.google.appengine.api.users.UserService;
import com.google.common.collect.ImmutableList;
import com.google.common.testing.NullPointerTester;
import google.registry.request.HttpException.ServiceUnavailableException;
import google.registry.testing.AppEngineRule;
@ -149,8 +148,7 @@ public final class RequestHandlerTest {
private final Component component = new Component();
private final StringWriter httpOutput = new StringWriter();
private final RequestHandler<Component> handler =
RequestHandler.create(Component.class, ImmutableList.copyOf(Component.class.getMethods()));
private final RequestHandler<Component> handler = RequestHandler.create(Component.class);
@Before
public void before() throws Exception {

37
javatests/google/registry/request/RouterTest.java
View file

@ -18,7 +18,6 @@ import static com.google.common.truth.Truth.assertThat;
import com.google.common.base.Function;
import com.google.common.base.Optional;
import com.google.common.collect.ImmutableList;
import google.registry.testing.ExceptionRule;
import java.util.concurrent.Callable;
import org.junit.Rule;
@ -33,18 +32,14 @@ public final class RouterTest {
@Rule
public final ExceptionRule thrown = new ExceptionRule();
private Router create(Class<?> clazz) {
return Router.create(ImmutableList.copyOf(clazz.getMethods()));
}
////////////////////////////////////////////////////////////////////////////////////////////////
public interface Empty {}
@Test
public void testRoute_noRoutes_returnsAbsent() throws Exception {
assertThat(create(Empty.class).route("")).isAbsent();
assertThat(create(Empty.class).route("/")).isAbsent();
assertThat(Router.create(Empty.class).route("")).isAbsent();
assertThat(Router.create(Empty.class).route("/")).isAbsent();
}
////////////////////////////////////////////////////////////////////////////////////////////////
@ -61,7 +56,7 @@ public final class RouterTest {
@Test
public void testRoute_pathMatch_returnsRoute() throws Exception {
Optional<Route> route = create(SlothComponent.class).route("/sloth");
Optional<Route> route = Router.create(SlothComponent.class).route("/sloth");
assertThat(route).isPresent();
assertThat(route.get().action().path()).isEqualTo("/sloth");
assertThat(route.get().instantiator()).isInstanceOf(Function.class);
@ -69,12 +64,12 @@ public final class RouterTest {
@Test
public void testRoute_pathMismatch_returnsAbsent() throws Exception {
assertThat(create(SlothComponent.class).route("/doge")).isAbsent();
assertThat(Router.create(SlothComponent.class).route("/doge")).isAbsent();
}
@Test
public void testRoute_pathIsAPrefix_notAllowedByDefault() throws Exception {
assertThat(create(SlothComponent.class).route("/sloth/extra")).isAbsent();
assertThat(Router.create(SlothComponent.class).route("/sloth/extra")).isAbsent();
}
////////////////////////////////////////////////////////////////////////////////////////////////
@ -91,16 +86,16 @@ public final class RouterTest {
@Test
public void testRoute_prefixMatches_returnsRoute() throws Exception {
assertThat(create(PrefixComponent.class).route("/prefix")).isPresent();
assertThat(create(PrefixComponent.class).route("/prefix/extra")).isPresent();
assertThat(Router.create(PrefixComponent.class).route("/prefix")).isPresent();
assertThat(Router.create(PrefixComponent.class).route("/prefix/extra")).isPresent();
}
@Test
public void testRoute_prefixDoesNotMatch_returnsAbsent() throws Exception {
assertThat(create(PrefixComponent.class).route("")).isAbsent();
assertThat(create(PrefixComponent.class).route("/")).isAbsent();
assertThat(create(PrefixComponent.class).route("/ulysses")).isAbsent();
assertThat(create(PrefixComponent.class).route("/man/of/sadness")).isAbsent();
assertThat(Router.create(PrefixComponent.class).route("")).isAbsent();
assertThat(Router.create(PrefixComponent.class).route("/")).isAbsent();
assertThat(Router.create(PrefixComponent.class).route("/ulysses")).isAbsent();
assertThat(Router.create(PrefixComponent.class).route("/man/of/sadness")).isAbsent();
}
////////////////////////////////////////////////////////////////////////////////////////////////
@ -118,21 +113,21 @@ public final class RouterTest {
@Test
public void testRoute_prefixAndLongPathMatch_returnsLongerPath() throws Exception {
Optional<Route> route = create(LongPathComponent.class).route("/prefix/long");
Optional<Route> route = Router.create(LongPathComponent.class).route("/prefix/long");
assertThat(route).isPresent();
assertThat(route.get().action().path()).isEqualTo("/prefix/long");
}
@Test
public void testRoute_prefixAndLongerPrefixMatch_returnsLongerPrefix() throws Exception {
Optional<Route> route = create(LongPathComponent.class).route("/prefix/longer");
Optional<Route> route = Router.create(LongPathComponent.class).route("/prefix/longer");
assertThat(route).isPresent();
assertThat(route.get().action().path()).isEqualTo("/prefix/long");
}
@Test
public void testRoute_onlyShortPrefixMatches_returnsShortPrefix() throws Exception {
Optional<Route> route = create(LongPathComponent.class).route("/prefix/cat");
Optional<Route> route = Router.create(LongPathComponent.class).route("/prefix/cat");
assertThat(route).isPresent();
assertThat(route.get().action().path()).isEqualTo("/prefix");
}
@ -146,7 +141,7 @@ public final class RouterTest {
@Test
public void testRoute_methodsInComponentAreIgnored_noRoutes() throws Exception {
assertThat(create(WeirdMethodsComponent.class).route("/sloth")).isAbsent();
assertThat(Router.create(WeirdMethodsComponent.class).route("/sloth")).isAbsent();
}
////////////////////////////////////////////////////////////////////////////////////////////////
@ -171,6 +166,6 @@ public final class RouterTest {
@Test
public void testCreate_twoTasksWithSameMethodAndPath_resultsInError() throws Exception {
thrown.expect(IllegalArgumentException.class, "Multiple entries with same key");
create(DuplicateComponent.class);
Router.create(DuplicateComponent.class);
}
}