pepepper/fluxer
1
0 Fork 0
mirror of https://github.com/fluxerapp/fluxer synced 2026-10-18 21:45:31 +09:00
Code Issues Packages Projects Releases Wiki Activity

fix(app): gate reworked typing indicators behind an experiment (#2782)

Browse Source
This commit is contained in:
Hampus authored and GitHub committed 2026-09-14 21:54:52 +02:00
1 parent 1861432a53
commit c212d315f4
91 files changed
+6137 -1756
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

fluxer_api/src/api/admin/controllers/InstanceConfigAdminController.ts
+16
View File
@@ -38,6 +38,7 @@ import {GuildActivityLogPresentationConfigSchema} from '@fluxer/schema/src/domai
import {GuildHeaderCollapseConfigSchema} from '@fluxer/schema/src/domains/experiment/GuildHeaderCollapseSchemas';
import {MessageHoverTrackingConfigSchema} from '@fluxer/schema/src/domains/experiment/MessageHoverTrackingSchemas';
import {MessageKeyboardFocusConfigSchema} from '@fluxer/schema/src/domains/experiment/MessageKeyboardFocusSchemas';
import {TypingIndicatorReworkConfigSchema} from '@fluxer/schema/src/domains/experiment/TypingIndicatorReworkSchemas';
import type {InstanceBranding} from '@fluxer/schema/src/domains/instance/InstanceSchemas';
import {SmtpEmailProvider} from '@pkgs/email/src/SmtpEmailProvider';
import type {Context} from 'hono';
@@ -70,6 +71,7 @@ async function buildInstanceConfigResponse(): Promise<InstanceConfigResponse> {
blockedMessageGroups,
expressionInfoCard,
guildHeaderCollapse,
typingIndicatorRework,
registrationConfig,
registrationUrls,
pendingRegistrations,
@@ -84,6 +86,7 @@ async function buildInstanceConfigResponse(): Promise<InstanceConfigResponse> {
instanceConfigRepository.getBlockedMessageGroupsConfig(),
instanceConfigRepository.getExpressionInfoCardConfig(),
instanceConfigRepository.getGuildHeaderCollapseConfig(),
instanceConfigRepository.getTypingIndicatorReworkConfig(),
instanceConfigRepository.getRegistrationConfig(),
instanceConfigRepository.getRegistrationUrlsForAdmin(),
instanceConfigRepository.getPendingRegistrations(),
@@ -121,6 +124,7 @@ async function buildInstanceConfigResponse(): Promise<InstanceConfigResponse> {
blocked_message_groups: blockedMessageGroups,
expression_info_card: expressionInfoCard,
guild_header_collapse: guildHeaderCollapse,
typing_indicator_rework: typingIndicatorRework,
registration: {
...registrationConfig,
urls: registrationUrls,
@@ -337,6 +341,18 @@ export function InstanceConfigAdminController(app: HonoApp) {
await instanceConfigRepository.setGuildHeaderCollapseConfig(validated);
}
}
if (data.typing_indicator_rework) {
const patch = omitUndefinedFields(data.typing_indicator_rework);
if (Object.keys(patch).length > 0) {
const currentTypingIndicatorRework = await instanceConfigRepository.getTypingIndicatorReworkConfig();
const validated = TypingIndicatorReworkConfigSchema.parse({
...currentTypingIndicatorRework,
...patch,
config_version: currentTypingIndicatorRework.config_version + 1,
});
await instanceConfigRepository.setTypingIndicatorReworkConfig(validated);
}
}
if (data.experiment_delivery) {
const currentExperimentDelivery = await instanceConfigRepository.getExperimentDeliveryConfig();
const validated = ExperimentDeliveryConfigSchema.parse({
fluxer_api/src/api/experiment/ExperimentController.ts
+4
View File
@@ -16,6 +16,7 @@ import {resolveGuildActivityLogPresentationAssignment} from '@fluxer/schema/src/
import {resolveGuildHeaderCollapseAssignment} from '@fluxer/schema/src/domains/experiment/GuildHeaderCollapseSchemas';
import {resolveMessageHoverTrackingAssignment} from '@fluxer/schema/src/domains/experiment/MessageHoverTrackingSchemas';
import {resolveMessageKeyboardFocusAssignment} from '@fluxer/schema/src/domains/experiment/MessageKeyboardFocusSchemas';
import {resolveTypingIndicatorReworkAssignment} from '@fluxer/schema/src/domains/experiment/TypingIndicatorReworkSchemas';
export function ExperimentController(app: HonoApp) {
app.get(
@@ -43,6 +44,7 @@ export function ExperimentController(app: HonoApp) {
guildActivityLogPresentationConfig,
expressionInfoCardConfig,
guildHeaderCollapseConfig,
typingIndicatorReworkConfig,
] = await Promise.all([
instanceConfigRepository.getExperimentDeliveryConfig(),
instanceConfigRepository.getVoiceNoiseSuppressionConfig(),
@@ -52,6 +54,7 @@ export function ExperimentController(app: HonoApp) {
instanceConfigRepository.getGuildActivityLogPresentationConfig(),
instanceConfigRepository.getExpressionInfoCardConfig(),
instanceConfigRepository.getGuildHeaderCollapseConfig(),
instanceConfigRepository.getTypingIndicatorReworkConfig(),
]);
const userId = ctx.get('user').id.toString();
const body: ExperimentAssignmentsResponse = {
@@ -68,6 +71,7 @@ export function ExperimentController(app: HonoApp) {
),
expression_info_card: resolveExpressionInfoCardAssignment(expressionInfoCardConfig, userId),
guild_header_collapse: resolveGuildHeaderCollapseAssignment(guildHeaderCollapseConfig, userId),
typing_indicator_rework: resolveTypingIndicatorReworkAssignment(typingIndicatorReworkConfig, userId),
},
};
const etag = `"${createHash('sha256').update(JSON.stringify(body)).digest('hex')}"`;
fluxer_api/src/api/experiment/tests/ExperimentController.test.ts
+87 -1
View File
@@ -25,6 +25,7 @@ import {
readGuildHeaderCollapseAssignment,
readMessageHoverTrackingAssignment,
readMessageKeyboardFocusAssignment,
readTypingIndicatorReworkAssignment,
readVoiceNoiseSuppressionAssignment,
} from '@fluxer/schema/src/domains/experiment/ExperimentSchemas';
import {
@@ -47,6 +48,10 @@ import {
DEFAULT_MESSAGE_KEYBOARD_FOCUS_CONFIG,
INERT_MESSAGE_KEYBOARD_FOCUS_ASSIGNMENT,
} from '@fluxer/schema/src/domains/experiment/MessageKeyboardFocusSchemas';
import {
DEFAULT_TYPING_INDICATOR_REWORK_CONFIG,
INERT_TYPING_INDICATOR_REWORK_ASSIGNMENT,
} from '@fluxer/schema/src/domains/experiment/TypingIndicatorReworkSchemas';
import {afterAll, beforeAll, beforeEach, describe, expect, it} from 'vitest';
const NOT_MODIFIED = 304;
@@ -87,6 +92,7 @@ describe('GET /experiments', () => {
guild_activity_log_presentation: INERT_GUILD_ACTIVITY_LOG_PRESENTATION_ASSIGNMENT,
expression_info_card: INERT_EXPRESSION_INFO_CARD_ASSIGNMENT,
guild_header_collapse: INERT_GUILD_HEADER_COLLAPSE_ASSIGNMENT,
typing_indicator_rework: INERT_TYPING_INDICATOR_REWORK_ASSIGNMENT,
},
});
});
@@ -416,7 +422,81 @@ describe('GET /experiments', () => {
});
});
it('resolves all seven experiments independently', async () => {
it('populates the typing indicator rework key even when the rollout is disabled', async () => {
const account = await createTestAccount(harness);
const body = await createBuilder<ExperimentAssignmentsResponse>(harness, account.token).get(ENDPOINT).execute();
expect(Object.hasOwn(body.assignments, 'typing_indicator_rework')).toBe(true);
expect(readTypingIndicatorReworkAssignment(body)).toEqual(INERT_TYPING_INDICATOR_REWORK_ASSIGNMENT);
});
it('targets an allowlisted account for typing indicator rework', async () => {
const account = await createTestAccount(harness);
await getInstanceConfigRepository().setTypingIndicatorReworkConfig({
...DEFAULT_TYPING_INDICATOR_REWORK_CONFIG,
enabled: true,
config_version: 6,
included_user_ids: [account.userId],
});
const body = await createBuilder<ExperimentAssignmentsResponse>(harness, account.token).get(ENDPOINT).execute();
expect(readTypingIndicatorReworkAssignment(body)).toEqual({
enabled: true,
config_version: 6,
user_targeted: true,
source: 'user_rule',
});
});
it('leaves an account outside a zero-width typing indicator rework rollout', async () => {
const account = await createTestAccount(harness);
await getInstanceConfigRepository().setTypingIndicatorReworkConfig({
...DEFAULT_TYPING_INDICATOR_REWORK_CONFIG,
enabled: true,
config_version: 2,
});
const body = await createBuilder<ExperimentAssignmentsResponse>(harness, account.token).get(ENDPOINT).execute();
expect(readTypingIndicatorReworkAssignment(body)).toEqual({
enabled: true,
config_version: 2,
user_targeted: false,
source: null,
});
});
it('serves a fresh body once the typing indicator rework config changes', async () => {
const account = await createTestAccount(harness);
const first = await createBuilder<ExperimentAssignmentsResponse>(harness, account.token)
.get(ENDPOINT)
.executeWithResponse();
const staleEtag = first.response.headers.get('etag') as string;
await getInstanceConfigRepository().setTypingIndicatorReworkConfig({
...DEFAULT_TYPING_INDICATOR_REWORK_CONFIG,
enabled: true,
config_version: 1,
rollout_basis_points: 10000,
});
const refreshed = await createBuilder<ExperimentAssignmentsResponse>(harness, account.token)
.get(ENDPOINT)
.header('If-None-Match', staleEtag)
.executeWithResponse();
expect(refreshed.response.status).toBe(HTTP_STATUS.OK);
expect(refreshed.response.headers.get('etag')).not.toBe(staleEtag);
expect(refreshed.json?.assignments.typing_indicator_rework).toMatchObject({
enabled: true,
config_version: 1,
user_targeted: true,
});
});
it('resolves all eight experiments independently', async () => {
const account = await createTestAccount(harness);
await getInstanceConfigRepository().setMessageHoverTrackingConfig({
...DEFAULT_MESSAGE_HOVER_TRACKING_CONFIG,
@@ -448,6 +528,11 @@ describe('GET /experiments', () => {
enabled: true,
rollout_basis_points: 10000,
});
await getInstanceConfigRepository().setTypingIndicatorReworkConfig({
...DEFAULT_TYPING_INDICATOR_REWORK_CONFIG,
enabled: true,
rollout_basis_points: 10000,
});
const body = await createBuilder<ExperimentAssignmentsResponse>(harness, account.token).get(ENDPOINT).execute();
@@ -457,6 +542,7 @@ describe('GET /experiments', () => {
expect(readGuildActivityLogPresentationAssignment(body).user_targeted).toBe(true);
expect(readExpressionInfoCardAssignment(body).user_targeted).toBe(true);
expect(readGuildHeaderCollapseAssignment(body).user_targeted).toBe(true);
expect(readTypingIndicatorReworkAssignment(body).user_targeted).toBe(true);
expect(readVoiceNoiseSuppressionAssignment(body).enabled).toBe(false);
});
fluxer_api/src/api/instance/InstanceConfigRepository.test.ts
+69
View File
@@ -41,6 +41,10 @@ import {
DEFAULT_MESSAGE_KEYBOARD_FOCUS_CONFIG,
type MessageKeyboardFocusConfig,
} from '@fluxer/schema/src/domains/experiment/MessageKeyboardFocusSchemas';
import {
DEFAULT_TYPING_INDICATOR_REWORK_CONFIG,
type TypingIndicatorReworkConfig,
} from '@fluxer/schema/src/domains/experiment/TypingIndicatorReworkSchemas';
import {afterEach, describe, expect, it, vi} from 'vitest';
const VOICE_NOISE_SUPPRESSION_CONFIG_KEY = 'voice_noise_suppression_config';
@@ -50,6 +54,7 @@ const BLOCKED_MESSAGE_GROUPS_CONFIG_KEY = 'blocked_message_groups_config';
const GUILD_ACTIVITY_LOG_PRESENTATION_CONFIG_KEY = 'guild_activity_log_presentation_config';
const EXPRESSION_INFO_CARD_CONFIG_KEY = 'expression_info_card_config';
const GUILD_HEADER_COLLAPSE_CONFIG_KEY = 'guild_header_collapse_config';
const TYPING_INDICATOR_REWORK_CONFIG_KEY = 'typing_indicator_rework_config';
const EXPERIMENT_DELIVERY_CONFIG_KEY = 'experiment_delivery_config';
const APP_PUBLIC_CONFIG_KEY = 'app_public_config';
const INSTANCE_POLICY_CONFIG_KEY = 'instance_policy_config';
@@ -635,6 +640,70 @@ describe('InstanceConfigRepository', () => {
});
});
it('returns the default typing indicator rework config when the key is absent', async () => {
const executor = new CountingInMemoryCassandraQueryExecutor();
setCassandraQueryExecutorForTesting(executor);
const kvProvider = new MockKVProvider();
const repository = createRepository(kvProvider);
await expect(repository.getTypingIndicatorReworkConfig()).resolves.toEqual(DEFAULT_TYPING_INDICATOR_REWORK_CONFIG);
});
it.each([
{name: 'unparseable text', stored: 'not-json'},
{name: 'a json array', stored: '[]'},
{name: 'out-of-range values', stored: '{"rollout_basis_points":99999}'},
{name: 'a target that is not a snowflake', stored: '{"included_user_ids":["nope"]}'},
])('falls back to the default typing indicator rework config for $name', async ({stored}) => {
const executor = new CountingInMemoryCassandraQueryExecutor();
setCassandraQueryExecutorForTesting(executor);
const kvProvider = new MockKVProvider();
const repository = createRepository(kvProvider);
await repository.setConfig(TYPING_INDICATOR_REWORK_CONFIG_KEY, stored);
await expect(repository.getTypingIndicatorReworkConfig()).resolves.toEqual(DEFAULT_TYPING_INDICATOR_REWORK_CONFIG);
});
it('round-trips a stored typing indicator rework config', async () => {
const executor = new CountingInMemoryCassandraQueryExecutor();
setCassandraQueryExecutorForTesting(executor);
const kvProvider = new MockKVProvider();
const repository = createRepository(kvProvider);
const config: TypingIndicatorReworkConfig = {
...DEFAULT_TYPING_INDICATOR_REWORK_CONFIG,
enabled: true,
config_version: 5,
rollout_basis_points: 1500,
rollout_salt: 'typing-indicator-rework-v2',
included_user_ids: ['1400000000000000001'],
excluded_user_ids: ['1400000000000000002'],
};
await repository.setTypingIndicatorReworkConfig(config);
await expect(repository.getTypingIndicatorReworkConfig()).resolves.toEqual(config);
});
it('fills newly added typing indicator rework fields from the schema defaults', async () => {
const executor = new CountingInMemoryCassandraQueryExecutor();
setCassandraQueryExecutorForTesting(executor);
const kvProvider = new MockKVProvider();
const repository = createRepository(kvProvider);
await repository.setConfig(
TYPING_INDICATOR_REWORK_CONFIG_KEY,
JSON.stringify({enabled: true, config_version: 2, rollout_basis_points: 1000}),
);
await expect(repository.getTypingIndicatorReworkConfig()).resolves.toEqual({
...DEFAULT_TYPING_INDICATOR_REWORK_CONFIG,
enabled: true,
config_version: 2,
rollout_basis_points: 1000,
});
});
it('fills newly added voice noise suppression fields from the schema defaults', async () => {
const executor = new CountingInMemoryCassandraQueryExecutor();
setCassandraQueryExecutorForTesting(executor);
fluxer_api/src/api/instance/InstanceConfigRepository.ts
+21
View File
@@ -60,6 +60,10 @@ import {
type MessageKeyboardFocusConfig,
MessageKeyboardFocusConfigSchema,
} from '@fluxer/schema/src/domains/experiment/MessageKeyboardFocusSchemas';
import {
type TypingIndicatorReworkConfig,
TypingIndicatorReworkConfigSchema,
} from '@fluxer/schema/src/domains/experiment/TypingIndicatorReworkSchemas';
import {
type InstanceAppPublic,
InstanceAppPublicSchema,
@@ -85,6 +89,7 @@ const MESSAGE_KEYBOARD_FOCUS_CONFIG_KEY = 'message_keyboard_focus_config';
const BLOCKED_MESSAGE_GROUPS_CONFIG_KEY = 'blocked_message_groups_config';
const EXPRESSION_INFO_CARD_CONFIG_KEY = 'expression_info_card_config';
const GUILD_HEADER_COLLAPSE_CONFIG_KEY = 'guild_header_collapse_config';
const TYPING_INDICATOR_REWORK_CONFIG_KEY = 'typing_indicator_rework_config';
const REGISTRATION_CONFIG_KEY = 'registration_config';
const REGISTRATION_URLS_KEY = 'registration_urls';
const REGISTRATION_PENDING_APPROVALS_KEY = 'registration_pending_approvals';
@@ -374,6 +379,7 @@ type StoredConfigSection =
| 'blocked message groups'
| 'expression info card'
| 'guild header collapse'
| 'typing indicator rework'
| 'instance policy'
| 'integrations'
| 'media'
@@ -539,6 +545,10 @@ function parseStoredGuildHeaderCollapseConfig(raw: string | null): GuildHeaderCo
return parseStoredConfigOrDefault(GuildHeaderCollapseConfigSchema, raw, 'guild header collapse');
}
function parseStoredTypingIndicatorReworkConfig(raw: string | null): TypingIndicatorReworkConfig {
return parseStoredConfigOrDefault(TypingIndicatorReworkConfigSchema, raw, 'typing indicator rework');
}
function validateStoredCollection<T>(schema: z.ZodType<T>, value: unknown, section: StoredConfigSection): Array<T> {
if (!Array.isArray(value)) {
throw new Error(`Stored ${section} configuration must be an array`);
@@ -1064,6 +1074,7 @@ export class InstanceConfigRepository {
parseStoredBlockedMessageGroupsConfig(snapshot.get(BLOCKED_MESSAGE_GROUPS_CONFIG_KEY) ?? null);
parseStoredExpressionInfoCardConfig(snapshot.get(EXPRESSION_INFO_CARD_CONFIG_KEY) ?? null);
parseStoredGuildHeaderCollapseConfig(snapshot.get(GUILD_HEADER_COLLAPSE_CONFIG_KEY) ?? null);
parseStoredTypingIndicatorReworkConfig(snapshot.get(TYPING_INDICATOR_REWORK_CONFIG_KEY) ?? null);
const policy = parseStoredInstancePolicyConfig(snapshot.get(INSTANCE_POLICY_CONFIG_KEY) ?? null);
checkStoredConfig('registration', () =>
parseStoredRegistrationConfig(snapshot.get(REGISTRATION_CONFIG_KEY) ?? null),
@@ -1213,6 +1224,16 @@ export class InstanceConfigRepository {
await this.setConfig(GUILD_HEADER_COLLAPSE_CONFIG_KEY, JSON.stringify(validated));
}
async getTypingIndicatorReworkConfig(): Promise<TypingIndicatorReworkConfig> {
const raw = await this.getConfig(TYPING_INDICATOR_REWORK_CONFIG_KEY);
return parseStoredTypingIndicatorReworkConfig(raw);
}
async setTypingIndicatorReworkConfig(config: TypingIndicatorReworkConfig): Promise<void> {
const validated = validateStoredConfig(TypingIndicatorReworkConfigSchema, config, 'typing indicator rework');
await this.setConfig(TYPING_INDICATOR_REWORK_CONFIG_KEY, JSON.stringify(validated));
}
async setExperimentDeliveryConfig(config: ExperimentDeliveryConfig): Promise<void> {
const validated = validateStoredConfig(ExperimentDeliveryConfigSchema, config, 'experiment delivery');
await this.setConfig(EXPERIMENT_DELIVERY_CONFIG_KEY, JSON.stringify(validated));
fluxer_api/src/api/openapi/openapi.json
+13 -1
View File
@@ -28320,7 +28320,8 @@
"$ref": "#/components/schemas/GuildActivityLogPresentationAssignmentResponse"
},
"expression_info_card": {"$ref": "#/components/schemas/ExpressionInfoCardAssignmentResponse"},
"guild_header_collapse": {"$ref": "#/components/schemas/GuildHeaderCollapseAssignmentResponse"}
"guild_header_collapse": {"$ref": "#/components/schemas/GuildHeaderCollapseAssignmentResponse"},
"typing_indicator_rework": {"$ref": "#/components/schemas/TypingIndicatorReworkAssignmentResponse"}
},
"additionalProperties": false
}
@@ -32075,6 +32076,17 @@
"additionalProperties": false,
"description": "Public presentation of the source guild of an expression"
},
"TypingIndicatorReworkAssignmentResponse": {
"type": "object",
"properties": {
"enabled": {"type": "boolean"},
"config_version": {"type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991},
"user_targeted": {"type": "boolean"},
"source": {"anyOf": [{"type": "string", "enum": ["user_rule", "canary"]}, {"type": "null"}]}
},
"required": ["enabled", "config_version", "user_targeted", "source"],
"additionalProperties": false
},
"GuildHeaderCollapseAssignmentResponse": {
"type": "object",
"properties": {