Cache profile fields and assets behind one shared store.
Trigger cinny-mobile / dispatch (push) Successful in 1s
Trigger cinny-mobile / dispatch (push) Successful in 1s
Colour, banner, collectibles, and profile each read the same extended profile endpoint through separate caches with mismatched TTLs, so a single profile view fired three round trips. They now read through one cache with a shared TTL and in-flight dedupe, and profile media is kept as blob URLs instead of being re-downloaded per mount. useUserProfile now prefers the SDK's sync-cached user and only fetches when both the SDK and the cache are cold.
This commit is contained in:
@@ -0,0 +1,73 @@
|
||||
import { MatrixClient } from 'matrix-js-sdk';
|
||||
import { mxcUrlToHttp } from './matrix';
|
||||
import { getCurrentAccessToken } from './auth';
|
||||
|
||||
/**
|
||||
* Blob URLs for profile assets (banner, nameplate, avatar decoration).
|
||||
*
|
||||
* Kept in one cache so reopening the same profile does not re-download the
|
||||
* same media on every mount. Entries are revoked only when evicted.
|
||||
*/
|
||||
const MAX_ASSET_CACHE_ENTRIES = 200;
|
||||
|
||||
const assetCache = new Map<string, string>();
|
||||
const inflightAssets = new Map<string, Promise<string | undefined>>();
|
||||
|
||||
function evictOldest(): void {
|
||||
const firstKey = assetCache.keys().next().value;
|
||||
if (firstKey === undefined) return;
|
||||
const url = assetCache.get(firstKey);
|
||||
assetCache.delete(firstKey);
|
||||
if (url) URL.revokeObjectURL(url);
|
||||
}
|
||||
|
||||
export async function getProfileAssetUrl(
|
||||
mx: MatrixClient,
|
||||
mxcUrl: string,
|
||||
useAuthentication: boolean
|
||||
): Promise<string | undefined> {
|
||||
if (!mxcUrl) return undefined;
|
||||
|
||||
const cached = assetCache.get(mxcUrl);
|
||||
if (cached) return cached;
|
||||
|
||||
const pending = inflightAssets.get(mxcUrl);
|
||||
if (pending) return pending;
|
||||
|
||||
const request = (async () => {
|
||||
const httpUrl = mxcUrlToHttp(mx, mxcUrl, useAuthentication);
|
||||
if (!httpUrl) return undefined;
|
||||
|
||||
const headers: HeadersInit = {};
|
||||
if (useAuthentication) {
|
||||
const accessToken = getCurrentAccessToken();
|
||||
if (accessToken) headers.Authorization = `Bearer ${accessToken}`;
|
||||
}
|
||||
|
||||
try {
|
||||
const response = await fetch(httpUrl, { headers });
|
||||
if (!response.ok) return undefined;
|
||||
|
||||
const blob = await response.blob();
|
||||
const blobUrl = URL.createObjectURL(blob);
|
||||
if (assetCache.size >= MAX_ASSET_CACHE_ENTRIES) evictOldest();
|
||||
assetCache.set(mxcUrl, blobUrl);
|
||||
return blobUrl;
|
||||
} catch {
|
||||
return undefined;
|
||||
}
|
||||
})();
|
||||
|
||||
inflightAssets.set(mxcUrl, request);
|
||||
try {
|
||||
return await request;
|
||||
} finally {
|
||||
if (inflightAssets.get(mxcUrl) === request) inflightAssets.delete(mxcUrl);
|
||||
}
|
||||
}
|
||||
|
||||
export function clearProfileAssetCache(): void {
|
||||
assetCache.forEach((url) => URL.revokeObjectURL(url));
|
||||
assetCache.clear();
|
||||
inflightAssets.clear();
|
||||
}
|
||||
@@ -0,0 +1,91 @@
|
||||
import { MatrixClient } from 'matrix-js-sdk';
|
||||
|
||||
/**
|
||||
* Single shared cache for a user's profile fields.
|
||||
*
|
||||
* Colour, banner and collectibles all come from the same profile endpoint, so they
|
||||
* must read through one cache instead of each keeping their own - otherwise opening
|
||||
* a profile view fires the same request three times.
|
||||
*/
|
||||
export type ProfileFields = Record<string, unknown>;
|
||||
|
||||
export const PROFILE_CACHE_TTL_MS = 5 * 60 * 1000;
|
||||
const MAX_PROFILE_CACHE_ENTRIES = 500;
|
||||
|
||||
type ProfileCacheEntry = { fields: ProfileFields; timestamp: number };
|
||||
|
||||
const profileCache = new Map<string, ProfileCacheEntry>();
|
||||
const inflightRequests = new Map<string, Promise<ProfileFields>>();
|
||||
const cacheListeners = new Set<(userId: string) => void>();
|
||||
|
||||
export function registerProfileCacheListener(fn: (userId: string) => void): () => void {
|
||||
cacheListeners.add(fn);
|
||||
return () => cacheListeners.delete(fn);
|
||||
}
|
||||
|
||||
export function clearProfileCache(userId?: string): void {
|
||||
if (!userId) return;
|
||||
profileCache.delete(userId);
|
||||
inflightRequests.delete(userId);
|
||||
cacheListeners.forEach((listener) => listener(userId));
|
||||
}
|
||||
|
||||
function setProfileCache(userId: string, fields: ProfileFields): void {
|
||||
if (profileCache.size >= MAX_PROFILE_CACHE_ENTRIES) {
|
||||
const firstKey = profileCache.keys().next().value;
|
||||
if (firstKey !== undefined) profileCache.delete(firstKey);
|
||||
}
|
||||
profileCache.set(userId, { fields, timestamp: Date.now() });
|
||||
}
|
||||
|
||||
/** Cached profile fields, or undefined when the entry is missing or expired. */
|
||||
export function getCachedProfileFields(userId: string): ProfileFields | undefined {
|
||||
if (!userId) return undefined;
|
||||
const entry = profileCache.get(userId);
|
||||
if (!entry || Date.now() - entry.timestamp >= PROFILE_CACHE_TTL_MS) return undefined;
|
||||
return entry.fields;
|
||||
}
|
||||
|
||||
/**
|
||||
* Profile fields for a user, served from the shared cache when possible.
|
||||
* Concurrent callers for the same user share one request.
|
||||
*/
|
||||
export async function getProfileFields(mx: MatrixClient, userId: string): Promise<ProfileFields> {
|
||||
if (!userId) return {};
|
||||
|
||||
const cached = getCachedProfileFields(userId);
|
||||
if (cached) return cached;
|
||||
|
||||
const pending = inflightRequests.get(userId);
|
||||
if (pending) return pending;
|
||||
|
||||
const request = (async () => {
|
||||
let fields: ProfileFields = {};
|
||||
|
||||
try {
|
||||
if (await mx.doesServerSupportExtendedProfiles()) {
|
||||
fields = await mx.getExtendedProfile(userId);
|
||||
}
|
||||
} catch {
|
||||
// Server may not support MSC4133, or the user has no extended fields.
|
||||
}
|
||||
|
||||
if (Object.keys(fields).length === 0) {
|
||||
try {
|
||||
fields = (await mx.getProfileInfo(userId)) as ProfileFields;
|
||||
} catch {
|
||||
fields = {};
|
||||
}
|
||||
}
|
||||
|
||||
setProfileCache(userId, fields);
|
||||
return fields;
|
||||
})();
|
||||
|
||||
inflightRequests.set(userId, request);
|
||||
try {
|
||||
return await request;
|
||||
} finally {
|
||||
if (inflightRequests.get(userId) === request) inflightRequests.delete(userId);
|
||||
}
|
||||
}
|
||||
@@ -1,5 +1,6 @@
|
||||
import { MatrixClient, Room } from 'matrix-js-sdk';
|
||||
import { ThemeKind } from '../hooks/useTheme';
|
||||
import { clearProfileCache, getProfileFields } from './profileCache';
|
||||
|
||||
/** MSC4522 stable profile field for username colors */
|
||||
export const PROFILE_KEY_COLOR_PREFERENCE_STABLE = 'm.color_preference';
|
||||
@@ -120,26 +121,8 @@ export function extractCollectiblesFromProfile(profile: Record<string, unknown>)
|
||||
};
|
||||
}
|
||||
|
||||
async function loadCollectiblesFromProfile(mx: MatrixClient, userId: string): Promise<CollectibleProfileFields> {
|
||||
if (await mx.doesServerSupportExtendedProfiles()) {
|
||||
try {
|
||||
const profile = await mx.getExtendedProfile(userId);
|
||||
return extractCollectiblesFromProfile(profile);
|
||||
} catch {
|
||||
// fall through
|
||||
}
|
||||
}
|
||||
|
||||
try {
|
||||
const profile = (await mx.getProfileInfo(userId)) as Record<string, unknown>;
|
||||
return extractCollectiblesFromProfile(profile);
|
||||
} catch {
|
||||
return {};
|
||||
}
|
||||
}
|
||||
|
||||
export async function loadUserCollectibles(mx: MatrixClient, userId: string): Promise<CollectibleProfileFields> {
|
||||
return loadCollectiblesFromProfile(mx, userId);
|
||||
return extractCollectiblesFromProfile(await getProfileFields(mx, userId));
|
||||
}
|
||||
|
||||
export async function saveCollectible(
|
||||
@@ -179,21 +162,7 @@ export async function getBannerUrlProfileKey(mx: MatrixClient): Promise<string>
|
||||
}
|
||||
|
||||
export async function loadBannerUrl(mx: MatrixClient, userId: string): Promise<string | undefined> {
|
||||
if (await mx.doesServerSupportExtendedProfiles()) {
|
||||
try {
|
||||
const profile = await mx.getExtendedProfile(userId);
|
||||
return extractBannerUrlFromProfile(profile);
|
||||
} catch {
|
||||
// fall through
|
||||
}
|
||||
}
|
||||
|
||||
try {
|
||||
const profile = (await mx.getProfileInfo(userId)) as Record<string, unknown>;
|
||||
return extractBannerUrlFromProfile(profile);
|
||||
} catch {
|
||||
return undefined;
|
||||
}
|
||||
return extractBannerUrlFromProfile(await getProfileFields(mx, userId));
|
||||
}
|
||||
|
||||
export async function saveBannerUrl(mx: MatrixClient, bannerMxc: string): Promise<void> {
|
||||
@@ -204,7 +173,7 @@ export async function saveBannerUrl(mx: MatrixClient, bannerMxc: string): Promis
|
||||
const key = await getBannerUrlProfileKey(mx);
|
||||
await mx.setExtendedProfileProperty(key, bannerMxc);
|
||||
const userId = mx.getUserId();
|
||||
if (userId) clearBannerCache(userId);
|
||||
if (userId) clearProfileCache(userId);
|
||||
}
|
||||
|
||||
export async function deleteBannerUrl(mx: MatrixClient): Promise<void> {
|
||||
@@ -215,17 +184,7 @@ export async function deleteBannerUrl(mx: MatrixClient): Promise<void> {
|
||||
const key = await getBannerUrlProfileKey(mx);
|
||||
await mx.deleteExtendedProfileProperty(key);
|
||||
const userId = mx.getUserId();
|
||||
if (userId) clearBannerCache(userId);
|
||||
}
|
||||
|
||||
let bannerCacheClearImpl: (userId: string) => void = () => {};
|
||||
|
||||
export function registerBannerCacheClear(fn: (userId: string) => void): void {
|
||||
bannerCacheClearImpl = fn;
|
||||
}
|
||||
|
||||
function clearBannerCache(userId: string): void {
|
||||
bannerCacheClearImpl(userId);
|
||||
if (userId) clearProfileCache(userId);
|
||||
}
|
||||
|
||||
export async function getColorPreferenceProfileKey(mx: MatrixClient): Promise<string> {
|
||||
@@ -239,21 +198,7 @@ export async function loadColorPreference(
|
||||
mx: MatrixClient,
|
||||
userId: string
|
||||
): Promise<ColorPreference | undefined> {
|
||||
if (await mx.doesServerSupportExtendedProfiles()) {
|
||||
try {
|
||||
const profile = await mx.getExtendedProfile(userId);
|
||||
return extractColorPreferenceFromProfile(profile);
|
||||
} catch {
|
||||
// fall through to standard profile endpoint
|
||||
}
|
||||
}
|
||||
|
||||
try {
|
||||
const profile = (await mx.getProfileInfo(userId)) as Record<string, unknown>;
|
||||
return extractColorPreferenceFromProfile(profile);
|
||||
} catch {
|
||||
return undefined;
|
||||
}
|
||||
return extractColorPreferenceFromProfile(await getProfileFields(mx, userId));
|
||||
}
|
||||
|
||||
export function extractMemberColorPreference(room: Room | undefined, userId: string): ColorPreference | undefined {
|
||||
@@ -272,17 +217,7 @@ export async function saveColorPreference(mx: MatrixClient, preference: ColorPre
|
||||
const key = await getColorPreferenceProfileKey(mx);
|
||||
await mx.setExtendedProfileProperty(key, preference);
|
||||
const userId = mx.getUserId();
|
||||
if (userId) clearPreferenceCache(userId);
|
||||
}
|
||||
|
||||
let preferenceCacheClearImpl: (userId: string) => void = () => {};
|
||||
|
||||
export function registerPreferenceCacheClear(fn: (userId: string) => void): void {
|
||||
preferenceCacheClearImpl = fn;
|
||||
}
|
||||
|
||||
function clearPreferenceCache(userId: string): void {
|
||||
preferenceCacheClearImpl(userId);
|
||||
if (userId) clearProfileCache(userId);
|
||||
}
|
||||
|
||||
export async function deleteColorPreference(mx: MatrixClient): Promise<void> {
|
||||
@@ -293,5 +228,5 @@ export async function deleteColorPreference(mx: MatrixClient): Promise<void> {
|
||||
const key = await getColorPreferenceProfileKey(mx);
|
||||
await mx.deleteExtendedProfileProperty(key);
|
||||
const userId = mx.getUserId();
|
||||
if (userId) clearPreferenceCache(userId);
|
||||
if (userId) clearProfileCache(userId);
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user