DOCSP-51959 Add a warning about tryNext bug to all change stream manual iteration examples #1189

mballard-mdb · 2025-07-17T15:43:42Z

Pull Request Info

PR Reviewing Guidelines

JIRA - https://jira.mongodb.org/browse/DOCSP-51959

Staging Links

monitoring-and-logging/change-streams

Self-Review Checklist

Is this free of any warnings or errors in the RST?
Did you run a spell-check?
Did you run a grammar-check?
Are all the links working?
Are the facets and meta keywords accurate?
Are the page titles greater than 20 characters long and SEO relevant?

netlify · 2025-07-17T15:43:47Z

✅ Deploy Preview for docs-node ready!

Name	Link
🔨 Latest commit	`aaf19e6`
🔍 Latest deploy log	https://app.netlify.com/projects/docs-node/deploys/6879547b307013000858bd82
😎 Deploy Preview	https://deploy-preview-1189--docs-node.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

docs-builder-bot · 2025-07-17T17:35:13Z

🔄 Deploy Preview for docs-node processing

Item	Details
🔨 Latest Commit	1ef168a97d66ae756c210fcb327d56be54379c0c
😎 Deploy Preview	https://deploy-preview-1189--docs-node.netlify.app
🔍 Build Logs	View Logs

rachel-mack

One suggestion:

rachel-mack · 2025-07-17T19:07:44Z

source/includes/try-next-warning.rst

+   The `tryNext() <{+api+}/classes/ChangeStream.html#tryNext>`_ method does not
+   automatically update the change stream's `resumeToken.
+   <{+api+}/classes/ChangeStream.html#resumeToken}>`_ If you require an updated
+   ``resumeToken``, use the ``next()`` method.


Suggested change

The `tryNext() <{+api+}/classes/ChangeStream.html#tryNext>`_ method does not

automatically update the change stream's `resumeToken.

<{+api+}/classes/ChangeStream.html#resumeToken}>`_ If you require an updated

``resumeToken``, use the ``next()`` method.

The `tryNext() <{+api+}/classes/ChangeStream.html#tryNext>`_ method does not

automatically update the change stream's `resumeToken.

<{+api+}/classes/ChangeStream.html#resumeToken>`_ If you require an updated

``resumeToken``, use the ``next()`` method.

rachel-mack · 2025-07-17T19:14:56Z

source/monitoring-and-logging/change-streams.txt

@@ -88,6 +88,7 @@ read events from the change stream:
      - ``next()`` to request the next document in the stream
      - ``close()`` to close the ChangeStream

+      .. include:: /includes/try-next-warning.rst


There's a warning below the tabs section on line 117/118 (not this one, but I can't comment directly on it), that I would move into the other tabs, because:

I don't think it's only relevant to the Idiomatic Iteration and Event tabs (ask tech review to confirm)

It looks a little odd to have two warnings appear in a row

I believe Iterator mode applies to idomatic and manual iteration, but I will double check as I agree stacking callouts is odd.

This is relevant to all tabs because it's a warning not to mix the modes defined in each tab, basically.

What do y'all think of moving this above the section altogether?

I can do that, under where it says "read events from change streams by iterating over them or listening for events." The warning can emphasize the or.

Yeah, I think that works nicely. Thanks

…al iteration examples (mongodb#1189) * DOCSP-51959 tryNext resumeToken error warning * fix link * bracket removal * move warning (cherry picked from commit 7baddf7)

mballard-mdb · 2025-07-17T20:07:56Z

💔 Some backports could not be created

Status	Branch	Result
✅	v6.17
❌	v6.16	Conflict resolution was aborted by the user
❌	v6.15	Conflict resolution was aborted by the user
❌	v6.14	Conflict resolution was aborted by the user
❌	v6.13	Conflict resolution was aborted by the user
❌	v6.12	Conflict resolution was aborted by the user
❌	v6.11	Conflict resolution was aborted by the user
❌	v6.10	Conflict resolution was aborted by the user
❌	v6.9	Conflict resolution was aborted by the user
❌	v6.8	Conflict resolution was aborted by the user

Note: Successful backport PRs will be merged automatically after passing CI.

Manual backport

To create the backport manually run:

backport --pr 1189

Questions ?

Please refer to the Backport tool documentation

…al iteration examples (#1189) (#1191) * DOCSP-51959 tryNext resumeToken error warning * fix link * bracket removal * move warning (cherry picked from commit 7baddf7)

…al iteration examples (mongodb#1189) * DOCSP-51959 tryNext resumeToken error warning * fix link * bracket removal * move warning (cherry picked from commit 7baddf7)

mballard-mdb · 2025-07-17T20:18:19Z

💚 All backports created successfully

Status	Branch	Result
✅	v6.16
✅	v6.15
✅	v6.14
✅	v6.13
✅	v6.12
✅	v6.11
✅	v6.10
✅	v6.9
✅	v6.8

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

…al iteration examples (#1189) (#1192) * DOCSP-51959 tryNext resumeToken error warning * fix link * bracket removal * move warning (cherry picked from commit 7baddf7)

…al iteration examples (#1189) (#1194) * DOCSP-51959 tryNext resumeToken error warning * fix link * bracket removal * move warning (cherry picked from commit 7baddf7)

…al iteration examples (#1189) (#1195) * DOCSP-51959 tryNext resumeToken error warning * fix link * bracket removal * move warning (cherry picked from commit 7baddf7)

…al iteration examples (#1189) (#1196) * DOCSP-51959 tryNext resumeToken error warning * fix link * bracket removal * move warning (cherry picked from commit 7baddf7)

…al iteration examples (#1189) (#1197) * DOCSP-51959 tryNext resumeToken error warning * fix link * bracket removal * move warning (cherry picked from commit 7baddf7)

…al iteration examples (#1189) (#1193) * DOCSP-51959 tryNext resumeToken error warning * fix link * bracket removal * move warning (cherry picked from commit 7baddf7)

…al iteration examples (#1189) (#1198) * DOCSP-51959 tryNext resumeToken error warning * fix link * bracket removal * move warning (cherry picked from commit 7baddf7)

…al iteration examples (#1189) (#1199) * DOCSP-51959 tryNext resumeToken error warning * fix link * bracket removal * move warning (cherry picked from commit 7baddf7)

…al iteration examples (#1189) (#1200) * DOCSP-51959 tryNext resumeToken error warning * fix link * bracket removal * move warning (cherry picked from commit 7baddf7)

DOCSP-51959 tryNext resumeToken error warning

4d3aa2e

fix link

cd70bcf

rachel-mack approved these changes Jul 17, 2025

View reviewed changes

mballard-mdb added 2 commits July 17, 2025 15:39

bracket removal

1ef168a

move warning

aaf19e6

mballard-mdb requested a review from baileympearson July 17, 2025 19:53

baileympearson approved these changes Jul 17, 2025

View reviewed changes

mballard-mdb merged commit 7baddf7 into mongodb:master Jul 17, 2025
6 checks passed

mballard-mdb deleted the DOCSP-51959-trynext-err branch July 17, 2025 20:01

mballard-mdb mentioned this pull request Jul 17, 2025

[v6.17] DOCSP-51959 Add a warning about tryNext bug to all change stream manual iteration examples (#1189) #1191

Merged

mballard-mdb mentioned this pull request Jul 17, 2025

[v6.16] DOCSP-51959 Add a warning about tryNext bug to all change stream manual iteration examples (#1189) #1192

Merged

mballard-mdb mentioned this pull request Jul 17, 2025

[v6.15] DOCSP-51959 Add a warning about tryNext bug to all change stream manual iteration examples (#1189) #1193

Merged

mballard-mdb mentioned this pull request Jul 17, 2025

[v6.14] DOCSP-51959 Add a warning about tryNext bug to all change stream manual iteration examples (#1189) #1194

Merged

mballard-mdb mentioned this pull request Jul 17, 2025

[v6.13] DOCSP-51959 Add a warning about tryNext bug to all change stream manual iteration examples (#1189) #1195

Merged

mballard-mdb mentioned this pull request Jul 17, 2025

[v6.12] DOCSP-51959 Add a warning about tryNext bug to all change stream manual iteration examples (#1189) #1196

Merged

mballard-mdb mentioned this pull request Jul 17, 2025

[v6.11] DOCSP-51959 Add a warning about tryNext bug to all change stream manual iteration examples (#1189) #1197

Merged

mballard-mdb mentioned this pull request Jul 17, 2025

[v6.10] DOCSP-51959 Add a warning about tryNext bug to all change stream manual iteration examples (#1189) #1198

Merged

mballard-mdb mentioned this pull request Jul 17, 2025

[v6.9] DOCSP-51959 Add a warning about tryNext bug to all change stream manual iteration examples (#1189) #1199

Merged

mballard-mdb mentioned this pull request Jul 17, 2025

[v6.8] DOCSP-51959 Add a warning about tryNext bug to all change stream manual iteration examples (#1189) #1200

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

DOCSP-51959 Add a warning about tryNext bug to all change stream manual iteration examples #1189

DOCSP-51959 Add a warning about tryNext bug to all change stream manual iteration examples #1189

Uh oh!

mballard-mdb commented Jul 17, 2025 •

edited

Loading

Uh oh!

netlify bot commented Jul 17, 2025 •

edited

Loading

Uh oh!

docs-builder-bot commented Jul 17, 2025 •

edited

Loading

Uh oh!

rachel-mack left a comment

Uh oh!

rachel-mack Jul 17, 2025

Uh oh!

rachel-mack Jul 17, 2025

Uh oh!

mballard-mdb Jul 17, 2025

Uh oh!

baileympearson Jul 17, 2025

Uh oh!

mballard-mdb Jul 17, 2025

Uh oh!

baileympearson Jul 17, 2025

Uh oh!

Uh oh!

mballard-mdb commented Jul 17, 2025

Uh oh!

mballard-mdb commented Jul 17, 2025

Uh oh!

Uh oh!

DOCSP-51959 Add a warning about tryNext bug to all change stream manual iteration examples #1189

DOCSP-51959 Add a warning about tryNext bug to all change stream manual iteration examples #1189

Uh oh!

Conversation

mballard-mdb commented Jul 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Info

Staging Links

Self-Review Checklist

Uh oh!

netlify bot commented Jul 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for docs-node ready!

Uh oh!

docs-builder-bot commented Jul 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔄 Deploy Preview for docs-node processing

Uh oh!

rachel-mack left a comment

Choose a reason for hiding this comment

Uh oh!

rachel-mack Jul 17, 2025

Choose a reason for hiding this comment

Uh oh!

rachel-mack Jul 17, 2025

Choose a reason for hiding this comment

Uh oh!

mballard-mdb Jul 17, 2025

Choose a reason for hiding this comment

Uh oh!

baileympearson Jul 17, 2025

Choose a reason for hiding this comment

Uh oh!

mballard-mdb Jul 17, 2025

Choose a reason for hiding this comment

Uh oh!

baileympearson Jul 17, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mballard-mdb commented Jul 17, 2025

💔 Some backports could not be created

Manual backport

Questions ?

Uh oh!

mballard-mdb commented Jul 17, 2025

💚 All backports created successfully

Questions ?

Uh oh!

Uh oh!

mballard-mdb commented Jul 17, 2025 •

edited

Loading

netlify bot commented Jul 17, 2025 •

edited

Loading

docs-builder-bot commented Jul 17, 2025 •

edited

Loading