DRIVERS-3151 Update change stream expanded field visibility (#1780)

Author: abr-egn

source/change-streams/change-streams.md

@@ -139,7 +139,7 @@ class ChangeStreamDocument {
 
   /**
    * Only present for ops of type 'rename', 'create', 'modify', 'createIndexes', 'dropIndexes', 'shardCollection', 'reshardCollection', 'refineCollectionShardKey'.
-   * Only present when the `showExpandedEvents` change stream option is enabled.
+   * Prior to server version 8.2.0, only present when the `showExpandedEvents` change stream option is enabled.
    *
    * A description of the operation.
    * 
@@ -202,7 +202,7 @@ class ChangeStreamDocument {
   /**
    * The `ui` field from the oplog entry corresponding to the change event.
    * 
-   * Only present when the `showExpandedEvents` change stream option is enabled and for the following events
+   * Only present for the following events:
    *  - 'insert'
    *  - 'update'
    *  - 'delete'
@@ -214,6 +214,7 @@ class ChangeStreamDocument {
    *  - 'shardCollection'
    *  - 'reshardCollection'
    *  - 'refineCollectionShardKey'
+   * Prior to server versions 8.2, only present when the `showExpandedEvents` change stream option is enabled.
    *  
    * This field is a value of binary subtype 4 (UUID).
    *  
@@ -1016,6 +1017,8 @@ There should be no backwards compatibility concerns.
 
 ## Changelog
 
+- 2025-03-31: Update for expanded field visibility in server 8.2+
+
 - 2025-02-24: Make `nsType` `Optional` to match other optional fields in the change stream spec.
 
 - 2025-01-29: Add `nsType` to `ChangeStreamDocument`.

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

@@ -24,32 +24,6 @@ initialData:
     documents: []
 
 tests:
-  - description: "disambiguatedPaths is not present when showExpandedEvents is false/unset"
-    operations:
-      - name: insertOne
-        object: *collection0
-        arguments:
-          document: { _id: 1, 'a': { '1': 1 } }
-      - name: createChangeStream
-        object: *collection0
-        arguments: { pipeline: [] }
-        saveResultAsEntity: &changeStream0 changeStream0
-      - name: updateOne
-        object: *collection0
-        arguments:
-          filter: { _id: 1 }
-          update: { $set: { 'a.1': 2 } }
-      - name: iterateUntilDocumentOrError
-        object: *changeStream0
-        expectResult:
-          operationType: "update"
-          ns: { db: *database0, coll: *collection0 }
-          updateDescription:
-            updatedFields: { $$exists: true }
-            removedFields: { $$exists: true }
-            truncatedArrays: { $$exists: true }
-            disambiguatedPaths: { $$exists: false }
-
   - description: "disambiguatedPaths is present on updateDescription when an ambiguous path is present"
     operations:
       - name: insertOne

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

@@ -115,7 +115,8 @@ tests:
                 "field": "array",
                 "newSize": 2
               }
-            ]
+            ],
+            disambiguatedPaths: { $$unsetOrMatches: { $$exists: true } }
           }
         }
 
@@ -722,6 +723,7 @@ tests:
             updatedFields: { x: 2 }
             removedFields: []
             truncatedArrays: { $$unsetOrMatches: { $$exists: true } }
+            disambiguatedPaths: { $$unsetOrMatches: { $$exists: true } }
       - name: iterateUntilDocumentOrError
         object: *changeStream0
         expectResult: