Clarify behavior for shared command options for FLE APIs which wrap multiple driver APIs

XMLWordPrintableJSON

    • Type: Task
    • Resolution: Unresolved
    • Priority: Minor - P4
    • None
    • Component/s: Client Side Encryption
    • None
    • Needed

      Summary

      As came up in a recent slack thread, the FLE spec should be explicit about how common options are applied to operations inside FLE APIs which wrap multiple driver operations (ex: create/drop collection helpers for FLEv2).  Options such as comment or explicit sessions should be propagated to all internal commands.

      It also came up that perhaps we should be sure to use the same implicit session - as a user, I might expect that all internal driver operations for a given driver API have the same lsid in the server logs.

      Motivation

      Who is the affected end user?

      Users of FLE APIs.

      How does this affect the end user?

      Minor confusion, potentially not seeing some fields in server logs they expect to see.  Or, for explicit sessions, potentially seeing operations not associated with their session in server logs.

      How likely is it that this problem or use case will occur?

      unlikely - these APIs are mostly convenience helpers for environment setup and we probably don't expect users to use them in application code.

      If the problem does occur, what are the consequences and how severe are they?

      Minor annoyance at a log message? Performance concern? Outage/unavailability? Failover can't complete?

      Is this issue urgent?

      no.

      Is this ticket required by a downstream team?

      no.

      Is this ticket only for tests?

      no.

      Acceptance Criteria

      We should clarify (and test) that any options passed to the driver API should be propagated to all internal operations, where applicable. 

              Assignee:
              Unassigned
              Reporter:
              Bailey Pearson
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: