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

Debug Helper: Add XML-RPC logger module #34487

Merged
merged 3 commits into from
Dec 6, 2023

Conversation

oskosk
Copy link
Contributor

@oskosk oskosk commented Dec 6, 2023

Adds an XML-RPC module to the Jetpack Debug Tools plugin making it simple to log incoming XML-RPC requests to debug.log

Example logging

Example toggling a Jetpack Setting in Calypso
image
XML formatted log JSON formatted log
image image

Settings page

image

Proposed changes:

  • Adds xmlrpc-logger module to debug-helper.
    • Adds settings page.

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

None

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

No

Testing instructions:

  • Check out this branch in your local environment
  • Activate the Jetpack Debug Tools plugin
  • Visit the menu item Jetpack Debug
    • Enable the XMLRPC Logger checkbox
    image
  • In a terminal run jetpack docker tail
  • Assuming your site is connected and reachable from the web, visit Calypso (any page)
  • Expect to see an XML-RPC request logged

@github-actions github-actions bot added the [Plugin] Debug Helper Debug Tools plugin label Dec 6, 2023
Copy link
Contributor

github-actions bot commented Dec 6, 2023

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.


Once your PR is ready for review, check one last time that all required checks appearing at the bottom of this PR are passing or skipped.
Then, add the "[Status] Needs Team Review" label and ask someone from your team review the code. Once reviewed, it can then be merged.
If you need an extra review from someone familiar with the codebase, you can update the labels from "[Status] Needs Team Review" to "[Status] Needs Review", and in that case Jetpack Approvers will do a final review of your PR.


Debug Helper plugin:

  • Next scheduled release: January 2, 2024.
  • Scheduled code freeze: December 25, 2023.

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

@oskosk oskosk added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. and removed [Status] In Progress labels Dec 6, 2023
Copy link
Contributor

@sergeymitr sergeymitr left a comment

Choose a reason for hiding this comment

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

Works great 👍

@sergeymitr sergeymitr added [Status] Ready to Merge Go ahead, you can push that green button! and removed [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. labels Dec 6, 2023
@oskosk oskosk merged commit 3c2d8c2 into trunk Dec 6, 2023
54 of 55 checks passed
@oskosk oskosk deleted the add/xmlrpc-logger-jetpack-debug-helper branch December 6, 2023 14:11
@github-actions github-actions bot removed the [Status] Ready to Merge Go ahead, you can push that green button! label Dec 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Plugin] Debug Helper Debug Tools plugin
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants