fix: move resync option back to base class

Parkreiner · Parkreiner · commit 60b222089f2d · 2025-05-07T15:16:21.000Z
diff --git a/site/src/hooks/useTimeSync.tsx b/site/src/hooks/useTimeSync.tsx
@@ -2,9 +2,8 @@
  * @todo Things that still need to be done before this can be called done:
  *
  * 1. Fill out all incomplete methods
- * 2. Make sure the class respects the resyncOnNewSubscription option
- * 3. Add tests
- * 4. See if there's a way to make sure that if you provide a type parameter to
+ * 2. Add tests
+ * 3. See if there's a way to make sure that if you provide a type parameter to
  *    the hook, you must also provide a select function
  */
 import {
@@ -40,21 +39,6 @@ type ReactTimeSyncSubscriptionEntry = Readonly<
 	}
 >;
 
-type ReactTimeSyncInitOptions = Readonly<
-	TimeSyncInitOptions & {
-		/**
-		 * Configures whether adding a new subscription will immediately create
-		 * a new time snapshot and use it to update all other subscriptions.
-		 */
-		resyncOnNewSubscription: boolean;
-	}
->;
-
-const defaultReactTimeSyncOptions: ReactTimeSyncInitOptions = {
-	...defaultOptions,
-	resyncOnNewSubscription: true,
-};
-
 interface ReactTimeSyncApi {
 	subscribe: (entry: ReactTimeSyncSubscriptionEntry) => () => void;
 	getSelectionSnapshot: <T = unknown>(id: string) => T;
@@ -65,9 +49,9 @@ class ReactTimeSync implements ReactTimeSyncApi {
 	readonly #resyncOnNewSubscription: boolean;
 	readonly #selectionCache: Map<string, unknown>;
 
-	constructor(options: Partial<ReactTimeSyncInitOptions>) {
+	constructor(options: Partial<TimeSyncInitOptions>) {
 		const {
-			resyncOnNewSubscription = defaultReactTimeSyncOptions.resyncOnNewSubscription,
+			resyncOnNewSubscription = defaultOptions.resyncOnNewSubscription,
 			initialDatetime = defaultOptions.initialDatetime,
 			createNewDatetime = defaultOptions.createNewDatetime,
 			setInterval = defaultOptions.setInterval,
@@ -101,7 +85,7 @@ const timeSyncContext = createContext<ReactTimeSync | null>(null);
 
 type TimeSyncProviderProps = Readonly<
 	PropsWithChildren<{
-		options?: Partial<ReactTimeSyncInitOptions>;
+		options?: Partial<TimeSyncInitOptions>;
 	}>
 >;
 
@@ -122,7 +106,7 @@ export const TimeSyncProvider: FC<TimeSyncProviderProps> = ({
 	// be treated like a pseudo-ref value, where its values can only be used in
 	// very specific, React-approved ways
 	const [readonlySync] = useState(
-		() => new ReactTimeSync(options ?? defaultReactTimeSyncOptions),
+		() => new ReactTimeSync(options ?? defaultOptions),
 	);
 
 	return (
diff --git a/site/src/utils/TimeSync.ts b/site/src/utils/TimeSync.ts
@@ -1,7 +1,8 @@
 /**
  * @todo What's left to do here:
  * 1. Fill out all incomplete methods
- * 2. Add tests
+ * 2. Make sure the class respects the resyncOnNewSubscription option
+ * 3. Add tests
  */
 export const IDEAL_REFRESH_ONE_SECOND = 1_000;
 export const IDEAL_REFRESH_ONE_MINUTE = 60 * 1_000;
@@ -35,10 +36,17 @@ export type TimeSyncInitOptions = Readonly<{
 	 * new interval to increase/decrease its update speed.)
 	 */
 	clearInterval: ClearInterval;
+
+	/**
+	 * Configures whether adding a new subscription will immediately create
+	 * a new time snapshot and use it to update all other subscriptions.
+	 */
+	resyncOnNewSubscription: boolean;
 }>;
 
 export const defaultOptions: TimeSyncInitOptions = {
 	initialDatetime: new Date(),
+	resyncOnNewSubscription: true,
 	createNewDatetime: () => new Date(),
 	setInterval: window.setInterval,
 	clearInterval: window.clearInterval,
@@ -83,6 +91,7 @@ interface TimeSyncApi {
  * composing your components to minimize the costs of re-renders.
  */
 export class TimeSync implements TimeSyncApi {
+	readonly #resyncOnNewSubscription: boolean;
 	readonly #createNewDatetime: (prev: Date) => Date;
 	readonly #setInterval: SetInterval;
 	readonly #clearInterval: ClearInterval;
@@ -94,6 +103,7 @@ export class TimeSync implements TimeSyncApi {
 	constructor(options: Partial<TimeSyncInitOptions>) {
 		const {
 			initialDatetime = defaultOptions.initialDatetime,
+			resyncOnNewSubscription = defaultOptions.resyncOnNewSubscription,
 			createNewDatetime = defaultOptions.createNewDatetime,
 			setInterval = defaultOptions.setInterval,
 			clearInterval = defaultOptions.clearInterval,
@@ -102,6 +112,7 @@ export class TimeSync implements TimeSyncApi {
 		this.#setInterval = setInterval;
 		this.#clearInterval = clearInterval;
 		this.#createNewDatetime = createNewDatetime;
+		this.#resyncOnNewSubscription = resyncOnNewSubscription;
 
 		this.#latestDateSnapshot = initialDatetime;
 		this.#subscriptions = [];
