CBL-7981: Add correlation ID API (#473)

Author: borrrden

common/main/cpp/com_couchbase_lite_internal_core_impl_NativeC4Replicator.h

@@ -81,6 +81,15 @@ JNIEXPORT jobject
 JNICALL Java_com_couchbase_lite_internal_core_impl_NativeC4Replicator_getStatus
         (JNIEnv * , jclass, jlong);
 
+/*
+ * Class:     com_couchbase_lite_internal_core_impl_NativeC4Replicator
+ * Method:    getCorrelationId
+ * Signature: (J)Ljava/lang/String;
+ */
+JNIEXPORT jstring JNICALL
+Java_com_couchbase_lite_internal_core_impl_NativeC4Replicator_getCorrelationId(
+    JNIEnv *, jclass, jlong);
+
 /*
  * Class:     com_couchbase_lite_internal_core_impl_NativeC4Replicator
  * Method:    getPendingDocIds

common/main/cpp/native_c4replicator.cc

@@ -21,6 +21,7 @@
 #include "native_glue.hh"
 #include "native_c4replutils.hh"
 #include "socket_factory.h"
+#include "fleece/FLSlice.h"
 #include "com_couchbase_lite_internal_core_impl_NativeC4Replicator.h"
 
 using namespace litecore;
@@ -604,6 +605,19 @@ Java_com_couchbase_lite_internal_core_impl_NativeC4Replicator_getStatus(
     return toJavaReplStatus(env, status);
 }
 
+JNIEXPORT jstring JNICALL
+Java_com_couchbase_lite_internal_core_impl_NativeC4Replicator_getCorrelationId(
+        JNIEnv *env,
+        jclass ignored,
+        jlong repl) {
+    auto result = c4repl_getCorrelationID((C4Replicator *)repl);
+    auto retVal = result
+        ? UTF8ToJstring(env, (const char *)result.buf, result.size)
+        : nullptr;
+    FLSliceResult_Release(result);
+    return retVal;
+}
+
 /*
  * Class:     com_couchbase_lite_internal_core_impl_NativeC4Replicator
  * Method:    getPendingDocIDs

common/main/java/com/couchbase/lite/AbstractReplicator.java

@@ -238,6 +238,22 @@ public void stop() {
     @NonNull
     public ReplicatorConfiguration getConfig() { return new ReplicatorConfiguration(config); }
 
+    /**
+     *  Gets the correlation ID of this replication so that it can be analyzed along
+     * with the logs from the remote side.  If not started, or unavailable, returns
+     * null
+     *
+     * @return The correlation ID of the replicator
+     */
+    @Nullable
+    public String getCorrelationId() {
+        try { return getOrCreateC4Replicator().getCorrelationId(); }
+        catch (LiteCoreException e) {
+            Log.e(LOG_DOMAIN, "Failed getting correlation ID", e);
+            return null;
+        }
+    }
+
     /**
      * The replicator's current status: its activity level and progress.
      *

common/main/java/com/couchbase/lite/internal/core/C4Replicator.java

@@ -234,6 +234,8 @@ long nCreateWithSocket(
         void nSetOptions(long replPeer, @Nullable byte[] options);
         @NonNull
         C4ReplicatorStatus nGetStatus(long replPeer);
+        @Nullable
+        String nGetCorrelationId(long replPeer);
         @NonNull
         FLSliceResult nGetPendingDocIds(long replPeer, @NonNull String scope, @NonNull String collection)
             throws LiteCoreException;
@@ -713,6 +715,9 @@ public void setOptions(@Nullable byte[] options) {
     @Nullable
     public C4ReplicatorStatus getStatus() { return withPeerOrNull(impl::nGetStatus); }
 
+    @Nullable
+    public String getCorrelationId() { return withPeerOrNull(impl::nGetCorrelationId); }
+
     public boolean isDocumentPending(@NonNull String docId, @NonNull String scope, @NonNull String collection)
         throws LiteCoreException {
         return withPeerOrDefault(false, replPeer -> impl.nIsDocumentPending(replPeer, docId, scope, collection));

common/main/java/com/couchbase/lite/internal/core/impl/NativeC4Replicator.java

@@ -118,6 +118,10 @@ public long nCreateWithSocket(
     public C4ReplicatorStatus nGetStatus(long peer) { return getStatus(peer); }
 
     // thread safe
+    @Nullable
+    @Override
+    public String nGetCorrelationId(long peer) { return getCorrelationId(peer); }
+
     @NonNull
     @Override
     public FLSliceResult nGetPendingDocIds(long peer, @NonNull String scope, @NonNull String collection)
@@ -230,6 +234,9 @@ private static native long createWithSocket(
     @NonNull
     private static native C4ReplicatorStatus getStatus(long peer);
 
+    @Nullable
+    private static native String getCorrelationId(long peer);
+
     /**
      * Returns a list of string ids for pending documents.
      * thread-safe

common/test/java/com/couchbase/lite/mock/ReplicatorMocks.kt

@@ -86,6 +86,7 @@ open class MockNativeReplicator : C4Replicator.NativeImpl {
     override fun nStart(peer: Long, restart: Boolean) = Unit
     override fun nStop(peer: Long) = Unit
     override fun nSetOptions(peer: Long, options: ByteArray?) = Unit
+    override fun nGetCorrelationId(peer: Long): String? = null
     override fun nGetPendingDocIds(peer: Long, scope: String, collection: String) = FLSliceResult.createTestSlice()
     override fun nIsDocumentPending(peer: Long, id: String, scope: String, collection: String) = true
     override fun nSetProgressLevel(peer: Long, progressLevel: Int) = Unit