You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

134 lines
3.9 KiB

// Copyright 2013 Selenium committers
// Copyright 2013 Software Freedom Conservancy
//
// 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.
/**
* @fileoverview Various HTTP utilities.
*/
var base = require('../_base'),
HttpClient = require('./index').HttpClient,
checkResponse = base.require('bot.response').checkResponse,
Executor = base.require('webdriver.http.Executor'),
HttpRequest = base.require('webdriver.http.Request'),
Command = base.require('webdriver.Command'),
CommandName = base.require('webdriver.CommandName'),
promise = base.require('webdriver.promise');
/**
* Queries a WebDriver server for its current status.
* @param {string} url Base URL of the server to query.
* @param {function(Error, *=)} callback The function to call with the
* response.
*/
function getStatus(url, callback) {
var client = new HttpClient(url);
var executor = new Executor(client);
var command = new Command(CommandName.GET_SERVER_STATUS);
executor.execute(command, function(err, responseObj) {
if (err) return callback(err);
try {
checkResponse(responseObj);
} catch (ex) {
return callback(ex);
}
callback(null, responseObj['value']);
});
}
// PUBLIC API
/**
* Queries a WebDriver server for its current status.
* @param {string} url Base URL of the server to query.
* @return {!webdriver.promise.Promise.<!Object>} A promise that resolves with
* a hash of the server status.
*/
exports.getStatus = function(url) {
return promise.checkedNodeCall(getStatus.bind(null, url));
};
/**
* Waits for a WebDriver server to be healthy and accepting requests.
* @param {string} url Base URL of the server to query.
* @param {number} timeout How long to wait for the server.
* @return {!webdriver.promise.Promise} A promise that will resolve when the
* server is ready.
*/
exports.waitForServer = function(url, timeout) {
var ready = promise.defer(),
start = Date.now(),
checkServerStatus = getStatus.bind(null, url, onResponse);
checkServerStatus();
return ready.promise;
function onResponse(err) {
if (!ready.isPending()) return;
if (!err) return ready.fulfill();
if (Date.now() - start > timeout) {
ready.reject(
Error('Timed out waiting for the WebDriver server at ' + url));
} else {
setTimeout(function() {
if (ready.isPending()) {
checkServerStatus();
}
}, 50);
}
}
};
/**
* Polls a URL with GET requests until it returns a 2xx response or the
* timeout expires.
* @param {string} url The URL to poll.
* @param {number} timeout How long to wait, in milliseconds.
* @return {!webdriver.promise.Promise} A promise that will resolve when the
* URL responds with 2xx.
*/
exports.waitForUrl = function(url, timeout) {
var client = new HttpClient(url),
request = new HttpRequest('GET', ''),
testUrl = client.send.bind(client, request, onResponse),
ready = promise.defer(),
start = Date.now();
testUrl();
return ready.promise;
function onResponse(err, response) {
if (!ready.isPending()) return;
if (!err && response.status > 199 && response.status < 300) {
return ready.fulfill();
}
if (Date.now() - start > timeout) {
ready.reject(Error(
'Timed out waiting for the URL to return 2xx: ' + url));
} else {
setTimeout(function() {
if (ready.isPending()) {
testUrl();
}
}, 50);
}
}
};