Uploaded image for project: 'Node.js Driver'
  1. Node.js Driver
  2. NODE-6584

Improve typing for autoEncryption options

    • Not Needed
    • Hide

      1. What would you like to communicate to the user about this feature?
      2. Would you like the user to see examples of the syntax and/or executable code and its output?
      3. Which versions of the driver/connector does this apply to?

      Show
      1. What would you like to communicate to the user about this feature? 2. Would you like the user to see examples of the syntax and/or executable code and its output? 3. Which versions of the driver/connector does this apply to?

      Use Case

      As a... CSFLE/QE user
      I want... to easily understand which filename I need to specify where
      So that... I am less confused by the presence of libmongocrypt, mongocryptd, crypt_shared and other files with similar names.

      User Experience

      • Users stop trying specify a libmongocrypt file or other one in place of the crypt_shared library.

      Dependencies

      • Not really a dependency, but a ticket with similar goals: MONGOCRYPT-738

      Risks/Unknowns

      • There's an obvious risk that users could rename their files, which is definitely supported, but highly unlikely to happen in a typical environment. Working around this restriction is easy.

      Acceptance Criteria

      Implementation Requirements

      • functional reqs, potential snafus to avoid, performance targets, etc

      Testing Requirements

      • unit test, spec test sync, etc

      Documentation Requirements

      • DOCSP ticket, API docs, etc

      Follow Up Requirements

      • additional tickets to file, required releases, etc
      • if node behavior differs/will differ from other drivers, confirm with dbx devs what standard to aim for and what plan, if any, exists to reconcile the diverging behavior moving forward

            Assignee:
            Unassigned Unassigned
            Reporter:
            anna.henningsen@mongodb.com Anna Henningsen
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated: