feat: allow overriding std/native HTTP servers

Resolves: #320

Author: kitsonk

README.md

@@ -513,11 +513,32 @@ need to start your server with the `--unstable` flag. For example:
 > deno run --allow-net --unstable server.ts
 ```
 
-Currently there are two features that are not yet supported with the native
-server, those are:
+The only feature known to be a limitation on the native HTTP server is the
+ability to upgrade a connection to a web-socket.
 
-- Server Sent Events
-- Upgrading a request to a WebSocket
+#### Overriding the HTTP server
+
+If you wish to not utilise the default behavior of detecting the capability, you
+can force the server during application creation. For example to force the
+`std/http` server, you would do the following:
+
+```ts
+import { Application, HttpServerStd } from "https://deno.land/x/oak/mod.ts";
+
+const app = new Application({
+  serverConstructor: HttpServerStd,
+});
+```
+
+Of if you wanted to force the native:
+
+```ts
+import { Application, HttpServerNative } from "https://deno.land/x/oak/mod.ts";
+
+const app = new Application({
+  serverConstructor: HttpServerNative,
+});
+```
 
 ### Just handling requests
 

application.ts

@@ -108,9 +108,10 @@ export interface ApplicationOptions<S> {
   proxy?: boolean;
 
   /** A server constructor to use instead of the default server for receiving
-   * requests.
-   *
-   * _This is not generally used, except for mocking and testing._
+   * requests.  When the native HTTP server is detected in the environment, then
+   * the native server will be used, otherwise the `std/http` server will be
+   * used.  Passing either `HTTPServerStd` or `HTTPServerNative` will override
+   * this behavior.
    */
   serverConstructor?: ServerConstructor<ServerRequest | NativeRequest>;
 

application_test.ts

@@ -12,7 +12,9 @@ import {
 } from "./application.ts";
 import { Context } from "./context.ts";
 import { Status } from "./deps.ts";
-import { NativeRequest } from "./http_server_native.ts";
+import { HttpServerNative } from "./http_server_native.ts";
+import type { NativeRequest } from "./http_server_native.ts";
+import { HttpServerStd } from "./http_server_std.ts";
 import type { ServerRequest, ServerResponse } from "./http_server_std.ts";
 import { httpErrors } from "./httpError.ts";
 import { Data, KeyStack } from "./keyStack.ts";
@@ -635,3 +637,21 @@ test({
     }
   },
 });
+
+test({
+  name: "new Application() - HttpServerStd",
+  fn() {
+    new Application({
+      serverConstructor: HttpServerStd,
+    });
+  },
+});
+
+test({
+  name: "new Application() - HttpServerNative",
+  fn() {
+    new Application({
+      serverConstructor: HttpServerNative,
+    });
+  },
+});

mod.ts

@@ -27,6 +27,9 @@ export * as helpers from "./helpers.ts";
 export { Cookies } from "./cookies.ts";
 export type { CookiesGetOptions, CookiesSetDeleteOptions } from "./cookies.ts";
 export * as etag from "./etag.ts";
+export { HttpServerNative } from "./http_server_native.ts";
+export type { NativeRequest } from "./http_server_native.ts";
+export { HttpServerStd } from "./http_server_std.ts";
 export type { ServerRequest, ServerResponse } from "./http_server_std.ts";
 export { HttpError, httpErrors, isHttpError } from "./httpError.ts";
 export { compose as composeMiddleware } from "./middleware.ts";
@@ -58,7 +61,12 @@ export type {
   ServerSentEventInit,
   ServerSentEventTarget,
 } from "./server_sent_event.ts";
-export type { ErrorStatus, HTTPMethods, RedirectStatus } from "./types.d.ts";
+export type {
+  ErrorStatus,
+  HTTPMethods,
+  RedirectStatus,
+  ServerConstructor,
+} from "./types.d.ts";
 export { isErrorStatus, isRedirectStatus } from "./util.ts";
 
 // Re-exported from `net`

mod_test.ts

@@ -18,6 +18,8 @@ test({
     assertEquals(Object.keys(mod.helpers).length, 1);
     assertEquals(typeof mod.HttpError, "function");
     assertEquals(typeof mod.httpErrors, "object");
+    assertEquals(typeof mod.HttpServerNative, "function");
+    assertEquals(typeof mod.HttpServerStd, "function");
     assertEquals(typeof mod.isErrorStatus, "function");
     assertEquals(typeof mod.isHttpError, "function");
     assertEquals(typeof mod.isRedirectStatus, "function");
@@ -34,6 +36,6 @@ test({
     assertEquals(typeof mod.STATUS_TEXT, "object");
     assertEquals(typeof mod.Status, "object");
     assertEquals(typeof mod.send, "function");
-    assertEquals(Object.keys(mod).length, 23);
+    assertEquals(Object.keys(mod).length, 25);
   },
 });