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 | 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 | 'use strict'; var debug = require('debug')('urllib'); var http = require('http'); var https = require('https'); var urlutil = require('url'); var util = require('util'); var qs = require('qs'); var querystring = require('querystring'); var zlib = require('zlib'); var ua = require('default-user-agent'); var digestAuthHeader = require('digest-header'); var util = require('util'); var ms = require('humanize-ms'); var statuses = require('statuses'); var contentTypeParser = require('content-type'); var first = require('ee-first'); var _Promise; var _iconv; var pkg = require('../package.json'); var USER_AGENT = exports.USER_AGENT = ua('node-urllib', pkg.version); // change Agent.maxSockets to 1000 exports.agent = new http.Agent(); exports.agent.maxSockets = 1000; exports.httpsAgent = new https.Agent(); exports.httpsAgent.maxSockets = 1000; /** * The default request timeout(in milliseconds). * @type {Number} * @const */ exports.TIMEOUT = ms('5s'); exports.TIMEOUTS = [ms('5s'), ms('5s')]; var REQUEST_ID = 0; var MAX_VALUE = Math.pow(2, 31) - 10; var isNode010 = /^v0\.10\.\d+$/.test(process.version); var isNode012 = /^v0\.12\.\d+$/.test(process.version); /** * support data types * will auto decode response body * @type {Array} */ var TEXT_DATA_TYPES = [ 'json', 'text' ]; var PROTO_RE = /^https?:\/\//i; /** * Handle all http request, both http and https support well. * * @example * * // GET http://httptest.cnodejs.net * urllib.request('http://httptest.cnodejs.net/test/get', function(err, data, res) {}); * // POST http://httptest.cnodejs.net * var args = { type: 'post', data: { foo: 'bar' } }; * urllib.request('http://httptest.cnodejs.net/test/post', args, function(err, data, res) {}); * * @param {String|Object} url * @param {Object} [args], optional * - {Object} [data]: request data, will auto be query stringify. * - {Boolean} [dataAsQueryString]: force convert `data` to query string. * - {String|Buffer} [content]: optional, if set content, `data` will ignore. * - {ReadStream} [stream]: read stream to sent. * - {WriteStream} [writeStream]: writable stream to save response data. * If you use this, callback's data should be null. * We will just `pipe(ws, {end: true})`. * - {consumeWriteStream} [true]: consume the writeStream, invoke the callback after writeStream close. * - {String} [method]: optional, could be GET | POST | DELETE | PUT, default is GET * - {String} [contentType]: optional, request data type, could be `json`, default is undefined * - {String} [dataType]: optional, response data type, could be `text` or `json`, default is buffer * - {Boolean} [fixJSONCtlChars]: optional, fix the control characters (U+0000 through U+001F) * before JSON parse response. Default is `false` * - {Object} [headers]: optional, request headers * - {Number|Array} [timeout]: request timeout(in milliseconds), default is `exports.TIMEOUTS containing connect timeout and response timeout` * - {Agent} [agent]: optional, http agent. Set `false` if you does not use agent. * - {Agent} [httpsAgent]: optional, https agent. Set `false` if you does not use agent. * - {String} [auth]: Basic authentication i.e. 'user:password' to compute an Authorization header. * - {String} [digestAuth]: Digest authentication i.e. 'user:password' to compute an Authorization header. * - {String|Buffer|Array} [ca]: An array of strings or Buffers of trusted certificates. * If this is omitted several well known "root" CAs will be used, like VeriSign. * These are used to authorize connections. * Notes: This is necessary only if the server uses the self-signed certificate * - {Boolean} [rejectUnauthorized]: If true, the server certificate is verified against the list of supplied CAs. * An 'error' event is emitted if verification fails. Default: true. * - {String|Buffer} [pfx]: A string or Buffer containing the private key, * certificate and CA certs of the server in PFX or PKCS12 format. * - {String|Buffer} [key]: A string or Buffer containing the private key of the client in PEM format. * Notes: This is necessary only if using the client certificate authentication * - {String|Buffer} [cert]: A string or Buffer containing the certificate key of the client in PEM format. * Notes: This is necessary only if using the client certificate authentication * - {String} [passphrase]: A string of passphrase for the private key or pfx. * - {String} [ciphers]: A string describing the ciphers to use or exclude. * - {String} [secureProtocol]: The SSL method to use, e.g. SSLv3_method to force SSL version 3. * The possible values depend on your installation of OpenSSL and are defined in the constant SSL_METHODS. * - {Boolean} [followRedirect]: Follow HTTP 3xx responses as redirects. defaults to false. * - {Number} [maxRedirects]: The maximum number of redirects to follow, defaults to 10. * - {Function(from, to)} [formatRedirectUrl]: Format the redirect url by your self. Default is `url.resolve(from, to)` * - {Function(options)} [beforeRequest]: Before request hook, you can change every thing here. * - {Boolean} [streaming]: let you get the res object when request connected, default is `false`. alias `customResponse` * - {Boolean} [gzip]: Accept gzip response content and auto decode it, default is `false`. * - {Boolean} [timing]: Enable timing or not, default is `false`. * - {Function} [lookup]: Custom DNS lookup function, default is `dns.lookup`. * Require node >= 4.0.0 and only work on `http` protocol. * @param {Function} [callback], callback(error, data, res). If missing callback, will return a promise object. * @return {HttpRequest} req object. * @api public */ exports.request = function request(url, args, callback) { // request(url, callback) if (arguments.length === 2 && typeof args === 'function') { callback = args; args = null; } if (typeof callback === 'function') { return exports.requestWithCallback(url, args, callback); } // Promise if (!_Promise) { _Promise = require('any-promise'); } return new _Promise(function (resolve, reject) { exports.requestWithCallback(url, args, makeCallback(resolve, reject)); }); }; // alias to curl exports.curl = exports.request; function makeCallback(resolve, reject) { return function (err, data, res) { if (err) { return reject(err); } resolve({ data: data, status: res.statusCode, headers: res.headers, res: res }); }; } // yield urllib.requestThunk(url, args) exports.requestThunk = function requestThunk(url, args) { return function (callback) { exports.requestWithCallback(url, args, function (err, data, res) { if (err) { return callback(err); } callback(null, { data: data, status: res.statusCode, headers: res.headers, res: res }); }); }; }; exports.requestWithCallback = function requestWithCallback(url, args, callback) { // requestWithCallback(url, callback) if (!url || (typeof url !== 'string' && typeof url !== 'object')) { var msg = util.format('expect request url to be a string or a http request options, but got %j', url); throw new Error(msg); } if (arguments.length === 2 && typeof args === 'function') { callback = args; args = null; } args = args || {}; if (REQUEST_ID >= MAX_VALUE) { REQUEST_ID = 0; } var reqId = ++REQUEST_ID; args.requestUrls = args.requestUrls || []; var reqMeta = { requestId: reqId, url: url, args: args, ctx: args.ctx, }; if (args.emitter) { args.emitter.emit('request', reqMeta); } args.timeout = args.timeout || exports.TIMEOUTS; args.maxRedirects = args.maxRedirects || 10; args.streaming = args.streaming || args.customResponse; var requestStartTime = Date.now(); var parsedUrl; if (typeof url === 'string') { if (!PROTO_RE.test(url)) { // Support `request('www.server.com')` url = 'http://' + url; } parsedUrl = urlutil.parse(url); } else { parsedUrl = url; } var method = (args.type || args.method || parsedUrl.method || 'GET').toUpperCase(); var port = parsedUrl.port || 80; var httplib = http; var agent = getAgent(args.agent, exports.agent); var fixJSONCtlChars = !!args.fixJSONCtlChars; if (parsedUrl.protocol === 'https:') { httplib = https; agent = getAgent(args.httpsAgent, exports.httpsAgent); if (!parsedUrl.port) { port = 443; } } var options = { host: parsedUrl.hostname || parsedUrl.host || 'localhost', path: parsedUrl.path || '/', method: method, port: port, agent: agent, headers: args.headers || {}, // default is dns.lookup // https://github.com/nodejs/node/blob/master/lib/net.js#L986 // custom dnslookup require node >= 4.0.0 // https://github.com/nodejs/node/blob/archived-io.js-v0.12/lib/net.js#L952 lookup: args.lookup, }; var sslNames = [ 'pfx', 'key', 'passphrase', 'cert', 'ca', 'ciphers', 'rejectUnauthorized', 'secureProtocol', 'secureOptions', ]; for (var i = 0; i < sslNames.length; i++) { var name = sslNames[i]; if (args.hasOwnProperty(name)) { options[name] = args[name]; } } // don't check ssl if (options.rejectUnauthorized === false && !options.hasOwnProperty('secureOptions')) { options.secureOptions = require('constants').SSL_OP_NO_TLSv1_2; } var auth = args.auth || parsedUrl.auth; if (auth) { options.auth = auth; } var body = args.content || args.data; var dataAsQueryString = method === 'GET' || method === 'HEAD' || args.dataAsQueryString; if (!args.content) { if (body && !(typeof body === 'string' || Buffer.isBuffer(body))) { if (dataAsQueryString) { // read: GET, HEAD, use query string body = args.nestedQuerystring ? qs.stringify(body) : querystring.stringify(body); } else { var contentType = options.headers['Content-Type'] || options.headers['content-type']; // auto add application/x-www-form-urlencoded when using urlencode form request if (!contentType) { if (args.contentType === 'json') { contentType = 'application/json'; } else { contentType = 'application/x-www-form-urlencoded'; } options.headers['Content-Type'] = contentType; } if (parseContentType(contentType).type === 'application/json') { body = JSON.stringify(body); } else { // 'application/x-www-form-urlencoded' body = args.nestedQuerystring ? qs.stringify(body) : querystring.stringify(body); } } } } // if it's a GET or HEAD request, data should be sent as query string if (dataAsQueryString && body) { options.path += (parsedUrl.query ? '&' : '?') + body; body = null; } var requestSize = 0; if (body) { var length = body.length; if (!Buffer.isBuffer(body)) { length = Buffer.byteLength(body); } requestSize = options.headers['Content-Length'] = length; } if (args.dataType === 'json') { options.headers.Accept = 'application/json'; } if (typeof args.beforeRequest === 'function') { // you can use this hook to change every thing. args.beforeRequest(options); } var connectTimer = null; var responseTimer = null; var __err = null; var connected = false; // socket connected or not var keepAliveSocket = false; // request with keepalive socket var responseSize = 0; var statusCode = -1; var responseAborted = false; var remoteAddress = ''; var remotePort = ''; var timing = null; if (args.timing) { timing = { // socket assigned queuing: 0, // dns lookup time dnslookup: 0, // socket connected connected: 0, // request sent requestSent: 0, // Time to first byte (TTFB) waiting: 0, contentDownload: 0, }; } function cancelConnectTimer() { if (connectTimer) { clearTimeout(connectTimer); connectTimer = null; } } function cancelResponseTimer() { if (responseTimer) { clearTimeout(responseTimer); responseTimer = null; } } function done(err, data, res) { cancelResponseTimer(); if (!callback) { console.warn('[urllib:warn] [%s] [worker:%s] %s %s callback twice!!!', Date(), process.pid, options.method, url); // https://github.com/node-modules/urllib/pull/30 if (err) { console.warn('[urllib:warn] [%s] [worker:%s] %s: %s\nstack: %s', Date(), process.pid, err.name, err.message, err.stack); } return; } var cb = callback; callback = null; var headers = {}; if (res) { statusCode = res.statusCode; headers = res.headers; } // handle digest auth if (statusCode === 401 && headers['www-authenticate'] && (!args.headers || !args.headers.Authorization) && args.digestAuth) { var authenticate = headers['www-authenticate']; if (authenticate.indexOf('Digest ') >= 0) { debug('Request#%d %s: got digest auth header WWW-Authenticate: %s', reqId, url, authenticate); args.headers = args.headers || {}; args.headers.Authorization = digestAuthHeader(options.method, options.path, authenticate, args.digestAuth); debug('Request#%d %s: auth with digest header: %s', reqId, url, args.headers.Authorization); if (res.headers['set-cookie']) { args.headers.Cookie = res.headers['set-cookie'].join(';'); } return exports.requestWithCallback(url, args, cb); } } var requestUseTime = Date.now() - requestStartTime; if (timing) { timing.contentDownload = requestUseTime; } debug('[%sms] done, %s bytes HTTP %s %s %s %s, keepAliveSocket: %s, timing: %j', requestUseTime, responseSize, statusCode, options.method, options.host, options.path, keepAliveSocket, timing); var response = { status: statusCode, statusCode: statusCode, headers: headers, size: responseSize, aborted: responseAborted, rt: requestUseTime, keepAliveSocket: keepAliveSocket, data: data, requestUrls: args.requestUrls, timing: timing, remoteAddress: remoteAddress, remotePort: remotePort, }; if (err) { var agentStatus = ''; if (agent && typeof agent.getCurrentStatus === 'function') { // add current agent status to error message for logging and debug agentStatus = ', agent status: ' + JSON.stringify(agent.getCurrentStatus()); } err.message += ', ' + options.method + ' ' + url + ' ' + statusCode + ' (connected: ' + connected + ', keepalive socket: ' + keepAliveSocket + agentStatus + ')' + '\nheaders: ' + JSON.stringify(headers); err.data = data; err.path = options.path; err.status = statusCode; err.headers = headers; err.res = response; } cb(err, data, args.streaming ? res : response); if (args.emitter) { // keep to use the same reqMeta object on request event before reqMeta.url = url; reqMeta.socket = req && req.connection; reqMeta.options = options; reqMeta.size = requestSize; args.emitter.emit('response', { requestId: reqId, error: err, ctx: args.ctx, req: reqMeta, res: response, }); } } function handleRedirect(res) { var err = null; if (args.followRedirect && statuses.redirect[res.statusCode]) { // handle redirect args._followRedirectCount = (args._followRedirectCount || 0) + 1; var location = res.headers.location; if (!location) { err = new Error('Got statusCode ' + res.statusCode + ' but cannot resolve next location from headers'); err.name = 'FollowRedirectError'; } else if (args._followRedirectCount > args.maxRedirects) { err = new Error('Exceeded maxRedirects. Probably stuck in a redirect loop ' + url); err.name = 'MaxRedirectError'; } else { var newUrl = args.formatRedirectUrl ? args.formatRedirectUrl(url, location) : urlutil.resolve(url, location); debug('Request#%d %s: `redirected` from %s to %s', reqId, options.path, url, newUrl); // make sure timer stop cancelResponseTimer(); // should clean up headers.Host on `location: http://other-domain/url` if (args.headers && args.headers.Host && PROTO_RE.test(location)) { args.headers.Host = null; } // avoid done will be execute in the future change. var cb = callback; callback = null; exports.requestWithCallback(newUrl, args, cb); return { redirect: true, error: null }; } } return { redirect: false, error: err }; } // set user-agent if (!options.headers['User-Agent'] && !options.headers['user-agent']) { options.headers['User-Agent'] = USER_AGENT; } if (args.gzip) { if (!options.headers['Accept-Encoding'] && !options.headers['accept-encoding']) { options.headers['Accept-Encoding'] = 'gzip'; } } function decodeContent(res, body, cb) { var encoding = res.headers['content-encoding']; if (body.length === 0) { return cb(null, body, encoding); } if (!encoding || encoding.toLowerCase() !== 'gzip') { return cb(null, body, encoding); } debug('gunzip %d length body', body.length); zlib.gunzip(body, cb); } var writeStream = args.writeStream; debug('Request#%d %s %s with headers %j, options.path: %s', reqId, method, url, options.headers, options.path); args.requestUrls.push(url); function onResponse(res) { if (timing) { timing.waiting = Date.now() - requestStartTime; } debug('Request#%d %s `req response` event emit: status %d, headers: %j', reqId, url, res.statusCode, res.headers); if (args.streaming) { var result = handleRedirect(res); if (result.redirect) { res.resume(); return; } if (result.error) { res.resume(); return done(result.error, null, res); } return done(null, null, res); } res.on('close', function () { debug('Request#%d %s: `res close` event emit, total size %d', reqId, url, responseSize); }); res.on('error', function () { debug('Request#%d %s: `res error` event emit, total size %d', reqId, url, responseSize); }); res.on('aborted', function () { responseAborted = true; debug('Request#%d %s: `res aborted` event emit, total size %d', reqId, url, responseSize); }); if (writeStream) { // If there's a writable stream to recieve the response data, just pipe the // response stream to that writable stream and call the callback when it has // finished writing. // // NOTE that when the response stream `res` emits an 'end' event it just // means that it has finished piping data to another stream. In the // meanwhile that writable stream may still writing data to the disk until // it emits a 'close' event. // // That means that we should not apply callback until the 'close' of the // writable stream is emited. // // See also: // - https://github.com/TBEDP/urllib/commit/959ac3365821e0e028c231a5e8efca6af410eabb // - http://nodejs.org/api/stream.html#stream_event_end // - http://nodejs.org/api/stream.html#stream_event_close_1 var result = handleRedirect(res); if (result.redirect) { res.resume(); return; } if (result.error) { res.resume(); // end ths stream first writeStream.end(); return done(result.error, null, res); } // you can set consumeWriteStream false that only wait response end if (args.consumeWriteStream === false) { res.on('end', done.bind(null, null, null, res)); } else { // node 0.10, 0.12: only emit res aborted, writeStream close not fired if (isNode010 || isNode012) { first([ [ writeStream, 'close' ], [ res, 'aborted' ], ], function(_, stream, event) { debug('Request#%d %s: writeStream or res %s event emitted', reqId, url, event); done(__err || null, null, res); }); } else { writeStream.on('close', function() { debug('Request#%d %s: writeStream close event emitted', reqId, url); done(__err || null, null, res); }); } } return res.pipe(writeStream); } // Otherwise, just concat those buffers. // // NOTE that the `chunk` is not a String but a Buffer. It means that if // you simply concat two chunk with `+` you're actually converting both // Buffers into Strings before concating them. It'll cause problems when // dealing with multi-byte characters. // // The solution is to store each chunk in an array and concat them with // 'buffer-concat' when all chunks is recieved. // // See also: // http://cnodejs.org/topic/4faf65852e8fb5bc65113403 var chunks = []; res.on('data', function (chunk) { debug('Request#%d %s: `res data` event emit, size %d', reqId, url, chunk.length); responseSize += chunk.length; chunks.push(chunk); }); res.on('end', function () { var body = Buffer.concat(chunks, responseSize); debug('Request#%d %s: `res end` event emit, total size %d, _dumped: %s', reqId, url, responseSize, res._dumped); if (__err) { // req.abort() after `res data` event emit. return done(__err, body, res); } var result = handleRedirect(res); if (result.error) { return done(result.error, body, res); } if (result.redirect) { return; } decodeContent(res, body, function (err, data, encoding) { if (err) { return done(err, body, res); } // if body not decode, dont touch it if (!encoding && TEXT_DATA_TYPES.indexOf(args.dataType) >= 0) { // try to decode charset try { data = decodeBodyByCharset(data, res); } catch (e) { debug('decodeBodyByCharset error: %s', e); // if error, dont touch it return done(null, data, res); } if (args.dataType === 'json') { if (responseSize === 0) { data = null; } else { var r = parseJSON(data, fixJSONCtlChars); if (r.error) { err = r.error; } else { data = r.data; } } } } if (responseAborted) { // err = new Error('Remote socket was terminated before `response.end()` was called'); // err.name = 'RemoteSocketClosedError'; debug('Request#%d %s: Remote socket was terminated before `response.end()` was called', reqId, url); } done(err, data, res); }); }); } var connectTimeout, responseTimeout; if (Array.isArray(args.timeout)) { connectTimeout = ms(args.timeout[0]); responseTimeout = ms(args.timeout[1]); } else { // set both timeout equal connectTimeout = responseTimeout = ms(args.timeout); } debug('ConnectTimeout: %d, ResponseTimeout: %d', connectTimeout, responseTimeout); function startConnectTimer() { debug('Connect timer ticking, timeout: %d', connectTimeout); connectTimer = setTimeout(function () { connectTimer = null; if (statusCode === -1) { statusCode = -2; } var msg = 'Connect timeout for ' + connectTimeout + 'ms'; var errorName = 'ConnectionTimeoutError'; if (!req.socket) { errorName = 'SocketAssignTimeoutError'; msg += ', working sockets is full'; } __err = new Error(msg); __err.name = errorName; __err.requestId = reqId; debug('ConnectTimeout: Request#%d %s %s: %s, connected: %s', reqId, url, __err.name, msg, connected); abortRequest(); }, connectTimeout); } function startResposneTimer() { debug('Response timer ticking, timeout: %d', responseTimeout); responseTimer = setTimeout(function () { responseTimer = null; var msg = 'Response timeout for ' + responseTimeout + 'ms'; var errorName = 'ResponseTimeoutError'; __err = new Error(msg); __err.name = errorName; __err.requestId = reqId; debug('ResponseTimeout: Request#%d %s %s: %s, connected: %s', reqId, url, __err.name, msg, connected); abortRequest(); }, responseTimeout); } var req; // request headers checker will throw error try { req = httplib.request(options, onResponse); } catch (err) { return done(err); } // environment detection: browser or nodejs if (typeof(window) === 'undefined') { // start connect timer just after `request` return, and just in nodejs environment startConnectTimer(); } function abortRequest() { debug('Request#%d %s abort, connected: %s', reqId, url, connected); // it wont case error event when req haven't been assigned a socket yet. if (!req.socket) { __err.noSocket = true; done(__err); } req.abort(); } if (timing) { // request sent req.on('finish', function() { timing.requestSent = Date.now() - requestStartTime; }); } req.once('socket', function (socket) { if (timing) { // socket queuing time timing.queuing = Date.now() - requestStartTime; } // https://github.com/nodejs/node/blob/master/lib/net.js#L377 // https://github.com/nodejs/node/blob/v0.10.40-release/lib/net.js#L352 // should use socket.socket on 0.10.x if (isNode010 && socket.socket) { socket = socket.socket; } var readyState = socket.readyState; if (readyState === 'opening') { socket.once('lookup', function(err, ip, addressType) { debug('Request#%d %s lookup: %s, %s, %s', reqId, url, err, ip, addressType); if (timing) { timing.dnslookup = Date.now() - requestStartTime; } if (ip) { remoteAddress = ip; } }); socket.once('connect', function() { if (timing) { // socket connected timing.connected = Date.now() - requestStartTime; } // cancel socket timer at first and start tick for TTFB cancelConnectTimer(); startResposneTimer(); debug('Request#%d %s new socket connected', reqId, url); connected = true; if (!remoteAddress) { remoteAddress = socket.remoteAddress; } remotePort = socket.remotePort; }); return; } debug('Request#%d %s reuse socket connected, readyState: %s', reqId, url, readyState); connected = true; keepAliveSocket = true; if (!remoteAddress) { remoteAddress = socket.remoteAddress; } remotePort = socket.remotePort; // reuse socket, timer should be canceled. cancelConnectTimer(); startResposneTimer(); }); req.on('error', function (err) { if (err.name === 'Error') { err.name = connected ? 'ResponseError' : 'RequestError'; } err.message += ' (req "error")'; debug('Request#%d %s `req error` event emit, %s: %s', reqId, url, err.name, err.message); done(__err || err); }); if (writeStream) { writeStream.once('error', function (err) { err.message += ' (writeStream "error")'; __err = err; debug('Request#%d %s `writeStream error` event emit, %s: %s', reqId, url, err.name, err.message); abortRequest(); }); } if (args.stream) { args.stream.pipe(req); args.stream.once('error', function (err) { err.message += ' (stream "error")'; __err = err; debug('Request#%d %s `readStream error` event emit, %s: %s', reqId, url, err.name, err.message); abortRequest(); }); } else { req.end(body); } req.requestId = reqId; return req; }; var JSONCtlCharsMap = { '"': '\\"', // \u0022 '\\': '\\\\', // \u005c '\b': '\\b', // \u0008 '\f': '\\f', // \u000c '\n': '\\n', // \u000a '\r': '\\r', // \u000d '\t': '\\t' // \u0009 }; var JSONCtlCharsRE = /[\u0000-\u001F\u005C]/g; function _replaceOneChar(c) { return JSONCtlCharsMap[c] || '\\u' + (c.charCodeAt(0) + 0x10000).toString(16).substr(1); } function replaceJSONCtlChars(str) { return str.replace(JSONCtlCharsRE, _replaceOneChar); } function parseJSON(data, fixJSONCtlChars) { var result = { error: null, data: null }; if (fixJSONCtlChars) { // https://github.com/node-modules/urllib/pull/77 // remote the control characters (U+0000 through U+001F) data = replaceJSONCtlChars(data); } try { result.data = JSON.parse(data); } catch (err) { if (err.name === 'SyntaxError') { err.name = 'JSONResponseFormatError'; } if (data.length > 1024) { // show 0~512 ... -512~end data err.message += ' (data json format: ' + JSON.stringify(data.slice(0, 512)) + ' ...skip... ' + JSON.stringify(data.slice(data.length - 512)) + ')'; } else { err.message += ' (data json format: ' + JSON.stringify(data) + ')'; } result.error = err; } return result; } /** * decode response body by parse `content-type`'s charset * @param {Buffer} data * @param {Http(s)Response} res * @return {String} */ function decodeBodyByCharset(data, res) { var type = res.headers['content-type']; if (!type) { return data.toString(); } var type = parseContentType(type); var charset = type.parameters.charset || 'utf-8'; if (!Buffer.isEncoding(charset)) { if (!_iconv) { _iconv = require('iconv-lite'); } return _iconv.decode(data, charset); } return data.toString(charset); } function getAgent(agent, defaultAgent) { return agent === undefined ? defaultAgent : agent; } function parseContentType(str) { try { return contentTypeParser.parse(str); } catch (err) { // ignore content-type error, tread as default return { parameters: {} }; } } |