Remove Data Liberation PHP modules (#79)

Removes the PHP Data Liberation plumbing originally introduced in
#1888. The
codebase has since moved to https://github.com/Automattic/php-toolkit
and is not maintained in the Playground repository anymore. It's only a
cause of test failures at the moment for little added benefit.

This PR also removes the possibility of importing WXR files using the
data liberation importer. It will have to be re-architected anyway to
accomodate for the changes in the php-toolkit repository structure.

 ## Testing instructions

This PR mostly removes code. Just confirm the CI checks pass

Author: adamziel

.eslintignore

@@ -7,7 +7,6 @@ __pycache__
 packages/playground/wordpress-builds/src/wordpress
 packages/playground/wordpress-builds/public
 packages/playground/sync/src/test/wp-*
-packages/playground/data-liberation/tests/fixtures
 packages/php-wasm/node/src/test/__test*
 *.timestamp-1678999213403.mjs
 .local

.github/workflows/ci.yml

@@ -23,31 +23,6 @@ jobs:
             - uses: ./.github/actions/prepare-playground
             - run: npx nx affected --target=lint
             - run: npx nx affected --target=typecheck
-    lint-and-test-php:
-        name: 'Lint and test PHP'
-        runs-on: wordpress-playground-private
-        steps:
-            - uses: actions/checkout@v4
-              with:
-                  submodules: true
-            - uses: actions/setup-node@v4
-              with:
-                  node-version: 20
-            - run: npm install
-            - name: Set up PHP
-              uses: shivammathur/setup-php@v2
-              with:
-                  # @TODO: Running the tests on PHP 7.2
-                  php-version: '8.1'
-                  tools: phpunit-polyfills
-            - name: Install Composer dependencies
-              uses: ramsey/composer-install@v3
-              with:
-                  ignore-cache: 'yes'
-                  composer-options: '--optimize-autoloader'
-                  working-directory: 'packages/playground/data-liberation'
-            - run: npx nx run playground-data-liberation:lint:php
-            - run: npx nx run playground-data-liberation:test:phpunit
     test-unit-asyncify:
         runs-on: wordpress-playground-private
         needs: [lint-and-typecheck]

.gitignore

@@ -14,7 +14,6 @@ packages/docs/site/src/model.json
 dist.zip
 rollup.d.ts
 .phpunit.cache
-packages/playground/data-liberation/vendor
 
 # dependencies
 node_modules

.gitmodules

@@ -1,7 +1,3 @@
 [submodule "isomorphic-git"]
     path="isomorphic-git"
     url=https://github.com/adamziel/isomorphic-git.git
-[submodule "blueprints-library"]
-    path="packages/playground/data-liberation/blueprints-library"
-    url=https://github.com/WordPress/blueprints-library.git
-    

.prettierignore

@@ -8,7 +8,6 @@
 /packages/playground/wordpress-builds/build/build-assets
 /packages/playground/wordpress-builds/src/wordpress
 /packages/playground/wordpress-builds/public/
-/packages/playground/data-liberation/tests/fixtures
 /packages/php-wasm/node/src/test/__test*
 __pycache__
 *.timestamp-1678999213403.mjs

package-lock.json

@@ -453,13 +453,6 @@ const schema11 = {
 							$ref: '#/definitions/FileReference',
 							description: 'The file to import',
 						},
-						importer: {
-							type: 'string',
-							enum: ['data-liberation', 'default'],
-							description:
-								'The importer to use. Possible values:\n\n- `default`: The importer from https://github.com/humanmade/WordPress-Importer\n- `data-liberation`: The experimental Data Liberation WXR importer developed at                      https://github.com/WordPress/wordpress-playground/issues/1894\n\nThis option is deprecated. The syntax will not be removed, but once the Data Liberation importer matures, it will become the only supported importer and the `importer` option will be ignored.',
-							deprecated: true,
-						},
 					},
 					required: ['file', 'step'],
 				},
@@ -3162,13 +3155,6 @@ const schema22 = {
 					$ref: '#/definitions/FileReference',
 					description: 'The file to import',
 				},
-				importer: {
-					type: 'string',
-					enum: ['data-liberation', 'default'],
-					description:
-						'The importer to use. Possible values:\n\n- `default`: The importer from https://github.com/humanmade/WordPress-Importer\n- `data-liberation`: The experimental Data Liberation WXR importer developed at                      https://github.com/WordPress/wordpress-playground/issues/1894\n\nThis option is deprecated. The syntax will not be removed, but once the Data Liberation importer matures, it will become the only supported importer and the `importer` option will be ignored.',
-					deprecated: true,
-				},
 			},
 			required: ['file', 'step'],
 		},
@@ -10056,38 +10042,6 @@ function validate14(
 																];
 															return false;
 														}
-														if (
-															!(
-																data40 ===
-																	'data-liberation' ||
-																data40 ===
-																	'default'
-															)
-														) {
-															validate14.errors =
-																[
-																	{
-																		instancePath:
-																			instancePath +
-																			'/importer',
-																		schemaPath:
-																			'#/oneOf/6/properties/importer/enum',
-																		keyword:
-																			'enum',
-																		params: {
-																			allowedValues:
-																				schema22
-																					.oneOf[6]
-																					.properties
-																					.importer
-																					.enum,
-																		},
-																		message:
-																			'must be equal to one of the allowed values',
-																	},
-																];
-															return false;
-														}
 														var valid21 =
 															_errs109 === errors;
 													} else {

packages/playground/blueprints/public/blueprint-schema-validator.js

@@ -542,7 +542,7 @@
 						},
 						"importer": {
 							"type": "string",
-							"enum": ["data-liberation", "default"],
+							"enum": ["default"],
 							"description": "The importer to use. Possible values:\n\n- `default`: The importer from https://github.com/humanmade/WordPress-Importer\n- `data-liberation`: The experimental Data Liberation WXR importer developed at                      https://github.com/WordPress/wordpress-playground/issues/1894\n\nThis option is deprecated. The syntax will not be removed, but once the Data Liberation importer matures, it will become the only supported importer and the `importer` option will be ignored.",
 							"deprecated": true
 						}

packages/playground/blueprints/public/blueprint-schema.json

@@ -7,13 +7,10 @@ import {
 	UniversalPHP,
 } from '@php-wasm/universal';
 import { FileReference, isResourceReference, Resource } from './resources';
-import { ImportWxrStep, Step, StepDefinition, WriteFileStep } from './steps';
+import { Step, StepDefinition, WriteFileStep } from './steps';
 import * as allStepHandlers from './steps/handlers';
 import { Blueprint, ExtraLibrary } from './blueprint';
 import { logger } from '@php-wasm/logger';
-/* @ts-ignore */
-// eslint-disable-next-line
-import dataLiberationCoreUrl from '../../../data-liberation/dist/data-liberation-core.phar.gz?url';
 
 // @TODO: Configure this in the `wp-cli` step, not here.
 const { wpCLI, ...otherStepHandlers } = allStepHandlers;
@@ -231,29 +228,14 @@ export function compileBlueprint(
 		(step) => typeof step === 'object' && step?.step === 'importWxr'
 	);
 	if (importWxrStepIndex !== undefined && importWxrStepIndex > -1) {
-		const importWxrStep = blueprint.steps![
-			importWxrStepIndex
-		]! as ImportWxrStep<any>;
-		if (importWxrStep.importer === 'data-liberation') {
-			blueprint.steps?.splice(importWxrStepIndex, 0, {
-				step: 'writeFile',
-				path: '/internal/shared/data-liberation-core.phar',
-				data: {
-					resource: 'url',
-					url: dataLiberationCoreUrl,
-					caption: 'Downloading the Data Liberation WXR importer',
-				},
-			});
-		} else {
-			blueprint.steps?.splice(importWxrStepIndex, 0, {
-				step: 'installPlugin',
-				pluginData: {
-					resource: 'url',
-					url: 'https://playground.wordpress.net/wordpress-importer.zip',
-					caption: 'Downloading the WordPress Importer plugin',
-				},
-			});
-		}
+		blueprint.steps?.splice(importWxrStepIndex, 0, {
+			step: 'installPlugin',
+			pluginData: {
+				resource: 'url',
+				url: 'https://playground.wordpress.net/wordpress-importer.zip',
+				caption: 'Downloading the WordPress Importer plugin',
+			},
+		});
 	}
 
 	const { valid, errors } = validateBlueprint(blueprint);

packages/playground/blueprints/src/lib/compile.ts

