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
|
/*
* Copyright (C) 2017 Igalia S.L.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#include "config.h"
#include "CommandResult.h"
namespace WebDriver {
// These error codes are specified in JSON-RPC 2.0, Section 5.1.
enum ProtocolErrorCode {
ParseError = -32700,
InvalidRequest = -32600,
MethodNotFound = -32601,
InvalidParams = -32602,
InternalError = -32603,
ServerError = -32000
};
CommandResult::CommandResult(RefPtr<JSON::Value>&& result, std::optional<ErrorCode> errorCode)
: m_errorCode(errorCode)
{
if (!m_errorCode) {
m_result = WTFMove(result);
return;
}
if (!result)
return;
auto errorObject = result->asObject();
if (!errorObject)
return;
auto error = errorObject->getInteger("code"_s);
if (!error)
return;
auto errorMessage = errorObject->getString("message"_s);
if (!errorMessage)
return;
switch (*error) {
case ProtocolErrorCode::ParseError:
case ProtocolErrorCode::InvalidRequest:
case ProtocolErrorCode::MethodNotFound:
case ProtocolErrorCode::InvalidParams:
case ProtocolErrorCode::InternalError:
m_errorCode = ErrorCode::UnknownError;
m_errorMessage = errorMessage;
break;
case ProtocolErrorCode::ServerError: {
String errorName;
auto position = errorMessage.find(';');
if (position != notFound) {
errorName = errorMessage.left(position);
m_errorMessage = errorMessage.substring(position + 1);
} else
errorName = errorMessage;
if (errorName == "WindowNotFound"_s)
m_errorCode = ErrorCode::NoSuchWindow;
else if (errorName == "FrameNotFound"_s)
m_errorCode = ErrorCode::NoSuchFrame;
else if (errorName == "NotImplemented"_s)
m_errorCode = ErrorCode::UnsupportedOperation;
else if (errorName == "ElementNotInteractable"_s)
m_errorCode = ErrorCode::ElementNotInteractable;
else if (errorName == "JavaScriptError"_s)
m_errorCode = ErrorCode::JavascriptError;
else if (errorName == "JavaScriptTimeout"_s)
m_errorCode = ErrorCode::ScriptTimeout;
else if (errorName == "NodeNotFound"_s)
m_errorCode = ErrorCode::StaleElementReference;
else if (errorName == "InvalidNodeIdentifier"_s)
m_errorCode = ErrorCode::NoSuchElement;
else if (errorName == "MissingParameter"_s || errorName == "InvalidParameter"_s)
m_errorCode = ErrorCode::InvalidArgument;
else if (errorName == "InvalidElementState"_s)
m_errorCode = ErrorCode::InvalidElementState;
else if (errorName == "InvalidSelector"_s)
m_errorCode = ErrorCode::InvalidSelector;
else if (errorName == "Timeout"_s)
m_errorCode = ErrorCode::Timeout;
else if (errorName == "NoJavaScriptDialog"_s)
m_errorCode = ErrorCode::NoSuchAlert;
else if (errorName == "ElementNotSelectable"_s)
m_errorCode = ErrorCode::ElementNotSelectable;
else if (errorName == "ScreenshotError"_s)
m_errorCode = ErrorCode::UnableToCaptureScreen;
else if (errorName == "UnexpectedAlertOpen"_s)
m_errorCode = ErrorCode::UnexpectedAlertOpen;
else if (errorName == "TargetOutOfBounds"_s)
m_errorCode = ErrorCode::MoveTargetOutOfBounds;
break;
}
}
}
CommandResult::CommandResult(ErrorCode errorCode, std::optional<String> errorMessage)
: m_errorCode(errorCode)
, m_errorMessage(errorMessage)
{
}
unsigned CommandResult::httpStatusCode() const
{
if (!m_errorCode)
return 200;
// ยง6.6 Handling Errors.
// https://www.w3.org/TR/webdriver/#handling-errors
switch (m_errorCode.value()) {
case ErrorCode::ElementClickIntercepted:
case ErrorCode::ElementNotSelectable:
case ErrorCode::ElementNotInteractable:
case ErrorCode::InvalidArgument:
case ErrorCode::InvalidElementState:
case ErrorCode::InvalidSelector:
return 400;
case ErrorCode::NoSuchAlert:
case ErrorCode::NoSuchCookie:
case ErrorCode::NoSuchElement:
case ErrorCode::NoSuchFrame:
case ErrorCode::NoSuchWindow:
case ErrorCode::NoSuchShadowRoot:
case ErrorCode::StaleElementReference:
case ErrorCode::DetachedShadowRoot:
case ErrorCode::InvalidSessionID:
case ErrorCode::UnknownCommand:
return 404;
case ErrorCode::JavascriptError:
case ErrorCode::MoveTargetOutOfBounds:
case ErrorCode::ScriptTimeout:
case ErrorCode::SessionNotCreated:
case ErrorCode::Timeout:
case ErrorCode::UnableToCaptureScreen:
case ErrorCode::UnexpectedAlertOpen:
case ErrorCode::UnknownError:
case ErrorCode::UnsupportedOperation:
return 500;
}
ASSERT_NOT_REACHED();
return 200;
}
String CommandResult::errorString() const
{
ASSERT(isError());
switch (m_errorCode.value()) {
case ErrorCode::ElementClickIntercepted:
return "element click intercepted"_s;
case ErrorCode::ElementNotSelectable:
return "element not selectable"_s;
case ErrorCode::ElementNotInteractable:
return "element not interactable"_s;
case ErrorCode::DetachedShadowRoot:
return "detached shadow root"_s;
case ErrorCode::InvalidArgument:
return "invalid argument"_s;
case ErrorCode::InvalidElementState:
return "invalid element state"_s;
case ErrorCode::InvalidSelector:
return "invalid selector"_s;
case ErrorCode::InvalidSessionID:
return "invalid session id"_s;
case ErrorCode::JavascriptError:
return "javascript error"_s;
case ErrorCode::NoSuchAlert:
return "no such alert"_s;
case ErrorCode::NoSuchCookie:
return "no such cookie"_s;
case ErrorCode::NoSuchElement:
return "no such element"_s;
case ErrorCode::NoSuchFrame:
return "no such frame"_s;
case ErrorCode::NoSuchShadowRoot:
return "no such shadow root"_s;
case ErrorCode::NoSuchWindow:
return "no such window"_s;
case ErrorCode::ScriptTimeout:
return "script timeout"_s;
case ErrorCode::SessionNotCreated:
return "session not created"_s;
case ErrorCode::StaleElementReference:
return "stale element reference"_s;
case ErrorCode::Timeout:
return "timeout"_s;
case ErrorCode::UnableToCaptureScreen:
return "unable to capture screen"_s;
case ErrorCode::MoveTargetOutOfBounds:
return "move target out of bounds"_s;
case ErrorCode::UnexpectedAlertOpen:
return "unexpected alert open"_s;
case ErrorCode::UnknownCommand:
return "unknown command"_s;
case ErrorCode::UnknownError:
return "unknown error"_s;
case ErrorCode::UnsupportedOperation:
return "unsupported operation"_s;
}
ASSERT_NOT_REACHED();
return emptyString();
}
} // namespace WebDriver
|