PLANET-7686: Upgrade WP Stateless to version `4.1.3` #335

mardelnet · 2025-03-31T08:40:21Z

Ref: https://jira.greenpeace.org/browse/PLANET-7686
Related PR: greenpeace/planet4-master-theme#2598

Testing 1

Set up a new development environment based out of a multilingual site (ie: GP Africa). For more details about running a WPML-enabled website locally, check this comment.
Upgrade the plugin on your local environment using the command: npx wp-env run cli wp plugin update wp-stateless
Confirm the upgrade from the plugins page.
Go to the Stateless settings (/wp-admin/upload.php?page=stateless-settings) and change the mode to Stateless. You will need extra data to make it work (Bucket, Service Account JSON, and Domain). You can copy it from the Gutenberg instance.
Run the data optimization by clicking on this button:
Wait for the process in the previous step to finish. You can check the status from here: Info > WP-Stateless > Data Optimization.
Go to the Media Library. Add and remove some files. The changes should be reflected in the Google Cloud bucket.
Replace some files using the Media Replacer (remember to flush the file cache after replacing it to see the new one). The changes should be reflected in the Google Cloud bucket, too.
Go to the Greenpeace Media page. Add some files. The changes should be reflected in the Google Cloud bucket.
Export a post or page with files in it. Import it in another P4 website. Check that everything looks all alright and that the changes were reflected in the Google Cloud bucket.
Repeat the previous step, but now do the opposite: import a post or page in your local environment.

Testing 2

Run the GP International site locally.
Upgrade the plugin following the steps of "Testing 1".
Check if this problem is fixed: https://jira.greenpeace.org/browse/PLANET-7558

Notes

Do we also want to try the Gravity Form add-on, @comzeradd?

- From version 3.4.1 to 4.1.3

gemini-code-assist

Hello @mardelnet, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

Summary of Changes

This pull request upgrades the wp-stateless plugin dependency in composer.json from version 3.4.1 to 4.1.3. This update likely includes new features, bug fixes, and performance improvements provided by the newer version of the plugin.

Highlights

Dependency Upgrade: The wp-stateless plugin has been upgraded from version 3.4.1 to 4.1.3 in the composer.json file.

Changelog

composer.json
- Upgraded wpackagist-plugin/wp-stateless from version 3.4.1 to 4.1.3.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in issue comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Trivia time!

What is Composer, and what problem does it solve?

Click here for the answer

Composer is a dependency management tool for PHP. It allows you to declare the libraries your project depends on and it will manage (install/update) them for you.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist

Code Review

The pull request updates the wp-stateless plugin version in the composer.json file. This is a straightforward update, and the change appears correct.

Merge Readiness

The pull request updates a dependency version. Given the limited scope of the change, it seems appropriate for merging, assuming that the update has been tested and verified to be compatible with the project. I am unable to directly approve the pull request, and users should have others review and approve this code before merging.

sagarsdeshmukh · 2025-04-08T06:12:27Z

Regarding WP-Stateless - Gravity Forms Addon, IMO we should use it along with a WP_STATELESS_COMPATIBILITY_GF constant.

mardelnet · 2025-04-08T07:20:16Z

Regarding WP-Stateless - Gravity Forms Addon, IMO we should use it along with a WP_STATELESS_COMPATIBILITY_GF constant.

Thanks, @sagarsdeshmukh
We could implement it in another PR if @comzeradd agrees.

sagarsdeshmukh · 2025-04-08T13:00:24Z

Nice job @mardelnet 🎉

I have tested the new version of WP-Stateless on my local environment as well as the following test environments:

The new version of the WP-Stateless plugin is working as expected. No issues were encountered during testing.
Below are few suggestions/notes:

We can use the CLI command wp stateless migrate to perform data optimizations via the post-deploy script.
After running the data optimization, the notice banner keeps displaying:
'WP-Stateless: Data Optimization Complete.'
We can consider hiding this banner once the optimization is done, as it might be confusing for editors.
Since the 'data optimization' operation takes a few minutes(eg. The GP Africa dev site tooks 12 mins) to complete, we’ll need to plan its execution carefully. Additionally, the following points should be considered:

Create a backup copy of wp database.
Do not upload, edit, or delete media or files while the optimization process is underway.
Perform this update during a low period in your website traffic.

mardelnet · 2025-04-08T13:59:09Z

Thank you so much, @sagarsdeshmukh

We can use the CLI command wp stateless migrate to perform data optimizations via the post-deploy script.

Can you please explain how to do this? I've no experience in adding or editing CLI commands.

After running the data optimization, the notice banner keeps displaying:
'WP-Stateless: Data Optimization Complete.'
We can consider hiding this banner once the optimization is done, as it might be confusing for editors.

How do you suggest doing this? PHP I suppose, right?

Since the 'data optimization' operation takes a few minutes(eg. The GP Africa dev site tooks 12 mins) to complete, we’ll need to plan its execution carefully. Additionally, the following points should be considered:

Create a backup copy of wp database.
Do not upload, edit, or delete media or files while the optimization process is underway.
Perform this update during a low period in your website traffic.

