CML在GitLab 17.4.1中图片链接失效问题分析与解决方案

问题背景

在使用CML（Continuous Machine Learning）工具与GitLab 17.4.1版本集成时，用户发现通过cml comment create或cml comment update命令添加到合并请求(MR)评论中的图片无法正常显示。虽然图片实际上传成功，但生成的图片链接格式存在问题。

问题现象

当前CML生成的图片链接格式如下：

https://${myinstance}.gitlab.com/${mygroup}/${mysubgroup}/${myproject}/uploads/6aaacfcf584e185f78b6df984148ad6a/plot.png

而在GitLab 17.4.1中，这种格式的链接已经失效。实际可用的链接格式应为：

https://${myinstance}.gitlab.com/-/projects/${myprojectsid}/uploads/6aaacfcf584e185f78b6df984148ad6a/plot.png

技术分析

1. GitLab API变更：GitLab 17.x版本可能对文件上传路径处理逻辑进行了调整，导致基于项目路径的旧式URL不再适用。

2. CML实现机制：CML当前通过拼接GitLab API返回的上传路径和项目路径来构造图片URL，这种硬编码方式在GitLab更新后变得脆弱。

3. 最佳实践对比：GitLab原生上传功能使用的是相对路径格式/uploads/...，这种方式更加健壮，不受实例URL结构变化影响。

解决方案建议

1. 采用相对路径：建议CML改为使用GitLab原生的相对路径格式/uploads/...，这与用户手动上传时的行为一致，具有更好的兼容性。

2. URL构造优化：修改CML源码中GitLab驱动部分的URL生成逻辑，移除硬编码的项目路径部分，直接使用API返回的上传路径。

3. 向后兼容：在实现变更时需要考虑对旧版本GitLab的兼容性，可以通过版本检测或配置选项来灵活处理。

实现影响

这一改动将带来以下好处：

• 提高与GitLab新版本的兼容性
• 减少因GitLab URL结构调整导致的失效风险
• 保持与原生GitLab行为的一致性
• 简化URL生成逻辑

总结

CML与GitLab集成时图片链接失效问题反映了API依赖的脆弱性。通过采用更健壮的相对路径方案，可以提升工具的稳定性和用户体验。建议开发团队评估并实施这一改进方案。