1489528 - FinderFindFlags IntDef annotation should include a zero value as a default

Status: RESOLVED FIXED

(GeckoView :: General, task, P5)

Description

[Jonathan Almeida [:jonalmeida]]

When using GeckoSession.getFinder().find, a flag is needed from the IntDef FinderFindFlags even if searching in a forward direction - for that we pass 0.

The Android linter complains that by passing 0 we're not adhering to the IntDef values which don't have a 0 attribute there.

Consider this snippet of code:

  val findFlags = if (forward) 0 else GeckoSession.FINDER_FIND_BACKWARDS
  geckoSession.finder.find(text, 0).then { result: GeckoSession.FinderResult? ->
    result?.let {
      notifyObservers { onFindResult(it.current, it.total, true) }
    }
    GeckoResult<Void>()
  }

To avoid the linter from complaining, we should add a default attribute to the IntDef.

Comment 1

[clairebitterness]

Hi! I would like to work on this bug

Comment 2

[Jonathan Almeida [:jonalmeida]]

davidb, can we assign a new mentor for this bug?

Comment 3

[Eugen Sawin [:esawin]]

(In reply to clairebitterness from comment #1)

Hi! I would like to work on this bug

Hi, are you still interested in working on this bug?

Comment 4

[phu.thai888]

Hello,

What is the status of this bug? I am new to contributing to Mozilla code base, but I would like to lend a hand if possible.

thank you,

Comment 5

[Jonathan Almeida [:jonalmeida]]

(In reply to phu.thai888 from comment #4)

Hello,

What is the status of this bug? I am new to contributing to Mozilla code base, but I would like to lend a hand if possible.

thank you,

Welcome! This bug is still open to be worked on. Maybe esawin can help?

Comment 6

[[:owlish] 🦉 PST]

Hi (In reply to phu.thai888 from comment #4)

Hello,

What is the status of this bug? I am new to contributing to Mozilla code base, but I would like to lend a hand if possible.

thank you,

Hi there, I'll be your mentor for the bug :)

If you don't already, set up your development environment. You can find the instructions here https://firefox-source-docs.mozilla.org/mobile/android/geckoview/contributor/geckoview-quick-start.html

Here is the function in question: https://searchfox.org/mozilla-central/source/mobile/android/geckoview/src/main/java/org/mozilla/geckoview/SessionFinder.java#82-83 <--- this is a SearchFox link. SearchFox is out tool we use to search our codebase. So you can see there the second parameter annotated @FinderFindFlags, and that's the interface we're interested in. You can find it in SearchFox by pasting FinderFindFlags into the search field and then selecting the file it's defined in.

Let me know if you have any questions or difficulties! Our team also has a Matrix channel #geckoview:mozilla.org which you can also use to ask questions.

Comment 7

[Chris Peterson [:cpeterson]]

Enhancements should have severity N/A.

Comment 8

[:Gela]

Attachment: Bug 1489528 - FinderFindFlags IntDef annotation should include a zero value as a default

Comment 9

[:Gela]

Attachment: WIP: Bug 1489528 - FinderFindFlags IntDef annotation should include a zero value as a default

Comment 10

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/d6c43b10944a
FinderFindFlags IntDef annotation should include a zero value as a default r=kaya,geckoview-reviewers,ohall

Comment 11

[Aron Cseh]

https://hg.mozilla.org/mozilla-central/rev/d6c43b10944a