Refactor current shutdown monitoring and add synchronization system for component attach

Author: JohnMcPMS

src/AppInstallerCLICore/AppInstallerCLICore.vcxproj

@@ -346,6 +346,7 @@
     <ClInclude Include="ContextOrchestrator.h" />
     <ClInclude Include="COMContext.h" />
     <ClInclude Include="Public\ConfigurationSetProcessorFactoryRemoting.h" />
+    <ClInclude Include="Public\ShutdownMonitoring.h" />
     <ClInclude Include="Sixel.h" />
     <ClInclude Include="Workflows\ConfigurationFlow.h" />
     <ClInclude Include="Workflows\DependenciesFlow.h" />
@@ -419,6 +420,7 @@
     <ClCompile Include="ConfigurationWingetDscModuleUnitValidation.cpp" />
     <ClCompile Include="ConfigureExportCommand.cpp" />
     <ClCompile Include="ContextOrchestrator.cpp" />
+    <ClCompile Include="ShutdownMonitoring.cpp" />
     <ClCompile Include="Sixel.cpp" />
     <ClCompile Include="Workflows\ConfigurationFlow.cpp" />
     <ClCompile Include="Workflows\DependenciesFlow.cpp" />
@@ -504,4 +506,4 @@
     <Error Condition="!Exists('$(SolutionDir)\packages\Microsoft.Windows.CppWinRT.2.0.230706.1\build\native\Microsoft.Windows.CppWinRT.props')" Text="$([System.String]::Format('$(ErrorTextNuget)', '$(SolutionDir)\packages\Microsoft.Windows.CppWinRT.2.0.230706.1\build\native\Microsoft.Windows.CppWinRT.props'))" />
     <Error Condition="!Exists('$(SolutionDir)\packages\Microsoft.Windows.CppWinRT.2.0.230706.1\build\native\Microsoft.Windows.CppWinRT.targets')" Text="$([System.String]::Format('$(ErrorTextNuget)', '$(SolutionDir)\packages\Microsoft.Windows.CppWinRT.2.0.230706.1\build\native\Microsoft.Windows.CppWinRT.targets'))" />
   </Target>
-</Project>
+</Project>

src/AppInstallerCLICore/AppInstallerCLICore.vcxproj.filters

@@ -293,6 +293,9 @@
     <ClInclude Include="Commands\DscAdminSettingsResource.h">
       <Filter>Commands\Configuration</Filter>
     </ClInclude>
+    <ClInclude Include="Public\ShutdownMonitoring.h">
+      <Filter>Public</Filter>
+    </ClInclude>
   </ItemGroup>
   <ItemGroup>
     <ClCompile Include="pch.cpp">
@@ -553,6 +556,9 @@
     <ClCompile Include="Commands\DscAdminSettingsResource.cpp">
       <Filter>Commands\Configuration</Filter>
     </ClCompile>
+    <ClCompile Include="ShutdownMonitoring.cpp">
+      <Filter>Source Files</Filter>
+    </ClCompile>
   </ItemGroup>
   <ItemGroup>
     <None Include="PropertySheet.props" />

src/AppInstallerCLICore/Commands/TestCommand.cpp

@@ -8,6 +8,7 @@
 #include "AppInstallerRuntime.h"
 #include "TableOutput.h"
 #include "Public/ConfigurationSetProcessorFactoryRemoting.h"
+#include "Public/ShutdownMonitoring.h"
 #include "Workflows/ConfigurationFlow.h"
 #include <winrt/Microsoft.Management.Configuration.h>
 
@@ -27,7 +28,7 @@ namespace AppInstaller::CLI
         HRESULT WaitForShutdown(Execution::Context& context)
         {
             LogAndReport(context, "Waiting for app shutdown event");
-            if (!Execution::WaitForAppShutdownEvent())
+            if (!ShutdownMonitoring::TerminationSignalHandler::Instance().WaitForAppShutdownEvent())
             {
                 LogAndReport(context, "Failed getting app shutdown event");
                 return APPINSTALLER_CLI_ERROR_INTERNAL_ERROR;
@@ -39,7 +40,7 @@ namespace AppInstaller::CLI
 
         HRESULT AppShutdownWindowMessage(Execution::Context& context)
         {
-            auto windowHandle = Execution::GetWindowHandle();
+            auto windowHandle = ShutdownMonitoring::TerminationSignalHandler::Instance().GetWindowHandle();
 
             if (windowHandle == NULL)
             {

src/AppInstallerCLICore/ExecutionContext.cpp

@@ -6,6 +6,7 @@
 #include "COMContext.h"
 #include "Command.h"
 #include "ExecutionContext.h"
+#include "Public/ShutdownMonitoring.h"
 #include <winget/Checkpoint.h>
 #include <winget/Reboot.h>
 #include <winget/UserSettings.h>
@@ -19,262 +20,6 @@ namespace AppInstaller::CLI::Execution
 
     namespace
     {
-        // Type to contain the CTRL signal and window messages handler.
-        struct SignalTerminationHandler
-        {
-            static SignalTerminationHandler& Instance()
-            {
-                static SignalTerminationHandler s_instance;
-                return s_instance;
-            }
-
-            void AddContext(Context* context)
-            {
-                std::lock_guard<std::mutex> lock{ m_contextsLock };
-
-                auto itr = std::find(m_contexts.begin(), m_contexts.end(), context);
-                THROW_HR_IF(E_NOT_VALID_STATE, itr != m_contexts.end());
-                m_contexts.push_back(context);
-            }
-
-            void RemoveContext(Context* context)
-            {
-                std::lock_guard<std::mutex> lock{ m_contextsLock };
-
-                auto itr = std::find(m_contexts.begin(), m_contexts.end(), context);
-                THROW_HR_IF(E_NOT_VALID_STATE, itr == m_contexts.end());
-                m_contexts.erase(itr);
-            }
-
-            void StartAppShutdown()
-            {
-                // Lifetime manager sends CTRL-C after the WM_QUERYENDSESSION is processed.
-                // If we disable the CTRL-C handler, the default handler will kill us.
-                TerminateContexts(CancelReason::AppShutdown, true);
-
-#ifndef AICLI_DISABLE_TEST_HOOKS
-                m_appShutdownEvent.SetEvent();
-#endif
-            }
-
-#ifndef AICLI_DISABLE_TEST_HOOKS
-            HWND GetWindowHandle() { return m_windowHandle.get(); }
-
-            bool WaitForAppShutdownEvent()
-            {
-                return m_appShutdownEvent.wait(60000);
-            }
-#endif
-
-        private:
-            SignalTerminationHandler()
-            {
-                if (Runtime::IsRunningAsAdmin() && Runtime::IsRunningInPackagedContext())
-                {
-                    m_catalog = winrt::Windows::ApplicationModel::PackageCatalog::OpenForCurrentPackage();
-                    m_updatingEvent = m_catalog.PackageUpdating(
-                        winrt::auto_revoke, [this](winrt::Windows::ApplicationModel::PackageCatalog, winrt::Windows::ApplicationModel::PackageUpdatingEventArgs args)
-                        {
-                            // There are 3 events being hit with 0%, 1% and 38%
-                            // Typically the window message is received between the first two.
-                            constexpr double minProgress = 0;
-                            auto progress = args.Progress();
-                            if (progress > minProgress)
-                            {
-                                SignalTerminationHandler::Instance().StartAppShutdown();
-                            }
-                        });
-                }
-                else
-                {
-                    // Create message only window.
-                    m_messageQueueReady.create();
-                    m_windowThread = std::thread(&SignalTerminationHandler::CreateWindowAndStartMessageLoop, this);
-                    if (!m_messageQueueReady.wait(100))
-                    {
-                        AICLI_LOG(CLI, Warning, << "Timeout creating winget window");
-                    }
-                }
-
-                // Set up ctrl-c handler.
-                LOG_IF_WIN32_BOOL_FALSE(SetConsoleCtrlHandler(StaticCtrlHandlerFunction, TRUE));
-
-#ifndef AICLI_DISABLE_TEST_HOOKS
-                m_appShutdownEvent.create();
-#endif
-            }
-
-            ~SignalTerminationHandler()
-            {
-                // At this point the thread is gone, but it will get angry
-                // if there's no call to join.
-                if (m_windowThread.joinable())
-                {
-                    m_windowThread.join();
-                }
-            }
-
-            static BOOL WINAPI StaticCtrlHandlerFunction(DWORD ctrlType)
-            {
-                return Instance().CtrlHandlerFunction(ctrlType);
-            }
-
-            static LRESULT WINAPI WindowMessageProcedure(HWND hWnd, UINT uMsg, WPARAM wParam, LPARAM lParam)
-            {
-                AICLI_LOG(CLI, Verbose, << "Received window message type: " << uMsg);
-                switch (uMsg)
-                {
-                case WM_QUERYENDSESSION:
-                    SignalTerminationHandler::Instance().StartAppShutdown();
-                    return TRUE;
-                case WM_ENDSESSION:
-                case WM_CLOSE:
-                    DestroyWindow(hWnd);
-                    break;
-                case WM_DESTROY:
-                    PostQuitMessage(0);
-                    break;
-                default:
-                    return DefWindowProc(hWnd, uMsg, wParam, lParam);
-                }
-                return FALSE;
-            }
-
-            BOOL CtrlHandlerFunction(DWORD ctrlType)
-            {
-                // TODO: Move this to be logged per active context when we have thread static globals
-                AICLI_LOG(CLI, Info, << "Got CTRL type: " << ctrlType);
-
-                switch (ctrlType)
-                {
-                case CTRL_C_EVENT:
-                case CTRL_BREAK_EVENT:
-                    return TerminateContexts(CancelReason::CtrlCSignal, false);
-                    // According to MSDN, we should never receive these due to having gdi32/user32 loaded in our process.
-                    // But handle them as a force terminate anyway.
-                case CTRL_CLOSE_EVENT:
-                case CTRL_LOGOFF_EVENT:
-                case CTRL_SHUTDOWN_EVENT:
-                    return TerminateContexts(CancelReason::CtrlCSignal, true);
-                default:
-                    return FALSE;
-                }
-            }
-
-            // Terminates the currently attached contexts.
-            // Returns FALSE if no contexts attached; TRUE otherwise.
-            BOOL TerminateContexts(CancelReason reason, bool force)
-            {
-                if (m_contexts.empty())
-                {
-                    return FALSE;
-                }
-
-                {
-                    std::lock_guard<std::mutex> lock{ m_contextsLock };
-                    for (auto& context : m_contexts)
-                    {
-                        context->Cancel(reason, force);
-                    }
-                }
-
-                return TRUE;
-            }
-
-            void CreateWindowAndStartMessageLoop()
-            {
-                PCWSTR windowClass = L"wingetWindow";
-                HINSTANCE hInstance = GetModuleHandle(NULL);
-                if (hInstance == NULL)
-                {
-                    LOG_LAST_ERROR_MSG("Failed getting module handle");
-                    return;
-                }
-
-                WNDCLASSEX wcex = {};
-                wcex.cbSize = sizeof(wcex);
-
-                wcex.style = CS_NOCLOSE;
-                wcex.lpfnWndProc = SignalTerminationHandler::WindowMessageProcedure;
-                wcex.cbClsExtra = 0;
-                wcex.cbWndExtra = 0;
-                wcex.hInstance = hInstance;
-                wcex.lpszClassName = windowClass;
-
-                if (!RegisterClassEx(&wcex))
-                {
-                    LOG_LAST_ERROR_MSG("Failed registering window class");
-                    return;
-                }
-
-                m_windowHandle = wil::unique_hwnd(CreateWindow(
-                    windowClass,
-                    L"WingetMessageOnlyWindow",
-                    WS_OVERLAPPEDWINDOW,
-                    0, /* x */
-                    0, /* y */
-                    0, /* nWidth */
-                    0, /* nHeight */
-                    NULL, /* hWndParent */
-                    NULL, /* hMenu */
-                    hInstance,
-                    NULL)); /* lpParam */
-
-                if (m_windowHandle == nullptr)
-                {
-                    LOG_LAST_ERROR_MSG("Failed creating window");
-                    return;
-                }
-
-                ShowWindow(m_windowHandle.get(), SW_HIDE);
-
-                // Force message queue to be created.
-                MSG msg;
-                PeekMessage(&msg, NULL, WM_USER, WM_USER, PM_NOREMOVE);
-                m_messageQueueReady.SetEvent();
-
-                // Message loop
-                BOOL getMessageResult;
-                while ((getMessageResult = GetMessage(&msg, m_windowHandle.get(), 0, 0)) != 0)
-                {
-                    if (getMessageResult == -1)
-                    {
-                        LOG_LAST_ERROR();
-                    }
-                    else
-                    {
-                        DispatchMessage(&msg);
-                    }
-                }
-            }
-
-#ifndef AICLI_DISABLE_TEST_HOOKS
-            wil::unique_event m_appShutdownEvent;
-#endif
-
-            std::mutex m_contextsLock;
-            std::vector<Context*> m_contexts;
-            wil::unique_event m_messageQueueReady;
-            wil::unique_hwnd m_windowHandle;
-            std::thread m_windowThread;
-            winrt::Windows::ApplicationModel::PackageCatalog m_catalog = nullptr;
-            decltype(winrt::Windows::ApplicationModel::PackageCatalog{ nullptr }.PackageUpdating(winrt::auto_revoke, nullptr)) m_updatingEvent;
-        };
-
-        void SetSignalTerminationHandlerContext(bool add, Context* context)
-        {
-            THROW_HR_IF(E_POINTER, context == nullptr);
-
-            if (add)
-            {
-                SignalTerminationHandler::Instance().AddContext(context);
-            }
-            else
-            {
-                SignalTerminationHandler::Instance().RemoveContext(context);
-            }
-        }
-
         bool ShouldRemoveCheckpointDatabase(HRESULT hr)
         {
             switch (hr)
@@ -356,7 +101,7 @@ namespace AppInstaller::CLI::Execution
 
     void Context::EnableSignalTerminationHandler(bool enabled)
     {
-        SetSignalTerminationHandlerContext(enabled, this);
+        ShutdownMonitoring::TerminationSignalHandler::EnableListener(enabled, this);
         m_disableSignalTerminationHandlerOnExit = enabled;
     }
 
@@ -487,16 +232,6 @@ namespace AppInstaller::CLI::Execution
     {
         return (m_shouldExecuteWorkflowTask ? m_shouldExecuteWorkflowTask(task) : true);
     }
-
-    HWND GetWindowHandle()
-    {
-        return SignalTerminationHandler::Instance().GetWindowHandle();
-    }
-
-    bool WaitForAppShutdownEvent()
-    {
-        return SignalTerminationHandler::Instance().WaitForAppShutdownEvent();
-    }
 #endif
 
     void ContextEnumBasedVariantMapActionCallback(const void* map, Data data, EnumBasedVariantMapAction action)

src/AppInstallerCLICore/ExecutionContext.h

@@ -7,6 +7,7 @@
 #include "ExecutionContextData.h"
 #include "CompletionData.h"
 #include "CheckpointManager.h"
+#include <AppInstallerProgress.h>
 #include <winget/Checkpoint.h>
 
 #include <string_view>
@@ -91,7 +92,7 @@ namespace AppInstaller::CLI::Execution
     // The context within which all commands execute.
     // Contains input/output via Execution::Reporter and
     // arguments via Execution::Args.
-    struct Context : EnumBasedVariantMap<Data, details::DataMapping, ContextEnumBasedVariantMapActionCallback>
+    struct Context : EnumBasedVariantMap<Data, details::DataMapping, ContextEnumBasedVariantMapActionCallback>, ICancellable
     {
         Context() = default;
         Context(std::ostream& out, std::istream& in) : Reporter(out, in) {}
@@ -139,7 +140,7 @@ namespace AppInstaller::CLI::Execution
         // Cancel the context; this terminates it as well as informing any in progress task to stop cooperatively.
         // Multiple attempts with CancelReason::CancelSignal may cause the process to simply exit.
         // The bypassUser indicates whether the user should be asked for cancellation (does not currently have any effect).
-        void Cancel(CancelReason reason, bool bypassUser = false);
+        void Cancel(CancelReason reason, bool bypassUser = false) override;
 
         // Gets context flags
         ContextFlag GetFlags() const