feat(NODE-4899)!: support only snappy 7 or later (#3491)

Co-authored-by: Durran Jordan <durran@gmail.com>
mongodb · Dec 21, 2022 · 21db1a9 · 21db1a9
1 parent e5b67f3
commit 21db1a9
Show file tree

Hide file tree

Showing 16 changed files with 645 additions and 315 deletions.
diff --git a/.evergreen/config.in.yml b/.evergreen/config.in.yml
@@ -798,18 +798,6 @@ functions:
 
           bash ${PROJECT_DIRECTORY}/.evergreen/run-custom-csfle-tests.sh
 
-  "run custom snappy tests":
-    - command: subprocess.exec
-      params:
-        working_dir: "src"
-        timeout_secs: 60
-        env:
-          MONGODB_URI: ${MONGODB_URI}
-          PROJECT_DIRECTORY: ${PROJECT_DIRECTORY}
-        binary: bash
-        args:
-          - "${PROJECT_DIRECTORY}/.evergreen/run-snappy-version-test.sh"
-
   "run lambda handler example tests":
     - command: subprocess.exec
       params:

diff --git a/.evergreen/config.yml b/.evergreen/config.yml
@@ -758,17 +758,6 @@ functions:
           echo "CRYPT_SHARED_LIB_PATH: $CRYPT_SHARED_LIB_PATH"
 
           bash ${PROJECT_DIRECTORY}/.evergreen/run-custom-csfle-tests.sh
-  run custom snappy tests:
-    - command: subprocess.exec
-      params:
-        working_dir: src
-        timeout_secs: 60
-        env:
-          MONGODB_URI: ${MONGODB_URI}
-          PROJECT_DIRECTORY: ${PROJECT_DIRECTORY}
-        binary: bash
-        args:
-          - ${PROJECT_DIRECTORY}/.evergreen/run-snappy-version-test.sh
   run lambda handler example tests:
     - command: subprocess.exec
       params:
@@ -2142,20 +2131,6 @@ tasks:
         variant: '*'
         status: '*'
         patch_optional: true
-  - name: run-custom-snappy-tests
-    tags:
-      - run-custom-dependency-tests
-    commands:
-      - func: install dependencies
-        vars:
-          NODE_LTS_NAME: erbium
-      - func: bootstrap mongo-orchestration
-        vars:
-          VERSION: '5.0'
-          TOPOLOGY: server
-          AUTH: auth
-      - name: run-custom-snappy-tests
-        func: run custom snappy tests
   - name: run-bson-ext-integration
     tags:
       - run-custom-dependency-tests
@@ -3175,7 +3150,6 @@ buildvariants:
     display_name: Custom Dependency Version Test
     run_on: rhel80-large
     tasks:
-      - run-custom-snappy-tests
       - run-bson-ext-integration
       - run-bson-ext-unit
       - run-custom-csfle-tests-5.0-pinned-commit

diff --git a/.evergreen/generate_evergreen_tasks.js b/.evergreen/generate_evergreen_tasks.js
@@ -578,10 +578,6 @@ BUILD_VARIANTS.push({
 });
 
 const oneOffFuncs = [
-  {
-    name: 'run-custom-snappy-tests',
-    func: 'run custom snappy tests'
-  },
   {
     name: 'run-bson-ext-integration',
     func: 'run bson-ext test',

diff --git a/.evergreen/run-snappy-version-test.sh b/.evergreen/run-snappy-version-test.sh
diff --git a/.github/workflows/dependencies.yml b/.github/workflows/dependencies.yml
@@ -22,5 +22,5 @@ jobs:
       with:
         node-version: ${{ matrix.node-version }}
         cache: 'npm'
-    - run: npm install
+    - run: npm clean-install
     - run: npm run check:dependencies
diff --git a/etc/notes/CHANGES_5.0.0.md b/etc/notes/CHANGES_5.0.0.md
@@ -0,0 +1,26 @@
+# Changes in v5
+
+## TOC
+
+- TODO
+
+## About
+
+The following is a detailed collection of the changes in the major v5 release of the mongodb package for Node.js.
+
+<!--
+1. a brief statement of what is breaking (brief as in "x will now return y instead of z", or "x is no longer supported, use y instead", etc
+2. a brief statement of why we are breaking it (bug, not useful, inconsistent behavior, better alternative, etc)
+3. if applicable, an example of suggested syntax change (can be included in (1) )
+-->
+
+## Changes
+
+### Snappy v7.x.x or later and optional peerDependency
+
+`snappy` compression has been added to the package.json as a peerDependency that is **optional**.
+This means `npm` will let you know if the version of snappy you have installed is incompatible with the driver.
+
+```sh
+npm install --save snappy@7
+```