TurboStreams权限与动态UI实现技巧

本文针对Rails应用中Turbo Streams实时更新场景下，服务器端权限（如Pundit）无法直接应用于流式内容的问题，提出了一种基于StimulusJS的客户端权限控制解决方案。该方案通过监听`turbo:before-stream-render`事件，拦截Turbo Stream渲染过程，在客户端异步请求资源权限信息，并动态调整UI元素的可见性。通过服务器端辅助方法、视图层修改、JSON模板暴露权限以及Stimulus控制器处理渲染事件等步骤，实现了在Turbo Streams环境中根据用户权限动态调整UI，规避了服务器端权限策略在特定上下文中的限制，为需要精细化UI权限管理的Web应用提供了一个灵活且强大的解决方案。

本文详细介绍了在Rails应用中使用Turbo Streams进行实时更新时，如何解决服务器端权限（如Pundit）无法直接应用于流式内容的问题。通过结合StimulusJS和Turbo Streams的生命周期事件，我们展示了如何在客户端接收并渲染Turbo Stream内容后，动态地通过AJAX请求获取资源权限，并据此调整UI元素的可见性，从而实现精细化的客户端权限控制。

利用Stimulus和Turbo Streams实现客户端权限控制

在现代Rails应用中，Hotwire框架（特别是Turbo Streams）为实时更新提供了强大而简洁的解决方案。然而，当涉及到需要根据用户权限动态显示或隐藏UI元素时，传统的服务器端权限管理库（如Pundit）在Turbo Streams的上下文中可能会遇到挑战。这是因为Turbo Streams通常通过ActionCable推送预渲染的HTML片段，这些片段在服务器端渲染时，可能无法访问完整的请求上下文（例如Warden::Proxy实例），导致权限策略无法正确评估。

本文将详细介绍一种解决方案，该方案通过在客户端拦截Turbo Stream的渲染过程，并结合StimulusJS控制器，在内容被添加到DOM后，异步获取并应用用户权限，从而实现动态的UI控制。

问题背景

假设一个Rails应用使用Turbo Streams实时更新项目列表。每个列表项都包含“编辑”和“删除”按钮，其可见性应根据当前用户的权限（例如，通过Pundit策略policy(my_model).edit?判断）来决定。当列表项通过Turbo Stream更新或创建时，如果直接在服务器端渲染的Turbo Stream片段中执行Pundit策略，可能会因为缺少请求上下文而失败，导致权限判断失效。

为了解决这个问题，我们的策略是在服务器端不对这些敏感按钮进行权限判断，而是默认隐藏它们。然后，在客户端接收并渲染Turbo Stream内容后，通过JavaScript（StimulusJS）异步请求该资源的权限信息，并根据返回结果动态显示或隐藏按钮。

解决方案步骤

1. 服务器端：检测Turbo Stream请求并辅助视图渲染

为了避免在Turbo Stream请求中执行Pundit策略时出现错误，我们首先在ApplicationController中定义一个辅助方法，用于检测当前请求是否为Turbo Stream类型。

# app/controllers/application_controller.rb

def turbo_stream?
  formats.any?(:turbo_stream)
end
helper_method :turbo_stream?

这个turbo_stream?辅助方法可以在视图中使用，以便在渲染Turbo Stream时跳过Pundit权限检查，并默认隐藏需要权限控制的按钮。

2. 视图层：资源局部视图的修改

在资源局部视图中，我们需要进行以下修改：

• 条件渲染与默认隐藏： 当turbo_stream?为真时，跳过Pundit检查，并为需要权限控制的按钮添加d-none类（Bootstrap的隐藏类），使其默认不可见。
• 添加数据属性： 为资源容器添加data-resource-url属性，指向该资源的JSON API端点，以便客户端能够获取其详细信息和权限。
• 标识操作按钮： 为“编辑”和“删除”按钮添加data-resource-action属性，以便Stimulus控制器能够方便地选择并操作它们。

<!-- app/views/resource/_resource.html.erb -->

<%= turbo_frame_tag resource do %>
  <div id="<%= dom_id resource %>"
       data-resource-url="<%= resource_path(resource, format: :json) %>">

    <!-- 省略其他代码 -->

    <% if turbo_stream? || policy(resource).edit? %>
      <%= link_to edit_resource_path(resource),
                  class: "btn btn-primary #{'d-none' if turbo_stream?}",
                  data: { resource_action: :edit } do %>
        <i class="las la-edit"></i>
        <span class="d-none d-lg-inline">
          <%= t("buttons.edit") %>
        </span>
      <% end %>
    <% end %>

    <% if turbo_stream? || policy(resource).destroy? %>
      <%= link_to resource,
                  class: "btn btn-danger #{'d-none' if turbo_stream?}",
                  data: {
                    resource_action: :destroy,
                    turbo_confirm: t("confirm.short"),
                    turbo_method: :delete
                  } do %>
        <i class="las la-trash-alt"></i>
        <span class="d-none d-lg-inline">
          <%= t("buttons.remove") %>
        </span>
      <% end %>
    <% end %>

  </div>
<% end %>

3. JSON模板：暴露资源权限

为了让客户端能够获取资源的权限信息，我们需要修改资源的JSON模板，使其包含当前用户的编辑和删除权限。

# app/views/resources/_resource.json.jbuilder

json.permissions do
  json.edit policy(resource).edit?
  json.destroy policy(resource).destroy?
end

