Merge branch 'main' into daymon-sharedpreferences-work

Author: daymxn

.github/workflows/dataconnect.yml

@@ -64,15 +64,16 @@ jobs:
         with:
           node-version: ${{ env.FDC_NODEJS_VERSION }}
 
-      - name: install firebase-tools
+      - name: Install Firebase Tools ("firebase" command-line tool)
         run: |
+          set -euo pipefail
           set -v
           mkdir -p ${{ env.FDC_FIREBASE_TOOLS_DIR }}
           cd ${{ env.FDC_FIREBASE_TOOLS_DIR }}
           echo '{}' > package.json
           npm install --fund=false --audit=false --save --save-exact firebase-tools@${{ env.FDC_FIREBASE_TOOLS_VERSION }}
 
-      - name: Restore Gradle cache
+      - name: Restore Gradle Cache
         id: restore-gradle-cache
         uses: actions/cache/restore@d4323d4df104b026a6aa633fdb11d772146be0bf # 4.2.2
         if: github.event_name != 'schedule'
@@ -84,9 +85,11 @@ jobs:
           restore-keys: |
             gradle-cache-jqnvfzw6w7-
 
-      - name: tool versions
+      - name: Print Command-Line Tool Versions
         continue-on-error: true
         run: |
+          set -euo pipefail
+
           function run_cmd {
             echo "==============================================================================="
             echo "Running Command: $*"
@@ -105,6 +108,7 @@ jobs:
 
       - name: Gradle assembleDebugAndroidTest
         run: |
+          set -euo pipefail
           set -v
 
           # Speed up build times and also avoid configuring firebase-crashlytics-ndk
@@ -117,23 +121,24 @@ jobs:
             ${{ (inputs.gradleInfoLog && '--info') || '' }} \
             :firebase-dataconnect:assembleDebugAndroidTest
 
-      - name: Save Gradle cache
+      - name: Save Gradle Cache
         uses: actions/cache/save@d4323d4df104b026a6aa633fdb11d772146be0bf # 4.2.2
         if: github.event_name == 'schedule'
         with:
           path: |
             ~/.gradle/caches
             ~/.gradle/wrapper
-          key: ${{ steps.restore-gradle-cache.outputs.cache-primary-key }}
+          key: gradle-cache-jqnvfzw6w7-${{ github.run_id }}
 
-      - name: Enable KVM group permissions for Android Emulator
+      - name: Enable KVM Group Permissions for Android Emulator
         run: |
+          set -euo pipefail
           echo 'KERNEL=="kvm", GROUP="kvm", MODE="0666", OPTIONS+="static_node=kvm"' \
             | sudo tee /etc/udev/rules.d/99-kvm4all.rules
           sudo udevadm control --reload-rules
           sudo udevadm trigger --name-match=kvm
 
-      - name: Restore AVD cache
+      - name: Restore AVD Cache
         uses: actions/cache/restore@d4323d4df104b026a6aa633fdb11d772146be0bf # 4.2.2
         if: github.event_name != 'schedule'
         id: restore-avd-cache
@@ -146,28 +151,30 @@ jobs:
             avd-cache-zhdsn586je-api${{ env.FDC_ANDROID_EMULATOR_API_LEVEL }}-
 
       - name: Create AVD
-        if: github.event_name == 'schedule' || steps.restore-avd-cache.outputs.cache-hit != 'true'
+        if: github.event_name == 'schedule' || steps.restore-avd-cache.outputs.cache-matched-key == ''
         uses: reactivecircus/android-emulator-runner@62dbb605bba737720e10b196cb4220d374026a6d #v2.33.0
         with:
           api-level: ${{ env.FDC_ANDROID_EMULATOR_API_LEVEL }}
           arch: x86_64
           force-avd-creation: false
           emulator-options: -no-window -gpu swiftshader_indirect -noaudio -no-boot-anim -camera-back none
           disable-animations: true
-          script: echo "Generated AVD snapshot for caching."
+          script: 'echo "Generated AVD snapshot for caching; event_name=${{ github.event_name }}, cache-matched-key=${{ steps.restore-avd-cache.outputs.cache-matched-key }}"'
 
-      - name: Save AVD cache
+      - name: Save AVD Cache
         uses: actions/cache/save@d4323d4df104b026a6aa633fdb11d772146be0bf # 4.2.2
         if: github.event_name == 'schedule'
         with:
           path: |
             ~/.android/avd/*
             ~/.android/adb*
-          key: ${{ steps.restore-avd-cache.outputs.cache-primary-key }}
+          key: avd-cache-zhdsn586je-api${{ env.FDC_ANDROID_EMULATOR_API_LEVEL }}-${{ github.run_id }}
 
-      - name: Data Connect Emulator
+      - name: Data Connect Emulator Start
+        id: data-connect-emulator
         run: |
-          set -x
+          set -euo pipefail
+          set -xv
 
           echo 'emulator.postgresConnectionUrl=postgresql://postgres:[email protected]:5432?sslmode=disable' > firebase-dataconnect/dataconnect.local.properties
 
@@ -176,14 +183,29 @@ jobs:
             :firebase-dataconnect:connectors:runDebugDataConnectEmulator \
             >firebase.emulator.dataconnect.log 2>&1 &
 
-      - name: Firebase Auth Emulator
+          echo "FIREBASE_DATA_CONNECT_EMULATOR_PID=$!" >> "$GITHUB_ENV"
+
+      - name: Firebase Auth Emulator Start
+        id: firebase-auth-emulator
         run: |
-          set -x
+          set -euo pipefail
+          set -xv
+
           cd firebase-dataconnect/emulator
           ${{ env.FDC_FIREBASE_COMMAND }} emulators:start --only=auth >firebase.emulator.auth.log 2>&1 &
 
-      - name: Capture Logcat Logs
-        run: adb logcat >logcat.log &
+          echo "FIREBASE_AUTH_EMULATOR_PID=$!" >> "$GITHUB_ENV"
+
+      - name: Logcat Log Capture Start
+        id: logcat-capture
+        continue-on-error: true
+        run: |
+          set -euo pipefail
+          set -xv
+
+          "$ANDROID_HOME/platform-tools/adb" logcat >logcat.log 2>&1 &
+
+          echo "LOGCAT_PID=$!" >> "$GITHUB_ENV"
 
       - name: Gradle connectedCheck
         id: connectedCheck
@@ -201,25 +223,26 @@ jobs:
           script: |
             set -eux && ./gradlew ${{ (inputs.gradleInfoLog && '--info') || '' }} :firebase-dataconnect:connectedCheck :firebase-dataconnect:connectors:connectedCheck
 
-      - name: Upload log file artifacts
+      - name: Upload Log Files
         uses: actions/upload-artifact@4cec3d8aa04e39d1a68397de0c4cd6fb9dce8ec1 # v4.6.1
         with:
           name: integration_test_logs
           path: "**/*.log"
           if-no-files-found: warn
           compression-level: 9
 
-      - name: Upload Gradle build report artifacts
+      - name: Upload Gradle Build Reports
         uses: actions/upload-artifact@4cec3d8aa04e39d1a68397de0c4cd6fb9dce8ec1 # v4.6.1
         with:
           name: integration_test_gradle_build_reports
           path: firebase-dataconnect/**/build/reports/
           if-no-files-found: warn
           compression-level: 9
 
-      - name: Verify "Gradle connectedCheck" step was successful
+      - name: Verify "Gradle connectedCheck" Step Was Successful
         if: steps.connectedCheck.outcome != 'success'
         run: |
+          set -euo pipefail
           echo 'Failing because the outcome of the "Gradle connectedCheck" step ("${{ steps.connectedCheck.outcome }}") was not successful'
           exit 1
 
@@ -236,3 +259,27 @@ jobs:
       - uses: docker://rhysd/actionlint:1.7.7
         with:
           args: -color /github/workspace/.github/workflows/dataconnect.yml
+
+  send-notifications:
+    needs: [integration-test, actionlint-dataconnect-yml]
+    if: always()
+    permissions:
+      issues: write
+    runs-on: ubuntu-latest
+    steps:
+      - name: Post Comment on Issue #6857
+        if: github.event_name == 'schedule'
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          set -euo pipefail
+
+          cat >message.txt <<EOF
+          Result of workflow ${{ github.workflow }} at ${{ github.ref }}: ${{ job.status }}
+          ${{ github.event.repository.html_url }}/actions/runs/${{ github.run_id }}
+          job=${{ github.job }} run_id=${{ github.run_id }} run_number=${{ github.run_number }} run_attempt=${{ github.run_attempt }}
+          EOF
+
+          echo "Posting comment on GitHub Issue: https://github.com/firebase/firebase-android-sdk/issues/6857:"
+          cat message.txt
+          gh issue comment 6857 --body-file message.txt -R ${{ github.repository }}

.github/workflows/fireci.yml

@@ -24,4 +24,4 @@ jobs:
       - run: |
           pytest ci/fireci
       - run: |
-          mypy --config-file ci/fireci/setup.cfg ci/fireci/
+          mypy --config-file ci/fireci/pyproject.toml ci/fireci/

ci/fireci/pyproject.toml

@@ -1,3 +1,44 @@
 [build-system]
-requires = ["setuptools ~= 58.0"]
+requires = ["setuptools ~= 70.0"]
 build-backend = "setuptools.build_meta"
+
+[project]
+name = "fireci"
+version = "0.1"
+dependencies = [
+  "protobuf==3.20.3",
+  "click==8.1.7",
+  "google-cloud-storage==2.18.2",
+  "mypy==1.6.0",
+  "numpy==1.24.4",
+  "pandas==1.5.3",
+  "PyGithub==1.58.2",
+  "pystache==0.6.0",
+  "requests==2.31.0",
+  "seaborn==0.12.2",
+  "PyYAML==6.0.1",
+  "termcolor==2.4.0",
+  "pytest"
+]
+
+[project.scripts]
+fireci = "fireci.main:cli"
+
+[tool.setuptools]
+packages = ["fireci", "fireciplugins"]
+
+[tool.mypy]
+strict_optional = false
+
+[[tool.mypy.overrides]]
+  module = [
+	"google.cloud",
+	"matplotlib",
+	"matplotlib.pyplot",
+	"pandas",
+	"pystache",
+	"requests",
+	"seaborn",
+	"yaml"
+  ]
+  ignore_missing_imports = true

ci/fireci/setup.cfg

@@ -15,7 +15,12 @@
 # limitations under the License.
 
 set -e
+set -x
 
 DIRECTORY=$(cd `dirname $0` && pwd)
-pip3 install -e $DIRECTORY/fireci >> /dev/null
+python3 -m ensurepip --upgrade
+python3 -m pip install --upgrade setuptools
+python3 -m pip install --upgrade pip
+python3 -m pip install --upgrade wheel
+python3 -m pip install -e $DIRECTORY/fireci >> /dev/null
 fireci $@

ci/run.sh

@@ -190,7 +190,7 @@ data class ProtoField(
 
   val lowerCamelCaseName: String
     get() {
-      return SNAKE_CASE_REGEX.replace(name) { it.value.replace("_", "").toUpperCase() }
+      return SNAKE_CASE_REGEX.replace(name) { it.value.replace("_", "").uppercase() }
     }
 
   val camelCaseName: String

encoders/protoc-gen-firebase-encoders/src/main/kotlin/com/google/firebase/encoders/proto/codegen/Types.kt

@@ -1,5 +1,6 @@
 # Unreleased
-
+[fixed] Fixed an issue where the connection to the real-time Remote Config backend could remain
+open in the background.
 
 # 22.1.0
 * [feature] Added support for custom signal targeting in Remote Config. Use `setCustomSignals` API for setting custom signals and use them to build custom targeting conditions in Remote Config.

firebase-config/CHANGELOG.md

@@ -54,6 +54,7 @@ public class ConfigAutoFetch {
   private final ConfigUpdateListener retryCallback;
   private final ScheduledExecutorService scheduledExecutorService;
   private final Random random;
+  private boolean isInBackground;
 
   public ConfigAutoFetch(
       HttpURLConnection httpURLConnection,
@@ -69,6 +70,7 @@ public ConfigAutoFetch(
     this.retryCallback = retryCallback;
     this.scheduledExecutorService = scheduledExecutorService;
     this.random = new Random();
+    this.isInBackground = false;
   }
 
   private synchronized void propagateErrors(FirebaseRemoteConfigException exception) {
@@ -87,6 +89,10 @@ private synchronized boolean isEventListenersEmpty() {
     return this.eventListeners.isEmpty();
   }
 
+  public void setIsInBackground(boolean isInBackground) {
+    this.isInBackground = isInBackground;
+  }
+
   private String parseAndValidateConfigUpdateMessage(String message) {
     int left = message.indexOf('{');
     int right = message.lastIndexOf('}');
@@ -105,15 +111,29 @@ public void listenForNotifications() {
       return;
     }
 
+    // Maintain a reference to the InputStream to guarantee its closure upon completion or in case
+    // of an exception.
+    InputStream inputStream = null;
     try {
-      InputStream inputStream = httpURLConnection.getInputStream();
+      inputStream = httpURLConnection.getInputStream();
       handleNotifications(inputStream);
-      inputStream.close();
     } catch (IOException ex) {
-      // Stream was interrupted due to a transient issue and the system will retry the connection.
-      Log.d(TAG, "Stream was cancelled due to an exception. Retrying the connection...", ex);
+      // If the real-time connection is at an unexpected lifecycle state when the app is
+      // backgrounded, it's expected closing the httpURLConnection will throw an exception.
+      if (!isInBackground) {
+        // Otherwise, the real-time server connection was closed due to a transient issue.
+        Log.d(TAG, "Real-time connection was closed due to an exception.", ex);
+      }
     } finally {
-      httpURLConnection.disconnect();
+      if (inputStream != null) {
+        try {
+          // Only need to close the InputStream, ConfigRealtimeHttpClient will disconnect
+          // HttpUrlConnection
+          inputStream.close();
+        } catch (IOException ex) {
+          Log.d(TAG, "Exception thrown when closing connection stream. Retrying connection...", ex);
+        }
+      }
     }
   }
 
@@ -186,7 +206,6 @@ private void handleNotifications(InputStream inputStream) throws IOException {
     }
 
     reader.close();
-    inputStream.close();
   }
 
   private void autoFetch(int remainingAttempts, long targetVersion) {