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

Social: Improve TS error reporting in publicize-components #39133

Merged
merged 4 commits into from
Aug 30, 2024

Conversation

manzoorwanijk
Copy link
Member

@manzoorwanijk manzoorwanijk commented Aug 29, 2024

Right now, if we use store from @wordpress/editor, it results in TS errors because of messed up TS types for that package. Those errors are not shown in the IDE we we use, rather they are reported only in CI when running pnpm compile-ts in plugins/jetpack.

So, installing "@types/wordpress__editor" as a dependency in publicize-components will show us the errors in the IDE and we won't have to wait for CI to show us the errors.

Also, instead of using casting as any along with eslint-disable-*, it's better and recommended to use @ts-expect-error instead of @ts-ignore. This way if that package fixes its TS types, we will get to know by that comment.

image

Proposed changes:

  • Install "@types/wordpress__editor" as a dependency to publicize-components
  • Remove casting as any

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:

  • Nothing changes for runtime but you can still do a smoke test for share status UI.

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

github-actions bot commented Aug 29, 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 update/improve-ts-error-reporting-in-publicize 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 update/improve-ts-error-reporting-in-publicize
    
    bin/jetpack-downloader test jetpack-mu-wpcom-plugin update/improve-ts-error-reporting-in-publicize
    

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

@manzoorwanijk manzoorwanijk requested a review from a team August 29, 2024 09:50
@manzoorwanijk manzoorwanijk self-assigned this Aug 29, 2024
@manzoorwanijk manzoorwanijk marked this pull request as ready for review August 29, 2024 09:50
@manzoorwanijk manzoorwanijk enabled auto-merge (squash) August 29, 2024 09:53
@manzoorwanijk manzoorwanijk changed the title Social: Improve TS error reporting in publicize Social: Improve TS error reporting in publicize-components Aug 29, 2024
@manzoorwanijk manzoorwanijk added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. and removed [Status] Needs Team Review labels Aug 30, 2024
@manzoorwanijk manzoorwanijk requested a review from a team August 30, 2024 04:23
Copy link
Contributor

@gmjuhasz gmjuhasz left a comment

Choose a reason for hiding this comment

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

Code looks reasonable, we also have this dep in the main Jetpack package

@manzoorwanijk manzoorwanijk merged commit 30dab5a into trunk Aug 30, 2024
74 checks passed
@manzoorwanijk manzoorwanijk deleted the update/improve-ts-error-reporting-in-publicize branch August 30, 2024 09:04
@github-actions github-actions bot removed [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. [Status] In Progress labels Aug 30, 2024
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