Core Data: Use new raw entity record selector instead of modifying th…

…e existing one.
WordPress · Aug 19, 2019 · 450b7f2 · 450b7f2
1 parent ff28c04
commit 450b7f2
Show file tree

Hide file tree

Showing 6 changed files with 62 additions and 21 deletions.
diff --git a/docs/designers-developers/developers/data/data-core.md b/docs/designers-developers/developers/data/data-core.md
@@ -217,6 +217,22 @@ _Returns_
 
 -   `?Object`: The entity record's save error.
 
+<a name="getRawEntityRecord" href="#getRawEntityRecord">#</a> **getRawEntityRecord**
+
+Returns the entity's record object by key,
+with its attributes mapped to their raw values.
+
+_Parameters_
+
+-   _state_ `Object`: State tree.
+-   _kind_ `string`: Entity kind.
+-   _name_ `string`: Entity name.
+-   _key_ `number`: Record's key.
+
+_Returns_
+
+-   `?Object`: Object with the entity's raw attributes.
+
 <a name="getRedoEdit" href="#getRedoEdit">#</a> **getRedoEdit**
 
 Returns the next edit from the current undo offset

diff --git a/packages/core-data/README.md b/packages/core-data/README.md
@@ -428,6 +428,22 @@ _Returns_
 
 -   `?Object`: The entity record's save error.
 
+<a name="getRawEntityRecord" href="#getRawEntityRecord">#</a> **getRawEntityRecord**
+
+Returns the entity's record object by key,
+with its attributes mapped to their raw values.
+
+_Parameters_
+
+-   _state_ `Object`: State tree.
+-   _kind_ `string`: Entity kind.
+-   _name_ `string`: Entity name.
+-   _key_ `number`: Record's key.
+
+_Returns_
+
+-   `?Object`: Object with the entity's raw attributes.
+
 <a name="getRedoEdit" href="#getRedoEdit">#</a> **getRedoEdit**
 
 Returns the next edit from the current undo offset

diff --git a/packages/core-data/src/actions.js b/packages/core-data/src/actions.js
@@ -137,7 +137,7 @@ export function* editEntityRecord( kind, name, recordId, edits ) {
 		kind,
 		name
 	);
-	const record = yield select( 'getEntityRecord', kind, name, recordId );
+	const record = yield select( 'getRawEntityRecord', kind, name, recordId );
 	const editedRecord = yield select(
 		'getEditedEntityRecord',
 		kind,
@@ -243,7 +243,7 @@ export function* saveEntityRecord(
 	let updatedRecord;
 	let persistedRecord;
 	if ( isAutosave || getSuccessNoticeActionArgs || getFailureNoticeActionArgs ) {
-		persistedRecord = yield select( 'getEntityRecord', kind, name, recordId );
+		persistedRecord = yield select( 'getRawEntityRecord', kind, name, recordId );
 	}
 	let error;
 	try {

diff --git a/packages/core-data/src/selectors.js b/packages/core-data/src/selectors.js
@@ -103,24 +103,33 @@ export function getEntity( state, kind, name ) {
  *
  * @return {Object?} Record.
  */
-export const getEntityRecord = createSelector(
+export function getEntityRecord( state, kind, name, key ) {
+	return get( state.entities.data, [ kind, name, 'queriedData', 'items', key ] );
+}
+
+/**
+ * Returns the entity's record object by key,
+ * with its attributes mapped to their raw values.
+ *
+ * @param {Object} state  State tree.
+ * @param {string} kind   Entity kind.
+ * @param {string} name   Entity name.
+ * @param {number} key    Record's key.
+ *
+ * @return {Object?} Object with the entity's raw attributes.
+ */
+export const getRawEntityRecord = createSelector(
 	( state, kind, name, key ) => {
-		const record = get( state.entities.data, [
-			kind,
-			name,
-			'queriedData',
-			'items',
-			key,
-		] );
+		const record = getEntityRecord( state, kind, name, key );
 		return (
 			record &&
-			Object.keys( record ).reduce( ( acc, _key ) => {
-				// Because edits are the "raw" attribute values,
-				// we return those from record selectors to make rendering,
-				// comparisons, and joins with edits easier.
-				acc[ _key ] = get( record[ _key ], 'raw', record[ _key ] );
-				return acc;
-			}, {} )
+							Object.keys( record ).reduce( ( acc, _key ) => {
+								// Because edits are the "raw" attribute values,
+								// we return those from record selectors to make rendering,
+								// comparisons, and joins with edits easier.
+								acc[ _key ] = get( record[ _key ], 'raw', record[ _key ] );
+								return acc;
+							}, {} )
 		);
 	},
 	( state ) => [ state.entities.data ]
@@ -213,7 +222,7 @@ export function hasEditsForEntityRecord( state, kind, name, recordId ) {
  */
 export const getEditedEntityRecord = createSelector(
 	( state, kind, name, recordId ) => ( {
-		...getEntityRecord( state, kind, name, recordId ),
+		...getRawEntityRecord( state, kind, name, recordId ),
 		...getEntityRecordEdits( state, kind, name, recordId ),
 	} ),
 	( state ) => [ state.entities.data ]

diff --git a/packages/editor/src/store/selectors.js b/packages/editor/src/store/selectors.js
@@ -159,7 +159,7 @@ export const getCurrentPost = createRegistrySelector( ( select ) => ( state ) =>
 	const postId = getCurrentPostId( state );
 	const postType = getCurrentPostType( state );
 
-	const post = select( 'core' ).getEntityRecord( 'postType', postType, postId );
+	const post = select( 'core' ).getRawEntityRecord( 'postType', postType, postId );
 	if ( post ) {
 		return post;
 	}

diff --git a/packages/editor/src/store/test/selectors.js b/packages/editor/src/store/test/selectors.js
@@ -30,7 +30,7 @@ const selectorNames = Object.keys( selectors );
 selectorNames.forEach( ( name ) => {
 	selectors[ name ] = ( state, ...args ) => {
 		const select = () => ( {
-			getEntityRecord() {
+			getRawEntityRecord() {
 				return state.currentPost;
 			},
 
@@ -69,7 +69,7 @@ selectorNames.forEach( ( name ) => {
 					};
 				}
 				return {
-					...this.getEntityRecord(),
+					...this.getRawEntityRecord(),
 					...edits,
 				};
 			},