Merge branch 'main' into feat/auto-generate-docs

Author: codekeyz

README.md

@@ -29,30 +29,20 @@ dependencies:
 ```dart
 import 'package:pharaoh/pharaoh.dart';
 
-final app = Pharaoh();
-
 void main() async {
 
-  app.use((req, res, next) {
-
-    /// do something here
-
-    next();
-
-  });
-
-  app.get('/foo', (req, res) => res.ok("bar"));
-
-  final guestRouter = app.router()
+  final guestRouter = Pharaoh.router
     ..get('/user', (req, res) => res.ok("Hello World"))
     ..post('/post', (req, res) => res.json({"mee": "moo"}))
     ..put('/put', (req, res) => res.json({"pookey": "reyrey"}));
 
-  app.group('/guest', guestRouter);
+  final app = Pharaoh()
+    ..use((req, res, next) => next());
+    ..get('/foo', (req, res) => res.ok("bar"))
+    ..group('/guest', guestRouter);
 
-  await app.listen(); // port => 3000
+  await app.listen();
 }
-
 ```
 
 See the [Pharaoh Examples](./pharaoh_examples/lib/) directory for more practical use-cases.

packages/pharaoh/lib/pharaoh.dart

@@ -1,18 +1,20 @@
 library;
 
-export 'src/core.dart' hide $PharaohImpl;
 export 'src/view/view.dart';
 export 'src/http/cookie.dart';
 export 'src/http/request.dart';
 export 'src/http/response.dart';
+export 'src/http/router.dart';
+
+export 'src/shelf_interop/adapter.dart';
+export 'src/shelf_interop/shelf.dart' show ShelfBody;
+
 export 'src/utils/utils.dart';
 export 'src/utils/exceptions.dart';
-export 'src/router/router_handler.dart';
+
 export 'src/middleware/session_mw.dart';
 export 'src/middleware/body_parser.dart';
 export 'src/middleware/cookie_parser.dart';
 export 'src/middleware/request_logger.dart';
 
-// shelf
-export 'src/shelf_interop/adapter.dart';
-export 'src/shelf_interop/shelf.dart' show ShelfBody;
+export 'package:spanner/spanner.dart' show HTTPMethod;

packages/pharaoh/lib/pharaoh_next.dart

@@ -1,10 +1,5 @@
-export 'src/_next/validation.dart';
-export 'src/_next/router.dart';
+export 'pharaoh.dart';
 export 'src/_next/core.dart';
 export 'src/_next/http.dart';
-export 'src/core.dart';
-
-export 'src/http/response.dart';
-export 'src/http/request.dart';
-export 'src/router/router_handler.dart';
-export 'package:spanner/spanner.dart' show HTTPMethod;
+export 'src/_next/router.dart';
+export 'src/_next/validation.dart';

packages/pharaoh/lib/src/_next/_core/core_impl.dart

@@ -62,9 +62,9 @@ class _PharaohNextImpl implements Application {
   int get port => config.port;
 
   Pharaoh _createPharaohInstance({OnErrorCallback? onException}) {
-    final pharaoh = Pharaoh()
-      ..useSpanner(_spanner)
-      ..viewEngine = _viewEngine;
+    final pharaoh = Pharaoh()..useSpanner(_spanner);
+    Pharaoh.viewEngine = _viewEngine;
+
     if (onException != null) pharaoh.onError(onException);
     return pharaoh;
   }

packages/pharaoh/lib/src/_next/http.dart

@@ -5,7 +5,7 @@ import 'dart:io';
 import '../http/request.dart';
 import '../http/response.dart';
 import '../middleware/session_mw.dart';
-import '../router/router_handler.dart';
+import '../http/router.dart';
 import 'core.dart';
 
 @inject

packages/pharaoh/lib/src/_next/router.dart

@@ -9,7 +9,7 @@ import 'package:grammer/grammer.dart';
 import 'package:meta/meta.dart';
 import '../http/request.dart';
 import '../http/response.dart';
-import '../router/router_handler.dart';
+import '../http/router.dart';
 import 'validation.dart';
 import 'core.dart';
 

packages/pharaoh/lib/src/core.dart

@@ -2,7 +2,6 @@ import 'dart:io';
 
 import 'package:http_parser/http_parser.dart';
 import 'package:pharaoh/pharaoh.dart';
-import 'package:spanner/spanner.dart';
 
 import 'message.dart';
 
@@ -15,8 +14,7 @@ class RequestContext {
   /// cookies & session
   static const String cookies = '$phar.cookies';
   static const String signedCookies = '$phar.signedcookies';
-  static const String session = '$phar.session.cookie';
-  static const String sessionId = '$phar.session.id';
+  static const String session = '$phar.session';
 }
 
 HTTPMethod getHttpMethod(HttpRequest req) => switch (req.method) {

packages/pharaoh/lib/src/http/request.dart

@@ -71,7 +71,7 @@ class _$RequestImpl extends Request {
   Session? get session => _context[RequestContext.session];
 
   @override
-  String? get sessionId => _context[RequestContext.sessionId];
+  String? get sessionId => session?.id;
 
   @override
   Object? operator [](String name) => _context[name];

packages/pharaoh/lib/src/http/request_impl.dart

@@ -1,20 +1,70 @@
-part of 'core.dart';
+import 'dart:async';
+import 'dart:io';
 
-class $PharaohImpl extends RouterContract
+import 'package:collection/collection.dart';
+import 'package:http_parser/http_parser.dart';
+import 'package:meta/meta.dart';
+import 'package:spanner/spanner.dart';
+import 'package:spanner/src/tree/tree.dart' show BASE_PATH;
+
+import '../middleware/body_parser.dart';
+import '../middleware/session_mw.dart';
+import '../shelf_interop/shelf.dart' as shelf;
+import '../utils/exceptions.dart';
+import '../view/view.dart';
+
+import 'request.dart';
+import 'response.dart';
+
+part 'router/router_contract.dart';
+part 'router/router_handler.dart';
+
+typedef PharaohError = ({Object exception, StackTrace trace});
+
+typedef OnErrorCallback = FutureOr<Response> Function(
+  PharaohError error,
+  Request req,
+  Response res,
+);
+
+abstract class Pharaoh implements RouterContract {
+  static _$GroupRouter get router => _$GroupRouter();
+
+  factory Pharaoh() => _$PharaohImpl();
+
+  static ViewEngine? viewEngine;
+
+  void onError(OnErrorCallback onError);
+
+  void useSpanner(Spanner spanner);
+
+  void useRequestHook(RequestHook hook);
+
+  void group(String path, _$GroupRouter router);
+
+  Uri get uri;
+
+  Future<Pharaoh> listen({int port = 3000});
+
+  @visibleForTesting
+  void handleRequest(HttpRequest httpReq);
+
+  Future<void> shutdown();
+}
+
+class _$PharaohImpl extends RouterContract
     with RouteDefinitionMixin
     implements Pharaoh {
   late final HttpServer _server;
 
   OnErrorCallback? _onErrorCb;
 
-  static ViewEngine? viewEngine_;
-
-  final List<ReqResHook> _preResponseHooks = [
+  final List<RequestHook> _requestHooks = [
     sessionPreResponseHook,
     viewRenderHook,
   ];
 
-  $PharaohImpl() {
+  _$PharaohImpl() {
     useSpanner(Spanner());
     use(bodyParser);
   }
@@ -42,15 +92,6 @@ class $PharaohImpl extends RouterContract
     );
   }
 
-  @override
-  Pharaoh group(final String path, final RouterContract router) {
-    if (router is! GroupRouter) {
-      throw PharaohException.value('Router is not an instance of GroupRouter');
-    }
-    router.commit(path, spanner);
-    return this;
-  }
-
   @override
   Future<Pharaoh> listen({int port = 3000}) async {
     _server = await HttpServer.bind(InternetAddress.anyIPv4, port, shared: true)
@@ -114,21 +155,22 @@ class $PharaohImpl extends RouterContract
       req.params.addAll(routeResult.params);
     }
 
-    reqRes = await executeHandlers(resolvedHandlers, reqRes);
-
-    for (final job in _preResponseHooks) {
-      reqRes = await Future.microtask(() => job(reqRes));
+    for (final hook in _requestHooks.whereNot((e) => e.onBefore == null)) {
+      reqRes = await hook.onBefore!.call(req, reqRes.res);
     }
 
-    if (!reqRes.res.ended) {
-      return reqRes.merge(routeNotFound());
+    reqRes = await executeHandlers(resolvedHandlers, reqRes);
+    if (!reqRes.res.ended) reqRes = reqRes.merge(routeNotFound());
+
+    for (final hook in _requestHooks.whereNot((e) => e.onAfter == null)) {
+      reqRes = await hook.onAfter!.call(reqRes.req, reqRes.res);
     }
 
     return reqRes;
   }
 
   Future<void> forward(HttpRequest request, Response res_) async {
-    var coding = res_.headers['transfer-encoding'];
+    var coding = res_.headers[HttpHeaders.transferEncodingHeader];
 
     final statusCode = res_.statusCode;
     request.response.statusCode = statusCode;
@@ -187,14 +229,21 @@ class $PharaohImpl extends RouterContract
   Future<void> shutdown() async => _server.close();
 
   @override
-  ViewEngine? get viewEngine => viewEngine_;
+  void onError(OnErrorCallback errorCb) => _onErrorCb = errorCb;
 
   @override
-  set viewEngine(ViewEngine? engine) => viewEngine_ = engine;
+  void useRequestHook(RequestHook hook) => _requestHooks.add(hook);
 
   @override
-  void onError(OnErrorCallback errorCb) => _onErrorCb = errorCb;
+  void group(String path, _$GroupRouter router) {
+    spanner.attachNode(path, router.spanner.root);
+  }
 }
 
-// ignore: constant_identifier_names
 const _XPoweredByHeader = 'X-Powered-By';
+
+class _$GroupRouter extends RouterContract with RouteDefinitionMixin {
+  _$GroupRouter() {
+    useSpanner(Spanner());
+  }
+}