add back FirebaseDataConnect.logging, but marked as deprecated, so as to NOT be a breaking change

Author: dconeybe

firebase-dataconnect/CHANGELOG.md

@@ -1,8 +1,8 @@
 # Unreleased
-* [changed] *Breaking Change* `FirebaseDataConnect.logLevel` changed to
-  `FirebaseDataConnect.logging` to provide more fine-grained control and access
-  to the logcat logging facilities, such as a `Flow` to collect the log level
-  changes and `push()` to easily set and restore the log level.
+* [feature] `FirebaseDataConnect.logging` added, to provide more advanced
+  control and access to the logcat logging facilities, such as a `Flow` to
+  collect the log level changes and `push()` to easily set and restore the log
+  level.
   ([#NNNN](https://github.com/firebase/firebase-android-sdk/pull/NNNN))
 
 # 16.0.0-beta03

firebase-dataconnect/api.txt

@@ -130,7 +130,9 @@ package com.google.firebase.dataconnect {
   public final class FirebaseDataConnectKt {
     method @NonNull public static com.google.firebase.dataconnect.FirebaseDataConnect getInstance(@NonNull com.google.firebase.dataconnect.FirebaseDataConnect.Companion, @NonNull com.google.firebase.FirebaseApp app, @NonNull com.google.firebase.dataconnect.ConnectorConfig config, @NonNull com.google.firebase.dataconnect.DataConnectSettings settings = com.google.firebase.dataconnect.DataConnectSettings());
     method @NonNull public static com.google.firebase.dataconnect.FirebaseDataConnect getInstance(@NonNull com.google.firebase.dataconnect.FirebaseDataConnect.Companion, @NonNull com.google.firebase.dataconnect.ConnectorConfig config, @NonNull com.google.firebase.dataconnect.DataConnectSettings settings = com.google.firebase.dataconnect.DataConnectSettings());
+    method @Deprecated @NonNull public static com.google.firebase.dataconnect.LogLevel getLogLevel(@NonNull com.google.firebase.dataconnect.FirebaseDataConnect.Companion);
     method @NonNull public static com.google.firebase.dataconnect.DataConnectLogging getLogging(@NonNull com.google.firebase.dataconnect.FirebaseDataConnect.Companion);
+    method @Deprecated public static void setLogLevel(@NonNull com.google.firebase.dataconnect.FirebaseDataConnect.Companion, @NonNull com.google.firebase.dataconnect.LogLevel);
   }
 
   @kotlinx.serialization.Serializable(with=LocalDateSerializer::class) public final class LocalDate {

firebase-dataconnect/src/main/kotlin/com/google/firebase/dataconnect/FirebaseDataConnect.kt

@@ -378,6 +378,23 @@ public fun FirebaseDataConnect.Companion.getInstance(
   settings: DataConnectSettings = DataConnectSettings()
 ): FirebaseDataConnect = getInstance(app = Firebase.app, config = config, settings = settings)
 
+/**
+ * The log level used by all [FirebaseDataConnect] instances.
+ *
+ * The default log level is [LogLevel.WARN]. Setting this to [LogLevel.DEBUG] will enable debug
+ * logging, which is especially useful when reporting issues to Google or investigating problems
+ * yourself. Setting it to [LogLevel.NONE] will disable all logging.
+ */
+@Deprecated(
+  message = "Will be removed when Data Connect graduates from beta",
+  replaceWith = ReplaceWith("logging.level", "com.google.firebase.dataconnect.logging")
+)
+public var FirebaseDataConnect.Companion.logLevel: LogLevel
+  get() = logging.level
+  set(level) {
+    logging.level = level
+  }
+
 /** The logcat logging facilities used by all [FirebaseDataConnect] instances. */
 public val FirebaseDataConnect.Companion.logging: DataConnectLogging
   get() = DataConnectLoggingImpl

firebase-dataconnect/src/test/kotlin/com/google/firebase/dataconnect/FirebaseDataConnectUnitTest.kt

@@ -0,0 +1,53 @@
+/*
+ * Copyright 2024 Google LLC
+ *
+ * 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.google.firebase.dataconnect
+
+import io.kotest.matchers.shouldBe
+import io.kotest.property.Arb
+import io.kotest.property.arbitrary.enum
+import io.kotest.property.checkAll
+import kotlinx.coroutines.test.runTest
+import org.junit.Test
+
+class FirebaseDataConnectUnitTest {
+
+  @Test
+  @Suppress("DEPRECATION")
+  fun `logLevel set and get`() = runTest {
+    checkAll(Arb.enum<LogLevel>()) { newLevel ->
+      FirebaseDataConnect.logLevel = newLevel
+      FirebaseDataConnect.logLevel shouldBe newLevel
+    }
+  }
+
+  @Test
+  @Suppress("DEPRECATION")
+  fun `logLevel set should forward to logging dot level`() = runTest {
+    checkAll(Arb.enum<LogLevel>()) { newLevel ->
+      FirebaseDataConnect.logLevel = newLevel
+      FirebaseDataConnect.logging.level shouldBe newLevel
+    }
+  }
+
+  @Test
+  @Suppress("DEPRECATION")
+  fun `logLevel get should retrieve from logging dot level`() = runTest {
+    checkAll(Arb.enum<LogLevel>()) { newLevel ->
+      FirebaseDataConnect.logging.level = newLevel
+      FirebaseDataConnect.logLevel shouldBe newLevel
+    }
+  }
+}