Load polyfills correctly for the new sqlite version (v2.2.22) by katinthehatsite · Pull Request #24 · Automattic/wp-cli-sqlite-command

katinthehatsite · 2026-04-08T13:52:22Z

In v2.2.22+ for the sqlite-database-integration, php-polyfills.php moved to wp-includes/database/php-polyfills.php. If you try to push a newly created site in Studio with that version, it will immediately fail due not being able to load php-polyfills.php. This PR adds a backwards compatible fix for it.

Testing instructions

Create a new site in Studio (does not matter with which PHP version)
Connect WP.com site
Try pushing the site
Confirm that the push fails

Copy the fixed SQLiteDatabaseIntegrationLoader.php from this branch to ~/.studio/server-files/sqlite-command/src/SQLiteDatabaseIntegrationLoader.php
Pin the version to prevent the app from overwriting your changes on restart: set the contents of ~/.studio/server-files/sqlite-command/version to v99.99.99
Restart Studio
Create a new site with any PHP version (you can use PHP 8.5 for good measure)
Go to the Sync tab
Connect a WP.com site
Start the push process
Confirm there are no errors due to loading polyfills (there will be another error in PHP 8.5 - all other versions will work fine with this fix - related to deprecated warning but it will be solved in a different Studio PR)

features/bootstrap/SQLiteFeatureContext.php

fredrikekelund

Rather than supporting two different file structures, I think we should consider updating the version check for the sqlite-database-integration plugin.

src/SQLiteDatabaseIntegrationLoader.php

fredrikekelund · 2026-04-09T08:21:33Z

The PR tests well, though. I can confirm that it fixes the problem for me locally 👍

fredrikekelund · 2026-04-09T08:29:49Z

OK, hold on a minute… Studio checks for remote updates to this dependency, but not for sqlite-database-integration. That means we ship a variable version of this dependency but a fixed version of sqlite-database-integration.

Zooming out for a moment, this seems like a less-than-ideal strategy because these two dependencies are actually relatively tightly coupled. Nonetheless, that's how it works. So my suggestion to support a single file structure in sqlite-database-integration wouldn't really work, because we can't be sure which bundled version of sqlite-database-integration the user has locally.

fredrikekelund · 2026-04-09T08:56:06Z

It looks like the failed tests are due to some recent update in https://github.com/wp-cli/wp-cli-tests. AFAICT, we didn't run those tests in other recent PRs.

fredrikekelund

This PR works well – it does what it says on the tin 👍

However, I still can't push a site using PHP 8.5, so it doesn't fix STU-1529 for me. Here are my error logs for when I try to push a site that uses PHP 8.5.

["wp_commentmeta","wp_comments","wp_links","wp_options","wp_postmeta","wp_posts","wp_term_relationships","wp_term_taxonomy","wp_termmeta","wp_terms","wp_usermeta","wp_users"]
Error occurred in handler for 'exportSiteForPush': Error: Database export failed: PHP Deprecated:  Case statements followed by a semicolon (;) are deprecated, use a colon (:) instead in phar:///tmp/wp-cli.phar/vendor/react/promise/src/functions.php on line 369

    at exportDatabaseToMultipleFiles (/Users/fredrik/Code/studio/apps/studio/dist/main/index.js:28293:11)
    at async DefaultExporter.addDatabase (/Users/fredrik/Code/studio/apps/studio/dist/main/index.js:28553:24)
    at async DefaultExporter.export (/Users/fredrik/Code/studio/apps/studio/dist/main/index.js:28450:7)
    at async exportBackup (/Users/fredrik/Code/studio/apps/studio/dist/main/index.js:28691:9)
    at async exportSiteForPush (/Users/fredrik/Code/studio/apps/studio/dist/main/index.js:44236:5)
    at async Session.<anonymous> (node:electron/js2c/browser_init:2:116791)

src/SQLiteDatabaseIntegrationLoader.php

fredrikekelund · 2026-04-09T09:00:17Z

src/SQLiteDatabaseIntegrationLoader.php

