Haskell Cabal 3.14 数据文件路径处理问题分析

在 Haskell 生态系统中，Cabal 是一个重要的构建工具和包管理系统。近期在 Cabal 3.14 版本中发现了一个关于数据文件路径处理的回归问题，这个问题影响了 alex 和 happy 等工具的测试套件执行。

问题现象

当使用 Cabal 3.14 构建 alex-3.4.0.1 和 happy-1.20.1.1 并启用测试时，测试套件会因找不到数据文件而失败。具体表现为测试过程中出现类似如下的错误信息：

happy: Uncaught exception ghc-internal:GHC.Internal.IO.Exception.IOException:
data//HappyTemplate-arrays-coerce: openFile: does not exist (No such file or directory)

这个问题在 v1-test 和 Setup.hs 测试模式下出现，但在 v2-test 模式下工作正常。这是一个明显的回归问题，因为在 Cabal 3.12 版本中不存在此问题。

问题根源

经过深入分析，问题的根源在于 Cabal 3.14 对数据文件路径的处理方式发生了变化。在 3.12 版本中，Cabal 会为数据文件路径设置绝对路径（如 /codetmp/alex-3.5.2.0/data/），而在 3.14 版本中则改为了相对路径（如 data/）。

这种变化源于 Cabal 3.14 中引入的一个修改，该修改影响了 interpretSymbolicPath 函数的使用方式。这个函数原本设计用于处理符号路径，但在数据文件路径的场景下，应该使用绝对路径而非相对路径。

技术细节

在 alex 和 happy 的测试套件中，测试程序会改变当前工作目录，这是测试场景中常见的行为。当数据文件路径被设置为相对路径时，一旦工作目录改变，程序就无法正确找到数据文件的位置。

Cabal 3.14 中的相关代码变更如下：

-      dataDirPath = pwd </> PD.dataDir pkg_descr
+      rawDataDir = PD.dataDir pkg_descr
+      dataDirPath
+        | null $ getSymbolicPath rawDataDir =
+            interpretSymbolicPath mbWorkDir sameDirectory
+        | otherwise =
+            interpretSymbolicPath mbWorkDir rawDataDir

interpretSymbolicPath 函数的文档明确指出，当与外部程序交互时，应该设置进程的工作目录并使用 interpretSymbolicPathCWD，而不是直接调用这个函数。因为如果工作目录是绝对路径，这个函数会将相对路径转换为绝对路径，这可能会破坏预期的行为。

解决方案

修复方案是确保在需要绝对路径的场景下（如设置 alex_datadir 环境变量时）使用绝对路径而非相对路径。这需要调整 interpretSymbolicPath 的使用方式，或者在某些特定场景下绕过该函数直接构造绝对路径。

影响范围

这个问题主要影响：

1. 使用数据文件（data-files）的包
2. 在测试套件中改变工作目录的包
3. 使用 v1-test 或 Setup.hs 测试模式的用户

特别是像 alex 和 happy 这样的工具链基础工具，它们通常被用来构建 Cabal 本身，因此这个问题会带来较大的影响。

总结

Cabal 3.14 中引入的路径处理变更导致了一些包在测试时无法正确找到数据文件。这个问题的本质是在应该使用绝对路径的场景下错误地使用了相对路径。修复方案已经提交，将确保在需要绝对路径的场景下正确使用绝对路径。

对于用户来说，如果遇到类似问题，可以暂时降级到 Cabal 3.12 版本，或者等待包含修复的新版本发布。这也提醒我们，在修改基础工具的核心路径处理逻辑时需要更加谨慎，充分考虑各种使用场景。