Fix a number of issues with the Range header handling for serving files

pkg/http_server/test/utils.dart

 // Copyright (c) 2013, 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 utils;
 
 import 'dart:async';
 import 'dart:convert';
 import 'dart:io';
 import "package:unittest/unittest.dart";
@@ skipping 24 matching lines @@
     var dir = Directory.systemTemp.createTempSync('http_server_virtual_');
 
     return func(dir)
         .whenComplete(() {
           return dir.delete(recursive: true);
         });
   });
 }
 
 Future<int> getStatusCodeForVirtDir(VirtualDirectory virtualDir,
-                           String path,
-                          {String host,
-                           bool secure: false,
-                           DateTime ifModifiedSince,
-                           bool rawPath: false,
-                           bool followRedirects: true}) {
+                                    String path,
+                                    {String host,
+                                     bool secure: false,
+                                     DateTime ifModifiedSince,
+                                     bool rawPath: false,
+                                     bool followRedirects: true,
+                                     int from,
+                                     int to}) {
 
   // if this is a mock test, then run the mock code path
   if(_isMockTestExpando[currentTestCase]) {
     var uri = _getUri(0, path, secure: secure, rawPath: rawPath);
 
     var request = new MockHttpRequest(uri, followRedirects: followRedirects,
         ifModifiedSince: ifModifiedSince);
+    _addRangeHeader(request, from, to);
 
     return _withMockRequest(virtualDir, request)
         .then((response) {
           return response.statusCode;
         });
   };
 
   assert(_isMockTestExpando[currentTestCase] == false);
 
   return _withServer(virtualDir, (port) {
     return getStatusCode(port, path, host: host, secure: secure,
           ifModifiedSince: ifModifiedSince, rawPath: rawPath,
-          followRedirects: followRedirects);
+          followRedirects: followRedirects, from: from, to: to);
   });
 }
 
 Future<int> getStatusCode(int port,
                           String path,
                           {String host,
                            bool secure: false,
                            DateTime ifModifiedSince,
                            bool rawPath: false,
-                           bool followRedirects: true}) {
+                           bool followRedirects: true,
+                           int from,
+                           int to}) {
   var uri = _getUri(port, path, secure: secure, rawPath: rawPath);
 
   return new HttpClient().getUrl(uri)
       .then((request) {
         if (!followRedirects) request.followRedirects = false;
         if (host != null) request.headers.host = host;
         if (ifModifiedSince != null) {
           request.headers.ifModifiedSince = ifModifiedSince;
         }
+        _addRangeHeader(request, from, to);
         return request.close();
       })
       .then((response) => response.drain().then(
           (_) => response.statusCode));
 }
 
-Future<HttpHeaders> getHeaders(VirtualDirectory virDir, String path) {
+Future<HttpHeaders> getHeaders(
+    VirtualDirectory virDir, String path, {int from, int to}) {
 
   // if this is a mock test, then run the mock code path
   if(_isMockTestExpando[currentTestCase]) {
     var uri = _getUri(0, path);
 
     var request = new MockHttpRequest(uri);
+    _addRangeHeader(request, from, to);
 
     return _withMockRequest(virDir, request)
         .then((response) {
           return response.headers;
         });
   }
 
   assert(_isMockTestExpando[currentTestCase] == false);
 
   return _withServer(virDir, (port) {
-      return _getHeaders(port, path);
+      return _getHeaders(port, path, from, to);
     });
 }
 
 Future<String> getAsString(VirtualDirectory virtualDir, String path) {
 
   // if this is a mock test, then run the mock code path
   if(_isMockTestExpando[currentTestCase]) {
     var uri = _getUri(0, path);
 
     var request = new MockHttpRequest(uri);
 
     return _withMockRequest(virtualDir, request)
         .then((response) {
           return response.mockContent;
         });
   };
 
   assert(_isMockTestExpando[currentTestCase] == false);
 
   return _withServer(virtualDir, (int port) {
       return _getAsString(port, path);
     });
 }
 
+Future<String> getAsBytes(
+    VirtualDirectory virtualDir, String path, {int from, int to}) {
+
+  // if this is a mock test, then run the mock code path
+  if(_isMockTestExpando[currentTestCase]) {

[kustermann, 2014/11/14 13:25:27]

space after 'if'

[Søren Gjesse, 2014/11/14 15:27:29]

Done.

+    var uri = _getUri(0, path);
+
+    var request = new MockHttpRequest(uri);
+    _addRangeHeader(request, from, to);
+
+    return _withMockRequest(virtualDir, request)
+        .then((response) {
+          return response.mockContentBinary;
+        });
+  };
+
+  assert(_isMockTestExpando[currentTestCase] == false);

[kustermann, 2014/11/14 13:25:27]

This assert is not doing anything, If you go into the if(), then it will return
before coming here, right?

Is it just for documentation purposes?

[Søren Gjesse, 2014/11/14 15:27:30]

Honestly don't know. It is in all these methods.

Will remove all in a separate CL.

+
+  return _withServer(virtualDir, (int port) {
+      return _getAsBytes(port, path, from, to);

[kustermann, 2014/11/14 13:25:27]

_getAsBytes is returning Future<List<int>> but the type signature of the above
function is

Future<String> getAsBytes()

[Søren Gjesse, 2014/11/14 15:27:29]

Done.

+    });
+}
+
 Future<MockHttpResponse> _withMockRequest(VirtualDirectory virDir,
     MockHttpRequest request) {
     return virDir.serveRequest(request).then((value) {
       expect(value, isNull);
       expect(request.response.mockDone, isTrue);
       return request.response;
     })
     .then((HttpResponse response) {
       if(response.statusCode == HttpStatus.MOVED_PERMANENTLY ||
           response.statusCode == HttpStatus.MOVED_TEMPORARILY) {
@@ skipping 12 matching lines @@
   HttpServer server;
   return HttpServer.bind('localhost', 0)
       .then((value) {
         server = value;
         virDir.serve(server);
         return func(server.port);
       })
       .whenComplete(() => server.close());
 }
 
-Future<HttpHeaders> _getHeaders(int port, String path) =>
+Future<HttpHeaders> _getHeaders(int port, String path, int from, int to) =>
     new HttpClient()

[kustermann, 2014/11/14 13:25:27]

Who is closing HttpClient here?

[Søren Gjesse, 2014/11/14 15:27:29]

Nobody. Added close.

       .get('localhost', port, path)
-      .then((request) => request.close())
+      .then((request) {
+        _addRangeHeader(request, from, to);
+        return request.close();
+      })
       .then((response) => response.drain().then(
           (_) => response.headers));
 
 Future<String> _getAsString(int port, String path) =>
     new HttpClient()

[kustermann, 2014/11/14 13:25:27]

ditto.

[Søren Gjesse, 2014/11/14 15:27:29]

Ditto.

       .get('localhost', port, path)
       .then((request) => request.close())
       .then((response) => UTF8.decodeStream(response));
 
+Future<List<int>> _getAsBytes(int port, String path, int from, int to) =>
+    new HttpClient()

[kustermann, 2014/11/14 13:25:27]

ditto

[Søren Gjesse, 2014/11/14 15:27:29]

Ditto.

+      .get('localhost', port, path)
+      .then((request) {
+        _addRangeHeader(request, from, to);
+        return request.close();
+      })
+      .then((response) => response.fold([], (p, e) => p..addAll(e)));
+
 Uri _getUri(int port,
             String path,
            {bool secure: false,
             bool rawPath: false}) {
   if (rawPath) {
     return new Uri(scheme: secure ? 'https' : 'http',
                   host: 'localhost',
                   port: port,
                   path: path);
   } else {
     return (secure ?
         new Uri.https('localhost:$port', path) :
         new Uri.http('localhost:$port', path));
   }
 }
 
+void _addRangeHeader(HttpRequest request, int from, int to) {
+  var fromStr = from != null ? '$from' : '';
+  var toStr = to != null ? '$to' : '';
+  if (fromStr.isNotEmpty || toStr.isNotEmpty) {
+    request.headers.set(HttpHeaders.RANGE, 'bytes=$fromStr-$toStr');
+  }
+}
+
 const CERTIFICATE = "localhost_cert";
 
 
 void setupSecure() {
   String certificateDatabase = Platform.script.resolve('pkcert').toFilePath();
   SecureSocket.initialize(database: certificateDatabase,
                           password: 'dartdart');
 }