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

Add usePostPrePublishValue hook #39119

Merged
merged 5 commits into from
Aug 28, 2024

Conversation

manzoorwanijk
Copy link
Member

@manzoorwanijk manzoorwanijk commented Aug 28, 2024

In a task like #550, we need to preserve some value before the post is publish, to avoid the value being updated after the post is published.

This PR creates a hook named usePostPrePublishValue, which watches for a passed value until the post is published and freezes the value after that.

Proposed changes:

  • Create usePostPrePublishValue hook
  • Extract re-usable test logic from the tests for useSyncPostDataToStore to common utilities
  • Add unit tests for usePostPrePublishValue hook

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:

Copy link
Contributor

github-actions bot commented Aug 28, 2024

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/use-post-pre-publish-value-hook branch.

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

    bin/jetpack-downloader test jetpack add/use-post-pre-publish-value-hook
    

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

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.


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!

Copy link
Contributor

@spsiddarthan spsiddarthan left a comment

Choose a reason for hiding this comment

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

Seems reasonable to me. I disabled the auto-merge though, so we can get it merged in the morning to avoid any surprises. Seems safe though since it's a new hook being introduced.

@spsiddarthan spsiddarthan disabled auto-merge August 28, 2024 13:39
@manzoorwanijk manzoorwanijk merged commit e9be6f8 into trunk Aug 28, 2024
59 checks passed
@manzoorwanijk manzoorwanijk deleted the add/use-post-pre-publish-value-hook branch August 28, 2024 14:39
gogdzl pushed a commit that referenced this pull request Oct 25, 2024
* Create usePostPrePublishValue hook

* Extract re-usable test logic to common utilities

* Add tests for usePostPrePublishValue

* Add changelog

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

Successfully merging this pull request may close these issues.

2 participants