Changeset 13998

Timestamp:

08/07/2024 02:08:06 PM (2 months ago)

Author:

imath

Message:

Make sure 12.0 deprecated code is loaded until version 15.0

Version 12.0 changed BuddyPress a lot with the introduction of the BP Rewrites API. To give more time to advanced users, BP plugin or theme developers so that they make their code ready for this API, unlike how we deal with deprecated code since r13304 & for the 2 following major releases (14.0 & 15.0), we will carry on loading it to prevent potential errors.

Props emaralive, espellcaste.

See #9210 (trunk)
Closes ​https://github.com/buddypress/buddypress/pull/352

Location:

trunk

Files:

• src/bp-core/bp-core-functions.php (modified) (1 diff)
• tests/phpunit/testcases/core/functions.php (modified) (1 diff)

trunk/src/bp-core/bp-core-functions.php

@@ -5013 +5013 @@
         }
 
-        // Only load 12.0 deprecated functions.
-        return array( 12.0 );
-    }
-
-    $index_first_major = array_search( $initial_version, $deprecated_functions_versions, true );
-    if ( false === $index_first_major ) {
-        return array_splice( $deprecated_functions_versions, -2 );
-    }
-
-    $latest_deprecated_functions_versions = array_splice( $deprecated_functions_versions, $index_first_major );
-
-    if ( 2 <= count( $latest_deprecated_functions_versions ) ) {
-        $latest_deprecated_functions_versions = array_splice( $latest_deprecated_functions_versions, -2 );
-    }
-
-    $index_initial_version = array_search( $initial_version, $latest_deprecated_functions_versions, true );
-    if ( false !== $index_initial_version && 12.0 !== $initial_version ) {
-        unset( $latest_deprecated_functions_versions[ $index_initial_version ] );
-    }
-
-    return $latest_deprecated_functions_versions;
+        // Load 12.0 deprecated functions only when BP was installed with 12.0, 14.0 or 15.0.
+        if ( in_array( $initial_version, array( 12.0, 14.0, 15.0 ), true ) ) {
+            return array( 12.0 );
+        }
+
+        return array();
+    }
+
+    $keep_last = 2;
+    if ( (float) 15 >= $initial_version ) {
+        $keep_last = count( $deprecated_functions_versions ) - array_search( 12.0, $deprecated_functions_versions, true );
+    }
+
+    return array_splice( $deprecated_functions_versions, -$keep_last );
 }
 

trunk/tests/phpunit/testcases/core/functions.php

