Skip to content

Update SQLite plugin to 2.2.3 and enable new driver #1506

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wojtekn merged 7 commits into from
Jul 17, 2025
Merged

Update SQLite plugin to 2.2.3 and enable new driver #1506

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
2ac4e0e
Update SQLite plugin to 2.2.0 and enable new driver
wojtekn Jun 24, 2025
d6b934c
Set constant earlier in the flow
wojtekn Jun 24, 2025
6391677
Remove unnecessary change
wojtekn Jun 24, 2025
8e8e528
Update SQLite plugin version to latest 2.2.2
wojtekn Jun 26, 2025
48bf68b
Enable AST driver for sqlite CLI calls
wojtekn Jul 2, 2025
224cae3
Merge branch 'trunk' into update/sqlite-plugin-to-2.2.0
wojtekn Jul 3, 2025
9a91b9b
Update SQLite driver to 2.2.3
wojtekn Jul 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/constants.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,9 @@ export const WP_CLI_IMPORT_EXPORT_RESPONSE_TIMEOUT =
WP_CLI_IMPORT_EXPORT_RESPONSE_TIMEOUT_IN_HRS * 60 * 60 * 1000; // 6hr

// SQLite
export const SQLITE_DATABASE_INTEGRATION_VERSION = 'v2.1.17-alpha.1';
export const SQLITE_DATABASE_INTEGRATION_VERSION = 'v2.2.3';

export const SQLITE_DATABASE_INTEGRATION_RELEASE_URL = `https://github.com/Automattic/sqlite-database-integration/archive/refs/tags/${ SQLITE_DATABASE_INTEGRATION_VERSION }.zip`;
export const SQLITE_DATABASE_INTEGRATION_RELEASE_URL = `https://github.com/WordPress/sqlite-database-integration/archive/refs/tags/${ SQLITE_DATABASE_INTEGRATION_VERSION }.zip`;

// IPC handlers that don't return anything (i.e. that are called with `ipcRenderer.send`)
export const IPC_VOID_HANDLERS = < const >[
Expand Down
6 changes: 3 additions & 3 deletions src/lib/import-export/export/export-database.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export async function exportDatabaseToFile(

// Execute the command to export directly to the temp file
const { stderr, exitCode } = await server.executeWpCliCommand(
`sqlite export ${ tempFileName } --require=/tmp/sqlite-command/command.php`,
`sqlite export ${ tempFileName } --require=/tmp/sqlite-command/command.php --enable-ast-driver`,
Copy link
Copy Markdown
Contributor Author

@wojtekn wojtekn Jul 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We set the parameter to enable the AST driver for CLI actions.

Copy link
Copy Markdown
Member

@sejas sejas Jul 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We probably won't add more commands, but I wonder if we should opt-in to use the AST driver more broadly. Like enable it by default, or auto-append the parameter in the wp-cli-process, similarly to how we increase the timeout:

studio/src/lib/wp-cli-process.ts

Lines 67 to 70 in 48bf68b

const timeout =
args[ 0 ] === 'sqlite' && [ 'import', 'export' ].includes( args[ 1 ] )
? IMPORT_EXPORT_RESPONSE_TIMEOUT
: DEFAULT_RESPONSE_TIMEOUT;

Copy link
Copy Markdown
Contributor Author

@wojtekn wojtekn Jul 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could, but we should remove this parameter as soon as the SQLite driver enables it by default. What do you think?

Copy link
Copy Markdown
Member

@sejas sejas Jul 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then, let's leave it as it is. There is no risk that we'll introduce more SQLite commands and forget to add the parameter in the meantime. 👍

{
skipPluginsAndThemes: true,
}
Expand Down Expand Up @@ -50,7 +50,7 @@ export async function exportDatabaseToMultipleFiles(
}

const tablesResult = await server.executeWpCliCommand(
`sqlite tables --format=json --require=/tmp/sqlite-command/command.php`,
`sqlite tables --format=json --require=/tmp/sqlite-command/command.php --enable-ast-driver`,
{
skipPluginsAndThemes: true,
}
Expand Down Expand Up @@ -85,7 +85,7 @@ export async function exportDatabaseToMultipleFiles(

// Execute the command to export directly to a temporary file in the project directory
const { stderr, exitCode } = await server.executeWpCliCommand(
`sqlite export ${ fileName } --tables=${ table } --require=/tmp/sqlite-command/command.php`,
`sqlite export ${ fileName } --tables=${ table } --require=/tmp/sqlite-command/command.php --enable-ast-driver`,
{
skipPluginsAndThemes: true,
}
Expand Down
2 changes: 1 addition & 1 deletion src/lib/import-export/import/importers/importer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ abstract class BaseImporter extends EventEmitter implements Importer {
await move( sqlFile, tmpPath );
await this.prepareSqlFile( tmpPath );
const { stderr, exitCode } = await server.executeWpCliCommand(
`sqlite import ${ sqlTempFile } --require=/tmp/sqlite-command/command.php`,
`sqlite import ${ sqlTempFile } --require=/tmp/sqlite-command/command.php --enable-ast-driver`,
// SQLite plugin requires PHP 8+
{ targetPhpVersion: DEFAULT_PHP_VERSION, skipPluginsAndThemes: true }
);
Expand Down
2 changes: 1 addition & 1 deletion src/lib/import-export/tests/export/exporters/sql-exporter.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ platformTestSuite( 'SqlExporter', ( { normalize } ) => {

const siteServer = SiteServer.get( '123' );
expect( siteServer?.executeWpCliCommand ).toHaveBeenCalledWith(
'sqlite export studio-backup-db-export-2024-08-01-12-00-00.sql --require=/tmp/sqlite-command/command.php',
'sqlite export studio-backup-db-export-2024-08-01-12-00-00.sql --require=/tmp/sqlite-command/command.php --enable-ast-driver',
{ skipPluginsAndThemes: true }
);
} );
Expand Down
2 changes: 1 addition & 1 deletion src/lib/import-export/tests/import/importer/jetpack-importer.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ platformTestSuite( 'JetpackImporter', ( { normalize } ) => {
const siteServer = SiteServer.get( mockStudioSiteId );

const expectedCommand =
'sqlite import studio-backup-sql-2024-08-01-12-00-00.sql --require=/tmp/sqlite-command/command.php';
'sqlite import studio-backup-sql-2024-08-01-12-00-00.sql --require=/tmp/sqlite-command/command.php --enable-ast-driver';
expect( siteServer?.executeWpCliCommand ).toHaveBeenNthCalledWith( 1, expectedCommand, {
targetPhpVersion: '8.3',
skipPluginsAndThemes: true,
Expand Down
4 changes: 3 additions & 1 deletion vendor/wp-now/src/wp-now.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -380,7 +380,9 @@ async function initWordPress( php: PHP, wordPressVersion: string, vfsDocumentRoo
initializeDefaultDatabase = true;
}

const wpConfigConsts = {};
const wpConfigConsts = {
WP_SQLITE_AST_DRIVER: true,
Copy link
Copy Markdown
Contributor Author

@wojtekn wojtekn Jul 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We set the constant to enable the new driver for the site's WP admin and frontend.

};

if ( wordPressVersion !== 'user-provided' ) {
wpConfigConsts[ 'WP_AUTO_UPDATE_CORE' ] = wordPressVersion === 'latest';
Expand Down
Loading