@wordpress/core-data 7.51.0 → 7.53.0

package/src/test/deprecated-entity-logging.js

@@ -1,12 +1,5 @@
-/**
- * WordPress dependencies
- */
 import deprecated from '@wordpress/deprecated';
 import { createRegistry } from '@wordpress/data';
-
-/**
- * Internal dependencies
- */
 import { store as coreDataStore } from '../index';
 
 jest.mock( '@wordpress/deprecated' );

package/src/test/entities.js

@@ -1,8 +1,4 @@
-/**
- * WordPress dependencies
- */
 import apiFetch from '@wordpress/api-fetch';
-
 jest.mock( '@wordpress/api-fetch' );
 jest.mock( '../sync', () => ( {
 	...jest.requireActual( '../sync' ),
@@ -12,10 +8,6 @@ jest.mock( '../utils/crdt', () => ( {
 	...jest.requireActual( '../utils/crdt' ),
 	applyPostChangesToCRDTDoc: jest.fn(),
 } ) );
-
-/**
- * Internal dependencies
- */
 import {
 	getMethodName,
 	rootEntitiesConfig,

package/src/test/entity-provider.js

@@ -1,11 +1,4 @@
-/**
- * External dependencies
- */
 import { act, render } from '@testing-library/react';
-
-/**
- * WordPress dependencies
- */
 import {
 	createBlock,
 	registerBlockType,
@@ -16,10 +9,6 @@ import { RichText, useBlockProps } from '@wordpress/block-editor';
 import { createRegistry, RegistryProvider } from '@wordpress/data';
 import { registerCoreBlocks } from '@wordpress/block-library';
 import { unregisterFormatType } from '@wordpress/rich-text';
-
-/**
- * Internal dependencies
- */
 import { store as coreDataStore } from '../index';
 import useEntityBlockEditor from '../hooks/use-entity-block-editor';
 

package/src/test/private-actions.js

@@ -1,13 +1,11 @@
-/**
- * WordPress dependencies
- */
 import apiFetch from '@wordpress/api-fetch';
-
-/**
- * Internal dependencies
- */
+import { store as blockEditorStore } from '@wordpress/block-editor';
+import { createRegistry } from '@wordpress/data';
+import { store as noticesStore } from '@wordpress/notices';
+import { store as coreStore } from '..';
 import { editMediaEntity, setCollaborationSupported } from '../private-actions';
 import { getSyncManager, hasSyncManager } from '../sync';
+import { unlock } from '../lock-unlock';
 
 jest.mock( '@wordpress/api-fetch' );
 jest.mock( '../sync', () => ( {
@@ -248,3 +246,295 @@ describe( 'setCollaborationSupported', () => {
 		} );
 	} );
 } );
+
+describe( 'saveDirtyEntities', () => {
+	beforeEach( () => {
+		apiFetch.mockReset();
+	} );
+
+	const postTypeConfig = {
+		kind: 'postType',
+		name: 'post',
+		baseURL: '/wp/v2/posts',
+		transientEdits: { blocks: true, selection: true },
+		mergedEdits: { meta: true },
+	};
+
+	const postId = 44;
+
+	const post = {
+		id: postId,
+		type: 'post',
+		title: 'bar',
+		content: 'bar',
+		excerpt: 'crackers',
+		status: 'draft',
+	};
+
+	const postEntityRecord = {
+		key: postId,
+		kind: 'postType',
+		name: 'post',
+		title: 'bar',
+	};
+
+	function createRegistryWithStoresAndEditedPost() {
+		const registry = createRegistry();
+
+		registry.register( blockEditorStore );
+		registry.register( coreStore );
+		registry.register( noticesStore );
+
+		registry.dispatch( coreStore ).addEntities( [ postTypeConfig ] );
+
+		registry
+			.dispatch( coreStore )
+			.receiveEntityRecords( 'postType', 'post', post );
+
+		registry
+			.dispatch( coreStore )
+			.editEntityRecord( 'postType', 'post', postId, {
+				content: 'new bar',
+			} );
+
+		return registry;
+	}
+
+	const hasEdits = ( registry ) =>
+		registry
+			.select( coreStore )
+			.hasEditsForEntityRecord( 'postType', 'post', postId );
+
+	const getContent = ( registry ) =>
+		registry
+			.select( coreStore )
+			.getEditedEntityRecord( 'postType', 'post', postId ).content;
+
+	const getMethod = ( options ) =>
+		options.headers?.[ 'X-HTTP-Method-Override' ] ||
+		options.method ||
+		'GET';
+
+	it( 'saves modified entities', async () => {
+		apiFetch.mockImplementation( async ( options ) => {
+			const method = getMethod( options );
+			const { path, data } = options;
+
+			if (
+				method === 'PUT' &&
+				path.startsWith( `/wp/v2/posts/${ postId }` )
+			) {
+				return { ...post, ...data };
+			}
+
+			throw {
+				code: 'unknown_path',
+				message: `Unknown path: ${ method } ${ path }`,
+			};
+		} );
+
+		const registry = createRegistryWithStoresAndEditedPost();
+
+		expect( hasEdits( registry ) ).toBe( true );
+
+		await unlock( registry.dispatch( coreStore ) ).saveDirtyEntities( {
+			dirtyEntityRecords: [ postEntityRecord ],
+		} );
+
+		expect( getContent( registry ) ).toBe( 'new bar' );
+		expect( hasEdits( registry ) ).toBe( false );
+
+		const notices = registry.select( noticesStore ).getNotices();
+		expect( notices ).toMatchObject( [
+			{
+				status: 'success',
+				content: 'Site updated.',
+			},
+		] );
+	} );
+
+	it( 'shows a notice to convey errors', async () => {
+		apiFetch.mockImplementation( async ( options ) => {
+			const method = getMethod( options );
+			const { path } = options;
+
+			throw {
+				code: 'unknown_path',
+				message: `Unknown path: ${ method } ${ path }`,
+			};
+		} );
+
+		const registry = createRegistryWithStoresAndEditedPost();
+
+		expect( hasEdits( registry ) ).toBe( true );
+
+		await unlock( registry.dispatch( coreStore ) ).saveDirtyEntities( {
+			dirtyEntityRecords: [ postEntityRecord ],
+		} );
+
+		expect( getContent( registry ) ).toBe( 'new bar' );
+		expect( hasEdits( registry ) ).toBe( true );
+
+		const notices = registry.select( noticesStore ).getNotices();
+		expect( notices[ 0 ].status ).toBe( 'error' );
+		expect( notices[ 0 ].content ).toMatch( /^Unknown path/ );
+	} );
+
+	it( 'derives error messages depending on failure scenario', async () => {
+		const registry = createRegistryWithStoresAndEditedPost();
+
+		// Throw an object with a `message` property
+		apiFetch.mockImplementation( async () => {
+			throw {
+				message: 'Lorem ipsum',
+			};
+		} );
+
+		await unlock( registry.dispatch( coreStore ) ).saveDirtyEntities( {
+			dirtyEntityRecords: [ postEntityRecord ],
+		} );
+
+		expect(
+			registry.select( noticesStore ).getNotices().at( -1 )
+		).toMatchObject( {
+			status: 'error',
+			content: 'Lorem ipsum',
+		} );
+
+		// Throw an object with an empty `message` property
+		apiFetch.mockImplementation( async () => {
+			throw {
+				message: '',
+			};
+		} );
+
+		await unlock( registry.dispatch( coreStore ) ).saveDirtyEntities( {
+			dirtyEntityRecords: [ postEntityRecord ],
+		} );
+
+		expect(
+			registry.select( noticesStore ).getNotices().at( -1 )
+		).toMatchObject( {
+			status: 'error',
+			content: 'Saving failed.',
+		} );
+
+		// Throw an actual error
+		apiFetch.mockImplementation( async () => {
+			throw new Error( 'Dolor sit amet' );
+		} );
+
+		await unlock( registry.dispatch( coreStore ) ).saveDirtyEntities( {
+			dirtyEntityRecords: [ postEntityRecord ],
+		} );
+
+		expect(
+			registry.select( noticesStore ).getNotices().at( -1 )
+		).toMatchObject( {
+			status: 'error',
+			content: 'Dolor sit amet',
+		} );
+
+		// Throw a string
+		apiFetch.mockImplementation( async () => {
+			throw 'Consectetur adipiscing elit';
+		} );
+
+		await unlock( registry.dispatch( coreStore ) ).saveDirtyEntities( {
+			dirtyEntityRecords: [ postEntityRecord ],
+		} );
+
+		expect(
+			registry.select( noticesStore ).getNotices().at( -1 )
+		).toMatchObject( {
+			status: 'error',
+			content: 'Consectetur adipiscing elit',
+		} );
+
+		// Throw an object implementing `toString`
+		apiFetch.mockImplementation( async () => {
+			throw {
+				toString() {
+					return 'Sed do eiusmod tempor incididunt';
+				},
+			};
+		} );
+
+		await unlock( registry.dispatch( coreStore ) ).saveDirtyEntities( {
+			dirtyEntityRecords: [ postEntityRecord ],
+		} );
+
+		expect(
+			registry.select( noticesStore ).getNotices().at( -1 )
+		).toMatchObject( {
+			status: 'error',
+			content: 'Sed do eiusmod tempor incididunt',
+		} );
+
+		// Throw something with no clear message
+		apiFetch.mockImplementation( async () => {
+			throw {};
+		} );
+
+		await unlock( registry.dispatch( coreStore ) ).saveDirtyEntities( {
+			dirtyEntityRecords: [ postEntityRecord ],
+		} );
+
+		expect(
+			registry.select( noticesStore ).getNotices().at( -1 )
+		).toMatchObject( {
+			status: 'error',
+			content: 'Saving failed.',
+		} );
+	} );
+
+	it( 'aborts if `onSave` fails', async () => {
+		apiFetch.mockImplementation( async () => {
+			throw {
+				code: 'unknown_path',
+				message: 'Unknown path',
+			};
+		} );
+
+		const registry = createRegistryWithStoresAndEditedPost();
+
+		await unlock( registry.dispatch( coreStore ) ).saveDirtyEntities( {
+			dirtyEntityRecords: [ postEntityRecord ],
+			async onSave() {
+				throw new Error( 'oh no' );
+			},
+		} );
+
+		expect( hasEdits( registry ) ).toBe( true );
+
+		const notices = registry.select( noticesStore ).getNotices();
+		expect( notices ).toMatchObject( [
+			{
+				status: 'error',
+				content: 'oh no',
+			},
+		] );
+	} );
+
+	it( 'honors the `successNoticeContent` prop', async () => {
+		apiFetch.mockImplementation( async ( options ) => {
+			const { data } = options;
+			return { ...post, ...data };
+		} );
+
+		const registry = createRegistryWithStoresAndEditedPost();
+
+		await unlock( registry.dispatch( coreStore ) ).saveDirtyEntities( {
+			dirtyEntityRecords: [ postEntityRecord ],
+			successNoticeContent: 'eureka',
+		} );
+
+		const notices = registry.select( noticesStore ).getNotices();
+		expect( notices ).toMatchObject( [
+			{
+				status: 'success',
+				content: 'eureka',
+			},
+		] );
+	} );
+} );

package/src/test/private-selectors.js

@@ -1,6 +1,3 @@
-/**
- * Internal dependencies
- */
 import { getUndoManager } from '../private-selectors';
 import { getSyncManager } from '../sync';
 

package/src/test/reducer.js

@@ -1,11 +1,4 @@
-/**
- * External dependencies
- */
 import deepFreeze from 'deep-freeze';
-
-/**
- * Internal dependencies
- */
 import {
 	entities,
 	embedPreviews,

package/src/test/resolvers.js

@@ -1,22 +1,10 @@
-/**
- * WordPress dependencies
- */
 import triggerFetch from '@wordpress/api-fetch';
-
-/**
- * Internal dependencies
- */
 import { getSyncManager } from '../sync';
-
 jest.mock( '@wordpress/api-fetch' );
 jest.mock( '../sync', () => ( {
 	getSyncManager: jest.fn(),
 	LOCAL_UNDO_IGNORED_ORIGIN: 'local-undo-ignored',
 } ) );
-
-/**
- * Internal dependencies
- */
 import {
 	getEntityRecord,
 	getEntityRecords,

package/src/test/rtc-rich-text-offset-space.test.js

@@ -1,6 +1,3 @@
-/**
- * External dependencies
- */
 import { act, render, waitFor } from '@testing-library/react';
 import {
 	afterEach,
@@ -10,10 +7,6 @@ import {
 	it,
 	jest,
 } from '@jest/globals';
-
-/**
- * WordPress dependencies
- */
 import {
 	getBlockTypes,
 	registerBlockType,
@@ -22,7 +15,6 @@ import {
 import { RichText } from '@wordpress/block-editor';
 import { createRegistry, RegistryProvider } from '@wordpress/data';
 import { Y } from '@wordpress/sync';
-
 /**
  * Mock sync manager accessor.
  */
@@ -31,10 +23,6 @@ jest.mock( '../sync', () => ( {
 	getSyncManager: jest.fn(),
 	LOCAL_EDITOR_ORIGIN: 'local-editor',
 } ) );
-
-/**
- * Internal dependencies
- */
 import { store as coreDataStore } from '../index';
 import { CRDT_RECORD_MAP_KEY, getSyncManager } from '../sync';
 import useEntityBlockEditor from '../hooks/use-entity-block-editor';

package/src/test/selectors.js

@@ -1,11 +1,4 @@
-/**
- * External dependencies
- */
 import deepFreeze from 'deep-freeze';
-
-/**
- * Internal dependencies
- */
 import {
 	getEntityRecord,
 	hasEntityRecord,

package/src/test/store.js

@@ -1,12 +1,5 @@
-/**
- * WordPress dependencies
- */
 import triggerFetch from '@wordpress/api-fetch';
 import { createRegistry } from '@wordpress/data';
-
-/**
- * Internal dependencies
- */
 import { store as coreDataStore } from '../index';
 
 jest.mock( '@wordpress/api-fetch' );
@@ -277,6 +270,7 @@ describe( 'getRevisions', () => {
 	} );
 
 	it( 'preserves all revisions when getRevision resolves after getRevisions', async () => {
+		const revision = { id: 1 };
 		let resolveSlowFetch;
 		const slowFetchPromise = new Promise( ( resolve ) => {
 			resolveSlowFetch = resolve;
@@ -307,16 +301,15 @@ describe( 'getRevisions', () => {
 			1,
 			{ context: 'edit' }
 		);
-		await resolveSelectStore.getRevisions( KIND, NAME, RECORD_KEY, {
-			context: 'edit',
-		} );
+		await expect(
+			resolveSelectStore.getRevisions( KIND, NAME, RECORD_KEY, {
+				context: 'edit',
+			} )
+		).resolves.toEqual( REVISIONS );
 
 		// Now resolve the slow single-revision fetch.
-		resolveSlowFetch( REVISIONS[ 0 ] );
-		await revisionPromise;
-
-		// Wait for all pending thunks (receiveRevisions) to settle.
-		await new Promise( ( resolve ) => setTimeout( resolve, 0 ) );
+		resolveSlowFetch( revision );
+		await expect( revisionPromise ).resolves.toEqual( revision );
 
 		const allRevisions = registry
 			.select( coreDataStore )

package/src/types.ts

@@ -1,11 +1,4 @@
-/**
- * WordPress dependencies
- */
 import type { ConnectionStatusDisconnected, Y } from '@wordpress/sync';
-
-/**
- * Internal dependencies
- */
 import type {
 	SelectionType,
 	SelectionDirection,
@@ -160,13 +153,22 @@ export type SelectionInOneBlock = {
 	selectionDirection?: SelectionDirection;
 };
 
+/**
+ * One end of a multi-block selection. Uses SelectionCursor when the endpoint
+ * lands inside a RichText field (character-level anchor) or SelectionWholeBlock
+ * when the entire block is selected (block-slot anchor). The type discriminant
+ * tells the receiver how to resolve this endpoint.
+ */
+export type SelectionEndpoint = SelectionCursor | SelectionWholeBlock;
+
 export type SelectionInMultipleBlocks = {
-	// The user has highlighted text over multiple blocks.
-	// The blocks are derived on the receiver side by navigating up from the
-	// resolved cursor positions via Y.AbstractType.parent.
+	// The user's selection spans more than one block. Each endpoint is resolved
+	// independently: text blocks carry a character-level CursorEndpoint while
+	// blocks without a RichText field (or selected as whole blocks) carry a
+	// WholeBlockEndpoint. Mixed combinations (e.g. paragraph → image) are valid.
 	type: SelectionType.SelectionInMultipleBlocks;
-	cursorStartPosition: CursorPosition;
-	cursorEndPosition: CursorPosition;
+	startEndpoint: SelectionEndpoint;
+	endEndpoint: SelectionEndpoint;
 	// The direction of the selection, indicating where the caret sits.
 	selectionDirection?: SelectionDirection;
 };

package/src/utils/block-selection-history.ts

@@ -1,14 +1,4 @@
-/**
- * External dependencies
- */
-/**
- * WordPress dependencies
- */
 import { Y } from '@wordpress/sync';
-
-/**
- * Internal dependencies
- */
 import {
 	asRichTextOffset,
 	findBlockByClientIdInDoc,

package/src/utils/clear-unchanged-edits.ts

@@ -1,6 +1,3 @@
-/**
- * External dependencies
- */
 import fastDeepEqual from 'fast-deep-equal/es6/index.js';
 
 /**

package/src/utils/conservative-map-item.js

@@ -1,6 +1,3 @@
-/**
- * External dependencies
- */
 import fastDeepEqual from 'fast-deep-equal/es6/index.js';
 
 /**

package/src/utils/crdt-blocks.ts

@@ -1,19 +1,8 @@
-/**
- * External dependencies
- */
 import { v4 as uuidv4 } from 'uuid';
 import fastDeepEqual from 'fast-deep-equal/es6/index.js';
-
-/**
- * WordPress dependencies
- */
 import { getBlockTypes } from '@wordpress/blocks';
 import { RichTextData } from '@wordpress/rich-text';
 import { Y } from '@wordpress/sync';
-
-/**
- * Internal dependencies
- */
 import {
 	asRichTextOffset,
 	createYMap,

package/src/utils/crdt-selection.ts

@@ -1,15 +1,8 @@
-/**
- * WordPress dependencies
- */
 import { dispatch, select } from '@wordpress/data';
 // @ts-expect-error No exported types.
 import { store as blockEditorStore } from '@wordpress/block-editor';
 import { isUnmodifiedBlock } from '@wordpress/blocks';
 import { type CRDTDoc, Y } from '@wordpress/sync';
-
-/**
- * Internal dependencies
- */
 import {
 	createBlockSelectionHistory,
 	YSelectionType,

package/src/utils/crdt-text.ts

@@ -1,6 +1,3 @@
-/**
- * WordPress dependencies
- */
 import { RichTextData } from '@wordpress/rich-text';
 
 const RICH_TEXT_CACHE_MAX_SIZE = 500;