Swap to stable recent emojis key (#1009)

<!-- 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. -->

Swaps to the stable recent emojis identifier since it was added to spec
in 1.18, and has a bit of migration logic to convert the legacy one to
the stable one if its not present.

#### 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:

- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] 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. -->
This commit is contained in:
7w1 authored and GitHub committed 2026-06-29 14:22:05 -05:00
commit 4d6137b0d2
6 files changed
+36 -7

No files matched your search

+5
View File
@@ -0,0 +1,5 @@
---
default: patch
---
Swap to using the stable identifier `m.recent_emoji` for recent emojis and add migration logic.
+6 -1
View File
@@ -11,7 +11,12 @@ export const useRecentEmoji = (mx: MatrixClient, limit?: number): IEmoji[] => {
useEffect(() => {
const handleAccountData = (event: MatrixEvent) => {
if (event.getType() !== (CustomAccountDataEvent.ElementRecentEmoji as string)) return;
if (
event.getType() !== (CustomAccountDataEvent.RecentEmoji as string) &&
event.getType() !== (CustomAccountDataEvent.LegacyElementRecentEmoji as string)
) {
return;
}
setRecentEmoji(getRecentEmojis(mx, limit));
};
+18 -3
View File
@@ -13,8 +13,20 @@ export type IRecentEmojiContent = {
};
export const getRecentEmojis = (mx: MatrixClient, limit?: number): IEmoji[] => {
const recentEmojiEvent = getAccountData(mx, CustomAccountDataEvent.ElementRecentEmoji);
let recentEmojiEvent = getAccountData(mx, CustomAccountDataEvent.RecentEmoji);
let isLegacy = false;
if (!recentEmojiEvent) {
recentEmojiEvent = getAccountData(mx, CustomAccountDataEvent.LegacyElementRecentEmoji);
isLegacy = true;
}
const recentEmoji = recentEmojiEvent?.getContent<IRecentEmojiContent>().recent_emoji;
if (isLegacy && Array.isArray(recentEmoji)) {
mx.setAccountData(CustomAccountDataEvent.RecentEmoji, {
recent_emoji: recentEmoji,
}).catch(() => {});
}
if (!Array.isArray(recentEmoji)) return [];
return recentEmoji
@@ -28,7 +40,10 @@ export const getRecentEmojis = (mx: MatrixClient, limit?: number): IEmoji[] => {
};
export function addRecentEmoji(mx: MatrixClient, unicode: string) {
const recentEmojiEvent = getAccountData(mx, CustomAccountDataEvent.ElementRecentEmoji);
let recentEmojiEvent = getAccountData(mx, CustomAccountDataEvent.RecentEmoji);
if (!recentEmojiEvent) {
recentEmojiEvent = getAccountData(mx, CustomAccountDataEvent.LegacyElementRecentEmoji);
}
const recentEmojiContent = recentEmojiEvent?.getContent<IRecentEmojiContent>();
const recentEmoji =
recentEmojiContent && Array.isArray(recentEmojiContent.recent_emoji)
@@ -45,7 +60,7 @@ export function addRecentEmoji(mx: MatrixClient, unicode: string) {
entry[1] += 1;
}
recentEmoji.unshift(entry);
mx.setAccountData(CustomAccountDataEvent.ElementRecentEmoji, {
mx.setAccountData(CustomAccountDataEvent.RecentEmoji, {
recent_emoji: recentEmoji.slice(0, 100),
});
}
+2 -1
View File
@@ -51,7 +51,8 @@ declare module 'matrix-js-sdk/lib/@types/event' {
interface AccountDataEvents {
[prefix.MATRIX_CINNY_UNSTABLE_ACCOUNT_SPACES_PROPERTY_NAME]: InCinnySpacesContent;
[prefix.MATRIX_ELEMENT_UNSTABLE_ACCOUNT_RECENT_EMOJIS_PROPERTY_NAME]: IRecentEmojiContent;
[prefix.MATRIX_ACCOUNT_RECENT_EMOJIS_PROPERTY_NAME]: IRecentEmojiContent;
[prefix.MATRIX_LEGACY_ELEMENT_UNSTABLE_ACCOUNT_RECENT_EMOJIS_PROPERTY_NAME]: IRecentEmojiContent;
[prefix.MATRIX_UNSTABLE_ACCOUNT_USER_EMOTES_PROPERTY_NAME]: PackContent;
[prefix.MATRIX_UNSTABLE_ACCOUNT_EMOTE_ROOMS_PROPERTY_NAME]: EmoteRoomsContent;
[prefix.MATRIX_SABLE_UNSTABLE_ACCOUNT_NICKNAMES_PROPERTY_NAME]: Record<string, string>;
+3 -1
View File
@@ -2,7 +2,9 @@ import * as prefix from '$unstable/prefixes';
export const CustomAccountDataEvent = {
CinnySpaces: prefix.MATRIX_CINNY_UNSTABLE_ACCOUNT_SPACES_PROPERTY_NAME,
ElementRecentEmoji: prefix.MATRIX_ELEMENT_UNSTABLE_ACCOUNT_RECENT_EMOJIS_PROPERTY_NAME,
LegacyElementRecentEmoji:
prefix.MATRIX_LEGACY_ELEMENT_UNSTABLE_ACCOUNT_RECENT_EMOJIS_PROPERTY_NAME,
RecentEmoji: prefix.MATRIX_ACCOUNT_RECENT_EMOJIS_PROPERTY_NAME,
PoniesUserEmotes: prefix.MATRIX_UNSTABLE_ACCOUNT_USER_EMOTES_PROPERTY_NAME,
PoniesEmoteRooms: prefix.MATRIX_UNSTABLE_ACCOUNT_EMOTE_ROOMS_PROPERTY_NAME,
SableNicknames: prefix.MATRIX_SABLE_UNSTABLE_ACCOUNT_NICKNAMES_PROPERTY_NAME,
+2 -1
View File
@@ -12,8 +12,9 @@ export const MATRIX_COMMET_UNSTABLE_PROFILE_STATUS_PROPERTY_NAME = 'chat.commet.
export const MATRIX_CINNY_UNSTABLE_ACCOUNT_SPACES_PROPERTY_NAME = 'in.cinny.spaces';
export const MATRIX_CINNY_UNSTABLE_STATE_ROOM_POWER_LEVELS_LABEL_PROPERTY_NAME =
'in.cinny.room.power_level_tags';
export const MATRIX_ELEMENT_UNSTABLE_ACCOUNT_RECENT_EMOJIS_PROPERTY_NAME =
export const MATRIX_LEGACY_ELEMENT_UNSTABLE_ACCOUNT_RECENT_EMOJIS_PROPERTY_NAME =
'io.element.recent_emoji';
export const MATRIX_ACCOUNT_RECENT_EMOJIS_PROPERTY_NAME = 'm.recent_emoji';
export const MATRIX_ELEMENT_UNSTABLE_STATE_ROOM_WIDGET_PROPERTY_NAME = 'im.vector.modular.widgets';
export const MATRIX_UNSTABLE_STATE_ROOM_BANNER_PROPERTY_NAME =