Changeset 56648

Timestamp:

09/21/2023 03:21:45 PM (15 months ago)

Author:

flixos90

Message:

Options, Meta APIs: Add further test coverage for comparison between old and new option value.

This ensures potential future changes to the logic are covered by existing tests that should pass before and after.

Props joemcgill.
See #22192.

File:

• trunk/tests/phpunit/tests/option/option.php (modified) (1 diff)

trunk/tests/phpunit/tests/option/option.php

@@ -369 +369 @@
         );
     }
+
+    /**
+     * Ensure the database is getting updated when type changes, but not otherwise.
+     *
+     * @ticket 22192
+     *
+     * @covers ::update_option
+     *
+     * @dataProvider data_update_option_type_juggling
+     */
+    public function test_update_loosey_options( $old_value, $new_value, $update = false ) {
+        add_option( 'foo', $old_value );
+
+        // Comparison will happen against value cached during add_option() above.
+        $updated = update_option( 'foo', $new_value );
+
+        if ( $update ) {
+            $this->assertTrue( $updated, 'This loosely equal option should trigger an update.' );
+        } else {
+            $this->assertFalse( $updated, 'Loosely equal option should not trigger an update.' );
+        }
+    }
+
+    /**
+     * Ensure the database is getting updated when type changes, but not otherwise.
+     *
+     * @ticket 22192
+     *
+     * @covers ::update_option
+     *
+     * @dataProvider data_update_option_type_juggling
+     */
+    public function test_update_loosey_options_from_db( $old_value, $new_value, $update = false ) {
+        add_option( 'foo', $old_value );
+
+        // Delete cache.
+        wp_cache_delete( 'alloptions', 'options' );
+        $updated = update_option( 'foo', $new_value );
+
+        if ( $update ) {
+            $this->assertTrue( $updated, 'This loosely equal option should trigger an update.' );
+        } else {
+            $this->assertFalse( $updated, 'Loosely equal option should not trigger an update.' );
+        }
+    }
+
+    /**
+     * Ensure the database is getting updated when type changes, but not otherwise.
+     *
+     * @ticket 22192
+     *
+     * @covers ::update_option
+     *
+     * @dataProvider data_update_option_type_juggling
+     */
+    public function test_update_loosey_options_from_refreshed_cache( $old_value, $new_value, $update = false ) {
+        add_option( 'foo', $old_value );
+
+        // Delete and refresh cache from DB.
+        wp_cache_delete( 'alloptions', 'options' );
+        wp_load_alloptions();
+
+        $updated = update_option( 'foo', $new_value );
+
+        if ( $update ) {
+            $this->assertTrue( $updated, 'This loosely equal option should trigger an update.' );
+        } else {
+            $this->assertFalse( $updated, 'Loosely equal option should not trigger an update.' );
+        }
+    }
+
+
+    /**
+     * Data provider.
+     *
+     * @return array
+     */
+    public function data_update_option_type_juggling() {
+        return array(
+            /*
+             * Truthy values.
+             * Loosely equal truthy scalar values should never result in a DB update.
+             */
+            array( '1', '1' ),
+            array( '1', 1 ),
+            array( '1', 1.0 ),
+            array( '1', true ),
+            array( 1, '1' ),
+            array( 1, 1 ),
+            array( 1, 1.0 ),
+            array( 1, true ),
+            array( 1.0, '1' ),
+            array( 1.0, 1 ),
+            array( 1.0, 1.0 ),
+            array( 1.0, true ),
+            array( true, '1' ),
+            array( true, 1 ),
+            array( true, 1.0 ),
+            array( true, true ),
+
+            /*
+             * Falsey values.
+             * Loosely equal falsey scalar values only sometimes result in a DB update.
+             */
+            array( '0', '0' ),
+            array( '0', 0 ),
+            array( '0', 0.0 ),
+            array( '0', false, true ), // Should update.
+            array( '', '' ),
+            array( '', 0, true ), // Should update.
+            array( '', 0.0, true ), // Should update.
+            array( '', false ),
+            array( 0, '0' ),
+            array( 0, '', true ), // Should update.
+            array( 0, 0 ),
+            array( 0, 0.0 ),
+            array( 0, false, true ), // Should update.
+            array( 0.0, '0' ),
+            array( 0.0, '', true ), // Should update.
+            array( 0.0, 0 ),
+            array( 0.0, 0.0 ),
+            array( 0.0, false, true ), // Should update.
+            array( false, '0', true ), // Should update.
+            array( false, '' ),
+            array( false, 0, true ), // Should update.
+            array( false, 0.0, true ), // Should update.
+            array( false, false ),
+
+            /*
+             * Non scalar values.
+             * Loosely equal non-scalar values should almost always result in an update.
+             */
+            array( false, array(), true ),
+            array( 'false', array(), true ),
+            array( '', array(), true ),
+            array( 0, array(), true ),
+            array( '0', array(), true ),
+            array( false, null ), // Does not update.
+            array( 'false', null, true ),
+            array( '', null ), // Does not update.
+            array( 0, null, true ),
+            array( '0', null, true ),
+            array( array(), false, true ),
+            array( array(), 'false', true ),
+            array( array(), '', true ),
+            array( array(), 0, true ),
+            array( array(), '0', true ),
+            array( array(), null, true ),
+            array( null, false ), // Does not update.
+            array( null, 'false', true ),
+            array( null, '' ), // Does not update.
+            array( null, 0, true ),
+            array( null, '0', true ),
+            array( null, array(), true ),
+        );
+    }
 }