merge: Overhaul trending polls (!1022)

View MR for information: https://activitypub.software/TransFem-org/Sharkey/-/merge_requests/1022

Approved-by: dakkar <dakkar@thenautilus.net>
Approved-by: Marie <github@yuugi.dev>
This commit is contained in:
Hazelnoot 2025-06-01 20:52:12 +00:00
commit 89a32041aa
6 changed files with 161 additions and 25 deletions

20
locales/index.d.ts vendored
View file

@ -13077,6 +13077,26 @@ export interface Locale extends ILocale {
* Users popular on {name}
*/
"popularUsersLocal": ParameterizedString<"name">;
/**
* Polls trending on {name}
*/
"pollsOnLocal": ParameterizedString<"name">;
/**
* Polls trending on the global network
*/
"pollsOnRemote": string;
/**
* Polls that have ended recently
*/
"pollsExpired": string;
/**
* Trending polls are disabled on this instance.
*/
"trendingPollsDisabled": string;
/**
* Please log in to view trending polls.
*/
"trendingPollsDisabledLogIn": string;
/**
* Silenced
*/

View file

@ -9,13 +9,13 @@ import type { NotesRepository, MutingsRepository, PollsRepository, PollVotesRepo
import { Endpoint } from '@/server/api/endpoint-base.js';
import { NoteEntityService } from '@/core/entities/NoteEntityService.js';
import { DI } from '@/di-symbols.js';
import { QueryService } from '@/core/QueryService.js';
import { RoleService } from '@/core/RoleService.js';
import { ApiError } from '@/server/api/error.js';
export const meta = {
tags: ['notes'],
requireCredential: true,
kind: 'read:account',
res: {
type: 'array',
optional: false, nullable: false,
@ -26,10 +26,24 @@ export const meta = {
},
},
// 2 calls per second
errors: {
ltlDisabled: {
message: 'Local timeline has been disabled.',
code: 'LTL_DISABLED',
id: '45a6eb02-7695-4393-b023-dd3be9aaaefd',
},
gtlDisabled: {
message: 'Global timeline has been disabled.',
code: 'GTL_DISABLED',
id: '0332fc13-6ab2-4427-ae80-a9fadffd1a6b',
},
},
// Up to 10 calls, then 2 per second
limit: {
duration: 1000,
max: 2,
type: 'bucket',
size: 10,
dripRate: 500,
},
} as const;
@ -39,6 +53,8 @@ export const paramDef = {
limit: { type: 'integer', minimum: 1, maximum: 100, default: 10 },
offset: { type: 'integer', default: 0 },
excludeChannels: { type: 'boolean', default: false },
local: { type: 'boolean', nullable: true, default: null },
expired: { type: 'boolean', default: false },
},
required: [],
} as const;
@ -59,18 +75,54 @@ export default class extends Endpoint<typeof meta, typeof paramDef> { // eslint-
private mutingsRepository: MutingsRepository,
private noteEntityService: NoteEntityService,
private readonly queryService: QueryService,
private readonly roleService: RoleService,
) {
super(meta, paramDef, async (ps, me) => {
const query = this.pollsRepository.createQueryBuilder('poll')
.where('poll.userHost IS NULL')
.andWhere('poll.userId != :meId', { meId: me.id })
.andWhere('poll.noteVisibility = \'public\'')
.andWhere(new Brackets(qb => {
.innerJoinAndSelect('poll.note', 'note')
.innerJoinAndSelect('note.user', 'user')
.leftJoinAndSelect('note.renote', 'renote')
.leftJoinAndSelect('note.reply', 'reply')
.leftJoinAndSelect('renote.user', 'renoteUser')
.leftJoinAndSelect('reply.user', 'replyUser')
.andWhere('user.isExplorable = TRUE')
;
if (me) {
query.andWhere('poll.userId != :meId', { meId: me.id });
}
if (ps.expired) {
query.andWhere('poll.expiresAt IS NOT NULL');
query.andWhere('poll.expiresAt <= :expiresMax', {
expiresMax: new Date(),
});
query.andWhere('poll.expiresAt >= :expiresMin', {
expiresMin: new Date(Date.now() - (1000 * 60 * 60 * 24 * 7)),
});
} else {
query.andWhere(new Brackets(qb => {
qb
.where('poll.expiresAt IS NULL')
.orWhere('poll.expiresAt > :now', { now: new Date() });
}));
}
const policies = await this.roleService.getUserPolicies(me?.id ?? null);
if (ps.local != null) {
if (ps.local) {
if (!policies.ltlAvailable) throw new ApiError(meta.errors.ltlDisabled);
query.andWhere('poll.userHost IS NULL');
} else {
if (!policies.gtlAvailable) throw new ApiError(meta.errors.gtlDisabled);
query.andWhere('poll.userHost IS NOT NULL');
}
} else {
if (!policies.gtlAvailable) throw new ApiError(meta.errors.gtlDisabled);
}
/*
//#region exclude arleady voted polls
const votedQuery = this.pollVotesRepository.createQueryBuilder('vote')
.select('vote.noteId')
@ -81,16 +133,15 @@ export default class extends Endpoint<typeof meta, typeof paramDef> { // eslint-
query.setParameters(votedQuery.getParameters());
//#endregion
*/
//#region mute
const mutingQuery = this.mutingsRepository.createQueryBuilder('muting')
.select('muting.muteeId')
.where('muting.muterId = :muterId', { muterId: me.id });
query
.andWhere(`poll.userId NOT IN (${ mutingQuery.getQuery() })`);
query.setParameters(mutingQuery.getParameters());
//#region block/mute/vis
this.queryService.generateVisibilityQuery(query, me);
this.queryService.generateBlockedHostQueryForNote(query);
if (me) {
this.queryService.generateBlockedUserQueryForNotes(query, me);
this.queryService.generateMutedUserQueryForNotes(query, me);
}
//#endregion
//#region exclude channels
@ -107,6 +158,7 @@ export default class extends Endpoint<typeof meta, typeof paramDef> { // eslint-
if (polls.length === 0) return [];
/*
const notes = await this.notesRepository.find({
where: {
id: In(polls.map(poll => poll.noteId)),
@ -115,6 +167,10 @@ export default class extends Endpoint<typeof meta, typeof paramDef> { // eslint-
id: 'DESC',
},
});
*/
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
const notes = polls.map(poll => poll.note!);
return await this.noteEntityService.packMany(notes, me, {
detail: true,

View file

@ -10,27 +10,77 @@ SPDX-License-Identifier: AGPL-3.0-only
<option value="polls">{{ i18n.ts.poll }}</option>
</MkTab>
<MkNotes v-if="tab === 'notes'" :pagination="paginationForNotes"/>
<MkNotes v-else-if="tab === 'polls'" :pagination="paginationForPolls"/>
<div v-else-if="tab === 'polls'">
<template v-if="ltlAvailable || gtlAvailable">
<MkFoldableSection v-if="ltlAvailable" class="_margin">
<template #header><i class="ph-house ph-bold ph-lg" style="margin-right: 0.5em;"></i>{{ i18n.tsx.pollsOnLocal({ name: instance.name ?? host }) }}</template>
<MkNotes :pagination="paginationForPollsLocal" :disableAutoLoad="true"/>
</MkFoldableSection>
<MkFoldableSection v-if="gtlAvailable" class="_margin">
<template #header><i class="ph-globe ph-bold ph-lg" style="margin-right: 0.5em;"></i>{{ i18n.ts.pollsOnRemote }}</template>
<MkNotes :pagination="paginationForPollsRemote" :disableAutoLoad="true"/>
</MkFoldableSection>
<MkFoldableSection v-if="gtlAvailable" class="_margin">
<template #header><i class="ph-timer ph-bold ph-lg" style="margin-right: 0.5em;"></i>{{ i18n.ts.pollsExpired }}</template>
<MkNotes :pagination="paginationForPollsExpired" :disableAutoLoad="true"/>
</MkFoldableSection>
</template>
<template v-else>
<div v-if="$i"><i class="ti ti-alert-triangle"></i>{{ i18n.ts.trendingPollsDisabled }}</div>
<div v-else><i class="ti ti-alert-triangle"></i>{{ i18n.ts.trendingPollsDisabledLogIn }}</div>
</template>
</div>
</div>
</template>
<script lang="ts" setup>
import { ref } from 'vue';
import { computed, ref } from 'vue';
import { host } from '@@/js/config.js';
import MkNotes from '@/components/MkNotes.vue';
import MkTab from '@/components/MkTab.vue';
import { i18n } from '@/i18n.js';
import MkFoldableSection from '@/components/MkFoldableSection.vue';
import { instance } from '@/instance.js';
import { $i } from '@/i';
const ltlAvailable = computed(() => $i?.policies.ltlAvailable ?? instance.policies.ltlAvailable);
const gtlAvailable = computed(() => $i?.policies.gtlAvailable ?? instance.policies.gtlAvailable);
const paginationForNotes = {
endpoint: 'notes/featured' as const,
limit: 10,
};
const paginationForPolls = {
const paginationForPollsLocal = {
endpoint: 'notes/polls/recommendation' as const,
limit: 10,
offsetMode: true,
params: {
excludeChannels: true,
local: true,
},
};
const paginationForPollsRemote = {
endpoint: 'notes/polls/recommendation' as const,
limit: 10,
offsetMode: true,
params: {
excludeChannels: true,
local: false,
},
};
const paginationForPollsExpired = {
endpoint: 'notes/polls/recommendation' as const,
limit: 10,
offsetMode: true,
params: {
excludeChannels: true,
local: null,
expired: true,
},
};

View file

@ -3840,7 +3840,7 @@ declare module '../api.js' {
/**
* No description provided.
*
* **Credential required**: *Yes* / **Permission**: *read:account*
* **Credential required**: *No*
*/
request<E extends 'notes/polls/recommendation', P extends Endpoints[E]['req']>(
endpoint: E,

View file

@ -3317,7 +3317,7 @@ export type paths = {
* notes/polls/recommendation
* @description No description provided.
*
* **Credential required**: *Yes* / **Permission**: *read:account*
* **Credential required**: *No*
*/
post: operations['notes___polls___recommendation'];
};
@ -27498,7 +27498,7 @@ export type operations = {
* notes/polls/recommendation
* @description No description provided.
*
* **Credential required**: *Yes* / **Permission**: *read:account*
* **Credential required**: *No*
*/
notes___polls___recommendation: {
requestBody: {
@ -27510,6 +27510,10 @@ export type operations = {
offset?: number;
/** @default false */
excludeChannels?: boolean;
/** @default null */
local?: boolean | null;
/** @default false */
expired?: boolean;
};
};
};

View file

@ -574,6 +574,12 @@ bubbleTimelineMustBeEnabled: "Note: the bubble timeline is hidden by default, an
popularUsersGlobal: "Users popular on the global network"
popularUsersLocal: "Users popular on {name}"
pollsOnLocal: "Polls trending on {name}"
pollsOnRemote: "Polls trending on the global network"
pollsExpired: "Polls that have ended recently"
trendingPollsDisabled: "Trending polls are disabled on this instance."
trendingPollsDisabledLogIn: "Please log in to view trending polls."
silenced: "Silenced"
totalFollowers: "Total followers"
totalFollowing: "Total following"