PSAppDeployToolkit中Start-ADTMsiProcess的PassThru参数问题解析

问题背景

在使用PSAppDeployToolkit 4.0.6版本时，开发者发现Start-ADTMsiProcess命令在使用-PassThru参数时存在一个预期外的行为：当MSI安装失败时，该参数无法返回任何输出结果。这与Start-ADTProcess命令的行为有所不同，后者可以通过添加-ErrorAction SilentlyContinue参数来获取失败进程的结果。

技术分析

Start-ADTMsiProcess是PSAppDeployToolkit中用于处理MSI安装的核心命令之一。其设计初衷是简化MSI包的部署过程，包括错误处理和日志记录等功能。在正常情况下，当MSI安装失败时，工具会抛出错误并终止执行流程。

PassThru参数的设计目的是允许命令返回执行结果对象，而不是直接处理执行结果。这在需要进一步处理安装结果的场景中非常有用。然而，在原始实现中，Start-ADTMsiProcess未能正确处理错误情况下的PassThru行为。

解决方案比较

开发者提出了两种可能的解决方案：

1. 修改ErrorAction传递机制：确保Start-ADTMsiProcess能够将其ErrorAction参数正确传递给Start-ADTProcess。这种方法更符合PowerShell的标准行为模式。

2. 使用IgnoreExitCodes参数：通过指定-IgnoreExitCodes参数（如-IgnoreExitCodes *）来显式忽略所有退出代码，强制返回执行结果。这种方法更加明确，但可能不够直观。

经过讨论和测试，项目维护者选择了第一种方案，通过提交代码修复了ErrorAction参数的传递问题。同时，为了增强工具的可用性，文档中也添加了明确的说明，指出在需要获取失败执行结果时，必须使用以下方式之一：

• 设置ErrorAction为SilentlyContinue或Ignored
• 使用IgnoreExitCodes或SuccessExitCodes参数

最佳实践建议

对于使用PSAppDeployToolkit的开发者，在处理可能失败的MSI安装时，建议：

1. 如果需要获取安装结果进行后续处理，应同时使用PassThru和适当的错误处理参数：

   $result = Start-ADTMsiProcess -FilePath 'package.msi' -PassThru -ErrorAction SilentlyContinue
   

2. 对于已知可能失败的特定退出代码，使用IgnoreExitCodes进行精确控制：

   $result = Start-ADTMsiProcess -FilePath 'package.msi' -PassThru -IgnoreExitCodes 1603,3010
   

3. 在日志记录和错误处理中，充分利用返回的结果对象中的详细信息。

总结

这个问题的修复体现了PSAppDeployToolkit项目对用户体验的持续改进。通过正确处理ErrorAction参数的传递，工具现在能够提供更加一致和灵活的行为，使开发者能够更好地控制MSI安装过程的结果处理流程。这也提醒我们在使用自动化部署工具时，要仔细阅读文档并理解各参数间的交互关系，以确保获得预期的行为。