DRIVERS-1343 Include the "to" field in ChangeStreamDocument (#1138)

Author: abr-egn

source/change-streams/change-streams.rst

@@ -9,8 +9,8 @@ Change Streams
 :Status: Accepted
 :Type: Standards
 :Minimum Server Version: 3.6
-:Last Modified: 2022-02-10
-:Version: 1.12
+:Last Modified: 2022-03-14
+:Version: 1.13
 
 .. contents::
 
@@ -141,6 +141,13 @@ If an aggregate command with a ``$changeStream`` stage completes successfully, t
      */
     ns: Document;
 
+    /**
+     * Only present for ops of type 'rename'.
+     *
+     * The namespace, in the same format as `ns`, that a collection has been renamed to.
+     */
+    to: Optional<Document>;
+
     /**
      * Only present for ops of type ‘insert’, ‘update’, ‘replace’, and
      * ‘delete’.
@@ -923,3 +930,5 @@ Changelog
 | 2022-02-10 | Specified that ``getMore`` command must explicitly send    |
 |            | inherited ``comment``.                                     |
 +------------+------------------------------------------------------------+
+| 2022-02-28 | Added ``to`` to ``ChangeStreamDocument``.                  |
++------------+------------------------------------------------------------+

source/change-streams/tests/unified/change-streams.json

@@ -426,6 +426,46 @@
           ]
         }
       ]
+    },
+    {
+      "description": "to field is set in a rename change event",
+      "runOnRequirements": [
+        {
+          "minServerVersion": "4.0.1"
+        }
+      ],
+      "operations": [
+        {
+          "name": "createChangeStream",
+          "object": "collection0",
+          "arguments": {
+            "pipeline": []
+          },
+          "saveResultAsEntity": "changeStream0"
+        },
+        {
+          "name": "rename",
+          "object": "collection0",
+          "arguments": {
+            "to": "collection1"
+          }
+        },
+        {
+          "name": "iterateUntilDocumentOrError",
+          "object": "changeStream0",
+          "expectResult": {
+            "operationType": "rename",
+            "ns": {
+              "db": "database0",
+              "coll": "collection0"
+            },
+            "to": {
+              "db": "database0",
+              "coll": "collection1"
+            }
+          }
+        }
+      ]
     }
   ]
 }

source/change-streams/tests/unified/change-streams.yml

@@ -226,3 +226,27 @@ tests:
                 comment: { $$exists: false }
               commandName: getMore
               databaseName: *database0
+  
+  - description: "to field is set in a rename change event"
+    runOnRequirements:
+      - minServerVersion: "4.0.1"
+    operations:
+      - name: createChangeStream
+        object: *collection0
+        arguments:
+          pipeline: []
+        saveResultAsEntity: &changeStream0 changeStream0
+      - name: rename
+        object: *collection0
+        arguments:
+          to: &collection1 collection1
+      - name: iterateUntilDocumentOrError
+        object: *changeStream0
+        expectResult:
+          operationType: rename
+          ns:
+            db: *database0
+            coll: *collection0
+          to:
+            db: *database0
+            coll: *collection1