如何调试Rails以追踪Accept请求头生成及处理格式判定流程？

问题场景 #

触发表单提交动作时，浏览器发送的Accept请求头为：

Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8

预期Turbo会自动注入text/vnd.turbo-stream.html到Accept头中，但实际并未生效。更棘手的是，即使在ApplicationController最靠前的before_action中设置binding.break断点，此时请求的处理格式已经被判定为HTML：

Started POST "/ops/aggregate_items?id=23" for ::1 at 2024-05-30 10:17:22 +0200
Processing by OpsController#aggregate_items as HTML
     5|   before_action :set_clean_host_site
[...]
     8|   def set_clean_host_site
=>   9|  binding.break

页面中使用form_with生成的表单配置了Turbo和turbo_stream格式：

<%= form_with url: aggregate_items_ops_path(id: main_container_item.id), data: { turbo: true, format: :turbo_stream } do |form| %>

渲染后的HTML为：

<form data-turbo="true" data-format="turbo_stream" action="/ops/aggregate_items?id=23" accept-charset="UTF-8" method="post">
</form>

但请求仍被当作HTML格式处理。

逐步追踪流程的具体步骤 #

1. 深入Rails路由匹配阶段的格式解析 #

Rails在路由匹配环节就会完成请求格式的初步判定，早于控制器的before_action执行。可以通过以下方式断点追踪：

• 在调试器中直接给核心方法设置断点：

  break ActionDispatch::Request#format
  

  这个方法是Rails解析请求格式的入口，会整合Accept头、请求参数、路由约束等信息生成最终格式。
• 临时修改ActionDispatch::Routing::RouteSet::Dispatcher#call方法，在路由匹配前加入断点，查看请求到达路由时的原始格式信息。

2. 验证Turbo的请求拦截逻辑 #

Turbo应该拦截带有data-turbo="true"和data-format="turbo_stream"的表单提交，修改请求的Accept头。可以通过浏览器开发者工具排查：

• 在浏览器Console中监听Turbo请求事件，打印请求头确认是否被修改：

  document.addEventListener('turbo:before-fetch-request', (event) => {
    console.log('Request Accept header:', event.detail.fetchOptions.headers.get('Accept'));
  });
  

• 在Turbo源码中找到表单提交拦截逻辑（比如submitForm方法），断点查看是否正确读取了data-format属性，并执行了Accept头的注入操作。

3. 排查Rails格式协商的优先级逻辑 #

Rails确定请求格式的优先级顺序为：路由中的:format占位符 → 请求参数中的format → Accept头。可以针对这几点验证：

• 检查路由配置是否包含format约束，比如是否显式指定支持turbo_stream：

  post '/ops/aggregate_items', to: 'ops#aggregate_items', format: [:html, :turbo_stream]
  

• 给格式协商核心方法设置断点：

  break ActionDispatch::Http::MimeNegotiation#negotiate_format
  

  查看它如何从各个来源确定最终的请求格式。

4. 检查自定义中间件的干扰 #

项目中的自定义中间件可能在路由匹配前修改了请求的Accept头或格式参数：

• 执行rails middleware列出所有中间件，检查是否有中间件提前处理了请求格式。
• 逐一禁用自定义中间件，测试请求格式是否恢复正常，定位可能的干扰源。

内容的提问来源于stack exchange，提问作者Jerome