@wordpress/data 6.4.1 → 6.5.0

package/src/plugins/persistence/test/index.js

@@ -9,8 +9,8 @@ import deepFreeze from 'deep-freeze';
 import plugin, {
 	createPersistenceInterface,
 	withLazySameState,
-	migrateFeaturePreferencesToInterfaceStore,
 	migrateFeaturePreferencesToPreferencesStore,
+	migrateThirdPartyFeaturePreferencesToPreferencesStore,
 	migrateIndividualPreferenceToPreferencesStore,
 } from '../';
 import objectStorage from '../storage/object';
@@ -384,13 +384,13 @@ describe( 'persistence', () => {
 	} );
 } );
 
-describe( 'migrateFeaturePreferencesToInterfaceStore', () => {
-	it( 'migrates preferences from the source to the interface store', () => {
+describe( 'migrateFeaturePreferencesToPreferencesStore', () => {
+	it( 'migrates multiple preferences from persisted source stores to preferences', () => {
 		const persistenceInterface = createPersistenceInterface( {
 			storageKey: 'test-username',
 		} );
 
-		const initialState = {
+		const sourceStateA = {
 			preferences: {
 				features: {
 					featureA: true,
@@ -400,26 +400,50 @@ describe( 'migrateFeaturePreferencesToInterfaceStore', () => {
 			},
 		};
 
-		persistenceInterface.set( 'core/test', initialState );
+		const sourceStateB = {
+			preferences: {
+				features: {
+					featureD: true,
+					featureE: false,
+					featureF: true,
+				},
+			},
+		};
+
+		persistenceInterface.set( 'core/test-a', sourceStateA );
+		persistenceInterface.set( 'core/test-b', sourceStateB );
 
-		migrateFeaturePreferencesToInterfaceStore(
+		migrateFeaturePreferencesToPreferencesStore(
 			persistenceInterface,
-			'core/test'
+			'core/test-a'
+		);
+
+		migrateFeaturePreferencesToPreferencesStore(
+			persistenceInterface,
+			'core/test-b'
 		);
 
 		expect( persistenceInterface.get() ).toEqual( {
-			'core/interface': {
+			'core/preferences': {
 				preferences: {
-					features: {
-						'core/test': {
-							featureA: true,
-							featureB: false,
-							featureC: true,
-						},
+					'core/test-a': {
+						featureA: true,
+						featureB: false,
+						featureC: true,
+					},
+					'core/test-b': {
+						featureD: true,
+						featureE: false,
+						featureF: true,
 					},
 				},
 			},
-			'core/test': {
+			'core/test-a': {
+				preferences: {
+					features: undefined,
+				},
+			},
+			'core/test-b': {
 				preferences: {
 					features: undefined,
 				},
@@ -427,12 +451,12 @@ describe( 'migrateFeaturePreferencesToInterfaceStore', () => {
 		} );
 	} );
 
-	it( 'handles multiple preferences from different stores to be migrated', () => {
+	it( 'migrates multiple preferences from the persisted interface store to preferences, with interface state taking precedence over source stores', () => {
 		const persistenceInterface = createPersistenceInterface( {
 			storageKey: 'test-username',
 		} );
 
-		const initialStateA = {
+		const sourceStateA = {
 			preferences: {
 				features: {
 					featureA: true,
@@ -442,7 +466,7 @@ describe( 'migrateFeaturePreferencesToInterfaceStore', () => {
 			},
 		};
 
-		const initialStateB = {
+		const sourceStateB = {
 			preferences: {
 				features: {
 					featureD: true,
@@ -452,33 +476,63 @@ describe( 'migrateFeaturePreferencesToInterfaceStore', () => {
 			},
 		};
 
-		persistenceInterface.set( 'core/test-a', initialStateA );
-		persistenceInterface.set( 'core/test-b', initialStateB );
+		const interfaceState = {
+			otherData: {
+				test: 1,
+			},
+			preferences: {
+				features: {
+					'core/test-a': {
+						featureG: true,
+						featureH: false,
+						featureI: true,
+					},
+					'core/test-b': {
+						featureJ: true,
+						featureK: false,
+						featureL: true,
+					},
+				},
+			},
+		};
 
-		migrateFeaturePreferencesToInterfaceStore(
+		persistenceInterface.set( 'core/test-a', sourceStateA );
+		persistenceInterface.set( 'core/test-b', sourceStateB );
+		persistenceInterface.set( 'core/interface', interfaceState );
+
+		migrateFeaturePreferencesToPreferencesStore(
 			persistenceInterface,
 			'core/test-a'
 		);
 
-		migrateFeaturePreferencesToInterfaceStore(
+		migrateFeaturePreferencesToPreferencesStore(
 			persistenceInterface,
 			'core/test-b'
 		);
 
 		expect( persistenceInterface.get() ).toEqual( {
+			'core/preferences': {
+				preferences: {
+					'core/test-a': {
+						featureG: true,
+						featureH: false,
+						featureI: true,
+					},
+					'core/test-b': {
+						featureJ: true,
+						featureK: false,
+						featureL: true,
+					},
+				},
+			},
 			'core/interface': {
+				otherData: {
+					test: 1,
+				},
 				preferences: {
 					features: {
-						'core/test-a': {
-							featureA: true,
-							featureB: false,
-							featureC: true,
-						},
-						'core/test-b': {
-							featureD: true,
-							featureE: false,
-							featureF: true,
-						},
+						'core/test-a': undefined,
+						'core/test-b': undefined,
 					},
 				},
 			},
@@ -495,23 +549,67 @@ describe( 'migrateFeaturePreferencesToInterfaceStore', () => {
 		} );
 	} );
 
-	describe( 'migrateFeaturePreferencesToPreferencesStore', () => {
-		it( 'migrates multiple preferences from persisted source stores to preferences', () => {
-			const persistenceInterface = createPersistenceInterface( {
-				storageKey: 'test-username',
-			} );
+	it( 'only migrates persisted preference data for the source name from source stores', () => {
+		const persistenceInterface = createPersistenceInterface( {
+			storageKey: 'test-username',
+		} );
 
-			const sourceStateA = {
+		const sourceStateA = {
+			otherData: {
+				test: 1,
+			},
+			preferences: {
+				features: {
+					featureA: true,
+					featureB: false,
+					featureC: true,
+				},
+			},
+		};
+
+		const sourceStateB = {
+			otherData: {
+				test: 2,
+			},
+			preferences: {
+				features: {
+					featureD: true,
+					featureE: false,
+					featureF: true,
+				},
+			},
+		};
+
+		persistenceInterface.set( 'core/test-a', sourceStateA );
+		persistenceInterface.set( 'core/test-b', sourceStateB );
+
+		migrateFeaturePreferencesToPreferencesStore(
+			persistenceInterface,
+			'core/test-a'
+		);
+
+		expect( persistenceInterface.get() ).toEqual( {
+			'core/preferences': {
 				preferences: {
-					features: {
+					'core/test-a': {
 						featureA: true,
 						featureB: false,
 						featureC: true,
 					},
 				},
-			};
-
-			const sourceStateB = {
+			},
+			'core/test-a': {
+				otherData: {
+					test: 1,
+				},
+				preferences: {
+					features: undefined,
+				},
+			},
+			'core/test-b': {
+				otherData: {
+					test: 2,
+				},
 				preferences: {
 					features: {
 						featureD: true,
@@ -519,113 +617,53 @@ describe( 'migrateFeaturePreferencesToInterfaceStore', () => {
 						featureF: true,
 					},
 				},
-			};
-
-			persistenceInterface.set( 'core/test-a', sourceStateA );
-			persistenceInterface.set( 'core/test-b', sourceStateB );
-
-			migrateFeaturePreferencesToPreferencesStore(
-				persistenceInterface,
-				'core/test-a'
-			);
+			},
+		} );
+	} );
 
-			migrateFeaturePreferencesToPreferencesStore(
-				persistenceInterface,
-				'core/test-b'
-			);
+	it( 'only migrates persisted data for the source name from interface', () => {
+		const persistenceInterface = createPersistenceInterface( {
+			storageKey: 'test-username',
+		} );
 
-			expect( persistenceInterface.get() ).toEqual( {
-				'core/preferences': {
-					preferences: {
-						'core/test-a': {
-							featureA: true,
-							featureB: false,
-							featureC: true,
-						},
-						'core/test-b': {
-							featureD: true,
-							featureE: false,
-							featureF: true,
-						},
-					},
-				},
-				'core/test-a': {
-					preferences: {
-						features: undefined,
+		const interfaceState = {
+			preferences: {
+				features: {
+					'core/test-a': {
+						featureG: true,
+						featureH: false,
+						featureI: true,
 					},
-				},
-				'core/test-b': {
-					preferences: {
-						features: undefined,
+					'core/test-b': {
+						featureJ: true,
+						featureK: false,
+						featureL: true,
 					},
 				},
-			} );
-		} );
+			},
+		};
 
-		it( 'migrates multiple preferences from the persisted interface store to preferences, with interface state taking precedence over source stores', () => {
-			const persistenceInterface = createPersistenceInterface( {
-				storageKey: 'test-username',
-			} );
+		persistenceInterface.set( 'core/interface', interfaceState );
 
-			const sourceStateA = {
-				preferences: {
-					features: {
-						featureA: true,
-						featureB: false,
-						featureC: true,
-					},
-				},
-			};
+		migrateFeaturePreferencesToPreferencesStore(
+			persistenceInterface,
+			'core/test-a'
+		);
 
-			const sourceStateB = {
+		expect( persistenceInterface.get() ).toEqual( {
+			'core/preferences': {
 				preferences: {
-					features: {
-						featureD: true,
-						featureE: false,
-						featureF: true,
+					'core/test-a': {
+						featureG: true,
+						featureH: false,
+						featureI: true,
 					},
 				},
-			};
-
-			const interfaceState = {
+			},
+			'core/interface': {
 				preferences: {
 					features: {
-						'core/test-a': {
-							featureG: true,
-							featureH: false,
-							featureI: true,
-						},
-						'core/test-b': {
-							featureJ: true,
-							featureK: false,
-							featureL: true,
-						},
-					},
-				},
-			};
-
-			persistenceInterface.set( 'core/test-a', sourceStateA );
-			persistenceInterface.set( 'core/test-b', sourceStateB );
-			persistenceInterface.set( 'core/interface', interfaceState );
-
-			migrateFeaturePreferencesToPreferencesStore(
-				persistenceInterface,
-				'core/test-a'
-			);
-
-			migrateFeaturePreferencesToPreferencesStore(
-				persistenceInterface,
-				'core/test-b'
-			);
-
-			expect( persistenceInterface.get() ).toEqual( {
-				'core/preferences': {
-					preferences: {
-						'core/test-a': {
-							featureG: true,
-							featureH: false,
-							featureI: true,
-						},
+						'core/test-a': undefined,
 						'core/test-b': {
 							featureJ: true,
 							featureK: false,
@@ -633,268 +671,255 @@ describe( 'migrateFeaturePreferencesToInterfaceStore', () => {
 						},
 					},
 				},
-				'core/interface': {
-					preferences: {
-						features: {
-							'core/test-a': undefined,
-							'core/test-b': undefined,
-						},
-					},
-				},
-				'core/test-a': {
-					preferences: {
-						features: undefined,
-					},
-				},
-				'core/test-b': {
-					preferences: {
-						features: undefined,
-					},
-				},
-			} );
+			},
 		} );
+	} );
+} );
 
-		it( 'only migrates persisted data for the source name from source stores', () => {
-			const persistenceInterface = createPersistenceInterface( {
-				storageKey: 'test-username',
-			} );
+describe( 'migrateIndividualPreferenceToPreferencesStore', () => {
+	it( 'migrates an individual preference from the source to the preferences store', () => {
+		const persistenceInterface = createPersistenceInterface( {
+			storageKey: 'test-username',
+		} );
+
+		const initialState = {
+			preferences: {
+				myPreference: '123',
+			},
+		};
+
+		persistenceInterface.set( 'core/test', initialState );
+
+		migrateIndividualPreferenceToPreferencesStore(
+			persistenceInterface,
+			'core/test',
+			'myPreference'
+		);
 
-			const sourceStateA = {
+		expect( persistenceInterface.get() ).toEqual( {
+			'core/preferences': {
 				preferences: {
-					features: {
-						featureA: true,
-						featureB: false,
-						featureC: true,
+					'core/test': {
+						myPreference: '123',
 					},
 				},
-			};
-
-			const sourceStateB = {
+			},
+			'core/test': {
 				preferences: {
-					features: {
-						featureD: true,
-						featureE: false,
-						featureF: true,
-					},
+					myPreference: undefined,
 				},
-			};
+			},
+		} );
+	} );
 
-			persistenceInterface.set( 'core/test-a', sourceStateA );
-			persistenceInterface.set( 'core/test-b', sourceStateB );
+	it( 'does not overwrite other preferences in the preferences store', () => {
+		const persistenceInterface = createPersistenceInterface( {
+			storageKey: 'test-username',
+		} );
 
-			migrateFeaturePreferencesToPreferencesStore(
-				persistenceInterface,
-				'core/test-a'
-			);
+		const initialState = {
+			otherData: {
+				test: 1,
+			},
+			preferences: {
+				myPreference: '123',
+			},
+		};
 
-			expect( persistenceInterface.get() ).toEqual( {
-				'core/preferences': {
-					preferences: {
-						'core/test-a': {
-							featureA: true,
-							featureB: false,
-							featureC: true,
-						},
-					},
-				},
-				'core/test-a': {
-					preferences: {
-						features: undefined,
-					},
+		persistenceInterface.set( 'core/test', initialState );
+		persistenceInterface.set( 'core/preferences', {
+			preferences: {
+				'core/other-store': {
+					preferenceA: 1,
+					preferenceB: 2,
 				},
-				'core/test-b': {
-					preferences: {
-						features: {
-							featureD: true,
-							featureE: false,
-							featureF: true,
-						},
-					},
+				'core/test': {
+					unrelatedPreference: 'unrelated-value',
 				},
-			} );
+			},
 		} );
 
-		it( 'only migrates persisted data for the source name from interface', () => {
-			const persistenceInterface = createPersistenceInterface( {
-				storageKey: 'test-username',
-			} );
+		migrateIndividualPreferenceToPreferencesStore(
+			persistenceInterface,
+			'core/test',
+			'myPreference'
+		);
 
-			const interfaceState = {
+		expect( persistenceInterface.get() ).toEqual( {
+			'core/preferences': {
 				preferences: {
-					features: {
-						'core/test-a': {
-							featureG: true,
-							featureH: false,
-							featureI: true,
-						},
-						'core/test-b': {
-							featureJ: true,
-							featureK: false,
-							featureL: true,
-						},
+					'core/other-store': {
+						preferenceA: 1,
+						preferenceB: 2,
 					},
-				},
-			};
-
-			persistenceInterface.set( 'core/interface', interfaceState );
-
-			migrateFeaturePreferencesToPreferencesStore(
-				persistenceInterface,
-				'core/test-a'
-			);
-
-			expect( persistenceInterface.get() ).toEqual( {
-				'core/preferences': {
-					preferences: {
-						'core/test-a': {
-							featureG: true,
-							featureH: false,
-							featureI: true,
-						},
+					'core/test': {
+						unrelatedPreference: 'unrelated-value',
+						myPreference: '123',
 					},
 				},
-				'core/interface': {
-					preferences: {
-						features: {
-							'core/test-a': undefined,
-							'core/test-b': {
-								featureJ: true,
-								featureK: false,
-								featureL: true,
-							},
-						},
-					},
+			},
+			'core/test': {
+				otherData: {
+					test: 1,
 				},
-			} );
-		} );
-	} );
-
-	describe( 'migrateIndividualPreferenceToPreferencesStore', () => {
-		it( 'migrates an individual preference from the source to the preferences store', () => {
-			const persistenceInterface = createPersistenceInterface( {
-				storageKey: 'test-username',
-			} );
-
-			const initialState = {
 				preferences: {
-					myPreference: '123',
+					myPreference: undefined,
 				},
-			};
+			},
+		} );
+	} );
 
-			persistenceInterface.set( 'core/test', initialState );
+	it( 'does not migrate data if there is already a matching preference key at the target', () => {
+		const persistenceInterface = createPersistenceInterface( {
+			storageKey: 'test-username',
+		} );
 
-			migrateIndividualPreferenceToPreferencesStore(
-				persistenceInterface,
-				'core/test',
-				'myPreference'
-			);
+		persistenceInterface.set( 'core/test', {
+			preferences: {
+				myPreference: '123',
+			},
+		} );
 
-			expect( persistenceInterface.get() ).toEqual( {
-				'core/preferences': {
-					preferences: {
-						'core/test': {
-							myPreference: '123',
-						},
-					},
-				},
+		persistenceInterface.set( 'core/preferences', {
+			preferences: {
 				'core/test': {
-					preferences: {
-						myPreference: undefined,
-					},
+					myPreference: 'already-set',
 				},
-			} );
+			},
 		} );
 
-		it( 'does not overwrite other preferences in the preferences store', () => {
-			const persistenceInterface = createPersistenceInterface( {
-				storageKey: 'test-username',
-			} );
+		migrateIndividualPreferenceToPreferencesStore(
+			persistenceInterface,
+			'core/test',
+			'myPreference'
+		);
 
-			const initialState = {
+		expect( persistenceInterface.get() ).toEqual( {
+			'core/preferences': {
+				preferences: {
+					'core/test': {
+						myPreference: 'already-set',
+					},
+				},
+			},
+			'core/test': {
 				preferences: {
 					myPreference: '123',
 				},
-			};
+			},
+		} );
+	} );
+} );
 
-			persistenceInterface.set( 'core/test', initialState );
-			persistenceInterface.set( 'core/preferences', {
-				preferences: {
-					'core/other-store': {
-						preferenceA: 1,
-						preferenceB: 2,
+describe( 'migrateThirdPartyFeaturePreferencesToPreferencesStore', () => {
+	it( 'migrates multiple scopes from the interface package to the preferences package', () => {
+		const persistenceInterface = createPersistenceInterface( {
+			storageKey: 'test-username',
+		} );
+
+		const interfaceState = {
+			otherData: {
+				test: 1,
+			},
+			preferences: {
+				features: {
+					'plugin-a': {
+						featureA: true,
+						featureB: false,
+						featureC: true,
 					},
-					'core/test': {
-						unrelatedPreference: 'unrelated-value',
+					'plugin-b': {
+						featureD: true,
+						featureE: false,
+						featureF: true,
 					},
 				},
-			} );
+			},
+		};
+		persistenceInterface.set( 'core/interface', interfaceState );
 
-			migrateIndividualPreferenceToPreferencesStore(
-				persistenceInterface,
-				'core/test',
-				'myPreference'
-			);
-
-			expect( persistenceInterface.get() ).toEqual( {
-				'core/preferences': {
-					preferences: {
-						'core/other-store': {
-							preferenceA: 1,
-							preferenceB: 2,
-						},
-						'core/test': {
-							unrelatedPreference: 'unrelated-value',
-							myPreference: '123',
-						},
+		migrateThirdPartyFeaturePreferencesToPreferencesStore(
+			persistenceInterface
+		);
+
+		expect( persistenceInterface.get() ).toEqual( {
+			'core/preferences': {
+				preferences: {
+					'plugin-a': {
+						featureA: true,
+						featureB: false,
+						featureC: true,
+					},
+					'plugin-b': {
+						featureD: true,
+						featureE: false,
+						featureF: true,
 					},
 				},
-				'core/test': {
-					preferences: {
-						myPreference: undefined,
+			},
+			'core/interface': {
+				otherData: {
+					test: 1,
+				},
+				preferences: {
+					features: {
+						'plugin-a': undefined,
+						'plugin-b': undefined,
 					},
 				},
-			} );
+			},
 		} );
+	} );
 
-		it( 'does not migrate data if there is already a matching preference key at the target', () => {
-			const persistenceInterface = createPersistenceInterface( {
-				storageKey: 'test-username',
-			} );
+	it( 'ignores any core scopes', () => {
+		const persistenceInterface = createPersistenceInterface( {
+			storageKey: 'test-username',
+		} );
 
-			persistenceInterface.set( 'core/test', {
-				preferences: {
-					myPreference: '123',
+		const interfaceState = {
+			preferences: {
+				features: {
+					'plugin-a': {
+						featureA: true,
+						featureB: false,
+						featureC: true,
+					},
+					'core/edit-post': {
+						featureD: true,
+						featureE: false,
+						featureF: true,
+					},
 				},
-			} );
+			},
+		};
+		persistenceInterface.set( 'core/interface', interfaceState );
 
-			persistenceInterface.set( 'core/preferences', {
+		migrateThirdPartyFeaturePreferencesToPreferencesStore(
+			persistenceInterface
+		);
+
+		expect( persistenceInterface.get() ).toEqual( {
+			'core/preferences': {
 				preferences: {
-					'core/test': {
-						myPreference: 'already-set',
+					'plugin-a': {
+						featureA: true,
+						featureB: false,
+						featureC: true,
 					},
 				},
-			} );
-
-			migrateIndividualPreferenceToPreferencesStore(
-				persistenceInterface,
-				'core/test',
-				'myPreference'
-			);
-
-			expect( persistenceInterface.get() ).toEqual( {
-				'core/preferences': {
-					preferences: {
-						'core/test': {
-							myPreference: 'already-set',
+			},
+			'core/interface': {
+				preferences: {
+					features: {
+						'plugin-a': undefined,
+						'core/edit-post': {
+							featureD: true,
+							featureE: false,
+							featureF: true,
 						},
 					},
 				},
-				'core/test': {
-					preferences: {
-						myPreference: '123',
-					},
-				},
-			} );
+			},
 		} );
 	} );
 } );