RUBY-1559 Implement uri option spec tests #1170
Conversation
saghm
force-pushed
the
uri-options-spec
branch
2 times, most recently
from
e4b4585 to
dadb6e5
Compare
saghm
force-pushed
the
uri-options-spec
branch
from
dadb6e5 to
7910476
Compare
saghm
force-pushed
the
uri-options-spec
branch
from
7438857 to
ffc3704
Compare
|
This PR should also have a ticket reference, API documentation for added options and tutorial documentation for added options. |
|
My mistake, there is a ticket. I've updated the description. |
|
We currently don't have any API documentation for URI options; we have it for client options, but no new client options have been added, only additional mappings to them from URI options. If you want me to, I can open a separate ticket for us to add API documentation for URI options. |
saghm
changed the title
| * - authMechanism=String | ||
| - ``:auth_mech => Symbol`` | ||
|
|
||
| * - authMechanismProperties=Strings |
There was a problem hiding this comment.
How would a user determine what to put in Strings for this option?
There was a problem hiding this comment.
This already existed in the old code; I just alphabetized the list for easier reading. If you just look at the diff for e396935, you'll see the options that are new.
There was a problem hiding this comment.
I've added extra documentation to this option and the others below where the type being forwarded is different from the type specified in the URI. Let me know if you think any of the other options need extra documentation as well.
saghm
force-pushed
the
uri-options-spec
branch
from
131beed to
2fefd93
Compare
saghm
force-pushed
the
uri-options-spec
branch
8 times, most recently
from
889ddd5 to
039f10b
Compare
saghm
force-pushed
the
uri-options-spec
branch
from
039f10b to
80fcbe7
Compare
|
I believe I've addressed all of the outstanding comments on this, so it's ready for review again |
|
|
||
| * - compressors=Strings | ||
| - ``:compressors => Array<String>`` | ||
| Specified as a comma-separated list, e.g. "zlib,snappy" |
There was a problem hiding this comment.
This is a weird default to specify in the Ruby driver because snappy isn't supported by Ruby. Will this warn?
Perhaps a better language is something along the lines of:
Specified as a comma-separated list. Note that the Ruby driver only supports zlib compression, however other drivers may support snappy. For maximum compatibility with drivers specify "snappy,zlib", if compatibility with other drivers is not a concern specify "zlib". Compression is not enabled by default and when using MongoDB 4.0 and earlier, zlib compression must be manually enabled on the server in order for the Ruby driver to compress wire protocol data.
There was a problem hiding this comment.
I didn't intend this to be interpreted as a default, but rather just to demonstrate how specifying more than one would work. I'm happy to make the suggested change, though.
There was a problem hiding this comment.
Okay that makes sense, let's put this language in given user confusion over compression.
Spec test pull request: mongodb/specifications#414
https://jira.mongodb.org/browse/RUBY-1559