Stabilize isPreviewMode flag

packages/block-editor/src/components/provider/test/experimental-provider.js

@@ -5,7 +5,7 @@ import { render } from '@testing-library/react';
 /**
  * WordPress dependencies
  */
-import { useRegistry } from '@wordpress/data';
+import { useRegistry, useSelect } from '@wordpress/data';
 
 /**
  * Internal dependencies
@@ -21,6 +21,20 @@ const HasEditorSetting = ( props ) => {
 	return <p>Test.</p>;
 };
 
+const PreviewModeGetter = () => {
+	const previewModeKeys = useSelect( ( select ) => {
+		const { getSettings } = select( blockEditorStore );
+		const settings = getSettings();
+		return {
+			// This property will be removed in the future. There is a test that asserts we're throwing a deprecation warning.
+			__unstableIsPreviewMode: settings.__unstableIsPreviewMode,
+			isPreviewMode: settings.isPreviewMode,
+		};
+	}, [] );
+
+	return <>{ JSON.stringify( previewModeKeys ) }</>;
+};
+
 describe( 'BlockEditorProvider', () => {
 	let registry;
 	const setRegistry = ( reg ) => {
@@ -58,6 +72,34 @@ describe( 'BlockEditorProvider', () => {
 		const settings = registry.select( blockEditorStore ).getSettings();
 		expect( settings ).toHaveProperty( 'stableSetting' );
 	} );
+	it( 'preserves deprecated getters incoming from the settings reducer', async () => {
+		const consoleWarn = jest
+			.spyOn( global.console, 'warn' )
+			.mockImplementation();
+
+		const { container } = render(
+			<BlockEditorProvider
+				settings={ {
+					isPreviewMode: true,
+				} }
+			>
+				<PreviewModeGetter />
+			</BlockEditorProvider>
+		);
+
+		expect( container ).toHaveTextContent(
+			JSON.stringify( {
+				__unstableIsPreviewMode: true,
+				isPreviewMode: true,
+			} )
+		);
+
+		expect( consoleWarn ).toHaveBeenCalledWith(
+			'__unstableIsPreviewMode is deprecated since version 6.8. Please use isPreviewMode instead.'
+		);
+
+		consoleWarn.mockRestore();
+	} );
 } );
 
 describe( 'ExperimentalBlockEditorProvider', () => {

packages/block-editor/src/store/actions.js

@@ -1591,7 +1591,23 @@ export function updateBlockListSettings( clientId, settings ) {
  * @return {Object} Action object
  */
 export function updateSettings( settings ) {
-	return __experimentalUpdateSettings( settings, {
+	let updatedSettings = settings;
+
+	if ( Object.hasOwn( updatedSettings, '__unstableIsPreviewMode' ) ) {
+		deprecated(
+			"__unstableIsPreviewMode argument in wp.data.dispatch('core/block-editor').updateSettings",
+			{
+				since: '6.8',
+				alternative: 'isPreviewMode',
+			}
+		);
+
+		updatedSettings = { ...updatedSettings };
+		updatedSettings.isPreviewMode = updatedSettings.__unstableIsPreviewMode;
+		delete updatedSettings.__unstableIsPreviewMode;
+	}
+
+	return __experimentalUpdateSettings( updatedSettings, {
 		stripExperimentalSettings: true,
 	} );
 }

packages/block-editor/src/store/reducer.js

@@ -1675,7 +1675,7 @@ export function settings( state = SETTINGS_DEFAULTS, action ) {
 			Object.defineProperty( updatedSettings, '__unstableIsPreviewMode', {
 				get() {
 					deprecated( '__unstableIsPreviewMode', {
-						since: '19.5',
+						since: '6.8',
 						alternative: 'isPreviewMode',
 					} );
 

packages/block-editor/src/store/test/actions.js

@@ -1125,6 +1125,47 @@ describe( 'actions', () => {
 		} );
 	} );
 
+	describe( 'updateSettings', () => {
+		it( 'warns when setting the deprecated __unstableIsPreviewMode property and sets the stable property instead', () => {
+			const consoleWarn = jest
+				.spyOn( global.console, 'warn' )
+				.mockImplementation();
+
+			const store = createRegistry().registerStore(
+				blockEditorStoreName,
+				{
+					actions,
+					selectors,
+					reducer,
+				}
+			);
+
+			store.dispatch(
+				updateSettings( {
+					__unstableIsPreviewMode: true,
+				} )
+			);
+
+			expect( consoleWarn ).toHaveBeenCalledWith(
+				"__unstableIsPreviewMode argument in wp.data.dispatch('core/block-editor').updateSettings is deprecated since version 6.8. Please use isPreviewMode instead."
+			);
+
+			consoleWarn.mockClear();
+
+			expect( store.getState().settings.__unstableIsPreviewMode ).toBe(
+				true
+			);
+
+			expect( store.getState().settings.isPreviewMode ).toBe( true );
+
+			expect( consoleWarn ).toHaveBeenCalledWith(
+				'__unstableIsPreviewMode is deprecated since version 6.8. Please use isPreviewMode instead.'
+			);
+
+			consoleWarn.mockRestore();
+		} );
+	} );
+
 	describe( 'registerInserterMediaCategory', () => {
 		describe( 'should log errors when invalid', () => {
 			it( 'valid object', () => {

packages/block-editor/src/store/test/reducer.js

@@ -3086,7 +3086,7 @@ describe( 'state', () => {
 			expect( settingsObject.isPreviewMode ).toBeDefined();
 
 			expect( consoleWarn ).toHaveBeenCalledWith(
-				'__unstableIsPreviewMode is deprecated since version 19.5. Please use isPreviewMode instead.'
+				'__unstableIsPreviewMode is deprecated since version 6.8. Please use isPreviewMode instead.'
 			);
 
 			consoleWarn.mockRestore();