Skip to content

feat(NODE-6676): add support for nsType in change stream create events #4431

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Feb 25, 2025
Merged

feat(NODE-6676): add support for nsType in change stream create events #4431

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
779b910
new tests
baileympearson Feb 24, 2025
6dba449
changes
baileympearson Feb 24, 2025
1b16680
Update src/change_stream.ts
baileympearson Feb 24, 2025
dfed48d
Merge branch 'main' into NODE-6676
nbbeeken Feb 24, 2025
e1cde09
Merge branch 'main' into NODE-6676
baileympearson Feb 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions src/change_stream.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -419,6 +419,13 @@ export interface ChangeStreamCreateDocument
ChangeStreamDocumentCollectionUUID {
/** Describes the type of operation represented in this change notification */
operationType: 'create';

/**
* The type of the newly created object.
*
* @since 8.1.0
*/
nsType?: 'collection' | 'timeseries' | 'view';
}

/**
Expand Down
145 changes: 145 additions & 0 deletions test/spec/change-streams/unified/change-streams-nsType.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
{
"description": "change-streams-nsType",
"schemaVersion": "1.7",
"runOnRequirements": [
{
"minServerVersion": "8.1.0",
"topologies": [
"replicaset",
"sharded"
],
"serverless": "forbid"
}
],
"createEntities": [
{
"client": {
"id": "client0",
"useMultipleMongoses": false
}
},
{
"database": {
"id": "database0",
"client": "client0",
"databaseName": "database0"
}
}
],
"tests": [
{
"description": "nsType is present when creating collections",
"operations": [
{
"name": "dropCollection",
"object": "database0",
"arguments": {
"collection": "foo"
}
},
{
"name": "createChangeStream",
"object": "database0",
"arguments": {
"pipeline": [],
"showExpandedEvents": true
},
"saveResultAsEntity": "changeStream0"
},
{
"name": "createCollection",
"object": "database0",
"arguments": {
"collection": "foo"
}
},
{
"name": "iterateUntilDocumentOrError",
"object": "changeStream0",
"expectResult": {
"operationType": "create",
"nsType": "collection"
}
}
]
},
{
"description": "nsType is present when creating timeseries",
"operations": [
{
"name": "dropCollection",
"object": "database0",
"arguments": {
"collection": "foo"
}
},
{
"name": "createChangeStream",
"object": "database0",
"arguments": {
"pipeline": [],
"showExpandedEvents": true
},
"saveResultAsEntity": "changeStream0"
},
{
"name": "createCollection",
"object": "database0",
"arguments": {
"collection": "foo",
"timeseries": {
"timeField": "time",
"metaField": "meta",
"granularity": "minutes"
}
}
},
{
"name": "iterateUntilDocumentOrError",
"object": "changeStream0",
"expectResult": {
"operationType": "create",
"nsType": "timeseries"
}
}
]
},
{
"description": "nsType is present when creating views",
"operations": [
{
"name": "dropCollection",
"object": "database0",
"arguments": {
"collection": "foo"
}
},
{
"name": "createChangeStream",
"object": "database0",
"arguments": {
"pipeline": [],
"showExpandedEvents": true
},
"saveResultAsEntity": "changeStream0"
},
{
"name": "createCollection",
"object": "database0",
"arguments": {
"collection": "foo",
"viewOn": "testName"
}
},
{
"name": "iterateUntilDocumentOrError",
"object": "changeStream0",
"expectResult": {
"operationType": "create",
"nsType": "view"
}
}
]
}
]
}
86 changes: 86 additions & 0 deletions test/spec/change-streams/unified/change-streams-nsType.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
description: "change-streams-nsType"
schemaVersion: "1.7"
runOnRequirements:
- minServerVersion: "8.1.0"
topologies: [ replicaset, sharded ]
serverless: forbid
createEntities:
- client:
id: &client0 client0
useMultipleMongoses: false
- database:
id: &database0 database0
client: *client0
databaseName: *database0

tests:
- description: "nsType is present when creating collections"
operations:
- name: dropCollection
object: *database0
arguments:
collection: &collection0 foo
- name: createChangeStream
object: *database0
arguments:
pipeline: []
showExpandedEvents: true
saveResultAsEntity: &changeStream0 changeStream0
- name: createCollection
object: *database0
arguments:
collection: *collection0
- name: iterateUntilDocumentOrError
object: *changeStream0
expectResult:
operationType: create
nsType: collection

- description: "nsType is present when creating timeseries"
operations:
- name: dropCollection
object: *database0
arguments:
collection: &collection0 foo
- name: createChangeStream
object: *database0
arguments:
pipeline: []
showExpandedEvents: true
saveResultAsEntity: &changeStream0 changeStream0
- name: createCollection
object: *database0
arguments:
collection: *collection0
timeseries:
timeField: "time"
metaField: "meta"
granularity: "minutes"
- name: iterateUntilDocumentOrError
object: *changeStream0
expectResult:
operationType: create
nsType: timeseries

- description: "nsType is present when creating views"
operations:
- name: dropCollection
object: *database0
arguments:
collection: &collection0 foo
- name: createChangeStream
object: *database0
arguments:
pipeline: []
showExpandedEvents: true
saveResultAsEntity: &changeStream0 changeStream0
- name: createCollection
object: *database0
arguments:
collection: *collection0
viewOn: testName
- name: iterateUntilDocumentOrError
object: *changeStream0
expectResult:
operationType: create
nsType: view