Kroki项目中PlantUML包含路径问题的分析与解决

问题背景

Kroki是一个开源的图表渲染服务，它支持多种图表描述语言，其中包括PlantUML。在Kroki 0.21.0版本升级后，用户报告了一个关于PlantUML包含路径功能的问题。

问题现象

在Kroki 0.20.0及之前版本中，用户可以通过配置KROKI_PLANTUML_INCLUDE_PATH环境变量来设置PlantUML的包含路径，例如设置为/home/kroki/include。然后在使用PlantUML时，可以通过相对路径引用库文件：

@startuml JWTInjection
!global $LIB_BASE_LOCATION="tmorin-plantuml-libs-11.1.0"
!include $LIB_BASE_LOCATION/bootstrap.puml

然而，在升级到Kroki 0.21.0后，这种相对路径引用方式不再工作，系统会返回错误："Error 400: cannot include tmorin-plantuml-libs-11.1.0/bootstrap.puml"。用户必须改为使用绝对路径才能正常工作：

@startuml JWTInjection
!global $LIB_BASE_LOCATION="/home/kroki/include/tmorin-plantuml-libs-11.1.0"
!include $LIB_BASE_LOCATION/bootstrap.puml

技术分析

这个问题的根源在于Kroki 0.21.0版本开始使用了PlantUML的二进制版本，而不是之前的Java库形式。这种变化带来了以下技术影响：

1. 配置方式变化：在Java库形式下，PlantUML的包含路径可以通过Java系统属性plantuml.include.path来配置。而在二进制版本中，需要通过不同的方式来设置这个路径。

2. 路径解析差异：二进制版本对相对路径的解析方式可能与Java库版本有所不同，导致相对路径引用失效。

3. 安全限制：Kroki的安全模式(KROKI_SAFE_MODE)可能对路径访问施加了更严格的限制。

解决方案

针对这个问题，开发团队需要从以下几个方面进行解决：

1. 二进制版本的配置支持：需要研究如何在PlantUML二进制版本中正确设置包含路径，可能需要通过命令行参数或环境变量来传递plantuml.include.path配置。

2. 路径解析逻辑：可能需要调整Kroki服务中对PlantUML调用的封装逻辑，确保相对路径能够正确解析到配置的包含路径下。

3. 兼容性考虑：为了保持向后兼容性，应该尽量维持0.20.0版本的行为，或者提供清晰的升级指南说明配置变化。

临时解决方案

对于急需解决问题的用户，可以采取以下临时方案：

1. 使用绝对路径引用库文件
2. 检查Kroki容器的文件系统权限，确保服务账户有权限访问包含目录
3. 暂时回退到0.20.0版本

总结

这个问题展示了在开源项目升级过程中可能遇到的兼容性挑战，特别是当底层依赖从库形式变为二进制形式时。开发团队需要仔细评估这种变化对现有功能的影响，并确保关键功能如路径解析能够继续正常工作。对于用户而言，了解这种底层变化有助于更好地诊断和解决问题。