Merge pull request #149 from rollbar/fixed/issue-147-class-name-collision

danielmorell · web-flow · commit 30f7fbdd1249 · 2026-03-06T12:04:19.000-06:00
Fixed #147 Added NamespaceTokenFixer to fix unscoped namespace strings
diff --git a/.github/workflows/php_unit.yml b/.github/workflows/php_unit.yml
@@ -102,17 +102,28 @@ jobs:
           cp phpcs.xml dist/phpcs.xml
           cp phpunit.xml dist/phpunit.xml
           cp -r tests dist/tests
+          cp -r utils dist/utils
 
       - name: Install Dist Composer Dependencies
         if: matrix.php != '8.5'
         working-directory: dist
         run: composer install --no-interaction --no-progress --no-suggest --optimize-autoloader
 
+      - name: Build Conflict Plugin
+        if: matrix.php != '8.5'
+        working-directory: dist
+        run: npm run build-conflict
+
       - name: Start Dist Docker environment
         if: matrix.php != '8.5'
         working-directory: dist
         run: npm run wp-env start
 
+      - name: Install Conflict Plugin
+        if: matrix.php != '8.5'
+        working-directory: dist
+        run: npm run install-conflict
+
       - name: Log running Dist Docker containers
         if: matrix.php != '8.5'
         working-directory: dist
diff --git a/.wp-env.json b/.wp-env.json
@@ -1,18 +1,19 @@
 {
-	"core": "WordPress/WordPress",
-	"plugins": [ "." ],
-	"config": {
+    "core": "WordPress/WordPress",
+    "plugins": [ "." ],
+    "config": {
         "WP_ENVIRONMENT_TYPE": "production",
         "WP_ENV": "production",
-		"WP_DEBUG": true,
-		"WP_DEBUG_LOG": true,
-		"WP_DEBUG_DISPLAY": true
-	},
-	"env": {
-		"tests": {
-			"mappings": {
-				"wp-content/plugins/rollbar": "./"
-			}
-		}
-	}
+        "WP_DEBUG": true,
+        "WP_DEBUG_LOG": true,
+        "WP_DEBUG_DISPLAY": true
+    },
+    "env": {
+        "tests": {
+            "mappings": {
+                "wp-content/plugins/rollbar": "./",
+                "wp-content/plugins/conflict": "./tests/conflict"
+            }
+        }
+    }
 }
diff --git a/composer.json b/composer.json
@@ -36,7 +36,8 @@
     },
     "autoload-dev": {
         "psr-4": {
-            "Rollbar\\WordPress\\Tests\\": "tests/"
+            "Rollbar\\WordPress\\Tests\\": "tests/",
+            "Rollbar\\WordPress\\BuildUtils\\": "utils/"
         }
     },
     "extra": {
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -12,11 +12,12 @@
         "test": "npm-run-all test:php test:phpcs",
         "tests-composer-update": "WP_ENV_PHP_VERSION='8.1' npm run wp-env -- run --env-cwd='wp-content/plugins/rollbar' tests-cli composer update",
         "tests-composer-install": "WP_ENV_PHP_VERSION='8.1' npm run wp-env -- run --env-cwd='wp-content/plugins/rollbar' tests-cli composer install --no-interaction",
-        "pretest:php": "npm-run-all tests-composer-install",
         "test:php": "npm run wp-env -- run tests-wordpress /var/www/html/wp-content/plugins/rollbar/vendor/bin/phpunit -c /var/www/html/wp-content/plugins/rollbar/phpunit.xml",
         "test:phpcs": "npm run wp-env -- run tests-wordpress /var/www/html/wp-content/plugins/rollbar/vendor/bin/phpcs --standard=/var/www/html/wp-content/plugins/rollbar/phpcs.xml -p",
         "start": "npm run wp-env start",
-        "build": "cp -f node_modules/rollbar/dist/rollbar.snippet.js public/js/rollbar.snippet.js"
+        "build": "cp -f node_modules/rollbar/dist/rollbar.snippet.js public/js/rollbar.snippet.js",
+        "build-conflict": "cd tests/conflict && composer install --no-interaction --no-progress --no-suggest --optimize-autoloader",
+        "install-conflict": "npm run wp-env -- run tests-cli wp plugin activate conflict"
     },
     "repository": {
         "type": "git",
diff --git a/phpcs.xml b/phpcs.xml
@@ -13,6 +13,7 @@
     <file>./mu-plugin</file>
     <file>./src</file>
     <file>./tests</file>
+    <file>./utils</file>
     <file>./rollbar.php</file>
 
     <!-- Show sniff codes in all reports -->
diff --git a/scoper.inc.php b/scoper.inc.php
@@ -2,7 +2,10 @@
 
 declare(strict_types=1);
 
+require_once './utils/NamespaceTokenFixer.php';
+
 $finder = Isolated\Symfony\Component\Finder\Finder::class;
+$fixer = new Rollbar\WordPress\BuildUtils\NamespaceTokenFixer();
 
 return [
     'prefix' => 'RollbarWP',
@@ -46,14 +49,10 @@
         'zend_monitor_custom_event',
     ],
     'patchers' => [
-        static function (string $filePath, string $prefix, string $content): string {
-            // Fix ClassLoader in string not being prefixed.
-            if ($filePath === __DIR__ . '/build/vendor/composer/autoload_real.php') {
-                $content = str_replace(
-                    '(\'Composer\\\\Autoload\\\\ClassLoader\' === $class)',
-                    '(\'RollbarWP\Composer\Autoload\ClassLoader\' === $class)',
-                    $content,
-                );
+        static function (string $filePath, string $prefix, string $content) use ($fixer): string {
+            if ($fixer->fileIsFixable($filePath)) {
+                $fixer->configure($filePath, $content);
+                $content = $fixer->fix();
             }
 
             return $content;
diff --git a/tests/conflict/composer.json b/tests/conflict/composer.json
@@ -0,0 +1,15 @@
+{
+    "name": "conflict/conflict",
+    "description": "This is a test plugin that has dependency conflicts.",
+    "minimum-stability": "stable",
+    "license": "MIT",
+    "require": {
+        "psr/log": "^1.0",
+        "monolog/monolog": "^1.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "Conflict\\": "src/"
+        }
+    }
+}
diff --git a/tests/conflict/composer.lock b/tests/conflict/composer.lock
diff --git a/tests/conflict/conflict.php b/tests/conflict/conflict.php
@@ -0,0 +1,24 @@
+<?php
+
+/**
+ * Plugin Name: Conflict
+ * Plugin URI: https://github.com/rollbar/rollbar-php-wordpress/tree/master/tests/conflict
+ * Description: A test plugin that conflicts with Rollbar.
+ * Version: 1.0.0
+ * Author: Rollbar
+ * Author URI: https://rollbar.com
+ * Text Domain: conflict
+ * License: MIT
+ * Requires PHP: 8.1
+ * Tested up to: 6.9
+ * Requires at least: 6.5
+ */
+
+// Exit if accessed directly
+defined('ABSPATH') || exit;
+
+const CONFLICT_PLUGIN_DIR = __DIR__;
+
+require_once CONFLICT_PLUGIN_DIR . '/vendor/autoload.php';
+
+\Conflict\Plugin::init();
diff --git a/tests/conflict/src/Plugin.php b/tests/conflict/src/Plugin.php
@@ -0,0 +1,49 @@
+<?php
+
+namespace Conflict;
+
+use Monolog\Handler\StreamHandler;
+use Monolog\Logger;
+
+/**
+ * This is a tiny plugin that will create a conflict with any other plugin that also uses Monolog unscoped.
+ *
+ * This is used to validate the scoping of Rollbar plugin's Monolog dependency.
+ */
+final class Plugin
+{
+    /**
+     * @var Logger $logger The logger instance.
+     */
+    private static Logger $logger;
+
+    /**
+     * Private constructor to prevent instantiation.
+     */
+    private function __construct()
+    {
+    }
+
+    /**
+     * Initializes the plugin.
+     *
+     * @return void
+     */
+    public static function init(): void
+    {
+        self::$logger = new Logger('conflict');
+        self::$logger->pushHandler(new StreamHandler(WP_CONTENT_DIR . '/logs/conflict.log', Logger::WARNING));
+
+        add_action('init', self::onInit(...));
+    }
+
+    /**
+     * Logs when the plugin is initialized.
+     *
+     * @return void
+     */
+    public static function onInit(): void
+    {
+        self::$logger->warning('Conflict plugin initialized.');
+    }
+}
diff --git a/tests/utils/NamespaceTokenFixerTest.php b/tests/utils/NamespaceTokenFixerTest.php
diff --git a/utils/NamespaceTokenFixer.php b/utils/NamespaceTokenFixer.php
