feat(http): allow lazy (cancellable) requests

PR #388 ISSUES CLOSED: #355
cyclejs · Aug 15, 2016 · 2417bd6 · 2417bd6
1 parent 3ea362d
commit 2417bd6
Show file tree

Hide file tree

Showing 11 changed files with 278 additions and 4 deletions.
diff --git a/http/src/MainHTTPSource.js b/http/src/MainHTTPSource.js
diff --git a/http/src/MainHTTPSource.js.map b/http/src/MainHTTPSource.js.map
diff --git a/http/src/http-driver.js b/http/src/http-driver.js
diff --git a/http/src/http-driver.js.map b/http/src/http-driver.js.map
diff --git a/http/src/http-driver.ts b/http/src/http-driver.ts
@@ -128,14 +128,17 @@ function normalizeRequestInput(reqOptions: RequestInput): RequestOptions {
 function makeRequestInputToResponse$(runStreamAdapter: StreamAdapter) {
   return function requestInputToResponse$(reqInput: RequestInput): MemoryStream<Response> & ResponseStream {
     let response$ = createResponse$(reqInput).remember();
-    /* tslint:disable:no-empty */
-    response$.addListener({next: () => {}, error: () => {}, complete: () => {}});
-    /* tslint:enable:no-empty */
+    let reqOptions = softNormalizeRequestInput(reqInput);
+    if (!reqOptions.lazy) {
+      /* tslint:disable:no-empty */
+      response$.addListener({next: () => {}, error: () => {}, complete: () => {}});
+      /* tslint:enable:no-empty */
+    }
     response$ = (runStreamAdapter) ?
       runStreamAdapter.adapt(response$, XStreamAdapter.streamSubscribe) :
       response$;
     Object.defineProperty(response$, 'request', <PropertyDescriptor> {
-      value: softNormalizeRequestInput(reqInput),
+      value: reqOptions,
       writable: false,
     });
     return <MemoryStream<Response> & ResponseStream> response$;

diff --git a/http/src/interfaces.js b/http/src/interfaces.js
diff --git a/http/src/interfaces.js.map b/http/src/interfaces.js.map
diff --git a/http/src/interfaces.ts b/http/src/interfaces.ts
@@ -20,6 +20,7 @@ export interface RequestOptions {
   withCredentials?: boolean;
   redirects?: number;
   category?: string;
+  lazy?: boolean;
   _error?: any;
   _namespace?: Array<string>;
 }

diff --git a/http/src/isolate.js b/http/src/isolate.js
diff --git a/http/src/isolate.js.map b/http/src/isolate.js.map
diff --git a/http/test/node.js b/http/test/node.js
@@ -39,6 +39,61 @@ describe('HTTP Driver in Node.js', function () {
     }
   );
 
+  it('should not auto-execute lazy request without listening to response stream',
+    function(done) {
+      function main() {
+        return {
+          HTTP: Rx.Observable.of({
+            url: uri + '/pet',
+            method: 'POST',
+            send: {name: 'Woof', species: 'Dog'},
+            lazy: true
+          })
+        }
+      }
+
+      var output = Cycle(main, { HTTP: makeHTTPDriver() });
+      globalSandbox.petPOSTResponse = null;
+      output.run();
+
+      setTimeout(function () {
+        assert.strictEqual(globalSandbox.petPOSTResponse, null);
+        done();
+      }, 250);
+    }
+  );
+
+  it('should execute lazy HTTP request when listening to response stream',
+    function(done) {
+      function main() {
+        return {
+          HTTP: Rx.Observable.of({
+            url: uri + '/pet',
+            method: 'POST',
+            send: {name: 'Woof', species: 'Dog'},
+            lazy: true
+          })
+        }
+      }
+
+      var output = Cycle(main, { HTTP: makeHTTPDriver() });
+      globalSandbox.petPOSTResponse = null;
+
+      output.sources.HTTP.response$$
+        .mergeAll()
+        .subscribe();
+
+      output.run();
+
+      setTimeout(function () {
+        assert.notStrictEqual(globalSandbox.petPOSTResponse, null);
+        assert.strictEqual(globalSandbox.petPOSTResponse, 'added Woof the Dog');
+        globalSandbox.petPOSTResponse = null;
+        done();
+      }, 250);
+    }
+  );
+
   it('should add request options object to each response',
     function(done) {
       function main() {