Add custom callback for autocomplete #2764

dilys-l · 2025-01-03T03:26:20Z

IMPORTANT: All PRs must be linked to an issue (except for extremely trivial and straightforward changes).

Description
Adds the ability for the client to pass a custom callback to AutoComplete for dynamic AutoComplete answer resolution

Alternative(s) considered
NA

Type
Feature

Screenshots (if applicable)

Checklist

I have read and acknowledged the Code of conduct.
I have read the Contributing page.
I have signed the Google Individual CLA, or I am covered by my company's Corporate CLA.
I have discussed my proposed solution with code owners in the linked issue(s) and we have agreed upon the general approach.
I have run ./gradlew spotlessApply and ./gradlew spotlessCheck to check my code follows the style guide of this project.
I have run ./gradlew check and ./gradlew connectedCheck to test my changes locally.
I have built and run the demo app(s) to verify my change fixes the issue and/or does not break the demo app(s).

google-cla · 2025-01-03T03:26:24Z

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

FikriMilano · 2025-01-07T09:17:05Z

catalog/src/main/java/com/google/android/fhir/catalog/CatalogApplication.kt

+        callbacks = mapOf(Pair(CustomCallbackType.AUTO_COMPLETE, AutoCompleteCallback(
+          callback = { query ->
+            run {
+              listOf(AutoCompleteViewAnswerOption("a", "Type 2 Diabetes Mellitus"),
+                AutoCompleteViewAnswerOption("b", "Test")
+                )
+            }
+          }
+        )))


on line 51, other than the query, I think we also need the value set resolver url to be passed in the API.

the url will be provided by the questionnaire item, what it does that it can point to a terminology server to retrieve the option lists, then the query will filter that lists so we can have less options to process

i think what fikri meant is tha tthe url should be passed as another parameter besides the query string itself. otherwise how do we distinguish different valueset searches?

Yeah good point. I will make this change.

jingtang10

Thanks @dilys-l! A couple of questions below.

jingtang10 · 2025-01-07T09:43:11Z

catalog/src/main/java/com/google/android/fhir/catalog/CatalogApplication.kt

+        callbacks = mapOf(Pair(CustomCallbackType.AUTO_COMPLETE, AutoCompleteCallback(
+          callback = { query ->
+            run {
+              listOf(AutoCompleteViewAnswerOption("a", "Type 2 Diabetes Mellitus"),
+                AutoCompleteViewAnswerOption("b", "Test")
+                )
+            }
+          }
+        )))


i think what fikri meant is tha tthe url should be passed as another parameter besides the query string itself. otherwise how do we distinguish different valueset searches?

jingtang10 · 2025-01-07T09:45:11Z

datacapture/src/main/java/com/google/android/fhir/datacapture/QuestionnaireEditAdapter.kt

+}
+
+enum class CustomCallbackType {
+  AUTO_COMPLETE,


what are the other callbacks types?

i think the definition of the callback should probably be the same for different widgets (e.g. auto complete, or dropdown), but the ui should behave differently.

My initial thinking was to make it a bit more open ended, but i agree that standardising the definition would be better. I'll make this change

…ocomplete

FikriMilano · 2025-01-14T05:32:11Z

catalog/src/main/java/com/google/android/fhir/catalog/CatalogApplication.kt

+        callbacks = mapOf(Pair(CustomCallbackType.AUTO_COMPLETE, AutoCompleteCallback(
+          callback = { query ->


this code is throwing an error when I tried to build the project, could you have a look?
and since this callback is being used to resolve searched options from value sets, should we rename it to something else?

Sorry, i forgot to include the update for this file. Is there a preferred naming convention for something like this?
Perhaps a ValueSetLookupResolver or similar?
I'll update the code once we agree on a new name.

that's a good name actually

jingtang10 · 2025-01-14T10:30:27Z

datacapture/src/main/java/com/google/android/fhir/datacapture/QuestionnaireEditAdapter.kt

@@ -391,3 +391,5 @@ internal object DiffCallbacks {
      }
    }
 }
+
+typealias CustomCallback<T> = (String, String) -> List<T>


are we expecting any other types than coding?

probably not, i can change this

jingtang10 · 2025-01-14T10:38:32Z

datacapture/src/main/java/com/google/android/fhir/datacapture/DataCaptureConfig.kt

+   * A [CustomCallback] may be set by the client to override the behaviour of an existing component
+   * in the sdc.
+   */
+  var callback: CustomCallback<*>? = null,


if you just add an option url to ExternalAnswerValueSetResolver below would it achieve the same thing?

the way that answerOptionValues are handled in AutoCompleteViewHolderFactory would need to change. i could probably change it so that it's handled in the adapter either way, but then the resolver would be triggered every time the query changes which might not be ideal

FikriMilano · 2025-01-14T10:25:37Z

datacapture/src/main/java/com/google/android/fhir/datacapture/DataCaptureConfig.kt

+   * A [CustomCallback] may be set by the client to override the behaviour of an existing component
+   * in the sdc.
+   */
+  var callback: CustomCallback<*>? = null,


since we are going to use this callback only for valueSetLookupResolver, should we change the type to (String, String) -> List<Coding>?

FikriMilano · 2025-01-14T10:40:27Z

...in/java/com/google/android/fhir/datacapture/views/factories/AutoCompleteViewHolderFactory.kt

+          if (callback != null && answerValueSet != null && objects.isEmpty()) {
+            (callback as? CustomCallback<AutoCompleteViewAnswerOption>)?.invoke(
+              query,
+              answerValueSet,
+            )
+              ?: emptyList()


could you move this implementation to the QuestionnaireViewModel? resolving the options in the UI code seems a bit wrong

android-fhir/datacapture/src/main/java/com/google/android/fhir/datacapture/QuestionnaireViewModel.kt

Lines 926 to 930 in 2a7e91f

val (enabledQuestionnaireAnswerOptions, disabledQuestionnaireResponseAnswers) =

answerOptionsEvaluator.evaluate(

questionnaireItem,

questionnaireResponseItem,

)

…ocomplete

- Combined functionality with the ExternalAnswerValueSetResolver - Renamed various functions and arguments for improved clarity - Moved filter handling out of the adapter and into the textChangedListener - Moved resolver to the viewmodel

add custom callback for autocomplete

43b74f8

dilys-l requested a review from a team as a code owner January 3, 2025 03:26

dilys-l requested a review from aditya-07 January 3, 2025 03:26

FikriMilano suggested changes Jan 7, 2025

View reviewed changes

jingtang10 requested changes Jan 7, 2025

View reviewed changes

dilys-l and others added 2 commits January 9, 2025 12:04

Incorporated review feedback

2a7962f

Merge branch 'google:master' into feature/add-custom-callback-for-aut…

0441c8d

…ocomplete

FikriMilano suggested changes Jan 14, 2025

View reviewed changes

jingtang10 reviewed Jan 14, 2025

View reviewed changes

FikriMilano suggested changes Jan 14, 2025

View reviewed changes

dilys-l and others added 2 commits January 23, 2025 11:57

Merge branch 'google:master' into feature/add-custom-callback-for-aut…

fa2dfcd

…ocomplete

Incorporated review feedback

d91d054

- Combined functionality with the ExternalAnswerValueSetResolver - Renamed various functions and arguments for improved clarity - Moved filter handling out of the adapter and into the textChangedListener - Moved resolver to the viewmodel

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add custom callback for autocomplete #2764

Add custom callback for autocomplete #2764

dilys-l commented Jan 3, 2025 •

edited

Loading

google-cla bot commented Jan 3, 2025

FikriMilano Jan 7, 2025 •

edited

Loading

jingtang10 Jan 7, 2025

dilys-l Jan 7, 2025

jingtang10 left a comment

jingtang10 Jan 7, 2025

jingtang10 Jan 7, 2025

dilys-l Jan 7, 2025

FikriMilano Jan 14, 2025

dilys-l Jan 14, 2025

FikriMilano Jan 14, 2025

jingtang10 Jan 14, 2025

dilys-l Jan 20, 2025

jingtang10 Jan 14, 2025

dilys-l Jan 20, 2025

FikriMilano Jan 14, 2025

FikriMilano Jan 14, 2025

		callbacks = mapOf(Pair(CustomCallbackType.AUTO_COMPLETE, AutoCompleteCallback(
		callback = { query ->

	val (enabledQuestionnaireAnswerOptions, disabledQuestionnaireResponseAnswers) =
	answerOptionsEvaluator.evaluate(
	questionnaireItem,
	questionnaireResponseItem,
	)

Add custom callback for autocomplete #2764

Are you sure you want to change the base?

Add custom callback for autocomplete #2764

Conversation

dilys-l commented Jan 3, 2025 • edited Loading

google-cla bot commented Jan 3, 2025

FikriMilano Jan 7, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jingtang10 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dilys-l commented Jan 3, 2025 •

edited

Loading

FikriMilano Jan 7, 2025 •

edited

Loading