Attempt to have nested class for realtime pipeline

Author: wu-hui

.github/workflows/firestore_ci_tests.yml

@@ -250,11 +250,85 @@ jobs:
           retention-days: 7
           if-no-files-found: ignore
 
+  firestore_emulator_integ_tests:
+    name: "System Tests Against Emulator"
+    runs-on: ubuntu-latest
+    needs:
+      - determine_changed
+    # only run on post submit or PRs not originating from forks.
+    if: ((github.repository == 'Firebase/firebase-android-sdk' && github.event_name == 'push') || (github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository)) && contains(fromJSON(needs.determine_changed.outputs.modules), ':firebase-firestore')
+    strategy:
+      fail-fast: false
+
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          fetch-depth: 2
+          submodules: true
+
+      - name: Enable KVM
+        run: |
+          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: Add google-services.json
+        env:
+          INTEG_TESTS_GOOGLE_SERVICES: ${{ secrets.INTEG_TESTS_GOOGLE_SERVICES }}
+        run: |
+          echo $INTEG_TESTS_GOOGLE_SERVICES | base64 -d > firebase-firestore/google-services.json    
+
+      - name: Set up JDK 21
+        uses: actions/setup-java@3a4f6e1af504cf6a31855fa899c6aa5355ba6c12 # v4.7.0
+        with:
+          java-version: 21
+          distribution: temurin
+          cache: gradle
+
+      - uses: google-github-actions/setup-gcloud@77e7a554d41e2ee56fc945c52dfd3f33d12def9a # v2.1.4
+
+      - name: Start Emulator
+        env:
+          EXPERIMENTAL_MODE: true
+        run: |
+          gcloud emulators firestore start --host-port=127.0.0.1:8080 --quiet &
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@3a4f6e1af504cf6a31855fa899c6aa5355ba6c12 # v4.7.0
+        with:
+          java-version: 17
+          distribution: temurin
+          cache: gradle
+
+      - name: Firestore Emulator Integ Tests
+        uses: reactivecircus/android-emulator-runner@62dbb605bba737720e10b196cb4220d374026a6d #v2.33.0
+        env:
+          FIREBASE_CI: 1
+          FTL_RESULTS_BUCKET: android-ci
+          FTL_RESULTS_DIR: ${{ github.event_name == 'pull_request' && format('pr-logs/pull/{0}/{1}/{2}/{3}_{4}/artifacts/', github.repository, github.event.pull_request.number, github.job, github.run_id, github.run_attempt) || format('logs/{0}/{1}_{2}/artifacts/', github.workflow, github.run_id, github.run_attempt)}}
+          FIREBASE_APP_CHECK_DEBUG_SECRET: ${{ secrets.FIREBASE_APP_CHECK_DEBUG_SECRET }}
+        with:
+          api-level: 31
+          arch: x86_64
+          ram-size: 4096M
+          heap-size: 4096M
+          script: |
+            adb logcat -v time > logcat.txt &
+            ./gradlew firebase-firestore:connectedCheck withErrorProne -PtargetBackend="emulator"
+      - name: Upload logs
+        if: failure()
+        uses: actions/upload-artifact@4cec3d8aa04e39d1a68397de0c4cd6fb9dce8ec1 # v4.6.1
+        with:
+          name: emulator-logcat.txt
+          path: logcat.txt
+          retention-days: 7
+          if-no-files-found: ignore
+
   check-required-tests:
     runs-on: ubuntu-latest
     if: always()
     name: Check all required Firestore tests results
-    needs: [integ_tests, named_integ_tests]
+    needs: [firestore_emulator_integ_tests]
     steps:
       - name: Check test matrix
         if: needs.integ_tests.result == 'failure' || needs.named_integ_tests.result == 'failure'

firebase-firestore/api.txt

@@ -489,42 +489,6 @@ package com.google.firebase.firestore {
     property public final com.google.firebase.Timestamp? updateTime;
   }
 
