Skip to content

DOCSP-26065: socketTimeoutMS behavior #643

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.

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

Conversation

rustagir
Copy link
Collaborator

@rustagir rustagir commented Apr 5, 2023

Pull Request Info

PR Reviewing Guidelines

JIRA - DOCSP-26065
Staging - FAQ

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?

Copy link
Contributor

@ccho-mongodb ccho-mongodb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This version looks much better, thanks for making the changes! Mostly minor suggestions, would like to take a quick look after you've made the updates.

source/faq.txt Outdated
negatively impacting throughput and performance.
Some operations, including all write operations, continue to run on the
{+mdb-server+} even if the client disconnects. This behavior can cause data
inconsistencies if your application retries the operation after failure.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion:

I think, but am not sure, that this refers to the disconnect as the failure and not some other type of write failure. If so, it would be helpful to describe it as a disconnect since that may not be similar to a general failure.

Suggested change
inconsistencies if your application retries the operation after failure.
inconsistencies if your application retries the operation after a disconnection.

source/faq.txt Outdated
through the driver.
To make sure that the driver closes the socket correctly in these cases,
set the ``socketTimeoutMS`` option on your ``MongoClient`` instance. Once any
process times out, the driver will successfully close the socket. We
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion:

I think it could be helpful to describe the process as a "MongoDB" one as done earlier since it's a general term.

I think it's not a definite outcome that the driver will successfully close it as something else could go wrong.

Suggested change
process times out, the driver will successfully close the socket. We
MongoDB process times out, the driver will close the socket. We

@rustagir rustagir requested a review from ccho-mongodb April 6, 2023 15:17
Copy link
Contributor

@ccho-mongodb ccho-mongodb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! I think there's a run-on sentence that could be broken up, but no need for another review.

source/faq.txt Outdated
Comment on lines 119 to 121
Starting in {+mdb-server+} version 4.2, the server terminates
certain operations such as aggregations and find operations if the
client disconnects the operations successfully completes. To see a full
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Issue:

I think this is a run-on sentence.

Suggestion:

I think this is what was intended:

Suggested change
Starting in {+mdb-server+} version 4.2, the server terminates
certain operations such as aggregations and find operations if the
client disconnects the operations successfully completes. To see a full
Starting in {+mdb-server+} version 4.2, when the client disconnects before
completing certain operations, such as aggregation and find operations,
the server automatically terminates them.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

eliminated a clause to shorten

Comment on lines +126 to +127
Other operations, such as write operations, continue to run on the
{+mdb-server+} even if the client disconnects. This behavior can cause data
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion:
Could be helpful to identify that this is the explicit server behavior.

Suggested change
Other operations, such as write operations, continue to run on the
{+mdb-server+} even if the client disconnects. This behavior can cause data
The server allows other operations, such as write operations, to continue to run on the
{+mdb-server+} even if the client disconnects. This behavior can cause data

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not changing because it seems like the mechanism is not that the server "allows" certain operations to continue running, but rather that it marks certain operations for termination.

@rustagir rustagir merged commit 4646875 into mongodb:master Apr 6, 2023
rustagir added a commit that referenced this pull request Apr 6, 2023
* DOCSP-26065: update information related to socketTimeoutMS + other fixes

* link fix

* fix

* changes after CC discussion

* wording

* CC PR fixes 1

* CC suggestion

(cherry picked from commit 4646875)
rustagir added a commit that referenced this pull request Apr 6, 2023
* DOCSP-26065: update information related to socketTimeoutMS + other fixes

* link fix

* fix

* changes after CC discussion

* wording

* CC PR fixes 1

* CC suggestion

(cherry picked from commit 4646875)
rustagir added a commit that referenced this pull request Apr 6, 2023
* DOCSP-26065: update information related to socketTimeoutMS + other fixes

* link fix

* fix

* changes after CC discussion

* wording

* CC PR fixes 1

* CC suggestion

(cherry picked from commit 4646875)
rustagir added a commit that referenced this pull request Apr 6, 2023
* DOCSP-26065: update information related to socketTimeoutMS + other fixes

* link fix

* fix

* changes after CC discussion

* wording

* CC PR fixes 1

* CC suggestion

(cherry picked from commit 4646875)
rustagir added a commit that referenced this pull request Apr 6, 2023
* DOCSP-26065: update information related to socketTimeoutMS + other fixes

* link fix

* fix

* changes after CC discussion

* wording

* CC PR fixes 1

* CC suggestion

(cherry picked from commit 4646875)
rustagir added a commit that referenced this pull request Apr 6, 2023
* DOCSP-26065: update information related to socketTimeoutMS + other fixes

* link fix

* fix

* changes after CC discussion

* wording

* CC PR fixes 1

* CC suggestion

(cherry picked from commit 4646875)
rustagir added a commit that referenced this pull request Apr 6, 2023
* DOCSP-26065: update information related to socketTimeoutMS + other fixes

* link fix

* fix

* changes after CC discussion

* wording

* CC PR fixes 1

* CC suggestion

(cherry picked from commit 4646875)
rustagir added a commit that referenced this pull request Apr 6, 2023
* DOCSP-26065: update information related to socketTimeoutMS + other fixes

* link fix

* fix

* changes after CC discussion

* wording

* CC PR fixes 1

* CC suggestion

(cherry picked from commit 4646875)
rustagir added a commit that referenced this pull request Apr 6, 2023
* DOCSP-26065: update information related to socketTimeoutMS + other fixes

* link fix

* fix

* changes after CC discussion

* wording

* CC PR fixes 1

* CC suggestion

(cherry picked from commit 4646875)
rustagir added a commit that referenced this pull request Apr 6, 2023
* DOCSP-26065: update information related to socketTimeoutMS + other fixes

* link fix

* fix

* changes after CC discussion

* wording

* CC PR fixes 1

* CC suggestion

(cherry picked from commit 4646875)
rustagir added a commit that referenced this pull request Apr 6, 2023
* DOCSP-26065: update information related to socketTimeoutMS + other fixes

* link fix

* fix

* changes after CC discussion

* wording

* CC PR fixes 1

* CC suggestion

(cherry picked from commit 4646875)
rustagir added a commit that referenced this pull request Apr 6, 2023
* DOCSP-26065: update information related to socketTimeoutMS + other fixes

* link fix

* fix

* changes after CC discussion

* wording

* CC PR fixes 1

* CC suggestion

(cherry picked from commit 4646875)
rustagir added a commit that referenced this pull request Apr 6, 2023
* DOCSP-26065: update information related to socketTimeoutMS + other fixes

* link fix

* fix

* changes after CC discussion

* wording

* CC PR fixes 1

* CC suggestion

(cherry picked from commit 4646875)
rustagir added a commit that referenced this pull request Apr 6, 2023
* DOCSP-26065: update information related to socketTimeoutMS + other fixes

* link fix

* fix

* changes after CC discussion

* wording

* CC PR fixes 1

* CC suggestion

(cherry picked from commit 4646875)
rustagir added a commit that referenced this pull request Apr 6, 2023
* DOCSP-26065: update information related to socketTimeoutMS + other fixes

* link fix

* fix

* changes after CC discussion

* wording

* CC PR fixes 1

* CC suggestion

(cherry picked from commit 4646875)
rustagir added a commit that referenced this pull request Apr 6, 2023
* DOCSP-26065: update information related to socketTimeoutMS + other fixes

* link fix

* fix

* changes after CC discussion

* wording

* CC PR fixes 1

* CC suggestion

(cherry picked from commit 4646875)
rustagir added a commit that referenced this pull request Apr 6, 2023
* DOCSP-26065: update information related to socketTimeoutMS + other fixes

* link fix

* fix

* changes after CC discussion

* wording

* CC PR fixes 1

* CC suggestion

(cherry picked from commit 4646875)
rustagir added a commit that referenced this pull request Apr 6, 2023
* DOCSP-26065: update information related to socketTimeoutMS + other fixes

* link fix

* fix

* changes after CC discussion

* wording

* CC PR fixes 1

* CC suggestion

(cherry picked from commit 4646875)
rustagir added a commit that referenced this pull request Apr 6, 2023
* DOCSP-26065: update information related to socketTimeoutMS + other fixes

* link fix

* fix

* changes after CC discussion

* wording

* CC PR fixes 1

* CC suggestion

(cherry picked from commit 4646875)
rustagir added a commit that referenced this pull request Apr 6, 2023
* DOCSP-26065: update information related to socketTimeoutMS + other fixes

* link fix

* fix

* changes after CC discussion

* wording

* CC PR fixes 1

* CC suggestion

(cherry picked from commit 4646875)
rustagir added a commit that referenced this pull request Apr 6, 2023
* DOCSP-26065: update information related to socketTimeoutMS + other fixes

* link fix

* fix

* changes after CC discussion

* wording

* CC PR fixes 1

* CC suggestion

(cherry picked from commit 4646875)
jordan-smith721 pushed a commit to jordan-smith721/docs-node that referenced this pull request Jul 24, 2023
* DOCSP-26065: update information related to socketTimeoutMS + other fixes

* link fix

* fix

* changes after CC discussion

* wording

* CC PR fixes 1

* CC suggestion

(cherry picked from commit 4646875)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants