From a075a057c1ef07cc5263ee8a1f3e5180239c8d8c Mon Sep 17 00:00:00 2001 From: Nathan Leniz Date: Wed, 7 Jul 2021 08:20:05 -0700 Subject: [PATCH 1/4] DOCSP-17414: ChangeStream paradim errors This changes the warning text to state that mixing paradigms will error. --- source/includes/changestream-paradigm-warning.rst | 4 ++++ source/usage-examples/changeStream.txt | 5 +---- 2 files changed, 5 insertions(+), 4 deletions(-) create mode 100644 source/includes/changestream-paradigm-warning.rst diff --git a/source/includes/changestream-paradigm-warning.rst b/source/includes/changestream-paradigm-warning.rst new file mode 100644 index 000000000..8a273c25d --- /dev/null +++ b/source/includes/changestream-paradigm-warning.rst @@ -0,0 +1,4 @@ +.. warning:: + + Attempting to use a ``ChangeStream`` as an ``Iterator`` that is in ``EventEmitter`` mode will cause an error, + and attempting to use a ``ChangeStream`` as an ``EventEmitter`` in ``Iterator`` mode will cause an error. diff --git a/source/usage-examples/changeStream.txt b/source/usage-examples/changeStream.txt index 5662a27ee..59f12a498 100644 --- a/source/usage-examples/changeStream.txt +++ b/source/usage-examples/changeStream.txt @@ -29,10 +29,7 @@ The ``watch()`` method returns an instance of a :node-api-4.0:`ChangeStream Date: Wed, 7 Jul 2021 10:15:09 -0700 Subject: [PATCH 2/4] reworded error message --- source/includes/changestream-paradigm-warning.rst | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/source/includes/changestream-paradigm-warning.rst b/source/includes/changestream-paradigm-warning.rst index 8a273c25d..b66f5c1e4 100644 --- a/source/includes/changestream-paradigm-warning.rst +++ b/source/includes/changestream-paradigm-warning.rst @@ -1,4 +1,8 @@ .. warning:: - Attempting to use a ``ChangeStream`` as an ``Iterator`` that is in ``EventEmitter`` mode will cause an error, - and attempting to use a ``ChangeStream`` as an ``EventEmitter`` in ``Iterator`` mode will cause an error. + Using a ``ChangeStream`` in ``EventEmitter`` and ``Iterator`` mode + concurrently is not supported and causes an error. This is to prevent + undefined behavior, where it cannot be guaranteed which consumer will + receive documents first. + + From c8c25049bb0058cc7d6f0c51bdd1886e8e0d4ed6 Mon Sep 17 00:00:00 2001 From: Nathan Leniz Date: Wed, 7 Jul 2021 11:04:06 -0700 Subject: [PATCH 3/4] nits --- source/includes/changestream-paradigm-warning.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/includes/changestream-paradigm-warning.rst b/source/includes/changestream-paradigm-warning.rst index b66f5c1e4..6d64a0a10 100644 --- a/source/includes/changestream-paradigm-warning.rst +++ b/source/includes/changestream-paradigm-warning.rst @@ -2,7 +2,7 @@ Using a ``ChangeStream`` in ``EventEmitter`` and ``Iterator`` mode concurrently is not supported and causes an error. This is to prevent - undefined behavior, where it cannot be guaranteed which consumer will - receive documents first. + undefined behavior, where the driver cannot guarantee which consumer + receives documents first. From 07181dc8e0752a80a7c063a28e7755509309affa Mon Sep 17 00:00:00 2001 From: Nathan Leniz Date: Wed, 7 Jul 2021 11:06:37 -0700 Subject: [PATCH 4/4] clarify subject --- source/includes/changestream-paradigm-warning.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/includes/changestream-paradigm-warning.rst b/source/includes/changestream-paradigm-warning.rst index 6d64a0a10..a4880a1ac 100644 --- a/source/includes/changestream-paradigm-warning.rst +++ b/source/includes/changestream-paradigm-warning.rst @@ -1,8 +1,8 @@ .. warning:: Using a ``ChangeStream`` in ``EventEmitter`` and ``Iterator`` mode - concurrently is not supported and causes an error. This is to prevent - undefined behavior, where the driver cannot guarantee which consumer - receives documents first. + concurrently is not supported by the driver and causes an error. This + is to prevent undefined behavior, where the driver cannot guarantee + which consumer receives documents first.