Overhaul the semantics of Request.handlerPath and Request.url.

test/request_test.dart

 // Copyright (c) 2014, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 library shelf.request_test;
 
 import 'dart:async';
 
 import 'package:shelf/shelf.dart';
 import 'package:unittest/unittest.dart';
 
 import 'test_util.dart';
 
 Request _request([Map<String, String> headers, Stream<List<int>> body]) {
   return new Request("GET", LOCALHOST_URI, headers: headers, body: body);
 }
 
 void main() {
   group('constructor', () {
     test('protocolVersion defaults to "1.1"', () {
       var request = new Request('GET', LOCALHOST_URI);
       expect(request.protocolVersion, '1.1');
     });
 
     test('provide non-default protocolVersion', () {
       var request = new Request('GET', LOCALHOST_URI, protocolVersion: '1.0');
       expect(request.protocolVersion, '1.0');
     });
 
-    test('requestedUri must be absolute', () {
-      expect(() => new Request('GET', Uri.parse('/path')),
-          throwsArgumentError);
+    group("url", () {
+      test("defaults to the requestedUri's relativized path and query", () {
+        var request = new Request(
+            'GET', Uri.parse("http://localhost/foo/bar?q=1"));
+        expect(request.url, equals(Uri.parse("foo/bar?q=1")));
+      });
+
+      test("is inferred from handlerPath if possible", () {
+        var request = new Request(
+            'GET', Uri.parse("http://localhost/foo/bar?q=1"),
+            handlerPath: '/foo/');
+        expect(request.url, equals(Uri.parse("bar?q=1")));
+      });
+
+      test("uses the given value if passed", () {
+        var request = new Request(
+            'GET', Uri.parse("http://localhost/foo/bar?q=1"),
+            url: Uri.parse("bar?q=1"));
+        expect(request.url, equals(Uri.parse("bar?q=1")));
+      });
     });
 
-    test('if uri is null, scriptName must be null', () {
-      expect(() => new Request('GET', Uri.parse('/path'),
-          scriptName: '/script/name'), throwsArgumentError);
+    group("handlerPath", () {
+      test("defaults to '/'", () {
+        var request = new Request(
+            'GET', Uri.parse("http://localhost/foo/bar"));
+        expect(request.handlerPath, equals('/'));
+      });
+
+      test("is inferred from url if possible", () {
+        var request = new Request(
+            'GET', Uri.parse("http://localhost/foo/bar?q=1"),
+            url: Uri.parse("bar?q=1"));
+        expect(request.handlerPath, equals("/foo/"));
+      });
+
+      test("uses the given value if passed", () {
+        var request = new Request(
+            'GET', Uri.parse("http://localhost/foo/bar?q=1"),
+            handlerPath: '/foo/');
+        expect(request.handlerPath, equals("/foo/"));
+      });
+
+      test("adds a trailing slash to the given value if necessary", () {
+        var request = new Request(
+            'GET', Uri.parse("http://localhost/foo/bar?q=1"),
+            handlerPath: '/foo');
+        expect(request.handlerPath, equals("/foo/"));
+        expect(request.url, equals(Uri.parse("bar?q=1")));
+      });
     });
 
-    test('if scriptName is null, uri must be null', () {
-      var relativeUri = new Uri(path: '/cool/beans.html');
-      expect(() => new Request('GET', Uri.parse('/path'),
-          url: relativeUri), throwsArgumentError);
-    });
+    group("errors", () {
+      group('requestedUri', () {
+        test('must be absolute', () {
+          expect(() => new Request('GET', Uri.parse('/path')),
+              throwsArgumentError);
+        });
 
-    test('uri must be relative', () {
-      var relativeUri = Uri.parse('http://localhost/test');
+        test('may not have a fragment', () {
+          expect(() {
+            new Request('GET', Uri.parse('http://localhost/#fragment'));
+          }, throwsArgumentError);
+        });
+      });
 
-      expect(() => new Request('GET', LOCALHOST_URI,
-          url: relativeUri, scriptName: '/news'),
-          throwsArgumentError);
+      group('url', () {
+        test('must be relative', () {
+          expect(() {
+            new Request('GET', Uri.parse('http://localhost/test'),
+                url: Uri.parse('http://localhost/test'));
+          }, throwsArgumentError);
+        });
 
-      // NOTE: explicitly testing fragments due to Issue 18053
-      relativeUri = Uri.parse('http://localhost/test#fragment');
+        test('may not be root-relative', () {
+          expect(() {
+            new Request('GET', Uri.parse('http://localhost/test'),
+                url: Uri.parse('/test'));
+          }, throwsArgumentError);
+        });
 
-      expect(() => new Request('GET', LOCALHOST_URI,
-          url: relativeUri, scriptName: '/news'),
-          throwsArgumentError);
-    });
+        test('may not have a fragment', () {
+          expect(() {
+            new Request('GET', Uri.parse('http://localhost/test'),
+                url: Uri.parse('test#fragment'));
+          }, throwsArgumentError);
+        });
 
-    test('uri and scriptName', () {
-      var pathInfo = '/pages/page.html?utm_source=ABC123';
-      var scriptName = '/assets/static';
-      var fullUrl = 'http://localhost/other_path/other_resource.asp';
-      var request = new Request('GET', Uri.parse(fullUrl),
-          url: Uri.parse(pathInfo), scriptName: scriptName);
+        test('must be a suffix of requestedUri', () {
+          expect(() {
+            new Request('GET', Uri.parse('http://localhost/dir/test'),
+                url: Uri.parse('dir'));
+          }, throwsArgumentError);
+        });
 
-      expect(request.scriptName, scriptName);
-      expect(request.url.path, '/pages/page.html');
-      expect(request.url.query, 'utm_source=ABC123');
-    });
+        test('must have the same query parameters as requestedUri', () {
+          expect(() {
+            new Request(
+                'GET',
+                Uri.parse('http://localhost/test?q=1&r=2'),
+                url: Uri.parse('test?q=2&r=1'));
+          }, throwsArgumentError);
 
-    test('minimal uri', () {
-      var pathInfo = '/';
-      var scriptName = '/assets/static';
-      var fullUrl = 'http://localhost$scriptName$pathInfo';
-      var request = new Request('GET', Uri.parse(fullUrl),
-          url: Uri.parse(pathInfo), scriptName: scriptName);
+          // Order matters for query parameters.
+          expect(() {
+            new Request('GET', Uri.parse('http://localhost/test?q=1&r=2'),
+                url: Uri.parse('test?r=2&q=1'));
+          }, throwsArgumentError);
+        });
+      });
 
-      expect(request.scriptName, scriptName);
-      expect(request.url.path, '/');
-      expect(request.url.query, '');
-    });
+      group('handlerPath', () {
+        test('must be a prefix of requestedUri', () {
+          expect(() {
+            new Request('GET', Uri.parse('http://localhost/dir/test'),
+                handlerPath: '/test');
+          }, throwsArgumentError);
+        });
 
-    test('invalid url', () {
-      var testUrl = 'page';
-      var scriptName = '/assets/static';
-      var fullUrl = 'http://localhost$scriptName$testUrl';
+        test('must start with "/"', () {
+          expect(() {
+            new Request('GET', Uri.parse('http://localhost/test'),
+                handlerPath: 'test');
+          }, throwsArgumentError);
+        });
+      });
 
-      expect(() => new Request('GET', Uri.parse(fullUrl),
-          url: Uri.parse(testUrl), scriptName: scriptName),
-          throwsArgumentError);
-    });
+      group('handlerPath + url must', () {
+        test('be requestedUrl path', () {
+          expect(() {
+            new Request('GET', Uri.parse('http://localhost/foo/bar/baz'),
+                handlerPath: '/foo/',
+                url: Uri.parse('baz'));
+          }, throwsArgumentError);
+        });
 
-    test('scriptName with no leading slash', () {
-      var pathInfo = '/page';
-      var scriptName = 'assets/static';
-      var fullUrl = 'http://localhost/assets/static/pages';
-
-      expect(() => new Request('GET',Uri.parse(fullUrl),
-          url: Uri.parse(pathInfo), scriptName: scriptName),
-          throwsArgumentError);
-
-      pathInfo = '/assets/static/page';
-      scriptName = '/';
-      fullUrl = 'http://localhost/assets/static/pages';
-
-      expect(() => new Request('GET',Uri.parse(fullUrl),
-          url: Uri.parse(pathInfo), scriptName: scriptName),
-          throwsArgumentError);
-    });
-
-    test('scriptName that is only a slash', () {
-      var pathInfo = '/assets/static/page';
-      var scriptName = '/';
-      var fullUrl = 'http://localhost/assets/static/pages';
-
-      expect(() => new Request('GET',Uri.parse(fullUrl),
-          url: Uri.parse(pathInfo), scriptName: scriptName),
-          throwsArgumentError);
+        test('be on a path boundary', () {
+          expect(() {
+            new Request('GET', Uri.parse('http://localhost/foo/bar/baz'),
+                handlerPath: '/foo/ba',
+                url: Uri.parse('r/baz'));
+          }, throwsArgumentError);
+        });
+      });
     });
   });
 
   group("ifModifiedSince", () {
     test("is null without an If-Modified-Since header", () {
       var request = _request();
       expect(request.ifModifiedSince, isNull);
     });
 
     test("comes from the Last-Modified header", () {
       var request = _request({
         'if-modified-since': 'Sun, 06 Nov 1994 08:49:37 GMT'
       });
       expect(request.ifModifiedSince,
           equals(DateTime.parse("1994-11-06 08:49:37z")));
     });
   });
 
   group('change', () {
     test('with no arguments returns instance with equal values', () {
       var controller = new StreamController();
 
       var uri = Uri.parse('https://test.example.com/static/file.html');
 
       var request = new Request('GET', uri,
           protocolVersion: '2.0',
           headers: {'header1': 'header value 1'},
-          url: Uri.parse('/file.html'),
-          scriptName: '/static',
+          url: Uri.parse('file.html'),
+          handlerPath: '/static/',
           body: controller.stream,
           context: {'context1': 'context value 1'});
 
       var copy = request.change();
 
       expect(copy.method, request.method);
       expect(copy.requestedUri, request.requestedUri);
       expect(copy.protocolVersion, request.protocolVersion);
       expect(copy.headers, same(request.headers));
       expect(copy.url, request.url);
-      expect(copy.scriptName, request.scriptName);
+      expect(copy.handlerPath, request.handlerPath);
       expect(copy.context, same(request.context));
       expect(copy.readAsString(), completion('hello, world'));
 
       controller.add(HELLO_BYTES);
       return new Future(() {
         controller
           ..add(WORLD_BYTES)
           ..close();
       });
     });
 
-    group('with just scriptName', () {
-      test('updates url if scriptName matches existing url', () {
-        var uri = Uri.parse('https://test.example.com/static/file.html');
-        var request = new Request('GET', uri);
-        var copy = request.change(scriptName: '/static');
+    group('with path', () {
+      test('updates handlerPath and url', () {
+        var uri = Uri.parse('https://test.example.com/static/dir/file.html');
+        var request = new Request('GET', uri,
+            handlerPath: '/static/', url: Uri.parse('dir/file.html'));
+        var copy = request.change(path: 'dir');
 
-        expect(copy.scriptName, '/static');
-        expect(copy.url, Uri.parse('/file.html'));
+        expect(copy.handlerPath, '/static/dir/');
+        expect(copy.url, Uri.parse('file.html'));
       });
 
-      test('throws if striptName does not match existing url', () {
-        var uri = Uri.parse('https://test.example.com/static/file.html');
-        var request = new Request('GET', uri);
+      test('allows a trailing slash', () {
+        var uri = Uri.parse('https://test.example.com/static/dir/file.html');
+        var request = new Request('GET', uri,
+            handlerPath: '/static/', url: Uri.parse('dir/file.html'));
+        var copy = request.change(path: 'dir/');
 
-        expect(() => request.change(scriptName: '/nope'), throwsArgumentError);
+        expect(copy.handlerPath, '/static/dir/');
+        expect(copy.url, Uri.parse('file.html'));
       });
-    });
 
-    test('url', () {
-      var uri = Uri.parse('https://test.example.com/static/file.html');
-      var request = new Request('GET', uri);
-      var copy = request.change(url: Uri.parse('/other_path/file.html'));
+      test('throws if path does not match existing uri', () {
+        var uri = Uri.parse('https://test.example.com/static/dir/file.html');
+        var request = new Request('GET', uri,
+            handlerPath: '/static/', url: Uri.parse('dir/file.html'));
 
-      expect(copy.scriptName, '');
-      expect(copy.url, Uri.parse('/other_path/file.html'));
-    });
+        expect(() => request.change(path: 'wrong'), throwsArgumentError);
+      });
 
-    test('scriptName and url', () {
-      var uri = Uri.parse('https://test.example.com/static/file.html');
-      var request = new Request('GET', uri);
-      var copy = request.change(scriptName: '/dynamic',
-          url: Uri.parse('/other_path/file.html'));
+      test("throws if path isn't a path boundary", () {
+        var uri = Uri.parse('https://test.example.com/static/dir/file.html');
+        var request = new Request('GET', uri,
+            handlerPath: '/static/', url: Uri.parse('dir/file.html'));
 
-      expect(copy.scriptName, '/dynamic');
-      expect(copy.url, Uri.parse('/other_path/file.html'));
+        expect(() => request.change(path: 'di'), throwsArgumentError);
+      });
     });
   });
 }