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

Use api-extractor in testing to determine public API changes

    • Type: Icon: Improvement Improvement
    • Resolution: Unresolved
    • Priority: Icon: Minor - P4 Minor - P4
    • None
    • Affects Version/s: None
    • Component/s: Tooling

      Description

      api-extractor can generate a detailed programatic description of our Driver APIs. We should utilize this in testing to assert and get checks on known changes to our public API. Essentially we can diff the current and new API before a release to determine exact changes.

      Open Qs

      • Can this combine with coverage, somehow proving the public API is completely covered by enumerating possible options to every operation?
      • We can likely use api-extractor to protect against cross repo breakages. It's intention is to manage types that are cross packages, if crypt depends on something in the driver, it can be tested that it doesn't change (at least at the TS level).

            Assignee:
            Unassigned Unassigned
            Reporter:
            neal.beeken@mongodb.com Neal Beeken
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated: