Open a RESTful API for Styx Object Store #406

mikkokar · 2019-05-02T14:15:53Z

I'm adding a new UrlPatternRouter. To configure this router, you specify a regular expression pattern for each endpoint per HTTP verb. It also captures patterns from URL and exposes them as values in HTTP context. See the unit tests as an example.

I have also added a new RoutingObjectHandler that builds on UrlPatternRouter. It allows Styx Routing Object Store to be modified via RESTful API. It supports, addition, removal, and replacement of routing objects.

The ObjectStore is updated accordingly, to support these features. Notice that ObjectStore concurrency model is improved. Object store modifications (insert/remove) now take place, always, in the calling thread. The executor simply delivers the watch notifications.

…cations.

- RoutingObjectHandler - UrlPatternRouter - Wired up into admin server

components/proxy/src/main/java/com/hotels/styx/admin/AdminServerBuilder.java

kvosper · 2019-05-02T15:49:32Z

components/proxy/src/main/java/com/hotels/styx/admin/AdminServerBuilder.java

@@ -122,6 +131,11 @@ private StandardHttpRouter adminEndpoints(StyxConfig styxConfig) {
        httpRouter.add("/admin/configuration/logging", new LoggingConfigurationHandler(styxConfig.startupConfig().logConfigLocation()));
        httpRouter.add("/admin/configuration/startup", new StartupConfigHandler(styxConfig.startupConfig()));

+        RoutingObjectHandler routingObjectHandler = new RoutingObjectHandler(routeDatabase, routingObjectFactory);
+        httpRouter.add("/admin/routing", routingObjectHandler);


If /admin/routing and /admin/routing/ are not considered equivalent, we should make a change to the httpRouter instead of duplicating code.

I think this is necessary because StandardHttpRouter treats the two endpoints differently. But I'll have another look.

I see we have this also for the metrics handler, but not for any others (
httpRouter.add("/admin/metrics", metricsHandler);
httpRouter.add("/admin/metrics/", metricsHandler);
)
I think this needs reviewing to identify any fixes we might need. I would say fixes can go in another PR.

components/proxy/src/main/java/com/hotels/styx/admin/handlers/RoutingObjectHandler.java

kvosper · 2019-05-02T16:30:58Z

components/proxy/src/test/kotlin/com/hotels/styx/admin/handlers/RoutingObjectHandlerTest.kt

+            val handler = RoutingObjectHandler(routeDatabase, objectFactory)
+
+            handler.handle(
+                    HttpRequest.put("/admin/routing/objects/staticResponse")


There are lots of tests that are set up this way. There should be some kind of shared setUp method for them (not for the test name Injecting new objects though, since the put is the thing being tested there).

components/proxy/src/test/kotlin/com/hotels/styx/admin/handlers/RoutingObjectHandlerTest.kt

components/proxy/src/test/kotlin/com/hotels/styx/admin/handlers/UrlPatternRouterTest.kt

components/proxy/src/test/kotlin/com/hotels/styx/routing/db/StyxObjectStoreTest.kt

Add functional tests for routing object REST API.

mikkokar · 2019-05-13T15:14:40Z

Added functional tests.

dvlato · 2019-05-14T10:34:34Z

components/proxy/src/main/java/com/hotels/styx/admin/AdminServerBuilder.java

@@ -122,6 +131,11 @@ private StandardHttpRouter adminEndpoints(StyxConfig styxConfig) {
        httpRouter.add("/admin/configuration/logging", new LoggingConfigurationHandler(styxConfig.startupConfig().logConfigLocation()));
        httpRouter.add("/admin/configuration/startup", new StartupConfigHandler(styxConfig.startupConfig()));

+        RoutingObjectHandler routingObjectHandler = new RoutingObjectHandler(routeDatabase, routingObjectFactory);
+        httpRouter.add("/admin/routing", routingObjectHandler);


I see we have this also for the metrics handler, but not for any others (
httpRouter.add("/admin/metrics", metricsHandler);
httpRouter.add("/admin/metrics/", metricsHandler);
)
I think this needs reviewing to identify any fixes we might need. I would say fixes can go in another PR.

dvlato · 2019-05-14T10:36:41Z

components/proxy/src/main/java/com/hotels/styx/admin/handlers/RoutingObjectHandler.java

@@ -81,7 +81,7 @@ public RoutingObjectHandler(StyxObjectStore<RoutingObjectRecord> routeDatabase,

                    try {
                        String object = routeDatabase.get(name)
-                                .map(record-> serialise(name, record))
+                                .map(record -> serialise(name, record))
                                .orElseThrow(ResourceNotFoundException::new);


Are we logging the name of the resource that couldn't be found anywhere?

dvlato · 2019-05-14T10:42:34Z

components/proxy/src/main/java/com/hotels/styx/admin/handlers/UrlPatternRouter.java

    private static final String PLACEHOLDERS_KEY = "UrlRouter.placeholders";
    private final List<RouteDescriptor> alternatives;

    private UrlPatternRouter(List<RouteDescriptor> alternatives) {
-        this.alternatives = alternatives;
+        this.alternatives = ImmutableList.copyOf(alternatives);


static import?

Normally ImmutableList.copyOf has been exempt from static imports.

To clarify, we try to use static imports when the key information is in the method name, which makes the class name just clutter. In this case, the method name alone is insufficient to demonstrate that we are instantiating an immutable list.

components/proxy/src/main/java/com/hotels/styx/admin/handlers/UrlPatternRouter.java

components/proxy/src/main/kotlin/com/hotels/styx/routing/db/StyxObjectStore.kt

* Add UrlPatternRouter class. * StyxObjectStore: Synchronous Insert/Remove, asynchronous watch notifications. * HttpInterceptorPipeline "handler" to support named object references.

mikkokar added 3 commits May 1, 2019 15:07

Add UrlPatternRouter class.

2fcc216

StyxObjectStore: Synchronous Insert/Remove, asynchronous watch notifi…

74b8d1c

…cations.

First cut: tests pass.

4cceb8e

- RoutingObjectHandler - UrlPatternRouter - Wired up into admin server

mikkokar requested review from kvosper and dvlato May 2, 2019 14:15

kvosper suggested changes May 2, 2019

View reviewed changes

mikkokar added 3 commits May 13, 2019 12:37

Address code review comments.

2f47b1e

HttpInterceptorPipeline "handler" to support named object references.

95b86ad

Add functional tests for routing object REST API.

Tidy up.

08b00e2

dvlato reviewed May 14, 2019

View reviewed changes

dvlato approved these changes May 14, 2019

View reviewed changes

mikkokar added 2 commits May 14, 2019 14:15

Address code review comments.

e709d5f

Tidy up.

ab7c34f

kvosper approved these changes May 15, 2019

View reviewed changes

mikkokar merged commit 385648f into ExpediaGroup:master May 16, 2019

mikkokar deleted the object-store-restful-api branch May 16, 2019 05:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Open a RESTful API for Styx Object Store #406

Open a RESTful API for Styx Object Store #406

mikkokar commented May 2, 2019 •

edited

Loading

kvosper May 2, 2019

mikkokar May 13, 2019

dvlato May 14, 2019

kvosper May 2, 2019

mikkokar commented May 13, 2019

dvlato May 14, 2019

dvlato May 14, 2019 •

edited

Loading

mikkokar May 14, 2019

dvlato May 14, 2019

mikkokar May 14, 2019

kvosper May 15, 2019

Open a RESTful API for Styx Object Store #406

Open a RESTful API for Styx Object Store #406

Conversation

mikkokar commented May 2, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mikkokar commented May 13, 2019

Choose a reason for hiding this comment

dvlato May 14, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mikkokar commented May 2, 2019 •

edited

Loading

dvlato May 14, 2019 •

edited

Loading