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         NoSuchAlert,
  50         NoSuchElement,
  51         NoSuchFrame,
  52         NoSuchWindow,
  53         ScriptTimeout,
  54         SessionNotCreated,
  55         StaleElementReference,
  56         Timeout,
  57         UnknownCommand,
  58         UnknownError,
  59         UnsupportedOperation,
  60     };
  61
  62     static CommandResult success(RefPtr<Inspector::InspectorValue>&& result = nullptr)
  63     {
  64         return CommandResult(WTFMove(result));
  65     }
  66
  67     static CommandResult fail(RefPtr<Inspector::InspectorValue>&& result = nullptr)
  68     {
  69         return CommandResult(WTFMove(result), CommandResult::ErrorCode::UnknownError);
  70     }
  71
  72     static CommandResult fail(ErrorCode errorCode, std::optional<String> errorMessage = std::nullopt)
  73     {
  74         return CommandResult(errorCode, errorMessage);
  75     }
  76
  77     unsigned httpStatusCode() const;
  78     const RefPtr<Inspector::InspectorValue>& result() const { return m_result; };
  79     bool isError() const { return !!m_errorCode; }
  80     ErrorCode errorCode() const { ASSERT(isError()); return m_errorCode.value(); }
  81     String errorString() const;
  82     std::optional<String> errorMessage() const { ASSERT(isError()); return m_errorMessage; }
  83
  84 private:
  85     explicit CommandResult(RefPtr<Inspector::InspectorValue>&&, std::optional<ErrorCode> = std::nullopt);
  86     explicit CommandResult(ErrorCode, std::optional<String> = std::nullopt);
  87
  88     RefPtr<Inspector::InspectorValue> m_result;
  89     std::optional<ErrorCode> m_errorCode;
  90     std::optional<String> m_errorMessage;
  91 };
  92
  93 } // namespace WebDriver