add pipeline to Listen RPC

Author: wu-hui

packages/firestore/src/protos/firestore_proto_api.ts

@@ -356,6 +356,9 @@ export declare namespace firestoreV1ApiClientInterfaces {
     parent?: string;
     structuredQuery?: StructuredQuery;
   }
+  interface PipelineQueryTarget {
+    pipeline?: StructuredPipeline;
+  }
   interface ReadOnly {
     readTime?: string;
   }
@@ -424,6 +427,7 @@ export declare namespace firestoreV1ApiClientInterfaces {
   interface Target {
     query?: QueryTarget;
     documents?: DocumentsTarget;
+    pipelineQuery?: PipelineQueryTarget;
     resumeToken?: string | Uint8Array;
     readTime?: Timestamp;
     targetId?: number;

packages/firestore/src/protos/google/firestore/v1/firestore.proto

@@ -913,13 +913,25 @@ message Target {
     }
   }
 
+  // A target specified by a pipeline query.
+  message PipelineQueryTarget {
+    // The pipeline to run.
+    oneof pipeline_type {
+      // A pipelined operation in structured format.
+      StructuredPipeline pipeline = 1;
+    }
+  }
+
   // The type of target to listen to.
   oneof target_type {
     // A target specified by a query.
     QueryTarget query = 2;
 
     // A target specified by a set of document names.
     DocumentsTarget documents = 3;
+
+    // A target specified by a pipeline query.
+    PipelineQueryTarget pipeline_query = 13;
   }
 
   // When to start listening.

packages/firestore/src/protos/google/firestore/v1/write.proto

@@ -198,6 +198,12 @@ message WriteResult {
 //
 // Multiple [DocumentChange][google.firestore.v1.DocumentChange] messages may be returned for the same logical
 // change, if multiple targets are affected.
+//
+// For PipelineQueryTargets, `document` will be in the new pipeline format,
+// (-- TODO(b/330735468): Insert link to spec. --)
+// For a Listen stream with both QueryTargets and PipelineQueryTargets present,
+// if a document matches both types of queries, then a separate DocumentChange
+// messages will be sent out one for each set.
 message DocumentChange {
   // The new state of the [Document][google.firestore.v1.Document].
   //

packages/firestore/src/protos/protos.json

@@ -2343,7 +2343,8 @@
                     "targetType": {
                       "oneof": [
                         "query",
-                        "documents"
+                        "documents",
+                        "pipeline_query"
                       ]
                     },
                     "resumeType": {
@@ -2362,6 +2363,10 @@
                       "type": "DocumentsTarget",
                       "id": 3
                     },
+                    "pipeline_query": {
+                      "type": "PipelineQueryTarget",
+                      "id": 13
+                    },
                     "resumeToken": {
                       "type": "bytes",
                       "id": 4
@@ -2411,6 +2416,21 @@
                           "id": 2
                         }
                       }
+                    },
+                    "PipelineQueryTarget": {
+                      "oneofs": {
+                        "pipelineType": {
+                          "oneof": [
+                            "pipeline"
+                          ]
+                        }
+                      },
+                      "fields": {
+                        "pipeline": {
+                          "type": "StructuredPipeline",
+                          "id": 1
+                        }
+                      }
                     }
                   }
                 },
@@ -3266,4 +3286,4 @@
       }
     }
   }
-}
+}