chore: Resolve Spanner bugfixes (#129)

* use HTTPMethod.ALL as fallback when method not found

* use function for logging

* bump spanner version

Author: codekeyz

packages/pharaoh/pubspec.yaml

@@ -8,7 +8,7 @@ environment:
 
 dependencies:
   meta:
-  spanner: ^1.0.1+5
+  spanner: ^1.0.2
   mime: ^1.0.4
   collection: ^1.18.0
   http_parser: ^4.0.2

packages/spanner/CHANGELOG.md

@@ -1,9 +1,13 @@
+## 1.0.2
+
+- (perf): Make route debug logs optional.
+- (bug): Fallback to `HTTPMethod.ALL` when exact route method not found.
+
 ## 1.0.1
 
 - De-coupled spanner from pharaoh.
 - Updated documentation
 
-
 ## 1.0.0
 
 - Initial version.

packages/spanner/lib/src/route/action.dart

@@ -13,7 +13,8 @@ mixin HandlerStore {
 
   bool hasMethod(HTTPMethod method) => requestHandlers.containsKey(method);
 
-  IndexedValue? getHandler(HTTPMethod method) => requestHandlers[method];
+  IndexedValue? getHandler(HTTPMethod method) =>
+      requestHandlers[method] ?? requestHandlers[HTTPMethod.ALL];
 
   void addRoute<T>(HTTPMethod method, IndexedValue<T> handler) {
     if (requestHandlers.containsKey(method)) {

packages/spanner/lib/src/tree/node.dart

@@ -86,12 +86,11 @@ class ParametricNode extends Node {
     return super.addChildAndReturn(key, node);
   }
 
-  final List<ParameterDefinition> _definitions = [];
+  final List<ParameterDefinition> _definitions;
 
-  List<ParameterDefinition> get definitions =>
-      UnmodifiableListView(_definitions);
+  Iterable<ParameterDefinition> get definitions => _definitions;
 
-  ParametricNode(ParameterDefinition defn) {
+  ParametricNode(ParameterDefinition defn) : _definitions = [] {
     _definitions.add(defn);
   }
 

packages/spanner/lib/src/tree/tree.dart

@@ -162,7 +162,11 @@ class Spanner {
     return isLastSegment ? defn : node.addChildAndReturn(key, paramNode);
   }
 
-  RouteResult? lookup(HTTPMethod method, dynamic route, {bool debug = false}) {
+  RouteResult? lookup(
+    HTTPMethod method,
+    dynamic route, {
+    void Function(String)? devlog,
+  }) {
     final path = route is Uri ? route.path : route.toString();
     final routeSegments = route is Uri
         ? route.pathSegments
@@ -206,14 +210,9 @@ class Spanner {
       );
     }
 
-    final debugLog = StringBuffer("\n");
-
-    void devlog(String message) {
-      if (!debug) return;
-      debugLog.writeln(message);
-    }
-
-    devlog('Finding node for ---------  ${method.name} $path ------------\n');
+    devlog?.call(
+      'Finding node for ---------  ${method.name} $path ------------\n',
+    );
 
     for (int i = 0; i < routeSegments.length; i++) {
       final String currPart = routeSegments[i];
@@ -233,12 +232,14 @@ class Spanner {
         final wcNode = rootNode.wildcardNode;
         if (wcNode != null) wildcardNode = wcNode;
 
-        devlog('- Found Static for                ->         $routePart');
+        devlog?.call('- Found Static for                ->         $routePart');
       } else {
         final parametricNode = rootNode.paramNode;
         if (parametricNode == null) {
-          devlog('x Found no Static Node for part   ->         $routePart');
-          devlog('x Route is not found              ->         $path');
+          devlog?.call(
+            'x Found no Static Node for part   ->         $routePart',
+          );
+          devlog?.call('x Route is not found              ->         $path');
 
           if (wildcardNode != null) {
             useWildcard(wildcardNode);
@@ -249,14 +250,16 @@ class Spanner {
         }
 
         if (parametricNode.hasChild(routePart)) {
-          devlog('- Found Static for             ->              $routePart');
+          devlog?.call(
+            '- Found Static for             ->              $routePart',
+          );
           rootNode = parametricNode.getChild(routePart);
           final wcNode = rootNode.wildcardNode;
           if (wcNode != null) wildcardNode = wcNode;
           continue;
         }
 
-        devlog(
+        devlog?.call(
           '- Finding Defn for $routePart        -> terminal?    $isLastPart',
         );
 
@@ -266,7 +269,7 @@ class Spanner {
           terminal: isLastPart,
         );
 
-        devlog('    * parametric defn:         ${definition.toString()}');
+        devlog?.call('    * parametric defn:         ${definition.toString()}');
 
         if (definition == null) {
           if (wildcardNode != null) {
@@ -294,7 +297,9 @@ class Spanner {
           break;
         }
 
-        devlog('- Found defn for route part    ->              $routePart');
+        devlog?.call(
+          '- Found defn for route part    ->              $routePart',
+        );
 
         final params = definition.resolveParams(currPart);
         resolvedParams.addAll(params);
@@ -310,10 +315,6 @@ class Spanner {
       }
     }
 
-    if (debug) {
-      print(debugLog);
-    }
-
     if (!rootNode.terminal) {
       return RouteResult(resolvedParams, getResults(null), actual: null);
     }

packages/spanner/pubspec.yaml

@@ -1,6 +1,6 @@
 name: spanner
 description: Generic HTTP Router implementation, internally uses a Radix Tree (aka compact Prefix Tree), supports route params, wildcards.
-version: 1.0.1+5
+version: 1.0.2
 repository: https://github.com/Pharaoh-Framework/pharaoh/tree/main/packages/spanner
 
 environment:

packages/spanner/test/issue_127_test.dart

@@ -0,0 +1,16 @@
+import 'package:spanner/spanner.dart';
+import 'package:test/test.dart';
+
+void main() {
+  test("ALL as fallback for specific method", () {
+    final router = Spanner()
+      ..addRoute(HTTPMethod.GET, '/api/auth/login', 4)
+      ..addRoute(HTTPMethod.ALL, '/api/auth/login', 5);
+
+    var result = router.lookup(HTTPMethod.GET, '/api/auth/login');
+    expect(result?.values, [4]);
+
+    result = router.lookup(HTTPMethod.POST, '/api/auth/login');
+    expect(result?.values, [5]);
+  });
+}