Skip to content

armgit / macro

Public Imported from GitHub
0

Macro is a unified workspace for teams: email, chat, docs, tasks, agents, calls, and CRM — @-linked together with shared AI memory.

fix(notifications): show nameless mentions as their kind in alert text (#9907)

Peter Chinman1b79e0706d51
diff --git a/crates/email_formatting/src/test.rs b/crates/email_formatting/src/test.rs
index 3e54623373..6c362fd691 100644
--- a/crates/email_formatting/src/test.rs
+++ b/crates/email_formatting/src/test.rs
@@ -38,6 +38,48 @@ fn digest_logo_keeps_the_png_aspect_ratio() {
));
}
+#[test]
+fn digest_escapes_nameless_mention_placeholders() {
+ use model_notifications::{
+ ChannelMessageSendMetadata, ChannelType, CommonChannelMetadata, NotificationTitle,
+ };
+
+ let event = NotifEvent::ChannelMessageSend(ChannelMessageSendMetadata {
+ sender: None,
+ sender_display_name: Some("Helper Bot".to_string()),
+ message_content: r#"Filed <m-document-mention>{"documentId":"t1","documentName":"","blockName":"task","blockParams":{}}</m-document-mention>"#.to_string(),
+ message_id: "m1".to_string(),
+ has_attachments: false,
+ common: CommonChannelMetadata {
+ channel_type: ChannelType::Team,
+ channel_name: "AI Team".to_string(),
+ },
+ sender_profile_picture_url: None,
+ });
+ let notif = NotifPreview {
+ created_at: Utc::now(),
+ title: event.format_title(None).unwrap(),
+ body: event.format_body(None).unwrap(),
+ };
+ assert_eq!(notif.body, "Filed <task>");
+
+ let html = DigestTemplate {
+ notifs: vec![notif],
+ num_truncated: 0,
+ total_count: 1,
+ unsubscribe_url: SignedUrl::new(
+ NotificationServiceUrl::default_for_environment(Environment::Production)
+ .parse_url()
+ .unwrap(),
+ Hmac::<Sha256>::new_from_slice(b"test-secret").unwrap(),
+ ),
+ }
+ .render()
+ .unwrap();
+ assert!(html.contains("Filed &#60;task&#62;"));
+ assert!(!html.contains("<task>"));
+}
+
#[test]
fn signed_unsubscribe_roundtrips_against_request_url() {
let secret = Hmac::<Sha256>::new_from_slice(b"test-secret").unwrap();
diff --git a/crates/mention_utils/AGENTS.md b/crates/mention_utils/AGENTS.md
index 30d5fd5185..0e5795e304 100644
--- a/crates/mention_utils/AGENTS.md
+++ b/crates/mention_utils/AGENTS.md
@@ -9,8 +9,10 @@ AI editors, lexical, and notification text.
## Start here
-- `src/parse.rs`: `nom` parsers for each mention chip XML tag.
-- `src/serialize.rs`: renders mentions back to chip XML or plain text.
+- `src/parse.rs`: `nom` parsers for each mention chip XML tag, and the
+ formatters (`PlainTextFormatter`) that turn tagged text into plain text for
+ notification bodies, digests, and search.
+- `src/serialize.rs`: writes mentions as chip XML.
- `src/tests.rs`: round-trip parse/serialize cases.
## Scope
@@ -41,3 +43,7 @@ AI editors, lexical, and notification text.
- New chip parsers should use `nom`, matching the rest of this crate, rather
than hand-rolled string scanning.
+- Agents leave `documentName` empty or omit it (the app shows the live name),
+ so `PlainTextFormatter` writes a nameless document mention as its kind in
+ angle brackets (`<task>`, `<message>`). Escape that text wherever it lands
+ in HTML.
diff --git a/crates/mention_utils/src/parse.rs b/crates/mention_utils/src/parse.rs
index 393e3c5ec0..8c2f327e00 100644
--- a/crates/mention_utils/src/parse.rs
+++ b/crates/mention_utils/src/parse.rs
@@ -113,8 +113,54 @@ impl<'de> XmlTaggedParsed<'de> for ParsedDateMention<'de> {
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct ParsedDocumentMention<'a> {
- #[serde(borrow)]
+ /// A cached label; agents leave it empty or omit it, since the app shows
+ /// the live name.
+ #[serde(borrow, default)]
pub document_name: Cow<'a, str>,
+ #[serde(borrow, default)]
+ pub block_name: Cow<'a, str>,
+ /// Free-form navigation parameters. Any shape is accepted, so an odd
+ /// value never stops the rest of the text from being formatted.
+ #[serde(default)]
+ pub block_params: serde_json::Value,
+}
+
+impl ParsedDocumentMention<'_> {
+ /// What the mention points at, as a lowercase noun, for text that cannot
+ /// show the live name.
+ pub fn kind(&self) -> &'static str {
+ let is_message = self
+ .block_params
+ .get("channel_message_id")
+ .is_some_and(|id| !id.is_null());
+
+ match self.block_name.as_ref() {
+ "channel" if is_message => "message",
+ "channel" => "channel",
+ "md" | "write" | "pdf" | "code" | "canvas" | "spreadsheet" | "csv" | "pptx" | "psd"
+ | "fig" | "ai" | "unknown" => "document",
+ "task" => "task",
+ "email" => "email",
+ "calendar" => "event",
+ "database" => "database",
+ "form" => "form",
+ "initiative" => "project",
+ "project" => "folder",
+ "company" => "company",
+ "contact" => "contact",
+ "pipeline" => "pipeline",
+ "call" => "call",
+ "chat" => "chat",
+ "agent" => "agent session",
+ "pr" => "pull request",
+ "image" => "image",
+ "video" => "video",
+ "skill" => "skill",
+ "snippet" => "snippet",
+ "routine" | "automation" => "routine",
+ _ => "item",
+ }
+ }
}
impl<'de> XmlTaggedParsed<'de> for ParsedDocumentMention<'de> {
@@ -496,7 +542,12 @@ impl XmlFormatter for PlainTextFormatter {
write!(f, "{}", link.text)
}
+ /// A nameless mention reads as its kind in angle brackets, e.g. `<task>`.
+ /// The brackets are literal text: HTML consumers must escape them.
fn format_doc(doc: &ParsedDocumentMention<'_>, f: &mut Formatter<'_>) -> std::fmt::Result {
+ if doc.document_name.trim().is_empty() {
+ return write!(f, "<{}>", doc.kind());
+ }
write!(f, "{}", doc.document_name)
}
diff --git a/crates/mention_utils/src/tests.rs b/crates/mention_utils/src/tests.rs
index f64e0b0539..c9f6d58a9c 100644
--- a/crates/mention_utils/src/tests.rs
+++ b/crates/mention_utils/src/tests.rs
@@ -33,7 +33,7 @@ fn parse_single_document_mention() {
let input = r#"<m-document-mention>{"documentName":"My Doc"}</m-document-mention>"#;
let out = ParsedXmlText::parse(input).unwrap();
assert_matches!(out.0, [
- TextSegment::Xml(XmlTag::Document(ParsedDocumentMention { document_name }))
+ TextSegment::Xml(XmlTag::Document(ParsedDocumentMention { document_name, .. }))
] => {
assert_eq!(document_name.as_ref(), "My Doc");
});
@@ -46,9 +46,9 @@ fn parse_document_mentions_with_text() {
assert_matches!(out.0, [
TextSegment::Plain("I'm testing sending a message with a document "),
- TextSegment::Xml(XmlTag::Document(ParsedDocumentMention { document_name: name1 })),
+ TextSegment::Xml(XmlTag::Document(ParsedDocumentMention { document_name: name1, .. })),
TextSegment::Plain(" mention "),
- TextSegment::Xml(XmlTag::Document(ParsedDocumentMention { document_name: name2 })),
+ TextSegment::Xml(XmlTag::Document(ParsedDocumentMention { document_name: name2, .. })),
] => {
assert_eq!(name1.as_ref(), "Document 1");
assert_eq!(name2.as_ref(), "Document 2");
@@ -56,11 +56,59 @@ fn parse_document_mentions_with_text() {
}
#[test]
-fn parse_document_mention_missing_name() {
- // Missing "documentName" field - should fail to parse as document mention
- let input = r#"<m-document-mention>{"documentId":"123","blockName":"md","blockParams":{}}</m-document-mention>"#;
- let result = ParsedXmlText::parse(input);
- assert!(result.is_err());
+fn nameless_document_mentions_render_as_their_kind() {
+ let input = concat!(
+ r#"I made <m-document-mention>{"documentId":"d1","documentName":"","blockName":"md","blockParams":{}}</m-document-mention>"#,
+ r#" from <m-document-mention>{"documentId":"d2","documentName":"","blockName":"database","blockParams":{}}</m-document-mention>"#,
+ r#", filed <m-document-mention>{"documentId":"t1","documentName":" ","blockName":"task","blockParams":{}}</m-document-mention>"#,
+ r#" under <m-document-mention>{"documentId":"i1","documentName":"","blockName":"initiative","blockParams":{}}</m-document-mention>"#,
+ r#" in <m-document-mention>{"documentId":"p1","documentName":"","blockName":"project","blockParams":{}}</m-document-mention>"#,
+ r#" and replied to <m-document-mention>{"documentId":"c1","documentName":"","blockName":"channel","blockParams":{"channel_message_id":"m1"}}</m-document-mention>"#,
+ r#" in <m-document-mention>{"documentId":"c1","documentName":"","blockName":"channel","blockParams":{}}</m-document-mention>"#,
+ r#" about <m-document-mention>{"documentId":"x1","documentName":"","blockName":"unheard-of","blockParams":{}}</m-document-mention>."#,
+ );
+ let rendered = PlainTextFormatter::format_xml_text(ParsedXmlText::parse(input).unwrap()).0;
+ assert_eq!(
+ rendered,
+ "I made <document> from <database>, filed <task> under <project> in <folder> and replied to <message> in <channel> about <item>."
+ );
+}
+
+#[test]
+fn document_mention_without_name_or_params_renders_as_its_kind() {
+ // Agents omit documentName, and routine mentions carry no blockParams.
+ let input = concat!(
+ r#"<m-document-mention>{"documentId":"r1","blockName":"routine"}</m-document-mention>"#,
+ r#" and <m-document-mention>{"documentId":"x1"}</m-document-mention>"#,
+ );
+ let rendered = PlainTextFormatter::format_xml_text(ParsedXmlText::parse(input).unwrap()).0;
+ assert_eq!(rendered, "<routine> and <item>");
+}
+
+#[test]
+fn document_mention_with_odd_block_params_still_renders() {
+ let input = concat!(
+ r#"<m-document-mention>{"documentId":"d1","documentName":"","blockName":"md","blockParams":"x"}</m-document-mention>"#,
+ r#" and <m-document-mention>{"documentId":"c1","documentName":"","blockName":"channel","blockParams":{"channel_message_id":null}}</m-document-mention>"#,
+ );
+ let rendered = PlainTextFormatter::format_xml_text(ParsedXmlText::parse(input).unwrap()).0;
+ assert_eq!(rendered, "<document> and <channel>");
+}
+
+#[test]
+fn named_document_mention_renders_its_name() {
+ let input = r#"<m-document-mention>{"documentId":"t1","documentName":"Ship it","blockName":"task","blockParams":{}}</m-document-mention>"#;
+ let rendered = PlainTextFormatter::format_xml_text(ParsedXmlText::parse(input).unwrap()).0;
+ assert_eq!(rendered, "Ship it");
+}
+
+#[test]
+fn kind_placeholder_is_not_read_back_as_a_tag() {
+ let input = r#"see <m-document-mention>{"documentId":"d1","documentName":"","blockName":"md","blockParams":{}}</m-document-mention>"#;
+ let once = PlainTextFormatter::format_xml_text(ParsedXmlText::parse(input).unwrap()).0;
+ let twice = PlainTextFormatter::format_xml_text(ParsedXmlText::parse_lenient(&once)).0;
+ assert_eq!(once, "see <document>");
+ assert_eq!(twice, once);
}
#[test]
@@ -403,7 +451,7 @@ fn parse_mixed_mentions() {
TextSegment::Plain("Hi "),
TextSegment::Xml(XmlTag::User(ParsedUserMention { .. })),
TextSegment::Plain(", let's discuss "),
- TextSegment::Xml(XmlTag::Document(ParsedDocumentMention { document_name })),
+ TextSegment::Xml(XmlTag::Document(ParsedDocumentMention { document_name, .. })),
TextSegment::Plain(" with "),
TextSegment::Xml(XmlTag::Contact(ParsedContactMention { name })),
TextSegment::Plain(" on "),
@@ -425,7 +473,7 @@ fn parse_mixed_mentions_with_links() {
TextSegment::Plain(", check out "),
TextSegment::Xml(XmlTag::Link(ParsedLink { text, url })),
TextSegment::Plain(" and "),
- TextSegment::Xml(XmlTag::Document(ParsedDocumentMention { document_name })),
+ TextSegment::Xml(XmlTag::Document(ParsedDocumentMention { document_name, .. })),
] => {
assert_eq!(text.as_ref(), "Our Docs");
assert_eq!(url.as_ref(), "https://docs.example.com");
@@ -440,9 +488,9 @@ fn parse_content_with_multiple_document_and_user_mentions() {
assert_matches!(out.0, [
TextSegment::Xml(XmlTag::User(ParsedUserMention { .. })),
TextSegment::Plain(" I'm testing sending a message with a document "),
- TextSegment::Xml(XmlTag::Document(ParsedDocumentMention { document_name: name1 })),
+ TextSegment::Xml(XmlTag::Document(ParsedDocumentMention { document_name: name1, .. })),
TextSegment::Plain(" mention "),
- TextSegment::Xml(XmlTag::Document(ParsedDocumentMention { document_name: name2 })),
+ TextSegment::Xml(XmlTag::Document(ParsedDocumentMention { document_name: name2, .. })),
] => {
assert_eq!(name1.as_ref(), "Document 1");
assert_eq!(name2.as_ref(), "Document 2");
@@ -527,7 +575,7 @@ fn parse_document_mention_with_surrounding_text() {
let out = ParsedXmlText::parse(input).unwrap();
assert_matches!(out.0, [
TextSegment::Plain("asdf "),
- TextSegment::Xml(XmlTag::Document(ParsedDocumentMention { document_name })),
+ TextSegment::Xml(XmlTag::Document(ParsedDocumentMention { document_name, .. })),
TextSegment::Plain(" asdf"),
] => {
assert_eq!(document_name.as_ref(), "Test Doc 34");
@@ -625,7 +673,7 @@ fn parse_mixed_mentions_with_multiple_links() {
TextSegment::Plain(", check out "),
TextSegment::Xml(XmlTag::Link(ParsedLink { text: t1, .. })),
TextSegment::Plain(" and "),
- TextSegment::Xml(XmlTag::Document(ParsedDocumentMention { document_name })),
+ TextSegment::Xml(XmlTag::Document(ParsedDocumentMention { document_name, .. })),
TextSegment::Plain(" on "),
TextSegment::Xml(XmlTag::Date(ParsedDateMention { display_format })),
TextSegment::Plain(" or visit "),
@@ -649,7 +697,7 @@ fn parse_link_user_document_mixed() {
TextSegment::Plain(" and "),
TextSegment::Xml(XmlTag::User(ParsedUserMention { .. })),
TextSegment::Plain(" this doc "),
- TextSegment::Xml(XmlTag::Document(ParsedDocumentMention { document_name })),
+ TextSegment::Xml(XmlTag::Document(ParsedDocumentMention { document_name, .. })),
] => {
assert_eq!(text.as_ref(), "Example");
assert_eq!(url.as_ref(), "https://example.com");
@@ -694,8 +742,8 @@ fn parse_contact_mention_missing_name_with_suffix() {
#[test]
fn parse_document_mention_missing_name_with_suffix() {
let input = r#"<m-document-mention>{"documentId":"6e01eaf5-f497-4b2e-96d0-ea3d527ef47d","blockName":"md","blockParams":{},"collapsed":false}</m-document-mention> asdf"#;
- let result = ParsedXmlText::parse(input);
- assert!(result.is_err());
+ let rendered = PlainTextFormatter::format_xml_text(ParsedXmlText::parse(input).unwrap()).0;
+ assert_eq!(rendered, "<document> asdf");
}
// =============================================================================
diff --git a/crates/model_notifications/src/metadata/test.rs b/crates/model_notifications/src/metadata/test.rs
index 91181c1433..c7cbab053b 100644
--- a/crates/model_notifications/src/metadata/test.rs
+++ b/crates/model_notifications/src/metadata/test.rs
@@ -1350,6 +1350,34 @@ fn agent_session_alerts_show_mentions_by_name() {
);
}
+#[test]
+fn alerts_show_nameless_mentions_as_their_kind() {
+ // Agents leave documentName empty or omit it; the app fills in live names.
+ let settled = AgentSessionSettledMetadata {
+ session: agent_session_ref(),
+ turn: 0,
+ actor: None,
+ stop_reason: "end_turn".to_string(),
+ excerpt: Some(
+ r#"The most recent one is <m-document-mention>{"documentId":"0195c94f-3b0c-79f0-8558-e5e509ac9dd8","documentName":"","blockName":"channel","blockParams":{"channel_message_id":"0195c94f-3b0c-79f0-8558-e5e509ac9dd9"}}</m-document-mention>, about <m-document-mention>{"documentId":"0195c94f-3b0c-79f0-8558-e5e509ac9dda","blockName":"task","blockParams":{}}</m-document-mention>."#
+ .to_string(),
+ ),
+ };
+ assert_eq!(
+ settled.format_body(None).unwrap(),
+ "The most recent one is <message>, about <task>."
+ );
+
+ let channel = ChannelMessageSendMetadata {
+ message_content: r#"I made <m-document-mention>{"documentId":"d1","documentName":"","blockName":"md","blockParams":{}}</m-document-mention> from <m-document-mention>{"documentId":"d2","documentName":"","blockName":"database","blockParams":{}}</m-document-mention>."#.to_string(),
+ ..bot_channel_message_send()
+ };
+ assert_eq!(
+ channel.format_body(None).unwrap(),
+ "I made <document> from <database>."
+ );
+}
+
#[test]
fn agent_session_settled_with_only_hidden_tags_falls_back_to_the_session_name() {
let metadata = AgentSessionSettledMetadata {