Add basic support for IEDriver to drive an EdgeChromium IE tab

Signed-off-by: Jim Evans <[email protected]>

Author: Stanley Hon

cpp/iedriver/Browser.cpp

@@ -34,12 +34,13 @@
 
 namespace webdriver {
 
-Browser::Browser(IWebBrowser2* browser, HWND hwnd, HWND session_handle) : DocumentHost(hwnd, session_handle) {
+Browser::Browser(IWebBrowser2* browser, HWND hwnd, HWND session_handle, bool is_edge_chromium) : DocumentHost(hwnd, session_handle) {
   LOG(TRACE) << "Entering Browser::Browser";
   this->is_explicit_close_requested_ = false;
   this->is_navigation_started_ = false;
   this->browser_ = browser;
   this->AttachEvents();
+  this->is_edge_chromium_ = is_edge_chromium;
 }
 
 Browser::~Browser(void) {
@@ -112,6 +113,12 @@ void __stdcall Browser::NewWindow3(IDispatch** ppDisp,
                                    DWORD dwFlags,
                                    BSTR bstrUrlContext,
                                    BSTR bstrUrl) {
+  if (this->is_edge_chromium_) {
+    LOG(TRACE) << "Entering Browser::NewWindow3 but early exiting due to edge mode";
+    // In Edge Chromium, we do not yet support attaching to new windows.
+    // Quit early and ignore that event.
+    return;
+  }
   LOG(TRACE) << "Entering Browser::NewWindow3";
   // Handle the NewWindow3 event to allow us to immediately hook
   // the events of the new browser window opened by the user action.
@@ -400,7 +407,14 @@ void Browser::Close() {
   // Closing the browser, so having focus on a frame doesn't
   // make any sense.
   this->SetFocusedFrameByElement(NULL);
-  HRESULT hr = this->browser_->Quit();
+
+  HRESULT hr = S_OK;
+  if (this->is_edge_chromium_) {
+    hr = PostMessage(GetTopLevelWindowHandle(), WM_CLOSE, 0, 0);
+  } else {
+    hr = this->browser_->Quit();
+  }
+
   if (FAILED(hr)) {
     LOGHR(WARN, hr) << "Call to IWebBrowser2::Quit failed";
   }

cpp/iedriver/Browser.h

@@ -44,7 +44,7 @@ class ElementRepository;
 
 class Browser : public DocumentHost, public IDispEventSimpleImpl<1, Browser, &DIID_DWebBrowserEvents2> {
  public:
-  Browser(IWebBrowser2* browser, HWND hwnd, HWND session_handle);
+  Browser(IWebBrowser2* browser, HWND hwnd, HWND session_handle, bool isEdgeChrome = false);
   virtual ~Browser(void);
 
   static inline _ATL_FUNC_INFO* BeforeNavigate2Info() {
@@ -159,6 +159,7 @@ class Browser : public DocumentHost, public IDispEventSimpleImpl<1, Browser, &DI
   CComPtr<IWebBrowser2> browser_;
   bool is_navigation_started_;
   bool is_explicit_close_requested_;
+  bool is_edge_chromium_;
   std::vector<DWORD> known_process_ids_;
 };
 

cpp/iedriver/BrowserFactory.cpp

@@ -41,6 +41,7 @@
 #define IE_FRAME_WINDOW_CLASS "IEFrame"
 #define SHELL_DOCOBJECT_VIEW_WINDOW_CLASS "Shell DocObject View"
 #define IE_SERVER_CHILD_WINDOW_CLASS "Internet Explorer_Server"
+#define ANDIE_FRAME_WINDOW_CLASS "Chrome_WidgetWin_1"
 
 #define IE_CLSID_REGISTRY_KEY L"SOFTWARE\\Classes\\InternetExplorer.Application\\CLSID"
 #define IE_SECURITY_ZONES_REGISTRY_KEY L"Software\\Microsoft\\Windows\\CurrentVersion\\Internet Settings\\Zones"
@@ -50,6 +51,7 @@
 
 #define IELAUNCHURL_ERROR_MESSAGE "IELaunchURL() returned HRESULT %X ('%s') for URL '%s'"
 #define CREATEPROCESS_ERROR_MESSAGE "CreateProcess() failed for command line '%s'"
+#define CREATEPROCESS_EDGE_ERROR "CreateProcess() failed for edge with the following command: "
 #define NULL_PROCESS_ID_ERROR_MESSAGE " successfully launched Internet Explorer, but did not return a valid process ID."
 #define PROTECTED_MODE_SETTING_ERROR_MESSAGE "Protected Mode settings are not the same for all zones. Enable Protected Mode must be set to the same value (enabled or disabled) for all zones."
 #define ZOOM_SETTING_ERROR_MESSAGE "Browser zoom level was set to %d%%. It should be set to 100%%"
@@ -95,6 +97,7 @@ BrowserFactory::BrowserFactory(void) {
   this->GetExecutableLocation();
   this->GetIEVersion();
   this->oleacc_instance_handle_ = NULL;
+  this->edge_ie_mode_ = false;
 }
 
 BrowserFactory::~BrowserFactory(void) {
@@ -121,7 +124,10 @@ void BrowserFactory::Initialize(BrowserFactorySettings settings) {
   this->clear_cache_ = settings.clear_cache_before_launch;
   this->browser_command_line_switches_ = StringUtilities::ToWString(settings.browser_command_line_switches);
   this->initial_browser_url_ = StringUtilities::ToWString(settings.initial_browser_url);
-
+  this->edge_ie_mode_ = settings.attach_to_edge_ie;
+  LOG(DEBUG) << "path before was " << settings.edge_executable_path << "\n";
+  this->edge_executable_location_ = StringUtilities::ToWString(settings.edge_executable_path);
+  LOG(DEBUG) << "path after was " << this->edge_executable_location_.c_str() << "\n";
   this->html_getobject_msg_ = ::RegisterWindowMessage(HTML_GETOBJECT_MSG);
 
   // Explicitly load MSAA so we know if it's installed
@@ -180,7 +186,9 @@ DWORD BrowserFactory::LaunchBrowserProcess(std::string* error_message) {
     PROCESS_INFORMATION proc_info;
     ::ZeroMemory(&proc_info, sizeof(proc_info));
 
-    if (!use_createprocess_api) {
+    if (this->edge_ie_mode_) {
+      this->LaunchEdgeInIEMode(&proc_info, error_message);
+    } else if (!use_createprocess_api) {
       this->LaunchBrowserUsingIELaunchURL(&proc_info, error_message);
     } else {
       this->LaunchBrowserUsingCreateProcess(&proc_info, error_message);
@@ -327,6 +335,55 @@ void BrowserFactory::LaunchBrowserUsingCreateProcess(PROCESS_INFORMATION* proc_i
   delete[] command_line;
 }
 
+void BrowserFactory::LaunchEdgeInIEMode(PROCESS_INFORMATION* proc_info,
+                                        std::string* error_message) {
+  LOG(TRACE) << "Entering BrowserFactory::LaunchEdgeInIEMode";
+  LOG(DEBUG) << "Starting Edge Chromium from the command line";
+
+  STARTUPINFO start_info;
+  ::ZeroMemory(&start_info, sizeof(start_info));
+  start_info.cb = sizeof(start_info);
+
+  std::wstring executable_and_url = this->edge_executable_location_;
+  if (executable_and_url == L"") {
+    executable_and_url = L"msedge.exe"; // Assume it's on the path if it's not passed
+  }
+
+  // These flags force Edge into a mode where it will only run MSHTML
+  executable_and_url.append(L" --ie-mode-force");
+  executable_and_url.append(L" --internet-explorer-integration=iemode");
+
+  executable_and_url.append(L" ");
+  executable_and_url.append(this->initial_browser_url_);
+
+  LOG(TRACE) << "IE starting command line is: '"
+             << LOGWSTRING(executable_and_url) << "'.";
+
+  LPWSTR command_line = new WCHAR[executable_and_url.size() + 1];
+  wcscpy_s(command_line,
+           executable_and_url.size() + 1,
+           executable_and_url.c_str());
+  command_line[executable_and_url.size()] = L'\0';
+  BOOL create_process_result = ::CreateProcess(NULL,
+                                               command_line,
+                                               NULL,
+                                               NULL,
+                                               FALSE,
+                                               0,
+                                               NULL,
+                                               NULL,
+                                               &start_info,
+                                               proc_info);
+
+
+  if (!create_process_result) {
+    *error_message = CREATEPROCESS_EDGE_ERROR + StringUtilities::ToString(command_line);
+  }
+
+  delete[] command_line;
+}
+
+
 bool BrowserFactory::GetDocumentFromWindowHandle(HWND window_handle,
                                                  IHTMLDocument2** document) {
   LOG(TRACE) << "Entering BrowserFactory::GetDocumentFromWindowHandle";
@@ -411,11 +468,13 @@ bool BrowserFactory::AttachToBrowser(ProcessWindowInfo* process_window_info,
   return attached;
 }
 
+
 bool BrowserFactory::IsBrowserProcessInitialized(DWORD process_id) {
   ProcessWindowInfo info;
   info.dwProcessId = process_id;
   info.hwndBrowser = NULL;
   info.pBrowser = NULL;
+
   ::EnumWindows(&BrowserFactory::FindBrowserWindow,
                 reinterpret_cast<LPARAM>(&info));
   return info.hwndBrowser != NULL;
@@ -431,8 +490,15 @@ bool BrowserFactory::AttachToBrowserUsingActiveAccessibility
     if (this->browser_attach_timeout_ > 0 && (clock() > end)) {
       break;
     }
-    ::EnumWindows(&BrowserFactory::FindBrowserWindow,
-                  reinterpret_cast<LPARAM>(process_window_info));
+    if (!this->edge_ie_mode_) {
+      ::EnumWindows(&BrowserFactory::FindBrowserWindow,
+                    reinterpret_cast<LPARAM>(process_window_info));
+    } else {
+      // If we're in edge_ie_mode, we need to look for different windows
+      ::EnumWindows(&BrowserFactory::FindEdgeWindow,
+                    reinterpret_cast<LPARAM>(process_window_info));
+    }
+
     if (process_window_info->hwndBrowser == NULL) {
       ::Sleep(250);
     }
@@ -940,21 +1006,37 @@ void BrowserFactory::InvokeClearCacheUtility(bool use_low_integrity_level) {
 BOOL CALLBACK BrowserFactory::FindBrowserWindow(HWND hwnd, LPARAM arg) {
   // Could this be an IE instance?
   // 8 == "IeFrame\0"
-  // 21 == "Shell DocObject View\0";
+  // 21 == "Shell DocObject View\0"
+  // 19 == "Chrome_WidgetWin_1"
   char name[21];
   if (::GetClassNameA(hwnd, name, 21) == 0) {
     // No match found. Skip
     return TRUE;
   }
 
-  if (strcmp(IE_FRAME_WINDOW_CLASS, name) != 0 && 
+  if (strcmp(IE_FRAME_WINDOW_CLASS, name) != 0 &&
       strcmp(SHELL_DOCOBJECT_VIEW_WINDOW_CLASS, name) != 0) {
     return TRUE;
   }
 
   return EnumChildWindows(hwnd, FindChildWindowForProcess, arg);
 }
 
+BOOL CALLBACK BrowserFactory::FindEdgeWindow(HWND hwnd, LPARAM arg) {
+  // Could this be an EdgeChrome window?
+  // 19 == "Chrome_WidgetWin_1"
+  char name[20];
+  if (::GetClassNameA(hwnd, name, 20) == 0) {
+    // No match found. Skip
+    return TRUE;
+  }
+
+  // continue if it is not "Chrome_WidgetWin_1"
+  if (strcmp(ANDIE_FRAME_WINDOW_CLASS, name) != 0) return TRUE;
+
+  return EnumChildWindows(hwnd, FindEdgeChildWindowForProcess, arg);
+}
+
 BOOL CALLBACK BrowserFactory::FindChildWindowForProcess(HWND hwnd, LPARAM arg) {
   ProcessWindowInfo *process_window_info = reinterpret_cast<ProcessWindowInfo*>(arg);
 
@@ -971,6 +1053,7 @@ BOOL CALLBACK BrowserFactory::FindChildWindowForProcess(HWND hwnd, LPARAM arg) {
   } else {
     DWORD process_id = NULL;
     ::GetWindowThreadProcessId(hwnd, &process_id);
+    LOG(DEBUG) << "Looking for " << process_window_info->dwProcessId;
     if (process_window_info->dwProcessId == process_id) {
       // Once we've found the first Internet Explorer_Server window
       // for the process we want, we can stop.
@@ -982,6 +1065,33 @@ BOOL CALLBACK BrowserFactory::FindChildWindowForProcess(HWND hwnd, LPARAM arg) {
   return TRUE;
 }
 
+BOOL CALLBACK BrowserFactory::FindEdgeChildWindowForProcess(HWND hwnd, LPARAM arg) {
+  ProcessWindowInfo* process_window_info = reinterpret_cast<ProcessWindowInfo*>(arg);
+
+  // Could this be an Internet Explorer Server window?
+  // 25 == "Internet Explorer_Server\0"
+  char name[25];
+  if (::GetClassNameA(hwnd, name, 25) == 0) {
+    // No match found. Skip
+    return TRUE;
+  }
+
+  if (strcmp(IE_SERVER_CHILD_WINDOW_CLASS, name) != 0) {
+    return TRUE;
+  }
+  else {
+    DWORD process_id = NULL;
+    ::GetWindowThreadProcessId(hwnd, &process_id);
+    LOG(DEBUG) << "Looking for " << process_window_info->dwProcessId;
+    // Once we've found the first Internet Explorer_Server window
+    // for the process we want, we can stop.
+    process_window_info->hwndBrowser = hwnd;
+    return FALSE;
+  }
+
+  return TRUE;
+}
+
 BOOL CALLBACK BrowserFactory::FindDialogWindowForProcess(HWND hwnd, LPARAM arg) {
   ProcessWindowInfo* process_win_info = reinterpret_cast<ProcessWindowInfo*>(arg);
 
@@ -1243,5 +1353,8 @@ bool BrowserFactory::IsWindowsVistaOrGreater() {
   return IsWindowsVersionOrGreater(HIBYTE(_WIN32_WINNT_VISTA), LOBYTE(_WIN32_WINNT_VISTA), 0);
 }
 
+bool BrowserFactory::IsEdgeMode() const {
+  return this->edge_ie_mode_;
+}
 
 } // namespace webdriver

cpp/iedriver/BrowserFactory.h

@@ -36,13 +36,16 @@ struct BrowserFactorySettings {
   int browser_attach_timeout;
   std::string initial_browser_url;
   std::string browser_command_line_switches;
+  bool attach_to_edge_ie; // Used to attach to EdgeChromium IE processes
+  std::string edge_executable_path;
 };
 
 class BrowserFactory {
  public:
   BrowserFactory(void);
   virtual ~BrowserFactory(void);
 
+
   void Initialize(BrowserFactorySettings settings);
 
   DWORD LaunchBrowserProcess(std::string* error_message);
@@ -65,12 +68,17 @@ class BrowserFactory {
   int browser_version(void) const { return this->ie_major_version_; }
 
   static BOOL CALLBACK FindChildWindowForProcess(HWND hwnd, LPARAM arg);
+  static BOOL CALLBACK FindEdgeChildWindowForProcess(HWND hwnd, LPARAM arg);
   static BOOL CALLBACK FindDialogWindowForProcess(HWND hwnd, LPARAM arg);
 
   static bool IsWindowsVistaOrGreater(void);
 
+  bool IsEdgeMode(void) const;
  private:
   static BOOL CALLBACK FindBrowserWindow(HWND hwnd, LPARAM param);
+
+
+  static BOOL CALLBACK FindEdgeWindow(HWND hwnd, LPARAM param);
   static bool IsWindowsVersionOrGreater(unsigned short major_version,
                                         unsigned short minor_version,
                                         unsigned short service_pack);
@@ -97,6 +105,8 @@ class BrowserFactory {
   int GetZoomLevel(IHTMLDocument2* document, IHTMLWindow2* window);
   void LaunchBrowserUsingCreateProcess(PROCESS_INFORMATION* proc_info,
                                        std::string* error_message);
+  void LaunchEdgeInIEMode(PROCESS_INFORMATION* proc_info,
+                          std::string* error_message);
   void LaunchBrowserUsingIELaunchURL(PROCESS_INFORMATION* proc_info,
                                      std::string* error_message);
   bool IsIELaunchURLAvailable(void);
@@ -116,6 +126,9 @@ class BrowserFactory {
 
   int ie_major_version_;
   std::wstring ie_executable_location_;
+
+  bool edge_ie_mode_;
+  std::wstring edge_executable_location_;
 };
 
 } // namespace webdriver

cpp/iedriver/CommandHandlers/NewSessionCommandHandler.cpp

@@ -42,6 +42,7 @@ void NewSessionCommandHandler::ExecuteInternal(
 
   // Find W3C capabilities first.
   IECommandExecutor& mutable_executor = const_cast<IECommandExecutor&>(executor);
+
   ParametersMap::const_iterator it = command_parameters.find("capabilities");
   if (it != command_parameters.end()) {
     LOG(DEBUG) << "Found W3C capabilities structure";
@@ -411,8 +412,24 @@ void NewSessionCommandHandler::SetBrowserFactorySettings(const IECommandExecutor
                                                            false);
     factory_settings.clear_cache_before_launch = ensure_clean_session.asBool();
 
+    // By default, we should not be attaching to edge_ie
+    factory_settings.attach_to_edge_ie = false;
+    Json::Value attach_to_edgechrome = this->GetCapability(capabilities,
+                                                           ATTACH_TO_EDGE_CHROME,
+                                                           Json::booleanValue,
+                                                           false);
+    factory_settings.attach_to_edge_ie = attach_to_edgechrome.asBool();
+
+    Json::Value edge_executable_path = this->GetCapability(capabilities,
+                                                           EDGE_EXECUTABLE_PATH,
+                                                           Json::stringValue,
+                                                           Json::Value(Json::stringValue));
+    factory_settings.edge_executable_path = edge_executable_path.asString();
+
     IECommandExecutor& mutable_executor = const_cast<IECommandExecutor&>(executor);
     mutable_executor.browser_factory()->Initialize(factory_settings);
+    mutable_executor.set_is_edge_mode(factory_settings.attach_to_edge_ie);
+    mutable_executor.set_edge_executable_path(factory_settings.edge_executable_path);
   }
 }
 
@@ -552,6 +569,8 @@ Json::Value NewSessionCommandHandler::CreateReturnedCapabilities(const IECommand
   ie_options[ELEMENT_SCROLL_BEHAVIOR_CAPABILITY] = executor.input_manager()->scroll_behavior();
   ie_options[REQUIRE_WINDOW_FOCUS_CAPABILITY] = executor.input_manager()->require_window_focus();
   ie_options[FILE_UPLOAD_DIALOG_TIMEOUT_CAPABILITY] = executor.file_upload_dialog_timeout();
+  ie_options[ATTACH_TO_EDGE_CHROME] = executor.is_edge_mode();
+  ie_options[EDGE_EXECUTABLE_PATH] = executor.edge_executable_path();
 
   if (executor.proxy_manager()->is_proxy_set()) {
     ie_options[USE_PER_PROCESS_PROXY_CAPABILITY] = executor.proxy_manager()->use_per_process_proxy();