+			$db = $plugin_directory . '/wp-includes/database';
+			return [
+				"$db/version.php",
+				"$db/parser/class-wp-parser-grammar.php",
+				"$db/parser/class-wp-parser.php",
+				"$db/parser/class-wp-parser-node.php",
+				"$db/parser/class-wp-parser-token.php",
+				"$db/mysql/class-wp-mysql-token.php",
+				"$db/mysql/class-wp-mysql-lexer.php",
+				"$db/mysql/class-wp-mysql-parser.php",
+				"$db/sqlite/class-wp-sqlite-pdo-user-defined-functions.php",
+				"$db/sqlite/class-wp-sqlite-connection.php",
+				"$db/sqlite/class-wp-sqlite-configurator.php",
+				"$db/sqlite/class-wp-sqlite-driver.php",
+				"$db/sqlite/class-wp-sqlite-driver-exception.php",
+				"$db/sqlite/class-wp-sqlite-information-schema-builder.php",
+				"$db/sqlite/class-wp-sqlite-information-schema-exception.php",
+				"$db/sqlite/class-wp-sqlite-information-schema-reconstructor.php",
+			];
+		}
+
+		$wp = $plugin_directory . '/wp-includes';
+		return [
+			$plugin_directory . '/version.php',
+			"$wp/parser/class-wp-parser-grammar.php",
+			"$wp/parser/class-wp-parser.php",
+			"$wp/parser/class-wp-parser-node.php",
+			"$wp/parser/class-wp-parser-token.php",
+			"$wp/mysql/class-wp-mysql-token.php",
+			"$wp/mysql/class-wp-mysql-lexer.php",
+			"$wp/mysql/class-wp-mysql-parser.php",
+			"$wp/sqlite/class-wp-sqlite-pdo-user-defined-functions.php",
+			"$wp/sqlite-ast/class-wp-sqlite-connection.php",
+			"$wp/sqlite-ast/class-wp-sqlite-configurator.php",
+			"$wp/sqlite-ast/class-wp-sqlite-driver.php",
+			"$wp/sqlite-ast/class-wp-sqlite-driver-exception.php",
+			"$wp/sqlite-ast/class-wp-sqlite-information-schema-builder.php",
+			"$wp/sqlite-ast/class-wp-sqlite-information-schema-exception.php",
+			"$wp/sqlite-ast/class-wp-sqlite-information-schema-reconstructor.php",
+		];


Since we're not using the same array to load the files, the $db and $wp prefixing seems kind of arbitrary to me. I'd spell out the full $plugin_directory . $path

I think these are not needed as per https://github.com/Automattic/wp-cli-sqlite-command/pull/24/changes#r3057297293.

fredrikekelund · 2026-04-09T09:02:12Z

src/SQLiteDatabaseIntegrationLoader.php

+		require_once "$sqlite/class-wp-sqlite-lexer.php";
+		require_once "$sqlite/class-wp-sqlite-query-rewriter.php";
+		require_once "$sqlite/class-wp-sqlite-translator.php";
+		require_once "$sqlite/class-wp-sqlite-token.php";
+		require_once "$sqlite/class-wp-sqlite-pdo-user-defined-functions.php";


Nitpicking, but still, I'd definitely spell out the full $plugin_directory . $path here.

JanJakes

Thanks for working on this! I totally missed the wp-pdo-mysql-on-sqlite.php back-compatibility angle. Sorry about that. I shared a few ideas for improvements and simplifications.

JanJakes · 2026-04-09T11:00:58Z

src/SQLiteDatabaseIntegrationLoader.php

+	 */
+	private static function load_ast_driver( $plugin_directory, $new_structure ) {
+		if ( file_exists( $plugin_directory . '/wp-pdo-mysql-on-sqlite.php' ) ) {
 			require_once $plugin_directory . '/wp-pdo-mysql-on-sqlite.php';


Not keeping require_once $plugin_directory . '/wp-pdo-mysql-on-sqlite.php'; in 2.2.21 and 2.2.22 was an oversight, but rather than listing the plugin files, we can just add this:

} elseif ( file_exists( $plugin_directory . '/wp-includes/database/load.php' ) ) { require_once '$plugin_directory . '/wp-includes/database/load.php'; }

The rest of the diff is not needed.

JanJakes · 2026-04-09T11:01:20Z

src/SQLiteDatabaseIntegrationLoader.php

+			$db = $plugin_directory . '/wp-includes/database';
+			return [
+				"$db/version.php",
+				"$db/parser/class-wp-parser-grammar.php",
+				"$db/parser/class-wp-parser.php",
+				"$db/parser/class-wp-parser-node.php",
+				"$db/parser/class-wp-parser-token.php",
+				"$db/mysql/class-wp-mysql-token.php",
+				"$db/mysql/class-wp-mysql-lexer.php",
+				"$db/mysql/class-wp-mysql-parser.php",
+				"$db/sqlite/class-wp-sqlite-pdo-user-defined-functions.php",
+				"$db/sqlite/class-wp-sqlite-connection.php",
+				"$db/sqlite/class-wp-sqlite-configurator.php",
+				"$db/sqlite/class-wp-sqlite-driver.php",
+				"$db/sqlite/class-wp-sqlite-driver-exception.php",
+				"$db/sqlite/class-wp-sqlite-information-schema-builder.php",
+				"$db/sqlite/class-wp-sqlite-information-schema-exception.php",
+				"$db/sqlite/class-wp-sqlite-information-schema-reconstructor.php",
+			];
+		}
+
+		$wp = $plugin_directory . '/wp-includes';
+		return [
+			$plugin_directory . '/version.php',
+			"$wp/parser/class-wp-parser-grammar.php",
+			"$wp/parser/class-wp-parser.php",
+			"$wp/parser/class-wp-parser-node.php",
+			"$wp/parser/class-wp-parser-token.php",
+			"$wp/mysql/class-wp-mysql-token.php",
+			"$wp/mysql/class-wp-mysql-lexer.php",
+			"$wp/mysql/class-wp-mysql-parser.php",
+			"$wp/sqlite/class-wp-sqlite-pdo-user-defined-functions.php",
+			"$wp/sqlite-ast/class-wp-sqlite-connection.php",
+			"$wp/sqlite-ast/class-wp-sqlite-configurator.php",
+			"$wp/sqlite-ast/class-wp-sqlite-driver.php",
+			"$wp/sqlite-ast/class-wp-sqlite-driver-exception.php",
+			"$wp/sqlite-ast/class-wp-sqlite-information-schema-builder.php",
+			"$wp/sqlite-ast/class-wp-sqlite-information-schema-exception.php",
+			"$wp/sqlite-ast/class-wp-sqlite-information-schema-reconstructor.php",
+		];


I think these are not needed as per https://github.com/Automattic/wp-cli-sqlite-command/pull/24/changes#r3057297293.

JanJakes · 2026-04-09T11:03:26Z

src/SQLiteDatabaseIntegrationLoader.php

+
+		require_once $new_structure
+			? $plugin_directory . '/wp-includes/database/php-polyfills.php'
+			: $plugin_directory . '/php-polyfills.php';


These php-polyfills preloads are only relevant for the old structure. The new structure includes them in $plugin_directory . '/wp-includes/database/load.php'. See also https://github.com/Automattic/wp-cli-sqlite-command/pull/24/changes#r3057297293.

In other words, it's safe to include this file only if it exists:

if ( file_exists( $plugin_directory . '/php-polyfills.php' ) { require_once $plugin_directory . '/php-polyfills.php'; }

JanJakes · 2026-04-09T11:10:48Z

src/SQLiteDatabaseIntegrationLoader.php

-		// We also need to selectively load the necessary classes from the plugin.
-		require_once $plugin_directory . '/php-polyfills.php';
+		// In v2.2.22+, files moved into wp-includes/database/ subdirectories.
+		$new_structure      = file_exists( $plugin_directory . '/wp-includes/database/php-polyfills.php' );


Maybe it's safer to check for the old structure, as in:

$old_structure = file_exists( $plugin_directory . '/php-polyfills.php' );

Or for the new structure using $plugin_directory . '/wp-includes/database/load.php'. It will be safer than relying on the existence of the polyfill file.

Applied the suggestion 👍

JanJakes · 2026-04-09T13:31:32Z

src/SQLiteDatabaseIntegrationLoader.php


-		if ( $new_driver_enabled && file_exists( $plugin_directory . '/wp-pdo-mysql-on-sqlite.php' ) ) {
-			require_once $plugin_directory . '/wp-pdo-mysql-on-sqlite.php';
-		} elseif ( $new_driver_enabled ) {


@katinthehatsite This branch actually also needs to stay in the code for now. I guess I should've expressed it clearer, as in, let's only add the new case to the existing ones:

} elseif ( file_exists( $plugin_directory . '/wp-includes/database/load.php' ) ) { require_once $plugin_directory . '/wp-includes/database/load.php'; }

Added them back now 👍

JanJakes

Looks good, thanks!

katinthehatsite · 2026-04-09T17:59:40Z

composer.json

      "email": "jeroen.pfeil@automattic.com"
    }
  ],
+  "minimum-stability": "dev",


I tried without these but it did not work for using wp-cli/wp-cli": "^2.13 so Claude recommended adding this

Kateryna Kodonenko added 2 commits April 8, 2026 15:33

Load polyfills correctly for the new sqlite version

2038ecc

Ensure we have the correct version

100d0a4

katinthehatsite self-assigned this Apr 8, 2026

katinthehatsite force-pushed the fix/new-structure-compatibility branch from b098ba7 to 100d0a4 Compare April 8, 2026 13:52

Kateryna Kodonenko added 2 commits April 8, 2026 16:47

Optimize code

316c5f4

Fix code quality issues

3fce617

katinthehatsite requested a review from a team April 8, 2026 15:42

Remove unused import

7574650

katinthehatsite commented Apr 8, 2026

View reviewed changes

features/bootstrap/SQLiteFeatureContext.php Show resolved Hide resolved

katinthehatsite mentioned this pull request Apr 8, 2026

Studio: Filter out deprecated warnings from fatal errors Automattic/studio#3018

Open

1 task

wojtekn requested a review from JanJakes April 9, 2026 07:54

fredrikekelund reviewed Apr 9, 2026

View reviewed changes

src/SQLiteDatabaseIntegrationLoader.php Outdated Show resolved Hide resolved

src/SQLiteDatabaseIntegrationLoader.php Show resolved Hide resolved

fredrikekelund approved these changes Apr 9, 2026

View reviewed changes

nightnei mentioned this pull request Apr 9, 2026

Fix sync pull getting stuck when site has broken SQLite integration Automattic/studio#3008

Open

1 task

JanJakes reviewed Apr 9, 2026

View reviewed changes

Kateryna Kodonenko added 3 commits April 9, 2026 14:02

Ensure we update the version

c7e8117

Adjust loading function

5389763

Remove new structure variable

248c544

JanJakes reviewed Apr 9, 2026

View reviewed changes

bRING BACK fallback

3b1aba5

JanJakes approved these changes Apr 9, 2026

View reviewed changes

Kateryna Kodonenko added 3 commits April 9, 2026 16:52

Try updating composer

4b85b4f

Add minumum stability

5240b5f

Adjust test setup

6744ef7

katinthehatsite merged commit 26cade0 into main Apr 9, 2026
56 checks passed

katinthehatsite commented Apr 9, 2026

View reviewed changes

Conversation

katinthehatsite commented Apr 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

fredrikekelund left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

fredrikekelund commented Apr 9, 2026

Uh oh!

fredrikekelund commented Apr 9, 2026

Uh oh!

fredrikekelund commented Apr 9, 2026

Uh oh!

fredrikekelund left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JanJakes left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JanJakes left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

katinthehatsite commented Apr 8, 2026 •

edited

Loading