@wordpress/core-data 7.41.2-next.v.202603102151.0 → 7.42.0

package/src/utils/test/crdt.ts

@@ -22,7 +22,22 @@ import {
 import type { YBlock, YBlockRecord, YBlocks } from '../crdt-blocks';
 import { updateSelectionHistory } from '../crdt-selection';
 import { createYMap, getRootMap, type YMapWrap } from '../crdt-utils';
-import type { Post, Type } from '../../entity-types';
+import type { Post } from '../../entity-types';
+
+// Default synced properties matching the base set built in entities.js,
+// plus 'categories' and 'tags' as example taxonomy rest_base values.
+const defaultSyncedProperties = new Set< string >( [
+	'blocks',
+	'categories',
+	'content',
+	'date',
+	'excerpt',
+	'meta',
+	'slug',
+	'status',
+	'tags',
+	'title',
+] );
 
 describe( 'crdt', () => {
 	let doc: Y.Doc;
@@ -37,8 +52,6 @@ describe( 'crdt', () => {
 	} );
 
 	describe( 'applyPostChangesToCRDTDoc', () => {
-		const mockPostType = {} as Type;
-
 		let map: YMapWrap< YPostRecord >;
 
 		beforeEach( () => {
@@ -50,7 +63,7 @@ describe( 'crdt', () => {
 				title: 'New Title',
 			} as PostChanges;
 
-			applyPostChangesToCRDTDoc( doc, changes, mockPostType );
+			applyPostChangesToCRDTDoc( doc, changes, defaultSyncedProperties );
 
 			const title = map.get( 'title' );
 			expect( title ).toBeInstanceOf( Y.Text );
@@ -63,7 +76,7 @@ describe( 'crdt', () => {
 				unsyncedProperty: 'value',
 			} as unknown as PostChanges;
 
-			applyPostChangesToCRDTDoc( doc, changes, mockPostType );
+			applyPostChangesToCRDTDoc( doc, changes, defaultSyncedProperties );
 
 			expect( map.has( 'unsyncedProperty' ) ).toBe( false );
 			expect( map.get( 'title' )?.toString() ).toBe( 'New Title' );
@@ -74,7 +87,7 @@ describe( 'crdt', () => {
 				title: () => 'function value',
 			} as unknown as PostChanges;
 
-			applyPostChangesToCRDTDoc( doc, changes, mockPostType );
+			applyPostChangesToCRDTDoc( doc, changes, defaultSyncedProperties );
 
 			expect( map.has( 'title' ) ).toBe( false );
 		} );
@@ -84,7 +97,7 @@ describe( 'crdt', () => {
 				title: { raw: 'Raw Title', rendered: 'Rendered Title' },
 			};
 
-			applyPostChangesToCRDTDoc( doc, changes, mockPostType );
+			applyPostChangesToCRDTDoc( doc, changes, defaultSyncedProperties );
 
 			const title = map.get( 'title' );
 			expect( title ).toBeInstanceOf( Y.Text );
@@ -96,7 +109,7 @@ describe( 'crdt', () => {
 				title: 'Auto Draft',
 			} as PostChanges;
 
-			applyPostChangesToCRDTDoc( doc, changes, mockPostType );
+			applyPostChangesToCRDTDoc( doc, changes, defaultSyncedProperties );
 
 			const title = map.get( 'title' );
 			expect( title ).toBeInstanceOf( Y.Text );
@@ -108,7 +121,7 @@ describe( 'crdt', () => {
 			applyPostChangesToCRDTDoc(
 				doc,
 				{ title: '' } as PostChanges,
-				mockPostType
+				defaultSyncedProperties
 			);
 
 			const title = map.get( 'title' );
@@ -119,7 +132,7 @@ describe( 'crdt', () => {
 			applyPostChangesToCRDTDoc(
 				doc,
 				{ title: 'Auto Draft' } as PostChanges,
-				mockPostType
+				defaultSyncedProperties
 			);
 
 			expect( map.get( 'title' )?.toString() ).toBe( '' );
@@ -134,7 +147,7 @@ describe( 'crdt', () => {
 				},
 			};
 
-			applyPostChangesToCRDTDoc( doc, changes, mockPostType );
+			applyPostChangesToCRDTDoc( doc, changes, defaultSyncedProperties );
 
 			const excerpt = map.get( 'excerpt' );
 			expect( excerpt ).toBeInstanceOf( Y.Text );
@@ -146,7 +159,7 @@ describe( 'crdt', () => {
 				slug: '',
 			};
 
-			applyPostChangesToCRDTDoc( doc, changes, mockPostType );
+			applyPostChangesToCRDTDoc( doc, changes, defaultSyncedProperties );
 
 			expect( map.has( 'slug' ) ).toBe( false );
 		} );
@@ -156,7 +169,7 @@ describe( 'crdt', () => {
 				slug: 'my-post-slug',
 			};
 
-			applyPostChangesToCRDTDoc( doc, changes, mockPostType );
+			applyPostChangesToCRDTDoc( doc, changes, defaultSyncedProperties );
 
 			expect( map.get( 'slug' ) ).toBe( 'my-post-slug' );
 		} );
@@ -174,7 +187,7 @@ describe( 'crdt', () => {
 				],
 			};
 
-			applyPostChangesToCRDTDoc( doc, changes, mockPostType );
+			applyPostChangesToCRDTDoc( doc, changes, defaultSyncedProperties );
 
 			expect( ( map.get( 'blocks' ) as YBlocks ).toJSON() ).toEqual(
 				changes.blocks
@@ -186,7 +199,7 @@ describe( 'crdt', () => {
 				blocks: [],
 			};
 
-			applyPostChangesToCRDTDoc( doc, changes, mockPostType );
+			applyPostChangesToCRDTDoc( doc, changes, defaultSyncedProperties );
 
 			const blocks = map.get( 'blocks' );
 			expect( blocks ).toBeInstanceOf( Y.Array );
@@ -200,7 +213,7 @@ describe( 'crdt', () => {
 				blocks: undefined,
 			};
 
-			applyPostChangesToCRDTDoc( doc, changes, mockPostType );
+			applyPostChangesToCRDTDoc( doc, changes, defaultSyncedProperties );
 
 			// The key should still exist, but the value should be undefined.
 			expect( map.has( 'blocks' ) ).toBe( true );
@@ -212,7 +225,7 @@ describe( 'crdt', () => {
 				content: 'Hello, world!',
 			} as PostChanges;
 
-			applyPostChangesToCRDTDoc( doc, changes, mockPostType );
+			applyPostChangesToCRDTDoc( doc, changes, defaultSyncedProperties );
 
 			const content = map.get( 'content' );
 			expect( content ).toBeInstanceOf( Y.Text );
@@ -227,7 +240,7 @@ describe( 'crdt', () => {
 				},
 			} as PostChanges;
 
-			applyPostChangesToCRDTDoc( doc, changes, mockPostType );
+			applyPostChangesToCRDTDoc( doc, changes, defaultSyncedProperties );
 
 			const content = map.get( 'content' );
 			expect( content ).toBeInstanceOf( Y.Text );
@@ -241,7 +254,7 @@ describe( 'crdt', () => {
 			applyPostChangesToCRDTDoc(
 				doc,
 				{ title: 'Old Title' } as PostChanges,
-				mockPostType
+				defaultSyncedProperties
 			);
 			const titleRef = map.get( 'title' );
 
@@ -249,7 +262,7 @@ describe( 'crdt', () => {
 			applyPostChangesToCRDTDoc(
 				doc,
 				{ title: 'New Title' } as PostChanges,
-				mockPostType
+				defaultSyncedProperties
 			);
 
 			expect( map.get( 'title' ) ).toBe( titleRef );
@@ -261,7 +274,7 @@ describe( 'crdt', () => {
 			applyPostChangesToCRDTDoc(
 				doc,
 				{ content: 'Old content' } as PostChanges,
-				mockPostType
+				defaultSyncedProperties
 			);
 			const contentRef = map.get( 'content' );
 
@@ -269,7 +282,7 @@ describe( 'crdt', () => {
 			applyPostChangesToCRDTDoc(
 				doc,
 				{ content: 'New content' } as PostChanges,
-				mockPostType
+				defaultSyncedProperties
 			);
 
 			expect( map.get( 'content' ) ).toBe( contentRef );
@@ -281,7 +294,7 @@ describe( 'crdt', () => {
 			applyPostChangesToCRDTDoc(
 				doc,
 				{ excerpt: 'Old excerpt' } as PostChanges,
-				mockPostType
+				defaultSyncedProperties
 			);
 			const excerptRef = map.get( 'excerpt' );
 
@@ -289,7 +302,7 @@ describe( 'crdt', () => {
 			applyPostChangesToCRDTDoc(
 				doc,
 				{ excerpt: 'New excerpt' } as PostChanges,
-				mockPostType
+				defaultSyncedProperties
 			);
 
 			expect( map.get( 'excerpt' ) ).toBe( excerptRef );
@@ -307,7 +320,7 @@ describe( 'crdt', () => {
 			metaMap.set( 'some_meta', 'old value' );
 			map.set( 'meta', metaMap );
 
-			applyPostChangesToCRDTDoc( doc, changes, mockPostType );
+			applyPostChangesToCRDTDoc( doc, changes, defaultSyncedProperties );
 
 			expect( metaMap.get( 'some_meta' ) ).toBe( 'new value' );
 		} );
@@ -323,7 +336,7 @@ describe( 'crdt', () => {
 			metaMap.set( 'some_meta', 'old value' );
 			map.set( 'meta', metaMap );
 
-			applyPostChangesToCRDTDoc( doc, changes, mockPostType );
+			applyPostChangesToCRDTDoc( doc, changes, defaultSyncedProperties );
 
 			expect( metaMap.get( 'some_meta' ) ).toStrictEqual( [
 				'value',
@@ -338,23 +351,40 @@ describe( 'crdt', () => {
 				},
 			};
 
-			applyPostChangesToCRDTDoc( doc, changes, mockPostType );
+			applyPostChangesToCRDTDoc( doc, changes, defaultSyncedProperties );
 
 			const metaMap = map.get( 'meta' );
 			expect( metaMap ).toBeInstanceOf( Y.Map );
 			expect( metaMap?.get( 'custom_field' ) ).toBe( 'value' );
 		} );
+
+		it( 'syncs taxonomy rest_base values included in syncedProperties', () => {
+			const changes = {
+				categories: [ 1, 2, 3 ],
+				genre: [ 10, 20 ], // should be ignored
+				tags: [ 4, 5 ],
+			} as unknown as PostChanges;
+
+			applyPostChangesToCRDTDoc( doc, changes, defaultSyncedProperties );
+
+			expect( map.get( 'categories' ) ).toEqual( [ 1, 2, 3 ] );
+			expect( map.get( 'genre' ) ).toBeUndefined();
+			expect( map.get( 'tags' ) ).toEqual( [ 4, 5 ] );
+
+			const customSyncedProperties = new Set( [
+				...defaultSyncedProperties,
+				'genre', // now included
+			] );
+
+			applyPostChangesToCRDTDoc( doc, changes, customSyncedProperties );
+
+			expect( map.get( 'categories' ) ).toEqual( [ 1, 2, 3 ] );
+			expect( map.get( 'genre' ) ).toEqual( [ 10, 20 ] );
+			expect( map.get( 'tags' ) ).toEqual( [ 4, 5 ] );
+		} );
 	} );
 
 	describe( 'getPostChangesFromCRDTDoc', () => {
-		const mockPostType = {
-			slug: 'post',
-			supports: {
-				title: true,
-				editor: true,
-			},
-		} as unknown as Type;
-
 		let map: YMapWrap< YPostRecord >;
 
 		beforeEach( () => {
@@ -373,7 +403,7 @@ describe( 'crdt', () => {
 			const changes = getPostChangesFromCRDTDoc(
 				doc,
 				editedRecord,
-				mockPostType
+				defaultSyncedProperties
 			);
 
 			expect( changes.title ).toBe( 'CRDT Title' );
@@ -388,7 +418,7 @@ describe( 'crdt', () => {
 			const changes = getPostChangesFromCRDTDoc(
 				doc,
 				editedRecord,
-				mockPostType
+				defaultSyncedProperties
 			);
 
 			expect( changes ).not.toHaveProperty( 'unsyncedProp' );
@@ -405,7 +435,7 @@ describe( 'crdt', () => {
 			const changes = getPostChangesFromCRDTDoc(
 				doc,
 				editedRecord,
-				mockPostType
+				defaultSyncedProperties
 			);
 
 			expect( changes ).not.toHaveProperty( 'status' );
@@ -424,7 +454,7 @@ describe( 'crdt', () => {
 			const changesWithEmptyDate = getPostChangesFromCRDTDoc(
 				doc,
 				editedRecord,
-				mockPostType
+				defaultSyncedProperties
 			);
 
 			expect( changesWithEmptyDate ).not.toHaveProperty( 'date' );
@@ -434,7 +464,7 @@ describe( 'crdt', () => {
 			const changesWithDefinedDate = getPostChangesFromCRDTDoc(
 				doc,
 				editedRecord,
-				mockPostType
+				defaultSyncedProperties
 			);
 
 			expect( changesWithDefinedDate ).not.toHaveProperty( 'date' );
@@ -453,7 +483,7 @@ describe( 'crdt', () => {
 			const changesWithEmptyDate = getPostChangesFromCRDTDoc(
 				doc,
 				editedRecord,
-				mockPostType
+				defaultSyncedProperties
 			);
 
 			expect( changesWithEmptyDate ).not.toHaveProperty( 'date' );
@@ -463,7 +493,7 @@ describe( 'crdt', () => {
 			const changesWithDefinedDate = getPostChangesFromCRDTDoc(
 				doc,
 				editedRecord,
-				mockPostType
+				defaultSyncedProperties
 			);
 
 			expect( changesWithDefinedDate ).not.toHaveProperty( 'date' );
@@ -479,7 +509,7 @@ describe( 'crdt', () => {
 			const changes = getPostChangesFromCRDTDoc(
 				doc,
 				editedRecord,
-				mockPostType
+				defaultSyncedProperties
 			);
 
 			expect( changes ).toHaveProperty( 'blocks' );
@@ -501,7 +531,7 @@ describe( 'crdt', () => {
 			const changes = getPostChangesFromCRDTDoc(
 				doc,
 				editedRecord,
-				mockPostType
+				defaultSyncedProperties
 			);
 
 			expect( changes ).toHaveProperty( 'blocks' );
@@ -518,7 +548,7 @@ describe( 'crdt', () => {
 			const changes = getPostChangesFromCRDTDoc(
 				doc,
 				editedRecord,
-				mockPostType
+				defaultSyncedProperties
 			);
 
 			expect( changes.content ).toBe( 'New content' );
@@ -534,7 +564,7 @@ describe( 'crdt', () => {
 			const changes = getPostChangesFromCRDTDoc(
 				doc,
 				editedRecord,
-				mockPostType
+				defaultSyncedProperties
 			);
 
 			expect( changes.content ).toBe( 'New content' );
@@ -550,7 +580,7 @@ describe( 'crdt', () => {
 			const changes = getPostChangesFromCRDTDoc(
 				doc,
 				editedRecord,
-				mockPostType
+				defaultSyncedProperties
 			);
 
 			expect( changes ).not.toHaveProperty( 'content' );
@@ -570,7 +600,7 @@ describe( 'crdt', () => {
 			const changes = getPostChangesFromCRDTDoc(
 				doc,
 				editedRecord,
-				mockPostType
+				defaultSyncedProperties
 			);
 
 			expect( changes.meta ).toEqual( {
@@ -592,7 +622,7 @@ describe( 'crdt', () => {
 			const changes = getPostChangesFromCRDTDoc(
 				doc,
 				editedRecord,
-				mockPostType
+				defaultSyncedProperties
 			);
 
 			expect( changes.meta ).toEqual( {
@@ -615,7 +645,7 @@ describe( 'crdt', () => {
 			const changes = getPostChangesFromCRDTDoc(
 				doc,
 				editedRecord,
-				mockPostType
+				defaultSyncedProperties
 			);
 
 			expect( changes.meta ).toEqual( {
@@ -626,6 +656,43 @@ describe( 'crdt', () => {
 			);
 		} );
 
+		it( 'returns taxonomy rest_base changes when in syncedProperties', () => {
+			map.set( 'categories', [ 1, 2 ] );
+			map.set( 'genre', [ 10, 20 ] );
+			map.set( 'tags', [ 3 ] );
+
+			const editedRecord = {
+				categories: [ 1 ],
+				genre: [ 10 ], // should be ignored
+				tags: [],
+			} as unknown as Post;
+
+			const changes = getPostChangesFromCRDTDoc(
+				doc,
+				editedRecord,
+				defaultSyncedProperties
+			) as Record< string, unknown >;
+
+			expect( changes.categories ).toEqual( [ 1, 2 ] );
+			expect( changes.genre ).toBeUndefined();
+			expect( changes.tags ).toEqual( [ 3 ] );
+
+			const customSyncedProperties = new Set( [
+				...defaultSyncedProperties,
+				'genre', // now included
+			] );
+
+			const changes2 = getPostChangesFromCRDTDoc(
+				doc,
+				editedRecord,
+				customSyncedProperties
+			) as Record< string, unknown >;
+
+			expect( changes2.categories ).toEqual( [ 1, 2 ] );
+			expect( changes2.genre ).toEqual( [ 10, 20 ] );
+			expect( changes2.tags ).toEqual( [ 3 ] );
+		} );
+
 		describe( 'selection recalculation', () => {
 			it( 'includes recalculated selection when text is inserted before cursor', () => {
 				const ytext = addBlockToDoc( map, 'block-1', 'Hello world' );
@@ -656,7 +723,7 @@ describe( 'crdt', () => {
 				const changes = getPostChangesFromCRDTDoc(
 					doc,
 					editedRecord,
-					mockPostType
+					defaultSyncedProperties
 				);
 
 				expect( changes.selection ).toBeDefined();
@@ -699,7 +766,7 @@ describe( 'crdt', () => {
 				const changes = getPostChangesFromCRDTDoc(
 					doc,
 					editedRecord,
-					mockPostType
+					defaultSyncedProperties
 				);
 
 				expect( changes.selection ).toBeDefined();
@@ -718,7 +785,7 @@ describe( 'crdt', () => {
 				const changes = getPostChangesFromCRDTDoc(
 					doc,
 					editedRecord,
-					mockPostType
+					defaultSyncedProperties
 				);
 
 				expect( changes.selection ).toBeUndefined();