Filter requests by folder, URI, method, query string #797

shawnaxsom · 2018-03-05T02:01:31Z

Relevant issues?

#739 - This fulfills at least some part of the issue. We may want to update the UI to display either what parts of text are matched, and/or show missing fields (e.g. add URL to the Quick Switch modal).

What does this PR do?

Adds a fuzzyMatchAll method to simplify and standardize how multiple-field searches are performed.
Applies fuzzyMatchAll to request search bars in the Sidebar and in the Quick Switch modal.
Updates those request search bars to have more descriptive placeholders.
Adds unit tests for both fuzzyMatch and fuzzyMatchAll.

What is left to do or discuss on the relevant issues?

We might want to make Quick Switch window display URI, 2+ folders (all parents), possibly query string. Either multiple rows, and/or show the field that matched. It might be a little much to include many e.g. query string parameters on there, so some things might have to stay hidden, or we have to get creative.
Should we keep Fuzzy Matching as implemented? An option to turn it off might be nice. I was wanting to search for POST earlier, and it was matching something like "httP://lOcalhoST". I prefer multiple word non-fuzzy searching for this reason. But I assume others prefer fuzzy matching or it wouldn't be there.
If we keep Fuzzy Matching as implemented, consider whether labels are needed. Probably overkill, but we could add optional labels to the search, like "method:POST url:localhost".

Example screenshots, gifs, or videos?

What code can others reuse?

fuzzyMatchAll - This calls out to the existing fuzzyMatch misc utility method. The difference is that it takes a string that will be split on spaces for required search terms, and it takes an array of fields that the search terms can match against.

Testing Steps

Search for URI, method, query string, folder, and/or request name on Quick Switch window
Perform fuzzy search, leaving out some letters for a given field
Perform a multiple word search, searching multiple types of fields in the list above
Repeat tests for Sidebar search

Previously only Request Name was searched for in Quick Switch window. This adds support for searching Request URL and Method as well. A fuzzyMatchAll function has been added to be able to search different fields in any order, space delimited.

…tring matching

welcome · 2018-03-05T02:01:34Z

💖 Thanks for opening this pull request! 💖

To help make this a smooth process, please be sure you have first read the
contributing guidelines.

gschier · 2018-03-08T10:25:02Z

Haven't forgot about this! Should be able to get to it next week 😄

gschier

Nice work @axs221! Only a few minor comments.

gschier · 2018-03-12T22:17:11Z

packages/insomnia-app/app/ui/components/modals/request-switcher-modal.js