-  public final class PipelineResultChange {
-    method public com.google.firebase.firestore.PipelineResult component1();
-    method public com.google.firebase.firestore.PipelineResultChange.ChangeType component2();
-    method public Integer? component3();
-    method public Integer? component4();
-    method public com.google.firebase.firestore.PipelineResultChange copy(com.google.firebase.firestore.PipelineResult result, com.google.firebase.firestore.PipelineResultChange.ChangeType type, Integer? oldIndex, Integer? newIndex);
-    method public Integer? getNewIndex();
-    method public Integer? getOldIndex();
-    method public com.google.firebase.firestore.PipelineResult getResult();
-    method public com.google.firebase.firestore.PipelineResultChange.ChangeType getType();
-    property public final Integer? newIndex;
-    property public final Integer? oldIndex;
-    property public final com.google.firebase.firestore.PipelineResult result;
-    property public final com.google.firebase.firestore.PipelineResultChange.ChangeType type;
-    field public static final com.google.firebase.firestore.PipelineResultChange.Companion Companion;
-  }
-
-  public enum PipelineResultChange.ChangeType {
-    enum_constant public static final com.google.firebase.firestore.PipelineResultChange.ChangeType ADDED;
-    enum_constant public static final com.google.firebase.firestore.PipelineResultChange.ChangeType MODIFIED;
-    enum_constant public static final com.google.firebase.firestore.PipelineResultChange.ChangeType REMOVED;
-  }
-
-  public static final class PipelineResultChange.Companion {
-  }
-
-  public final class PipelineSnapshotMetadata {
-    method public boolean component1();
-    method public boolean component2();
-    method public com.google.firebase.firestore.PipelineSnapshotMetadata copy(boolean hasPendingWrites, boolean isConsistentBetweenListeners);
-    method public boolean getHasPendingWrites();
-    method public boolean isConsistentBetweenListeners();
-    property public final boolean hasPendingWrites;
-    property public final boolean isConsistentBetweenListeners;
-  }
-
   public final class PipelineSource {
     method public com.google.firebase.firestore.Pipeline collection(com.google.firebase.firestore.CollectionReference ref);
     method public com.google.firebase.firestore.Pipeline collection(com.google.firebase.firestore.CollectionReference ref, com.google.firebase.firestore.pipeline.CollectionSourceOptions options);
@@ -614,37 +578,73 @@ package com.google.firebase.firestore {
   }
 
   public final class RealtimePipeline {
-    method public com.google.firebase.firestore.ListenerRegistration addSnapshotListener(com.google.firebase.firestore.EventListener<com.google.firebase.firestore.RealtimePipelineSnapshot> listener);
-    method public com.google.firebase.firestore.ListenerRegistration addSnapshotListener(com.google.firebase.firestore.RealtimePipelineOptions options, com.google.firebase.firestore.EventListener<com.google.firebase.firestore.RealtimePipelineSnapshot> listener);
-    method public com.google.firebase.firestore.ListenerRegistration addSnapshotListener(java.util.concurrent.Executor executor, com.google.firebase.firestore.EventListener<com.google.firebase.firestore.RealtimePipelineSnapshot> listener);
-    method public com.google.firebase.firestore.ListenerRegistration addSnapshotListener(java.util.concurrent.Executor executor, com.google.firebase.firestore.RealtimePipelineOptions options, com.google.firebase.firestore.EventListener<com.google.firebase.firestore.RealtimePipelineSnapshot> listener);
+    method public com.google.firebase.firestore.ListenerRegistration addSnapshotListener(com.google.firebase.firestore.EventListener<com.google.firebase.firestore.RealtimePipeline.Snapshot> listener);
+    method public com.google.firebase.firestore.ListenerRegistration addSnapshotListener(com.google.firebase.firestore.RealtimePipeline.ListenOptions options, com.google.firebase.firestore.EventListener<com.google.firebase.firestore.RealtimePipeline.Snapshot> listener);
+    method public com.google.firebase.firestore.ListenerRegistration addSnapshotListener(java.util.concurrent.Executor executor, com.google.firebase.firestore.EventListener<com.google.firebase.firestore.RealtimePipeline.Snapshot> listener);
+    method public com.google.firebase.firestore.ListenerRegistration addSnapshotListener(java.util.concurrent.Executor executor, com.google.firebase.firestore.RealtimePipeline.ListenOptions options, com.google.firebase.firestore.EventListener<com.google.firebase.firestore.RealtimePipeline.Snapshot> listener);
     method public com.google.firebase.firestore.RealtimePipeline limit(int limit);
-    method public kotlinx.coroutines.flow.Flow<com.google.firebase.firestore.RealtimePipelineSnapshot> snapshots();
-    method public kotlinx.coroutines.flow.Flow<com.google.firebase.firestore.RealtimePipelineSnapshot> snapshots(com.google.firebase.firestore.RealtimePipelineOptions options);
+    method public kotlinx.coroutines.flow.Flow<com.google.firebase.firestore.RealtimePipeline.Snapshot> snapshots();
+    method public kotlinx.coroutines.flow.Flow<com.google.firebase.firestore.RealtimePipeline.Snapshot> snapshots(com.google.firebase.firestore.RealtimePipeline.ListenOptions options);
     method public com.google.firebase.firestore.RealtimePipeline sort(com.google.firebase.firestore.pipeline.Ordering order, com.google.firebase.firestore.pipeline.Ordering... additionalOrders);
     method public com.google.firebase.firestore.RealtimePipeline where(com.google.firebase.firestore.pipeline.BooleanExpression condition);
   }
 
-  public final class RealtimePipelineOptions {
-    ctor public RealtimePipelineOptions();
-    method public com.google.firebase.firestore.RealtimePipelineOptions withMetadataChanges(com.google.firebase.firestore.MetadataChanges metadataChanges);
-    method public com.google.firebase.firestore.RealtimePipelineOptions withServerTimestampBehavior(com.google.firebase.firestore.DocumentSnapshot.ServerTimestampBehavior serverTimestampBehavior);
-    method public com.google.firebase.firestore.RealtimePipelineOptions withSource(com.google.firebase.firestore.ListenSource source);
-    field public static final com.google.firebase.firestore.RealtimePipelineOptions.Companion Companion;
-    field public static final com.google.firebase.firestore.RealtimePipelineOptions DEFAULT;
+  public static final class RealtimePipeline.ListenOptions {
+    ctor public RealtimePipeline.ListenOptions();
+    method public com.google.firebase.firestore.RealtimePipeline.ListenOptions withMetadataChanges(com.google.firebase.firestore.MetadataChanges metadataChanges);
+    method public com.google.firebase.firestore.RealtimePipeline.ListenOptions withServerTimestampBehavior(com.google.firebase.firestore.DocumentSnapshot.ServerTimestampBehavior serverTimestampBehavior);
+    method public com.google.firebase.firestore.RealtimePipeline.ListenOptions withSource(com.google.firebase.firestore.ListenSource source);
+    field public static final com.google.firebase.firestore.RealtimePipeline.ListenOptions.Companion Companion;
+    field public static final com.google.firebase.firestore.RealtimePipeline.ListenOptions DEFAULT;
   }
 
-  public static final class RealtimePipelineOptions.Companion {
+  public static final class RealtimePipeline.ListenOptions.Companion {
   }
 
-  public final class RealtimePipelineSnapshot {
-    method public java.util.List<com.google.firebase.firestore.PipelineResultChange> getChanges(com.google.firebase.firestore.MetadataChanges? metadataChanges = null);
-    method public com.google.firebase.firestore.PipelineSnapshotMetadata getMetadata();
+  public static final class RealtimePipeline.Snapshot {
+    method public java.util.List<com.google.firebase.firestore.RealtimePipeline.Snapshot.ResultChange> getChanges(com.google.firebase.firestore.MetadataChanges? metadataChanges = null);
+    method public com.google.firebase.firestore.RealtimePipeline.Snapshot.SnapshotMetadata getMetadata();
     method public java.util.List<com.google.firebase.firestore.PipelineResult> getResults();
-    property public final com.google.firebase.firestore.PipelineSnapshotMetadata metadata;
+    property public final com.google.firebase.firestore.RealtimePipeline.Snapshot.SnapshotMetadata metadata;
     property public final java.util.List<com.google.firebase.firestore.PipelineResult> results;
   }
 
+  public static final class RealtimePipeline.Snapshot.ResultChange {
+    method public com.google.firebase.firestore.PipelineResult component1();
+    method public com.google.firebase.firestore.RealtimePipeline.Snapshot.ResultChange.ChangeType component2();
+    method public Integer? component3();
+    method public Integer? component4();
+    method public com.google.firebase.firestore.RealtimePipeline.Snapshot.ResultChange copy(com.google.firebase.firestore.PipelineResult result, com.google.firebase.firestore.RealtimePipeline.Snapshot.ResultChange.ChangeType type, Integer? oldIndex, Integer? newIndex);
+    method public Integer? getNewIndex();
+    method public Integer? getOldIndex();
+    method public com.google.firebase.firestore.PipelineResult getResult();
+    method public com.google.firebase.firestore.RealtimePipeline.Snapshot.ResultChange.ChangeType getType();
+    property public final Integer? newIndex;
+    property public final Integer? oldIndex;
+    property public final com.google.firebase.firestore.PipelineResult result;
+    property public final com.google.firebase.firestore.RealtimePipeline.Snapshot.ResultChange.ChangeType type;
+    field public static final com.google.firebase.firestore.RealtimePipeline.Snapshot.ResultChange.Companion Companion;
+  }
+
+  public enum RealtimePipeline.Snapshot.ResultChange.ChangeType {
+    enum_constant public static final com.google.firebase.firestore.RealtimePipeline.Snapshot.ResultChange.ChangeType ADDED;
+    enum_constant public static final com.google.firebase.firestore.RealtimePipeline.Snapshot.ResultChange.ChangeType MODIFIED;
+    enum_constant public static final com.google.firebase.firestore.RealtimePipeline.Snapshot.ResultChange.ChangeType REMOVED;
+  }
+
+  public static final class RealtimePipeline.Snapshot.ResultChange.Companion {
+  }
+
+  public static final class RealtimePipeline.Snapshot.SnapshotMetadata {
+    method public boolean component1();
+    method public boolean component2();
+    method public com.google.firebase.firestore.RealtimePipeline.Snapshot.SnapshotMetadata copy(boolean hasPendingWrites, boolean isConsistentBetweenListeners);
+    method public boolean getHasPendingWrites();
+    method public boolean isConsistentBetweenListeners();
+    property public final boolean hasPendingWrites;
+    property public final boolean isConsistentBetweenListeners;
+  }
+
   public final class RealtimePipelineSource {
     method public com.google.firebase.firestore.RealtimePipeline collection(com.google.firebase.firestore.CollectionReference ref);
     method public com.google.firebase.firestore.RealtimePipeline collection(String path);
@@ -1681,19 +1681,6 @@ package com.google.firebase.firestore.pipeline {
     enum_constant public static final com.google.firebase.firestore.pipeline.Ordering.Direction DESCENDING;
   }
 
-  public final class PipelineOptions extends com.google.firebase.firestore.pipeline.AbstractOptions<com.google.firebase.firestore.pipeline.PipelineOptions> {
-    ctor public PipelineOptions();
-    method public com.google.firebase.firestore.pipeline.PipelineOptions withIndexMode(com.google.firebase.firestore.pipeline.PipelineOptions.IndexMode indexMode);
-  }
-
-  public static final class PipelineOptions.IndexMode {
-    field public static final com.google.firebase.firestore.pipeline.PipelineOptions.IndexMode.Companion Companion;
-    field public static final com.google.firebase.firestore.pipeline.PipelineOptions.IndexMode RECOMMENDED;
-  }
-
-  public static final class PipelineOptions.IndexMode.Companion {
-  }
-
   public final class RawOptions extends com.google.firebase.firestore.pipeline.AbstractOptions<com.google.firebase.firestore.pipeline.RawOptions> {
     field public static final com.google.firebase.firestore.pipeline.RawOptions.Companion Companion;
     field public static final com.google.firebase.firestore.pipeline.RawOptions DEFAULT;
@@ -1712,9 +1699,6 @@ package com.google.firebase.firestore.pipeline {
     method public com.google.firebase.firestore.pipeline.RawStage ofName(String name);
   }
 
-  public final class RealtimePipelineOptions extends com.google.firebase.firestore.pipeline.AbstractOptions<com.google.firebase.firestore.pipeline.RealtimePipelineOptions> {
-  }
-
   public final class SampleStage extends com.google.firebase.firestore.pipeline.Stage<com.google.firebase.firestore.pipeline.SampleStage> {
     method public static com.google.firebase.firestore.pipeline.SampleStage withDocLimit(int documents);
     method public static com.google.firebase.firestore.pipeline.SampleStage withPercentage(double percentage);