Bài viết này một phần lấy cảm hứng từ chương sắp tới của sách Advanced CableReady của tác giả, và được điều chỉnh cho bài khách này trên AppSignal.
Thông báo (notifications) là mối quan tâm chéo (cross-cutting concern) điển hình chung cho nhiều ứng dụng web.
Gem Noticed làm phát triển thông báo cực kỳ dễ dàng bằng cách cung cấp model backed bởi database và các phương thức delivery (phân phối) có thể gắn thêm (pluggable) cho ứng dụng Ruby on Rails. Nó đi kèm hỗ trợ built-in cho mailers, websockets, và một vài phương thức delivery khác.
Chúng ta cũng sẽ xem xét ưu điểm của việc dùng gem CableReady để kích hoạt thông báo hệ thống trong ứng dụng Ruby on Rails.
Hãy đi vào vấn đề!
Điều Kiện Tiên Quyết & Yêu Cầu
Thỉnh thoảng, bạn có thể cần kích hoạt thông báo hệ thống từ app. Bạn có thể đạt được điều này với Notifications API.
Ví dụ, giả sử ứng dụng cho phép người dùng tải file lớn mất nhiều thời gian để transcode. Bạn có thể muốn gửi thông báo cho người dùng khi upload video hoàn tất. Điều này có nghĩa là họ có thể chuyển sang task mới trong lúc đó và không phải giữ ứng dụng mở vài phút.
May mắn thay, dễ dàng triển khai và fleshing out (làm đầy đủ) thông báo hệ thống với hai điều kiện tiên quyết:
- Noticed hỗ trợ custom delivery methods (Notified expose API đơn giản để triển khai bất kỳ cơ chế truyền tải nào bạn thích — ví dụ, post đến Discord servers).
- CableReady có operation notification (thông báo) trong kho tên lửa của nó.
Danh sách yêu cầu cho CableReady và Noticed ngắn gọn — bạn chỉ cần:
- một ActionCable server đang chạy
- một ActiveJob backend (thường dùng bởi Noticed)
Lưu ý: Toàn bộ mã mẫu cho dự án này có sẵn trên GitHub. Bạn cũng có thể làm theo dưới đây — chúng tôi sẽ hướng dẫn từng bước.
CableReady Primer Cho Ứng Dụng Ruby on Rails
Hãy bắt đầu bằng cách làm quen với CableReady. Ra mắt năm 2017, nó có thể được coi là "thư viện chuẩn ActionCable bị thiếu".
Trước khi Turbo xuất hiện, cách duy nhất tạo real-time app trong Ruby on Rails là qua ActionCable. ActionCable là wrapper native Rails quanh WebSockets, cung cấp API cả server-side và client-side để gửi tin nhắn qua kết nối bền vững theo cả hai hướng bất kỳ lúc nào.
Nhược điểm của cách tiếp cận này (và vẫn là) là bạn phải viết rất nhiều boilerplate code để làm cho nó xảy ra.
Đây là nơi CableReady giúp bằng cách cung cấp lớp trừu tượng (abstraction layer) quanh hàng loạt DOM operations được kích hoạt trên server. Một vài ví dụ bao gồm:
- DOM mutations (
inner_html,insert_adjacent_html,morph, v.v.) - DOM element property mutations (
add_css_class,remove_css_class,set_dataset_property, v.v.) - dispatching arbitrary DOM events
- browser history manipulations
- notifications (chúng ta sẽ tận dụng)
Server Và Client CableReady
CableReady làm phép màu như thế nào? Tóm lại, nó bao gồm phần server-side và client-side.
Phía server, module CableReady::Broadcaster có thể được include vào bất kỳ phần nào của ứng dụng cần nó. Điều này có thể là trong job, model callback, hoặc controller đơn giản. Nhưng trước hết, một ActionCable channel phải có mặt. Trích tài liệu chính thức CableReady:
Lưu ý visitors được gọi là stream identifier (định danh luồng). Nó có thể dùng để target khán giả rộng hoặc chỉ client cụ thể đăng ký channel. Để kết thúc ví dụ, chúng ta có thể include broadcaster module trong model và gửi console.log đến client sau đăng ký:
Phía client, logic đơn giản. Tạo subscription đến channel nói trên. Sau đó, trong hook received, gọi CableReady.perform trên tất cả operation truyền qua dây:
CableReady vs. Turbo Cho Rails
Tóm lại, khi nào nên dùng CableReady, và khi nào nên tránh?
Với sự ra mắt của Turbo, cộng đồng web dev nhận được hộp công cụ mạnh để tạo server-rendered reactive app. Về cơ bản là công nghệ frontend với binding server-side mạnh cho Rails, nó vừa vặn vào stack Model-View-Controller (MVC) chuẩn. Do đó, nó có thể đáp ứng hầu hết yêu cầu app điển hình.
CableReady, mặt khác, là con dao Thụy Sĩ của phát triển real-time Rails và nên dùng cẩn thận. Nó là abstraction mạnh có thể rất hấp dẫn để dùng lan man. Nhưng nếu bạn tưởng tượng mọi phần DOM có thể bị mutate từ bất kỳ vị trí nào trong app, bạn sẽ hiểu điều này có thể dẫn đến race condition và bug khó theo dõi.
Có trường hợp như trường hợp tại hand, tuy nhiên, CableReady hoàn hảo vì cho phép kiểm soát mहीn-grained (tinh vi) hơn DOM.
Được yêu cầu TLDR đơn giản, tôi sẽ trả lời: Turbo dành cho application developer, CableReady dành cho library builder. Nhưng như chúng ta sẽ thấy, có vùng xám giữa hai cái.
Noticed — Thông Báo Đơn Giản Cho Ứng Dụng Ruby on Rails
Thư viện thứ hai chúng ta sẽ áp dụng để phân phối thông báo hệ thống là gem Noticed của Chris Oliver. Cốt lõi, nó xây dựng trên model ActiveRecord mô hình hóa một thông báo đơn lẻ đến recipient. Nó giữ metadata chung, như:
- ai thông báo được gửi đến (recipient)
- khi thông báo được đọc
- bất kỳ tham số nào thông báo liên kết (thường là tham chiếu đến model khác)
Nếu bạn quen với cách ActiveStorage/ActionText meta-tables hoạt động, điều này rất tương tự.
Bên cạnh đó, Noticed dùng POROs (Plain Old Ruby Objects, ví dụ objects không liên kết Rails hoặc framework khác), đóng vai trò blueprint cho thông báo thực tế. Chúng cũng, hơi gây hiểu lầm, được gọi là Notifications và mang logic về cách render và phân phối chúng. Đây là ví dụ từ README:
Chúng ta sẽ thấy điều này hoạt động ngay. Đặc biệt quan tâm là các invocation deliver_by, vì chúng xác định phương thức delivery nào thông báo nên dùng:
deliver_by :databaselưu bản ghi Notification (của model nói trên) để truy cập saudeliver_by :action_cablegửi qua ActionCable channel và stream định nghĩa (mặc địnhNoticed::NotificationChannel)deliver_by :emailchỉ định mailer dùng gửi thông báo. Ví dụ hiển thị cách tính đến preference (tùy chọn) recipient có thể đã set.
Mục tiêu cho phần còn lại bài là triển khai custom delivery method gửi thông báo hệ thống.
Custom Delivery Method: System Notifications Qua Notifications API
Trước khi bắt đầu, hãy dọn dẹp bằng cách tạo Rails app mới. Vì tích hợp với CableReady dễ hơn cách này, tôi chọn option JavaScript esbuild hơn importmaps:
Lưu ý: Lúc viết, phiên bản Rails hiện tại là 7.0.4. Nếu bạn có Rails app hiện có, bạn có thể bỏ qua bước sau, nhưng đảm bảo bạn có User model hoặc khái niệm tương tự đóng vai recipient.
1. Chuẩn Bị Recipients
Noticed cần User model làm recipient, nên để ngắn gọn, kéo Devise và generate User model.
Sau đó, mở Rails console và tạo user mẫu:
2. Thêm Noticed
Tiếp theo, thêm Noticed vào bundle và generate database model.
Chúng ta làm theo yêu cầu, chạy db:migrate và thêm polymorphic has_many association vào User model:
Mảnh ghép cuối trước khi test là tạo blueprint PORO:
Chúng ta chỉnh sửa một chút để chỉ dùng database delivery method và placeholder message cho lúc này. Bạn thường thêm params bắt buộc ở đây, như model id, để xây dựng message và URL link đến — xem Noticed README để chi tiết.
Chỉ dùng Rails console, chúng ta có thể demo cách deliver thông báo dựa trên PORO này:
Như ta thấy, Noticed thực hiện database insert, nên bây giờ ta có thể lấy tất cả Notifications cho user chỉ định:
Điều này đủ để xây dựng index view đơn giản liệt kê tất cả thông báo delivered cho user hiện tại:
Sau khi spin up app với bin/dev, chúng ta đăng nhập và browse đến https://localhost:3000/notifications:

