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 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326
|
// Copyright 2009 The Closure Library Authors. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS-IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
goog.provide('goog.net.BrowserChannelTest');
goog.setTestOnly('goog.net.BrowserChannelTest');
goog.require('goog.Timer');
goog.require('goog.array');
goog.require('goog.dom');
goog.require('goog.functions');
goog.require('goog.json');
goog.require('goog.net.BrowserChannel');
goog.require('goog.net.ChannelDebug');
goog.require('goog.net.ChannelRequest');
goog.require('goog.net.tmpnetwork');
goog.require('goog.structs.Map');
goog.require('goog.testing.MockClock');
goog.require('goog.testing.PropertyReplacer');
goog.require('goog.testing.asserts');
goog.require('goog.testing.jsunit');
goog.require('goog.testing.recordFunction');
/**
* Delay between a network failure and the next network request.
*/
var RETRY_TIME = 1000;
/**
* A really long time - used to make sure no more timeouts will fire.
*/
var ALL_DAY_MS = 1000 * 60 * 60 * 24;
var stubs = new goog.testing.PropertyReplacer();
var browserChannel;
var deliveredMaps;
var handler;
var mockClock;
var gotError;
var numStatEvents;
var lastStatEvent;
var numTimingEvents;
var lastPostSize;
var lastPostRtt;
var lastPostRetryCount;
// Set to true to see the channel debug output in the browser window.
var debug = false;
// Debug message to print out when debug is true.
var debugMessage = '';
function debugToWindow(message) {
if (debug) {
debugMessage += message + '<br>';
goog.dom.getElement('debug').innerHTML = debugMessage;
}
}
/**
* Stubs goog.net.tmpnetwork to always time out. It maintains the
* contract given by goog.net.tmpnetwork.testGoogleCom, but always
* times out (calling callback(false)).
*
* stubTmpnetwork should be called in tests that require it before
* a call to testGoogleCom happens. It is reset at tearDown.
*/
function stubTmpnetwork() {
stubs.set(
goog.net.tmpnetwork, 'testLoadImage', function(url, timeout, callback) {
goog.Timer.callOnce(goog.partial(callback, false), timeout);
});
}
/**
* Mock ChannelRequest.
* @constructor
*/
var MockChannelRequest = function(
channel, channelDebug, opt_sessionId, opt_requestId, opt_retryId) {
this.channel_ = channel;
this.channelDebug_ = channelDebug;
this.sessionId_ = opt_sessionId;
this.requestId_ = opt_requestId;
this.successful_ = true;
this.lastError_ = null;
this.lastStatusCode_ = 200;
// For debugging, keep track of whether this is a back or forward channel.
this.isBack = !!(opt_requestId == 'rpc');
this.isForward = !this.isBack;
};
MockChannelRequest.prototype.postData_ = null;
MockChannelRequest.prototype.requestStartTime_ = null;
MockChannelRequest.prototype.requestUri_ = null;
MockChannelRequest.prototype.setExtraHeaders = function(extraHeaders) {};
MockChannelRequest.prototype.setTimeout = function(timeout) {};
MockChannelRequest.prototype.setReadyStateChangeThrottle = function(throttle) {
};
MockChannelRequest.prototype.xmlHttpPost = function(
uri, postData, decodeChunks) {
this.channelDebug_.debug(
'---> POST: ' + uri + ', ' + postData + ', ' + decodeChunks);
this.postData_ = postData;
this.requestStartTime_ = goog.now();
};
MockChannelRequest.prototype.xmlHttpGet = function(
uri, decodeChunks, opt_noClose) {
this.channelDebug_.debug(
'<--- GET: ' + uri + ', ' + decodeChunks + ', ' + opt_noClose);
this.requestUri_ = uri;
this.requestStartTime_ = goog.now();
};
MockChannelRequest.prototype.tridentGet = function(uri, usingSecondaryDomain) {
this.channelDebug_.debug('<---GET (T): ' + uri);
this.requestUri_ = uri;
this.requestStartTime_ = goog.now();
};
MockChannelRequest.prototype.sendUsingImgTag = function(uri) {
this.requestStartTime_ = goog.now();
};
MockChannelRequest.prototype.cancel = function() {
this.successful_ = false;
};
MockChannelRequest.prototype.getSuccess = function() {
return this.successful_;
};
MockChannelRequest.prototype.getLastError = function() {
return this.lastError_;
};
MockChannelRequest.prototype.getLastStatusCode = function() {
return this.lastStatusCode_;
};
MockChannelRequest.prototype.getSessionId = function() {
return this.sessionId_;
};
MockChannelRequest.prototype.getRequestId = function() {
return this.requestId_;
};
MockChannelRequest.prototype.getPostData = function() {
return this.postData_;
};
MockChannelRequest.prototype.getRequestStartTime = function() {
return this.requestStartTime_;
};
function setUpPage() {
// Use our MockChannelRequests instead of the real ones.
goog.net.BrowserChannel.createChannelRequest = function(
channel, channelDebug, opt_sessionId, opt_requestId, opt_retryId) {
return new MockChannelRequest(
channel, channelDebug, opt_sessionId, opt_requestId, opt_retryId);
};
// Mock out the stat notification code.
goog.net.BrowserChannel.notifyStatEvent = function(stat) {
numStatEvents++;
lastStatEvent = stat;
};
goog.net.BrowserChannel.notifyTimingEvent = function(size, rtt, retries) {
numTimingEvents++;
lastPostSize = size;
lastPostRtt = rtt;
lastPostRetryCount = retries;
};
}
function setUp() {
numTimingEvents = 0;
lastPostSize = null;
lastPostRtt = null;
lastPostRetryCount = null;
mockClock = new goog.testing.MockClock(true);
browserChannel = new goog.net.BrowserChannel('1');
gotError = false;
handler = new goog.net.BrowserChannel.Handler();
handler.channelOpened = function() {};
handler.channelError = function(channel, error) { gotError = true; };
handler.channelSuccess = function(channel, maps) {
deliveredMaps = goog.array.clone(maps);
};
handler.channelClosed = function(
channel, opt_pendingMaps, opt_undeliveredMaps) {
// Mock out the handler, and let it set a formatted user readable string
// of the undelivered maps which we can use when verifying our assertions.
if (opt_pendingMaps) {
this.pendingMapsString = formatArrayOfMaps(opt_pendingMaps);
}
if (opt_undeliveredMaps) {
this.undeliveredMapsString = formatArrayOfMaps(opt_undeliveredMaps);
}
};
handler.channelHandleMultipleArrays = function() {};
handler.channelHandleArray = function() {};
browserChannel.setHandler(handler);
// Provide a predictable retry time for testing.
browserChannel.getRetryTime_ = function(retryCount) { return RETRY_TIME; };
var channelDebug = new goog.net.ChannelDebug();
channelDebug.debug = function(message) { debugToWindow(message); };
browserChannel.setChannelDebug(channelDebug);
numStatEvents = 0;
lastStatEvent = null;
}
function tearDown() {
mockClock.dispose();
stubs.reset();
debugToWindow('<hr>');
}
/**
* Helper function to return a formatted string representing an array of maps.
*/
function formatArrayOfMaps(arrayOfMaps) {
var result = [];
for (var i = 0; i < arrayOfMaps.length; i++) {
var map = arrayOfMaps[i];
var keys = map.map.getKeys();
for (var j = 0; j < keys.length; j++) {
var tmp = keys[j] + ':' + map.map.get(keys[j]) +
(map.context ? ':' + map.context : '');
result.push(tmp);
}
}
return result.join(', ');
}
function testFormatArrayOfMaps() {
// This function is used in a non-trivial test, so let's verify that it works.
var map1 = new goog.structs.Map();
map1.set('k1', 'v1');
map1.set('k2', 'v2');
var map2 = new goog.structs.Map();
map2.set('k3', 'v3');
var map3 = new goog.structs.Map();
map3.set('k4', 'v4');
map3.set('k5', 'v5');
map3.set('k6', 'v6');
// One map.
var a = [];
a.push(new goog.net.BrowserChannel.QueuedMap(0, map1));
assertEquals('k1:v1, k2:v2', formatArrayOfMaps(a));
// Many maps.
var b = [];
b.push(new goog.net.BrowserChannel.QueuedMap(0, map1));
b.push(new goog.net.BrowserChannel.QueuedMap(0, map2));
b.push(new goog.net.BrowserChannel.QueuedMap(0, map3));
assertEquals(
'k1:v1, k2:v2, k3:v3, k4:v4, k5:v5, k6:v6', formatArrayOfMaps(b));
// One map with a context.
var c = [];
c.push(new goog.net.BrowserChannel.QueuedMap(0, map1, 'c1'));
assertEquals('k1:v1:c1, k2:v2:c1', formatArrayOfMaps(c));
}
function connectForwardChannel(
opt_serverVersion, opt_hostPrefix, opt_uriPrefix) {
var uriPrefix = opt_uriPrefix || '';
browserChannel.connect(uriPrefix + '/test', uriPrefix + '/bind', null);
mockClock.tick(0);
completeTestConnection();
completeForwardChannel(opt_serverVersion, opt_hostPrefix);
}
function connect(opt_serverVersion, opt_hostPrefix, opt_uriPrefix) {
connectForwardChannel(opt_serverVersion, opt_hostPrefix, opt_uriPrefix);
completeBackChannel();
}
function disconnect() {
browserChannel.disconnect();
mockClock.tick(0);
}
function completeTestConnection() {
completeForwardTestConnection();
completeBackTestConnection();
assertEquals(
goog.net.BrowserChannel.State.OPENING, browserChannel.getState());
}
function completeForwardTestConnection() {
browserChannel.connectionTest_.onRequestData(
browserChannel.connectionTest_, '["b"]');
browserChannel.connectionTest_.onRequestComplete(
browserChannel.connectionTest_);
mockClock.tick(0);
}
function completeBackTestConnection() {
browserChannel.connectionTest_.onRequestData(
browserChannel.connectionTest_, '11111');
mockClock.tick(0);
}
function completeForwardChannel(opt_serverVersion, opt_hostPrefix) {
var responseData = '[[0,["c","1234567890ABCDEF",' +
(opt_hostPrefix ? '"' + opt_hostPrefix + '"' : 'null') +
(opt_serverVersion ? ',' + opt_serverVersion : '') + ']]]';
browserChannel.onRequestData(
browserChannel.forwardChannelRequest_, responseData);
browserChannel.onRequestComplete(browserChannel.forwardChannelRequest_);
mockClock.tick(0);
}
function completeBackChannel() {
browserChannel.onRequestData(
browserChannel.backChannelRequest_, '[[1,["foo"]]]');
browserChannel.onRequestComplete(browserChannel.backChannelRequest_);
mockClock.tick(0);
}
function responseVersion7() {
browserChannel.onRequestData(
browserChannel.forwardChannelRequest_,
goog.net.ChannelDebug.MAGIC_RESPONSE_COOKIE);
browserChannel.onRequestComplete(browserChannel.forwardChannelRequest_);
mockClock.tick(0);
}
function responseNoBackchannel(lastArrayIdSentFromServer, outstandingDataSize) {
responseData =
goog.json.serialize([0, lastArrayIdSentFromServer, outstandingDataSize]);
browserChannel.onRequestData(
browserChannel.forwardChannelRequest_, responseData);
browserChannel.onRequestComplete(browserChannel.forwardChannelRequest_);
mockClock.tick(0);
}
function response(lastArrayIdSentFromServer, outstandingDataSize) {
responseData =
goog.json.serialize([1, lastArrayIdSentFromServer, outstandingDataSize]);
browserChannel.onRequestData(
browserChannel.forwardChannelRequest_, responseData);
browserChannel.onRequestComplete(browserChannel.forwardChannelRequest_);
mockClock.tick(0);
}
function receive(data) {
browserChannel.onRequestData(
browserChannel.backChannelRequest_, '[[1,' + data + ']]');
browserChannel.onRequestComplete(browserChannel.backChannelRequest_);
mockClock.tick(0);
}
function responseTimeout() {
browserChannel.forwardChannelRequest_lastError_ =
goog.net.ChannelRequest.Error.TIMEOUT;
browserChannel.forwardChannelRequest_.successful_ = false;
browserChannel.onRequestComplete(browserChannel.forwardChannelRequest_);
mockClock.tick(0);
}
function responseRequestFailed(opt_statusCode) {
browserChannel.forwardChannelRequest_.lastError_ =
goog.net.ChannelRequest.Error.STATUS;
browserChannel.forwardChannelRequest_.lastStatusCode_ = opt_statusCode || 503;
browserChannel.forwardChannelRequest_.successful_ = false;
browserChannel.onRequestComplete(browserChannel.forwardChannelRequest_);
mockClock.tick(0);
}
function responseUnknownSessionId() {
browserChannel.forwardChannelRequest_.lastError_ =
goog.net.ChannelRequest.Error.UNKNOWN_SESSION_ID;
browserChannel.forwardChannelRequest_.successful_ = false;
browserChannel.onRequestComplete(browserChannel.forwardChannelRequest_);
mockClock.tick(0);
}
function responseActiveXBlocked() {
browserChannel.backChannelRequest_.lastError_ =
goog.net.ChannelRequest.Error.ACTIVE_X_BLOCKED;
browserChannel.backChannelRequest_.successful_ = false;
browserChannel.onRequestComplete(browserChannel.backChannelRequest_);
mockClock.tick(0);
}
function sendMap(key, value, opt_context) {
var map = new goog.structs.Map();
map.set(key, value);
browserChannel.sendMap(map, opt_context);
mockClock.tick(0);
}
function hasForwardChannel() {
return !!browserChannel.forwardChannelRequest_;
}
function hasBackChannel() {
return !!browserChannel.backChannelRequest_;
}
function hasDeadBackChannelTimer() {
return goog.isDefAndNotNull(browserChannel.deadBackChannelTimerId_);
}
function assertHasForwardChannel() {
assertTrue('Forward channel missing.', hasForwardChannel());
}
function assertHasBackChannel() {
assertTrue('Back channel missing.', hasBackChannel());
}
function testConnect() {
connect();
assertEquals(goog.net.BrowserChannel.State.OPENED, browserChannel.getState());
// If the server specifies no version, the client assumes 6
assertEquals(6, browserChannel.channelVersion_);
assertFalse(browserChannel.isBuffered());
}
function testConnect_backChannelEstablished() {
connect();
assertHasBackChannel();
}
function testConnect_withServerHostPrefix() {
connect(undefined, 'serverHostPrefix');
assertEquals('serverHostPrefix', browserChannel.hostPrefix_);
}
function testConnect_withClientHostPrefix() {
handler.correctHostPrefix = function(hostPrefix) {
return 'clientHostPrefix';
};
connect();
assertEquals('clientHostPrefix', browserChannel.hostPrefix_);
}
function testConnect_overrideServerHostPrefix() {
handler.correctHostPrefix = function(hostPrefix) {
return 'clientHostPrefix';
};
connect(undefined, 'serverHostPrefix');
assertEquals('clientHostPrefix', browserChannel.hostPrefix_);
}
function testConnect_withServerVersion() {
connect(8);
assertEquals(8, browserChannel.channelVersion_);
}
function testConnect_notOkToMakeRequestForTest() {
handler.okToMakeRequest =
goog.functions.constant(goog.net.BrowserChannel.Error.NETWORK);
browserChannel.connect('/test', '/bind', null);
mockClock.tick(0);
assertEquals(goog.net.BrowserChannel.State.CLOSED, browserChannel.getState());
}
function testConnect_notOkToMakeRequestForBind() {
browserChannel.connect('/test', '/bind', null);
mockClock.tick(0);
completeTestConnection();
handler.okToMakeRequest =
goog.functions.constant(goog.net.BrowserChannel.Error.NETWORK);
completeForwardChannel();
assertEquals(goog.net.BrowserChannel.State.CLOSED, browserChannel.getState());
}
function testSendMap() {
connect();
assertEquals(1, numTimingEvents);
sendMap('foo', 'bar');
responseVersion7();
assertEquals(2, numTimingEvents);
assertEquals('foo:bar', formatArrayOfMaps(deliveredMaps));
}
function testSendMap_twice() {
connect();
sendMap('foo1', 'bar1');
responseVersion7();
assertEquals('foo1:bar1', formatArrayOfMaps(deliveredMaps));
sendMap('foo2', 'bar2');
responseVersion7();
assertEquals('foo2:bar2', formatArrayOfMaps(deliveredMaps));
}
function testSendMap_andReceive() {
connect();
sendMap('foo', 'bar');
responseVersion7();
receive('["the server reply"]');
}
function testReceive() {
connect();
receive('["message from server"]');
assertHasBackChannel();
}
function testReceive_twice() {
connect();
receive('["message one from server"]');
receive('["message two from server"]');
assertHasBackChannel();
}
function testReceive_andSendMap() {
connect();
receive('["the server reply"]');
sendMap('foo', 'bar');
responseVersion7();
assertHasBackChannel();
}
function testBackChannelRemainsEstablished_afterSingleSendMap() {
connect();
sendMap('foo', 'bar');
responseVersion7();
receive('["ack"]');
assertHasBackChannel();
}
function testBackChannelRemainsEstablished_afterDoubleSendMap() {
connect();
sendMap('foo1', 'bar1');
sendMap('foo2', 'bar2');
responseVersion7();
receive('["ack"]');
// This assertion would fail prior to CL 13302660.
assertHasBackChannel();
}
function testTimingEvent() {
connect();
assertEquals(1, numTimingEvents);
sendMap('', '');
assertEquals(1, numTimingEvents);
mockClock.tick(20);
var expSize = browserChannel.forwardChannelRequest_.getPostData().length;
responseVersion7();
assertEquals(2, numTimingEvents);
assertEquals(expSize, lastPostSize);
assertEquals(20, lastPostRtt);
assertEquals(0, lastPostRetryCount);
sendMap('abcdefg', '123456');
expSize = browserChannel.forwardChannelRequest_.getPostData().length;
responseTimeout();
assertEquals(2, numTimingEvents);
mockClock.tick(RETRY_TIME + 1);
responseVersion7();
assertEquals(3, numTimingEvents);
assertEquals(expSize, lastPostSize);
assertEquals(1, lastPostRetryCount);
assertEquals(1, lastPostRtt);
}
/**
* Make sure that dropping the forward channel retry limit below the retry count
* reports an error, and prevents another request from firing.
*/
function testSetFailFastWhileWaitingForRetry() {
stubTmpnetwork();
connect();
assertEquals(1, numTimingEvents);
sendMap('foo', 'bar');
assertNull(browserChannel.forwardChannelTimerId_);
assertNotNull(browserChannel.forwardChannelRequest_);
assertEquals(0, browserChannel.forwardChannelRetryCount_);
// Watchdog timeout.
responseTimeout();
assertNotNull(browserChannel.forwardChannelTimerId_);
assertNull(browserChannel.forwardChannelRequest_);
assertEquals(1, browserChannel.forwardChannelRetryCount_);
// Almost finish the between-retry timeout.
mockClock.tick(RETRY_TIME - 1);
assertNotNull(browserChannel.forwardChannelTimerId_);
assertNull(browserChannel.forwardChannelRequest_);
assertEquals(1, browserChannel.forwardChannelRetryCount_);
// Setting max retries to 0 should cancel the timer and raise an error.
browserChannel.setFailFast(true);
assertNull(browserChannel.forwardChannelTimerId_);
assertNull(browserChannel.forwardChannelRequest_);
assertEquals(1, browserChannel.forwardChannelRetryCount_);
assertTrue(gotError);
assertEquals(0, deliveredMaps.length);
// We get the error immediately before starting to ping google.com.
// Simulate that timing out. We should get a network error in addition to the
// initial failure.
gotError = false;
mockClock.tick(goog.net.tmpnetwork.GOOGLECOM_TIMEOUT);
assertTrue('No error after tmpnetwork ping timed out.', gotError);
// Make sure no more retry timers are firing.
mockClock.tick(ALL_DAY_MS);
assertNull(browserChannel.forwardChannelTimerId_);
assertNull(browserChannel.forwardChannelRequest_);
assertEquals(1, browserChannel.forwardChannelRetryCount_);
assertEquals(1, numTimingEvents);
}
/**
* Make sure that dropping the forward channel retry limit below the retry count
* reports an error, and prevents another request from firing.
*/
function testSetFailFastWhileRetryXhrIsInFlight() {
stubTmpnetwork();
connect();
assertEquals(1, numTimingEvents);
sendMap('foo', 'bar');
assertNull(browserChannel.forwardChannelTimerId_);
assertNotNull(browserChannel.forwardChannelRequest_);
assertEquals(0, browserChannel.forwardChannelRetryCount_);
// Watchdog timeout.
responseTimeout();
assertNotNull(browserChannel.forwardChannelTimerId_);
assertNull(browserChannel.forwardChannelRequest_);
assertEquals(1, browserChannel.forwardChannelRetryCount_);
// Wait for the between-retry timeout.
mockClock.tick(RETRY_TIME);
assertNull(browserChannel.forwardChannelTimerId_);
assertNotNull(browserChannel.forwardChannelRequest_);
assertEquals(1, browserChannel.forwardChannelRetryCount_);
// Simulate a second watchdog timeout.
responseTimeout();
assertNotNull(browserChannel.forwardChannelTimerId_);
assertNull(browserChannel.forwardChannelRequest_);
assertEquals(2, browserChannel.forwardChannelRetryCount_);
// Wait for another between-retry timeout.
mockClock.tick(RETRY_TIME);
// Now the third req is in flight.
assertNull(browserChannel.forwardChannelTimerId_);
assertNotNull(browserChannel.forwardChannelRequest_);
assertEquals(2, browserChannel.forwardChannelRetryCount_);
// Set fail fast, killing the request
browserChannel.setFailFast(true);
assertNull(browserChannel.forwardChannelTimerId_);
assertNull(browserChannel.forwardChannelRequest_);
assertEquals(2, browserChannel.forwardChannelRetryCount_);
assertTrue(gotError);
// We get the error immediately before starting to ping google.com.
// Simulate that timing out. We should get a network error in addition to the
gotError = false;
mockClock.tick(goog.net.tmpnetwork.GOOGLECOM_TIMEOUT);
assertTrue('No error after tmpnetwork ping timed out.', gotError);
// Make sure no more retry timers are firing.
mockClock.tick(ALL_DAY_MS);
assertNull(browserChannel.forwardChannelTimerId_);
assertNull(browserChannel.forwardChannelRequest_);
assertEquals(2, browserChannel.forwardChannelRetryCount_);
assertEquals(1, numTimingEvents);
}
/**
* Makes sure that setting fail fast while not retrying doesn't cause a failure.
*/
function testSetFailFastAtRetryCount() {
stubTmpnetwork();
connect();
assertEquals(1, numTimingEvents);
sendMap('foo', 'bar');
assertNull(browserChannel.forwardChannelTimerId_);
assertNotNull(browserChannel.forwardChannelRequest_);
assertEquals(0, browserChannel.forwardChannelRetryCount_);
// Set fail fast.
browserChannel.setFailFast(true);
// Request should still be alive.
assertNull(browserChannel.forwardChannelTimerId_);
assertNotNull(browserChannel.forwardChannelRequest_);
assertEquals(0, browserChannel.forwardChannelRetryCount_);
// Watchdog timeout. Now we should get an error.
responseTimeout();
assertNull(browserChannel.forwardChannelTimerId_);
assertNull(browserChannel.forwardChannelRequest_);
assertEquals(0, browserChannel.forwardChannelRetryCount_);
assertTrue(gotError);
// We get the error immediately before starting to ping google.com.
// Simulate that timing out. We should get a network error in addition to the
// initial failure.
gotError = false;
mockClock.tick(goog.net.tmpnetwork.GOOGLECOM_TIMEOUT);
assertTrue('No error after tmpnetwork ping timed out.', gotError);
// Make sure no more retry timers are firing.
mockClock.tick(ALL_DAY_MS);
assertNull(browserChannel.forwardChannelTimerId_);
assertNull(browserChannel.forwardChannelRequest_);
assertEquals(0, browserChannel.forwardChannelRetryCount_);
assertEquals(1, numTimingEvents);
}
function testRequestFailedClosesChannel() {
stubTmpnetwork();
connect();
assertEquals(1, numTimingEvents);
sendMap('foo', 'bar');
responseRequestFailed();
assertEquals(
'Should be closed immediately after request failed.',
goog.net.BrowserChannel.State.CLOSED, browserChannel.getState());
mockClock.tick(goog.net.tmpnetwork.GOOGLECOM_TIMEOUT);
assertEquals(
'Should remain closed after the ping timeout.',
goog.net.BrowserChannel.State.CLOSED, browserChannel.getState());
assertEquals(1, numTimingEvents);
}
function testStatEventReportedOnlyOnce() {
stubTmpnetwork();
connect();
sendMap('foo', 'bar');
numStatEvents = 0;
lastStatEvent = null;
responseUnknownSessionId();
assertEquals(1, numStatEvents);
assertEquals(goog.net.BrowserChannel.Stat.ERROR_OTHER, lastStatEvent);
numStatEvents = 0;
mockClock.tick(goog.net.tmpnetwork.GOOGLECOM_TIMEOUT);
assertEquals('No new stat events should be reported.', 0, numStatEvents);
}
function testActiveXBlockedEventReportedOnlyOnce() {
stubTmpnetwork();
connectForwardChannel();
numStatEvents = 0;
lastStatEvent = null;
responseActiveXBlocked();
assertEquals(1, numStatEvents);
assertEquals(goog.net.BrowserChannel.Stat.ERROR_OTHER, lastStatEvent);
mockClock.tick(goog.net.tmpnetwork.GOOGLECOM_TIMEOUT);
assertEquals('No new stat events should be reported.', 1, numStatEvents);
}
function testStatEventReportedOnlyOnce_onNetworkUp() {
stubTmpnetwork();
connect();
sendMap('foo', 'bar');
numStatEvents = 0;
lastStatEvent = null;
responseRequestFailed();
assertEquals(
'No stat event should be reported before we know the reason.', 0,
numStatEvents);
// Let the ping time out.
mockClock.tick(goog.net.tmpnetwork.GOOGLECOM_TIMEOUT);
// Assert we report the correct stat event.
assertEquals(1, numStatEvents);
assertEquals(goog.net.BrowserChannel.Stat.ERROR_NETWORK, lastStatEvent);
}
function testStatEventReportedOnlyOnce_onNetworkDown() {
stubTmpnetwork();
connect();
sendMap('foo', 'bar');
numStatEvents = 0;
lastStatEvent = null;
responseRequestFailed();
assertEquals(
'No stat event should be reported before we know the reason.', 0,
numStatEvents);
// Wait half the ping timeout period, and then fake the network being up.
mockClock.tick(goog.net.tmpnetwork.GOOGLECOM_TIMEOUT / 2);
browserChannel.testGoogleComCallback_(true);
// Assert we report the correct stat event.
assertEquals(1, numStatEvents);
assertEquals(goog.net.BrowserChannel.Stat.ERROR_OTHER, lastStatEvent);
}
function testOutgoingMapsAwaitsResponse() {
connect();
assertEquals(0, browserChannel.outgoingMaps_.length);
sendMap('foo1', 'bar');
assertEquals(0, browserChannel.outgoingMaps_.length);
sendMap('foo2', 'bar');
assertEquals(1, browserChannel.outgoingMaps_.length);
sendMap('foo3', 'bar');
assertEquals(2, browserChannel.outgoingMaps_.length);
sendMap('foo4', 'bar');
assertEquals(3, browserChannel.outgoingMaps_.length);
responseVersion7();
// Now the forward channel request is completed and a new started, so all maps
// are dequeued from the array of outgoing maps into this new forward request.
assertEquals(0, browserChannel.outgoingMaps_.length);
}
function testUndeliveredMaps_doesNotNotifyWhenSuccessful() {
handler.channelClosed = function(
channel, opt_pendingMaps, opt_undeliveredMaps) {
if (opt_pendingMaps || opt_undeliveredMaps) {
fail('No pending or undelivered maps should be reported.');
}
};
connect();
sendMap('foo1', 'bar1');
responseVersion7();
sendMap('foo2', 'bar2');
responseVersion7();
disconnect();
}
function testUndeliveredMaps_doesNotNotifyIfNothingWasSent() {
handler.channelClosed = function(
channel, opt_pendingMaps, opt_undeliveredMaps) {
if (opt_pendingMaps || opt_undeliveredMaps) {
fail('No pending or undelivered maps should be reported.');
}
};
connect();
mockClock.tick(ALL_DAY_MS);
disconnect();
}
function testUndeliveredMaps_clearsPendingMapsAfterNotifying() {
connect();
sendMap('foo1', 'bar1');
sendMap('foo2', 'bar2');
sendMap('foo3', 'bar3');
assertEquals(1, browserChannel.pendingMaps_.length);
assertEquals(2, browserChannel.outgoingMaps_.length);
disconnect();
assertEquals(0, browserChannel.pendingMaps_.length);
assertEquals(0, browserChannel.outgoingMaps_.length);
}
function testUndeliveredMaps_notifiesWithContext() {
connect();
// First send two messages that succeed.
sendMap('foo1', 'bar1', 'context1');
responseVersion7();
sendMap('foo2', 'bar2', 'context2');
responseVersion7();
// Pretend the server hangs and no longer responds.
sendMap('foo3', 'bar3', 'context3');
sendMap('foo4', 'bar4', 'context4');
sendMap('foo5', 'bar5', 'context5');
// Give up.
disconnect();
// Assert that we are informed of any undelivered messages; both about
// #3 that was sent but which we don't know if the server received, and
// #4 and #5 which remain in the outgoing maps and have not yet been sent.
assertEquals('foo3:bar3:context3', handler.pendingMapsString);
assertEquals(
'foo4:bar4:context4, foo5:bar5:context5', handler.undeliveredMapsString);
}
function testUndeliveredMaps_serviceUnavailable() {
// Send a few maps, and let one fail.
connect();
sendMap('foo1', 'bar1');
responseVersion7();
sendMap('foo2', 'bar2');
responseRequestFailed();
// After a failure, the channel should be closed.
disconnect();
assertEquals('foo2:bar2', handler.pendingMapsString);
assertEquals('', handler.undeliveredMapsString);
}
function testUndeliveredMaps_onPingTimeout() {
stubTmpnetwork();
connect();
// Send a message.
sendMap('foo1', 'bar1');
// Fake REQUEST_FAILED, triggering a ping to check the network.
responseRequestFailed();
// Let the ping time out, unsuccessfully.
mockClock.tick(goog.net.tmpnetwork.GOOGLECOM_TIMEOUT);
// Assert channel is closed.
assertEquals(goog.net.BrowserChannel.State.CLOSED, browserChannel.getState());
// Assert that the handler is notified about the undelivered messages.
assertEquals('foo1:bar1', handler.pendingMapsString);
assertEquals('', handler.undeliveredMapsString);
}
function testResponseNoBackchannelPostNotBeforeBackchannel() {
connect(8);
sendMap('foo1', 'bar1');
mockClock.tick(10);
assertFalse(
browserChannel.backChannelRequest_.getRequestStartTime() <
browserChannel.forwardChannelRequest_.getRequestStartTime());
responseNoBackchannel();
assertNotEquals(
goog.net.BrowserChannel.Stat.BACKCHANNEL_MISSING, lastStatEvent);
}
function testResponseNoBackchannel() {
connect(8);
sendMap('foo1', 'bar1');
response(-1, 0);
mockClock.tick(goog.net.BrowserChannel.RTT_ESTIMATE + 1);
sendMap('foo2', 'bar2');
assertTrue(
browserChannel.backChannelRequest_.getRequestStartTime() +
goog.net.BrowserChannel.RTT_ESTIMATE <
browserChannel.forwardChannelRequest_.getRequestStartTime());
responseNoBackchannel();
assertEquals(goog.net.BrowserChannel.Stat.BACKCHANNEL_MISSING, lastStatEvent);
}
function testResponseNoBackchannelWithNoBackchannel() {
connect(8);
sendMap('foo1', 'bar1');
assertNull(browserChannel.backChannelTimerId_);
browserChannel.backChannelRequest_.cancel();
browserChannel.backChannelRequest_ = null;
responseNoBackchannel();
assertEquals(goog.net.BrowserChannel.Stat.BACKCHANNEL_MISSING, lastStatEvent);
}
function testResponseNoBackchannelWithStartTimer() {
connect(8);
sendMap('foo1', 'bar1');
browserChannel.backChannelRequest_.cancel();
browserChannel.backChannelRequest_ = null;
browserChannel.backChannelTimerId_ = 123;
responseNoBackchannel();
assertNotEquals(
goog.net.BrowserChannel.Stat.BACKCHANNEL_MISSING, lastStatEvent);
}
function testResponseWithNoArraySent() {
connect(8);
sendMap('foo1', 'bar1');
// Send a response as if the server hasn't sent down an array.
response(-1, 0);
// POST response with an array ID lower than our last received is OK.
assertEquals(1, browserChannel.lastArrayId_);
assertEquals(-1, browserChannel.lastPostResponseArrayId_);
}
function testResponseWithArraysMissing() {
connect(8);
sendMap('foo1', 'bar1');
assertEquals(-1, browserChannel.lastPostResponseArrayId_);
// Send a response as if the server has sent down seven arrays.
response(7, 111);
assertEquals(1, browserChannel.lastArrayId_);
assertEquals(7, browserChannel.lastPostResponseArrayId_);
mockClock.tick(goog.net.BrowserChannel.RTT_ESTIMATE * 2);
assertEquals(goog.net.BrowserChannel.Stat.BACKCHANNEL_DEAD, lastStatEvent);
}
function testMultipleResponsesWithArraysMissing() {
connect(8);
sendMap('foo1', 'bar1');
assertEquals(-1, browserChannel.lastPostResponseArrayId_);
// Send a response as if the server has sent down seven arrays.
response(7, 111);
assertEquals(1, browserChannel.lastArrayId_);
assertEquals(7, browserChannel.lastPostResponseArrayId_);
sendMap('foo2', 'bar2');
mockClock.tick(goog.net.BrowserChannel.RTT_ESTIMATE);
response(8, 119);
mockClock.tick(goog.net.BrowserChannel.RTT_ESTIMATE);
// The original timer should still fire.
assertEquals(goog.net.BrowserChannel.Stat.BACKCHANNEL_DEAD, lastStatEvent);
}
function testOnlyRetryOnceBasedOnResponse() {
connect(8);
sendMap('foo1', 'bar1');
assertEquals(-1, browserChannel.lastPostResponseArrayId_);
// Send a response as if the server has sent down seven arrays.
response(7, 111);
assertEquals(1, browserChannel.lastArrayId_);
assertEquals(7, browserChannel.lastPostResponseArrayId_);
assertTrue(hasDeadBackChannelTimer());
mockClock.tick(goog.net.BrowserChannel.RTT_ESTIMATE * 2);
assertEquals(goog.net.BrowserChannel.Stat.BACKCHANNEL_DEAD, lastStatEvent);
assertEquals(1, browserChannel.backChannelRetryCount_);
mockClock.tick(goog.net.BrowserChannel.RTT_ESTIMATE);
sendMap('foo2', 'bar2');
assertFalse(hasDeadBackChannelTimer());
response(8, 119);
assertFalse(hasDeadBackChannelTimer());
}
function testResponseWithArraysMissingAndLiveChannel() {
connect(8);
sendMap('foo1', 'bar1');
assertEquals(-1, browserChannel.lastPostResponseArrayId_);
// Send a response as if the server has sent down seven arrays.
response(7, 111);
assertEquals(1, browserChannel.lastArrayId_);
assertEquals(7, browserChannel.lastPostResponseArrayId_);
mockClock.tick(goog.net.BrowserChannel.RTT_ESTIMATE);
assertTrue(hasDeadBackChannelTimer());
receive('["ack"]');
assertFalse(hasDeadBackChannelTimer());
mockClock.tick(goog.net.BrowserChannel.RTT_ESTIMATE);
assertNotEquals(goog.net.BrowserChannel.Stat.BACKCHANNEL_DEAD, lastStatEvent);
}
function testResponseWithBigOutstandingData() {
connect(8);
sendMap('foo1', 'bar1');
assertEquals(-1, browserChannel.lastPostResponseArrayId_);
// Send a response as if the server has sent down seven arrays and 50kbytes.
response(7, 50000);
assertEquals(1, browserChannel.lastArrayId_);
assertEquals(7, browserChannel.lastPostResponseArrayId_);
assertFalse(hasDeadBackChannelTimer());
mockClock.tick(goog.net.BrowserChannel.RTT_ESTIMATE * 2);
assertNotEquals(goog.net.BrowserChannel.Stat.BACKCHANNEL_DEAD, lastStatEvent);
}
function testResponseInBufferedMode() {
connect(8);
browserChannel.useChunked_ = false;
sendMap('foo1', 'bar1');
assertEquals(-1, browserChannel.lastPostResponseArrayId_);
response(7, 111);
assertEquals(1, browserChannel.lastArrayId_);
assertEquals(7, browserChannel.lastPostResponseArrayId_);
assertFalse(hasDeadBackChannelTimer());
mockClock.tick(goog.net.BrowserChannel.RTT_ESTIMATE * 2);
assertNotEquals(goog.net.BrowserChannel.Stat.BACKCHANNEL_DEAD, lastStatEvent);
}
function testResponseWithGarbage() {
connect(8);
sendMap('foo1', 'bar1');
browserChannel.onRequestData(
browserChannel.forwardChannelRequest_, 'garbage');
assertEquals(goog.net.BrowserChannel.State.CLOSED, browserChannel.getState());
}
function testResponseWithGarbageInArray() {
connect(8);
sendMap('foo1', 'bar1');
browserChannel.onRequestData(
browserChannel.forwardChannelRequest_, '["garbage"]');
assertEquals(goog.net.BrowserChannel.State.CLOSED, browserChannel.getState());
}
function testResponseWithEvilData() {
connect(8);
sendMap('foo1', 'bar1');
browserChannel.onRequestData(
browserChannel.forwardChannelRequest_,
goog.net.BrowserChannel.LAST_ARRAY_ID_RESPONSE_PREFIX +
'=<script>evil()\<\/script>&' +
goog.net.BrowserChannel.OUTSTANDING_DATA_RESPONSE_PREFIX +
'=<script>moreEvil()\<\/script>');
assertEquals(goog.net.BrowserChannel.State.CLOSED, browserChannel.getState());
}
function testPathAbsolute() {
connect(8, undefined, '/talkgadget');
assertEquals(
browserChannel.backChannelUri_.getDomain(), window.location.hostname);
assertEquals(
browserChannel.forwardChannelUri_.getDomain(), window.location.hostname);
}
function testPathRelative() {
connect(8, undefined, 'talkgadget');
assertEquals(
browserChannel.backChannelUri_.getDomain(), window.location.hostname);
assertEquals(
browserChannel.forwardChannelUri_.getDomain(), window.location.hostname);
}
function testPathWithHost() {
connect(8, undefined, 'https://example.com');
assertEquals(browserChannel.backChannelUri_.getScheme(), 'https');
assertEquals(browserChannel.backChannelUri_.getDomain(), 'example.com');
assertEquals(browserChannel.forwardChannelUri_.getScheme(), 'https');
assertEquals(browserChannel.forwardChannelUri_.getDomain(), 'example.com');
}
function testCreateXhrIo() {
var xhr = browserChannel.createXhrIo(null);
assertFalse(xhr.getWithCredentials());
assertThrows(
'Error connection to different host without CORS',
goog.bind(browserChannel.createXhrIo, browserChannel, 'some_host'));
browserChannel.setSupportsCrossDomainXhrs(true);
xhr = browserChannel.createXhrIo(null);
assertTrue(xhr.getWithCredentials());
xhr = browserChannel.createXhrIo('some_host');
assertTrue(xhr.getWithCredentials());
}
function testSetParser() {
var recordParse = goog.testing.recordFunction(JSON.parse);
var parser = {};
parser.parse = recordParse;
browserChannel.setParser(parser);
connect();
assertEquals(3, recordParse.getCallCount());
var call3 = recordParse.popLastCall();
var call2 = recordParse.popLastCall();
var call1 = recordParse.popLastCall();
assertEquals(1, call1.getArguments().length);
assertEquals('["b"]', call1.getArgument(0));
assertEquals(1, call2.getArguments().length);
assertEquals('[[0,["c","1234567890ABCDEF",null]]]', call2.getArgument(0));
assertEquals(1, call3.getArguments().length);
assertEquals('[[1,["foo"]]]', call3.getArgument(0));
}
function testAsyncTest() {
browserChannel.asyncTest_ = true;
browserChannel.connect('/test', '/bind');
mockClock.tick(0);
// We first establish the channel, assuming it is buffered.
assertNotNull(browserChannel.forwardChannelRequest_);
assertNull(browserChannel.connectionTest_);
assertTrue(browserChannel.isBuffered());
// Since we're assuming the channel is buferred, the "Close Immediately" flag
// should be set.
completeForwardChannel();
assertEquals(
'1', browserChannel.backChannelRequest_.requestUri_.queryData_.get('CI'));
mockClock.tick(100);
// Now, we perform the test which reveals the channel is not buffered.
assertNotNull(browserChannel.connectionTest_);
completeForwardTestConnection();
completeBackTestConnection();
assertFalse(browserChannel.isBuffered());
// From now on, the "Close Immediately" flag should not be set.
completeBackChannel();
assertEquals(
'0', browserChannel.backChannelRequest_.requestUri_.queryData_.get('CI'));
}
|