Uploaded image for project: 'Drivers'
  1. Drivers
  2. DRIVERS-936

Inconsistent/bad grammar in FLE wire version error message

    XMLWordPrintableJSON

Details

    • Icon: Improvement Improvement
    • Resolution: Won't Do
    • Icon: Minor - P4 Minor - P4
    • None
    • Client Side Encryption
    • None

    Description

      https://github.com/mongodb/specifications/blob/master/source/client-side-encryption/client-side-encryption.rst#auto-encrypt-and-decrypt says:

      > Drivers MUST raise an error when attempting to auto encrypt a command if the maxWireVersion is less than 8. The error message MUST contain "Auto-encryption requires a minimum MongoDB version of 4.2".

      My feeling is that the words "auto" and "encryption" should be separated by a space and be two words, though I am not an expert in English grammar. According to https://www.grammar-monster.com/lessons/hyphens_in_prefixes.htm, if the words "auto" and "encryption" were to be combined into one word they would not be separated by a dash as falling under "You Can Let Different Vowels Double Up" category, i.e. the new word would be "autoencryption". It seems to me that the intent of the phrase is to reference automatic encryption, not to emphasize "autoencryption" as some kind of a new concept that needs its own word.

      There does not appear to be any other instance in the spec document where "auto-encryption" is used as a hyphenated word.

      The error message can also use the phrase "MongoDB server version" instead of "MongoDB version" to be clear which product it is referring to since MongoDB has a number of other products like Realm and drivers.

      I suggest the following wording:

      > Drivers MUST raise an error when attempting to auto encrypt a command if the maxWireVersion is less than 8. The error message MUST contain "Auto encryption requires MongoDB server version 4.2 or higher".

      Attachments

        Activity

          People

            Unassigned Unassigned
            oleg.pudeyev@mongodb.com Oleg Pudeyev (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: