fix: Update engines to prevent agent from being used with versions of…

… Node.js where v8 profilers have memory leaks (#699)

.github/sync-repo-settings.yaml

@@ -35,7 +35,6 @@ branchProtectionRules:
     - "docs"
     - "lint"
     - "test (10)"
-    - "test (12)"
-    - "test (13)"
+    - "test (12.15)"
     - "windows"
     - "system-test"

.github/workflows/ci.yaml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: [10, 12, 13]
+        node: [10, 12.15]
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v1
@@ -31,7 +31,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v1
         with:
-          node-version: 12
+          node-version: 12.15
       - run: npm install
       - run: npm test
       - name: coverage
@@ -45,7 +45,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v1
         with:
-          node-version: 12
+          node-version: 12.15
       - run: npm install
       - run: npm run lint
   docs:
@@ -54,7 +54,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v1
         with:
-          node-version: 12
+          node-version: 12.15
       - run: npm install
       - run: npm run docs-test
   system-test:
@@ -63,7 +63,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v1
         with:
-          node-version: 12
+          node-version: 12.15
       - run: npm install
       - run: npm run system-test
       - name: coverage

README.md

@@ -56,12 +56,17 @@ npm install @google-cloud/profiler
 
 ### Prerequisites
 
-1. Your application will need to be using Node.js 10.4.1 or greater or Node.js
-12. The profiler will not be enabled when using earlier versions of 10 because
-versions of Node.js 10 prior to 10.4.1 are impacted by
-[this](https://bugs.chromium.org/p/chromium/issues/detail?id=847863) issue,
-which can cause garbage collection to take several minutes when heap profiling
-is enabled.
+1. Your application will need to be using Node.js 10.4.1 or greater on the 10.x
+ version branch or Node.js 12.15.0 or lower on the 12.x version branch. The 
+ profiler will not be enabled when using version prior to 10.4.1 or after 
+ 12.15.0. This is because:
+ * Versions of Node.js 10 prior to 10.4.1 are impacted by
+   [this](https://bugs.chromium.org/p/chromium/issues/detail?id=847863) issue,
+   which can cause garbage collection to take several minutes when heap 
+   profiling is enabled.
+ * Versions of Node.js 12 after 12.15.0 are impacted by 
+   [this memory leak](https://bugs.chromium.org/p/v8/issues/detail?id=10883)
+   when profiling is enabled.
 
 1. `@google-cloud/profiler` depends on the
 [`pprof`](https://www.npmjs.com/package/pprof) module, a module with a native

package.json

@@ -84,6 +84,6 @@
     ]
   },
   "engines": {
-    "node": ">=10.4.1"
+    "node": ">=10.4.1 <=12.15.0"
   }
 }

system-test/integration_test.go

@@ -276,7 +276,7 @@ func TestAgentIntegration(t *testing.T) {
 			},
 			name:          fmt.Sprintf("profiler-test-node12-%s-gce", runID),
 			wantProfiles:  wantProfiles,
-			nodeVersion:   "12",
+			nodeVersion:   "12.15",
 			timeout:       gceTestTimeout,
 			benchDuration: gceBenchDuration,
 		},
@@ -289,7 +289,7 @@ func TestAgentIntegration(t *testing.T) {
 			},
 			name:          fmt.Sprintf("profiler-test-node13-%s-gce", runID),
 			wantProfiles:  wantProfiles,
-			nodeVersion:   "12",
+			nodeVersion:   "12.15",
 			timeout:       gceTestTimeout,
 			benchDuration: gceBenchDuration,
 		},
@@ -310,7 +310,7 @@ func TestAgentIntegration(t *testing.T) {
 				},
 				name:          fmt.Sprintf("profiler-backoff-test-node12-%s", runID),
 				backoffTest:   true,
-				nodeVersion:   "12",
+				nodeVersion:   "12.15",
 				timeout:       backoffTestTimeout,
 				benchDuration: backoffBenchDuration,
 			})

test/test-init-config.ts

@@ -40,6 +40,18 @@ describe('nodeVersionOkay', () => {
   it('should not accept v10.4.0', () => {
     assert.strictEqual(false, nodeVersionOkay('v10.4.0'));
   });
+  it('should accept v12.15.0', () => {
+    assert.strictEqual(true, nodeVersionOkay('v12.15.0'));
+  });
+  it('should not accept v12.16.0', () => {
+    assert.strictEqual(false, nodeVersionOkay('v12.16.0'));
+  });
+  it('should not accept v14.0.0', () => {
+    assert.strictEqual(false, nodeVersionOkay('v14.0.0'));
+  });
+  it('should not accept v14.13.0', () => {
+    assert.strictEqual(false, nodeVersionOkay('v14.13.0'));
+  });
 });
 
 describe('createProfiler', () => {