I'm adding @comzeradd to this conversation to discuss how to action in this last point.

sagarsdeshmukh · 2025-04-09T06:49:10Z

Can you please explain how to do this? I've no experience in adding or editing CLI commands.

With every deployment, post-deploy scripts are executed—such as migration script or the 'Disable Attachment Pages' script.
We can include the data optimization CLI command as part of a new post-deploy script in the same way at here.

How do you suggest doing this? PHP I suppose, right?

Yes, that's right. The code below might be helpful -

add_action('admin_print_scripts', function () {
    echo '<style>
        #stateless-notice-migrations-finished { display: none !important; }
    </style>';
});

- From version 3.4.1 to 4.1.3

- Add post-deploy script

…ithub.com/greenpeace/planet4-base into PLANET-7686_upgrade-wp-stateless-to-4.1.x

mardelnet · 2025-04-09T09:03:15Z

Thanks @sagarsdeshmukh !

Can you please explain how to do this? I've no experience in adding or editing CLI commands.

With every deployment, post-deploy scripts are executed—such as migration script or the 'Disable Attachment Pages' script. We can include the data optimization CLI command as part of a new post-deploy script in the same way at here.

The post-deploy script was added. Can you please check it?

How do you suggest doing this? PHP I suppose, right?

Yes, that's right. The code below might be helpful -

I am not completely sure whether adding this would be a good idea for 2 reasons: editors can hide the message by simply clicking the close button (it doesn't re-appear on page reload) and the CSS code will hide any other future message related to migrations in WP Stateless. What do you think?

sagarsdeshmukh · 2025-04-09T09:19:15Z

tasks/post-deploy/09-stateless-data-optimization.sh

+#!/bin/bash
+
+echo "Perform WP-Stateless data optimization..."
+wp stateless migrate


This command lists a optimization id/records

$ npx wp-env run cli wp stateless migrate +----------------+------------------------------------+---------+--------------+ | id | description | status | message | +----------------+------------------------------------+---------+--------------+ | 20240423174109 | Optimize Compatibility Files | Skipped | Not required | | 20240219175240 | Update data for Google Cloud files | Pending | Ready to run | +----------------+------------------------------------+---------+--------------+

We need to provide params with above command,
when we run npx wp-env run cli wp stateless -help on local -

usage: wp stateless migrate [<id|auto>] [--force] [--progress=<val>] [--email=<val>] [--yes] [--url=<val>] or: wp stateless reset_cache_control [--url=<val>] or: wp stateless sync <type> [--url=<val>] [--start=<val>] [--limit=<val>] [--end=<val>] [--batch=<val>] [--batches=<val>] [--b] [--log] [--o] [--order=<val>] or: wp stateless upgrade <type> [--url=<val>] [--start=<val>] [--limit=<val>] [--end=<val>] [--batch=<val>] [--batches=<val>] [--b] [--log] [--o]

I tried below command on local which works for me -
wp stateless migrate auto [email protected] --yes
here --yes skip confirmation(ref.)

Thanks!
Should we use Nikos' email or is there a way to add the website admin's email?

I guess by default it will pick the website admin's email, but if we want to track the status during release process its good to add Nikos mail id.

Done, @sagarsdeshmukh

Is the command required for the upgrade? I deployed the branch on a test instance and the process times out because it takes a lot of time to finish.

We could upgrade the plugin and then I could manually trigger the migrate command outside of CircleCI

Nice catch @comzeradd
In that case, manually triggering the migrate command will be better (I just removed it).
Perhaps we should let the NROs know of that beforehand so they don't do the same.

We could hide the notices temporarily, just to make sure with a simple css rule. Right now I'm seeing this:

Something like that should work:

.stateless-admin-notice { display: none !important; }

That's something to be done in the master theme, right @comzeradd?

Yes, I think it makes more sense to be in the theme

Done: greenpeace/planet4-master-theme#2598

- Adjust post-deploy script

mardelnet · 2025-04-14T12:49:34Z

@sagarsdeshmukh @comzeradd
Any additional comments regarding this PR?

comzeradd · 2025-04-15T07:18:03Z

Any additional comments regarding this PR?

Testing the PR locally seems to work fine. But I'm getting a notice about the GF Add-on that may be confusing for NRO admins, thinking that the connection with GF is broken. So I think that may it's better to also install the add-on on this PR to have it in place on releasing this upgrade.

mardelnet · 2025-04-15T10:46:39Z

Any additional comments regarding this PR?

Testing the PR locally seems to work fine. But I'm getting a notice about the GF Add-on that may be confusing for NRO admins, thinking that the connection with GF is broken. So I think that may it's better to also install the add-on on this PR to have it in place on releasing this upgrade.

Thanks @comzeradd
I've included the addon in the composer.json file and its installation in the post-deploy script.

comzeradd · 2025-04-16T07:53:09Z

tasks/post-deploy/09-wp-stateless.sh

+wp plugin activate wp-stateless-gravity-forms-addon
+
+echo "Perform WP-Stateless data optimization..."
+wp stateless migrate auto [email protected] --yes


The script is not executable, failing to run. You can change that with:

chmod +x 09-wp-stateless.sh

- Install and activate the GF addon

sagarsdeshmukh · 2025-04-18T05:47:31Z

@sagarsdeshmukh @comzeradd Any additional comments regarding this PR?

Nothing to add from my side — looks good to me.

Upgrade WP Stateless

96784d4

- From version 3.4.1 to 4.1.3

mardelnet self-assigned this Mar 31, 2025

gemini-code-assist bot reviewed Mar 31, 2025

View reviewed changes

mardelnet changed the title ~~Upgrade WP Stateless to version 4.1.3~~ PLANET-7686: Upgrade WP Stateless to version 4.1.3 Mar 31, 2025

mardelnet requested a review from sagarsdeshmukh March 31, 2025 09:41

mardelnet added the Review label Mar 31, 2025

mardelnet added 3 commits April 9, 2025 10:45

Upgrade WP Stateless

4780f4c

- From version 3.4.1 to 4.1.3

Upgrade WP Stateless

d923cae

- Add post-deploy script

Merge branch 'PLANET-7686_upgrade-wp-stateless-to-4.1.x' of https://g…

e8fab62

…ithub.com/greenpeace/planet4-base into PLANET-7686_upgrade-wp-stateless-to-4.1.x

sagarsdeshmukh reviewed Apr 9, 2025

View reviewed changes

Upgrade WP Stateless

635d1a7

- Adjust post-deploy script

mardelnet requested a review from sagarsdeshmukh April 9, 2025 10:03

mardelnet force-pushed the PLANET-7686_upgrade-wp-stateless-to-4.1.x branch from 8162496 to 3154e4d Compare April 15, 2025 10:45

comzeradd reviewed Apr 16, 2025

View reviewed changes

mardelnet force-pushed the PLANET-7686_upgrade-wp-stateless-to-4.1.x branch from 3154e4d to 135461f Compare April 16, 2025 07:59

Upgrade WP Stateless

60be9a8

- Install and activate the GF addon

mardelnet force-pushed the PLANET-7686_upgrade-wp-stateless-to-4.1.x branch from 135461f to 60be9a8 Compare April 16, 2025 08:30

mardelnet requested a review from comzeradd April 16, 2025 08:32

mardelnet mentioned this pull request Apr 16, 2025

PLANET-7686: Hide WP-Stateless admin notices greenpeace/planet4-master-theme#2598

Merged

sagarsdeshmukh approved these changes Apr 18, 2025

View reviewed changes

mardelnet merged commit f448e26 into main Apr 21, 2025
1 check passed

mardelnet deleted the PLANET-7686_upgrade-wp-stateless-to-4.1.x branch April 21, 2025 07:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

PLANET-7686: Upgrade WP Stateless to version `4.1.3` #335

PLANET-7686: Upgrade WP Stateless to version `4.1.3` #335

mardelnet commented Mar 31, 2025 •

edited

Loading

gemini-code-assist bot left a comment

gemini-code-assist bot left a comment

sagarsdeshmukh commented Apr 8, 2025

mardelnet commented Apr 8, 2025

sagarsdeshmukh commented Apr 8, 2025

mardelnet commented Apr 8, 2025

sagarsdeshmukh commented Apr 9, 2025

mardelnet commented Apr 9, 2025

sagarsdeshmukh Apr 9, 2025

mardelnet Apr 9, 2025

sagarsdeshmukh Apr 9, 2025

mardelnet Apr 9, 2025

comzeradd Apr 16, 2025

mardelnet Apr 16, 2025

comzeradd Apr 16, 2025

mardelnet Apr 16, 2025

comzeradd Apr 16, 2025

mardelnet Apr 16, 2025

mardelnet commented Apr 14, 2025

comzeradd commented Apr 15, 2025

mardelnet commented Apr 15, 2025

comzeradd Apr 16, 2025

mardelnet Apr 16, 2025

sagarsdeshmukh commented Apr 18, 2025 •

edited

Loading

PLANET-7686: Upgrade WP Stateless to version 4.1.3 #335

PLANET-7686: Upgrade WP Stateless to version 4.1.3 #335

Conversation

mardelnet commented Mar 31, 2025 • edited Loading

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Summary of Changes

Highlights

Changelog

Footnotes

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Merge Readiness

sagarsdeshmukh commented Apr 8, 2025

mardelnet commented Apr 8, 2025

sagarsdeshmukh commented Apr 8, 2025

mardelnet commented Apr 8, 2025

sagarsdeshmukh commented Apr 9, 2025

mardelnet commented Apr 9, 2025

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mardelnet commented Apr 14, 2025

comzeradd commented Apr 15, 2025

mardelnet commented Apr 15, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sagarsdeshmukh commented Apr 18, 2025 • edited Loading

PLANET-7686: Upgrade WP Stateless to version `4.1.3` #335

PLANET-7686: Upgrade WP Stateless to version `4.1.3` #335

mardelnet commented Mar 31, 2025 •

edited

Loading

sagarsdeshmukh commented Apr 18, 2025 •

edited

Loading