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

MU WPCOM: dashboard: add general tasks widget scaffolding + one card (domain upsell) #41150

Merged
merged 7 commits into from
Feb 18, 2025

Conversation

ellatrix
Copy link
Contributor

@ellatrix ellatrix commented Jan 17, 2025

See Automattic/wp-calypso#95386.

Proposed changes:

  • Adds scaffolding for the general tasks widget and a first card, the domain upsell card.

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

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

Testing instructions:

  • With classic style admin enabled, check the Dashboard and test the widget. Note that the site must be launched, and the entire checklist on My Home should be completed. Alternatively you could manually set the onboarding_checklist_completed site option (OR if your blog is older than 2018-02-01, it should always appear). If you need a site to test you can use ellaiseulde.

Copy link
Contributor

github-actions bot commented Jan 17, 2025

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/dashboard-general-task-widget 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-mu-wpcom-plugin add/dashboard-general-task-widget
    

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

Copy link
Contributor

github-actions bot commented Jan 17, 2025

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 a "[Type]" label (Bug, Enhancement, Janitorial, Task).
  • ✅ 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.


Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Choose a review path based on your changes:
    • A. Team Review: add the "[Status] Needs Team Review" label
      • For most changes, including minor cross-team impacts.
      • Example: Updating a team-specific component or a small change to a shared library.
    • B. Crew Review: add the "[Status] Needs Review" label
      • For significant changes to core functionality.
      • Example: Major updates to a shared library or complex features.
    • C. Both: Start with Team, then request Crew
      • For complex changes or when you need extra confidence.
      • Example: Refactor affecting multiple systems.
  3. Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!


Mu Wpcom plugin:

  • Next scheduled release: WordPress.com Simple releases happen semi-continuously (PCYsg-Jjm-p2).

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


Wpcomsh plugin:

  • Next scheduled release: Atomic deploys happen twice daily on weekdays (p9o2xV-2EN-p2).

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

@github-actions github-actions bot added the [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. label Jan 17, 2025
@ellatrix ellatrix changed the title MU WPCOM: dashboard: add general tasks widget MU WPCOM: dashboard: add general tasks widget scaffolding Jan 17, 2025
@ellatrix ellatrix changed the title MU WPCOM: dashboard: add general tasks widget scaffolding MU WPCOM: dashboard: add general tasks widget scaffolding + domain upsell Jan 20, 2025
@ellatrix ellatrix force-pushed the add/dashboard-general-task-widget branch from d486bb7 to b0646aa Compare February 7, 2025 12:37
Copy link
Contributor

github-actions bot commented Feb 7, 2025

Code Coverage Summary

Coverage changed in 2 files.

File Coverage Δ% Δ Uncovered
projects/packages/jetpack-mu-wpcom/src/features/wpcom-dashboard-widgets/wpcom-dashboard-widgets.php 0/101 (0.00%) 0.00% 24 💔
projects/packages/jetpack-mu-wpcom/src/utils.php 4/56 (7.14%) -1.19% 8 💔

Full summary · PHP report · JS report

Copy link

jp-launch-control bot commented Feb 14, 2025

Code Coverage Summary

Coverage changed in 2 files.

File Coverage Δ% Δ Uncovered
projects/packages/jetpack-mu-wpcom/src/features/wpcom-dashboard-widgets/wpcom-dashboard-widgets.php 0/104 (0.00%) 0.00% 27 💔
projects/packages/jetpack-mu-wpcom/src/utils.php 4/56 (7.14%) -1.19% 8 💔

Full summary · PHP report · JS report

Coverage check overridden by I don't care about code coverage for this PR Use this label to ignore the check for insufficient code coveage. .

@@ -13,7 +15,36 @@ function load_wpcom_dashboard_widgets() {
return;
}

enqueue_wpcom_dashboard_widgets();
$layout_response = Client::wpcom_json_api_request_as_blog(
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, you need to request_as_user here, then you won't need to "fix" authentication on the server.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Huh! That works! 😮 Thank you!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wpcom_json_api_request_as_user does not seem to work on dot com, so I've opted for using wpcom_json_api_request_as_blog in that case for now. Only that method seems to support internal requests. I wonder if there's anything preventing us from adding it to wpcom_json_api_request_as_user.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wpcom_json_api_request_as_user does not seem to work on dot com

What does it do instead of working? And what does "on dot com" mean? On a Simple site? Or on public-api? A Simple site should never call request_as_user or request_as_blog in the first place: that means sending a REST request basically to itself.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should make an internal request in that case, see #41864

Copy link
Member

@jsnajdr jsnajdr Feb 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This wpcom-api-direct thing is very interesting. Maybe that's what we need to make Gutenberg preloading work 🙂

@ellatrix ellatrix marked this pull request as ready for review February 17, 2025 01:37
@ellatrix ellatrix force-pushed the add/dashboard-general-task-widget branch from 4314a1f to c4e2078 Compare February 17, 2025 01:41
jsnajdr
jsnajdr previously approved these changes Feb 17, 2025
Copy link
Member

@jsnajdr jsnajdr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good 👍

@ellatrix ellatrix force-pushed the add/dashboard-general-task-widget branch from b3ac1c8 to 9d08e7a Compare February 18, 2025 01:17
@ellatrix ellatrix added the I don't care about code coverage for this PR Use this label to ignore the check for insufficient code coveage. label Feb 18, 2025
@ellatrix
Copy link
Contributor Author

Thank you @jsnajdr! Let's follow-up with a fix to make wpcom_json_api_request_as_user do internal requests on dot com.

@ellatrix ellatrix merged commit 1f3e872 into trunk Feb 18, 2025
63 checks passed
@ellatrix ellatrix deleted the add/dashboard-general-task-widget branch February 18, 2025 01:32
@github-actions github-actions bot removed [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. [Status] In Progress labels Feb 18, 2025
@ellatrix ellatrix changed the title MU WPCOM: dashboard: add general tasks widget scaffolding + domain upsell MU WPCOM: dashboard: add general tasks widget scaffolding + one card (domain upsell) Feb 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants