Consolidate Jetpack initial state

[manzoorwanijk]

This is the first attempt to consolidate initial state in Jetpack - pdWQjU-KI-p2

#38606 serves as the basic working example of the usage of the initial state (script data) added in this PR.

Proposed changes:

• Introduce a js package named script-data which provides some basic JS utility functions. Suggestions are welcome.
• Expose that script-data package via packages/assets, i.e. assets package will contain the build output from script-data js package.
• Make the script data filterable via hooks
• Any package/plugin intending to use the script-data can either import the package in its JS code or explicitly specify jetpack-script-data as a dependency to its JS script handle when registering/enqueueing it.

Other information:

• Have you written new tests for your changes, if applicable?
• Have you checked the E2E test CI results, and verified that your changes do not break them?
• Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

pdWQjU-KI-p2

Does this pull request change what data or activity we track or use?

Testing instructions:

This PR does not change anything, for any package/plugin. It just adds the support for initial state which can be used in subsequent PR. As mentioned above, #38606 serves as the basic working example of the usage of this PR.

• Just do a smoke test of Jetpack and Social pages and the post editor.

[github-actions]

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

• ✅ Include a description of your PR changes.
  
• ✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
  
• ✅ Add testing instructions.
  
• ✅ Specify whether this PR includes any changes to data or privacy.
  
• ✅ Add changelog entries to affected projects
  

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖

---

The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.

---

Once your PR is ready for review, check one last time that all required checks appearing at the bottom of this PR are passing or skipped.
Then, add the "[Status] Needs Team Review" label and ask someone from your team review the code. Once reviewed, it can then be merged.
If you need an extra review from someone familiar with the codebase, you can update the labels from "[Status] Needs Team Review" to "[Status] Needs Review", and in that case Jetpack Approvers will do a final review of your PR.

---

Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

• WordPress.com Simple releases happen daily.
• WoA releases happen weekly.
• Releases to self-hosted sites happen monthly. The next release is scheduled for none scheduled (scheduled code freeze on undefined).

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

---

Backup plugin:

• Next scheduled release: none scheduled.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

---

Boost plugin:

• Next scheduled release: none scheduled.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

---

Search plugin:

• Next scheduled release: none scheduled.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

---

Social plugin:

• Next scheduled release: none scheduled.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

---

Starter Plugin plugin:

• Next scheduled release: none scheduled.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

---

Protect plugin:

• Next scheduled release: August 12, 2024.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

---

Videopress plugin:

• Next scheduled release: none scheduled.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

---

Migration plugin:

• Next scheduled release: none scheduled.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

---

Mu Wpcom plugin:

• Next scheduled release: WordPress.com Simple releases happen daily.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

---

Inspect plugin:

• Next scheduled release: none scheduled.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

---

Wpcomsh plugin:

• Next scheduled release: on demand (usually Mondays if not sooner).

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

---

Automattic For agencies client plugin:

• Next scheduled release: none scheduled.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

---

Classic Theme helper plugin plugin:

• Next scheduled release: none scheduled.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

[github-actions]

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

• To test on WoA, go to the Plugins menu on a WordPress.com Simple site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin, and enable the add/consolidate-initial-state branch.

  • For jetpack-mu-wpcom changes, also add define( 'JETPACK_MU_WPCOM_LOAD_VIA_BETA_PLUGIN', true ); to your wp-config.php file.

• To test on Simple, run the following command on your sandbox:

  bin/jetpack-downloader test jetpack add/consolidate-initial-state
  

  bin/jetpack-downloader test jetpack-mu-wpcom-plugin add/consolidate-initial-state
  

Interested in more tips and information?

• In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
• Read more about our development workflow here: PCYsg-eg0-p2
• Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

[anomiex]

I wonder what the merits are of setting this global versus setting a property on the window.JetpackInitialState object.

[manzoorwanijk]

I am not sure which is better:

One benefit of window.JetpackInitialState is that it can be check in if() condition but it can also be deleted.

[zinigor]

Since we're already using window.JetpackInitialState in both types and utils, can we use it here as well? I don't think there's a downside to it, is there?

[manzoorwanijk]

Just wanted to mention that a huge benefit of using window.JetpackInitialState has been that I can directly type JetpackInitialState in the console on simple sites where the editor parts are rendered in iframes and the variable is still attached to the window. Otherise, for the variables declared with var, I had to search the DOM to find the data being rendered inside iframes because it would not be globally available.

Thanks.

[anomiex]

I'm going to ask Vulcan to finish up the review on this, since they know a lot more about how Connection and such works than I do.

[manzoorwanijk]

@anomiex any idea why the build for packages/assets fails in CI for not recognizing TS syntax?

It works fine locally.

Changes addressed

[zinigor]

Looks good!