@@ -45,14 +45,10 @@ export interface ImportWxrStep<ResourceType> {
  */
 export const importWxr: StepHandler<ImportWxrStep<File>> = async (
 	playground,
-	{ file, importer = 'default' },
+	{ file },
 	progress?
 ) => {
-	if (importer === 'data-liberation') {
-		await importWithDataLiberationImporter(playground, file, progress);
-	} else {
-		await importWithDefaultImporter(playground, file, progress);
-	}
+	await importWithDefaultImporter(playground, file, progress);
 };
 
 async function importWithDefaultImporter(
@@ -107,133 +103,3 @@ async function importWithDefaultImporter(
 	`,
 	});
 }
-
-async function importWithDataLiberationImporter(
-	playground: UniversalPHP,
-	file: File,
-	progress?: StepProgress | undefined
-) {
-	progress?.tracker?.setCaption('Preparing content import');
-	await writeFile(playground, {
-		path: '/tmp/import.wxr',
-		data: file,
-	});
-	const docroot = await playground.documentRoot;
-	/**
-	 * Surface the import progress information in the Blueprint progress bar.
-	 * This temporary message handler is cleared at the end of this step.
-	 */
-	const clearProgressListener = await playground.onMessage(
-		(messageString) => {
-			const message = JSON.parse(messageString) as any;
-			if (message?.type === 'import-wxr-progress') {
-				progress?.tracker?.setCaption(message.progress);
-			}
-		}
-	);
-	try {
-		await playground.run({
-			code: `<?php
-	require ${phpVar(docroot)} . '/wp-load.php';
-	require ${phpVar(docroot)} . '/wp-admin/includes/admin.php';
-
-	// Defines the constants expected by the Box .phar stub when "cli" is used
-	// as the SAPI name.
-	// @TODO: Don't use the "cli" SAPI string and don't allow composer to run platform checks.
-	if(!defined('STDERR')) define('STDERR', fopen('php://stderr', 'w'));
-	if(!defined('STDIN'))  define('STDIN', fopen('php://stdin', 'r'));
-	if(!defined('STDOUT')) define('STDOUT', fopen('php://stdout', 'w'));
-	
-	// Preloaded by the Blueprint compile() function
-	require '/internal/shared/data-liberation-core.phar';
-
-	$admin_id = get_users(array('role' => 'Administrator') )[0]->ID;
-	wp_set_current_user( $admin_id );
-
-	$new_site_url = get_site_url();
-	$importer = WP_Stream_Importer::create_for_wxr_file(
-		'/tmp/import.wxr',
-		array(
-			'new_site_url' => $new_site_url,
-		)
-	);
-	$session = WP_Import_Session::create(
-		array(
-			'data_source' => 'wxr_file',
-			'file_name' => '/tmp/import.wxr',
-		)
-	);
-	while ( true ) {
-		if ( true === $importer->next_step() ) {
-			/**
-			 * We're ignoring any importing errors.
-			 * This script is a part of Blueprints and is expected to finish
-			 * without stopping. We won't be gathering additional user input
-			 * along the way. Instead, we'll just decide not to ignore the
-			 * errors.
-			 *
-			 * @TODO: Consider extracting this code into a CLI script and
-			 *        using it here instead of this custom script. Note it's
-			 *        about a simple CLI script, not a WP-CLI command, as the
-			 *        latter would require downloading 5MB of WP-CLI code.
-			 */
-			switch ( $importer->get_stage() ) {
-				case WP_Stream_Importer::STAGE_INITIAL:
-					$message = 'Preparing content import';
-					break;
-		
-				case WP_Stream_Importer::STAGE_INDEX_ENTITIES:
-					// Bump the total number of entities to import.
-					$indexed = $session->count_all_total_entities();
-					$message = 'Content import 1/4: Indexing records (' . $indexed . ' so far)';
-					$session->create_frontloading_placeholders( $importer->get_indexed_assets_urls() );
-					$session->bump_total_number_of_entities(
-						$importer->get_indexed_entities_counts()
-					);
-					break;
-
-				case WP_Stream_Importer::STAGE_TOPOLOGICAL_SORT:
-					$message = 'Content import 2/4: Indexing data';
-					break;
-
-				case WP_Stream_Importer::STAGE_FRONTLOAD_ASSETS:
-					$session->bump_frontloading_progress(
-						$importer->get_frontloading_progress(),
-						$importer->get_frontloading_events()
-					);
-					$nb_media = $session->count_awaiting_frontloading_placeholders();
-					$message = 'Content import 3/4: Downloading media (' . $nb_media . ' remaining)';
-					break;
-
-				case WP_Stream_Importer::STAGE_IMPORT_ENTITIES:
-					$session->bump_imported_entities_counts(
-						$importer->get_imported_entities_counts()
-					);
-					$nb_remaining_entities = $session->count_remaining_entities();
-					$message = 'Content import 4/4: Inserting data (' . $nb_remaining_entities . ' remaining)';
-					break;
-
-				default:
-					$message = 'Importing content';
-					break;
-			}
-
-			// Report progress to the UI
-			post_message_to_js(json_encode([
-				'type' => 'import-wxr-progress',
-				'progress' => $message,
-			]));
-			continue;
-		}
-		if ( $importer->advance_to_next_stage() ) {
-			continue;
-		}
-		// Import finished
-		break;
-	}
-	`,
-		});
-	} finally {
-		await clearProgressListener();
-	}
-}