Merge pull request #1335 from couchbase/feature/issue_1315

Fixed #1315 - Replicator shouldn't go to IDLE state if the authentica…

Author: pasin

src/main/java/com/couchbase/lite/replicator/ReplicationInternal.java

@@ -24,6 +24,7 @@
 import com.couchbase.lite.auth.Authenticator;
 import com.couchbase.lite.auth.Authorizer;
 import com.couchbase.lite.auth.LoginAuthorizer;
+import com.couchbase.lite.auth.OpenIDConnectAuthorizer;
 import com.couchbase.lite.auth.SessionCookieAuthorizer;
 import com.couchbase.lite.internal.InterfaceAudience;
 import com.couchbase.lite.internal.RevisionInternal;
@@ -84,6 +85,13 @@ abstract class ReplicationInternal implements BlockingQueueListener {
     private static int lastSessionID = 0;
     public static int RETRY_DELAY_SECONDS = 60; // #define kRetryDelay 60.0 in CBL_Replicator.m
 
+    private static ReplicationStateTransition TRANS_RUNNING_TO_IDLE =
+            new ReplicationStateTransition(ReplicationState.RUNNING,
+                    ReplicationState.IDLE, ReplicationTrigger.WAITING_FOR_CHANGES);
+    private static ReplicationStateTransition TRANS_IDLE_TO_RUNNING =
+            new ReplicationStateTransition(ReplicationState.IDLE,
+                    ReplicationState.RUNNING, ReplicationTrigger.RESUME);
+
     // Change listeners can be called back synchronously or asynchronously.
     protected enum ChangeListenerNotifyStyle {
         SYNC, ASYNC
@@ -95,6 +103,7 @@ protected enum ChangeListenerNotifyStyle {
     protected HttpClientFactory clientFactory;
     protected String lastSequence;
     protected Authenticator authenticator;
+    protected boolean authenticating = false;
     protected String filterName;
     protected Map<String, Object> filterParams;
     protected List<String> documentIDs;
@@ -148,6 +157,7 @@ protected enum ChangeListenerNotifyStyle {
         this.clientFactory = clientFactory;
         this.lifecycle = lifecycle;
         this.requestHeaders = new HashMap<String, Object>();
+        this.authenticating = false;
 
         // The reason that notifications are ASYNC is to make the public API call
         // Replication.getStatus() work as expected.  Because if this is set to SYNC,
@@ -252,6 +262,7 @@ protected void start() {
             }
             db.addReplication(parentReplication);
             db.addActiveReplication(parentReplication);
+            this.authenticating = false;
             initSessionId();
             // initialize batcher
             initBatcher();
@@ -298,6 +309,8 @@ protected void goOnline() {
      * Close all resources associated with this replicator.
      */
     protected void close() {
+        this.authenticating = false;
+
         // cancel pending futures
         for (Future future : pendingFutures) {
             future.cancel(false);
@@ -426,6 +439,7 @@ protected void checkSession() {
 
     @InterfaceAudience.Private
     protected void checkSessionAtPath(final String sessionPath) {
+        // First check whether a session exists
         Future future = sendAsyncRequest("GET", sessionPath, null, new RemoteRequestCompletion() {
 
             @Override
@@ -470,6 +484,8 @@ public void onCompletion(Response _response, Object result, Throwable err) {
 
     @InterfaceAudience.Private
     protected void login() {
+        authenticating = true;
+
         final LoginAuthorizer loginAuth;
         List<Object> login = null;
         loginAuth = getAuthenticator() instanceof LoginAuthorizer ? (LoginAuthorizer) getAuthenticator() : null;
@@ -520,6 +536,8 @@ public void run(Database database) {
     }
 
     private void loginFinishedWithError(Throwable error) {
+        authenticating = false;
+
         if (error != null) {
             Log.v(TAG, "%s: Login error: %s", this, error.getMessage());
             setError(error);
@@ -1183,6 +1201,7 @@ public boolean canSendCompressedRequests() {
      * Actual work of stopping the replication process.
      */
     protected void stop() {
+        this.authenticating = false;
         // clear batcher
         batcher.clear();
         // set non-continuous
@@ -1452,9 +1471,19 @@ private void logTransition(Transition<ReplicationState, ReplicationTrigger> tran
                 transition.getSource(), transition.getDestination(), transition.getTrigger(), this);
     }
 
-    private void notifyChangeListenersStateTransition(Transition<ReplicationState, ReplicationTrigger> transition) {
+    private void notifyChangeListenersStateTransition(
+            Transition<ReplicationState, ReplicationTrigger> transition) {
         logTransition(transition);
-        Replication.ChangeEvent changeEvent = new Replication.ChangeEvent(this, new ReplicationStateTransition(transition));
+
+        ReplicationStateTransition replStateTrans = new ReplicationStateTransition(transition);
+
+        if ((TRANS_RUNNING_TO_IDLE.equals(replStateTrans)
+                || TRANS_IDLE_TO_RUNNING.equals(replStateTrans)) && authenticating) {
+            Log.i(TAG, "During middle of authentication, not notify Replicator state change");
+            return;
+        }
+
+        Replication.ChangeEvent changeEvent = new Replication.ChangeEvent(this, replStateTrans);
         notifyChangeListeners(changeEvent);
     }
 

src/main/java/com/couchbase/lite/replicator/ReplicationStateTransition.java

@@ -1,16 +1,16 @@
-/**
- * Copyright (c) 2016 Couchbase, Inc. All rights reserved.
- *
- * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
- * except in compliance with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under the
- * License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
- * either express or implied. See the License for the specific language governing permissions
- * and limitations under the License.
- */
+//
+// Copyright (c) 2016 Couchbase, Inc. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
+// except in compliance with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software distributed under the
+// License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+// either express or implied. See the License for the specific language governing permissions
+// and limitations under the License.
+//
 package com.couchbase.lite.replicator;
 
 import com.github.oxo42.stateless4j.transitions.Transition;
@@ -61,4 +61,24 @@ public ReplicationTrigger getTrigger() {
         this.trigger = trigger;
     }
 
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+
+        ReplicationStateTransition that = (ReplicationStateTransition) o;
+
+        if (source != that.source) return false;
+        if (destination != that.destination) return false;
+        return trigger == that.trigger;
+
+    }
+
+    @Override
+    public int hashCode() {
+        int result = source.hashCode();
+        result = 31 * result + destination.hashCode();
+        result = 31 * result + trigger.hashCode();
+        return result;
+    }
 }