Umbrella Issue: find/replace overlay issues

[Wittmaxi]

This Issue documents my views on priority for the issues of the find/replace overlay.
High issues are issues which are blocking a possible release

high

• Find/Replace Overlay: Close by escape even when in editor #2033
• Find/Replace overlay: Immediate Replace after searching selected text not working #2011
• Find/Replace Overlay: unexpected key bindings on MacOS #2007
• Find/Replace overlay: Buttons sometimes missing #2006
• Find/Replace overlay: missing help for regular expressions #1994
• Find/Replace overlay: does not move on every resize #1992
• Find/Replace overlay isn't hidden when the editor is too small #1989
• Input/Replace Toggle Icons Looks Strange on macOS in Dark Theme #1983
• Find/Replace overlay should have an X for closing #1991
• find/replace overlay: makes Eclipse unusable on switching editors #1951
• find/replace overlay: inconsistencies when moving view to separate window #1945
• [Find/Replace Overlay] The search-history cannot be accessed from the Overlay #1907
• Find/Replace Overlay: doesn't escape RegEx selection when opening #2053
• Find/Replace Overlay: when closing another view, the overlay completely closes itself #2046
• Find/Replace overlay: UNIX-line separators are not interpreted correctly on Windows #2054
• Find/Replace overlay: weird placement when unmaximizing #2059
• Find/Replace Overlay: Lost in Manifest editor #2075
• [GTK] UI hang while using Find/Replace overlay #2138
• Find/replace overlay: find-dialog are resized unnormally if it is used for MD-files #2147
• Find/replace overlay: logs NPE #2244
• Find/replace overlay: does not take focus after detach #2246
• New find/replace overlay broken under wayland eclipse.platform.swt#1447
• [Find/Replace] 'Find Next' (Ctrl+K) command broken with the overlay #2285
• [Find/Replace] changed search string is ignored by search dialog #2322
• Find/replace overlay: improve switching between find and replace input fields #2161
• Paste into find overlay control does not work in multipage editor (manifest.mf, plugin.xml) #2509

medium

• Find/Replace overlay: Arrow button re-sizes on editor scrolling #2018
• Find/Replace overlay: Search text not selected when switching to open overlay #2012
• Find/Replace overlay: reorder regexp/whole word button #1998
• Find/Replace overlay: not high enough #1997
• Find/Replace overlay: changes heigth on resize #1995
• Find/Replace overlay: "String xyz not found" message #1993
• find/replace overlay: The Use find/replace overlay preference is hard to locate because keyword definitions are absent #1953
• [find/replace overlay] disabling RegEx resets to the wrong base-location #1915
• [find/replace overlay] incremental base position resets randomly when using "search in selection" #1914
• Find/Replace overlay: remember parameters from earlier #2055
• Users of the Find/Replace dialog want to use Alt + A to perform "Search all" #2080
• Find/Replace overlay: search and replace input fields not vertically centered #2092
• Find/Replace Overlay: can hide views which are in "detached mode" #2099
• Find/replace overlay: history drop-down navigates to second entry when pressing "down" key #2139
• Find/replace overlay: preference changes require reopening overlay #2158
• Find/replace overlay: enable "whole word" option when input field is empty #2162
• [Find/Replace] Pre-selected search string is always escaped even if RegEx search is disabled #2270
• Find/Replace Overlay: History missing #2291
• Find/replace overlay: no placement update while not visible #2478
• [overlay search] search bar does not forward shortcuts from the editor making it sometimes confusing #2512

low

• Find/Replace Overlay - Show result number #2034
• Find/Replace Overlay: Allow rebinding shortcuts #2015
• Find/Replace overlay: make resizeable #1996
• find/replace overlay: return to last cursor position when emptying the search #1944
• [find/replace overlay] Separate UI from Controller Logic #1912
• [find/replace logic] cannot easily reset the Incremental Base-Location #1913
• [find/replace overlay] Add Editor-Annotations whereever a search-result was found #1909
• find/replace overlay - Notification API uses old X  #2035
• Cursor multi-select pastes multiple copies multiple times instead of one copy multiple times #1813
• Find/Replace Overlay unused fields #2060
• Find/Replace History: write Unit Tests #2100
• FindReplaceLogic: performIncrementalSearch breaks contract #2105
• Find/replace overlay: open search history drop-down menu via Alt+Down/Alt+Up #2145
• Find/replace overlay: improve search history navigation #2146
• Find/replace overlay: border size #2194
• Find/replace overlay: text field heights #2195
• Find/Replace Overlay: unable to selectively replace using the keyboard #2473
• Find/Replace Overlay: Compare Editor #2498
• Find/replace overlay: minimum size too small on Linux #2520

unclear

