Add open source build logic for Firestore Android

a-maurice · a-maurice · commit ecebfc58387e · 2020-03-11T18:07:37.000-07:00
Adds the gradle logic, adjusts the CMake dependencies, and adds resource file generation, for Android builds of Firestore. Remove Nullable annotation, since that is not present in all the versions of the Android SDK that the open source repo can support.

PiperOrigin-RevId: 300221250
diff --git a/Android/firebase_dependencies.gradle b/Android/firebase_dependencies.gradle
@@ -23,6 +23,7 @@ def firebaseDependenciesMap = [
   'auth' : ['com.google.firebase:firebase-auth:19.2.0'],
   'database' : ['com.google.firebase:firebase-database:19.2.1'],
   'dynamic_links' : ['com.google.firebase:firebase-dynamic-links:19.1.0'],
+  'firestore' : ['com.google.firebase:firebase-firestore:21.4.0'],
   'functions' : ['com.google.firebase:firebase-functions:19.0.2'],
   'instance_id' : ['com.google.firebase:firebase-iid:20.0.2'],
   'invites' : ['com.google.firebase:firebase-invites:17.0.0'],
@@ -42,6 +43,7 @@ def firebaseResourceDependenciesMap = [
   'admob' : [':admob:admob_resources'],
   'auth' : [':auth:auth_resources'],
   'database' : [':database:database_resources'],
+  'firestore' : [':firestore:firestore_resources'],
   'storage' : [':storage:storage_resources']
 ]
 
@@ -74,6 +76,9 @@ class Dependencies {
   def getDynamicLinks() {
     libSet.add('dynamic_links')
   }
+  def getFirestore() {
+    libSet.add('firestore')
+  }
   def getFunctions() {
     libSet.add('functions')
   }
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -120,27 +120,29 @@ if(FIREBASE_CPP_USE_PRIOR_GRADLE_BUILD)
     "${CMAKE_CURRENT_LIST_DIR}/[^/]+/(.*)"
     "${CMAKE_CURRENT_LIST_DIR}/app/\\1"
     APP_BINARY_DIR "${FIREBASE_BINARY_DIR}")
+
+  set(FIRESTORE_SOURCE_DIR ${APP_BINARY_DIR}/external/src/firestore)
 else()
   # Run the CMake build logic that will download all the external dependencies.
   message(STATUS "Downloading external project dependencies...")
   download_external_sources()
   message(STATUS "Download complete.")
+endif()
 
-  # Include Firestore's external build early to resolve conflicts on packages.
-  if(FIREBASE_INCLUDE_FIRESTORE)
-    set(FIRESTORE_SOURCE_DIR ${FIREBASE_BINARY_DIR}/external/src/firestore)
-    set(FIRESTORE_BINARY_DIR ${FIRESTORE_SOURCE_DIR}-build)
+# Include Firestore's external build early to resolve conflicts on packages.
+if(NOT ANDROID AND FIREBASE_INCLUDE_FIRESTORE)
+  set(FIRESTORE_SOURCE_DIR ${FIREBASE_BINARY_DIR}/external/src/firestore)
+  set(FIRESTORE_BINARY_DIR ${FIRESTORE_SOURCE_DIR}-build)
 
-    set(
-      FIREBASE_IOS_BUILD_TESTS
-      ${FIREBASE_CPP_BUILD_TESTS}
-      CACHE BOOL "Force Firestore build tests to match"
-    )
+  set(
+    FIREBASE_IOS_BUILD_TESTS
+    ${FIREBASE_CPP_BUILD_TESTS}
+    CACHE BOOL "Force Firestore build tests to match"
+  )
 
-    add_subdirectory(${FIRESTORE_SOURCE_DIR} ${FIRESTORE_BINARY_DIR})
+  add_subdirectory(${FIRESTORE_SOURCE_DIR} ${FIRESTORE_BINARY_DIR})
 
-    copy_subdirectory_definition(${FIRESTORE_SOURCE_DIR} NANOPB_SOURCE_DIR)
-  endif()
+  copy_subdirectory_definition(${FIRESTORE_SOURCE_DIR} NANOPB_SOURCE_DIR)
 endif()
 
 # Disable the Flatbuffer build tests, install and flathash
@@ -252,28 +254,29 @@ if (NOT ANDROID AND NOT IOS)
   endif()
 endif()
 
-if(FIREBASE_INCLUDE_FIRESTORE)
-  # The Firestore build includes protobuf and nanopb already
-  list(APPEND CMAKE_MODULE_PATH ${NANOPB_SOURCE_DIR}/extra)
-  find_package(Nanopb REQUIRED)
-
-  set(PROTOBUF_FOUND ON)
-
-else()
-  find_package(Protobuf)
-  if (PROTOBUF_FOUND)
-    # NanoPB requires Protobuf to be present, so only add it if it was found.
-    add_external_library(nanopb)
-
-    # NanoPB has a FindNanopb which defines the function to generate files, so
-    # add it to the module path, and use that.
+if(NOT ANDROID)
+  if(FIREBASE_INCLUDE_FIRESTORE)
+    # The Firestore build includes protobuf and nanopb already
     list(APPEND CMAKE_MODULE_PATH ${NANOPB_SOURCE_DIR}/extra)
-    find_package(Nanopb)
+    find_package(Nanopb REQUIRED)
 
-    target_compile_definitions(
-      protobuf-nanopb-static
-      PUBLIC -DPB_FIELD_32BIT -DPB_ENABLE_MALLOC
-    )
+    set(PROTOBUF_FOUND ON)
+  else()
+    find_package(Protobuf)
+    if (PROTOBUF_FOUND)
+      # NanoPB requires Protobuf to be present, so only add it if it was found.
+      add_external_library(nanopb)
+
+      # NanoPB has a FindNanopb which defines the function to generate files,
+      # so add it to the module path, and use that.
+      list(APPEND CMAKE_MODULE_PATH ${NANOPB_SOURCE_DIR}/extra)
+      find_package(Nanopb)
+
+      target_compile_definitions(
+        protobuf-nanopb-static
+        PUBLIC -DPB_FIELD_32BIT -DPB_ENABLE_MALLOC
+      )
+    endif()
   endif()
 endif()
 
diff --git a/cmake/external_rules.cmake b/cmake/external_rules.cmake
@@ -51,7 +51,7 @@ function(download_external_sources)
       WORKING_DIRECTORY ${FIRESTORE_BINARY_DIR}
     )
 
-    set(NANOPB_SRC_DIR ${FIRESTORE_BINARY_DIR}/external/src/nanopb)
+    set(NANOPB_SOURCE_DIR ${FIRESTORE_BINARY_DIR}/external/src/nanopb)
   endif()
 
   # Set variables to indicate if local versions of third party libraries should
diff --git a/firestore/CMakeLists.txt b/firestore/CMakeLists.txt
@@ -44,7 +44,16 @@ set(common_SRCS
     src/common/write_batch.cc
     ${settings_apple_SRCS})
 
+# Define the resource build needed for Android
+firebase_cpp_gradle(":firestore:firestore_resources:generateDexJarRelease"
+    "${CMAKE_CURRENT_LIST_DIR}/firestore_resources/build/dexed.jar")
+binary_to_array("firestore_resources"
+    "${CMAKE_CURRENT_LIST_DIR}/firestore_resources/build/dexed.jar"
+    "firebase_firestore"
+    "${FIREBASE_GEN_FILE_DIR}/firestore")
+
 set(android_SRCS
+    ${firestore_resources_source}
     src/android/blob_android.cc
     src/android/blob_android.h
     src/android/collection_reference_android.cc
@@ -164,16 +173,21 @@ add_library(firebase_firestore STATIC
 
 set_property(TARGET firebase_firestore PROPERTY FOLDER "Firebase Cpp")
 
+if(NOT ANDROID)
+  set(firestore_api_dep firebase_firestore_api)
+else()
+  set(firestore_api_dep)
+endif()
+
 # Set up the dependency on Firebase App.
 target_link_libraries(firebase_firestore
   PUBLIC
     firebase_app
     firebase_auth
   PRIVATE
-    firebase_firestore_api
+    ${firestore_api_dep}
 )
 
-
 # Public headers all refer to each other relative to the src/include directory,
 # while private headers are relative to the entire C++ SDK directory.
 target_include_directories(firebase_firestore
@@ -183,6 +197,10 @@ target_include_directories(firebase_firestore
   PRIVATE
     ${FIREBASE_CPP_SDK_ROOT_DIR}
 )
+target_compile_definitions(firebase_firestore
+  PRIVATE
+    -DINTERNAL_EXPERIMENTAL=1
+)
 
 if(ANDROID)
   firebase_cpp_proguard_file(firestore)
diff --git a/firestore/build.gradle b/firestore/build.gradle
@@ -0,0 +1,88 @@
+// Copyright 2020 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.
+
+buildscript {
+  repositories {
+    google()
+    jcenter()
+  }
+  dependencies {
+    classpath 'com.android.tools.build:gradle:3.2.1'
+  }
+}
+allprojects {
+  repositories {
+    google()
+    jcenter()
+  }
+}
+
+apply plugin: 'com.android.library'
+
+android {
+  compileSdkVersion 28
+  buildToolsVersion '28.0.3'
+
+  sourceSets {
+    main {
+      manifest.srcFile '../android_build_files/AndroidManifest.xml'
+    }
+  }
+
+  externalNativeBuild {
+    cmake {
+      path '../CMakeLists.txt'
+    }
+  }
+
+  defaultConfig {
+    // Jelly Bean is the minimum supported version needed by Firebase.
+    minSdkVersion 16
+    targetSdkVersion 28
+    versionCode 1
+    versionName "1.0"
+
+    buildTypes {
+      release {
+        minifyEnabled false
+      }
+    }
+
+    externalNativeBuild {
+      cmake {
+        targets 'firebase_firestore'
+        // Args are: Re-use app library prebuilt by app gradle project.
+        //           Don't configure all the cmake subprojects.
+        //           Only include needed project.
+        arguments '-DFIREBASE_CPP_USE_PRIOR_GRADLE_BUILD=ON',
+                '-DFIREBASE_INCLUDE_LIBRARY_DEFAULT=OFF',
+                '-DFIREBASE_INCLUDE_FIRESTORE=ON'
+      }
+    }
+  }
+
+  lintOptions {
+    abortOnError false
+  }
+}
+
+dependencies {
+  implementation project(':app')
+}
+apply from: "$rootDir/android_build_files/extract_and_dex.gradle"
+apply from: "$rootDir/android_build_files/generate_proguard.gradle"
+project.afterEvaluate {
+  generateProguardFile('firestore')
+  setupDexDependencies(':firestore:firestore_resources')
+}
diff --git a/firestore/firestore_resources/build.gradle b/firestore/firestore_resources/build.gradle
@@ -0,0 +1,58 @@
+// Copyright 2020 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.
+
+buildscript {
+  repositories {
+    google()
+    jcenter()
+  }
+  dependencies {
+    classpath 'com.android.tools.build:gradle:3.2.1'
+    classpath 'com.google.gms:google-services:4.2.0'
+  }
+}
+allprojects {
+  repositories {
+    google()
+    jcenter()
+  }
+}
+
+apply plugin: 'com.android.library'
+
+android {
+  compileSdkVersion 28
+
+  sourceSets {
+    main {
+      manifest.srcFile '../../android_build_files/AndroidManifest.xml'
+      java {
+        srcDirs = ['../src_java/com/google/firebase/firestore/internal/cpp']
+        exclude 'Dummy.java'
+      }
+    }
+  }
+}
+
+dependencies {
+  implementation 'com.google.firebase:firebase-analytics:17.2.2'
+  implementation 'com.google.firebase:firebase-firestore:21.4.1'
+}
+
+afterEvaluate {
+  generateReleaseBuildConfig.enabled = false
+}
+
+apply from: "$rootDir/android_build_files/extract_and_dex.gradle"
+extractAndDexAarFile('firestore_resources')
diff --git a/settings.gradle b/settings.gradle
@@ -11,6 +11,8 @@ include ':app',
         ':database',
         ':database:database_resources',
         ':dynamic_links',
+        ':firestore',
+        ':firestore:firestore_resources',
         ':functions',
         ':instance_id',
         ':messaging',

Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ function(download_external_sources)`
`51`	`51`	`WORKING_DIRECTORY ${FIRESTORE_BINARY_DIR}`
`52`	`52`	`)`
`53`	`53`
`54`		`- set(NANOPB_SRC_DIR ${FIRESTORE_BINARY_DIR}/external/src/nanopb)`
	`54`	`+ set(NANOPB_SOURCE_DIR ${FIRESTORE_BINARY_DIR}/external/src/nanopb)`
`55`	`55`	`endif()`
`56`	`56`
`57`	`57`	`# Set variables to indicate if local versions of third party libraries should`