Interactivity API: Prevent non-object state from being added (#59886)

Ensure that `state` is an object when creating a store for a given namespace. `store.state` is expected to be an object. There is code that prevents state from being updated if it is not an object, but it's possible to set the state to a non-object initially, which breaks subsequent updates. Co-authored-by: sirreal <[email protected]> Co-authored-by: DAreRodz <[email protected]>
WordPress · Mar 18, 2024 · 50c9d80 · 50c9d80
1 parent 37a8390
commit 50c9d80
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 7 deletions.
diff --git a/packages/e2e-tests/plugins/interactive-blocks/store/render.php b/packages/e2e-tests/plugins/interactive-blocks/store/render.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * HTML for testing the directive `data-wp-bind`.
+ * HTML for testing the `store` function.
  *
  * @package gutenberg-test-interactive-blocks
  */
@@ -9,6 +9,7 @@
 ?>
 
 <div data-wp-interactive="test/store">
+	<div data-wp-text="state.0" data-testid="state-0"></div>
 	<div
 		data-testid="non-plain object"
 		data-wp-text="state.isNotProxified"

diff --git a/packages/e2e-tests/plugins/interactive-blocks/store/view.js b/packages/e2e-tests/plugins/interactive-blocks/store/view.js
@@ -3,18 +3,21 @@
  */
 import { store, getElement } from '@wordpress/interactivity';
 
+// A non-object state should never be allowed.
+store( 'test/store', { state: [ 'wrong' ] } );
 
 const { state } = store( 'test/store', {
 	state: {
+		0: 'right',
 		get isNotProxified() {
 			const { ref } = getElement();
 			return state.elementRef === ref;
-		}
+		},
 	},
 	callbacks: {
 		init() {
 			const { ref } = getElement();
 			state.elementRef = ref; // HTMLElement
-		}
-	}
-} )
+		},
+	},
+} );
diff --git a/packages/interactivity/CHANGELOG.md b/packages/interactivity/CHANGELOG.md
@@ -4,6 +4,7 @@
 
 ### Bug Fixes
 
+-   Prevent non-objects from being set in store state. ([#59886](https://github.com/WordPress/gutenberg/pull/59886))
 -   Ensure that stores are available for subscription before hydration. ([#59842](https://github.com/WordPress/gutenberg/pull/59842))
 -   Ensure scope is restored when catching exceptions thrown in async generator actions. ([#59708](https://github.com/WordPress/gutenberg/pull/59708))
 

diff --git a/packages/interactivity/src/store.ts b/packages/interactivity/src/store.ts
@@ -274,7 +274,10 @@ export function store(
 		if ( lock !== universalUnlock ) {
 			storeLocks.set( namespace, lock );
 		}
-		const rawStore = { state: deepSignal( state ), ...block };
+		const rawStore = {
+			state: deepSignal( isObject( state ) ? state : {} ),
+			...block,
+		};
 		const proxiedStore = new Proxy( rawStore, handlers );
 		rawStores.set( namespace, rawStore );
 		stores.set( namespace, proxiedStore );

diff --git a/test/e2e/specs/interactivity/store.spec.ts b/test/e2e/specs/interactivity/store.spec.ts
@@ -3,7 +3,7 @@
  */
 import { test, expect } from './fixtures';
 
-test.describe( 'data-wp-bind', () => {
+test.describe( 'store', () => {
 	test.beforeAll( async ( { interactivityUtils: utils } ) => {
 		await utils.activatePlugins();
 		await utils.addPostWithBlock( 'test/store' );
@@ -22,4 +22,11 @@ test.describe( 'data-wp-bind', () => {
 		const el = page.getByTestId( 'non-plain object' );
 		await expect( el ).toHaveText( 'true' );
 	} );
+
+	test( 'Ensures that state cannot be set to a non-object', async ( {
+		page,
+	} ) => {
+		const element = page.getByTestId( 'state-0' );
+		await expect( element ).toHaveText( 'right' );
+	} );
 } );