Changes that did not make their way over.

Author: desrosj

src/wp-admin/includes/schema.php

@@ -198,6 +198,7 @@ function wp_get_db_schema( $scope = 'all', $blog_id = null ) {
 	PRIMARY KEY  (id),
 	KEY type_client_id (type,client_id),
 	KEY room (room,id),
+	KEY room_type_date (room,type,date_gmt),
 	KEY date_gmt (date_gmt)
 ) $charset_collate;\n";
 

src/wp-includes/collaboration.php

@@ -7,18 +7,54 @@
  */
 
 /**
- * Checks whether real-time collaboration is enabled.
+ * Determines whether real-time collaboration is enabled.
  *
- * The feature requires both the site option and the database schema
- * introduced in db_version 61841.
+ * If the WP_ALLOW_COLLABORATION constant is false,
+ * collaboration is always disabled regardless of the database option.
+ * Otherwise, the feature requires both the 'wp_collaboration_enabled'
+ * option and the database schema introduced in db_version 61841.
  *
  * @since 7.0.0
  *
- * @return bool True if collaboration is enabled, false otherwise.
+ * @return bool Whether real-time collaboration is enabled.
  */
 function wp_is_collaboration_enabled() {
-	return get_option( 'wp_enable_real_time_collaboration' )
-		&& get_option( 'db_version' ) >= 61841;
+	return (
+		wp_is_collaboration_allowed() &&
+		get_option( 'wp_collaboration_enabled' ) &&
+		get_option( 'db_version' ) >= 61841
+	);
+}
+
+/**
+ * Determines whether real-time collaboration is allowed.
+ *
+ * If the WP_ALLOW_COLLABORATION constant is false,
+ * collaboration is not allowed and cannot be enabled.
+ * The constant defaults to true, unless the WP_ALLOW_COLLABORATION
+ * environment variable is set to string "false".
+ *
+ * @since 7.0.0
+ *
+ * @return bool Whether real-time collaboration is allowed.
+ */
+function wp_is_collaboration_allowed() {
+	if ( ! defined( 'WP_ALLOW_COLLABORATION' ) ) {
+		$env_value = getenv( 'WP_ALLOW_COLLABORATION' );
+		if ( false === $env_value ) {
+			// Environment variable is not defined, default to allowing collaboration.
+			define( 'WP_ALLOW_COLLABORATION', true );
+		} else {
+			/*
+			 * Environment variable is defined, let's confirm it is actually set to
+			 * "true" as it may still have a string value "false" – the preceeding
+			 * `if` branch only tests for the boolean `false`.
+			 */
+			define( 'WP_ALLOW_COLLABORATION', 'true' === $env_value );
+		}
+	}
+
+	return WP_ALLOW_COLLABORATION;
 }
 
 /**
@@ -65,25 +101,10 @@ function wp_delete_old_collaboration_data() {
 	if ( ! wp_is_collaboration_enabled() ) {
 		/*
 		 * Collaboration was enabled in the past but has since been disabled.
-		 * Clean up any remaining stale data and unschedule the cron job
-		 * so this callback does not continue to run.
+		 * Unschedule the cron job prior to clean up so this callback does not
+		 * continue to run.
 		 */
-		$wpdb->query(
-			$wpdb->prepare(
-				"DELETE FROM {$wpdb->collaboration} WHERE date_gmt < %s",
-				gmdate( 'Y-m-d H:i:s', time() - WEEK_IN_SECONDS )
-			)
-		);
-
-		$wpdb->query(
-			$wpdb->prepare(
-				"DELETE FROM {$wpdb->collaboration} WHERE type = 'awareness' AND date_gmt < %s",
-				gmdate( 'Y-m-d H:i:s', time() - 60 )
-			)
-		);
-
 		wp_clear_scheduled_hook( 'wp_delete_old_collaboration_data' );
-		return;
 	}
 
 	/* Clean up rows older than 7 days. */

src/wp-includes/collaboration/class-wp-collaboration-table-storage.php

