Convert SyncProvider to class

packages/core-data/src/sync.ts

@@ -2,8 +2,7 @@
  * WordPress dependencies
  */
 import { applyFilters } from '@wordpress/hooks';
-import { getWebRTCSyncProvider } from '@wordpress/sync';
-import type { SyncProvider } from '@wordpress/sync';
+import { getWebRTCSyncProvider, SyncProvider } from '@wordpress/sync';
 
 declare global {
 	interface Window {
@@ -26,13 +25,7 @@ export function getSyncProvider(): SyncProvider {
 		return syncProvider;
 	}
 
-	const fallbackNoOpSyncProvider: SyncProvider = {
-		__fallback: true,
-		bootstrap: async () => {},
-		configs: new Map(),
-		discard: async () => {},
-		update: () => {},
-	};
+	const fallbackNoOpSyncProvider = new SyncProvider( null, null );
 
 	syncProvider = applyFilters(
 		'core.getSyncProvider',

packages/sync/src/index.ts

@@ -7,13 +7,12 @@
  */
 import { connectIndexDb } from './connect-indexdb';
 import { createWebRTCConnection } from './create-webrtc-connection';
-import { createSyncProvider } from './provider';
-import type { SyncProvider } from './types';
+import { SyncProvider } from './provider';
 
 export * as Y from 'yjs';
 export { connectIndexDb } from './connect-indexdb';
 export { createWebRTCConnection } from './create-webrtc-connection';
-export { createSyncProvider } from './provider';
+export { SyncProvider } from './provider';
 export * from './types';
 
 declare global {
@@ -35,7 +34,7 @@ declare global {
  * @return {SyncProvider} The WebRTC sync provider.
  */
 export function getWebRTCSyncProvider(): SyncProvider {
-	return createSyncProvider(
+	return new SyncProvider(
 		connectIndexDb,
 		createWebRTCConnection( {
 			password: window?.__experimentalCollaborativeEditingSecret,

packages/sync/src/provider.ts

@@ -1,7 +1,3 @@
-/**
- * WordPress dependencies
- */
-
 /**
  * External dependencies
  */
@@ -13,56 +9,64 @@ import * as Y from 'yjs';
 import type {
 	ConnectDoc,
 	ConnectDocResult,
+	CRDTDoc,
 	ObjectID,
 	ObjectData,
 	ObjectType,
 	SyncConfig,
-	SyncProvider,
 } from './types';
 
 interface EntityState {
 	destroy: () => void;
-	ydoc: Y.Doc;
+	ydoc: CRDTDoc;
 }
 
-/**
- * Create a sync provider.
- *
- * @param {ConnectDoc | null} connectLocal  Connect the document to a local database.
- * @param {ConnectDoc | null} connectRemote Connect the document to a remote sync connection.
- * @return {SyncProvider} Sync provider.
- */
-export const createSyncProvider = (
-	connectLocal: ConnectDoc | null,
-	connectRemote: ConnectDoc | null
-): SyncProvider => {
-	const configs: Map< ObjectType, SyncConfig > = new Map<
+export class SyncProvider {
+	protected connectLocal: ConnectDoc | null;
+	protected connectRemote: ConnectDoc | null;
+
+	protected configs: Map< ObjectType, SyncConfig > = new Map<
 		ObjectType,
 		SyncConfig
 	>();
-	const entityStates: Map< string, EntityState > = new Map<
+
+	protected entityStates: Map< string, EntityState > = new Map<
 		string,
 		EntityState
 	>();
 
+	/**
+	 * Constructor.
+	 *
+	 * @param {ConnectDoc | null} connectLocal  Connect the document to a local database.
+	 * @param {ConnectDoc | null} connectRemote Connect the document to a remote sync connection.
+	 */
+	public constructor(
+		connectLocal: ConnectDoc | null,
+		connectRemote: ConnectDoc | null
+	) {
+		this.connectLocal = connectLocal;
+		this.connectRemote = connectRemote;
+	}
+
 	/**
 	 * Fetch data from local database or remote source.
 	 *
 	 * @param {SyncConfig} syncConfig    Sync configuration for the object type.
 	 * @param {ObjectData} initialData   Initial data to apply to the document.
 	 * @param {Function}   handleChanges Callback to call when data changes.
 	 */
-	async function bootstrap(
+	public async bootstrap(
 		syncConfig: SyncConfig,
 		initialData: ObjectData,
 		handleChanges: ( data: Partial< ObjectData > ) => void
 	): Promise< void > {
 		const ydoc = new Y.Doc( { meta: new Map() } );
 		const objectId = syncConfig.getObjectId( initialData );
 		const objectType = syncConfig.objectType;
-		const entityId = `${ objectType }_${ objectId }`;
+		const entityId = this.getEntityId( objectType, objectId );
 
-		configs.set( objectType, syncConfig );
+		this.configs.set( objectType, syncConfig );
 
 		const updateHandler: ( _update: Uint8Array, origin: string ) => void = (
 			_update,
@@ -77,9 +81,10 @@ export const createSyncProvider = (
 		ydoc.on( 'update', updateHandler );
 
 		const connectLocalResult: ConnectDocResult | null =
-			( await connectLocal?.( objectId, objectType, ydoc ) ) ?? null;
+			( await this.connectLocal?.( objectId, objectType, ydoc ) ) ?? null;
 		const connectRemoteResult =
-			( await connectRemote?.( objectId, objectType, ydoc ) ) ?? null;
+			( await this.connectRemote?.( objectId, objectType, ydoc ) ) ??
+			null;
 
 		const entityState: EntityState = {
 			destroy: () => {
@@ -88,14 +93,43 @@ export const createSyncProvider = (
 
 				ydoc.off( 'update', updateHandler );
 				ydoc.destroy();
-				entityStates.delete( entityId );
+				this.entityStates.delete( entityId );
 			},
 			ydoc,
 		};
 
-		entityStates.set( entityId, entityState );
+		this.entityStates.set( entityId, entityState );
 
-		update( objectType, initialData, initialData, 'gutenberg' );
+		this.update( objectType, initialData, initialData, 'gutenberg' );
+	}
+
+	/**
+	 * Get the entity ID for the given object type and object ID.
+	 *
+	 * @param {ObjectType} objectType Object type.
+	 * @param {ObjectID}   objectId   Object ID.
+	 */
+	protected getEntityId(
+		objectType: ObjectType,
+		objectId: ObjectID
+	): string {
+		return `${ objectType }_${ objectId }`;
+	}
+
+	/**
+	 * Get the entity state for the given object type and object ID.
+	 *
+	 * @param {ObjectType} objectType Object type.
+	 * @param {ObjectID}   objectId   Object ID.
+	 */
+	protected getEntityState(
+		objectType: ObjectType,
+		objectId: ObjectID
+	): EntityState | null {
+		return (
+			this.entityStates.get( this.getEntityId( objectType, objectId ) ) ??
+			null
+		);
 	}
 
 	/**
@@ -106,24 +140,22 @@ export const createSyncProvider = (
 	 * @param {Partial< ObjectData >} changes    Updates to make.
 	 * @param {string}                origin     The source of change.
 	 */
-	function update(
+	public update(
 		objectType: ObjectType,
 		record: ObjectData,
 		changes: Partial< ObjectData >,
 		origin: string
-	) {
-		const objectId = configs.get( objectType )?.getObjectId( record );
-		const entityId = `${ objectType }_${ objectId }`;
-		const entityState = entityStates.get( entityId );
+	): void {
+		const objectId = this.configs.get( objectType )?.getObjectId( record );
 
-		if ( ! entityState ) {
-			throw new Error(
-				`Entity ${ objectType }:${ objectId } not found `
-			);
+		if ( ! objectId ) {
+			return;
 		}
 
-		entityState.ydoc.transact( () => {
-			configs
+		const entityState = this.getEntityState( objectType, objectId );
+
+		entityState?.ydoc.transact( () => {
+			this.configs
 				.get( objectType )
 				?.applyChangesToDoc( entityState.ydoc, changes );
 		}, origin );
@@ -132,20 +164,13 @@ export const createSyncProvider = (
 	/**
 	 * Stop updating a document and discard it.
 	 *
-	 * @param {ObjectType} objectType Object type to load.
-	 * @param {ObjectID}   objectId   Object ID to load.
+	 * @param {ObjectType} objectType Object type to discard.
+	 * @param {ObjectID}   objectId   Object ID to discard.
 	 */
-	function discard( objectType: ObjectType, objectId: ObjectID ) {
+	public discard( objectType: ObjectType, objectId: ObjectID ): void {
 		const entityId = `${ objectType }_${ objectId }`;
 
-		entityStates.get( entityId )?.destroy();
-		entityStates.delete( entityId );
+		this.getEntityState( objectType, objectId )?.destroy();
+		this.entityStates.delete( entityId );
 	}
-
-	return {
-		bootstrap,
-		configs,
-		discard,
-		update,
-	};
-};
+}

packages/sync/src/types.ts

@@ -27,20 +27,3 @@ export type SyncConfig = {
 	getObjectId: ( data: ObjectData ) => ObjectID;
 	objectType: ObjectType;
 };
-
-export type SyncProvider = {
-	__fallback?: boolean;
-	bootstrap: (
-		syncConfig: SyncConfig,
-		initialData: ObjectData,
-		handleChanges: ( data: Partial< ObjectData > ) => void
-	) => Promise< void >;
-	configs: Map< ObjectType, SyncConfig >;
-	discard: ( type: ObjectType, id: ObjectID ) => void;
-	update: (
-		type: ObjectType,
-		record: ObjectData,
-		changes: Partial< ObjectData >,
-		origin: string
-	) => void;
-};