+   * Appends path of ancestor groups, delimited by forward slashes
+   * E.g. Folder1/Folder2/Folder3
+   */
+  _groupOf (request) {


Small thing. This variable would be more accurately described as child or requestOrRequestGroup. Can you rename to be more clear?

Sounds good, I'll go with requestOrRequestGroup, verbose but clear as what can be expected

gschier · 2018-03-12T22:22:59Z

packages/insomnia-app/app/ui/components/modals/request-switcher-modal.js

+          request.url,
+          request.method,
+          this._groupOf(request),
+          ...(request.parameters


It might be more intuitive to join the parameters to the URL? Thoughts?

See https://github.com/getinsomnia/insomnia/blob/cd1ff32b4d098979cc61de6837475f648bda82e3/plugins/insomnia-plugin-request/index.js#L108-L109 for an example of URL building.

Yeah that makes sense, I will change it as suggested

gschier · 2018-03-12T22:31:18Z

Responding to your comments in the PR description:

We might want to make Quick Switch window display URI, 2+ folders (all parents), possibly query string. Either multiple rows, and/or show the field that matched. It might be a little much to include many e.g. query string parameters on there, so some things might have to stay hidden, or we have to get creative.

I agree, it's probably best to show as much as possible. Perhaps we could hide most things by default and only show them if they were part of the match?

Should we keep Fuzzy Matching as implemented? An option to turn it off might be nice. I was wanting to search for POST earlier, and it was matching something like "httP://lOcalhoST". I prefer multiple word non-fuzzy searching for this reason. But I assume others prefer fuzzy matching or it wouldn't be there.

I agree that the fuzzy search right now is probably too loose, specifically for the sidebar filter. For the request switcher, the current solution would probably be fine if results were sorted by best match like in Atom/Sublime/etc.

If we keep Fuzzy Matching as implemented, consider whether labels are needed. Probably overkill, but we could add optional labels to the search, like "method:POST url:localhost".

Oh, that's interesting. Like GitHub does with issues. I think labels are a great idea either way because we could add things like status:200, auth:Basic, content-type:json, etc.

Thanks @axs221!

shawnaxsom · 2018-03-20T00:22:05Z

@gschier Okay I updated the branch with the minor feedback from the PR, minus the items mentioned in Responding to your comments in the PR description.

Is what is there so far worth merging, and then doing a second PR for the rest? Otherwise I should be able to get to the additional items in the next week or so.

Thank you!

gschier · 2018-03-28T20:56:58Z

Yep, it looks great!

gschier · 2018-03-28T20:58:31Z

I was busy for the past couple weeks traveling but will now be more available and responsive to help out if needed 😄

shawnaxsom · 2018-03-28T21:14:49Z

@gschier Okay thanks! Hope you had a good time traveling; I've been busy too, no worries. I'll put some thought into the UI changes soon and we can discuss.

gschier · 2018-03-28T21:34:23Z

It was amazing, thanks for asking 😃

Sounds good! Probably best to create a new issue for discussion of the next phase 👍

gschier · 2018-03-29T15:40:47Z

@axs221 just so you're aware, I'm disabling the new fuzzy matching for URL/parameters until we have some UI to make it more clear what's going on.

* Quick Switch matching for Request URL and Method Previously only Request Name was searched for in Quick Switch window. This adds support for searching Request URL and Method as well. A fuzzyMatchAll function has been added to be able to search different fields in any order, space delimited. * Include request parameters in searchable fields * Allow searching requests by folder paths * More descriptive placeholder for Quick Switch modal search input * Update sidebar filter to match Quick Switch, allowing URL and Query String matching * More descriptive placeholder for sidebar search * Unit tests for fuzzyMatch and fuzzyMatchAll * More unit tests for fuzzyMatch and fuzzyMatchAll * minor refactorings

Shawn Axsom added 8 commits March 4, 2018 13:04

Include request parameters in searchable fields

ec21c88

Allow searching requests by folder paths

a909827

More descriptive placeholder for Quick Switch modal search input

0a9b73f

Update sidebar filter to match Quick Switch, allowing URL and Query S…

8d07144

…tring matching

More descriptive placeholder for sidebar search

bdd09f6

Unit tests for fuzzyMatch and fuzzyMatchAll

f169517

More unit tests for fuzzyMatch and fuzzyMatchAll

9ea0044

gschier suggested changes Mar 12, 2018

View reviewed changes

minor refactorings

58e00cc

shawnaxsom force-pushed the feature/fuzzy-match-request-parameters branch from caa89fc to 58e00cc Compare March 20, 2018 00:11

Merge branch 'develop' into feature/fuzzy-match-request-parameters

b3802f0

gschier merged commit bee9973 into Kong:develop Mar 28, 2018

shawnaxsom mentioned this pull request Mar 28, 2018

[Feature Request] Fuzzy Search Results in Switch Requests (⌘P) Palette #739

Closed

shawn-pe mentioned this pull request Apr 9, 2018

[old] UI should show matches when filtering requests by folder, URI, method, query string #856

Closed

This was referenced Apr 9, 2018

[Improvement] UI should show matches when filtering requests by folder, URI, method, query string #857

Closed

UI for filter requests by folder, URI, method, query string #864

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Filter requests by folder, URI, method, query string #797

Filter requests by folder, URI, method, query string #797

shawnaxsom commented Mar 5, 2018

welcome bot commented Mar 5, 2018

gschier commented Mar 8, 2018

gschier left a comment

gschier Mar 12, 2018

shawnaxsom Mar 19, 2018

gschier Mar 12, 2018

shawnaxsom Mar 20, 2018

gschier commented Mar 12, 2018

shawnaxsom commented Mar 20, 2018

gschier commented Mar 28, 2018

gschier commented Mar 28, 2018

shawnaxsom commented Mar 28, 2018

gschier commented Mar 28, 2018

gschier commented Mar 29, 2018

Filter requests by folder, URI, method, query string #797

Filter requests by folder, URI, method, query string #797

Conversation

shawnaxsom commented Mar 5, 2018

Relevant issues?

What does this PR do?

What is left to do or discuss on the relevant issues?

Example screenshots, gifs, or videos?

What code can others reuse?

Testing Steps

welcome bot commented Mar 5, 2018

gschier commented Mar 8, 2018

gschier left a comment

Choose a reason for hiding this comment

gschier Mar 12, 2018

Choose a reason for hiding this comment

shawnaxsom Mar 19, 2018

Choose a reason for hiding this comment

gschier Mar 12, 2018

Choose a reason for hiding this comment

shawnaxsom Mar 20, 2018

Choose a reason for hiding this comment

gschier commented Mar 12, 2018

shawnaxsom commented Mar 20, 2018

gschier commented Mar 28, 2018

gschier commented Mar 28, 2018

shawnaxsom commented Mar 28, 2018

gschier commented Mar 28, 2018

gschier commented Mar 29, 2018