Merge pull request #18 from soyuka/fix-2

Fix #2

Author: soyuka

README.md

@@ -10,7 +10,7 @@ npm install random-access-http
 
 ## Why?
 
-Peers in a distributed system tend to come and go over a short period of time in many common p2p scenarios, especially when you are giving away a file without incentivizing the swarm to seed the file for a long time.  There are also an abundance of free cloud hosts that let you host large files over http.
+Peers in a distributed system tend to come and go over a short period of time in many common p2p scenarios, especially when you are giving away a file without incentivizing the swarm to seed the file for a long time. There are also an abundance of free cloud hosts that let you host large files over http.
 
 This module provides you random access to a file hosted over http so that it can be used by a client in a distributed system (such as hypercore or hyperdrive) to acquire parts of the file for itself and the other peers in the swarm.
 
@@ -30,13 +30,13 @@ file.read(5, 10, function(err, buffer) {
 })
 ```
 
-file will use a keepalive agent to reduce the number http requests needed for the session.  When you are done you should call `file.close()` to destroy the agent.
+file will use a keepalive agent to reduce the number http requests needed for the session. When you are done you should call `file.close()` to destroy the agent.
 
 ## API
 
 #### `var file = randomAccessHTTP(url, [options])`
 
-Create a new 'file' that reads from the provided `url`.  The `url` can be either `http`, `https` or a relative path if url is set in options.
+Create a new 'file' that reads from the provided `url`. The `url` can be either `http`, `https` or a relative path if url is set in options.
 
 Options include:
 ```js
@@ -46,17 +46,20 @@ Options include:
   timeout: number, // Optional. Default: 60000
   maxRedirects: number, // Optional. Default: 10
   maxContentLength: number, // Optional. Default: 50MB
+  strict: true, // When false, will accept non-ranged response (it will slice the response to the requested offset/length)
 }
 ```
 
 #### `file.write(offset, buffer, [callback])`
 
-**Not implemented!**  Please let us know if you have opinions on how to implement this.
+**Not implemented!** Please let us know if you have opinions on how to implement this.
 This will silently fail with no data being writen.
 
 #### `file.read(offset, length, callback)`
 
-Read a buffer at a specific offset. Callback is called with the buffer read.  Currently this will fail if the server returns byte ranges different than what is requested.  PRs welcome to expand the flexibility of this method to allow for servers that return fat ranges.
+Read a buffer at a specific offset. Callback is called with the buffer read.
+By default, this will fail if the server returns byte ranges different than what is requested.
+If you want to support uncooperative static file servers (that doesn't use ranges), pass the `strict` with a falsy value.
 
 #### `file.close([callback])`
 

index.js

@@ -21,6 +21,8 @@ var randomAccessHttp = function (filename, options) {
     throw new Error('Expect first argument to be a valid URL or a relative path, with url set in options')
   }
 
+  // If this is falsy, raHttp will read non-ranged data
+  var strict = true
   var axiosConfig = Object.assign({}, defaultOptions)
   if (isNode) {
     var http = require('http')
@@ -34,6 +36,7 @@ var randomAccessHttp = function (filename, options) {
     if (options.timeout) axiosConfig.timeout = options.timeout
     if (options.maxRedirects) axiosConfig.maxRedirects = options.maxRedirects
     if (options.maxContentLength) axiosConfig.maxContentLength = options.maxContentLength
+    if (options.strict !== undefined) strict = options.strict
   }
   var _axios = axios.create(axiosConfig)
   var file = filename
@@ -51,7 +54,11 @@ var randomAccessHttp = function (filename, options) {
             if (response.headers['content-length']) this.length = response.headers['content-length']
             return req.callback(null)
           }
-          return req.callback(new Error('Accept-Ranges does not include "bytes"'))
+
+          if (strict) return req.callback(new Error('Accept-Ranges does not include "bytes"'))
+
+          logger.warn('Accept-Ranges does not include "bytes" or may not be supported.')
+          return req.callback(null)
         })
         .catch((err) => {
           if (verbose) logger.log('Error opening', file, '-', err)
@@ -66,7 +73,13 @@ var randomAccessHttp = function (filename, options) {
       if (verbose) logger.log('Trying to read', file, headers.Range)
       _axios.get(file, { headers: headers })
         .then((response) => {
-          if (!response.headers['content-range']) throw new Error('Server did not return a byte range')
+          if (!response.headers['content-range']) {
+            if (strict) throw new Error('No content range. Use the "strict" option to bypass.')
+            if (req.offset + req.size > response.data.length) throw new Error('Could not satisfy length')
+            logger.warn('Reading data without content-range.')
+            return req.callback(null, Buffer.from(response.data.slice(req.offset, req.offset + req.size)))
+          }
+
           if (response.status !== 206) throw new Error('Bad response: ' + response.status)
           var expectedRange = `bytes ${range}/${this.length}`
           if (response.headers['content-range'] !== expectedRange) throw new Error('Server returned unexpected range: ' + response.headers['content-range'])

lib/logger.js

@@ -1,4 +1,5 @@
 // This is simply for testing
 module.exports = {
-  log: console.log
+  log: console.log,
+  warn: console.warn
 }

package-lock.json

@@ -36,6 +36,7 @@
     "nyc": "^11.4.1",
     "proxyquire": "^1.8.0",
     "sinon": "^4.2.2",
+    "st": "^1.2.2",
     "standard": "^10.0.3",
     "stoppable": "^1.0.5",
     "tap-spec": "^4.1.1",

package.json

@@ -3,6 +3,8 @@ var proxyquire = require('proxyquire').noPreserveCache()
 var sinon = require('sinon')
 var stoppable = require('stoppable')
 var http = require('http')
+var st = require('st')
+var path = require('path')
 var port = 3000
 
 var server
@@ -187,3 +189,26 @@ test('raHttp.del logs with options.verbose === true', (t) => {
     })
   })
 })
+
+test('raHttp.read() on server that does not support ranges', (t) => {
+  var raHttp = require('../index.js')
+  var mount = st({
+    path: path.join(__dirname, '..')
+  })
+
+  var server = stoppable(http.createServer(function (req, res) {
+    mount(req, res)
+  }))
+
+  server.listen(port, function () {
+    var ra = raHttp('LICENSE', { url: 'http://localhost:3000', strict: false })
+    ra.read(10, 20, (err, data) => {
+      t.error(err)
+      t.ok(data instanceof Buffer)
+      t.same(data.length, 20)
+      server.stop(function () {
+        t.end()
+      })
+    })
+  })
+})