ec533980147142939cc07da666d28fdad6fffd3d
[WebKit-https.git] / Source / WebDriver / CommandResult.h
1 /*
2  * Copyright (C) 2017 Igalia S.L.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include <wtf/Forward.h>
29 #include <wtf/text/WTFString.h>
30
31 namespace Inspector {
32 class InspectorValue;
33 }
34
35 namespace WebDriver {
36
37 class CommandResult {
38 public:
39     // ยง6.6 Handling Errors.
40     // https://www.w3.org/TR/webdriver/#handling-errors
41     enum class ErrorCode {
42         ElementClickIntercepted,
43         ElementNotInteractable,
44         InvalidArgument,
45         InvalidElementState,
46         InvalidSelector,
47         InvalidSessionID,
48         JavascriptError,
49         NoSuchElement,
50         NoSuchFrame,
51         NoSuchWindow,
52         ScriptTimeout,
53         SessionNotCreated,
54         StaleElementReference,
55         Timeout,
56         UnknownCommand,
57         UnknownError,
58         UnsupportedOperation,
59     };
60
61     static CommandResult success(RefPtr<Inspector::InspectorValue>&& result = nullptr)
62     {
63         return CommandResult(WTFMove(result));
64     }
65
66     static CommandResult fail(RefPtr<Inspector::InspectorValue>&& result = nullptr)
67     {
68         return CommandResult(WTFMove(result), CommandResult::ErrorCode::UnknownError);
69     }
70
71     static CommandResult fail(ErrorCode errorCode, std::optional<String> errorMessage = std::nullopt)
72     {
73         return CommandResult(errorCode, errorMessage);
74     }
75
76     unsigned httpStatusCode() const;
77     const RefPtr<Inspector::InspectorValue>& result() const { return m_result; };
78     bool isError() const { return !!m_errorCode; }
79     ErrorCode errorCode() const { ASSERT(isError()); return m_errorCode.value(); }
80     String errorString() const;
81     std::optional<String> errorMessage() const { ASSERT(isError()); return m_errorMessage; }
82
83 private:
84     explicit CommandResult(RefPtr<Inspector::InspectorValue>&&, std::optional<ErrorCode> = std::nullopt);
85     explicit CommandResult(ErrorCode, std::optional<String> = std::nullopt);
86
87     RefPtr<Inspector::InspectorValue> m_result;
88     std::optional<ErrorCode> m_errorCode;
89     std::optional<String> m_errorMessage;
90 };
91
92 } // namespace WebDriver