Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Observe query updates #1520

Merged
merged 5 commits into from
Oct 1, 2021
Merged

Observe query updates #1520

merged 5 commits into from
Oct 1, 2021

Conversation

poojamat
Copy link
Contributor

@poojamat poojamat commented Oct 1, 2021

Issue #, if available:

Description of changes:
Add support for observe query.
Java sample code:

String tag = "ObserveQuery";
        Consumer<DataStoreQuerySnapshot<Blog>> onQuerySnapshot = value ->{
            Log.d(tag, "success on snapshot");
            Log.d(tag, "num records: " + value.getItems().size());
            Log.d(tag, "sync status: " + value.getIsSynced());
        };

        Consumer<Cancelable> observationStarted = value ->{
                Log.d(tag, "success on cancelable");
        };
        Consumer<DataStoreException> onObservationError =value ->{
                Log.d(tag, "error on snapshot$value");
        };
        Action onObservationComplete = () ->{
            Log.d(tag, "complete");
        };

        QueryPredicate predicate =
                NAME.contains("1").or(NAME.contains("2")).or(NAME.contains("3"));
        QuerySortBy querySortBy = new QuerySortBy("blog", "name", QuerySortOrder.ASCENDING);
        List<QuerySortBy> sortByList = new ArrayList<QuerySortBy>();
        sortByList.add(querySortBy);
        ObserveQueryOptions options = new ObserveQueryOptions(predicate, sortByList);
        Amplify.DataStore.<Blog>observeQuery(
                Blog.class,
                options,
                observationStarted,
                onQuerySnapshot,
                onObservationError,
                onObservationComplete
        );

Kotlin Sample code:

        val tag = "ObserveQuery"
        val onQuerySnapshot: Consumer<DataStoreQuerySnapshot<Car>> =
            Consumer<DataStoreQuerySnapshot<Car>> { value: DataStoreQuerySnapshot<Car> ->
                Log.d(tag, "success on snapshot")
                Log.d(tag, "num records: " + value.items.size)
                Log.d(tag, "sync status: " + value.isSynced)
            }

        val observationStarted =
            Consumer { _: Cancelable ->
                Log.d(tag, "success on cancelable")
            }
        val onObservationError =
            Consumer { value: DataStoreException ->
                Log.d(tag, "error on snapshot$value")
            }
        val onObservationComplete = Action {
            Log.d(tag, "complete")
        }

        // 1, 4, 5, 6
        val predicate: QueryPredicate =
            NAME.contains("1").or(NAME.contains("2")).or(NAME.contains("3"))
        val querySortBy = QuerySortBy("car", "name", QuerySortOrder.ASCENDING)
        
        val options = ObserveQueryOptions(predicate, listOf(querySortBy))
        Amplify.DataStore.observeQuery(
            Car::class.java,
            options,
            observationStarted,
            onQuerySnapshot,
            onObservationError,
            onObservationComplete
        )

RxJava Sample code:

    RxAmplify.DataStore.observeQuery(Model.class,
                new ObserveQueryOptions()).subscribe(
                        modelDataStoreQuerySnapshot -> {
                            Log.d("mySampleApp", "success on snapshot");
                            Log.d("mySampleApp", "num records: " + modelDataStoreQuerySnapshot.getItems().size());
                            Log.d("mySampleApp", "sync status: " + modelDataStoreQuerySnapshot.getIsSynced());
                        });

Kotlin Coroutines Sample code:

     Amplify.DataStore.observeQuery(
                Blog::class,
                ObserveQueryOptions(Blog.NAME.contains("Susan"), null)
            ).onStart { Log.i("MyAmplifyApp", "Observation began") }
                .catch { Log.e("MyAmplifyApp", "Observation failed", it) }
                .onCompletion { Log.i("MyAmplifyApp", "Observation complete") }
                .collect { value -> Log.i("MyAmplifyApp", "Blog: ${value.items.size}") }

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@poojamat poojamat requested a review from a team October 1, 2021 04:49
Copy link
Contributor

@rjuliano rjuliano left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One minor comment, but other than that LGTM!!!

@poojamat
Copy link
Contributor Author

poojamat commented Oct 1, 2021

feat: Updates to observe query API to not batch the changes after Sync and cancel subscription in some error scenarios.

@poojamat poojamat merged commit bcd84c5 into main Oct 1, 2021
@poojamat poojamat deleted the observe-query-updates branch October 1, 2021 20:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants