时间戳

首页 > 解决方案 > WiX 工具集 - 为什么在 InstallFinalize 之后立即执行 CustomAction 的 CustomActionData 集合为空？

wix - WiX 工具集 - 为什么在 InstallFinalize 之后立即执行 CustomAction 的 CustomActionData 集合为空？

问题描述

我正在使用 WiX v3.14 构建一个 .Net Core 安装程序。我有一个 CustomAction - UpdateJsonAppSettings - 用 C# 编写，旨在更新作为安装一部分的 appsettings.json 文件（使用执行安装的用户输入的字段构建的数据库连接字符串）。当我将 CustomAction 安排为立即运行 After="InstallFinalize" 时，使用 Before="UpdateJsonAppSettings" 安排的 CustomActionData 集合，session.CustomActionData 集合为空。

<CustomAction Id="SetCustomActionData"
              Return="check"
              Property="UpdateJsonAppSettings"
              Value="connectionString=[CONNECTION_STRING_FORMATTED];filepath=[PATH_TO_APPSETTINGS_JSON]" />

<CustomAction Id="UpdateJsonAppSettings"
              BinaryKey="CustomActions"
              DllEntry="UpdateJsonAppSettings" 
              Execute="immediate" 
              Return="ignore" />

<InstallExecuteSequence>
  <Custom Action="ConnectionString" Before="SetCustomActionData" />
  <Custom Action="SetCustomActionData" Before="UpdateJsonAppSettings" />
  <Custom Action="UpdateJsonAppSettings" After="InstallFinalize">NOT Installed AND NOT PATCH</Custom>
</InstallExecuteSequence>

会话日志：

Session.Log:
MSI (s) (C8:8C) [11:15:44:363]: Doing action: SetCustomActionData
Action 11:15:44: SetCustomActionData. 
Action start 11:15:44: SetCustomActionData.
MSI (s) (C8:8C) [11:15:44:379]: PROPERTY CHANGE: Adding UpdateJsonAppSettings property. Its value is 'connectionString=Data Source=localhost\SQLEXPRESS;;Initial Catalog=DB;;User Id=dbuser;;Password=dbuserpassword;;MultipleActiveResultSets=true;;App=EntityFramework;filepath=[#appSettings]'.
Action ended 11:15:44: SetCustomActionData. Return value 1.

[SNIP]

Action start 11:15:44: UpdateJsonAppSettings.
MSI (s) (C8:B8) [11:15:44:382]: Invoking remote custom action. DLL: C:\windows\Installer\MSI95BF.tmp, Entrypoint: UpdateJsonAppSettings
SFXCA: Extracting custom action to temporary directory: C:\TEMP\MSI95BF.tmp-\
SFXCA: Binding to CLR version v4.0.30319
Calling custom action CustomActions!CustomActions.CustomAction.UpdateJsonAppSettings
Session.CustomActionData.Count(): 0
Exception thrown by custom action:
System.Reflection.TargetInvocationException: Exception has been thrown by the target of an invocation. ---> System.Collections.Generic.KeyNotFoundException: The given key was not present in the dictionary.

当我将 CustomAction UpdateJsonAppSettings 修改为 Execute="deferred" 并将其安排在“InstallFiles”之后时，CustomActionData 已正确设置并且可用于 CustomAction，但安装失败并出现 File not found 异常。Scheduled Before="InstallFinalize" 失败并出现同样的异常。

Session.Log:
Calling custom action CustomActions!CustomActions.CustomAction.UpdateJsonAppSettings
Session.CustomActionData.Count(): 2
key: connectionString, value: Data Source=localhost\SQLEXPRESS;Initial Catalog=DB;User Id=dbuser;Password=dbuserpassword;MultipleActiveResultSets=true;App=EntityFramework
key: filepath, value: C:\inetpub\wwwroot\ServiceApi\appsettings.json
UpdateJsonAppSettings() returned: NotExecuted; _result: File not found:C:\inetpub\wwwroot\ServiceApi\appsettings.json; filepath: C:\inetpub\wwwroot\ServiceApi\appsettings.json; connectionString: Data Source=localhost\SQLEXPRESS;Initial Catalog=DB;User Id=dbuser;Password=dbuserpassword;MultipleActiveResultSets=true;App=EntityFramework

