@wordpress/core-data 7.49.1 → 7.50.1-next.v.202607070741.0

package/src/test/private-actions.js

@@ -6,9 +6,14 @@ import apiFetch from '@wordpress/api-fetch';
 /**
  * Internal dependencies
  */
-import { editMediaEntity } from '../private-actions';
+import { editMediaEntity, setCollaborationSupported } from '../private-actions';
+import { getSyncManager, hasSyncManager } from '../sync';
 
 jest.mock( '@wordpress/api-fetch' );
+jest.mock( '../sync', () => ( {
+	getSyncManager: jest.fn(),
+	hasSyncManager: jest.fn(),
+} ) );
 
 describe( 'editMediaEntity', () => {
 	let dispatch;
@@ -211,3 +216,35 @@ describe( 'editMediaEntity', () => {
 		expect( result ).toBeUndefined();
 	} );
 } );
+
+describe( 'setCollaborationSupported', () => {
+	afterEach( () => {
+		getSyncManager.mockReset();
+		hasSyncManager.mockReset();
+	} );
+
+	it( 'unloads sync and resets sync undo state when disabling collaboration', () => {
+		const syncManager = {
+			unloadAll: jest.fn(),
+		};
+		const dispatch = Object.assign( jest.fn(), {
+			__unstableNotifySyncUndoManagerChange: jest.fn(),
+		} );
+		hasSyncManager.mockReturnValue( true );
+		getSyncManager.mockReturnValue( syncManager );
+
+		setCollaborationSupported( false )( { dispatch } );
+
+		expect( dispatch ).toHaveBeenCalledWith( {
+			type: 'SET_COLLABORATION_SUPPORTED',
+			supported: false,
+		} );
+		expect( syncManager.unloadAll ).toHaveBeenCalledTimes( 1 );
+		expect(
+			dispatch.__unstableNotifySyncUndoManagerChange
+		).toHaveBeenCalledWith( {
+			hasUndo: false,
+			hasRedo: false,
+		} );
+	} );
+} );

package/src/test/resolvers.js

@@ -183,6 +183,51 @@ describe( 'getEntityRecord', () => {
 		);
 	} );
 
