Core Data: Normalize _fields value for use in stableKey (#27526)

* Core Data: Normalize _fields value for use in stableKey * Fix existing tests * Fix selector used in tests
WordPress · Jan 28, 2021 · f3fbc59 · f3fbc59
1 parent bb05df7
commit f3fbc59
Show file tree

Hide file tree

Showing 4 changed files with 86 additions and 3 deletions.
diff --git a/packages/core-data/src/queried-data/get-query-parts.js b/packages/core-data/src/queried-data/get-query-parts.js
@@ -48,7 +48,7 @@ export function getQueryParts( query ) {
 
 	for ( let i = 0; i < keys.length; i++ ) {
 		const key = keys[ i ];
-		const value = query[ key ];
+		let value = query[ key ];
 
 		switch ( key ) {
 			case 'page':
@@ -73,6 +73,8 @@ export function getQueryParts( query ) {
 				// Example: Asking for titles in posts without title support.
 				if ( key === '_fields' ) {
 					parts.fields = getNormalizedCommaSeparable( value );
+					// Make sure to normalize value for `stableKey`
+					value = parts.fields.join();
 				}
 
 				// While it could be any deterministic string, for simplicity's

diff --git a/packages/core-data/src/queried-data/test/get-query-parts.js b/packages/core-data/src/queried-data/test/get-query-parts.js
@@ -79,4 +79,16 @@ describe( 'getQueryParts', () => {
 			include: null,
 		} );
 	} );
+
+	it( 'encodes stable string key with fields parameters', () => {
+		const parts = getQueryParts( { _fields: [ 'id', 'title' ] } );
+
+		expect( parts ).toEqual( {
+			page: 1,
+			perPage: 10,
+			stableKey: '_fields=id%2Ctitle',
+			fields: [ 'id', 'title' ],
+			include: null,
+		} );
+	} );
 } );
diff --git a/packages/core-data/src/queried-data/test/selectors.js b/packages/core-data/src/queried-data/test/selectors.js
@@ -94,7 +94,7 @@ describe( 'getQueriedItems', () => {
 				2: true,
 			},
 			queries: {
-				'_fields%5B0%5D=content': [ 1, 2 ],
+				'_fields=content': [ 1, 2 ],
 			},
 		};
 
@@ -133,7 +133,7 @@ describe( 'getQueriedItems', () => {
 				2: true,
 			},
 			queries: {
-				'_fields%5B0%5D=content&_fields%5B1%5D=meta.template': [ 1, 2 ],
+				'_fields=content%2Cmeta.template': [ 1, 2 ],
 			},
 		};
 

diff --git a/packages/core-data/src/test/selectors.js b/packages/core-data/src/test/selectors.js
@@ -247,6 +247,75 @@ describe( 'getEntityRecords', () => {
 			{ slug: 'page' },
 		] );
 	} );
+
+	it( 'should return filtered items', () => {
+		const state = deepFreeze( {
+			entities: {
+				data: {
+					postType: {
+						post: {
+							queriedData: {
+								items: {
+									1: {
+										id: 1,
+										content: 'chicken',
+										author: 'bob',
+									},
+								},
+								itemIsComplete: {
+									1: true,
+								},
+								queries: {
+									'_fields=id%2Ccontent': [ 1 ],
+								},
+							},
+						},
+					},
+				},
+			},
+		} );
+		expect(
+			getEntityRecords( state, 'postType', 'post', {
+				_fields: [ 'id', 'content' ],
+			} )
+		).toEqual( [ { id: 1, content: 'chicken' } ] );
+	} );
+
+	it( 'should return the same instance with the same arguments', () => {
+		let state = deepFreeze( {
+			entities: {
+				data: {},
+			},
+		} );
+
+		const postTypeFirstRecords = getEntityRecords(
+			state,
+			'root',
+			'postType'
+		);
+		const wpBlockFirstRecords = getEntityRecords(
+			state,
+			'postType',
+			'wp_block'
+		);
+
+		// Simulate update states
+		state = { ...state };
+
+		const postTypeSecondRecords = getEntityRecords(
+			state,
+			'root',
+			'postType'
+		);
+		const wpBlockSecondRecords = getEntityRecords(
+			state,
+			'postType',
+			'wp_block'
+		);
+
+		expect( postTypeFirstRecords ).toBe( postTypeSecondRecords );
+		expect( wpBlockFirstRecords ).toBe( wpBlockSecondRecords );
+	} );
 } );
 
 describe( '__experimentalGetDirtyEntityRecords', () => {