Merge commit 'adacdc3' into develop

john-shaffer · john-shaffer · commit 16abe86df5a3 · 2025-07-10T13:30:29.000-05:00
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -29,9 +29,11 @@ jobs:
       - name: Install Nix
         uses: DeterminateSystems/determinate-nix-action@v3
 
-      - name: Run tests
-        run: nix flake check
-        working-directory: dev
+      - name: Build all checks and outputs
+        run: |
+          nix develop -c om ci
+          cd dev
+          nix develop -c om ci
 
       - name: Build plugin zip
         run: |
diff --git a/.github/workflows/codequality.yml b/.github/workflows/codequality.yml
diff --git a/composer.json b/composer.json
@@ -68,15 +68,15 @@
     },
     "scripts": {
         "phpstan": "php -d memory_limit=-1 ./vendor/bin/phpstan analyse",
-        "phpcbf": "vendor/bin/phpcbf -d memory_limit=512M --standard=./tools/phpcs.xml --extensions=php src tests views *.php",
-        "phpcs": "vendor/bin/phpcs -d memory_limit=512M -s --standard=./tools/phpcs.xml --extensions=php src tests views *.php",
-        "php81": "vendor/bin/phpcs --standard=PHPCompatibility --runtime-set testVersion 8.1 --ignore=*/tests/*,*/admin/*,**/coverage/*,*.js,*/vendor/*,*/integration-tests/bedrock/*,*/integration-tests/result*,*/integration-tests/wordpress/* ./",
-        "php82": "vendor/bin/phpcs --standard=PHPCompatibility --runtime-set testVersion 8.2 --ignore=*/tests/*,*/admin/*,**/coverage/*,*.js,*/vendor/*,*/integration-tests/bedrock/*,*/integration-tests/result*,*/integration-tests/wordpress/* ./",
-        "php83": "vendor/bin/phpcs --standard=PHPCompatibility --runtime-set testVersion 8.3 --ignore=*/tests/*,*/admin/*,**/coverage/*,*.js,*/vendor/*,*/integration-tests/bedrock/*,*/integration-tests/result*,*/integration-tests/wordpress/* ./",
-        "php84": "vendor/bin/phpcs --standard=PHPCompatibility --runtime-set testVersion 8.4 --ignore=*/tests/*,*/admin/*,**/coverage/*,*.js,*/vendor/*,*/integration-tests/bedrock/*,*/integration-tests/result*,*/integration-tests/wordpress/* ./",
-        "phpunit": "vendor/bin/phpunit ./tests/unit/",
-        "coverage": "XDEBUG_MODE=coverage vendor/bin/phpunit tests/unit --coverage-html coverage --whitelist src/",
-        "lint": "vendor/bin/parallel-lint --exclude integration-tests --exclude vendor .",
+        "phpcbf": "php ./vendor/bin/phpcbf -d memory_limit=512M --standard=./phpcs.xml --extensions=php src tests views *.php",
+        "phpcs": "php ./vendor/bin/phpcs -d memory_limit=512M -s --standard=./phpcs.xml --extensions=php src tests views *.php",
+        "php81": "php ./vendor/bin/phpcs --standard=PHPCompatibility --runtime-set testVersion 8.1 --ignore=*/tests/*,*/admin/*,**/coverage/*,*.js,*/vendor/*,*/integration-tests/bedrock/*,*/integration-tests/result*,*/integration-tests/wordpress/* ./",
+        "php82": "php ./vendor/bin/phpcs --standard=PHPCompatibility --runtime-set testVersion 8.2 --ignore=*/tests/*,*/admin/*,**/coverage/*,*.js,*/vendor/*,*/integration-tests/bedrock/*,*/integration-tests/result*,*/integration-tests/wordpress/* ./",
+        "php83": "php ./vendor/bin/phpcs --standard=PHPCompatibility --runtime-set testVersion 8.3 --ignore=*/tests/*,*/admin/*,**/coverage/*,*.js,*/vendor/*,*/integration-tests/bedrock/*,*/integration-tests/result*,*/integration-tests/wordpress/* ./",
+        "php84": "php ./vendor/bin/phpcs --standard=PHPCompatibility --runtime-set testVersion 8.4 --ignore=*/tests/*,*/admin/*,**/coverage/*,*.js,*/vendor/*,*/integration-tests/bedrock/*,*/integration-tests/result*,*/integration-tests/wordpress/* ./",
+        "phpunit": "php ./vendor/bin/phpunit ./tests/unit/",
+        "coverage": "XDEBUG_MODE=coverage php ./vendor/bin/phpunit tests/unit --coverage-html coverage --whitelist src/",
+        "lint": "php ./vendor/bin/parallel-lint --exclude integration-tests --exclude vendor .",
         "test": [
             "composer validate --strict",
             "@lint",
@@ -89,7 +89,7 @@
             "@phpunit"
         ],
         "test-integration": "nix flake check ./dev",
-        "test-integration-live": "WORDPRESS_DIR=$(realpath ./dev/data/wordpress1) vendor/bin/phpunit tests/integration",
+        "test-integration-live": "WORDPRESS_DIR=$(realpath ./dev/data/wordpress1) php ./vendor/bin/phpunit tests/integration",
         "build": "nix build .#plugin"
     }
 }
