aboutsummaryrefslogtreecommitdiff
path: root/node_modules/selenium-webdriver/http/util.js
diff options
context:
space:
mode:
authorFlorian Dold <florian.dold@gmail.com>2016-11-03 01:33:53 +0100
committerFlorian Dold <florian.dold@gmail.com>2016-11-03 01:33:53 +0100
commitd1291f67551c58168af43698a359cb5ddfd266b0 (patch)
tree55a13ed29fe1915e3f42f1b1b7038dafa2e975a7 /node_modules/selenium-webdriver/http/util.js
parentd0a0695fb5d34996850723f7d4b1b59c3df909c2 (diff)
node_modules
Diffstat (limited to 'node_modules/selenium-webdriver/http/util.js')
-rw-r--r--node_modules/selenium-webdriver/http/util.js139
1 files changed, 139 insertions, 0 deletions
diff --git a/node_modules/selenium-webdriver/http/util.js b/node_modules/selenium-webdriver/http/util.js
new file mode 100644
index 000000000..7564ba85e
--- /dev/null
+++ b/node_modules/selenium-webdriver/http/util.js
@@ -0,0 +1,139 @@
+// Licensed to the Software Freedom Conservancy (SFC) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The SFC licenses this file
+// to you 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.
+ */
+
+'use strict';
+
+const Executor = require('./index').Executor,
+ HttpClient = require('./index').HttpClient,
+ HttpRequest = require('./index').Request,
+ Command = require('../lib/command').Command,
+ CommandName = require('../lib/command').Name,
+ error = require('../lib/error'),
+ promise = require('../lib/promise');
+
+
+
+/**
+ * Queries a WebDriver server for its current status.
+ * @param {string} url Base URL of the server to query.
+ * @return {!Promise<!Object>} A promise that resolves with
+ * a hash of the server status.
+ */
+function getStatus(url) {
+ var client = new HttpClient(url);
+ var executor = new Executor(client);
+ var command = new Command(CommandName.GET_SERVER_STATUS);
+ return executor.execute(command);
+}
+
+
+// PUBLIC API
+
+
+/**
+ * Queries a WebDriver server for its current status.
+ * @param {string} url Base URL of the server to query.
+ * @return {!Promise<!Object>} A promise that resolves with
+ * a hash of the server status.
+ */
+exports.getStatus = getStatus;
+
+
+/**
+ * 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 {!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();
+ return ready.promise;
+
+ function checkServerStatus() {
+ return getStatus(url).then(status => ready.fulfill(status), onError);
+ }
+
+ function onError(e) {
+ // Some servers don't support the status command. If they are able to
+ // response with an error, then can consider the server ready.
+ if (e instanceof error.UnsupportedOperationError) {
+ ready.fulfill();
+ return;
+ }
+
+ if (Date.now() - start > timeout) {
+ ready.reject(
+ Error('Timed out waiting for the WebDriver server at ' + url));
+ } else {
+ setTimeout(function() {
+ if (ready.promise.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 {!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', ''),
+ ready = promise.defer(),
+ start = Date.now();
+ testUrl();
+ return ready.promise;
+
+ function testUrl() {
+ client.send(request).then(onResponse, onError);
+ }
+
+ function onError() {
+ if (Date.now() - start > timeout) {
+ ready.reject(Error(
+ 'Timed out waiting for the URL to return 2xx: ' + url));
+ } else {
+ setTimeout(function() {
+ if (ready.promise.isPending()) {
+ testUrl();
+ }
+ }, 50);
+ }
+ }
+
+ function onResponse(response) {
+ if (!ready.promise.isPending()) return;
+ if (response.status > 199 && response.status < 300) {
+ return ready.fulfill();
+ }
+ onError();
+ }
+};