注意： 在这个JSON模板中，policy(resource).edit?和policy(resource).destroy?是直接在服务器端执行的，但这是在处理一个标准的JSON API请求时，而不是在渲染Turbo Stream时，因此Pundit能够正确访问请求上下文。

4. 客户端：Stimulus控制器处理Turbo Stream渲染事件

核心逻辑在于创建一个Stimulus控制器，它监听turbo:before-stream-render事件。这个事件允许我们在Turbo Stream内容被渲染到DOM之前拦截它。我们将修改事件的render方法，使其在执行默认渲染逻辑之后，再运行我们自定义的权限处理逻辑。

// app/javascript/controllers/turbostream_controller.js

import Rails from "@rails/ujs"
import { Controller } from "@hotwired/stimulus"

export default class extends Controller {
  // Stimulus 控制器连接时，添加事件监听器
  connect() {
    // 监听 turbo:before-stream-render 事件
    addEventListener("turbo:before-stream-render",
                     (e) => { this.beforeStreamRender(e) })
  }

  // 处理 turbo:before-stream-render 事件
  beforeStreamRender(event) {
    // 保存 Turbo Stream 默认的渲染方法
    const defaultAction = event.detail.render
    // 覆盖默认的渲染方法，在执行完默认渲染后，再调用我们的处理逻辑
    event.detail.render = (streamElement) => {
      defaultAction(streamElement) // 执行 Turbo Stream 的默认渲染
      try {
        this.processStream(streamElement) // 执行自定义的流处理逻辑
      } catch(error) {
        console.error("Error processing Turbo Stream:", error)
      }
    }
  }

  // 处理渲染后的 Turbo Stream 元素
  processStream(streamElement) {
    // 检查 Turbo Stream 的动作类型，只处理 'prepend', 'append', 'update'
    if (["prepend", "append", "update"].includes(streamElement.action)) {
        // 获取流元素中的模板内容
        var template = streamElement.children[0].content
        // 在模板内容中查找带有 data-resource-url 属性的 div
        var templateDiv = template.querySelector('[data-resource-url]')
        if (templateDiv != null) {
          // 获取资源的 DOM ID
          var id = templateDiv.getAttribute('id')
          // 调用方法设置动作按钮的可见性
          this.setActionButtonVisibility(id)
        }
    }
  }

  // 根据权限设置动作按钮的可见性
  setActionButtonVisibility(id) {
    // 查找 DOM 中对应的资源 div
    var div = document.querySelector(`div#${id}`)
    if (!div) {
      console.warn(`Resource div with id ${id} not found.`)
      return;
    }
    // 获取资源的 URL
    var url = div.getAttribute('data-resource-url')
    // 查找编辑和删除按钮
    var editButton = div.querySelector('[data-resource-action="edit"]')
    var destroyButton = div.querySelector('[data-resource-action="destroy"]')

    // 如果按钮不存在，则无需进一步处理
    if (!editButton && !destroyButton) {
      return;
    }

    // 使用 Rails UJS 发送 AJAX GET 请求获取权限数据
    Rails.ajax({
      type: "GET",
      url: url,
      success: (data, _status, _xhr) => {
        try {
          // 根据返回的权限数据，切换按钮的 'd-none' 类
          // 如果 data.permissions.edit 为 false，则添加 'd-none'，否则移除
          if (editButton) {
            editButton.classList.toggle('d-none', !data.permissions.edit)
          }
          if (destroyButton) {
            destroyButton.classList.toggle('d-none', !data.permissions.destroy)
          }
        } catch(error) {
          console.error("Error setting action button visibility:", error)
        }
      },
      error: (xhr, status, error) => {
        console.error(`Failed to fetch permissions for ${url}:`, status, error);
      }
    })
  }
}

5. 整合Stimulus控制器

最后一步是将Stimulus控制器连接到你的视图。只需将包含Turbo Stream更新内容的区域用一个带有data-controller="turbostream"属性的div包裹起来即可。

<!-- app/views/resource/index.html.erb -->

<div data-controller="turbostream">
  <!-- 你的原始资源列表代码，例如： -->
  <%= turbo_stream_from "resources" %>
  <div id="resources">
    <% @resources.each do |resource| %>
      <%= render resource %>
    <% end %>
  </div>
</div>

注意事项与总结

• 额外请求： 这种方法引入了一个额外的AJAX请求，每次通过Turbo Stream创建或更新资源时，都会向服务器请求该资源的权限信息。对于权限因资源而异的场景，这几乎是不可避免的权衡。
• 用户体验： 按钮会短暂地默认隐藏，然后在权限加载后才显示。这可能会导致微小的UI闪烁，但通常在可接受范围内。
• 安全性： 客户端的权限控制仅影响UI显示，后端API端点仍需严格执行服务器端权限检查，以防止未经授权的操作。
• 可扩展性： 这种模式对于需要根据用户权限动态调整UI的复杂场景非常有用，例如显示不同用户界面的不同操作、状态或内容。

通过上述步骤，我们成功地在Rails Turbo Streams环境中实现了客户端权限控制，确保了实时更新的UI能够根据用户的具体权限动态调整，同时规避了服务器端权限策略在特定上下文中的限制。这种方法提供了一个灵活且强大的解决方案，适用于需要精细化UI权限管理的Web应用。

本篇关于《TurboStreams权限与动态UI实现技巧》的介绍就到此结束啦，但是学无止境，想要了解学习更多关于文章的相关知识，请关注golang学习网公众号！