+	it( 'does not load entity with sync manager when collaboration is unsupported', async () => {
+		const POST_RECORD = { id: 1, title: 'Test Post' };
+		const POST_RESPONSE = {
+			json: () => Promise.resolve( POST_RECORD ),
+		};
+		const ENTITIES_WITH_SYNC = [
+			{
+				name: 'post',
+				kind: 'postType',
+				baseURL: '/wp/v2/posts',
+				baseURLParams: { context: 'edit' },
+				syncConfig: {},
+			},
+		];
+
+		const resolveSelectWithSync = {
+			getEntitiesConfig: jest.fn( () => ENTITIES_WITH_SYNC ),
+		};
+		const select = {
+			isCollaborationSupported: jest.fn( () => false ),
+		};
+
+		triggerFetch.mockImplementation( () => POST_RESPONSE );
+
+		await getEntityRecord(
+			'postType',
+			'post',
+			1
+		)( {
+			select,
+			dispatch,
+			registry,
+			resolveSelect: resolveSelectWithSync,
+		} );
+
+		expect( syncManager.load ).not.toHaveBeenCalled();
+		expect( select.isCollaborationSupported ).toHaveBeenCalledTimes( 1 );
+		expect( dispatch.receiveEntityRecords ).toHaveBeenCalledWith(
+			'postType',
+			'post',
+			POST_RECORD,
+			undefined
+		);
+	} );
+
 	it( 'notifies core-data when the sync undo manager stack changes', async () => {
 		const POST_RECORD = { id: 1, title: 'Test Post' };
 		const POST_RESPONSE = {

package/src/utils/crdt-blocks.ts

@@ -46,6 +46,7 @@ export interface Block {
 	attributes: BlockAttributes;
 	clientId?: string;
 	innerBlocks: Block[];
+	innerContent?: Array< string | null >;
 	isValid?: boolean;
 	name: string;
 	originalContent?: string;

package/src/utils/crdt.ts

@@ -345,8 +345,24 @@ function parseCursorSelection( selection?: WPSelection ): MergeCursorPosition {
 		: null;
 }
 
-function defaultGetChangesFromCRDTDoc( crdtDoc: CRDTDoc ): ObjectData {
-	return getRootMap( crdtDoc, CRDT_RECORD_MAP_KEY ).toJSON();
+function defaultGetChangesFromCRDTDoc(
+	crdtDoc: CRDTDoc,
+	editedRecord: ObjectData
+): ObjectData {
+	const docRecord = getRootMap( crdtDoc, CRDT_RECORD_MAP_KEY ).toJSON();
+
+	/*
+	 * Only report properties that differ from the edited record. Reporting
+	 * unchanged properties as edits marks the record dirty: `Y.Map.toJSON()`
+	 * returns fresh object instances, so without this comparison every synced
+	 * update (e.g. from another tab) re-dispatches the entire record as edits.
+	 * See https://github.com/WordPress/gutenberg/issues/79907.
+	 */
+	return Object.fromEntries(
+		Object.entries( docRecord ).filter( ( [ key, newValue ] ) =>
+			haveValuesChanged( editedRecord?.[ key ], newValue )
+		)
+	);
 }
 
 /**

package/src/utils/test/crdt-blocks.ts

@@ -165,6 +165,64 @@ describe( 'crdt-blocks', () => {
 			expect( content.toString() ).toBe( 'Hello World' );
 		} );
 
+		it( 'syncs innerContent of static inner-content blocks into the Y.Doc', () => {
+			const incomingBlocks: Block[] = [
+				{
+					name: 'core/html',
+					attributes: {},
+					innerBlocks: [
+						{
+							name: 'core/paragraph',
+							attributes: { content: 'Editable' },
+							innerBlocks: [],
+							clientId: 'inner-1',
+						},
+					],
+					innerContent: [ '<div class="banner">', null, '</div>' ],
+					clientId: 'html-1',
+				},
+			];
+
+			mergeCrdtBlocks( yblocks, incomingBlocks, null );
+
+			const block = yblocks.get( 0 );
+			expect( block.get( 'innerContent' ) ).toEqual( [
+				'<div class="banner">',
+				null,
+				'</div>',
+			] );
+		} );
+
+		it( 'updates innerContent when the static markup changes', () => {
+			const initialBlocks: Block[] = [
+				{
+					name: 'core/html',
+					attributes: {},
+					innerBlocks: [],
+					innerContent: [ '<p>one</p>' ],
+					clientId: 'html-1',
+				},
+			];
+
+			mergeCrdtBlocks( yblocks, initialBlocks, null );
+
+			const updatedBlocks: Block[] = [
+				{
+					name: 'core/html',
+					attributes: {},
+					innerBlocks: [],
+					innerContent: [ '<p>two</p>' ],
+					clientId: 'html-1',
+				},
+			];
+
+			mergeCrdtBlocks( yblocks, updatedBlocks, null );
+
+			expect( yblocks.get( 0 ).get( 'innerContent' ) ).toEqual( [
+				'<p>two</p>',
+			] );
+		} );
+
 		it( 'updates existing blocks when content changes', () => {
 			const initialBlocks: Block[] = [
 				{

package/src/utils/test/crdt.ts

@@ -68,6 +68,7 @@ import { CRDT_RECORD_MAP_KEY } from '../../sync';
 import {
 	applyPostChangesToCRDTDoc,
 	defaultCollectionSyncConfig,
+	defaultSyncConfig,
 	getPostChangesFromCRDTDoc,
 	POST_META_KEY_FOR_CRDT_DOC_PERSISTENCE,
 	type PostChanges,
@@ -93,6 +94,52 @@ const defaultSyncedProperties = new Set< string >( [
 	'title',
 ] );
 
+describe( 'defaultSyncConfig', () => {
+	// Regression test for https://github.com/WordPress/gutenberg/issues/79907:
+	// reporting unchanged properties as changes marks resolved records
+	// (e.g. taxonomy terms) as dirty whenever a synced update arrives.
+	it( 'getChangesFromCRDTDoc returns no changes when the document matches the edited record', () => {
+		const doc = new Y.Doc();
+		const record = {
+			id: 1,
+			name: 'Uncategorized',
+			slug: 'uncategorized',
+			meta: [],
+			_links: { self: [ { href: 'https://example.com' } ] },
+		};
+		defaultSyncConfig.applyChangesToCRDTDoc( doc, record );
+
+		// The edited record deep-equals the document contents, but
+		// `Y.Map.toJSON()` returns fresh object instances.
+		const changes = defaultSyncConfig.getChangesFromCRDTDoc( doc, {
+			...record,
+			meta: [],
+			_links: { self: [ { href: 'https://example.com' } ] },
+		} );
+
+		expect( changes ).toEqual( {} );
+		doc.destroy();
+	} );
+
+	it( 'getChangesFromCRDTDoc returns only the properties that differ from the edited record', () => {
+		const doc = new Y.Doc();
+		defaultSyncConfig.applyChangesToCRDTDoc( doc, {
+			id: 1,
+			name: 'Renamed category',
+			slug: 'uncategorized',
+		} );
+
+		const changes = defaultSyncConfig.getChangesFromCRDTDoc( doc, {
+			id: 1,
+			name: 'Uncategorized',
+			slug: 'uncategorized',
+		} );
+
+		expect( changes ).toEqual( { name: 'Renamed category' } );
+		doc.destroy();
+	} );
+} );
+
 describe( 'defaultCollectionSyncConfig', () => {
 	it( 'has no-op applyChangesToCRDTDoc', () => {
 		const doc = new Y.Doc();