Blame · heartbeat.ts

b69ab31	1	/**
b69ab31	2	* Copyright (c) Meta Platforms, Inc. and affiliates.
b69ab31	3	*
b69ab31	4	* This source code is licensed under the MIT license found in the
b69ab31	5	* LICENSE file in the root directory of this source tree.
b69ab31	6	*/
b69ab31	7
b69ab31	8	import {useEffect, useState} from 'react';
b69ab31	9	import {randomId} from 'shared/utils';
b69ab31	10	import clientToServerAPI from './ClientToServerAPI';
b69ab31	11
b69ab31	12	export type Heartbeat =
b69ab31	13	\| {
b69ab31	14	type: 'waiting';
b69ab31	15	}
b69ab31	16	\| {
b69ab31	17	type: 'timeout';
b69ab31	18	}
b69ab31	19	\| {
b69ab31	20	type: 'success' \| 'slow';
b69ab31	21	/** Round trip time between sending the heartbeat and getting the response */
b69ab31	22	rtt: number;
b69ab31	23	};
b69ab31	24
b69ab31	25	export const DEFAULT_HEARTBEAT_TIMEOUT_MS = 1500;
b69ab31	26
b69ab31	27	/**
b69ab31	28	* Ping the server
b69ab31	29	*/
b69ab31	30	export function useHeartbeat(timeoutMs = DEFAULT_HEARTBEAT_TIMEOUT_MS) {
b69ab31	31	const [state, setState] = useState<Heartbeat>({type: 'waiting'});
b69ab31	32
b69ab31	33	useEffect(() => {
b69ab31	34	const id = randomId();
b69ab31	35	const start = Date.now();
b69ab31	36	clientToServerAPI.postMessage({type: 'heartbeat', id});
b69ab31	37	clientToServerAPI
b69ab31	38	.nextMessageMatching('heartbeat', message => message.id === id)
b69ab31	39	.then(() => {
b69ab31	40	setState(val => {
b69ab31	41	if (val.type === 'waiting') {
b69ab31	42	return {type: 'success', rtt: Date.now() - start};
b69ab31	43	} else if (val.type === 'timeout') {
b69ab31	44	return {type: 'slow', rtt: Date.now() - start};
b69ab31	45	}
b69ab31	46	return val;
b69ab31	47	});
b69ab31	48	});
b69ab31	49
b69ab31	50	const timeout = setTimeout(() => {
b69ab31	51	setTimeout(() => {
b69ab31	52	setState(val => {
b69ab31	53	if (val.type === 'waiting') {
b69ab31	54	return {type: 'timeout'};
b69ab31	55	}
b69ab31	56	return val;
b69ab31	57	});
b69ab31	58	});
b69ab31	59	}, timeoutMs);
b69ab31	60
b69ab31	61	return () => clearTimeout(timeout);
b69ab31	62	}, [setState, timeoutMs]);
b69ab31	63
b69ab31	64	return state;
b69ab31	65	}