Skip to content

Write editor: add save/publish failure telemetry#50176

Open
allilevine wants to merge 1 commit into
trunkfrom
add/write-editor-save-failure-telemetry
Open

Write editor: add save/publish failure telemetry#50176
allilevine wants to merge 1 commit into
trunkfrom
add/write-editor-save-failure-telemetry

Conversation

@allilevine

Copy link
Copy Markdown
Member

Proposed changes

Failed or stalled saves in the Write editor currently leave the Publish and Save buttons disabled with no error surfaced to the user and nothing recorded in Tracks, so the failures are invisible. This adds observability only — it does not change save behavior.

  • savePost() is now a thin wrapper that reports throws during content preparation / tag resolution (today silent unhandled rejections) as wpcom_write_editor_save_failed with phase: "prepare", then re-throws so behavior is unchanged.
  • The save-request catch fires the same event with phase: "save_request".
  • A non-aborting 30s watchdog fires wpcom_write_editor_save_stalled for a request that never settles (e.g. one held open by a proxy, VPN, or ad blocker).
  • Events carry error_code, HTTP error_status, a truncated error_message, and is_autosave / is_update / is_new_post to localize the root cause.

The behavioral fix (reset the saving flag on failure, add a request timeout, surface an error) is intentionally deferred to a follow-up so we can first confirm the actual failure mode from this data.

Related product discussion/links

  • RSM-4323

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

Yes — it adds two new Tracks events for Write editor save diagnostics:

  • wpcom_write_editor_save_failed — props: post_status, is_autosave, is_update, is_new_post, phase, error_code, error_status, error_message (truncated to 200 chars).
  • wpcom_write_editor_save_stalled — props: post_status, is_autosave, is_update, is_new_post, elapsed_ms.

No post content or personally identifying information is recorded. The [Status] Needs Privacy Updates label should be applied.

Testing instructions

  • Open the Write editor (wp-admin/admin.php?page=write), add a title and some body content.
  • In DevTools, force a failing save: window.wp.apiFetch = () => Promise.reject( { code: 'rest_cannot_create', message: 'Simulated', data: { status: 503 } } );
  • Clear the queue with window._tkq = [];, then click Publish.
  • Confirm window._tkq contains a wpcom_write_editor_save_failed entry with phase: "save_request", error_code: "rest_cannot_create", error_status: 503. The existing error message and button re-enable behavior should be unchanged.
  • For the prepare path: add a #tag line to the content and set window.wp.apiFetch = () => { throw new TypeError('boom'); }; — the event should fire with phase: "prepare".

Failed or stalled saves in the Write editor currently leave the Publish
and Save buttons disabled with no error surfaced and nothing recorded, so
the failures are invisible in Tracks. This adds observability only; it does
not change save behavior.

- savePost() is now a thin wrapper that reports throws during content
  preparation / tag resolution (today silent unhandled rejections) as
  wpcom_write_editor_save_failed with phase "prepare", then re-throws so
  behavior is unchanged.
- The save-request catch fires the same event with phase "save_request".
- A non-aborting 30s watchdog fires wpcom_write_editor_save_stalled for a
  request that never settles (e.g. blocked by a proxy/VPN/ad blocker).

Events carry error_code, HTTP error_status, a truncated error_message, and
is_autosave / is_update / is_new_post to localize the root cause.

RSM-4323

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01JzwcxRibRLPqDWqngRx3oh
@allilevine allilevine self-assigned this Jul 2, 2026
@github-actions

github-actions Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

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 WoA dev 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 (WordPress.com Site Helper), and enable the add/write-editor-save-failure-telemetry branch.
  • To test on Simple, run the following command on your sandbox:
bin/jetpack-downloader test jetpack-mu-wpcom-plugin add/write-editor-save-failure-telemetry

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

@github-actions

github-actions Bot commented Jul 2, 2026

Copy link
Copy Markdown
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 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 🤖


Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Make sure to test your changes on all platforms that it applies to. You're responsible for the quality of the code you ship.
  3. You can use GitHub's Reviewers functionality to request a review.
  4. When it's reviewed and merged, you will be pinged in Slack to deploy the changes to WordPress.com simple once the build is done.

If you have questions about anything, reach out in #jetpack-developers for guidance!

@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 Jul 2, 2026
@jp-launch-control

jp-launch-control Bot commented Jul 2, 2026

Copy link
Copy Markdown

Code Coverage Summary

Coverage changed in 1 file.

File Coverage Δ% Δ Uncovered
projects/packages/jetpack-mu-wpcom/src/features/write/view.js 0/6560 (0.00%) 0.00% 138 💔

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. .

@allilevine allilevine added the I don't care about code coverage for this PR Use this label to ignore the check for insufficient code coveage. label Jul 2, 2026
@allilevine allilevine requested a review from kbrown9 July 2, 2026 15:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

I don't care about code coverage for this PR Use this label to ignore the check for insufficient code coveage. [mu wpcom Feature] Write [Package] Jetpack mu wpcom WordPress.com Features [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant