Jenkins 遭遇 CORS 错误？如何解决？

2024-07-11 19:23:05

Jenkins 遭遇 CORS 错误？Nginx 和 CORS 插件都救不了它？

你是否也曾被 Jenkins 突如其来的 CORS 错误搞得焦头烂额？明明安装了 CORS 插件，Nginx 配置也检查了一遍又一遍，可它还是时不时地跳出来刷存在感。别担心，本文将带你抽丝剥茧，揭开 Jenkins 间歇性 CORS 错误的神秘面纱，并奉上解决问题的锦囊妙计。

问题场景

很多开发者都碰到过这样的情况，浏览器控制台赫然显示着这样的错误信息：

Access to XMLHttpRequest at 'https://backend.<MY_WEBSITE>.com/api/authenticate-admin' from origin 'https://admin.<MY_WEBSITE>.com' has been blocked by CORS policy: Response to preflight request doesn't pass access control check: No 'Access-Control-Allow-Origin' header is present on the requested resource.

错误信息明白地告诉我们，浏览器阻止了 Jenkins (https://admin.<MY_WEBSITE>.com) 发起的跨域请求访问后端 API (https://backend.<MY_WEBSITE>.com/api/authenticate-admin)，罪魁祸首正是 CORS 策略。

让人百思不解的是，明明已经安装了 Jenkins CORS 插件，Nginx 反向代理配置也检查了无数遍，问题却如同幽灵般挥之不去，时而出现，时而消失，让人抓狂。

深入剖析

要想解决问题，必须先了解问题的本质。浏览器在处理跨域请求时，会先发送一个“探子”——预检请求 (preflight request)，询问服务器是否允许该跨域请求。服务器收到“探子”后，需要在响应头中添加 Access-Control-Allow-Origin 等 CORS 相关字段，明确告知浏览器允许哪些来源的请求访问。

从报错信息来看，问题出在预检请求的响应上，服务器并没有在响应中包含 Access-Control-Allow-Origin 头信息，导致浏览器拒绝了后续的实际请求。

排除了 Nginx 配置问题，那么问题可能潜藏在以下几个地方：

Jenkins CORS 插件配置失误 : 插件安装了，但不代表配置就万无一失，可能存在配置错误导致插件形同虚设。
缓存作祟 : 浏览器、代理服务器或 Jenkins 服务器可能缓存了之前的错误响应，导致问题反复出现。
插件之间“不和” : 其他 Jenkins 插件可能与 CORS 插件存在冲突，导致 CORS 功能失效。
Jenkins 版本“Bug” : 某些 Jenkins 版本可能存在 bug，导致 CORS 功能不稳定。

解决方案

针对以上分析，我们可以采取以下步骤逐一排查：

1. 检查 Jenkins CORS 插件配置

进入 Jenkins 管理页面，找到 CORS 插件配置。
确保插件已启用，并正确配置了允许访问的域名。
可以尝试将 * 添加到允许访问的域名列表中，但这会降低安全性，不建议在生产环境使用。

2. 清理缓存

清理浏览器缓存，特别是与域名 https://admin.<MY_WEBSITE>.com 和 https://backend.<MY_WEBSITE>.com 相关的缓存。
如果使用了代理服务器，也需要清理代理服务器缓存。
重启 Jenkins 服务，清除服务器端的缓存。

3. 排查插件冲突

禁用其他非必要的 Jenkins 插件，尤其是与网络请求相关的插件。
逐个启用插件，观察问题是否再次出现，从而定位到冲突的插件。
尝试更新或更换与 CORS 功能冲突的插件。

4. 更新 Jenkins 版本

查看 Jenkins 官方网站，确认当前使用的 Jenkins 版本是否存在已知的 CORS 相关 bug。
尝试升级 Jenkins 到最新版本，新版本通常会修复之前版本中存在的问题。

5. 分析 Nginx 日志

检查 Nginx 访问日志和错误日志，查看预检请求的响应信息。
确认 Nginx 是否正确转发了预检请求，以及后端服务器是否返回了正确的 CORS 响应头。
如果 Nginx 配置了缓存，尝试禁用缓存或清理缓存。

6. 后端服务配置

检查后端服务的代码或框架配置，确保正确设置了 CORS 响应头。
某些框架或库需要安装额外的 CORS 相关模块或插件，才能正确处理 CORS 请求。

常见问题解答

为什么安装了 CORS 插件还是会出现跨域问题？
- CORS 插件配置错误，例如允许访问的域名设置不正确。
- 其他插件与 CORS 插件冲突，导致 CORS 功能失效。
- Jenkins 版本存在 bug，导致 CORS 功能不稳定。
Nginx 已经配置了 CORS，为什么浏览器还会报跨域错误？
- Nginx 缓存了之前的错误响应，需要清理缓存。
- Nginx 配置的 CORS 响应头不完整，例如缺少 Access-Control-Allow-Credentials 等字段。
- Nginx 并没有正确转发预检请求到后端服务器。
如何排查是哪个插件与 CORS 插件冲突？
- 逐个禁用非必要的插件，然后逐个启用，观察问题是否再次出现，从而定位到冲突的插件。
除了更新 Jenkins 版本，还有其他方法解决 CORS 问题吗？
- 尝试使用其他 CORS 插件，或者手动修改 Jenkins 的配置文件来实现 CORS 功能。
如何避免 Jenkins 出现 CORS 问题？
- 在部署 Jenkins 时，仔细阅读官方文档，正确配置 CORS 插件和 Nginx。
- 尽量使用最新版本的 Jenkins，并及时更新插件。
- 避免安装不必要的插件，并定期清理缓存。