WiX Toolset - почему коллекция CustomActionData пуста для немедленного действия CustomAction после InstallFinalize? - PullRequest
0 голосов
/ 10 октября 2018

Я использую WiX v3.14 для сборки установщика .Net Core.У меня есть CustomAction - UpdateJsonAppSettings - написанный на C #, который предназначен для обновления файла appsettings.json, являющегося частью установки (со строкой подключения к базе данных, созданной из полей, введенных пользователем, выполняющим установку).Когда я планирую выполнение CustomAction как немедленного для запуска After = "InstallFinalize", коллекция CustomActionData, запланированная с помощью Before = "UpdateJsonAppSettings", коллекция 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:

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?

1 Ответ

0 голосов
/ 11 октября 2018

Большое спасибо за предложение Стейна - оно в конечном итоге позволило мне найти решение, хотя это было далеко не просто.Я не уверен, как изложить это объяснение так же, как сделать ваш комментарий правильным ответом.

Я обнаружил, что установил элемент CustomDataAction, который определил путь к appsettings.json в CustomAction,хотя отображается правильно при отправке в session.Log, это НЕ то, что было на самом деле установлено (см. ПРЕДУПРЕЖДЕНИЕ в строке).

    [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 для содержания «реального» элемента filepath - это установить его в CustomAction типа 51 (я думаю) в Product.wxs.Никакая другая комбинация, которую я пробовал, не сработала.

Фрагмент рабочего кода из 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, в то время как скомпилированный код установщика фактически использует разные значения).

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...