@@ -56,6 +56,10 @@ class WP_Collaboration_Table_Storage {
 	public function add_update( string $room, $update ): bool {
 		global $wpdb;
 
+		if ( '' === $room || empty( $update['type'] ) || empty( $update['client_id'] ) ) {
+			return false;
+		}
+
 		$result = $wpdb->insert(
 			$wpdb->collaboration,
 			array(
@@ -64,8 +68,9 @@ public function add_update( string $room, $update ): bool {
 				'client_id' => $update['client_id'] ?? '',
 				'data'      => wp_json_encode( $update ),
 				'date_gmt'  => gmdate( 'Y-m-d H:i:s' ),
+				'user_id'   => get_current_user_id(),
 			),
-			array( '%s', '%s', '%s', '%s', '%s' )
+			array( '%s', '%s', '%s', '%s', '%s', '%d' )
 		);
 
 		return false !== $result;
@@ -286,27 +291,42 @@ public function remove_updates_through_cursor( string $room, int $cursor ): bool
 	 *
 	 * @global wpdb $wpdb WordPress database abstraction object.
 	 *
-	 * @param string               $room    Room identifier.
+	 * @param string               $room      Room identifier.
 	 * @param string               $client_id Client identifier.
-	 * @param array<string, mixed> $state   Serializable awareness state for this client.
-	 * @param int                  $user_id WordPress user ID that owns this client.
+	 * @param array<string, mixed> $state     Serializable awareness state for this client.
+	 * @param int                  $user_id   WordPress user ID that owns this client.
 	 * @return bool True on success, false on failure.
 	 */
 	public function set_awareness_state( string $room, string $client_id, array $state, int $user_id ): bool {
 		global $wpdb;
 
+		if ( '' === $room || '' === $client_id ) {
+			return false;
+		}
+
 		$data = wp_json_encode( $state );
-		$now  = gmdate( 'Y-m-d H:i:s' );
+
+		/*
+		 * Bucket the timestamp to 5-second intervals so most polls
+		 * short-circuit without a database write. Ceil is used instead
+		 * of floor to prevent the awareness timeout from being hit early.
+		 */
+		$now = gmdate( 'Y-m-d H:i:s', (int) ceil( time() / 5 ) * 5 );
 
 		/* Check if a row already exists. */
-		$exists = $wpdb->get_var(
+		$exists = $wpdb->get_row(
 			$wpdb->prepare(
-				"SELECT id FROM {$wpdb->collaboration} WHERE room = %s AND type = 'awareness' AND client_id = %s LIMIT 1",
+				"SELECT id, date_gmt FROM {$wpdb->collaboration} WHERE room = %s AND type = 'awareness' AND client_id = %s LIMIT 1",
 				$room,
 				$client_id
 			)
 		);
 
+		if ( $exists && $exists->date_gmt === $now ) {
+			// Row already has the current date, consider update a success.
+			return true;
+		}
+
 		if ( $exists ) {
 			$result = $wpdb->update(
 				$wpdb->collaboration,
@@ -315,7 +335,7 @@ public function set_awareness_state( string $room, string $client_id, array $sta
 					'data'     => $data,
 					'date_gmt' => $now,
 				),
-				array( 'id' => $exists )
+				array( 'id' => $exists->id )
 			);
 		} else {
 			$result = $wpdb->insert(

src/wp-includes/collaboration/class-wp-http-polling-collaboration-server.php

@@ -151,7 +151,15 @@ public function register_routes(): void {
 				'required' => true,
 				'type'     => array( 'object', 'null' ),
 			),
+			/*
+			 * client_id accepts both string and integer values:
+			 *  - 'minimum' bounds the integer form.
+			 *  - 'minLength' / 'maxLength' bound the string form.
+			 */
 			'client_id' => array(
+				'minimum'           => 1,
+				'minLength'         => 1,
+				'maxLength'         => 32, // Matches the client_id column width in wp-admin/includes/schema.php.
 				'required'          => true,
 				'type'              => array( 'string', 'integer' ),
 				'sanitize_callback' => function ( $value ) {
@@ -315,7 +323,7 @@ public function handle_request( WP_REST_Request $request ) {
 			// The lowest client ID is nominated to perform compaction when needed.
 			$is_compactor = false;
 			if ( count( $merged_awareness ) > 0 ) {
-				$is_compactor = (string) min( array_keys( $merged_awareness ) ) === $client_id;
+				$is_compactor = (string) min( array_keys( $merged_awareness ) ) === (string) $client_id;
 			}
 
 			// Process each update according to its type.