Extract file search redux backend by jasonLaster · Pull Request #3889 · firefox-devtools/debugger

jasonLaster · 2017-09-05T02:28:58Z

Summary of Changes

I realized #3888 was too big, so i'm taking the file search redux part out and making it its own PR.

Why extract:

I'm realizing now that actions/ui was primarily file search.
Now that we have redux backends for project search, text search etc, it only seems fair
the file search (SearchBar) component is way too complicated
I'd like to have the search bar component only mounted when it is shown, to do this we need a permanent store.

Test Plan

Re-use existing tests

bomsy · 2017-09-05T17:55:15Z

+
+/**
+ * UI reducer
+ * @module reducers/ui


should be reducers/file-search

bomsy · 2017-09-05T17:56:20Z

+import { getMatches } from "../utils/search";
+import type { ThunkArgs } from "./types";
+
+// import {} from "./index";


remove this line

codehag

this looks really good! coupla nits

codehag · 2017-09-06T18:16:44Z

+
+async function searchContents(query: string, editor: Object) {
+  return async ({ getState, dispatch }) => {
+    // const { selectedSource, modifiers, editor: ed } = this.props;


we can remove this line as well

codehag · 2017-09-06T18:17:03Z

+    const query = getFileSearchQuery(getState());
+    const modifiers = getFileSearchModifiers(getState());
+    const { searchResults: matches } = getFileSearchResults();
+    // const { query, modifiers, searchResults: { matches } } = this.props;


this one too

codehag · 2017-09-06T18:18:48Z

+  count: number
+};
+
+export type UIState = {


should this also be FileSearchState?

codehag · 2017-09-06T18:23:08Z

+    }
+
+    case "TOGGLE_MODIFIER": {
+      const actionVal = !state.getIn(["modifiers", action.modifier]);


I'm on the fence about this but i will mention it anyway; is action.modifier a string? could we do something like

prefs[`fileSearch${action.modifier}`]

(i think it needs a first letter uppercase, but you get the idea)

since we seem to be doing the same thing each time, and we might not need this extra layer

codecov · 2017-09-08T20:30:17Z

Codecov Report

Merging #3889 into master will decrease coverage by 0.02%.
The diff coverage is 33.62%.

@@            Coverage Diff             @@
##           master    #3889      +/-   ##
==========================================
- Coverage   54.69%   54.66%   -0.03%     
==========================================
  Files         141      143       +2     
  Lines        5125     5098      -27     
  Branches     1056     1050       -6     
==========================================
- Hits         2803     2787      -16     
+ Misses       2322     2311      -11

Impacted Files	Coverage Δ
src/utils/result-list.js	`83.33% <ø> (+46.74%)`	⬆️
src/actions/ui.js	`70.96% <ø> (-4.71%)`	⬇️
src/selectors.js	`100% <ø> (ø)`	⬆️
src/components/Editor/index.js	`21.24% <ø> (ø)`	⬆️
src/reducers/ui.js	`76.59% <ø> (-3.71%)`	⬇️
src/components/shared/SearchInput.js	`93.54% <100%> (+0.44%)`	⬆️
src/actions/file-search.js	`13.79% <13.79%> (ø)`
src/components/Editor/SearchBar.js	`28.84% <16.66%> (-4.49%)`	⬇️
src/reducers/file-search.js	`92% <92%> (ø)`
... and 1 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c517758...943c7d9. Read the comment docs.

jasonLaster · 2017-09-08T20:55:46Z

+    }
+
+    case "TOGGLE_MODIFIER": {
+      const actionVal = !state.getIn(["modifiers", action.modifier]);


lol we tried to do this kind of thing before, but it is too magical.

a big style reason not to, is that it is nice to grep for pref keys, just like it's nice to grep for l10n keys

wldcordeiro · 2017-09-09T04:06:20Z

      shiftSearchAgainShortcut
    } = getShortcuts();

-    shortcuts.on(searchShortcut, (_, e) => this.toggleSearch(e));


Did you mean to remove the search shortcut?

yes, because the search bar is now unmounted when it is not open. See the Editor/index render method

I see that. But now there isn't a way to enable the search bar?

oh, we should probably fix that :)

I think i was going to add a shortcut in App.js or Editor/index

wldcordeiro · 2017-09-17T17:43:03Z

Working on this some more. Had to rework some of the code and rebase. Apologies for the delays.

jasonLaster · 2017-09-22T14:08:54Z

+    dispatch(actions.toggleFileSearchModifier("caseSensitive"));
+    fileSearchModState = getFileSearchModifiers(getState());
+    expect(fileSearchModState.get("caseSensitive")).toBe(true);
+  });


i bet we can do some doSearch tests now where we stub codemirror. Obviously not a blocker, just excited

wldcordeiro · 2017-09-29T23:56:52Z

Almost ready to go! One last behavior to test and this is ready. 😄

wldcordeiro · 2017-10-01T18:18:38Z

Travis keeps failing but I believe I've got it working like expected 😁

jasonLaster · 2017-10-02T03:56:26Z

hmm, the failure seems relevant. I'll look tomorrow.

Lets finish this up

wldcordeiro · 2017-10-03T04:59:05Z

Got it down to one failing mochitest that's unrelated? It's the browser_debug-console.js test. 🤔

wldcordeiro · 2017-10-03T06:45:32Z


  // Second time to hide console
-  pressKey(dbg, "Escape");
+  pressKey(dbg, "CtrlEscape");


Adding this key code worked but it feels wrong. 🙁 @jasonLaster Care to dig in a bit?

wldcordeiro · 2017-10-03T06:47:01Z

  const state = cm.state.search;

  pressKey(dbg, "Enter");
+  pressKey(dbg, "Enter");


I don't know why the second ent here seems to be the trick.

looks like it might be a timing issue

jasonLaster · 2017-10-03T12:31:29Z


  // Second time to hide console
-  pressKey(dbg, "Escape");
+  pressKey(dbg, "CtrlEscape");


jasonLaster · 2017-10-03T12:31:29Z

  const state = cm.state.search;

  pressKey(dbg, "Enter");
+  pressKey(dbg, "Enter");


also weird...

codehag · 2017-10-11T09:36:00Z

can you rebase and I will take a look at the mochi test issue?

codehag

Hey everyone. I will close this PR in favor of #4368

While i was able to fix the escape button bug, I also found that ctrl-cmd-i was no longer working in this branch. Unforunately too many changes were made in this pr for me to be able to accurately diagnose it, and some of them would need some work yet. The above pr is just a simplified version of this one

codehag · 2017-10-13T09:48:29Z

    shortcuts.on(
      L10N.getStr("symbolSearch.search.key2"),
-      this.toggleSymbolModal
+      this.toggleVisible.bind(this, "symbol")


why do we have this name change here? it doesnt seem part of the reducer work

codehag · 2017-10-13T11:30:52Z

-      ref: c => (this.$input = c)
+      ref: c => {
+        this.$input = c;
+        this.props.refFunc != null && this.props.refFunc(c);


why are we making this change?

codehag · 2017-10-13T11:31:24Z

  renderEditorPane: Function;
  renderVerticalLayout: Function;
-  toggleSymbolModal: Function;
+  toggleVisible: Function;


also here: what is this change doing? can we leave it out?

codehag · 2017-10-13T14:54:27Z

-  setSearchValue(value: string) {
-    const searchInput = this.searchInput();
-    if (value == "" || !searchInput) {
+    if (!this.props.editor) {


moving this below e.stopPropagation and e.preventDefault is what was causing the escape button bug.

codehag · 2017-10-13T14:55:36Z

  }
+
+  getInputRef(c) {
+    this.searchInput = c;


this change doesnt make much sense to me, because this allows us to highjack the search and allows us to set the search field in two ways, via props and through setSearchValue.

we should instead have local state and props, props being the state that is sent to the search worker.

codehag · 2017-10-13T14:57:22Z

Closing as mentioned above.

bomsy reviewed Sep 5, 2017

View reviewed changes

codehag reviewed Sep 6, 2017

View reviewed changes

wldcordeiro force-pushed the fix-project-search2 branch from f2eac48 to 7750a62 Compare September 8, 2017 20:29

jasonLaster commented Sep 8, 2017

View reviewed changes

wldcordeiro reviewed Sep 9, 2017

View reviewed changes

wldcordeiro force-pushed the fix-project-search2 branch 3 times, most recently from c0efbe1 to 4b410e0 Compare September 11, 2017 18:39

wldcordeiro force-pushed the fix-project-search2 branch 2 times, most recently from 56f55af to 4d8c9a9 Compare September 22, 2017 00:50

jasonLaster commented Sep 23, 2017

View reviewed changes

jasonLaster force-pushed the fix-project-search2 branch 3 times, most recently from 6bbe8ca to 42bfd73 Compare September 29, 2017 00:17

wldcordeiro force-pushed the fix-project-search2 branch from 42bfd73 to 6fe1d56 Compare September 29, 2017 23:49

wldcordeiro force-pushed the fix-project-search2 branch 3 times, most recently from 5d6f79e to 9cb13dd Compare October 1, 2017 07:03

wldcordeiro force-pushed the fix-project-search2 branch 2 times, most recently from d4e76fe to 21fed11 Compare October 3, 2017 04:17

jasonLaster and others added 2 commits October 2, 2017 22:21

Extract file search redux backend

44455db

Further extracting the file search system into redux.

2e183f5

wldcordeiro force-pushed the fix-project-search2 branch from 21fed11 to f22c1c0 Compare October 3, 2017 04:25

wldcordeiro force-pushed the fix-project-search2 branch from f22c1c0 to 376af9b Compare October 3, 2017 06:41

wldcordeiro reviewed Oct 3, 2017

View reviewed changes

Integrate new Redux enabled search.

943c7d9

wldcordeiro force-pushed the fix-project-search2 branch from 376af9b to 943c7d9 Compare October 3, 2017 06:55

jasonLaster commented Oct 3, 2017

View reviewed changes

codehag mentioned this pull request Oct 13, 2017

File search reducer #4368

Merged

codehag reviewed Oct 13, 2017

View reviewed changes

codehag closed this Oct 13, 2017

Uh oh!

Conversation

jasonLaster commented Sep 5, 2017

Summary of Changes

Test Plan

Uh oh!

bomsy Sep 5, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codehag left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codecov Bot commented Sep 8, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wldcordeiro commented Sep 17, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wldcordeiro commented Sep 29, 2017

Uh oh!

wldcordeiro commented Oct 1, 2017

Uh oh!

jasonLaster commented Oct 2, 2017

Uh oh!

wldcordeiro commented Oct 3, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codehag commented Oct 11, 2017

Uh oh!

codehag left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codehag commented Oct 13, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

bomsy Sep 5, 2017 •

edited

Loading

codecov Bot commented Sep 8, 2017 •

edited

Loading