Use @wp-playground.cli and the Simply Static plugin for static site g…

…eneration (#59) This PR ships a Blueprint that generates the static site using the Simply Static plugin and the `run-blueprint` feature WordPress/wordpress-playground#1289. Usage: ```shell bash build-static-site.sh # the site is now rendered in the output directory ```
adamziel · May 1, 2024 · ad58b79 · ad58b79
1 parent eaa8cfb
commit ad58b79
Show file tree

Hide file tree

Showing 6 changed files with 71 additions and 195 deletions.
diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml
@@ -19,11 +19,14 @@ jobs:
         steps:
             - name: Checkout code
               uses: actions/checkout@v2
+            - name: 'Install bun'
+              run: |
+                  curl -fsSL https://bun.sh/install | bash
             - name: Generate static site
-              run: PATH_PREFIX=/$(echo ${{ env.REPO }} | cut -d'/' -f2)/ node generate-static-site.js
+              run: PATH="${PATH}:${HOME}/.bun/bin" bash build-static-site.sh
             - name: Deploy
               uses: peaceiris/actions-gh-pages@v4
               with:
                 github_token: ${{ secrets.GITHUB_TOKEN }}
-                publish_dir: ./out
+                publish_dir: ./output
 
diff --git a/build-static-site.sh b/build-static-site.sh
@@ -0,0 +1,18 @@
+#!/bin/bash
+
+mkdir -p output
+bunx @wp-playground/cli@latest \
+    run-blueprint \
+    --mount=./wp-content/plugins/wp-docs-plugin:/wordpress/wp-content/plugins/wp-docs-plugin \
+    --mount=./wp-content/plugins/export-static-site:/wordpress/wp-content/plugins/export-static-site \
+    --mount=./wp-content/html-pages:/wordpress/wp-content/html-pages \
+    --mount=./wp-content/uploads:/wordpress/wp-content/uploads \
+    --mount=./wp-content/themes/playground-docs:/wordpress/wp-content/themes/playground-docs \
+    --mount=./output:/output \
+    --blueprint=./wp-content/blueprint-static-site.json \
+    --wp=6.5 \
+    --php=8.0 
+
+cd output
+unzip export.zip
+rm export.zip
diff --git a/generate-static-site.js b/generate-static-site.js
diff --git a/wp-content/blueprint-wp-now.json → wp-content/blueprint-static-site.json b/wp-content/blueprint-wp-now.json → wp-content/blueprint-static-site.json
@@ -37,16 +37,24 @@
 				"slug": "gutenberg"
 			}
 		},
-                {
-                        "step": "installPlugin",
-                        "pluginZipFile": {
-                                "resource": "wordpress.org/plugins",
-                                "slug": "simply-static"
-                        }
-                },
-                {
-                        "step": "activatePlugin",
-                        "pluginPath": "wp-docs-plugin/plugin.php"
-                }
+		{
+			"step": "installPlugin",
+			"pluginZipFile": {
+				"resource": "wordpress.org/plugins",
+				"slug": "simply-static"
+			}
+		},
+		{
+			"step": "activatePlugin",
+			"pluginPath": "wp-docs-plugin/plugin.php"
+		},
+		{
+			"step": "activatePlugin",
+			"pluginPath": "export-static-site/export-static-site.php"
+		},
+		{
+			"step": "runPHP",
+			"code": "<?php require '/wordpress/wp-load.php'; export_static_site( '/output/export.zip' );"
+		}
 	]
 }
diff --git a/wp-content/plugins/export-static-site/export-static-site.php b/wp-content/plugins/export-static-site/export-static-site.php
@@ -0,0 +1,29 @@
+<?php
+/*
+Plugin Name: Export Static Site
+Plugin URI: https://w.org/playground
+Description: Exposes a export_static_site PHP function that exports the static site using the Simply Static
+Version: 0.1
+Author: WordPress Contributors
+License: GPL2
+*/
+
+function export_static_site($output_file)
+{
+    $simply_static = Simply_Static\Plugin::instance();
+    $simply_static->run_static_export();
+
+    // Wait at most 2 minutes for the export to finish
+    $i = 0;
+    do {
+        $exports = glob(WP_CONTENT_DIR . '/uploads/simply-static/temp-files/*.zip');
+        sleep(1);
+    } while (empty($exports) && ++$i < 120);
+
+    if (empty($exports)) {
+        throw new Exception("The export wasn't finished in two minutes, aborting.");
+    }
+
+    $export = end($exports);
+    rename($export, $output_file);
+}
diff --git a/wp-content/plugins/wp-docs-plugin/plugin.php b/wp-content/plugins/wp-docs-plugin/plugin.php
@@ -37,30 +37,6 @@
     return array ();
 });
 
-
-/**
- * Static site generation endpoints
- */
-add_action('parse_request', function ($wp) {
-    if (str_starts_with($_SERVER['REQUEST_URI'], '/sitemap/')) {
-        header('Content-Type: application/json');
-        echo json_encode(get_index_of_all_pages());
-        exit;
-    }
-    if (str_starts_with($_SERVER['REQUEST_URI'], '/zip-wp-files/')) {
-        zip_wp_files(ABSPATH.'/wp.zip');
-        rename(ABSPATH.'/wp.zip', ABSPATH.'/wp-content/wp.zip');
-        header('Content-Type: application/json');
-        echo json_encode(array('ok'));
-        exit;
-    }
-    if (str_starts_with($_SERVER['REQUEST_URI'], '/logout/')) {
-        wp_logout();
-        header('Location: /');
-        exit;
-    }
-});
-
 function initialize_docs_plugin() {
     if(get_option('docs_populated')) {
         // Prevent collisions between the initial create_db_pages_from_html_files call
@@ -203,56 +179,6 @@ function download_docs_callback() {
     rename($tmpPath, HTML_PAGES_PATH);
 });
 
-function get_index_of_all_pages() {
-    $frontpage_id = get_option('page_on_front');
-    $pages = [];
-    foreach (array('page', 'page') as $page_type) {
-        $pages = array_merge($pages, get_pages(
-            array(
-                'post_status' => 'publish',
-                'posts_per_page' => -1,
-                'post_type' => $page_type
-            )
-        ));
-    }
-
-    $sitemap = [];
-    // Loop through pages and print URLs
-    foreach($pages as $page) {
-        $sitemap[] = [
-            'url' => get_permalink($page->ID),
-            'title' => $page->post_title,
-            'isFrontPage' => $page->ID == $frontpage_id,
-        ];
-    }
-    return $sitemap;
-}
-
-function zip_wp_files($target_path) {
-    // Zip wp-content and wp-includes
-    $zip = new ZipArchive();
-    if ($zip->open($target_path, ZipArchive::CREATE | ZipArchive::OVERWRITE) !== true) {
-        echo 'Failed to create zip file';
-        exit(1);
-    }
-
-    foreach(['wp-content', 'wp-includes'] as $dir) {
-        $files = new RecursiveIteratorIterator(
-            new RecursiveDirectoryIterator(ABSPATH . '/' . $dir),
-            RecursiveIteratorIterator::LEAVES_ONLY
-        );
-
-        foreach ($files as $name => $file) {
-            if (!$file->isDir() && pathinfo($file->getRealPath(), PATHINFO_EXTENSION) !== 'php') {
-                $filePath = $file->getRealPath();
-                $relativePath = substr($filePath, strlen(ABSPATH));
-                $zip->addFile($filePath, $relativePath);
-            }
-        }
-    }
-
-    $zip->close();
-}
 
 function create_db_pages_from_html_files($dir, $parent_id = 0) {
     $indexFilePath = $dir . '/index.html';