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.

Sign up for GitHub

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

Jump to bottom

Search: new URL param to display search query results in page source #11555

Merged
merged 1 commit into from
Mar 22, 2019
Merged

Search: new URL param to display search query results in page source #11555

merged 1 commit into from
Mar 22, 2019

Conversation

dereksmart
Copy link
Member

This PR provides an easy way to see what Jetpack search is returning for results. It can be useful if we are not sure whether the issue is with the theme, conflicting plugin, etc. It can be useful for HEs or users.

It adds the results to the page source only.

There very well may be a better way to do this, or a reason we're not doing it already.

Testing instructions:

  • Purchase a plan
  • Enable Jetpack Search
  • Search for something
  • On the search results URL, manually add &searchdebug=1 to the url and load
  • Look in the page source. cmd+f for Query response data
  • You should see the response data.
  • It should not affect any default searches. You should not see this if the query param is not present.

Proposed changelog entry for your changes:

  • Jetpack Search: An easy way to see the raw Jetpack Search query results.

@dereksmart dereksmart added [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it [Status] Needs Review This PR is ready for review. [Feature] Search For all things related to Search labels Mar 12, 2019
@dereksmart dereksmart requested review from gibrown and a team March 12, 2019 23:42
@matticbot
Copy link
Contributor

Caution: This PR has changes that must be merged to WordPress.com
Hello dereksmart! These changes need to be synced to WordPress.com - If you 're an a11n, please commandeer, review, and approve D25474-code before merging this PR. Thank you!

@jetpackbot
Copy link
Collaborator

Thank you for the great PR description!

When this PR is ready for review, please apply the [Status] Needs Review label. If you are an a11n, please have someone from your team review the code if possible. The Jetpack team will also review this PR and merge it to be included in the next Jetpack release.

Scheduled Jetpack release: April 2, 2019.
Scheduled code freeze: March 26, 2019

Generated by 🚫 dangerJS against b297bba

@jenkoian
Copy link
Contributor

You can already get this from the debug bar if I understand correctly https://github.com/Automattic/jetpack/blob/88979138725c4e925ba38c2492d37556330041c0/3rd-party/debug-bar/class.jetpack-search-debug-bar.php

@kraftbj
Copy link
Contributor

kraftbj commented Mar 13, 2019

The downside of the debug bar approach is for Automattic staff helping to resolve customer issues, we don't have that available without the customer granting us an account and having that plugin installed.

@kraftbj kraftbj added [Status] Ready to Merge Go ahead, you can push that green button! and removed [Status] Needs Review This PR is ready for review. labels Mar 13, 2019
@mdawaffe
Copy link
Member

I don't see any sensitive data in the printed request or response. Can we get a confirmation from the search folks that this is OK, though? Perhaps some responses return different information.

@kraftbj
Copy link
Contributor

kraftbj commented Mar 14, 2019

@gibrown Just a sanity check that outputting the query used is not a problem.

@kraftbj kraftbj added this to the 7.2 milestone Mar 20, 2019
@kraftbj kraftbj merged commit 8a9e8ff into master Mar 22, 2019
@kraftbj kraftbj deleted the add/search-response-data-in-source branch March 22, 2019 15:22
@ghost ghost removed the [Status] Ready to Merge Go ahead, you can push that green button! label Mar 22, 2019
@kraftbj
Copy link
Contributor

kraftbj commented Mar 22, 2019

r189297-wpcom

kraftbj added a commit that referenced this pull request Mar 26, 2019
@kraftbj
CL #11555
14b3ce2
kraftbj added a commit that referenced this pull request Mar 27, 2019
@kraftbj
Add initial 7.2 changelog to master (#11690)
2227bfd 
* Initial Changelog for 7.2

* Testing list: add mention of IE11 testing

* Initial Changelog for 7.2

* Testing list: add mention of IE11 testing

* Add CL for #11224

* Add CL for #11426

* Add CL for #11442

* Add testing instructions for #11224

* Add CL for #11451

* Reclassify CL item

* Add testing instructions for #11451

* Add CL for #11486

* Add CL for #11418

* Add CL for #11524

* Add CL and testing instructions for #11449

* Add CL for #11460

* Add CL for #11520 and #11582

* Add CL for #11531

* Add CL #11644

* Add testing instructions for #11644

* Add testing instructions for #11644

* Add CL for #11618

* Uniform changelog lines

* CL #11679

* CL #11661

* CL #11654

* CL #11645

* CL #11643

* CL #11636

* CL #11635 and for other PHPCS commits

* CL #11627

* CL #11626

* CL #11598

* CL #11596

* Remove nested items for shortcopy. I don't believe the detailed list is helpful

* CL #11570

* CL #11569

* CL #11560

* CL #11558

* CL #11555

* CL #6704

* CL #11298

* CL #11324

* CL #11443

* CL #11484

* CL #11516

* CL #11529

* Expand Ads block enhancement CL item
gibrown pushed a commit that referenced this pull request Nov 8, 2019
@kraftbj @gibrown
Search: new URL param to display search query results in page source …
6b38f2e 
…(jetpack:11555)

Summary:
 <!--- Provide a general summary of your changes in the Title above -->

 This PR provides an easy way to see what Jetpack search is returning for results. It can be useful if we are not sure whether the issue is with the theme, conflicting plugin, etc. It can be useful for HEs or users.

 It adds the results to the page source only.

 There very well may be a better way to do this, or a reason we're not doing it already.

 #### Testing instructions:
 <!-- Please include detailed testing steps, explaining how to test your change. -->
 <!-- Bear in mind that context you working on is not obvious for everyone.  -->
 <!-- Adding "simple" configuration steps will help reviewers to get to your PR as quickly as possible. -->
 <!-- "Before / After" screenshots can also be very helpful when the change is visual. -->

 - Purchase a plan
 - Enable Jetpack Search
 - Search for something
 - On the search results URL, manually add `&searchdebug=1` to the url and load
 - Look in the page source. `cmd+f` for `Query response data`
 - You should see the response data.
 - It should not affect any default searches. You should not see this if the query param is not present.

 #### Proposed changelog entry for your changes:
 <!-- Please do not leave this empty. If no changelog entry needed, state as such. -->

 * Jetpack Search: An easy way to see the raw Jetpack Search query results.

--

Automatically created by Jetpack Fusion from a Pull Request:
#11555

Test Plan: - [ ] Dummy test plan.

Reviewers: github-phab-bot

Subscribers: dereksmart

Tags: #touches_jetpack_files

Differential Revision: https://[private link]

Merges r189297-wpcom.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kraftbj kraftbj kraftbj approved these changes

@gibrown gibrown Awaiting requested review from gibrown

Assignees
No one assigned
Labels
[Feature] Search For all things related to Search Touches WP.com Files [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it
Projects
None yet
Milestone
7.2
Development

Successfully merging this pull request may close these issues.
6 participants
@dereksmart @matticbot @jetpackbot @jenkoian @kraftbj @mdawaffe