Made ApplicationPipeline a request handler, removed its initialHandler function as handleRequest is better anyhow

Author: stablekernel-admin

lib/application.dart

@@ -51,33 +51,27 @@ class ApplicationInstanceConfiguration {
   /// A copy constructor
   ApplicationInstanceConfiguration.fromConfiguration(
       ApplicationInstanceConfiguration config)
-      : this.address = config.address,
-        this.port = config.port,
-        this.isIpv6Only = config.isIpv6Only,
-        this.isUsingClientCertificate = config.isUsingClientCertificate,
-        this.serverCertificateName = config.serverCertificateName,
-        this.shared = config.shared;
+  : this.address = config.address,
+  this.port = config.port,
+  this.isIpv6Only = config.isIpv6Only,
+  this.isUsingClientCertificate = config.isUsingClientCertificate,
+  this.serverCertificateName = config.serverCertificateName,
+  this.shared = config.shared;
 }
 
 /// A abstract class that concrete subclasses will implement to provide request handling behavior.
 ///
 /// [Application]s set up HTTP(s) listeners, but do not do anything with them. The behavior of how an application
-/// responds to requests is defined by its [ApplicationPipeline].
-abstract class ApplicationPipeline {
+/// responds to requests is defined by its [ApplicationPipeline]. Instances of this class must implement the
+/// [handleRequest] method from [RequestHandler] - this is the entry point of all requests into this pipeline.
+abstract class ApplicationPipeline implements RequestHandler {
 
   /// Passed in options for this pipeline from its owning [Application].
   ///
   /// These values give an opportunity for a pipeline to have a customization point within attachTo., like running
   /// the owning [Application] in 'Development' or 'Production' mode. This property will always be set prior to invoking attachTo, but may be null
   /// if the user did not set any configuration values.
   Map<String, dynamic> options;
-
-  /// Allows an [ApplicationPipeline] to handle HTTP(s) requests from its [Application].
-  ///
-  /// Implementors of [ApplicationPipeline] must override this method to respond to an [Application]'s requests.
-  /// The return value is the first [RequestHandler] that will be the initial [ResourceRequest] handler.
-  /// The [initialHandler] will likely have handlers attached to it.
-  RequestHandler initialHandler();
 }
 
 /// A container for web server applications.
@@ -94,7 +88,7 @@ class Application {
   ///
   /// This must be configured prior to [start]ing the [Application].
   ApplicationInstanceConfiguration configuration =
-      new ApplicationInstanceConfiguration();
+  new ApplicationInstanceConfiguration();
 
   /// The type of [ApplicationPipeline] that configures how requests are handled.
   ///
@@ -119,7 +113,7 @@ class Application {
 
     for (int i = 0; i < numberOfInstances; i++) {
       var config =
-          new ApplicationInstanceConfiguration.fromConfiguration(configuration);
+      new ApplicationInstanceConfiguration.fromConfiguration(configuration);
 
       var serverRecord = await _spawn(config, i + 1);
       servers.add(serverRecord);
@@ -140,7 +134,7 @@ class Application {
     var initialMessage = new _InitialServerMessage(
         pipelineTypeName, pipelineLibraryURI, config, identifier, receivePort.sendPort);
     var isolate =
-        await Isolate.spawn(_Server.entry, initialMessage, paused: true);
+    await Isolate.spawn(_Server.entry, initialMessage, paused: true);
     isolate.addErrorListener(receivePort.sendPort);
 
     return new _ServerRecord(isolate, receivePort, identifier);
@@ -153,7 +147,6 @@ class _Server {
   HttpServer server;
   ApplicationPipeline pipeline;
   int identifier;
-  RequestHandler initialHandler;
 
   _Server(this.pipeline, this.configuration, this.identifier, this.parentMessagePort);
 
@@ -164,42 +157,41 @@ class _Server {
       server.serverHeader = "monadart/${this.identifier}";
 
       pipeline.options = configuration.pipelineOptions;
-      initialHandler = pipeline.initialHandler();
       server.map((httpReq) => new ResourceRequest(httpReq))
-        .listen(initialHandler.handleRequest);
+      .listen(pipeline.handleRequest);
     };
 
     if (configuration.serverCertificateName != null) {
       HttpServer
-          .bindSecure(configuration.address, configuration.port,
-              certificateName: configuration.serverCertificateName,
-              v6Only: configuration.isIpv6Only,
-              shared: configuration.shared)
-          .then(onBind);
+      .bindSecure(configuration.address, configuration.port,
+      certificateName: configuration.serverCertificateName,
+      v6Only: configuration.isIpv6Only,
+      shared: configuration.shared)
+      .then(onBind);
     } else if (configuration.isUsingClientCertificate) {
       HttpServer
-          .bindSecure(configuration.address, configuration.port,
-              requestClientCertificate: true,
-              v6Only: configuration.isIpv6Only,
-              shared: configuration.shared)
-          .then(onBind);
+      .bindSecure(configuration.address, configuration.port,
+      requestClientCertificate: true,
+      v6Only: configuration.isIpv6Only,
+      shared: configuration.shared)
+      .then(onBind);
     } else {
       HttpServer
-          .bind(configuration.address, configuration.port,
-              v6Only: configuration.isIpv6Only, shared: configuration.shared)
-          .then(onBind);
+      .bind(configuration.address, configuration.port,
+      v6Only: configuration.isIpv6Only, shared: configuration.shared)
+      .then(onBind);
     }
   }
 
   static void entry(_InitialServerMessage params) {
     var pipelineSourceLibraryMirror =
-        currentMirrorSystem().libraries[params.pipelineLibraryURI];
+    currentMirrorSystem().libraries[params.pipelineLibraryURI];
     var pipelineTypeMirror = pipelineSourceLibraryMirror.declarations[
-        new Symbol(params.pipelineTypeName)] as ClassMirror;
+    new Symbol(params.pipelineTypeName)] as ClassMirror;
 
     var app = pipelineTypeMirror.newInstance(new Symbol(""), []).reflectee;
     var server =
-        new _Server(app, params.configuration, params.identifier, params.parentMessagePort);
+    new _Server(app, params.configuration, params.identifier, params.parentMessagePort);
 
     server.start();
   }
@@ -225,5 +217,5 @@ class _InitialServerMessage {
   int identifier;
 
   _InitialServerMessage(this.pipelineTypeName, this.pipelineLibraryURI,
-      this.configuration, this.identifier, this.parentMessagePort);
-}
+                        this.configuration, this.identifier, this.parentMessagePort);
+}

lib/http_controller.dart

@@ -41,7 +41,7 @@ class HttpMethod {
 
   HttpMethod._fromMethod(HttpMethod m, List<String> parameters)
   : this.method = m.method,
-    this._parameters = parameters;
+  this._parameters = parameters;
 
   /// Returns whether or not this [HttpMethod] matches a [ResourceRequest].
   bool matchesRequest(ResourceRequest req) {
@@ -82,9 +82,11 @@ abstract class HttpController implements RequestHandler {
   /// but once execution enters a handler method (one decorated with [HttpMethod]), this exception handler
   /// is in place.
   Function get exceptionHandler => _exceptionHandler;
+
   void set exceptionHandler(Response handler(ResourceRequest resourceRequest, dynamic exceptionOrError, StackTrace stacktrace)) {
     _exceptionHandler = handler;
   }
+
   Function _exceptionHandler = _defaultExceptionHandler;
 
   /// The request being processed by this [HttpController].
@@ -177,29 +179,29 @@ abstract class HttpController implements RequestHandler {
 
   dynamic _convertParameterWithMirror(String parameterValue, ParameterMirror parameterMirror) {
     var typeMirror = parameterMirror.type;
-    if(typeMirror.isSubtypeOf(reflectType(String))) {
+    if (typeMirror.isSubtypeOf(reflectType(String))) {
       return parameterValue;
     }
 
-    if(typeMirror is ClassMirror) {
+    if (typeMirror is ClassMirror) {
       var cm = (typeMirror as ClassMirror);
       var parseDecl = cm.declarations[new Symbol("parse")];
-      if(parseDecl != null) {
+      if (parseDecl != null) {
         try {
           var reflValue = cm.invoke(parseDecl.simpleName, [parameterValue]);
           return reflValue.reflectee;
         } catch (e) {
           throw new _InternalControllerException("Invalid value for parameter type",
-            HttpStatus.BAD_REQUEST,
-            responseMessage: "URI parameter is wrong type");
+          HttpStatus.BAD_REQUEST,
+          responseMessage: "URI parameter is wrong type");
         }
       }
     }
 
     // If we get here, then it wasn't a string and couldn't be parsed, and we should throw?
     throw new _InternalControllerException("Invalid path parameter type, types must be String or implement parse",
-      HttpStatus.INTERNAL_SERVER_ERROR,
-      responseMessage: "URI parameter is wrong type");
+    HttpStatus.INTERNAL_SERVER_ERROR,
+    responseMessage: "URI parameter is wrong type");
     return null;
   }
 
@@ -218,18 +220,18 @@ abstract class HttpController implements RequestHandler {
 
   Map<Symbol, dynamic> _queryParametersForRequest(ResourceRequest req, Symbol handlerMethodSymbol) {
     var queryParams = req.request.uri.queryParameters;
-    if(queryParams.length == 0) {
+    if (queryParams.length == 0) {
       return null;
     }
 
     var optionalParams = (reflect(this).type.declarations[handlerMethodSymbol] as MethodMirror)
-      .parameters.where((methodParameter) => methodParameter.isOptional).toList();
+    .parameters.where((methodParameter) => methodParameter.isOptional).toList();
 
     var retMap = {};
     queryParams.forEach((k, v) {
       var keySymbol = new Symbol(k);
       var matchingParameter = optionalParams.firstWhere((p) => p.simpleName == keySymbol, orElse: () => null);
-      if(matchingParameter != null) {
+      if (matchingParameter != null) {
         retMap[keySymbol] = _convertParameterWithMirror(v, matchingParameter);
       }
     });

test/application_tests.dart

@@ -30,14 +30,17 @@ main() {
 }
 
 class TPipeline extends ApplicationPipeline {
+  Router router;
 
-  RequestHandler initialHandler() {
-    var router = new Router();
+  TPipeline() {
+    router = new Router();
 
     router.addRouteHandler("/t", new RequestHandlerGenerator<TController>());
     router.addRouteHandler("/r", new RequestHandlerGenerator<RController>());
+  }
 
-    return router;
+  void handleRequest(ResourceRequest req) {
+    router.handleRequest(req);
   }
 }
 

test/controller_tests.dart

@@ -231,6 +231,7 @@ class IntController extends HttpController {
   Future<Response> getOne(int id) async {
     return new Response.ok("${id * 2}");
   }
+
   @httpGet
   Future<Response> getAll({int opt: null}) async {
     return new Response.ok("${opt}");
@@ -242,6 +243,7 @@ class DateTimeController extends HttpController {
   Future<Response> getOne(DateTime time) async {
     return new Response.ok("${time.add(new Duration(seconds: 5))}");
   }
+
   @httpGet
   Future<Response> getAll({DateTime opt: null}) async {
     return new Response.ok("${opt}");

test/isolate_application_tests.dart

@@ -52,15 +52,19 @@ main() {
 
   });
 }
+
 class TPipeline extends ApplicationPipeline {
+  Router router;
 
-  RequestHandler initialHandler() {
-    var router = new Router();
+  TPipeline() {
+    router = new Router();
 
     router.addRouteHandler("/t", new RequestHandlerGenerator<TController>());
     router.addRouteHandler("/r", new RequestHandlerGenerator<RController>());
+  }
 
-    return router;
+  void handleRequest(ResourceRequest req) {
+    router.handleRequest(req);
   }
 }
 

test/pattern_tests.dart

@@ -1,5 +1,4 @@
 @TestOn("vm")
-
 import "package:test/test.dart";
 import "dart:core";
 import '../lib/monadart.dart';