Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PartyTown Integration #987

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open

PartyTown Integration #987

wants to merge 10 commits into from

Conversation

jacobd91
Copy link
Contributor

@jacobd91 jacobd91 commented Nov 6, 2024

This PR adds a new feature as an "extension" of the User Experience module

To enable visit Performance -> General Settings -> User Experience and check the checkbox for Enable Partytown

From there you can visit Performance -> User Experience and click on the PartyTown anchor in the anchor menu

Settings include

  • Include List (textarea) - Define relative/absolute URLs for JS assets you wish to offload. This is a partial match check
  • Atomics Support (checkbox) - Adds the required headers for Atomics to work. Will not work without it
  • Preload (checkbox) - Preloads the main PartyTown driver file
  • Debug Mode (checkbox) - Adds verbose browser console logging for both the service worker and Atomics
  • Timeout (number) - Timeout in miliseconds before offloaded scripts will execute in main thread if the service worker or Atomics is taking too long
  • Worker Concurrency Limit (number) - Set max limit of PartyTown workers that can run simultaneously

Once configured purge the cache and then refresh any front-end page. View the console log for any errors or debug output if enabled. To see if scripts were processed via the offload look at the DOM and search for "text/partytown" or your defined targets. If a defined target doesn't have type="text/partytown" then the mutator didn't find it. If the script was successfully offloaded then it will be type="text/partytown-x"

@jacobd91 jacobd91 requested a review from cssjoe November 6, 2024 18:08
@jacobd91 jacobd91 self-assigned this Nov 6, 2024
@cssjoe cssjoe added this to the 2.9.0 milestone Nov 6, 2024
@codecov-commenter
Copy link

codecov-commenter commented Nov 13, 2024

Codecov Report

Attention: Patch coverage is 0% with 555 lines in your changes missing coverage. Please review.

Project coverage is 0.90%. Comparing base (5f60e03) to head (65aafaa).
Report is 34 commits behind head on master.

Files with missing lines Patch % Lines
UserExperience_Preload_Requests_Page_View.php 0.00% 127 Missing ⚠️
UserExperience_PartyTown_Extension.php 0.00% 124 Missing ⚠️
UserExperience_PartyTown_Page_View.php 0.00% 113 Missing ⚠️
UserExperience_PartyTown_Environment.php 0.00% 89 Missing ⚠️
UserExperience_PartyTown_Mutator.php 0.00% 45 Missing ⚠️
UserExperience_GeneralPage_View.php 0.00% 32 Missing ⚠️
FeatureShowcase_Plugin_Admin.php 0.00% 16 Missing ⚠️
UserExperience_Plugin_Admin.php 0.00% 5 Missing ⚠️
UserExperience_Preload_Requests_Extension.php 0.00% 3 Missing ⚠️
Root_Environment.php 0.00% 1 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##             master    #987      +/-   ##
===========================================
- Coverage      0.91%   0.90%   -0.01%     
- Complexity    19453   19509      +56     
===========================================
  Files           674     678       +4     
  Lines         97946   98430     +484     
===========================================
  Hits            893     893              
- Misses        97053   97537     +484     
Flag Coverage Δ
?

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.


🚨 Try these New Features:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants