Add ml sdk version to logs. (#2368)

Author: annzimmer

firebase-ml-modeldownloader/src/main/java/com/google/firebase/ml/modeldownloader/internal/FirebaseMlLogEvent.java

@@ -100,6 +100,8 @@ public static Builder builder() {
 
     public abstract String getFirebaseProjectId();
 
+    public abstract String getMlSdkVersion();
+
     /** Builder for {@link SystemInfo}. */
     @AutoValue.Builder
     public abstract static class Builder {
@@ -115,6 +117,9 @@ public abstract static class Builder {
       @NonNull
       public abstract Builder setFirebaseProjectId(String value);
 
+      @NonNull
+      public abstract Builder setMlSdkVersion(String value);
+
       @NonNull
       public abstract SystemInfo build();
     }

firebase-ml-modeldownloader/src/main/java/com/google/firebase/ml/modeldownloader/internal/FirebaseMlLogger.java

@@ -23,6 +23,7 @@
 import androidx.annotation.WorkerThread;
 import com.google.android.datatransport.TransportFactory;
 import com.google.firebase.FirebaseApp;
+import com.google.firebase.ml.modeldownloader.BuildConfig;
 import com.google.firebase.ml.modeldownloader.CustomModel;
 import com.google.firebase.ml.modeldownloader.internal.FirebaseMlLogEvent.EventName;
 import com.google.firebase.ml.modeldownloader.internal.FirebaseMlLogEvent.ModelDownloadLogEvent;
@@ -223,6 +224,7 @@ private SystemInfo getSystemInfo() {
         .setAppId(appPackageName)
         .setAppVersion(appVersion)
         .setApiKey(apiKey)
+        .setMlSdkVersion(BuildConfig.VERSION_NAME)
         .build();
   }
 

firebase-ml-modeldownloader/src/test/java/com/google/firebase/ml/modeldownloader/internal/DataTransportMlEventSenderTest.java

@@ -42,6 +42,7 @@ public class DataTransportMlEventSenderTest {
           .setAppVersion("0.1.0")
           .setApiKey("fakeKey5645")
           .setFirebaseProjectId("FakeFirebaseId")
+          .setMlSdkVersion("3.4.5")
           .build();
 
   @Before

firebase-ml-modeldownloader/src/test/java/com/google/firebase/ml/modeldownloader/internal/FirebaseMlLogEventTest.java

@@ -17,6 +17,7 @@
 import static com.google.common.truth.extensions.proto.ProtoTruth.assertThat;
 import static com.google.firebase.ml.modeldownloader.internal.FirebaseMlLogEvent.FIREBASE_ML_JSON_ENCODER;
 
+import com.google.firebase.ml.modeldownloader.BuildConfig;
 import com.google.firebase.ml.modeldownloader.internal.FirebaseMlLogEvent.ModelDownloadLogEvent.DownloadStatus;
 import com.google.firebase.ml.modeldownloader.proto.ErrorCode;
 import com.google.firebase.ml.modeldownloader.proto.EventName;
@@ -57,6 +58,7 @@ public void testLogRequest_jsonToProto() throws InvalidProtocolBufferException {
                     .setAppVersion(APP_VERSION)
                     .setFirebaseProjectId(PROJECT_ID)
                     .setApiKey(API_KEY)
+                    .setMlSdkVersion(BuildConfig.VERSION_NAME)
                     .build())
             .setModelDownloadLogEvent(
                 com.google.firebase.ml.modeldownloader.internal.FirebaseMlLogEvent
@@ -91,6 +93,7 @@ public void testLogRequest_jsonToProto() throws InvalidProtocolBufferException {
             .setAppVersion(APP_VERSION)
             .setFirebaseProjectId(PROJECT_ID)
             .setApiKey(API_KEY)
+            .setMlSdkVersion(BuildConfig.VERSION_NAME)
             .build();
 
     ModelDownloadLogEvent modelDownloadLogEvent =

firebase-ml-modeldownloader/src/test/java/com/google/firebase/ml/modeldownloader/internal/FirebaseMlLoggerTest.java

@@ -30,6 +30,7 @@
 import com.google.firebase.FirebaseApp;
 import com.google.firebase.FirebaseOptions;
 import com.google.firebase.FirebaseOptions.Builder;
+import com.google.firebase.ml.modeldownloader.BuildConfig;
 import com.google.firebase.ml.modeldownloader.CustomModel;
 import com.google.firebase.ml.modeldownloader.FirebaseMlException;
 import com.google.firebase.ml.modeldownloader.internal.FirebaseMlLogEvent.EventName;
@@ -60,7 +61,7 @@ public class FirebaseMlLoggerTest {
           .setApiKey(API_KEY)
           .build();
 
-  private SystemInfo SYSTEM_INFO;
+  private SystemInfo systemInfo;
 
   private static final String MODEL_NAME = "MODEL_NAME_1";
   private static final String MODEL_HASH = "dsf324";
@@ -86,11 +87,12 @@ public void setUp() throws NameNotFoundException {
         FirebaseApp.initializeApp(ApplicationProvider.getApplicationContext(), FIREBASE_OPTIONS);
 
     mlLogger = new FirebaseMlLogger(app, mockSharedPreferencesUtil, mockStatsSender);
-    SYSTEM_INFO =
+    systemInfo =
         SystemInfo.builder()
             .setFirebaseProjectId(TEST_PROJECT_ID)
             .setAppId(app.getApplicationContext().getOpPackageName())
             .setApiKey(API_KEY)
+            .setMlSdkVersion(BuildConfig.VERSION_NAME)
             .setAppVersion(
                 String.valueOf(
                     app.getApplicationContext()
@@ -132,7 +134,7 @@ public void logDownloadFailureWithReason() {
                             .setDownloadStatus(DownloadStatus.FAILED)
                             .setDownloadFailureStatus(405)
                             .build())
-                    .setSystemInfo(SYSTEM_INFO)
+                    .setSystemInfo(systemInfo)
                     .build()));
     verify(mockSharedPreferencesUtil, timeout(1)).getModelDownloadCompleteTimeMs(any());
     verify(mockSharedPreferencesUtil, timeout(1)).getModelDownloadBeginTimeMs(any());
@@ -156,7 +158,7 @@ public void logDownloadFailureWithReason_getModelDownloadBeginTimeMsNull() {
                             .setDownloadStatus(DownloadStatus.FAILED)
                             .setDownloadFailureStatus(405)
                             .build())
-                    .setSystemInfo(SYSTEM_INFO)
+                    .setSystemInfo(systemInfo)
                     .build()));
     verify(mockSharedPreferencesUtil, timeout(1)).getModelDownloadBeginTimeMs(any());
     verify(mockSharedPreferencesUtil, times(1)).getCustomModelStatsCollectionFlag();
@@ -179,7 +181,7 @@ public void logDownloadEventWithExactDownloadTime() {
                             .setErrorCode(ErrorCode.NO_ERROR)
                             .setDownloadStatus(DownloadStatus.SUCCEEDED)
                             .build())
-                    .setSystemInfo(SYSTEM_INFO)
+                    .setSystemInfo(systemInfo)
                     .build()));
     verify(mockStatsSender, Mockito.times(1)).sendEvent(any());
     verify(mockSharedPreferencesUtil, timeout(1)).setModelDownloadCompleteTimeMs(any(), eq(2500L));
@@ -204,7 +206,7 @@ public void logDownloadEventWithExactDownloadTime_getModelDownloadBeginTimeMsNul
                             .setErrorCode(ErrorCode.NO_ERROR)
                             .setDownloadStatus(DownloadStatus.SUCCEEDED)
                             .build())
-                    .setSystemInfo(SYSTEM_INFO)
+                    .setSystemInfo(systemInfo)
                     .build()));
     verify(mockSharedPreferencesUtil, timeout(1)).getModelDownloadBeginTimeMs(any());
     verify(mockSharedPreferencesUtil, times(1)).getCustomModelStatsCollectionFlag();

firebase-ml-modeldownloader/src/test/proto/firebase/ml/modeldownloader/firebase_ml_log_sdk.proto

@@ -38,6 +38,10 @@ message SystemInfo {
   // a valid Firebase Project ID.
   string firebase_project_id = 3;
 
+  // Firebase ML SDK version. This is the library version of
+  // //java/com/google/android/gmscore/integ/client/firebase_ml/common/library.bzl
+  string ml_sdk_version = 4;
+
   // The API key of the firebase project.
   string api_key = 7 ;