Uploaded image for project: 'Node.js Driver'
  1. Node.js Driver
  2. NODE-6538 Rewrite mongodb-js/zstd in C++
  3. NODE-6539

Create barebones C++ node-addon-api package in mongodb-js/zstd

    • Type: Icon: Sub-task Sub-task
    • Resolution: Fixed
    • Priority: Icon: Unknown Unknown
    • zstd-2.0.0
    • Affects Version/s: None
    • Component/s: None
    • 0
    • Not Needed
    • Not Needed

      Use Case

      As a zstd package developer,
      I want a basic C++ addon template to use build the new C++ compression logic in that contains all the standard addon tooling,
      So that development of the C++ logic is easy and reviews are easier.

      User Experience

      • What is the desired/expected outcome for the user once this ticket is implemented?
      • If bug: What is the number of impacted customers? How severe is the impact? Is anyone blocked or broken?

      Dependencies

      • upstream and/or downstream requirements and timelines to bear in mind

      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

      • Add barebones napi + node-gyp package
      • Add an ubuntu Github action that compiles the addon 
        • This ensures that subtask 2 has a place to run tests in CI before filling out the full CI matrix
      • Add standard Node driver tooling to the repo
      • Eslint + configuration
      • Prettier + configuration
      • Clang-format + configuration
      • Mocha + configuration

      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:
            bailey.pearson@mongodb.com Bailey Pearson
            Reporter:
            bailey.pearson@mongodb.com Bailey Pearson
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: