revite/src/mobx/stores/Experiments.ts

107 lines
2.4 KiB
TypeScript
Raw Normal View History

import { action, computed, makeAutoObservable, ObservableSet } from "mobx";
2021-12-11 14:36:26 +00:00
import Persistent from "../interfaces/Persistent";
2021-12-11 12:08:43 +00:00
/**
* Union type of available experiments.
*/
export type Experiment = "dummy" | "theme_shop";
2021-12-11 12:08:43 +00:00
/**
* Currently active experiments.
*/
2021-12-11 13:23:01 +00:00
export const AVAILABLE_EXPERIMENTS: Experiment[] = ["dummy", "theme_shop"];
2021-12-11 12:08:43 +00:00
/**
* Definitions for experiments listed by {@link Experiment}.
*/
export const EXPERIMENTS: {
[key in Experiment]: { title: string; description: string };
} = {
2021-12-11 12:08:43 +00:00
dummy: {
title: "Dummy Experiment",
description: "This is a dummy experiment.",
},
theme_shop: {
title: "Theme Shop",
description: "Allows you to access and set user submitted themes.",
},
};
interface Data {
enabled?: Experiment[];
}
/**
* Handles enabling and disabling client experiments.
*/
export default class Experiments implements Persistent<Data> {
private enabled: ObservableSet<Experiment>;
/**
* Construct new Experiments store.
*/
constructor() {
this.enabled = new ObservableSet();
makeAutoObservable(this);
}
toJSON() {
return {
enabled: this.enabled,
};
}
@action hydrate(data: Data) {
if (data.enabled) {
for (const experiment of data.enabled) {
this.enabled.add(experiment as Experiment);
}
}
}
/**
* Check if an experiment is enabled.
* @param experiment Experiment
*/
@computed isEnabled(experiment: Experiment) {
return this.enabled.has(experiment);
}
/**
* Enable an experiment.
* @param experiment Experiment
*/
@action enable(experiment: Experiment) {
this.enabled.add(experiment);
}
/**
* Disable an experiment.
* @param experiment Experiment
*/
@action disable(experiment: Experiment) {
this.enabled.delete(experiment);
}
2021-12-11 13:23:01 +00:00
/**
* Set the state of an experiment.
* @param key Experiment
* @param enabled Whether this experiment is enabled.
*/
@computed setEnabled(key: Experiment, enabled: boolean): void {
if (enabled) {
this.enable(key);
} else {
this.disable(key);
}
}
/**
* Reset and disable all experiments.
*/
@action reset() {
this.enabled.clear();
}
}