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

Create script to automate linking of a local mongodb-client-encryption from the driver

    • 2
    • Not Needed
    • 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 driver engineer,
      I want a to automate linking and building the libmongocrypt node c++ bindings with the driver,
      So that development of FLE is simpler.

      User Impact

      n/a.  internal tooling change.

      Dependencies

      • none.

      Unknowns

      • none.

      Acceptance Criteria

      Implementation Requirements

      • add a script into etc/tooling that does the following
        • (optional, configured by some sort of flag) builds libmongocrypt statically to link against
        • builds mongodb-client-encryption bindings
        • (optional, configured by some sort of flag) uses `npm link` (or a symlink in the package.json) to link the driver to the libmongocrypt Node bindings locally
          • This step should be optional because a common workflow would be 1) build libmongocrypt 2) build and link bindings to driver 3) make changes to bindings 4) rebuild bindings and run driver's tests. steps 3 & 4 would be repeated during development.
      • add a script that unlinks mongodb-client-encryption from the driver locally

      Testing Requirements

      • Manually verify that the script works.

      Documentation Requirements

      • add a section in the Node driver testing readme explaining how to use the new tooling.

      Follow Up Requirements

      • none

            Assignee:
            bailey.pearson@mongodb.com Bailey Pearson
            Reporter:
            daria.pardue@mongodb.com Daria Pardue
            Warren James
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: