signal-desktop/ts/RemoteConfig.ts

126 lines
3.6 KiB
TypeScript
Raw Normal View History

2022-01-12 17:35:47 +00:00
// Copyright 2020-2022 Signal Messenger, LLC
2020-10-30 20:34:04 +00:00
// SPDX-License-Identifier: AGPL-3.0-only
2020-05-27 21:37:06 +00:00
import { get, throttle } from 'lodash';
import type { WebAPIType } from './textsecure/WebAPI';
import * as log from './logging/log';
2020-05-27 21:37:06 +00:00
2021-03-03 20:09:58 +00:00
export type ConfigKeyType =
| 'desktop.announcementGroup'
| 'desktop.clientExpiration'
| 'desktop.groupCallOutboundRing'
| 'desktop.internalUser'
| 'desktop.mandatoryProfileSharing'
2021-06-25 16:08:16 +00:00
| 'desktop.mediaQuality.levels'
| 'desktop.messageCleanup'
| 'desktop.messageRequests'
2021-06-08 21:51:58 +00:00
| 'desktop.retryReceiptLifespan'
| 'desktop.retryRespondMaxAge'
| 'desktop.senderKey.retry'
| 'desktop.senderKey.send'
| 'desktop.senderKeyMaxAge'
| 'desktop.sendSenderKey3'
| 'desktop.showUserBadges.beta'
| 'desktop.showUserBadges2'
| 'desktop.usernames'
| 'global.calling.maxGroupCallRingSize'
| 'global.groupsv2.groupSizeHardLimit'
| 'global.groupsv2.maxGroupSize';
2020-05-27 21:37:06 +00:00
type ConfigValueType = {
name: ConfigKeyType;
enabled: boolean;
enabledAt?: number;
value?: unknown;
2020-05-27 21:37:06 +00:00
};
export type ConfigMapType = {
[key in ConfigKeyType]?: ConfigValueType;
};
2020-05-27 21:37:06 +00:00
type ConfigListenerType = (value: ConfigValueType) => unknown;
type ConfigListenersMapType = {
[key: string]: Array<ConfigListenerType>;
};
let config: ConfigMapType = {};
const listeners: ConfigListenersMapType = {};
export async function initRemoteConfig(server: WebAPIType): Promise<void> {
2020-05-27 21:37:06 +00:00
config = window.storage.get('remoteConfig') || {};
await maybeRefreshRemoteConfig(server);
2020-05-27 21:37:06 +00:00
}
2020-09-11 19:37:01 +00:00
export function onChange(
key: ConfigKeyType,
fn: ConfigListenerType
): () => void {
2020-05-27 21:37:06 +00:00
const keyListeners: Array<ConfigListenerType> = get(listeners, key, []);
keyListeners.push(fn);
listeners[key] = keyListeners;
return () => {
listeners[key] = listeners[key].filter(l => l !== fn);
};
}
export const refreshRemoteConfig = async (
server: WebAPIType
): Promise<void> => {
2020-05-27 21:37:06 +00:00
const now = Date.now();
const newConfig = await server.getConfig();
// Process new configuration in light of the old configuration
// The old configuration is not set as the initial value in reduce because
// flags may have been deleted
const oldConfig = config;
config = newConfig.reduce((acc, { name, enabled, value }) => {
2020-05-27 21:37:06 +00:00
const previouslyEnabled: boolean = get(oldConfig, [name, 'enabled'], false);
const previousValue: unknown = get(oldConfig, [name, 'value'], undefined);
2020-09-11 19:37:01 +00:00
// If a flag was previously not enabled and is now enabled,
// record the time it was enabled
2020-05-27 21:37:06 +00:00
const enabledAt: number | undefined =
previouslyEnabled && enabled ? now : get(oldConfig, [name, 'enabledAt']);
const configValue = {
2020-05-27 21:37:06 +00:00
name: name as ConfigKeyType,
enabled,
enabledAt,
value,
2020-05-27 21:37:06 +00:00
};
const hasChanged =
previouslyEnabled !== enabled || previousValue !== configValue.value;
2020-05-27 21:37:06 +00:00
// If enablement changes at all, notify listeners
const currentListeners = listeners[name] || [];
if (hasChanged) {
log.info(`Remote Config: Flag ${name} has changed`);
2020-05-27 21:37:06 +00:00
currentListeners.forEach(listener => {
listener(configValue);
2020-05-27 21:37:06 +00:00
});
}
// Return new configuration object
return {
...acc,
[name]: configValue,
2020-05-27 21:37:06 +00:00
};
}, {});
window.storage.put('remoteConfig', config);
};
export const maybeRefreshRemoteConfig = throttle(
refreshRemoteConfig,
// Only fetch remote configuration if the last fetch was more than two hours ago
2 * 60 * 60 * 1000,
{ trailing: false }
);
export function isEnabled(name: ConfigKeyType): boolean {
return get(config, [name, 'enabled'], false);
}
export function getValue(name: ConfigKeyType): string | undefined {
return get(config, [name, 'value'], undefined);
}