iron-ajax.html 22 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675
<!doctype html>
<!--
Copyright (c) 2015 The Polymer Project Authors. All rights reserved.
This code may only be used under the BSD style license found at http://polymer.github.io/LICENSE.txt
The complete set of authors may be found at http://polymer.github.io/AUTHORS.txt
The complete set of contributors may be found at http://polymer.github.io/CONTRIBUTORS.txt
Code distributed by Google as part of the polymer project is also
subject to an additional IP rights grant found at http://polymer.github.io/PATENTS.txt
-->
<html>
<head>
  <title>iron-ajax</title>

  <script src="../../webcomponentsjs/webcomponents.js"></script>
  <script src="../../web-component-tester/browser.js"></script>
  <script src="../../test-fixture/test-fixture-mocha.js"></script>

  <link rel="import" href="../../polymer/polymer.html">
  <link rel="import" href="../../promise-polyfill/promise-polyfill.html">
  <link rel="import" href="../../test-fixture/test-fixture.html">
  <link rel="import" href="../iron-ajax.html">
</head>
<body>
  <test-fixture id="TrivialGet">
    <template>
      <iron-ajax url="/responds_to_get_with_json"></iron-ajax>
    </template>
  </test-fixture>
  <test-fixture id="ParamsGet">
    <template>
      <iron-ajax url="/responds_to_get_with_json"
                 params='{"a": "a"}'></iron-ajax>
    </template>
  </test-fixture>
  <test-fixture id="AutoGet">
    <template>
      <iron-ajax auto url="/responds_to_get_with_json"></iron-ajax>
    </template>
  </test-fixture>
  <test-fixture id="GetEcho">
    <template>
      <iron-ajax handle-as="json" url="/echoes_request_url"></iron-ajax>
    </template>
  </test-fixture>
  <test-fixture id="TrivialPost">
    <template>
      <iron-ajax method="POST"
                 url="/responds_to_post_with_json"></iron-ajax>
    </template>
  </test-fixture>
  <test-fixture id="DebouncedGet">
    <template>
      <iron-ajax auto
                 url="/responds_to_debounced_get_with_json"
                 debounce-duration="150"></iron-ajax>
    </template>
  </test-fixture>
  <!-- note(rictic):
       This makes us dependent on a third-party server, but we need to be able
       to check what headers the browser actually sends on the wire.
       If necessary we can spin up our own httpbin server, as the code is open
       source.
    -->
  <test-fixture id="RealPost">
    <template>
      <iron-ajax method="POST" url="http://httpbin.org/post"></iron-ajax>
    </template>
  </test-fixture>
  <script>
    suite('<iron-ajax>', function () {
      var responseHeaders = {
        json: { 'Content-Type': 'application/json' },
        plain: { 'Content-Type': 'text/plain' }
      };
      var ajax;
      var request;
      var server;

      function timePasses(ms) {
        return new Promise(function(resolve) {
          window.setTimeout(function() {
            resolve();
          }, ms);
        });
      }

      setup(function() {
        server = sinon.fakeServer.create();
        server.respondWith(
          'GET',
          /\/responds_to_get_with_json.*/,
          [
            200,
            responseHeaders.json,
            '{"success":true}'
          ]
        );

        server.respondWith(
          'POST',
          '/responds_to_post_with_json',
          [
            200,
            responseHeaders.json,
            '{"post_success":true}'
          ]
        );

        server.respondWith(
          'GET',
          '/responds_to_get_with_text',
          [
            200,
            responseHeaders.plain,
            'Hello World'
          ]
        );

        server.respondWith(
          'GET',
          '/responds_to_debounced_get_with_json',
          [
            200,
            responseHeaders.json,
            '{"success": "true"}'
          ]
        );

        ajax = fixture('TrivialGet');
      });

      teardown(function() {
        server.restore();
      });

      // Echo requests are responded to individually and on demand, unlike the
      // others in this file which are responded to with server.respond(),
      // which responds to all open requests.
      // We don't use server.respondWith here because there's no way to use it
      // and only respond to a subset of requests.
      // This way we can test for delayed and out of order responses and
      // distinquish them by their responses.
      function respondToEchoRequest(request) {
        request.respond(200, responseHeaders.json, JSON.stringify({
          url: request.url
        }));
      }

      suite('when making simple GET requests for JSON', function() {
        test('has sane defaults that love you', function() {
          request = ajax.generateRequest();

          server.respond();

          expect(request.response).to.be.ok;
          expect(request.response).to.be.an('object');
          expect(request.response.success).to.be.equal(true);
        });

        test('will be asynchronous by default', function() {
          expect(ajax.toRequestOptions().async).to.be.eql(true);
        });
      });

      suite('when setting custom headers', function() {
        test('are present in the request headers', function() {
          ajax.headers['custom-header'] = 'valid';
          var options = ajax.toRequestOptions();

          expect(options.headers).to.be.ok;
          expect(options.headers['custom-header']).to.be.an('string');
          expect(options.headers.hasOwnProperty('custom-header')).to.be.equal(
              true);
        });

        test('non-objects in headers are not applied', function() {
          ajax.headers = 'invalid';
          var options = ajax.toRequestOptions();

          expect(Object.keys(options.headers).length).to.be.equal(0);
        });
      });

      suite('when properties are changed', function() {
        test('generates simple-request elements that reflect the change', function() {
          request = ajax.generateRequest();

          expect(request.xhr.method).to.be.equal('GET');

          ajax.method = 'POST';
          ajax.url = '/responds_to_post_with_json';

          request = ajax.generateRequest();

          expect(request.xhr.method).to.be.equal('POST');
        });
      });

      suite('when generating a request', function() {
        test('yields an iron-request instance', function() {
          var IronRequest = document.createElement('iron-request').constructor;

          expect(ajax.generateRequest()).to.be.instanceOf(IronRequest);
        });

        test('reflects the loading state in the `loading` property', function() {
          var request = ajax.generateRequest();

          expect(ajax.loading).to.be.equal(true);

          server.respond();

          return request.completes.then(function() {
            return timePasses(1);
          }).then(function() {
            expect(ajax.loading).to.be.equal(false);
          });
        });
      });

      suite('when there are multiple requests', function() {
        var requests;
        var echoAjax;
        var promiseAllComplete;

        setup(function() {
          echoAjax = fixture('GetEcho');
          requests = [];

          for (var i = 0; i < 3; ++i) {
            echoAjax.params = {'order': i + 1};
            requests.push(echoAjax.generateRequest());
          }
          var allPromises = requests.map(function(r){return r.completes});
          promiseAllComplete = Promise.all(allPromises);
        });

        test('holds all requests in the `activeRequests` Array', function() {
          expect(requests).to.deep.eql(echoAjax.activeRequests);
        });

        test('empties `activeRequests` when requests are completed', function() {
          expect(echoAjax.activeRequests.length).to.be.equal(3);
          for (var i = 0; i < 3; i++) {
            respondToEchoRequest(server.requests[i]);
          }
          return promiseAllComplete.then(function() {
            return timePasses(1);
          }).then(function() {
            expect(echoAjax.activeRequests.length).to.be.equal(0);
          });
        });

        test('avoids race conditions with last response', function() {
          expect(echoAjax.lastResponse).to.be.equal(undefined);

          // Resolving the oldest request doesn't update lastResponse.
          respondToEchoRequest(server.requests[0]);
          return requests[0].completes.then(function() {
            expect(echoAjax.lastResponse).to.be.equal(undefined);

            // Resolving the most recent request does!
            respondToEchoRequest(server.requests[2]);
            return requests[2].completes;
          }).then(function() {
            expect(echoAjax.lastResponse).to.be.deep.eql(
                {url: '/echoes_request_url?order=3'});


            // Resolving an out of order stale request after does nothing!
            respondToEchoRequest(server.requests[1]);
            return requests[1].completes;
          }).then(function() {
            expect(echoAjax.lastResponse).to.be.deep.eql(
                {url: '/echoes_request_url?order=3'});
          });
        });

        test('`loading` is true while the last one is loading', function() {
          expect(echoAjax.loading).to.be.equal(true);

          respondToEchoRequest(server.requests[0]);
          return requests[0].completes.then(function() {
            // We're still loading because requests[2] is the most recently
            // made request.
            expect(echoAjax.loading).to.be.equal(true);

            respondToEchoRequest(server.requests[2]);
            return requests[2].completes;
          }).then(function() {
            // Now we're done loading.
            expect(echoAjax.loading).to.be.eql(false);

            // Resolving an out of order stale request after should have
            // no effect.
            respondToEchoRequest(server.requests[1]);
            return requests[1].completes;
          }).then(function() {
            expect(echoAjax.loading).to.be.eql(false);
          });
        });
      });

      suite('when params are changed', function() {
        test('generates a request that reflects the change', function() {
          ajax = fixture('ParamsGet');
          request = ajax.generateRequest();

          expect(request.xhr.url).to.be.equal('/responds_to_get_with_json?a=a');

          ajax.params = {b: 'b'};
          request = ajax.generateRequest();

          expect(request.xhr.url).to.be.equal('/responds_to_get_with_json?b=b');
        });
      });

      suite('when `auto` is enabled', function() {
        setup(function() {
          ajax = fixture('AutoGet');
        });

        test('automatically generates new requests', function() {
          return new Promise(function(resolve) {
            ajax.addEventListener('request', function() {
              resolve();
            });
          });
        });

        test('does not send requests if url is not a string', function() {
          return new Promise(function(resolve, reject) {
            ajax.addEventListener('request', function() {
              reject('A request was generated but url is null!');
            });

            ajax.url = null;
            ajax.handleAs = 'text';

            Polymer.Base.async(function() {
              resolve();
            }, 1);
          });
        });

        test('deduplicates multiple changes to a single request', function() {
          return new Promise(function(resolve, reject) {
            ajax.addEventListener('request', function() {
              server.respond();
            });

            ajax.addEventListener('response', function() {
              try {
                expect(ajax.activeRequests.length).to.be.eql(1);
                resolve()
              } catch (e) {
                reject(e);
              }
            });

            ajax.handleas = 'text';
            ajax.params = { foo: 'bar' };
            ajax.headers = { 'X-Foo': 'Bar' };
          });
        });
        
        test('automatically generates new request when a sub-property of params is changed', function(done) {
          ajax.addEventListener('request', function() {
            server.respond();
          });
          
          ajax.params = { foo: 'bar' };
          ajax.addEventListener('response', function() {
            ajax.addEventListener('request', function() {
              done();
            });
            
            ajax.set('params.foo', 'xyz');
          });
        });
      });

      suite('the last response', function() {
        setup(function() {
          request = ajax.generateRequest();
          server.respond();
        });

        test('is accessible as a readonly property', function() {
          return request.completes.then(function (request) {
            expect(ajax.lastResponse).to.be.equal(request.response);
          });
        });


        test('updates with each new response', function() {
          return request.completes.then(function(request) {

            expect(request.response).to.be.an('object');
            expect(ajax.lastResponse).to.be.equal(request.response);

            ajax.handleAs = 'text';
            request = ajax.generateRequest();
            server.respond();

            return request.completes;
          }).then(function(request) {
            expect(request.response).to.be.a('string');
            expect(ajax.lastResponse).to.be.equal(request.response);
          });
        });
      });

      suite('when making POST requests', function() {
        setup(function() {
          ajax = fixture('TrivialPost');
        });

        test('POSTs the value of the `body` attribute', function() {
          var requestBody = JSON.stringify({foo: 'bar'});

          ajax.body = requestBody;
          ajax.generateRequest();

          expect(server.requests[0]).to.be.ok;
          expect(server.requests[0].requestBody).to.be.equal(requestBody);
        });

        test('if `contentType` is set to form encode, the body is encoded',function() {
          ajax.body = {foo: 'bar\nbip', 'biz bo': 'baz blar'};
          ajax.contentType = 'application/x-www-form-urlencoded';
          ajax.generateRequest();

          expect(server.requests[0]).to.be.ok;
          expect(server.requests[0].requestBody).to.be.equal(
              'foo=bar%0D%0Abip&biz+bo=baz+blar');
        });

        test('if `contentType` is json, the body is json encoded', function() {
          var requestObj = {foo: 'bar', baz: [1,2,3]}
          ajax.body = requestObj;
          ajax.contentType = 'application/json';
          ajax.generateRequest();

          expect(server.requests[0]).to.be.ok;
          expect(server.requests[0].requestBody).to.be.equal(
              JSON.stringify(requestObj));
        });

        suite('the examples in the documentation work', function() {
          test('json content, body attribute is an object', function() {
            ajax.setAttribute('body', '{"foo": "bar baz", "x": 1}');
            ajax.contentType = 'application/json';
            ajax.generateRequest();

            expect(server.requests[0]).to.be.ok;
            expect(server.requests[0].requestBody).to.be.equal(
                '{"foo":"bar baz","x":1}');
          });

          test('form content, body attribute is an object', function() {
            ajax.setAttribute('body', '{"foo": "bar baz", "x": 1}');
            ajax.contentType = 'application/x-www-form-urlencoded';
            ajax.generateRequest();

            expect(server.requests[0]).to.be.ok;
            expect(server.requests[0].requestBody).to.be.equal(
                'foo=bar+baz&x=1');
          });
        });

        suite('and `contentType` is explicitly set to form encode', function() {
          test('we encode a custom object', function() {
            function Foo(bar) { this.bar = bar };
            var requestObj = new Foo('baz');
            ajax.body = requestObj;
            ajax.contentType = 'application/x-www-form-urlencoded';
            ajax.generateRequest();

            expect(server.requests[0]).to.be.ok;
            expect(server.requests[0].requestBody).to.be.equal('bar=baz');
          });
        })

        suite('and `contentType` isn\'t set', function() {
          test('we don\'t try to encode an ArrayBuffer', function() {
            var requestObj = new ArrayBuffer()
            ajax.body = requestObj;
            ajax.generateRequest();

            expect(server.requests[0]).to.be.ok;
            // We give the browser the ArrayBuffer directly, without trying
            // to encode it.
            expect(server.requests[0].requestBody).to.be.equal(requestObj);
          });
        })
      });

      suite('when debouncing requests', function() {
        setup(function() {
          ajax = fixture('DebouncedGet');
        });

        test('only requests a single resource', function() {
          ajax._requestOptionsChanged();
          expect(server.requests[0]).to.be.equal(undefined);
          ajax._requestOptionsChanged();
          return timePasses(200).then(function() {
            expect(server.requests[0]).to.be.ok;
          });
        });
      });

      suite('when a response handler is bound', function() {
        var responseHandler;

        setup(function() {
          responseHandler = sinon.spy();
          ajax.addEventListener('response', responseHandler);
        });

        test('calls the handler after every response', function() {
          ajax.generateRequest();
          ajax.generateRequest();

          server.respond();

          return ajax.lastRequest.completes.then(function() {
            expect(responseHandler.callCount).to.be.equal(2);
          });
        });
      });

      suite('when the response type is `json`', function() {
        setup(function() {
          server.restore();
        });

        test('finds the JSON on any platform', function() {
          ajax.url = '../bower.json';
          request = ajax.generateRequest();
          return request.completes.then(function() {
            expect(ajax.lastResponse).to.be.instanceOf(Object);
          });
        });
      });

      suite('when handleAs parameter is `text`', function() {

        test('response type is string', function () {
          ajax.url = '/responds_to_get_with_json';
          ajax.handleAs = 'text';

          request = ajax.generateRequest();
          var promise = request.completes.then(function () {
            expect(typeof(ajax.lastResponse)).to.be.equal('string');
          });

          server.respond();

          return promise;
        });

      });

      suite('when a request fails', function() {
        test('we give an error with useful details', function() {
          ajax.url = '/responds_to_get_with_text';
          ajax.handleAs = 'json';
          var eventFired = false;
          ajax.addEventListener('error', function(event) {
            expect(event.detail.request).to.be.okay;
            expect(event.detail.error).to.be.okay;
            eventFired = true;
          });
          var promise = ajax.generateRequest().completes.then(function() {
            throw new Error('Expected the request to fail!');
          }, function(error) {
            expect(error).to.be.instanceof(Error);
            return timePasses(100);
          }).then(function() {
            expect(eventFired).to.be.eq(true);
          });

          server.respond();

          return promise;
        });
      });

      suite('when handleAs parameter is `json`', function() {

        test('response type is string', function () {
          ajax.url = '/responds_to_get_with_json';
          ajax.handleAs = 'json';

          request = ajax.generateRequest();
          var promise = request.completes.then(function () {
            expect(typeof(ajax.lastResponse)).to.be.equal('object');
          });

          server.respond();

          return promise;
        });

      });

      suite('when making a POST over the wire', function() {
        test('FormData is handled correctly', function() {
          server.restore();
          var requestBody = new FormData();
          requestBody.append('a', 'foo');
          requestBody.append('b', 'bar');

          var ajax = fixture('RealPost');
          ajax.body = requestBody;
          return ajax.generateRequest().completes.then(function() {
            expect(ajax.lastResponse.headers['Content-Type']).to.match(
                /^multipart\/form-data; boundary=.*$/);

            expect(ajax.lastResponse.form.a).to.be.equal('foo');
            expect(ajax.lastResponse.form.b).to.be.equal('bar');
          });
        });

        test('json is handled correctly', function() {
          server.restore();
          var ajax = fixture('RealPost');
          ajax.body = JSON.stringify({a: 'foo', b: 'bar'});
          ajax.contentType = 'application/json';
          return ajax.generateRequest().completes.then(function() {
            expect(ajax.lastResponse.headers['Content-Type']).to.match(
                /^application\/json(;.*)?$/);
            expect(ajax.lastResponse.json.a).to.be.equal('foo');
            expect(ajax.lastResponse.json.b).to.be.equal('bar');
          });
        });

        test('urlencoded data is handled correctly', function() {
          server.restore();
          var ajax = fixture('RealPost');
          ajax.body = 'a=foo&b=bar';
          return ajax.generateRequest().completes.then(function() {
            expect(ajax.lastResponse.headers['Content-Type']).to.match(
                /^application\/x-www-form-urlencoded(;.*)?$/);

            expect(ajax.lastResponse.form.a).to.be.equal('foo');
            expect(ajax.lastResponse.form.b).to.be.equal('bar');
          });
        });

        test('xml is handled correctly', function() {
          server.restore();
          var ajax = fixture('RealPost');

          var xmlDoc = document.implementation.createDocument(
              null, "foo", null);
          var node = xmlDoc.createElement("bar");
          node.setAttribute("name" , "baz");
          xmlDoc.documentElement.appendChild(node);
          ajax.body = xmlDoc;
          return ajax.generateRequest().completes.then(function() {
            expect(ajax.lastResponse.headers['Content-Type']).to.match(
                /^application\/xml(;.*)?$/);
            expect(ajax.lastResponse.data).to.match(
                /<foo\s*><bar\s+name="baz"\s*\/><\/foo\s*>/);
          });
        });
      });
    });
  </script>

</body>
</html>