javaandroidfirebase-realtime-databasecompletionhandler

How to ensure Completion handler for one Firebase lookup completes before another one does


I have the following Firebase DB node structure:

UserInGroup
    --- GroupID
      --- UserId : true/false  


Users
    --- UserId
      --- Username : String
      --- ...


GroupStatus
    --- GroupId
      --- UserId: true/false    

I need to pull for the first node to get all the users in the Group

Then use that info to get the users account info details

Finally check to see the users status in the Group

I cannot figure a way to implement the completionhandler in Java/Android ? I have done so for iOS with completionhandlers.

Can anyone assist with helping me implement the solution in Java?

---- UPDATE ----

I have done the following:

// Create an interface to init all the callback functions
private interface AllUsersCallback {

    void onSuccess(DataSnapshot dataSnapshot);

    void onStart();

    void onFailure();

}

private void readData(Query query, AllUsersActivity.AllUsersCallback listener) {

    listener.onStart();

    query.addListenerForSingleValueEvent(new ValueEventListener() {

        @Override
        public void onDataChange(DataSnapshot dataSnapshot) {

            if (dataSnapshot.exists()) {

                listener.onSuccess(dataSnapshot);

            } else { // dataSnapshot doesn't exist

            }

        }

        @Override
        public void onCancelled(DatabaseError databaseError) {

            Log.d(TAG, databaseError.getMessage());
            //
            listener.onFailure();

        }

    });

}

And lastly the Activity view:

@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    // Init ArrayList
    userList = new ArrayList<>();

    userInGroupReference = mFirebaseDatabase.getReference("GroupUsers");

    userInGroupQuery = userInGroupReference.child(groupID).orderByValue().equalTo(true);

    // Completion Handler for Lookups
    readData(userInGroupQuery, new AllUsersActivity.AllUsersCallback() {

        @Override
        public void onSuccess(DataSnapshot dataSnapshot) {

            // Clear the List (remove dupes)
            userList.clear();

            for (DataSnapshot snapshot : dataSnapshot.getChildren()) {

                String userId = snapshot.getKey();
               
                // Call function to set usernames to the users
                setUsername(userId); 

            }

            /*
              THIS ALWAYS COMES OUT BLANK!? <--------
            */
            for (int i = 0; i < userList.size(); i++) {

                Log.e(TAG,"List element: " + userList.get(i).getUsername());

            }

        }

        @Override
        public void onStart() {

            // When starting
            Log.d("ONSTART", "Started");

        }

        @Override
        public void onFailure() {

            // If failed
            Log.d("onFailure", "Failed");

        }

    });

}

and the function used to set the users username to the userList:

public void setUsername(String userId) {

    userReference = mFirebaseDatabase.getReference("Users");

    userQuery = userReference.child(userId).child("username");

    // Add handle for listener
    userQuery.addListenerForSingleValueEvent(new ValueEventListener() {

        @Override
        public void onDataChange(DataSnapshot dataSnapshot) {

            if (dataSnapshot.exists()) {

                String username = dataSnapshot.getValue().toString();

                AllUsers result = new AllUsers(username);
                
                userList.add(result);

            }

        }

        @Override
        public void onCancelled(DatabaseError databaseError) {

        }

    });

}

Solution

  • These database calls are asynchronous - the callback code does not run immediately, it runs some time in the future when you actually get the data.

    The easiest way to chain multiple dependent async queries is to put each query into its own function, and call it from the dependent query's callback. In your case, you could have multiple callbacks running at once, so as each one completes you can check for it to be done and check for them all to be done by comparing the size of the list with the number of queries launched.

    For example:

    private ArrayList<String> userList = new ArrayList<>();
    private int numUsers = 0;
    
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        
        // other setup stuff
        startInitialQuery();
    }
    
    private void startInitialQuery() {
        // make your initial query
        
        query.addListenerForSingleValueEvent(new ValueEventListener() {
    
            @Override
            public void onDataChange(DataSnapshot dataSnapshot) {
                if (dataSnapshot.exists()) {
                    userList.clear();
                    numUsers = 0; // dataSnapshot.getChildren().size();
                    
                    // If the size() call above works, use that, otherwise
                    // you can count the number of children this way.
                    for(DataSnapshot snap : dataSnapshot.getChildren()) {
                        ++numUsers;
                    }   
                    
                    for(DataSnapshot snap : dataSnapshot.getChildren()) {
                        String userId = snap.getKey();
                        readUser(userId);
                    }
                }
            }
    
            @Override
            public void onCancelled(DatabaseError databaseError) {
                Log.d(TAG, databaseError.getMessage());
            }
        });
    }
    
    private void readUser(String userId) {
    
        // make userQuery using "userId" input
        
        userQuery.addListenerForSingleValueEvent(new ValueEventListener() {
    
            @Override
            public void onDataChange(DataSnapshot dataSnapshot) {
                if (dataSnapshot.exists()) {
                    String username = dataSnapshot.getValue().toString();
                    userList.add(username);
                    checkLoaded();
                }
                else {
                    --numUsers;
                    checkLoaded();
                }
            }
    
            @Override
            public void onCancelled(DatabaseError databaseError) {
                Log.d(TAG, databaseError.getMessage());
                --numUsers;
                checkLoaded();
            }
        });
    }
    
    private void checkLoaded() {
        if( userList.size() == numUsers ) {
            // All done getting users! Show a toast, update a view, etc...
        }
    }
    

    Alternately, if you switch to using Kotlin and coroutines you can write this as a pretty simple linear suspend function where you can actually make the different tasks wait.

    A cleaner, but more invasive change, would be to move this all to a ViewModel that contains LiveData of each of these steps. As data is received, you post it to the LiveData and the UI can observe that and react accordingly (e.g update views, trigger the next call, etc).

    Update

    Here is an example showing how to do this with a ViewModel and LiveData

    
    public class MainViewModel extends ViewModel {
        private final MutableLiveData<List<String>> users = new MutableLiveData<>();
        LiveData<List<String>> getUsers() {
            return users;
        }
    
        private final ArrayList<String> userList = new ArrayList<>();
    
        void startFetchingData() {
            // build query
            query.addListenerForSingleValueEvent(new ValueEventListener() {
    
                @Override
                public void onDataChange(DataSnapshot dataSnapshot) {
                    if (dataSnapshot.exists()) {
                        userList.clear();
    
                        for(DataSnapshot snap : dataSnapshot.getChildren()) {
                            String userId = snap.getKey();
                            readUser(userId);
                        }
                    }
                }
    
                @Override
                public void onCancelled(DatabaseError databaseError) {
                    Log.d(TAG, databaseError.getMessage());
                }
            });
        }
    
    
        private void readUser(String userId) {
            // build userQuery
            userQuery.addListenerForSingleValueEvent(new ValueEventListener() {
    
                @Override
                public void onDataChange(DataSnapshot dataSnapshot) {
                    if (dataSnapshot.exists()) {
                        String username = dataSnapshot.getValue().toString();
                        userList.add(username);
                        users.postValue(userList);
                    }
                }
    
                @Override
                public void onCancelled(DatabaseError databaseError) {
                    Log.d(TAG, databaseError.getMessage());
                }
            });
        }
    }
    
    

    and in the activity you set an observer for the LiveData that is notified any time the data changes.

    model = new ViewModelProvider(this).get(MainViewModel.class);
    
    final Observer<List<String>> userObserver = userList -> {
        // Update the UI, or call something else
        // this will get called every time the list of users is
        // updated in the ViewModel
        System.out.println("TEST: got data " + userList);
    };
    
    // Observe the LiveData, passing in this activity as the LifecycleOwner and the observer.
    model.getUsers().observe(this, userObserver);
    
    model.startFetchingData();