diff --git a/dev/flake.nix b/dev/flake.nix
@@ -33,6 +33,7 @@
             extensions = { enabled, all }:
               enabled ++ (with all; [ imagick memcached ]);
           };
+          wp2staticLib = inputs.wp2static.lib.${system};
           wp2staticPkgs = inputs.wp2static.packages.${system};
           wp2static = wp2staticPkgs.plugin;
         in {
@@ -129,7 +130,7 @@
                       toString dbPort
                     }" --user="${dbUserName}" --password="${dbUserPass}" "${dbName}"
                     ${pkgs.rsync}/bin/rsync -a --copy-links ${wp2staticPkgs.composerVendorDev}/. .
-                    ${pkgs.rsync}/bin/rsync -a --copy-links ${wp2staticPkgs.wp2staticSrcDev}/. .
+                    ${pkgs.rsync}/bin/rsync -a --copy-links ${wp2staticLib.wp2staticSrcDev}/. .
                     chmod ug+w -R ./vendor
                     ${phpPackages.composer}/bin/composer dump-autoload
                     WORDPRESS_DIR="$(realpath ./data/wordpress1)"
diff --git a/flake.nix b/flake.nix
@@ -24,17 +24,17 @@
           pname = "${name}-composer-deps";
           version = version;
           src = composerSrc;
-          vendorHash = "sha256-22HRb3w2JLmoqi3AtX6RpVCk7QAdMOx0MuOFBzubziU=";
+          vendorHash = "sha256-3Hi6VYSpfgsTv71O6AhstrJxeuEzJL0Dkhq2HSZCIkI=";
         });
         composerVendorDev = php.mkComposerVendor (finalAttrs: {
           composerNoDev = false;
           pname = "${name}-composer-deps-dev";
           version = version;
           src = composerSrc;
-          vendorHash = "sha256-P5F8UWN4KPAA5OegcrhZWE/dyeaKUrg2EdHnSM5MMxo=";
+          vendorHash = "sha256-/38uou7iOaDCZUT3SHXP+opn/SgKRXP+EMx2c8s0EJw=";
         });
         wp2staticSrc = pkgs.lib.cleanSourceWith {
-          src = wp2staticSrcDev;
+          src = self;
           filter = path: type:
             let base = baseNameOf path;
             in type == "directory" && base == "src" || type == "directory"
@@ -50,7 +50,7 @@
             && base == "tests" || pkgs.lib.hasInfix "/tests/" path || type
             == "directory" && base == "views" || type == "regular"
             && pkgs.lib.hasSuffix ".php" base || base == "composer.json" || base
-            == "composer.lock" || base == "phpunit.xml";
+            == "composer.lock" || base == "phpcs.xml" || base == "phpunit.xml";
         };
         wp2static = runCommand "wp2static" { } ''
           export PLUGIN_DIR="$TMPDIR/${name}"
@@ -65,10 +65,34 @@
           cd "$PLUGIN_DIR"/..
           ${zip}/bin/zip -r -9 $out/wp2static.zip "$(basename "$PLUGIN_DIR")"
         '';
+        wp2staticCheck = stdenv.mkDerivation {
+          pname = "wp2static-check";
+          version = version;
+
+          src = wp2staticSrcDev;
+
+          nativeBuildInputs = [ bash php ];
+
+          doBuild = false;
+          doCheck = true;
+
+          checkPhase = ''
+            TMPDIR="$(realpath ./tmp)"
+            mkdir -p "$TMPDIR"
+            export PLUGIN_DIR="$TMPDIR/${name}"
+            mkdir -p "$PLUGIN_DIR"
+            cd "$PLUGIN_DIR"
+            cp -a "${composerVendorDev}/vendor" .
+            cp -a "$src"/* .
+            ${phpPackages.composer}/bin/composer lint
+            ${phpPackages.composer}/bin/composer phpcs
+          '';
+        };
       in {
+        checks = { inherit wp2staticCheck; };
+        lib = { inherit wp2staticSrcDev wp2staticSrc; };
         packages = {
-          inherit composerVendorDev composerVendor wp2static wp2staticSrcDev
-            wp2staticSrc;
+          inherit composerVendorDev composerVendor wp2static;
           plugin = wp2static;
         };
       });
diff --git a/phpcs.xml b/phpcs.xml
@@ -46,6 +46,7 @@
     <exclude name="Squiz.Commenting.FileComment.Missing" />
     <exclude name="Squiz.Commenting.FunctionComment.ParamCommentFullStop" />
     <exclude name="Squiz.Commenting.FunctionComment.ThrowsNoFullStop" />
+    <exclude name="Squiz.Commenting.FunctionCommentThrowTag" />
     <exclude name="Squiz.Commenting.InlineComment.InvalidEndChar" />
     <exclude name="Squiz.Commenting.LongConditionClosingComment.SpacingBefore" />
     <exclude name="Squiz.Commenting.PostStatementComment.Found" />
@@ -84,6 +85,9 @@
     <exclude name="WordPress.PHP.StrictComparisons.LooseComparison" />
     <exclude name="WordPress.PHP.StrictInArray.MissingTrueStrict" />
     <exclude name="WordPress.PHP.YodaConditions.NotYoda" />
+    <!-- Forcing exceptions to be escaped is bad practice.
+     See: https://github.com/WordPress/WordPress-Coding-Standards/issues/2374 -->
+    <exclude name="WordPress.Security.EscapeOutput.ExceptionNotEscaped"/>
     <exclude name="WordPress.Security.EscapeOutput.OutputNotEscaped" />
     <exclude name="WordPress.Security.NonceVerification" />
     <exclude name="WordPress.Security.ValidatedSanitizedInput" />
diff --git a/src/Controller.php b/src/Controller.php
@@ -511,7 +511,7 @@ public static function wp2staticEnqueueJobs( ?int $post_id = null ): void {
     public static function wp2staticToggleAddon( string $addon_slug = null ): void {
         if ( defined( 'WP_CLI' ) ) {
             if ( ! $addon_slug ) {
-                throw new WP2StaticException(
+                throw WsLog::ex(
                     'No addon slug given for CLI toggling'
                 );
             }
diff --git a/src/Crawler.php b/src/Crawler.php
@@ -120,6 +120,8 @@ public static function wp2staticCrawl( string $crawler_slug ): void {
             }
             $crawled = $url_discovery->discoverURLs( $crawled );
             foreach ( $crawled as $_ ) {
+                // Intentionally empty to consume the iterator
+                continue;
             }
 
             $has_new = true;
diff --git a/src/DetectSitemapsURLs.php b/src/DetectSitemapsURLs.php
@@ -163,8 +163,7 @@ public static function detect( string $wp_site_url, bool $log = false ): \Iterat
                 }
             }
         } catch ( WP2StaticException $e ) {
-            WsLog::l( $e->getMessage() );
-            throw new WP2StaticException( $e->getMessage(), 0, $e );
+            throw WsLog::ex( $e->getMessage(), 0, $e );
         }
     }
 }
diff --git a/src/FilesHelper.php b/src/FilesHelper.php
@@ -17,8 +17,7 @@ public static function deleteDirWithFiles( string $dir ): void {
 
             if ( ! $dir_files ) {
                 $err = 'Trying to delete nonexistent dir: ' . $dir;
-                WsLog::l( $err );
-                throw new WP2StaticException( $err );
+                throw WsLog::ex( $err );
             }
 
             $files = array_diff( $dir_files, [ '.', '..' ] );
@@ -92,8 +91,7 @@ public static function cleanDetectedURLs( array $urls ): array {
 
         if ( ! is_string( $home_url ) ) {
             $err = 'Home URL not defined ';
-            WsLog::l( $err );
-            throw new WP2StaticException( $err );
+            throw WsLog::ex( $err );
         }
 
         $cleaned_urls = [];
diff --git a/src/SiteInfo.php b/src/SiteInfo.php
@@ -92,8 +92,7 @@ public static function getPath( string $name ): string {
 
         if ( ! array_key_exists( $key, self::$info ) ) {
             $err = 'Attempted to access missing SiteInfo path';
-            WsLog::l( $err );
-            throw new WP2StaticException( $err );
+            throw WsLog::ex( $err );
         }
 
         /**
@@ -121,8 +120,7 @@ public static function getUrl( string $name ): string {
 
         if ( ! array_key_exists( $key, self::$info ) ) {
             $err = 'Attempted to access missing SiteInfo URL';
-            WsLog::l( $err );
-            throw new WP2StaticException( $err );
+            throw WsLog::ex( $err );
         }
 
         /**
@@ -201,8 +199,7 @@ public static function getSiteURLHost(): string {
 
         if ( ! is_string( $url_host ) ) {
             $err = 'Failed to get hostname from Site URL';
-            WsLog::l( $err );
-            throw new WP2StaticException( $err );
+            throw WsLog::ex( $err );
         }
 
         return $url_host;
diff --git a/src/SitemapParser.php b/src/SitemapParser.php
@@ -116,21 +116,24 @@ public function __construct( $user_agent = self::DEFAULT_USER_AGENT, array $conf
      */
     public function parseRecursive( $url ) {
         $this->addToQueue( [ $url ] );
+        $todo = $this->getQueue();
 
-        // TODO: ignore until refactor, need to tear apart
-        // phpcs:ignore Squiz.PHP.DisallowSizeFunctionsInLoops.Found
-        while ( count( $todo = $this->getQueue() ) > 0 ) {
+        while ( count( $todo ) > 0 ) {
             $sitemaps = $this->sitemaps;
             $urls = $this->urls;
+
             try {
-                $this->parse( strval( $todo[0] ) );
+                $this->parse( strval( array_shift( $todo ) ) );
             } catch ( WP2StaticException $e ) {
                 WsLog::w( $e->getMessage() );
                 // Keep crawling
                 continue;
             }
+
             $this->sitemaps = array_merge_recursive( $sitemaps, $this->sitemaps );
             $this->urls = array_merge_recursive( $urls, $this->urls );
+
+            $todo = $this->getQueue();
         }
     }
 
@@ -177,7 +180,7 @@ public function parse( $url, $url_content = null ) {
         $this->clean();
         $this->current_url = $this->urlEncode( $url );
         if ( ! $this->urlValidate( $this->current_url ) ) {
-            throw new WP2StaticException( 'Invalid URL' );
+            throw WsLog::ex( 'Invalid URL' );
         }
         $this->history[] = $this->current_url;
         $response = is_string( $url_content ) ? $url_content : $this->getContent();
@@ -227,7 +230,7 @@ protected function getContent() {
             $this->urlEncode( (string) $this->current_url );
 
         if ( ! $this->urlValidate( $this->current_url ) ) {
-            throw new WP2StaticException( 'Invalid URL' );
+            throw WsLog::ex( 'Invalid URL' );
         }
 
         try {
@@ -251,9 +254,9 @@ protected function getContent() {
                 return null;
             }
         } catch ( WP2StaticGuzzleHttp\Exception\TransferException $e ) {
-            throw new WP2StaticException( 'Unable to fetch URL contents', 0, $e );
+            throw WsLog::ex( 'Unable to fetch URL contents', 0, $e );
         } catch ( WP2StaticGuzzleHttp\Exception\GuzzleException $e ) {
-            throw new WP2StaticException( 'WP2StaticGuzzleHttp exception', 0, $e );
+            throw WsLog::ex( 'WP2StaticGuzzleHttp exception', 0, $e );
         }
     }
 
diff --git a/src/URL.php b/src/URL.php
@@ -34,7 +34,7 @@ public function __construct( string $urlstr, ?string $parent_page_url = null ) {
         } else {
             // test absolute URL
             if ( ! $url->getHost() ) {
-                throw new WP2StaticException(
+                throw WsLog::ex(
                     "Trying to create unsupported URL: $urlstr"
                 );
             }
diff --git a/src/URLHelper.php b/src/URLHelper.php
@@ -62,7 +62,7 @@ public static function modifyUrl( array $changes, string $url = '' ): string {
             ! isset( $url_array['host'] ) ||
             ! isset( $url_array['path'] )
         ) {
-            throw new WP2StaticException( 'Unable to parse URL' );
+            throw WsLog::ex( 'Unable to parse URL' );
         }
 
         return $url_array['scheme'] . '://' .
diff --git a/src/WsLog.php b/src/WsLog.php
@@ -26,6 +26,27 @@ public static function createTable(): void {
         dbDelta( $sql );
     }
 
+    /**
+     * Log an error message and return a throwable exception
+     *
+     * @param string $message
+     * @param int $code (default 0)
+     * @param \Throwable $previous (default null)
+     * @return \WP2Static\WP2StaticException
+     */
+    public static function ex(
+        string $message,
+        int $code = 0,
+        ?Throwable $previous = null
+    ): WP2StaticException {
+        self::l( $message );
+        return new WP2StaticException(
+            $message,
+            $code,
+            $previous
+        );
+    }
+
     public static function l( string $text ): void {
         global $wpdb;
 
diff --git a/tools/build_release.sh b/tools/build_release.sh

Original file line number	Diff line number	Diff line change
`@@ -511,7 +511,7 @@ public static function wp2staticEnqueueJobs( ?int $post_id = null ): void {`
`511`	`511`	`public static function wp2staticToggleAddon( string $addon_slug = null ): void {`
`512`	`512`	`if ( defined( 'WP_CLI' ) ) {`
`513`	`513`	`if ( ! $addon_slug ) {`
`514`		`- throw new WP2StaticException(`
	`514`	`+ throw WsLog::ex(`
`515`	`515`	`'No addon slug given for CLI toggling'`
`516`	`516`	`);`
`517`	`517`	`}`
Original file line number	Diff line number	Diff line change
`@@ -120,6 +120,8 @@ public static function wp2staticCrawl( string $crawler_slug ): void {`
`120`	`120`	`}`
`121`	`121`	`$crawled = $url_discovery->discoverURLs( $crawled );`
`122`	`122`	`foreach ( $crawled as $_ ) {`
	`123`	`+ // Intentionally empty to consume the iterator`
	`124`	`+ continue;`
`123`	`125`	`}`
`124`	`126`
`125`	`127`	`$has_new = true;`
Original file line number	Diff line number	Diff line change
`@@ -163,8 +163,7 @@ public static function detect( string $wp_site_url, bool $log = false ): \Iterat`
`163`	`163`	`}`
`164`	`164`	`}`
`165`	`165`	`} catch ( WP2StaticException $e ) {`
`166`		`- WsLog::l( $e->getMessage() );`
`167`		`- throw new WP2StaticException( $e->getMessage(), 0, $e );`
	`166`	`+ throw WsLog::ex( $e->getMessage(), 0, $e );`
`168`	`167`	`}`
`169`	`168`	`}`
`170`	`169`	`}`