Fix PMP profile handling and rendering for empty PMP display names (#495)

<!-- Please read
https://github.com/SableClient/Sable/blob/dev/CONTRIBUTING.md before
submitting your pull request -->

### Description

<!-- Please include a summary of the change. Please also include
relevant motivation and context. List any dependencies that are required
for this change. -->

This PR changes that whitespace only, or empty display names of
per-message-profiles resulting in display-names in the event being unset
and the fallback-string not being added to the body.

It also unsets the `avatar_url` if the avatar is not set. And internally
made the displayname an optional field. Only the `id` is now an required
field for the beeper pmp.

It also changes the message rendering, by removing the "via"-part if the
name is unset.

#### Type of change

- [x] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [ ] This change requires a documentation update

### Checklist:

- [x] My code follows the style guidelines of this project
- [x] I have performed a self-review of my own code
- [x] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings

### AI disclosure:

- [ ] Partially AI assisted (clarify which code was AI assisted and
briefly explain what it does).
- [ ] Fully AI generated (explain what all the generated code does in
moderate detail).
<!-- Write any explanation required here, but do not generate the
explanation using AI!! You must prove you understand what the code in
this PR does. -->
No AI was used for my changes
This commit is contained in:
7w1 authored and GitHub committed 2026-03-23 17:16:39 +00:00
commit bb9e024d5d
4 files changed
+44 -26

No files matched your search

+5
View File
@@ -0,0 +1,5 @@
---
default: patch
---
fix the issue of empty displaynames of a persona, causing an empty fallback message, it will now ommit the fallback, if the name is empty or only consists of whitespace
+23 -19
View File
@@ -746,30 +746,34 @@ export const RoomInput = forwardRef<HTMLDivElement, RoomInputProps>(
const perMessageProfile = await getCurrentlyUsedPerMessageProfileForRoom(mx, roomId);
if (perMessageProfile) {
content['com.beeper.per_message_profile'] =
convertPerMessageProfileToBeeperFormat(perMessageProfile);
content['com.beeper.per_message_profile'] = convertPerMessageProfileToBeeperFormat(
perMessageProfile,
perMessageProfile.name.trim() !== ''
);
// if a per-message profile is used, it must per spec include a fallback
const prefix = `${perMessageProfile.name}: `;
if (perMessageProfile.name.trim() !== '') {
// if a per-message profile is used, it must per spec include a fallback
const prefix = `${perMessageProfile.name}: `;
if (!content.body.startsWith(prefix)) {
// to prevent double-prefixing when the fallback is already present
content.body = prefix + content.body;
}
if (!content.body.startsWith(prefix)) {
// to prevent double-prefixing when the fallback is already present
content.body = prefix + content.body;
}
/**
* html escaped version of the display name
*/
const escapedName = sanitizeCustomHtml(perMessageProfile.name);
/**
* html escaped version of the display name
*/
const escapedName = sanitizeCustomHtml(perMessageProfile.name);
const htmlPrefix = `<strong data-mx-profile-fallback>${escapedName}: </strong>`;
const htmlPrefix = `<strong data-mx-profile-fallback>${escapedName}: </strong>`;
if (content.formatted_body && !content.formatted_body.startsWith(htmlPrefix)) {
content.formatted_body = htmlPrefix + content.formatted_body;
} else {
// we don't have a formatted body, but we need one
content.format = 'org.matrix.custom.html';
content.formatted_body = `${htmlPrefix}${plainText}`;
if (content.formatted_body && !content.formatted_body.startsWith(htmlPrefix)) {
content.formatted_body = htmlPrefix + content.formatted_body;
} else {
// we don't have a formatted body, but we need one
content.format = 'org.matrix.custom.html';
content.formatted_body = `${htmlPrefix}${plainText}`;
}
}
}
+2 -1
View File
@@ -425,8 +425,9 @@ function MessageInternal(
/**
* boolean to indicate wheather we should indicate to the user that it is a pmp
* We want to not show it, when the name is unset, or whitespace only
*/
const showPmPInfo = pmp !== undefined;
const showPmPInfo = parsedPMPContent?.name && parsedPMPContent.name?.trim() !== '';
// Profiles and Colors
const profile = useUserProfile(senderId, room);
const { color: usernameColor, font: usernameFont } = useSableCosmetics(senderId, room);
+14 -6
View File
@@ -40,7 +40,7 @@ export type PerMessageProfileBeeperFormat = {
/**
* the display name to use for messages using this profile. This is required because otherwise the profile would have no effect on the message.
*/
displayname: string;
displayname?: string;
/**
* the avatar url to use for messages using this profile.
* Beeper expects this to be a mxc url.
@@ -50,7 +50,7 @@ export type PerMessageProfileBeeperFormat = {
* using the unstable prefix for pronouns, under which it is also stored in profiles
*/
'io.fsky.nyx.pronouns'?: PronounSet[];
has_fallback: boolean;
has_fallback?: boolean;
};
/**
@@ -61,15 +61,23 @@ export type PerMessageProfileBeeperFormat = {
* @return {*} {PerMessageProfileBeeperFormat} the per message profile in Beeper's format, which can be applied to a message before sending it
*/
export function convertPerMessageProfileToBeeperFormat(
profile: PerMessageProfile
profile: PerMessageProfile,
has_fallback: boolean
): PerMessageProfileBeeperFormat {
return {
const beeperPMP: PerMessageProfileBeeperFormat = {
id: profile.id,
displayname: profile.name,
avatar_url: profile.avatarUrl,
'io.fsky.nyx.pronouns': profile.pronouns,
has_fallback: true,
has_fallback,
};
// delete empty fields
// to-do maybe find a better way of doing it
if (!profile.name || profile?.name.trim().length === 0) delete beeperPMP.displayname;
if (!profile.avatarUrl) delete beeperPMP.avatar_url;
if (!profile.pronouns || profile.pronouns?.length === 0) delete beeperPMP['io.fsky.nyx.pronouns'];
if (!has_fallback) delete beeperPMP.has_fallback;
return beeperPMP;
}
/**
@@ -85,7 +93,7 @@ export function convertBeeperFormatToOurPerMessageProfile(
): PerMessageProfile {
return {
id: beeperProfile.id,
name: beeperProfile.displayname,
name: beeperProfile.displayname ?? '',
avatarUrl: beeperProfile.avatar_url,
pronouns: beeperProfile['io.fsky.nyx.pronouns'],
};