Builder: refuse a layout whose rows, cells or widgets are not lists

The loader now checks the same top-level shape the server accepts before
building rows, so a stored value with a non-list member locks the builder
instead of presenting an empty one that an edit could save over the stored
layout. The nested widget test now proves sanitize_all() runs on an array
layout and does not run on the preserving paths.

Author: Misplon

js/siteorigin-panels/model/builder.js

@@ -97,14 +97,25 @@ module.exports = Backbone.Model.extend({
 				// what is stored.
 				var isEmptyContainer = ! _.isNull( data ) && typeof data === 'object' && _.isEmpty( data );
 
-				if ( data !== false && ! _.isUndefined( data ) && ! isEmptyContainer ) {
+				if ( data !== false && ! isEmptyContainer ) {
 					throw new Error( 'Layout data has no grid cells' );
 				}
 
 				this.finishLoad();
 				return;
 			}
 
+			// The same shape the server accepts: rows and cells are lists, and so
+			// are the widgets when present. Anything else is not a layout, and an
+			// unlocked empty builder would let an edit replace what is stored.
+			if (
+				! _.isArray( data.grid_cells ) ||
+				! _.isArray( data.grids ) ||
+				( ! _.isUndefined( data.widgets ) && ! _.isArray( data.widgets ) )
+			) {
+				throw new Error( 'Layout data is not a layout' );
+			}
+
 			var gi;
 			for ( var ci = 0; ci < data.grid_cells.length; ci ++ ) {
 				gi = parseInt( data.grid_cells[ci].grid );

tests/js/builder-load-failure.test.js

@@ -260,6 +260,26 @@ test( 'a scalar, a non-empty list or an unrelated object is a failed load', func
 	} );
 } );
 
+test( 'a layout-shaped object with a non-list member is a failed load', function () {
+	[
+		{ grids: 'x', grid_cells: [] },
+		{ grids: [], grid_cells: 1 },
+		{ widgets: '', grids: [], grid_cells: [] },
+		{ grids: [ { cells: 1, style: {} } ], grid_cells: { 0: { grid: 0, index: 0, weight: 1 } } }
+	].forEach( function ( bad ) {
+		const model = builder();
+		const events = countEvents( model );
+
+		model.loadPanelsData( bad );
+
+		assert.equal( model.loadFailed, true, JSON.stringify( bad ) );
+		assert.equal( events.load_panels_data, 0, JSON.stringify( bad ) );
+
+		model.refreshPanelsData();
+		assert.equal( events[ 'change:data' ], 0, JSON.stringify( bad ) );
+	} );
+} );
+
 test( 'an empty object or list is a successful empty load', function () {
 	[ {}, [] ].forEach( function ( empty ) {
 		const model = builder();

tests/save-post/SavePostMalformedPayloadTest.php

@@ -57,11 +57,12 @@ private function require_admin_class() {
 			eval(
 				'class SiteOrigin_Panels_Styles_Admin {'
 				. ' private static $instance;'
+				. ' public static $sanitize_calls = 0;'
 				. ' public static function single() {'
 				. '   if ( empty( self::$instance ) ) { self::$instance = new self(); }'
 				. '   return self::$instance;'
 				. ' }'
-				. ' public function sanitize_all( $panels_data ) { return $panels_data; }'
+				. ' public function sanitize_all( $panels_data ) { self::$sanitize_calls++; return $panels_data; }'
 				. '}'
 			);
 		}
@@ -353,11 +354,23 @@ public function test_layout_widget_returns_old_instance_on_malformed_string() {
 	public function test_layout_widget_still_sanitizes_an_array_layout() {
 		$old = array( 'builder_id' => 'old', 'panels_data' => array() );
 		$new = array( 'panels_data' => $this->valid_layout() );
+		$calls_before = \SiteOrigin_Panels_Styles_Admin::$sanitize_calls;
 
 		$updated = $this->widget()->update( $new, $old );
 
 		$this->assertSame( $this->valid_layout(), $updated['panels_data'] );
 		$this->assertNotSame( 'old', $updated['builder_id'] );
+		$this->assertSame( $calls_before + 1, \SiteOrigin_Panels_Styles_Admin::$sanitize_calls, 'sanitize_all() ran on the array layout' );
+	}
+
+	public function test_layout_widget_does_not_sanitize_when_the_field_is_absent_or_refused() {
+		$old = array( 'builder_id' => 'old', 'panels_data' => $this->valid_layout() );
+		$calls_before = \SiteOrigin_Panels_Styles_Admin::$sanitize_calls;
+
+		$this->widget()->update( array( 'title' => 'x' ), $old );
+		$this->widget()->update( array( 'panels_data' => '{bad' ), $old );
+
+		$this->assertSame( $calls_before, \SiteOrigin_Panels_Styles_Admin::$sanitize_calls, 'nothing to sanitize on the preserving paths' );
 	}
 
 	public function test_layout_widget_decodes_a_valid_string_layout() {