Files
fluxer/fluxer_api/src/tenor/TenorService.ts
Hampus Kraft 2f557eda8c initial commit
2026-01-01 21:05:54 +00:00

290 lines
8.5 KiB
TypeScript

/*
* Copyright (C) 2026 Fluxer Contributors
*
* This file is part of Fluxer.
*
* Fluxer is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Fluxer is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with Fluxer. If not, see <https://www.gnu.org/licenses/>.
*/
import type {Context} from 'hono';
import {Config} from '~/Config';
import {FLUXER_USER_AGENT} from '~/Constants';
import type {ICacheService} from '~/infrastructure/ICacheService';
import type {IMediaService} from '~/infrastructure/IMediaService';
import type {ITenorService} from '~/infrastructure/ITenorService';
import {Logger} from '~/Logger';
import type {TenorCategoryTagResponse, TenorGifResponse} from '~/tenor/TenorModel';
const TENOR_BASE_URL = 'https://tenor.googleapis.com/v2';
const DEFAULT_MEDIA_FILTER = 'webm';
const DEFAULT_CONTENT_FILTER = 'low';
const CLIENT_KEY = 'fluxer';
const MAX_RETRIES = 3;
const BACKOFF_BASE_DELAY = 1000;
const CACHE_EXPIRATION_TIME = 300 * 1000;
interface TenorGif {
id: string;
title: string;
media_formats: {
webm: {
url: string;
dims: [number, number];
};
};
itemurl: string;
}
interface TenorCategoryTag {
searchterm: string;
}
type CacheEntry<T> = {
data: T;
timestamp: number;
};
export class TenorService implements ITenorService {
private readonly FEATURED_CACHE_KEY = 'tenor:featured';
private readonly TRENDING_CACHE_KEY = 'tenor:trending';
private refreshingKeys: Map<string, boolean> = new Map();
constructor(
private cacheService: ICacheService,
private mediaService: IMediaService,
) {}
private createURL({endpoint, params}: {endpoint: string; params: Record<string, string | number | undefined>}): URL {
const url = new URL(`${TENOR_BASE_URL}/${endpoint}`);
const defaultParams = {
client_key: CLIENT_KEY,
contentfilter: DEFAULT_CONTENT_FILTER,
media_filter: DEFAULT_MEDIA_FILTER,
...params,
};
for (const [key, value] of Object.entries(defaultParams)) {
if (value !== undefined) {
url.searchParams.append(key, value.toString());
}
}
return url;
}
private async fetchTenorData<T>(url: URL): Promise<T> {
for (let attempt = 0; attempt < MAX_RETRIES; attempt++) {
try {
const response = await fetch(url.toString(), {headers: {'User-Agent': FLUXER_USER_AGENT}});
if (!response.ok) {
throw new Error(`Failed to fetch Tenor data: ${response.statusText}`);
}
return response.json() as Promise<T>;
} catch (error) {
if (attempt < MAX_RETRIES - 1) {
const delay = BACKOFF_BASE_DELAY * 2 ** attempt;
await new Promise((resolve) => setTimeout(resolve, delay));
} else {
throw error;
}
}
}
throw new Error('Exceeded maximum retries');
}
private async fetchAndTransformGifs(url: URL): Promise<Array<TenorGifResponse>> {
const {results} = await this.fetchTenorData<{results: Array<TenorGif>}>(url);
return results.map((gif) => this.transformTenorGif(gif));
}
private async getCache<T>(key: string): Promise<{data: T; isStale: boolean} | null> {
const cached = await this.cacheService.get<CacheEntry<T>>(key);
if (!cached) return null;
const age = Date.now() - cached.timestamp;
const isStale = age > CACHE_EXPIRATION_TIME;
return {data: cached.data, isStale};
}
private async setCache<T>(key: string, data: T): Promise<void> {
const cacheEntry: CacheEntry<T> = {
data,
timestamp: Date.now(),
};
await this.cacheService.set(key, cacheEntry);
}
private triggerBackgroundRefresh<T>(key: string, refreshFn: () => Promise<T>): void {
if (this.refreshingKeys.get(key)) {
return;
}
this.refreshingKeys.set(key, true);
setImmediate(async () => {
try {
const freshData = await refreshFn();
await this.setCache(key, freshData);
} catch (error) {
Logger.debug({key, error}, `Background refresh failed for key ${key}`);
} finally {
this.refreshingKeys.delete(key);
}
});
}
async search(params: {q: string; locale: string; ctx: Context}): Promise<Array<TenorGifResponse>> {
const url = this.createURL({
endpoint: 'search',
params: {
key: Config.tenor.apiKey,
q: params.q,
country: params.ctx.req.header('CF-IPCountry') || 'US',
locale: params.locale,
limit: 50,
},
});
return this.fetchAndTransformGifs(url);
}
async registerShare(params: {id: string; q: string; locale: string; ctx: Context}): Promise<void> {
const url = this.createURL({
endpoint: 'registershare',
params: {
key: Config.tenor.apiKey,
id: params.id,
country: params.ctx.req.header('CF-IPCountry') || 'US',
locale: params.locale,
q: params.q,
},
});
await fetch(url.toString(), {headers: {'User-Agent': FLUXER_USER_AGENT}});
}
async getFeatured(params: {locale: string; ctx: Context}): Promise<{
gifs: Array<TenorGifResponse>;
categories: Array<TenorCategoryTagResponse>;
}> {
const cached = await this.getCache<{
gifs: Array<TenorGifResponse>;
categories: Array<TenorCategoryTagResponse>;
}>(this.FEATURED_CACHE_KEY);
if (cached) {
if (cached.isStale) {
this.triggerBackgroundRefresh(this.FEATURED_CACHE_KEY, () => this.fetchFeaturedData(params));
}
return cached.data;
}
const data = await this.fetchFeaturedData(params);
await this.setCache(this.FEATURED_CACHE_KEY, data);
return data;
}
private async fetchFeaturedData(params: {locale: string; ctx: Context}): Promise<{
gifs: Array<TenorGifResponse>;
categories: Array<TenorCategoryTagResponse>;
}> {
const [gifs, categories] = await Promise.all([this.getFeaturedGifs(params), this.getFeaturedCategories(params)]);
return {gifs, categories};
}
async getTrendingGifs(params: {locale: string; ctx: Context}): Promise<Array<TenorGifResponse>> {
const cached = await this.getCache<Array<TenorGifResponse>>(this.TRENDING_CACHE_KEY);
if (cached) {
if (cached.isStale) {
this.triggerBackgroundRefresh(this.TRENDING_CACHE_KEY, () => this.fetchTrendingGifs(params));
}
return cached.data;
}
const gifs = await this.fetchTrendingGifs(params);
await this.setCache(this.TRENDING_CACHE_KEY, gifs);
return gifs;
}
private async fetchTrendingGifs(params: {locale: string; ctx: Context}): Promise<Array<TenorGifResponse>> {
const url = this.createURL({
endpoint: 'featured',
params: {
key: Config.tenor.apiKey,
country: params.ctx.req.header('CF-IPCountry') || 'US',
locale: params.locale,
limit: 50,
},
});
return this.fetchAndTransformGifs(url);
}
async suggest(params: {q: string; locale: string; ctx: Context}): Promise<Array<string>> {
const url = this.createURL({
endpoint: 'autocomplete',
params: {
key: Config.tenor.apiKey,
q: params.q,
locale: params.locale,
},
});
const {results} = await this.fetchTenorData<{results: Array<string>}>(url);
return results;
}
private async getFeaturedGifs(params: {locale: string; ctx: Context}): Promise<Array<TenorGifResponse>> {
const url = this.createURL({
endpoint: 'featured',
params: {
key: Config.tenor.apiKey,
country: params.ctx.req.header('CF-IPCountry') || 'US',
locale: params.locale,
limit: 1,
},
});
return this.fetchAndTransformGifs(url);
}
private async getFeaturedCategories(params: {
locale: string;
ctx: Context;
}): Promise<Array<TenorCategoryTagResponse>> {
const url = this.createURL({
endpoint: 'categories',
params: {
key: Config.tenor.apiKey,
country: params.ctx.req.header('CF-IPCountry') || 'US',
locale: params.locale,
type: 'featured',
},
});
const {tags} = await this.fetchTenorData<{tags: Array<TenorCategoryTag>}>(url);
return Promise.all(
tags.map(async (tag) => {
const [gif] = await this.search({q: tag.searchterm, locale: params.locale, ctx: params.ctx});
return {
name: tag.searchterm,
src: gif.src,
proxy_src: gif.proxy_src,
};
}),
);
}
private transformTenorGif(input: TenorGif): TenorGifResponse {
return {
id: input.id,
title: input.title,
url: input.itemurl,
src: input.media_formats.webm.url,
proxy_src: this.mediaService.getExternalMediaProxyURL(input.media_formats.webm.url),
width: input.media_formats.webm.dims[0],
height: input.media_formats.webm.dims[1],
};
}
}