• [find/replace overlay] it is not intuitive that enabling RegEx disables Incremental Search #1911
• [Find/Replace] [Dark Theme] Bad contrast on some buttons #2284

[Wittmaxi]

@HeikoKlare did I miss anything we discussed in our meeting?

[HeikoKlare]

Priorities look sound. Just the following issues were missing (I have added them to the initial post with the mentioned priorities):

• [Find/Replace Overlay] The search-history cannot be accessed from the Overlay #1907 (high)
• [find/replace overlay] incremental base position resets randomly when using "search in selection" #1914 (medium)
• Find/Replace overlay: reorder regexp/whole word button #1998 (medium)

[arsenalzp]

Hello,
Any of those issues are for newcomers (good-first-issue)?

[Wittmaxi]

@arsenalzp Hi, if you are looking to get into them I can give you some pointers, just ask in the corresponding issues :)

These should be (relatively) straight-forward to do:
#1991
#2012

This one might is a bit harder, but maybe you can help me by creating a prototype for how such a resize-mechanism could look like?
#1996

Some issues are already actively being fixed, others are more involved. I can of course help you get into them too, just ask 😀

Please add me to the reviewers of your PRs so that I can roughly see what is happening in the Overlay!

[arsenalzp]

@arsenalzp Hi, if you are looking to get into them I can give you some pointers, just ask in the corresponding issues :)

These should be (relatively) straight-forward to do: #1991 #2012

This one might is a bit harder, but maybe you can help me by creating a prototype for how such a resize-mechanism could look like? #1996

Some issues are already actively being fixed, others are more involved. I can of course help you get into them too, just ask 😀

Please add me to the reviewers of your PRs so that I can roughly see what is happening in the Overlay!

Thank you for detail explanation!
Let me explore the project and its architecture a little bit :)

[HeikoKlare]

I have just added #2033 (high prio) and #2034 (low prio) to the list.

[lukeu]

Early adopter feedback - maybe consider adding #1813 to the list?

I almost logged an issue but realised the prior issue existed. I'd seen it occasionally with ALT+click to make multiple cursors (which I don't do often). I think the Find overlay will make this much easier to encounter, however.

Say I need to do a multple replace. Often I'll copy the "new" text to the clipboard, select the old text and then...

• Maybe I'll even just use ["Find Again", "Paste"] keys a few times (very fast, no find UI needed), or
• If there's more than a few hits, I'll...
  • Press Ctrl+F (the "old" text is entered into the Find Overlay - nice)
  • Press Ctrl+Enter (a multi-selection is made - nice)
  • Whack ESC, Paste

The last step just seems more quick & natural to me than [expand the overlay, paste it there, replace, close it]

The problem is: if Find found 100 hits - this bug inserts 10,000 copies (!)

[HeikoKlare]

Thank you for your early adopter feedback, @lukeu! It is great to see you testing new functionality and then also giving feedback on it. That's very valuable!

I agree that the reported bug is quite annoying. Personally, I did not use the described workflow so far but rely on the "replace all" functionality of the find/replace dialog/overlay, but I see how beneficial the workflow can be (and when you can use it, it should of course work as expected anyway).
Since it's not a bug introduced by the new UI, I also do not see an urgent need of having it fixed in the context of the find/replace overlay and would consider it with lower priority than other issues that might reduce acceptance and/or adoption of the new UI. Still, as you mentioned that the issue becomes more "obvious" with the new UI (#1813 (comment)), I would propose to simply put it on this issue's list (even though it might be priority "low" in the context of this issue).

[Wittmaxi]

I am adding #2053
with high priority

[HeikoKlare]

Also add #2046 (with high prio)?

[Wittmaxi]

@HeikoKlare Yes! Done!

[Wittmaxi]

Added #2055 with medium priority
Added #2054 with high priority

[Wittmaxi]

Added #2059 with high priority
@HeikoKlare is this related to your recent changes to the positioning of the overlay?

[HeikoKlare]

Added:

• Find/Replace Overlay unused fields #2060 (prio low)
• Find/Replace Overlay: Lost in Manifest editor #2075 (prio high)

[HeikoKlare]

Added with medium priority (feel free to change if you see a different prio fitting):

• Users of the Find/Replace dialog want to use Alt + A to perform "Search all" #2080

[Wittmaxi]

Medium Prio:
#2099

Low Prio:
#2100

[Wittmaxi]

Low prio: #2105

[HeikoKlare]

Added three issues/proposals with prio "medium" based on a test session at SAP. Thank you for testing and reporting!

• Find/replace overlay: preference changes require reopening overlay #2158
• Find/replace overlay: improve switching between find and replace input fields #2161
• Find/replace overlay: enable "whole word" option when input field is empty #2162

[HeikoKlare]

Added with low priority:

• Find/replace overlay: border size #2194
• Find/replace overlay: text field heights #2195