这看起来像是 Catch-22 的情况。感激地收到任何帮助。

PS - 出于某种原因，我的原始帖子最终出现在 META-StackExchange 上？

标签： wix

解决方案

非常感谢 Stein 的建议——它最终让我找到了解决方案，尽管这绝非易事。我不确定如何提出这个解释以及如何将您的评论设置为正确答案。

我发现在 CustomAction 中设置定义 appsettings.json 路径的 CustomDataAction 元素，虽然在发送到 session.Log 时正确显示，但并不是实际设置的内容（参见 WARNING in-line）。

    [CustomAction]
    public static ActionResult SetCustomActionData(Session session)
    {
        CustomActionData _data = new CustomActionData();
        // ..escape single ';'
        string _connectionString = session["CONNECTION_STRING"];
        _connectionString.Replace(";", ";;");
        _data["connectionString"] = _connectionString;
        // ..correctly output in install log
        session.Log(string.Format("SetCustomActionData() setting _connectionString: {0}", _connectionString));
        // Property set to [#appSettings] in Product.wxs
        string _filePath = session["PATH_TO_APPSETTINGS_JSON"];
        _data["filepath"] = _filePath;
        // ..correctly output in install log
        session.Log(string.Format("SetCustomActionData() setting _filepath: {0}", _filePath));
        // ..set the CustomActionData programmatically
        session["UpdateJsonAppSettings"] = _data.ToString();

        return ActionResult.Success;
    }

    Install.log:
    [SNIP]
    SetCustomActionData() setting _connectionString: 'Data Source=localhost\SQLEXPRESS;;Initial Catalog=...'
    SetCustomActionData() setting _filepath: 'C:\inetpub\wwwroot\UServiceApi\appsettings.json'

    [CustomAction]
    public static ActionResult UpdateJsonAppSettings(Session session)
    {
        // ..as per Stein's suggestion
        MessageBox.Show("Attach run32dll.dll now");
        // ..correctly output to log (i.e. 2)
        session.Log(string.Format("Session.CustomActionData.Count(): {0}", session.CustomActionData.Count));
        // ..correctly output two key/value pairs to log
        foreach(string _key in session.CustomActionData.Keys)
            session.Log(string.Format("key: {0}, value: {1}", _key, session.CustomActionData[_key]));

        string _connectionString = session.CustomActionData["connectionString"];
        string _pathToAppSettings = session.CustomActionData["filepath"];
        // WARNING: _pathToAppSettings has reverted to the literal "[#appSettings]" - which of course triggers File not found Exception.
        ActionResult _retVal = UpdateJsonConnectionString(_connectionString, _pathToAppSettings, out string _result);
        // ..log failure
        if (_retVal != ActionResult.Success)
            session.Log(string.Format("UpdateJsonAppSettings() returned: {0}; _result: {1}; filepath: {2}; connectionString: {3}", 
                                      _retVal, _result, _pathToAppSettings, _connectionString));

        return _retVal;
    }

    Install.log:
    [SNIP]
    key: connectionString, value: Data Source=localhost\SQLEXPRESS;Initial Catalog=...
    key: filepath, value: C:\inetpub\wwwroot\UServiceApi\appsettings.json
    [SNIP]
    UpdateJsonAppSettings() returned: NotExecuted; _result: File not found:C:\inetpub\wwwroot\ServiceApi\appsettings.json...

我尝试了许多不同的 Properties 和 CustomAction 实现组合，但最终发现正确设置 CustomActionData 以包含“真实”文件路径元素的唯一方法是将其设置为 Product.wxs 中的 Type 51（我认为）CustomAction。我尝试过的其他组合都没有。

Product.wxs 中的工作代码片段：

<Property Id="PATH_TO_APPSETTINGS_JSON" Value="[#appSettings]" />

<CustomAction Id="SetCustomActionData" 
              Return="check" 
              Property="UpdateJsonAppSettings" 
              Value="connectionString=[CONNECTION_STRING_FORMATTED];filepath=[#appSettings]" />// NOTE: cannot use filepath=[PATH_TO_APPSETTINGS_JSON] here

结论：一个可能的 WiX 错误 - 日志没有说实话（它选择性地“翻译”CustomActionData 元素，而编译的安装程序代码实际上使用不同的值）。

推荐阅读