No .m.rule.contains_user_name rule sent to clients

[deepbluev7]

Description

When I curl /_matrix/client/v3/pushrules/ it doesn't return the .m.rule.contains_user_name rule. This means clients don't properly highlight those messages. It also isn't present in the pseudo account data event

Steps to reproduce

• curl /_matrix/client/v3/pushrules/ and grep for user_name.

Homeserver

nheko.im, neko.dev, ocean.joedonofry.com

Synapse Version

1.71rc1, 1.69.0

Installation Method

Other (please mention below)

Platform

Docker, custom ebuild, etc

Relevant log output

None

Anything else that would be useful to know?

The rule is present in https://github.com/matrix-org/synapse/blob/2d0ba3f89aaf9545d81c4027500e543ec70b68a6/rust/src/push/base_rules.rs, which would suggest it is formatted. The formatting should happen here: https://github.com/matrix-org/synapse/blob/99a7e7e0230cba5d00ec204926edae89d4b6b8c3/synapse/push/clientformat.py

I have no idea yet, where it goes poof.

[DMRobertson]

AFAICT from the spec, this rule is supposed to show up under the global/content.

This doesn't look promising:

$ curl -s -H "Authorization: Bearer $TOKEN" -X GET https://matrix-client.matrix.org/_matrix/client/v3/pushrules/ | jq '.global.content'
[]

[DMRobertson]

On 1.68.0, this snippet

synapse/synapse/push/clientformat.py

Lines 42 to 43 in 5442891

	template_rule = _rule_to_template(r)
	if not template_rule:

sets template_rule to None where r is

PushRule(rule_id='global/content/.m.rule.contains_user_name', priority_class=4, conditions=[{'kind': 'event_match', 'key': 'content.body', 'pattern_type': 'user_localpart'}], actions=['notify', {'set_tweak': 'sound', 'value': 'default'}, {'set_tweak': 'highlight'}], default=True, default_enabled=True)

Not a regression then?

[DMRobertson]

We return None here

synapse/synapse/push/clientformat.py

Lines 97 to 98 in 5442891

	if "pattern" not in thecond:
	return None

because rule.conditions[0] is {'kind': 'event_match', 'key': 'content.body', 'pattern_type': 'user_localpart'}.

[DMRobertson]

There is code here to account for this, but it happens after we've already decided the template_rule is None.

synapse/synapse/push/clientformat.py

Lines 58 to 71 in 5442891

	# Remove internal stuff.
	template_rule["conditions"] = copy.deepcopy(template_rule["conditions"])
	for c in template_rule["conditions"]:
	c.pop("_cache_key", None)
	pattern_type = c.pop("pattern_type", None)
	if pattern_type == "user_id":
	c["pattern"] = user.to_string()
	elif pattern_type == "user_localpart":
	c["pattern"] = user.localpart
	sender_type = c.pop("sender_type", None)
	if sender_type == "user_id":
	c["sender"] = user.to_string()

Would guess this was broken in #13522, so a regression in 1.66.

[DMRobertson]

@erikjohnston I think you're best-placed to look at this when you're back. I don't fully grok the templaterule machinery here so wouldn't want to attempt a fix without your insight, at the very least.

[deepbluev7]

I made a temporary fix in #14356. It is more of a bodge though, so you might want to fix it properly instead.