//! Phase 21 (Track M.3) — Rails ActionCable WebSocket adapter (Ruby). //! //! Fires when the surrounding source declares an `ApplicationCable` / //! `ActionCable::Channel::Base` subclass and the function body sits on //! a `receive` / `subscribed` / `unsubscribed` callback. use crate::dynamic::framework::{FrameworkAdapter, FrameworkBinding}; use crate::evidence::EntryKind; use crate::summary::FuncSummary; use crate::symbol::Lang; pub struct WebsocketActionCableAdapter; const ADAPTER_NAME: &str = "websocket-actioncable"; fn callee_is_actioncable(name: &str) -> bool { let last = name.rsplit_once('.').map(|(_, s)| s).unwrap_or(name); matches!( last, "receive" | "subscribed" | "unsubscribed" | "transmit" | "broadcast" ) } fn source_imports_actioncable(file_bytes: &[u8]) -> bool { const NEEDLES: &[&[u8]] = &[ b"ApplicationCable::Channel", b"ActionCable::Channel::Base", b"< ApplicationCable", b"< ActionCable::Channel", b"require 'action_cable'", b"require \"action_cable\"", ]; NEEDLES .iter() .any(|n| file_bytes.windows(n.len()).any(|w| w == *n)) } fn extract_path(file_bytes: &[u8]) -> String { let text = std::str::from_utf8(file_bytes).unwrap_or(""); for needle in [ "stream_from '", "stream_from \"", "stream_for '", "stream_for \"", ] { if let Some(idx) = text.find(needle) { let after = &text[idx + needle.len()..]; let close = if needle.ends_with('"') { '"' } else { '\'' }; if let Some(end) = after.find(close) { return after[..end].to_owned(); } } } "/cable".to_owned() } impl FrameworkAdapter for WebsocketActionCableAdapter { fn name(&self) -> &'static str { ADAPTER_NAME } fn lang(&self) -> Lang { Lang::Ruby } fn detect( &self, summary: &FuncSummary, _ast: tree_sitter::Node<'_>, file_bytes: &[u8], ) -> Option { let matches_call = super::any_callee_matches(summary, callee_is_actioncable); let matches_source = source_imports_actioncable(file_bytes); if matches_call || matches_source { Some(FrameworkBinding { adapter: ADAPTER_NAME.to_owned(), kind: EntryKind::WebSocket { path: extract_path(file_bytes), }, route: None, request_params: Vec::new(), response_writer: None, middleware: Vec::new(), }) } else { None } } } #[cfg(test)] mod tests { use super::*; fn parse_ruby(src: &[u8]) -> tree_sitter::Tree { let mut parser = tree_sitter::Parser::new(); let lang = tree_sitter::Language::from(tree_sitter_ruby::LANGUAGE); parser.set_language(&lang).unwrap(); parser.parse(src, None).unwrap() } #[test] fn fires_on_actioncable_channel() { let src: &[u8] = b"class ChatChannel < ApplicationCable::Channel\n def subscribed\n stream_from 'chat_room'\n end\n def receive(data)\n end\nend\n"; let tree = parse_ruby(src); let summary = FuncSummary { name: "receive".into(), ..Default::default() }; let binding = WebsocketActionCableAdapter .detect(&summary, tree.root_node(), src) .expect("action_cable binds"); assert_eq!(binding.adapter, "websocket-actioncable"); if let EntryKind::WebSocket { path } = binding.kind { assert_eq!(path, "chat_room"); } } }