3. Cài Đặt CableReady
Để dùng CableReady, cần cài đặt. May mắn thay, nhanh chóng:
Hãy generate NotificationChannel để deliver message:
Điều này thêm tất cả dependency ActionCable (JavaScript) thiếu và scaffold file channel, cụ thể app/channels/notification_channel.rb và app/javascript/channels/notification_channel.js.
Đối với server-side channel, chúng ta kế thừa từ Noticed::NotificationChannel:
Trước khi tiếp tục, cần đảm bảo ActionCable được authenticated cho Devise user. Tôi không đi sâu chi tiết ở đây. Boilerplate cần thiết trông như sau:
Xem StimulusReflex docs cho các option khác.
Phía client, cần thêm setup code nhỏ đề cập ở trên:
Lưu ý: Redis cần cho ActionCable hoạt động, nên phần còn lại bài giả định bạn có local server chạy.
4. Triển Khai Delivery Method
Để broadcast system notifications, hãy generate delivery method mới:
Lớp scaffold trông như sau:
Hãy tiếp tục bằng cách phác thảo cách chúng ta thiết kế phương thức deliver hoạt động.
Chúng ta mượn phương thức channel một phần từ built-in ActionCable delivery method. Nó cho phép truyền channel qua class method option. Nếu không, fallback về Noticed::NotificationsChannel cung cấp.
Sau đó dùng phương thức notification của CableReady để broadcast instance tương ứng đến recipient.
Để đưa vào hành động, phải kết nối nó với PORO thông báo:
5. Đưa Vào Vận Hành
Bây giờ chỉ còn thử. Chúng ta đơn giản chạy lại từ Rails console:
Giả sử bạn vẫn đăng nhập, trình duyệt trước hết xin phép nhận thông báo thay mặt app:

Sau khi xác nhận, bạn nhận được popup thông báo đẹp từ trình duyệt:

Kết Luận
Đi qua CableReady và Noticed nhanh, chúng ta đã demo cách tích hợp native browser API vào app. Kết quả là cách đơn giản, súc tích deliver system notifications đến user.
Use case này cũng minh họa việc dễ dàng mix CableReady vào use case. Nếu nghĩ thêm một bước, tách delivery method drafted thành library không khó.
Tôi hy vọng điều này truyền cảm hứng cho bạn tìm manifestations (biểu hiện) của vertical reactive problem domains trong app và thử CableReady.
Đọc thêm bằng cách mua sách Advanced CableReady mới của tôi.
Dùng mã coupon APPSIGNAL-PROMO và tiết kiệm $10!
Chúc bạn viết mã vui vẻ!
P.S. Nếu bạn muốn đọc các bài Ruby Magic ngay khi chúng xuất bản, hãy đăng ký bản tin Ruby Magic của chúng tôi và không bao giờ bỏ lỡ bất kỳ bài viết nào!