Let closed types work with mongodb-connection-string-url again

XMLWordPrintableJSON

    • Type: Bug
    • Resolution: Unresolved
    • Priority: Minor - P4
    • None
    • Affects Version/s: mongodb-connection-string-url-7.0.1
    • Component/s: Connection String
    • Not Needed
    • None
    • None
    • None
    • None
    • None
    • None
    • None

      Use Case

      As a... devtools engineer
      I want... to be able to use closed types (without arbitrary index signatures) in CommaAndColonSeparatedRecord and typedSearchParams
      So that... if I know that I am only potentially accessing a limited set of fields, I can express that in TS

      User Experience

      • Using types like `interface Foo { key: string }

        ` work fine again as type arguments to the mentioned methods.

      Dependencies

      • No hard dependencies, although this was discovered as part of COMPASS-10356.

      Risks/Unknowns

      • What could go wrong while implementing this change? (e.g., performance, inadvertent behavioral changes in adjacent functionality, existing tech debt, etc)
      • Is there an opportunity for better cross-driver alignment or testing in this area?
      • Is there an opportunity to improve existing documentation on this subject?

      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:
            Neal Beeken
            Reporter:
            Anna Henningsen
            None
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated: