Move PL plugin under `plugins/performance-lab` #1182

thelovekesh · 2024-04-25T16:43:19Z

Summary

Relevant technical choices

Relocate the plugin to the plugins/performance-lab directory.
Create a dummy plugin file in the root directory for wp-env mounting purposes and to display an administrative notification if an attempt is made to install it on a production environment.

thelovekesh · 2024-04-25T17:07:13Z

performance.php

+ * Description: The Performance Monorepo is not a plugin rather a collection of performance features as plugins. Download <a href="https://wordpress.org/plugins/performance-lab/" to install performance features instead.
+ * Author: WordPress Performance Team
+ * Author URI: https://make.wordpress.org/performance/
+ * Text Domain: performance-lab


Initially, I kept it performance but tests have performance-lab text domain so switched it. But keeping it performance-lab doesn't seem right given it's already taken by the PL plugin.

I like the idea of providing some feedback to anyone who tries to install the whole repo. I think using the performance-lab text domain is likely fine. I wonder if we could even automatically load the root file for the actual Performance Lab plugin if someone ends up in this situation?

@joemcgill For users utilizing wp-env, it should function as expected. However, for those with custom setups, we should include documentation on how to work with the monorepo. Simply activating the PL plugin isn't sufficient since we need to provide references to other plugins as well. It could also be confusing if one plugin from the /plugins directory is loaded while others are not.

@westonruter Any thoughts here?

We're currently lacking such documentation for users who want to work on the standalone plugins as well, so I don't see this as a blocker.

I've updated notices in 8cbac0c with a link to the handbook page. We can add documentation there for how to handle contributing when not using wp-env.

I think this is a good step. Thanks.

westonruter

Looking good!

performance.php

westonruter · 2024-04-25T17:39:59Z

tests/bootstrap.php

-		},
-		1
-	);
+	if ( 'performance-lab' === $plugin_name ) {


Doesn't the --testsuite need to always be supplied now? If $plugi_bane is empty, shouldn't an error occur?

I have set the default test suite to performance-lab. See 7a5dea4

github-actions · 2024-05-16T11:54:57Z

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: thelovekesh <thelovekesh@git.wordpress.org>
Co-authored-by: westonruter <westonruter@git.wordpress.org>
Co-authored-by: joemcgill <joemcgill@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

westonruter · 2024-05-17T00:49:15Z

Let's prioritize merging this right after the 3.1.0 release.

joemcgill

I dig this idea and it's looking really good. I've added some feedback inline.

.wp-env.json

bin/plugin/commands/readme.js

bin/plugin/commands/since.js

composer.json

package.json

joemcgill · 2024-05-18T00:23:10Z

.github/workflows/deploy-plugins.yml

We can't test this workflow in debug mode until after this PR is merged, so let's make sure to check that this works once after merging.

joemcgill · 2024-05-18T00:26:57Z

performance.php

+ * Description: The Performance Monorepo is not a plugin rather a collection of performance features as plugins. Download <a href="https://wordpress.org/plugins/performance-lab/" to install performance features instead.
+ * Author: WordPress Performance Team
+ * Author URI: https://make.wordpress.org/performance/
+ * Text Domain: performance-lab


I like the idea of providing some feedback to anyone who tries to install the whole repo. I think using the performance-lab text domain is likely fine. I wonder if we could even automatically load the root file for the actual Performance Lab plugin if someone ends up in this situation?

phpcs.xml.dist

plugins/performance-lab/phpcs.xml.dist

thelovekesh · 2024-05-22T11:31:17Z

In my opinion, the contents of .gitattributes for ignoring files in the archive are no longer relevant.

westonruter · 2024-05-22T17:32:18Z

In my opinion, the contents of .gitattributes for ignoring files in the archive are no longer relevant.

@thelovekesh Agreed. Let's eliminate all of these lines:

performance/.gitattributes

Lines 3 to 43 in be4c00a

    
           /.git export-ignore 
        
           /.github export-ignore 
        
           /.wordpress-org export-ignore 
        
           /.husky export-ignore 
        
           /node_modules export-ignore 
        
           /vendor export-ignore 
        
           /bin export-ignore 
        
           /docs export-ignore 
        
           /tests export-ignore 
        
           /plugin-tests export-ignore 
        
           /plugins export-ignore 
        
           /plugins.json export-ignore 
        
           /*.DS_store export-ignore 
        
           /.DS_store? export-ignore 
        
           /.editorconfig export-ignore 
        
           /.eslintrc.js export-ignore 
        
           /.nvmrc export-ignore 
        
           /.wp-env.json export-ignore 
        
           /composer.json export-ignore 
        
           /composer.lock export-ignore 
        
           /package.json export-ignore 
        
           /package-lock.json export-ignore 
        
           phpcs.xml.dist export-ignore 
        
           /phpstan.neon.dist export-ignore 
        
           /phpunit.xml.dist export-ignore 
        
           /webpack.config.js export-ignore 
        
           /CONTRIBUTING.md export-ignore 
        
           /SECURITY.md export-ignore 
        
           /README.md export-ignore 
        
           /.gitattributes export-ignore 
        
           /.gitignore export-ignore 
        
           /modules/**/readme.txt export-ignore 
        
           /modules/**/.wordpress-org export-ignore 
        
           /plugins/**/.wordpress-org export-ignore

westonruter · 2024-05-22T17:58:54Z

phpstan.neon.dist

+		- plugins
+		- tests
+		- performance.php
+		- plugins/performance-lab/load.php


This line is redundant since it is already inside the plugins directory now:

Suggested change

- plugins/performance-lab/load.php

@westonruter If I remove this, I got the following error:

------ ------------------------------------------------------------------------------------------------ Line tests/plugins/performance-lab/load-tests.php ------ ------------------------------------------------------------------------------------------------ :35 Call to method PHPUnit\Framework\Assert::assertFalse() with int will always evaluate to false. :50 Call to method PHPUnit\Framework\Assert::assertFalse() with int will always evaluate to false. :73 Call to method PHPUnit\Framework\Assert::assertFalse() with int will always evaluate to false. :144 Call to method PHPUnit\Framework\Assert::assertFalse() with int will always evaluate to false. ------ ------------------------------------------------------------------------------------------------

I think it has something to do with the file loading order.

Interesting. I don't get that error with that line removed.

$ npm run phpstan > phpstan > composer phpstan > phpstan analyse --memory-limit=2048M Note: Using configuration file /home/westonruter/repos/performance/phpstan.neon.dist. 107/107 [▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓] 100% [OK] No errors

Interesting. Which version are you on?

Can you try with --debug flag once since it disables the cache? Also, it was failing in CI as well - https://github.com/WordPress/performance/actions/runs/9111313232/job/25048167246

Humm. No errors when passing --debug either.

🤔

No configs override with phpstan.neon in the root?

No 😞

$ npm run phpstan -- -- --debug > phpstan > composer phpstan -- --debug > phpstan analyse --memory-limit=2048M '--debug' ! [NOTE] The Xdebug PHP extension is active, but "--xdebug" is not used. ! The process was restarted and it will not halt at breakpoints. ! Use "--xdebug" if you want to halt at breakpoints. Note: Using configuration file /home/westonruter/repos/performance/phpstan.neon.dist. /home/westonruter/repos/performance/plugins/optimization-detective/class-od-data-validation-exception.php ... /home/westonruter/repos/performance/performance.php [OK] No errors

Failing in wp-env as well with and without XDebug.

composer.json

phpcs.xml.dist

westonruter

Great work and great changes! 🎉

package.json

Co-authored-by: Weston Ruter <westonruter@google.com>

joemcgill

I think we should go ahead and merge this. I think there's some follow-up work we need to do to make it easier to run PHPUnit locally, but that can be handled in a follow-up issue.

thelovekesh force-pushed the move/pl-plugin-to-plugins branch from 16605b4 to 5f9587e Compare April 25, 2024 16:44

thelovekesh added [Type] Enhancement A suggestion for improvement of an existing feature Infrastructure Issues for the overall performance plugin infrastructure no milestone PRs that do not have a defined milestone for release labels Apr 25, 2024

thelovekesh commented Apr 25, 2024

View reviewed changes

westonruter reviewed Apr 25, 2024

View reviewed changes

westonruter mentioned this pull request May 3, 2024

Feature: Allow updating with git-updater #574

Closed

thelovekesh force-pushed the move/pl-plugin-to-plugins branch from 29e4657 to 5c11950 Compare May 16, 2024 09:59

thelovekesh marked this pull request as ready for review May 16, 2024 11:54

thelovekesh requested review from adamsilverstein, felixarntz, joemcgill, manuelRod and mukeshpanchal27 as code owners May 16, 2024 11:54

thelovekesh requested a review from westonruter May 16, 2024 11:54

westonruter mentioned this pull request May 17, 2024

Bump plugin versions and add versions command to verify version consistency in plugins #1221

Merged

joemcgill reviewed May 18, 2024

View reviewed changes

westonruter added this to the performance-lab n.e.x.t milestone May 20, 2024

thelovekesh added 10 commits May 22, 2024 12:29

Move PL plugin files to plugins/performance-lab

92e2ce2

Add performance-lab to plugins.json

9e06ddd

Move dotorg assets to PL plugin in plugins directory

38f2e9d

Update build command for PL plugin

cd0f1be

Move PHPCS config for PL plugins/performance-lab

a0336b0

Update wp-env config to include PL plugin from plugins directory

797f2ff

Update PHPCS config

a421c68

Add placeholder plugin file for performance monorepo

c719034

Mount root in wp-env

2533f82

Update test scritps

09569fc

thelovekesh added 4 commits May 22, 2024 12:32

Move test data images from modules to test/data

fff04de

Move perflab main plugin file tests to its tests dir

f946536

Add perflab load.php in paths to get loaded early

618446f

Set default testsuite

af1b602

thelovekesh force-pushed the move/pl-plugin-to-plugins branch from 7a5dea4 to af1b602 Compare May 22, 2024 07:02

thelovekesh added 5 commits May 22, 2024 12:54

Remove edge case of PL plugin to be refered as the root plugin

2937407

Mount plugin root files in tests

db957d4

Fix cwd in wp-env tests

23de67a

Update ruleset name

a0f00cc

Update lint:all script

0596b06

thelovekesh mentioned this pull request May 22, 2024

Add zip-plugin-builds command #1228

Merged

thelovekesh force-pushed the move/pl-plugin-to-plugins branch from c9f44d0 to 0596b06 Compare May 22, 2024 11:23

thelovekesh requested a review from joemcgill May 22, 2024 17:19

Update monorepo notices

8cbac0c

westonruter mentioned this pull request May 22, 2024

Add generate-pending-release-diffs command #1227

Merged

thelovekesh and others added 3 commits May 22, 2024 23:20

Remove redundant export-ignores

f5f5fbb

Remove obsolete condition in since command

e3dc1a6

Add github-linguist docs for reference

d9cd4d4

westonruter reviewed May 22, 2024

View reviewed changes

composer.json Show resolved Hide resolved

westonruter reviewed May 22, 2024

View reviewed changes

phpcs.xml.dist Show resolved Hide resolved

westonruter approved these changes May 22, 2024

View reviewed changes

westonruter reviewed May 22, 2024

View reviewed changes

package.json Outdated Show resolved Hide resolved

thelovekesh and others added 2 commits May 23, 2024 00:31

Update PHP tests commands

f0d034d

Co-authored-by: Weston Ruter <westonruter@google.com>

Update test command in php-test-plugins workflow

8bc9e7d

joemcgill approved these changes May 22, 2024

View reviewed changes

westonruter merged commit 8eeaeb6 into trunk May 22, 2024
18 checks passed

westonruter deleted the move/pl-plugin-to-plugins branch May 22, 2024 19:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move PL plugin under `plugins/performance-lab` #1182

Move PL plugin under `plugins/performance-lab` #1182

thelovekesh commented Apr 25, 2024

thelovekesh Apr 25, 2024

joemcgill May 18, 2024

thelovekesh May 22, 2024

westonruter May 22, 2024

westonruter May 22, 2024

westonruter May 22, 2024

joemcgill May 22, 2024

westonruter left a comment

westonruter Apr 25, 2024

thelovekesh May 16, 2024

github-actions bot commented May 16, 2024

westonruter commented May 17, 2024

joemcgill left a comment

joemcgill May 18, 2024

joemcgill May 18, 2024

thelovekesh commented May 22, 2024 •

edited

westonruter commented May 22, 2024 •

edited

westonruter May 22, 2024 •

edited

thelovekesh May 22, 2024

westonruter May 22, 2024

thelovekesh May 22, 2024

westonruter May 22, 2024

thelovekesh May 22, 2024 •

edited

westonruter May 22, 2024 •

edited

thelovekesh May 22, 2024

westonruter May 22, 2024

thelovekesh May 22, 2024

westonruter left a comment

joemcgill left a comment

Move PL plugin under plugins/performance-lab #1182

Move PL plugin under plugins/performance-lab #1182

Conversation

thelovekesh commented Apr 25, 2024

Summary

Relevant technical choices

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

westonruter left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented May 16, 2024

westonruter commented May 17, 2024

joemcgill left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thelovekesh commented May 22, 2024 • edited

westonruter commented May 22, 2024 • edited

westonruter May 22, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thelovekesh May 22, 2024 • edited

Choose a reason for hiding this comment

westonruter May 22, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

westonruter left a comment

Choose a reason for hiding this comment

joemcgill left a comment

Choose a reason for hiding this comment

Move PL plugin under `plugins/performance-lab` #1182

Move PL plugin under `plugins/performance-lab` #1182

thelovekesh commented May 22, 2024 •

edited

westonruter commented May 22, 2024 •

edited

westonruter May 22, 2024 •

edited

thelovekesh May 22, 2024 •

edited

westonruter May 22, 2024 •

edited