mirror of
https://github.com/fluxerapp/fluxer
synced 2026-10-07 19:22:14 +09:00
feat(premium): add the Plutonium page behind an experiment (#3097)
This commit is contained in:
Hampus
@@ -24,6 +24,10 @@ import {
|
||||
InstanceBillingResponse,
|
||||
InstanceBillingUpdateRequest,
|
||||
} from '@fluxer/schema/src/domains/admin/InstanceBillingSchemas';
|
||||
import {
|
||||
PlutoniumPageConfigResponse,
|
||||
PlutoniumPageConfigUpdateRequest,
|
||||
} from '@fluxer/schema/src/domains/admin/PlutoniumPageSchemas';
|
||||
import {PushRelayConfigResponse, PushRelayConfigUpdateRequest} from '@fluxer/schema/src/domains/admin/PushRelaySchemas';
|
||||
import {
|
||||
ExperimentDeliveryConfigResponse,
|
||||
@@ -638,6 +642,7 @@ export const InstanceConfigResponse = z.object({
|
||||
gateway_rollout: GatewayRolloutConfigResponse,
|
||||
push_relay: PushRelayConfigResponse,
|
||||
domain_migration: DomainMigrationConfigResponse,
|
||||
plutonium_page: PlutoniumPageConfigResponse,
|
||||
captcha: CaptchaConfigResponse,
|
||||
experiment_delivery: ExperimentDeliveryConfigResponse,
|
||||
registration: InstanceRegistrationResponse,
|
||||
@@ -671,6 +676,7 @@ export const InstanceConfigUpdateRequest = z.object({
|
||||
gateway_rollout: GatewayRolloutConfigUpdateRequest.nullish(),
|
||||
push_relay: PushRelayConfigUpdateRequest.nullish(),
|
||||
domain_migration: DomainMigrationConfigUpdateRequest.nullish(),
|
||||
plutonium_page: PlutoniumPageConfigUpdateRequest.nullish(),
|
||||
captcha: CaptchaConfigUpdateRequest.nullish(),
|
||||
experiment_delivery: ExperimentDeliveryConfigUpdateRequest.nullish(),
|
||||
registration: z
|
||||
|
||||
@@ -0,0 +1,123 @@
|
||||
// SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
|
||||
import {
|
||||
DEFAULT_PLUTONIUM_PAGE_CONFIG,
|
||||
type PlutoniumPageConfig,
|
||||
PlutoniumPageConfigSchema,
|
||||
PlutoniumPageConfigUpdateRequest,
|
||||
resolvePlutoniumPageAssignment,
|
||||
} from '@fluxer/schema/src/domains/admin/PlutoniumPageSchemas';
|
||||
import {type ExperimentTargeting, experimentBucket} from '@fluxer/schema/src/domains/experiment/ExperimentBucket';
|
||||
import {describe, expect, test} from 'vitest';
|
||||
|
||||
const NO_TARGETING: ExperimentTargeting = {memberGuildIds: new Set(), premium: false};
|
||||
|
||||
const TARGETED_USER_ID = '1000000000000000001';
|
||||
|
||||
function createConfig(overrides: Partial<PlutoniumPageConfig> = {}): PlutoniumPageConfig {
|
||||
return {...DEFAULT_PLUTONIUM_PAGE_CONFIG, included_user_ids: [], excluded_user_ids: [], ...overrides};
|
||||
}
|
||||
|
||||
function syntheticUserIds(count: number): Array<string> {
|
||||
return Array.from({length: count}, (_, index) => (1400000000000000000n + BigInt(index)).toString());
|
||||
}
|
||||
|
||||
describe('plutonium page configuration', () => {
|
||||
test('defaults to disabled', () => {
|
||||
expect(PlutoniumPageConfigSchema.parse({})).toEqual({
|
||||
enabled: false,
|
||||
config_version: 0,
|
||||
rollout_basis_points: 0,
|
||||
rollout_salt: 'plutonium-page-v1',
|
||||
included_user_ids: [],
|
||||
excluded_user_ids: [],
|
||||
included_guild_ids: [],
|
||||
include_premium_users: false,
|
||||
});
|
||||
});
|
||||
|
||||
test('strips config_version from admin updates', () => {
|
||||
expect(PlutoniumPageConfigUpdateRequest.safeParse({config_version: 3}).data).toEqual({});
|
||||
expect(PlutoniumPageConfigUpdateRequest.safeParse({rollout_basis_points: 10001}).success).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
describe('resolvePlutoniumPageAssignment', () => {
|
||||
test('serves nobody while disabled, even included users', () => {
|
||||
const config = createConfig({rollout_basis_points: 10000, included_user_ids: [TARGETED_USER_ID]});
|
||||
expect(resolvePlutoniumPageAssignment(config, TARGETED_USER_ID, NO_TARGETING)).toEqual({enabled: false});
|
||||
});
|
||||
|
||||
test('applies exclusions before inclusions', () => {
|
||||
const config = createConfig({
|
||||
enabled: true,
|
||||
included_user_ids: [TARGETED_USER_ID],
|
||||
excluded_user_ids: [TARGETED_USER_ID],
|
||||
});
|
||||
expect(resolvePlutoniumPageAssignment(config, TARGETED_USER_ID, NO_TARGETING)).toEqual({enabled: false});
|
||||
});
|
||||
|
||||
test('serves included users at zero rollout', () => {
|
||||
const config = createConfig({enabled: true, included_user_ids: [TARGETED_USER_ID]});
|
||||
expect(resolvePlutoniumPageAssignment(config, TARGETED_USER_ID, NO_TARGETING)).toEqual({enabled: true});
|
||||
});
|
||||
|
||||
test('buckets the rollout by salt and user id', () => {
|
||||
const config = createConfig({enabled: true, rollout_basis_points: 2500});
|
||||
for (const userId of syntheticUserIds(200)) {
|
||||
expect(resolvePlutoniumPageAssignment(config, userId, NO_TARGETING).enabled).toBe(
|
||||
experimentBucket(userId, config.rollout_salt) < 2500,
|
||||
);
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
describe('resolvePlutoniumPageAssignment guild targeting', () => {
|
||||
const INCLUDED_GUILD_ID = '3000000000000000001';
|
||||
const MEMBER_GUILDS: ExperimentTargeting = {
|
||||
memberGuildIds: new Set(['3000000000000000009', INCLUDED_GUILD_ID]),
|
||||
premium: false,
|
||||
};
|
||||
|
||||
test('serves members of an included guild at zero rollout', () => {
|
||||
const config = createConfig({enabled: true, included_guild_ids: [INCLUDED_GUILD_ID]});
|
||||
expect(resolvePlutoniumPageAssignment(config, TARGETED_USER_ID, MEMBER_GUILDS)).toEqual({enabled: true});
|
||||
expect(resolvePlutoniumPageAssignment(config, TARGETED_USER_ID, NO_TARGETING)).toEqual({enabled: false});
|
||||
});
|
||||
|
||||
test('keeps user exclusions ahead of guild membership', () => {
|
||||
const config = createConfig({
|
||||
enabled: true,
|
||||
included_guild_ids: [INCLUDED_GUILD_ID],
|
||||
excluded_user_ids: [TARGETED_USER_ID],
|
||||
});
|
||||
expect(resolvePlutoniumPageAssignment(config, TARGETED_USER_ID, MEMBER_GUILDS)).toEqual({enabled: false});
|
||||
});
|
||||
|
||||
test('serves no guild members while disabled', () => {
|
||||
const config = createConfig({included_guild_ids: [INCLUDED_GUILD_ID]});
|
||||
expect(resolvePlutoniumPageAssignment(config, TARGETED_USER_ID, MEMBER_GUILDS)).toEqual({enabled: false});
|
||||
});
|
||||
});
|
||||
|
||||
describe('resolvePlutoniumPageAssignment premium targeting', () => {
|
||||
const PREMIUM: ExperimentTargeting = {memberGuildIds: new Set(), premium: true};
|
||||
|
||||
test('serves premium users only when the switch is on', () => {
|
||||
const on = createConfig({enabled: true, include_premium_users: true});
|
||||
expect(resolvePlutoniumPageAssignment(on, TARGETED_USER_ID, PREMIUM)).toEqual({enabled: true});
|
||||
expect(resolvePlutoniumPageAssignment(on, TARGETED_USER_ID, NO_TARGETING)).toEqual({enabled: false});
|
||||
expect(resolvePlutoniumPageAssignment(createConfig({enabled: true}), TARGETED_USER_ID, PREMIUM)).toEqual({
|
||||
enabled: false,
|
||||
});
|
||||
});
|
||||
|
||||
test('keeps user exclusions ahead of the premium switch', () => {
|
||||
const config = createConfig({
|
||||
enabled: true,
|
||||
include_premium_users: true,
|
||||
excluded_user_ids: [TARGETED_USER_ID],
|
||||
});
|
||||
expect(resolvePlutoniumPageAssignment(config, TARGETED_USER_ID, PREMIUM)).toEqual({enabled: false});
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,77 @@
|
||||
// SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
|
||||
import {
|
||||
EXPERIMENT_BUCKET_RESOLUTION,
|
||||
type ExperimentTargeting,
|
||||
experimentAudienceIncludes,
|
||||
experimentBucket,
|
||||
} from '@fluxer/schema/src/domains/experiment/ExperimentBucket';
|
||||
import {z} from 'zod';
|
||||
|
||||
const PLUTONIUM_PAGE_ROLLOUT_BASIS_POINTS_MAX = EXPERIMENT_BUCKET_RESOLUTION;
|
||||
const PLUTONIUM_PAGE_MAX_TARGETED_USERS = 1000;
|
||||
const DEFAULT_PLUTONIUM_PAGE_SALT = 'plutonium-page-v1';
|
||||
|
||||
const PLUTONIUM_PAGE_SALT_PATTERN = /^[\x20-\x7e]+$/u;
|
||||
|
||||
const PlutoniumPageTargetIdSchema = z.string().regex(/^\d{1,20}$/u);
|
||||
const PlutoniumPageTargetedUserIdsSchema = z.array(PlutoniumPageTargetIdSchema).max(PLUTONIUM_PAGE_MAX_TARGETED_USERS);
|
||||
|
||||
const plutoniumPageConfigFields = {
|
||||
enabled: z.boolean(),
|
||||
config_version: z.number().int().min(0),
|
||||
rollout_basis_points: z.number().int().min(0).max(PLUTONIUM_PAGE_ROLLOUT_BASIS_POINTS_MAX),
|
||||
rollout_salt: z.string().trim().min(1).max(64).regex(PLUTONIUM_PAGE_SALT_PATTERN),
|
||||
included_user_ids: PlutoniumPageTargetedUserIdsSchema,
|
||||
included_guild_ids: PlutoniumPageTargetedUserIdsSchema,
|
||||
include_premium_users: z.boolean(),
|
||||
excluded_user_ids: PlutoniumPageTargetedUserIdsSchema,
|
||||
};
|
||||
|
||||
export const PlutoniumPageConfigSchema = z.object({
|
||||
enabled: plutoniumPageConfigFields.enabled.default(false),
|
||||
config_version: plutoniumPageConfigFields.config_version.default(0),
|
||||
rollout_basis_points: plutoniumPageConfigFields.rollout_basis_points.default(0),
|
||||
rollout_salt: plutoniumPageConfigFields.rollout_salt.default(DEFAULT_PLUTONIUM_PAGE_SALT),
|
||||
included_user_ids: plutoniumPageConfigFields.included_user_ids.default([]),
|
||||
included_guild_ids: plutoniumPageConfigFields.included_guild_ids.default([]),
|
||||
include_premium_users: plutoniumPageConfigFields.include_premium_users.default(false),
|
||||
excluded_user_ids: plutoniumPageConfigFields.excluded_user_ids.default([]),
|
||||
});
|
||||
|
||||
export type PlutoniumPageConfig = z.infer<typeof PlutoniumPageConfigSchema>;
|
||||
|
||||
export const DEFAULT_PLUTONIUM_PAGE_CONFIG: PlutoniumPageConfig = PlutoniumPageConfigSchema.parse({});
|
||||
|
||||
export const PlutoniumPageConfigUpdateRequest = z
|
||||
.object(plutoniumPageConfigFields)
|
||||
.omit({config_version: true})
|
||||
.partial();
|
||||
|
||||
export type PlutoniumPageConfigUpdateRequest = z.infer<typeof PlutoniumPageConfigUpdateRequest>;
|
||||
|
||||
export const PlutoniumPageConfigResponse = PlutoniumPageConfigSchema;
|
||||
|
||||
export type PlutoniumPageConfigResponse = z.infer<typeof PlutoniumPageConfigResponse>;
|
||||
|
||||
export const PlutoniumPageAssignmentResponse = z.object({
|
||||
enabled: plutoniumPageConfigFields.enabled,
|
||||
});
|
||||
|
||||
export type PlutoniumPageAssignmentResponse = z.infer<typeof PlutoniumPageAssignmentResponse>;
|
||||
|
||||
export const INERT_PLUTONIUM_PAGE_ASSIGNMENT: PlutoniumPageAssignmentResponse = {
|
||||
enabled: false,
|
||||
};
|
||||
|
||||
export function resolvePlutoniumPageAssignment(
|
||||
config: PlutoniumPageConfig,
|
||||
userId: string,
|
||||
targeting: ExperimentTargeting,
|
||||
): PlutoniumPageAssignmentResponse {
|
||||
if (!config.enabled) return {...INERT_PLUTONIUM_PAGE_ASSIGNMENT};
|
||||
if (config.excluded_user_ids.includes(userId)) return {...INERT_PLUTONIUM_PAGE_ASSIGNMENT};
|
||||
if (config.included_user_ids.includes(userId)) return {enabled: true};
|
||||
if (experimentAudienceIncludes(config, targeting)) return {enabled: true};
|
||||
return {enabled: experimentBucket(userId, config.rollout_salt) < config.rollout_basis_points};
|
||||
}
|
||||
@@ -4,6 +4,10 @@ import {
|
||||
DomainMigrationAssignmentResponse,
|
||||
INERT_DOMAIN_MIGRATION_ASSIGNMENT,
|
||||
} from '@fluxer/schema/src/domains/admin/DomainMigrationSchemas';
|
||||
import {
|
||||
INERT_PLUTONIUM_PAGE_ASSIGNMENT,
|
||||
PlutoniumPageAssignmentResponse,
|
||||
} from '@fluxer/schema/src/domains/admin/PlutoniumPageSchemas';
|
||||
import {z} from 'zod';
|
||||
|
||||
export const EXPERIMENT_MIN_POLL_INTERVAL_SECONDS = 60;
|
||||
@@ -42,6 +46,7 @@ export type ExperimentDeliveryConfigResponse = z.infer<typeof ExperimentDelivery
|
||||
|
||||
const ExperimentAssignmentsSchema = z.object({
|
||||
domain_migration: DomainMigrationAssignmentResponse.optional(),
|
||||
plutonium_page: PlutoniumPageAssignmentResponse.optional(),
|
||||
});
|
||||
|
||||
export const ExperimentAssignmentsResponse = z.object({
|
||||
@@ -63,3 +68,7 @@ export function readDomainMigrationAssignment(
|
||||
): DomainMigrationAssignmentResponse {
|
||||
return response.assignments.domain_migration ?? INERT_DOMAIN_MIGRATION_ASSIGNMENT;
|
||||
}
|
||||
|
||||
export function readPlutoniumPageAssignment(response: ExperimentAssignmentsResponse): PlutoniumPageAssignmentResponse {
|
||||
return response.assignments.plutonium_page ?? INERT_PLUTONIUM_PAGE_ASSIGNMENT;
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user