RuntimeException: Cannot find preference screen within search result

[tolot27]

Searching the settings for "back-fill" and clicking on the top-most hit "Back-fill data Tap to send historical data to Nightscout" (if English is the UI language) results in a java.lang.RuntimeException: Cannot find preference screen within search result.

The log shows:

jamorham PREFS
Got error trying to highlight search results:
java.lang.RuntimeException: Cannot find preference screen
within search result

Any version of xDrip is affected.

[tolot27]

I've traced the bug down to the library search-preference.aar. This library is self-compiled from repository ByteHamster/SearchPreference and there are many never versions available. Unfortunately, non of these versions work with xDrip. It looks like search-preference.aar was cloned and modified around version v1.2.6.

@jamorham Do you know who modified the original library?

[tolot27]

I've found Adapted for using in PreferenceActivity Context but this commit introduces some other changes and it will not introduce SearchConfiguration.getKeysList().

[jamorham]

This is easy to resolve see: 87ac6fc

[Lupum1001]

Opened another pull request with more fixes.
#2114

Is there a way to screen for this issue automatically, either by linting the xml or writing unit tests?

[Lupum1001]

#2114 (comment)
#2114 (comment)
Sorry about the relocation @tolot27; I just have a preference for discussing further fixes in the context of the issue instead of the individual pull request if that's ok.

This will also find root nodes of PreferenceScreen. I don't know whether they need an android:key attribute or not.

To my knowledge anything of the type Preference, or its subclasses will need the android:key defined. There's at least one exception which is PreferenceCategory, but PreferenceGroup may be another.
https://developer.android.com/reference/android/preference/Preference

[tolot27]

Sorry about the relocation @tolot27; I just have a preference for discussing further fixes in the context of the issue instead of the individual pull request if that's ok.

I try to keep the developer related discussions separated from the user-relevant discussions to not "pollute" the issues. But this issue is more like a dev issue. Hence, I'm fine with it.

This will also find root nodes of PreferenceScreen. I don't know whether they need an android:key attribute or not.

To my knowledge anything of the type Preference, or its subclasses will need the android:key defined.

The docs do not state that the android:key attribute is required. If it is really required, we have to add it to the root nodes, too.

Android Developers > Docs > Reference states:

"This class contains a key that will be used as the key into the SharedPreferences. It is up to the subclass to decide how to store the value."

We have to verify if the addition of the missing android:key attribute changes the storage of the preferences and introduces incompatibilities during import.