@@ -879 +879 @@
 
     /**
+     * This test acts like a reminder: $deprecated_functions_versions needs to include each versions of the `/src/bp-core/deprecated` directory.
+     *
+     * eg:  if `/src/bp-core/deprecated/15.0.php` exists, then $deprecated_functions_versions should include `15.0`.
+     *
+     * @group bp_get_deprecated_functions_versions
+     * @ticket BP9210
+     */
+    public function test_bp_get_deprecated_functions_versions_array_is_consistent_with_deprecated_files() {
+        // When current major version is the initial version, we shouldn't load any deprecated functions file.
+        $this->assertTrue( false !== bp_get_deprecated_functions_versions(), 'Please check the list of `$deprecated_functions_versions` in `bp_get_deprecated_functions_versions()`. There should be one for each file of the `/src/bp-core/deprecated` directory.' );
+    }
+
+    /**
+     * @group bp_get_deprecated_functions_versions
      * @ticket BP8687
      * @ticket BP9075
+     * @ticket BP9210
      */
     public function test_bp_get_deprecated_functions_versions() {
-        $current_version = bp_get_version();
+        $current_version = (float) bp_get_version();
         $versions        = bp_get_deprecated_functions_versions();
         $bp              = buddypress();
 
-        // When current major version is the initial version, we should only load 12.0 deprecated functions file.
-        $this->assertSame( $versions, array( 12.0 ), 'Please check the list of `$deprecated_functions_versions` in `bp_get_deprecated_functions_versions()`. There should be one for each file of the `/src/bp-core/deprecated` directory.' );
-
-        $bp->version = '12.1.1';
-
-        // We should load the 2 lasts deprecated functions files.
-        $this->bp_initial_version = '12.0';
-
         add_filter( 'pre_option__bp_initial_major_version', array( $this, 'override_initial_version' ), 10, 0 );
 
+        // Fresh install.
+        $this->bp_initial_version = $current_version;
+        $expected_versions        = array();
+
+        // Include 12.0 until version 15.0.
+        if ( $current_version <= (float) 15 ) {
+            $expected_versions = array( 12.0 );
+        }
+
         $versions = bp_get_deprecated_functions_versions();
 
-        $this->assertContains( 12.0, $versions, '12.0 deprecated functions should be loaded when 12.1.1 was the first installed version.' );
-
-        $this->bp_initial_version = '9.0';
+        $this->assertSame( $versions, $expected_versions, 'Deprecated functions are not loaded for fresh installs.' );
+
+        // BuddyPress updated from previous versions.
+        $expected_versions = array( $current_version - 1, $current_version ); // The 2 last deprecated function files.
+
+        // First BuddyPress installed version is older than 11.0. In this case, the initial version is 0.
+        // See https://buddypress.trac.wordpress.org/changeset/13304
+        $this->bp_initial_version = 0;
 
         $versions = bp_get_deprecated_functions_versions();
 
-        $this->assertContains( 12.0, $versions, '12.0 deprecated functions should be loaded when 12.0 was updated for a minor release' );
+        // Include 12.0 until version 15.0.
+        if ( $current_version <= (float) 15 ) {
+            $this->assertContains( 12.0, $versions, '12.0 deprecated functions should be loaded when first installed version is <= 15.0' );
+        } else {
+            $this->assertSame( $versions, $expected_versions, 'The last deprecated function files are loaded for updated BuddyPress.' );
+        }
+
+        // Testing with previous major version.
+        $this->bp_initial_version = $current_version - 1;
+
+        $versions = bp_get_deprecated_functions_versions();
+
+        // Include 12.0 until version 15.0.
+        if ( $current_version <= (float) 15 ) {
+            $this->assertContains( 12.0, $versions, '12.0 deprecated functions should be loaded when first installed version is <= 15.0' );
+        } else {
+            $this->assertSame( $versions, $expected_versions, 'The last deprecated function files are loaded for updated BuddyPress.' );
+        }
+
+        // Testing with 2 versions older.
+        $this->bp_initial_version = (float) 15 === $current_version ? (float) 12 : $current_version - 2;
+
+        $versions = bp_get_deprecated_functions_versions();
+
+        // Include 12.0 until version 15.0.
+        if ( $current_version <= (float) 15 ) {
+            $this->assertContains( 12.0, $versions, '12.0 deprecated functions should be loaded when first installed version is <= 15.0' );
+        } else {
+            $this->assertSame( $versions, $expected_versions, 'The last deprecated function files are loaded for updated BuddyPress.' );
+        }
 
         remove_filter( 'pre_option__bp_initial_major_version', array( $this, 'override_initial_version' ), 10, 0 );
-
-        $bp->version = $current_version;
-
-        // We should load the 2 lasts deprecated functions files.
-        $this->bp_initial_version = '8.0';
-
-        add_filter( 'pre_option__bp_initial_major_version', array( $this, 'override_initial_version' ), 10, 0 );
-
-        $versions = bp_get_deprecated_functions_versions();
-
-        remove_filter( 'pre_option__bp_initial_major_version', array( $this, 'override_initial_version' ), 10, 0 );
-
-        $this->assertTrue( 2 === count( $versions ) );
-
-        // Even if this version does not exist in deprecated functions files, we should load the 2 lasts.
-        $this->bp_initial_version = '1.0';
-
-        add_filter( 'pre_option__bp_initial_major_version', array( $this, 'override_initial_version' ), 10, 0 );
-
-        $versions = bp_get_deprecated_functions_versions();
-
-        remove_filter( 'pre_option__bp_initial_major_version', array( $this, 'override_initial_version' ), 10, 0 );
-
-        $this->assertTrue( 2 === count( $versions ) );
     }