Move projects to use latest WebView2 SDK 0.9.627-prerelease

Author: peiche-ms

SampleApps/WebView2APISample/App.cpp

@@ -12,6 +12,7 @@
 #include <shobjidl.h>
 #include <string.h>
 #include <vector>
+
 #include "AppWindow.h"
 #include "DpiUtil.h"
 
@@ -101,6 +102,10 @@ int APIENTRY wWinMain(HINSTANCE hInstance,
                 {
                     creationModeId = IDM_CREATION_MODE_VISUAL_DCOMP;
                 }
+                else if (NEXT_PARAM_CONTAINS(L"targetdcomp"))
+                {
+                    creationModeId = IDM_CREATION_MODE_TARGET_DCOMP;
+                }
                 else if (NEXT_PARAM_CONTAINS(L"visualwincomp"))
                 {
                     creationModeId = IDM_CREATION_MODE_VISUAL_WINCOMP;

SampleApps/WebView2APISample/AppWindow.cpp

@@ -6,12 +6,14 @@
 
 #include "AppWindow.h"
 
+#include <DispatcherQueue.h>
 #include <functional>
 #include <string>
 #include <vector>
 #include <ShObjIdl_core.h>
 #include <Shellapi.h>
 #include <ShlObj_core.h>
+#include <winrt/windows.system.h>
 #include "App.h"
 #include "CheckFailure.h"
 #include "ControlComponent.h"
@@ -48,6 +50,9 @@ AppWindow::AppWindow(
       m_initialUri(initialUri),
       m_onWebViewFirstInitialized(webviewCreatedCallback)
 {
+    // Initialize COM as STA.
+    CHECK_FAILURE(CoInitializeEx(NULL, COINIT_APARTMENTTHREADED | COINIT_DISABLE_OLE1DDE));
+
     ++s_appInstances;
 
     WCHAR szTitle[s_maxLoadString]; // The title bar text
@@ -328,6 +333,7 @@ bool AppWindow::ExecuteAppCommands(WPARAM wParam, LPARAM lParam)
         return true;
     case IDM_CREATION_MODE_WINDOWED:
     case IDM_CREATION_MODE_VISUAL_DCOMP:
+    case IDM_CREATION_MODE_TARGET_DCOMP:
     case IDM_CREATION_MODE_VISUAL_WINCOMP:
         m_creationModeId = LOWORD(wParam);
         UpdateCreationModeMenu();
@@ -446,10 +452,11 @@ void AppWindow::InitializeWebView()
     // getting created which will apply the browser switches.
     CloseWebView();
     m_dcompDevice = nullptr;
-    m_wincompHelper = nullptr;
+    m_wincompCompositor = nullptr;
     LPCWSTR subFolder = nullptr;
 
-    if (m_creationModeId == IDM_CREATION_MODE_VISUAL_DCOMP)
+    if (m_creationModeId == IDM_CREATION_MODE_VISUAL_DCOMP ||
+        m_creationModeId == IDM_CREATION_MODE_TARGET_DCOMP)
     {
         HRESULT hr = DCompositionCreateDevice2(nullptr, IID_PPV_ARGS(&m_dcompDevice));
         if (!SUCCEEDED(hr))
@@ -465,7 +472,7 @@ void AppWindow::InitializeWebView()
     }
     else if (m_creationModeId == IDM_CREATION_MODE_VISUAL_WINCOMP)
     {
-        HRESULT hr = CreateWinCompCompositor();
+        HRESULT hr = TryCreateDispatcherQueue();
         if (!SUCCEEDED(hr))
         {
             MessageBox(
@@ -476,10 +483,11 @@ void AppWindow::InitializeWebView()
                 L"Create with Windowless WinComp Visual Failed", MB_OK);
             return;
         }
+        m_wincompCompositor = winrtComp::Compositor();
     }
     //! [CreateCoreWebView2EnvironmentWithOptions]
-    auto options = Microsoft::WRL::Make<CoreWebView2ExperimentalEnvironmentOptions>();
-    CHECK_FAILURE(options->put_IsSingleSignOnUsingOSPrimaryAccountEnabled(
+    auto options = Microsoft::WRL::Make<CoreWebView2EnvironmentOptions>();
+    CHECK_FAILURE(options->put_AllowSingleSignOnUsingOSPrimaryAccount(
         m_AADSSOEnabled ? TRUE : FALSE));
     if (!m_language.empty())
         CHECK_FAILURE(options->put_Language(m_language.c_str()));
@@ -516,7 +524,7 @@ HRESULT AppWindow::OnCreateEnvironmentCompleted(
 
     auto webViewExperimentalEnvironment =
         m_webViewEnvironment.try_query<ICoreWebView2ExperimentalEnvironment>();
-    if (webViewExperimentalEnvironment && (m_dcompDevice || m_wincompHelper))
+    if (webViewExperimentalEnvironment && (m_dcompDevice || m_wincompCompositor))
     {
         CHECK_FAILURE(webViewExperimentalEnvironment->CreateCoreWebView2CompositionController(
             m_mainWindow,
@@ -565,7 +573,9 @@ HRESULT AppWindow::OnCreateCoreWebView2ControllerCompleted(HRESULT result, ICore
         NewComponent<SettingsComponent>(
             this, m_webViewEnvironment.get(), m_oldSettingsComponent.get());
         m_oldSettingsComponent = nullptr;
-        NewComponent<ViewComponent>(this, m_dcompDevice.get(), m_wincompHelper.get());
+        NewComponent<ViewComponent>(
+            this, m_dcompDevice.get(), m_wincompCompositor,
+            m_creationModeId == IDM_CREATION_MODE_TARGET_DCOMP);
         NewComponent<ControlComponent>(this, &m_toolbar);
 
         // We have a few of our own event handlers to register here as well
@@ -694,11 +704,8 @@ void AppWindow::RegisterEventHandlers()
                 CHECK_FAILURE(args->GetDeferral(&deferral));
                 AppWindow* newAppWindow;
 
-                wil::com_ptr<ICoreWebView2ExperimentalNewWindowRequestedEventArgs>
-                    experimentalArgs;
-                CHECK_FAILURE(args->QueryInterface(IID_PPV_ARGS(&experimentalArgs)));
-                wil::com_ptr<ICoreWebView2ExperimentalWindowFeatures> windowFeatures;
-                CHECK_FAILURE(experimentalArgs->get_WindowFeatures(&windowFeatures));
+                wil::com_ptr<ICoreWebView2WindowFeatures> windowFeatures;
+                CHECK_FAILURE(args->get_WindowFeatures(&windowFeatures));
 
                 RECT windowRect = {0};
                 UINT32 left = 0;
@@ -863,9 +870,6 @@ void AppWindow::CloseWebView(bool cleanupUserDataFolder)
 
 HRESULT AppWindow::DeleteFileRecursive(std::wstring path)
 {
-    // Initialize COM as STA.
-    CHECK_FAILURE(CoInitializeEx(NULL, COINIT_APARTMENTTHREADED | COINIT_DISABLE_OLE1DDE));
-
     wil::com_ptr<IFileOperation> fileOperation;
     CHECK_FAILURE(
         CoCreateInstance(CLSID_FileOperation, NULL, CLSCTX_ALL, IID_PPV_ARGS(&fileOperation)));
@@ -1030,37 +1034,49 @@ HRESULT AppWindow::DCompositionCreateDevice2(IUnknown* renderingDevice, REFIID r
     return hr;
 }
 
-// Helper function that loads WebView2APISampleWinCompHelper.dll which provides an
-// IWinCompHelper abstraction for building a WinComp visual tree. The DLL is dynamically
-// loaded to create the helper interface and create the compositor. Not having a static
-// dependency on WebView2APISampleWinCompHelper.dll enables the sample app to run on
-// versions of Windows that don't support WinComp (since the DLL has a static dependency on
-// WinComp).
-HRESULT AppWindow::CreateWinCompCompositor()
+// WinRT APIs cannot run without a DispatcherQueue. This helper function creates a
+// DispatcherQueueController (which instantiates a DispatcherQueue under the covers) that will
+// manage tasks for the WinRT APIs. The DispatcherQueue implementation lives in
+// CoreMessaging.dll Similar to dcomp.dll, we load CoreMessaging.dll dynamically so the sample
+// app can run on versions of windows that don't have CoreMessaging.
+HRESULT AppWindow::TryCreateDispatcherQueue()
 {
-    HRESULT hr = E_FAIL;
-    static decltype(::CreateWinCompHelper)* fnCreateWinCompHelper = nullptr;
-    if (fnCreateWinCompHelper == nullptr)
+    namespace winSystem = winrt::Windows::System;
+
+    HRESULT hr = S_OK;
+    thread_local winSystem::DispatcherQueueController dispatcherQueueController{ nullptr };
+
+    if (dispatcherQueueController == nullptr)
     {
-        // Use SetErrorMode to ensure an error dialog doesn't pop up if the
-        // WebView2APISampleWinCompHelper.dll fails to load for a missing dependency.
-        SetErrorMode(SEM_FAILCRITICALERRORS | SEM_NOOPENFILEERRORBOX);
-        HMODULE hmod = ::LoadLibraryEx(L"WebView2APISampleWinCompHelper.dll", nullptr, 0);
-        if (hmod != nullptr)
+        hr = E_FAIL;
+        static decltype(::CreateDispatcherQueueController)* fnCreateDispatcherQueueController =
+            nullptr;
+        if (fnCreateDispatcherQueueController == nullptr)
         {
-            fnCreateWinCompHelper = reinterpret_cast<decltype(::CreateWinCompHelper)*>(
-                ::GetProcAddress(hmod, "CreateWinCompHelper"));
+            HMODULE hmod = ::LoadLibraryEx(L"CoreMessaging.dll", nullptr, 0);
+            if (hmod != nullptr)
+            {
+                fnCreateDispatcherQueueController =
+                    reinterpret_cast<decltype(::CreateDispatcherQueueController)*>(
+                        ::GetProcAddress(hmod, "CreateDispatcherQueueController"));
+            }
         }
-        SetErrorMode(0);
-    }
-    if (fnCreateWinCompHelper != nullptr)
-    {
-        hr = fnCreateWinCompHelper(&m_wincompHelper);
-        if (SUCCEEDED(hr))
+        if (fnCreateDispatcherQueueController != nullptr)
         {
-            hr = m_wincompHelper->CreateCompositor();
+            winSystem::DispatcherQueueController controller{ nullptr };
+            DispatcherQueueOptions options
+            {
+                sizeof(DispatcherQueueOptions),
+                DQTYPE_THREAD_CURRENT,
+                DQTAT_COM_STA
+            };
+            hr = fnCreateDispatcherQueueController(
+                options, reinterpret_cast<ABI::Windows::System::IDispatcherQueueController**>(
+                             winrt::put_abi(controller)));
+            dispatcherQueueController = controller;
         }
     }
+
     return hr;
 }
 

SampleApps/WebView2APISample/AppWindow.h

@@ -16,9 +16,11 @@
 #include <string>
 #include <vector>
 #include <winnt.h>
-#include "WebView2APISample_WinCompHelper/WebView2APISample_WinCompHelper.h"
+#include <winrt/Windows.UI.Composition.h>
 #include <winrt/Windows.UI.ViewManagement.h>
 
+namespace winrtComp = winrt::Windows::UI::Composition;
+
 class SettingsComponent;
 
 class AppWindow
@@ -127,10 +129,10 @@ class AppWindow
 
     // Compositor creation helper methods
     HRESULT DCompositionCreateDevice2(IUnknown* renderingDevice, REFIID riid, void** ppv);
-    HRESULT CreateWinCompCompositor();
+    HRESULT TryCreateDispatcherQueue();
 
     wil::com_ptr<IDCompositionDevice> m_dcompDevice;
-    wil::com_ptr<IWinCompHelper> m_wincompHelper;
+    winrtComp::Compositor m_wincompCompositor{ nullptr };
     winrt::Windows::UI::ViewManagement::UISettings m_uiSettings{ nullptr };
 };
 

SampleApps/WebView2APISample/DCompTargetImpl.cpp

@@ -0,0 +1,32 @@
+// Copyright (C) Microsoft Corporation. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#include "stdafx.h"
+
+#include "DCompTargetImpl.h"
+
+DCompTargetImpl::DCompTargetImpl(ViewComponent* owner)
+{
+    m_viewComponentOwner = owner;
+}
+
+void DCompTargetImpl::RemoveOwnerRef()
+{
+    m_viewComponentOwner = nullptr;
+}
+
+HRESULT __stdcall DCompTargetImpl::SetRoot(IDCompositionVisual* visual)
+{
+    HRESULT hr = S_OK;
+    if (m_viewComponentOwner)
+    {
+        hr = m_viewComponentOwner->m_dcompWebViewVisual->RemoveAllVisuals();
+        if (SUCCEEDED(hr) && visual)
+        {
+            hr = m_viewComponentOwner->m_dcompWebViewVisual->AddVisual(visual, FALSE, nullptr);
+        }
+    }
+
+    return hr;
+}

SampleApps/WebView2APISample/DCompTargetImpl.h

@@ -0,0 +1,24 @@
+// Copyright (C) Microsoft Corporation. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#pragma once
+
+#include "stdafx.h"
+
+#include "ViewComponent.h"
+
+class DCompTargetImpl
+    : public Microsoft::WRL::RuntimeClass<
+    Microsoft::WRL::RuntimeClassFlags<Microsoft::WRL::ClassicCom>, IDCompositionTarget>
+{
+public:
+    DCompTargetImpl(ViewComponent* owner);
+    void RemoveOwnerRef();
+
+    // Inherited via IDCompositionTarget
+    virtual HRESULT __stdcall SetRoot(IDCompositionVisual* visual) override;
+
+private:
+    ViewComponent* m_viewComponentOwner;
+};

SampleApps/WebView2APISample/ScenarioAddHostObject.html

@@ -21,7 +21,7 @@ <h2>Set Property</h2>
     <div><code><pre><span id="setPropertyAsyncOutput"></span></pre></code></div>
 
     <button id="setPropertyExplicitAsyncButton">Set property explicit async</button><input type="text" id="setPropertyExplicitAsyncInput" placeholder="String property value" />
-    <label for="setPropertyExplicitAsyncButton">Runs <code>await chrome.webview.hostObjects.sample.setRemote("property", value)</code> which waits for the property to be set.</label>
+    <label for="setPropertyExplicitAsyncButton">Runs <code>await chrome.webview.hostObjects.sample.setHostProperty("property", value)</code> which waits for the property to be set.</label>
     <div><code><pre><span id="setPropertyExplicitAsyncOutput"></span></pre></code></div>
 
     <button id="setPropertySyncButton">Set property sync</button><input type="text" id="setPropertySyncInput" placeholder="String property value" />
@@ -66,15 +66,15 @@ <h2>Invoke Callback</h2>
         document.getElementById("setPropertyAsyncButton").addEventListener("click", async () => {
         const propertyValue = document.getElementById("setPropertyAsyncInput").value;
         // The following line will work but it will return immediately before the property value has actually been set.
-        // If you need to set the property and wait for the property to change value, use the setRemote function.
+        // If you need to set the property and wait for the property to change value, use the setHostProperty function.
         chrome.webview.hostObjects.sample.property = propertyValue;
         document.getElementById("setPropertyAsyncOutput").textContent = "Set";
         });
 
         document.getElementById("setPropertyExplicitAsyncButton").addEventListener("click", async () => {
         const propertyValue = document.getElementById("setPropertyExplicitAsyncInput").value;
-        // If you care about waiting until the property has actually changed value use the setRemote function.
-        await chrome.webview.hostObjects.sample.setRemote("property", propertyValue);
+        // If you care about waiting until the property has actually changed value use the setHostProperty function.
+        await chrome.webview.hostObjects.sample.setHostProperty("property", propertyValue);
         document.getElementById("setPropertyExplicitAsyncOutput").textContent = "Set";
         });