[nettozahler]

Thank you for all the work on this find/replace overlay. Using it I have found something which looks like a bug to me. In NON-regex (standard) mode one can simply add a phrase in the search and replace fields and change one occurrence after the other by pressing ENTER repeatedly. But this does not work for me in regex mode. Here hitting ENTER has no effect and I must use the "arrow down" button to jump to the next occurrence each time. I have not found an existing bug report for this issue yet. If you confirm this being a bug I can open a new bug report. But maybe I am missing something?

[HeikoKlare]

Thank you for reporting the issue, @nettozahler! We were not aware of that bug yet (and I agree that it is a bug), so we do not have a GitHub issue for it yet. It would be great if you can open a new issue for that. It should be easy to fix and would be great to still have it in the upcoming release, so we will have a look as soon as possible.

[nettozahler]

Here is the fresh bug report: #2203 (comment). I think I cannot add it to this "umbrella" myself?

[akurtakov]

There seems to be huge issue with this feature under Linux/wayland eclipse-platform/eclipse.platform.swt#1447

[HeikoKlare]

There seems to be huge issue with this feature under Linux/wayland eclipse-platform/eclipse.platform.swt#1447

To me, it's actually not appears to be a bug of this feature but a bug of the Shell implementation when used on Wayland, see eclipse-platform/eclipse.platform.swt#1447 (comment)

[akurtakov]

There seems to be huge issue with this feature under Linux/wayland eclipse-platform/eclipse.platform.swt#1447

To me, it's actually not appears to be a bug of this feature but a bug of the Shell implementation when used on Wayland, see eclipse-platform/eclipse.platform.swt#1447 (comment)

That's exactly why I reported it to swt but still it's a major regression in the overall UX.

[HeikoKlare]

Yes, it's definitely a regression. At least, this is something that you can configure via preferences, so you are not stuck with the bad UX. But still it's a bad experience to see this as default behavior on a fresh installation. And, of course, you need to know (1) that you can configure it and (2) where you have to configure it, since the popup easing this process for you does not appear either. I do not see a way of automatically disabling the feature (for Wayland), except for code-based changes.

If I am not mistaken, the welcome page is also static, local content, isn't it? Otherwise, if that information was dynamically loaded from a remote URL and could thus be changed after deployment of the application, it could be a means to inform users about the issue (and the simple solution for it).

[HeikoKlare]

Added with high prio:

• Find/replace overlay: logs NPE #2244
• Find/replace overlay: does not take focus after detach #2246
• New find/replace overlay broken under wayland eclipse.platform.swt#1447

[HeikoKlare]

Added:

• [Find/Replace] Pre-selected search string is always escaped even if RegEx search is disabled #2270
• [Find/Replace] [Dark Theme] Bad contrast on some buttons #2284
• [Find/Replace] 'Find Next' (Ctrl+K) command broken with the overlay #2285
• Find/Replace Overlay: History missing #2291

[deepika-u]

A query: Do we have an option to clear the history and have a fresh set of history i want to build/accumulate from now on?

[HeikoKlare]

A query: Do we have an option to clear the history and have a fresh set of history i want to build/accumulate from now on?

If I am not mistaken, there is no such option yet. It might be possible to clear the dialog settings, in which the history is stored, manually, but not in a proper way via the UI. I don't see a necessity for it since old history entries will simply be removed upon addition of new entries (and the existing dialog also had not option for it), but if you find that a useful function, feel free to create an issue from it.

[stephan-herrmann]

To me #2473 feels like a significant regression.

[HeikoKlare]

To me #2473 feels like a significant regression.

I have added #2473 to the list of issues, but my current assessment regarding "significance" of the issue is different. It only affects a very specific workflow, so that if you are used to that workflow, it is probably annoying, but I am unsure whether the workflow is widely used.

[tobiasmelcher]

#2509 might be added to this list

[HeikoKlare]

#2509 might be added to this list

Thank you for reporting this. I've added it to the list with medium priority.
I also ranked #2161 up to high priority, as I consider this the most important of the currently open issues, in particular higher than the other medium priority ones.

[HannesWell]

#2509 might be added to this list

Thank you for reporting this. I've added it to the list with medium priority.

Can you please reevaluate the priority? At least I personally find it very annoying when running into the described situation.

[HeikoKlare]

Can you please reevaluate the priority? At least I personally find it very annoying when running into the described situation.

It's fine for me to increase the priority. In particular, since the priorities should be driven by demand of the community and initial priorities (assigned by an individual) may be driven by an the individual's assessment with incomplete assumptions about the usage of features. So feel free to simply adapt the priorities here. Just keep in mind that they should really reflect the according relevance, as people who want to take over issues and contribute fixes for them should be properly guided in selecting a reasonable issue by the list of priorities.