Allow Promise return type for onBeforeRequest and onAfterResponse. (#212)

* Allow Promise return type for onBeforeRequest and onAfterResponse.

* Allow Promise return type for onBeforeRequest and onAfterResponse: documentation and test case.

* Allow to specify options for Node's request method (#203)

* adding nodejs HttpStack request options

* fix

* fix

* fix

* visual fix

* proposal for request options

* disabling browser

* fix

* Clarify how to import using ESM syntax

* Added onShouldRetry callback for controlling retries (#198)

* Added onShouldRetry callback for controlling retry

Whenever the library is about to retry an upload due to an
error, the new optional callback onShouldRetry will be
called when defined. Its return value will tell the library whether
to actually retry the upload or fail with an error, for example
based on status code checks.

This makes it possible to customize the behavior like reacting on
specific status codes.

* Move onShouldRetry example to usage.md

* Refactored shouldRetry logic

- isOnline is now excluded from the check, so the onShouldRetry callback
  should manually add an online check if desired
- removed inline function and made the conditions more readable
- clarified inline comments about status code check

* Add test assertion for onShouldRetry arguments

* Update usage.md

* Update test-common.js

* Update api.md

Co-authored-by: Marius <[email protected]>

* making property 'private', adding small test for 'insecure' request

* fixes ?

* fix: import

* Update js-base64 to a version which does not use eval() anymore

Closes #147

* PR comments fixes

* fixed exports on node, addex HttpStack export on browser

* added new test case - node 14

* test fixes

* test fixes

* fix tests

* Bump lodash from 4.17.14 to 4.17.19

Bumps [lodash](https://github.com/lodash/lodash) from 4.17.14 to 4.17.19.
- [Release notes](https://github.com/lodash/lodash/releases)
- [Commits](lodash/lodash@4.17.14...4.17.19)

Signed-off-by: dependabot[bot] <[email protected]>

* Clean up request initialization and add proper test

Co-authored-by: Dragos Cirjan <[email protected]>
Co-authored-by: Dragos Cirjan <[email protected]>
Co-authored-by: Marius <[email protected]>
Co-authored-by: Vincent Petry <[email protected]>
Co-authored-by: Marius <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Kevin van Zonneveld <[email protected]>

* Bump elliptic from 6.3.1 to 6.5.3 (#214)

Bumps [elliptic](https://github.com/indutny/elliptic) from 6.3.1 to 6.5.3.
- [Release notes](https://github.com/indutny/elliptic/releases)
- [Commits](indutny/elliptic@v6.3.1...v6.5.3)

Signed-off-by: dependabot[bot] <[email protected]>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Update dependencies using 'npm audit fix'

* Do not pass URL as separate parameter

This is not supported in Node.js 8 and 9.

* Downgrade tsd to support Node.js 8 and 9

See https://github.com/SamVerschueren/tsd/releases/tag/v0.12.1

* Correct type definition for Upload#terminate (#217)

inconsistency between typescript typing and function definition

* Minor cleanups

Co-authored-by: Dragos Cirjan <[email protected]>
Co-authored-by: Dragos Cirjan <[email protected]>
Co-authored-by: Dragos Cirjan <[email protected]>
Co-authored-by: Marius <[email protected]>
Co-authored-by: Vincent Petry <[email protected]>
Co-authored-by: Marius <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Kevin van Zonneveld <[email protected]>
Co-authored-by: kabaliserv <[email protected]>

Author: 9 people

docs/api.md

@@ -227,6 +227,18 @@ onBeforeRequest: function (req) {
 }
 ```
 
+You can also return a Promise if you need to perform some calculations before the request is sent:
+
+```js
+onBeforeRequest: function (req) {
+    return new Promise(resolve => {
+        var xhr = req.getUnderlyingObect()
+        xhr.withCredentials = true
+        resolve()
+    })
+}
+```
+
 #### onAfterResponse
 
 *Default value:* `null`
@@ -241,6 +253,19 @@ onAfterResponse: function (req, res) {
 }
 ```
 
+You can also return a Promise if you need to perform some calculations before tus-js-client processes the response:
+
+```js
+onAfterResponse: function (req, res) {
+    return new Promise(resolve => {
+        var url = req.getURL()
+        var value = res.getHeader("X-My-Header")
+        console.log(`Request for ${url} responded with ${value}`)
+        resolve()
+    })
+}
+```
+
 #### httpStack
 
 *Default value:* Environment-specific implementation

lib/upload.js

@@ -834,18 +834,20 @@ class BaseUpload {
    * @api private
    */
   _sendRequest(req, body = null) {
-    if (typeof this.options.onBeforeRequest === "function") {
-      this.options.onBeforeRequest(req);
-    }
-
-    return req.send(body)
-      .then((res) => {
-        if (typeof this.options.onAfterResponse === "function") {
-          this.options.onAfterResponse(req, res);
-        }
-
-        return res;
-      });
+    const onBeforeRequestPromise = (typeof this.options.onBeforeRequest === "function")
+      ? Promise.resolve(this.options.onBeforeRequest(req))
+      : Promise.resolve();
+
+    return onBeforeRequestPromise.then(() => {
+      return req.send(body)
+        .then((res) => {
+          const onAfterResponsePromise = (typeof this.options.onAfterResponse === "function")
+            ? Promise.resolve(this.options.onAfterResponse(req, res))
+            : Promise.resolve();
+
+          return onAfterResponsePromise.then(() => res);
+        });
+    });
   }
 }
 

test/spec/test-common.js

@@ -1248,5 +1248,52 @@ describe("tus", function () {
       expect(options.onError).not.toHaveBeenCalled();
       expect(options.onSuccess).toHaveBeenCalled();
     });
+
+    it("should invoke the request and response Promises", async function () {
+      const testStack = new TestHttpStack();
+      var file = getBlob("hello world");
+      var options = {
+        httpStack: testStack,
+        uploadUrl: "http://tus.io/uploads/foo",
+        onBeforeRequest: function (req) {
+          return new Promise(resolve => {
+            expect(req.getURL()).toBe("http://tus.io/uploads/foo");
+            expect(req.getMethod()).toBe("HEAD");
+            resolve();
+          });
+        },
+        onAfterResponse: function (req, res) {
+          return new Promise(resolve => {
+            expect(req.getURL()).toBe("http://tus.io/uploads/foo");
+            expect(req.getMethod()).toBe("HEAD");
+            expect(res.getStatus()).toBe(204);
+            expect(res.getHeader("Upload-Offset")).toBe(11);
+            resolve();
+          });
+        },
+        onSuccess: waitableFunction("onSuccess")
+      };
+      spyOn(options, "onBeforeRequest");
+      spyOn(options, "onAfterResponse");
+
+      var upload = new tus.Upload(file, options);
+      upload.start();
+
+      var req = await testStack.nextRequest();
+      expect(req.url).toBe("http://tus.io/uploads/foo");
+      expect(req.method).toBe("HEAD");
+
+      req.respondWith({
+        status: 204,
+        responseHeaders: {
+          "Upload-Offset": 11,
+          "Upload-Length": 11
+        }
+      });
+
+      await options.onSuccess.toBeCalled;
+      expect(options.onBeforeRequest).toHaveBeenCalled();
+      expect(options.onAfterResponse).toHaveBeenCalled();
+    });
   });
 });