fix: extend supported gRPC version range to 1.7 (googleapis#586)

Fixes googleapis#585
BenCrux · Oct 31, 2017 · 3e30d28 · 3e30d28
1 parent 45e78c9
commit 3e30d28
Show file tree

Hide file tree

Showing 8 changed files with 60 additions and 20 deletions.
diff --git a/src/plugins/plugin-grpc.ts b/src/plugins/plugin-grpc.ts
@@ -32,6 +32,11 @@ function patchMetadata(metadata, api) {
   Metadata = metadata;
 }
 
+function unpatchMetadata(metadata) {
+  // patchMetadata doesn't modify the module exports of metadata.js.
+  // So it's safe to provide a no-op unpatch function.
+}
+
 function patchClient(client, api) {
   /**
    * Wraps a callback so that the current span for this trace is also ended when
@@ -469,26 +474,40 @@ function unpatchServer(server) {
 
 // # Exports
 
-var SUPPORTED_VERSIONS = '0.13 - 1';
-
 module.exports = [
   {
     file: 'src/node/src/client.js',
-    versions: SUPPORTED_VERSIONS,
+    versions: '0.13 - 1.6',
     patch: patchClient,
     unpatch: unpatchClient
   },
   {
     file: 'src/node/src/metadata.js',
-    versions: SUPPORTED_VERSIONS,
+    versions: '0.13 - 1.6',
     patch: patchMetadata,
-    // patchMetadata doesn't modify the module exports of metadata.js.
-    // So it's safe to have provide a no-op unpatch function.
-    unpatch: function unpatchMetadata() {}
+    unpatch: unpatchMetadata
   },
   {
     file: 'src/node/src/server.js',
-    versions: SUPPORTED_VERSIONS,
+    versions: '0.13 - 1.6',
+    patch: patchServer,
+    unpatch: unpatchServer
+  },
+  {
+    file: 'src/client.js',
+    versions: '1.7',
+    patch: patchClient,
+    unpatch: unpatchClient
+  },
+  {
+    file: 'src/metadata.js',
+    versions: '1.7',
+    patch: patchMetadata,
+    unpatch: unpatchMetadata
+  },
+  {
+    file: 'src/server.js',
+    versions: '1.7',
     patch: patchServer,
     unpatch: unpatchServer
   }

diff --git a/src/trace-plugin-loader.ts b/src/trace-plugin-loader.ts
@@ -165,6 +165,14 @@ export function activate(logger: Logger, config: PluginLoaderConfig): void {
                 originalModuleLoad(instrumentation.file, module, false);
             patchSet = {};
             if (semver.valid(version)) {
+              // strip version of pre-release tags.
+              // warn if they exist.
+              if (!!semver.prerelease(version)) {
+                const originalVersion = version;
+                version = version.split('-')[0];
+                logger.warn(`${moduleRoot}: Using patch for version ${
+                    version} for pre-release version ${originalVersion}`);
+              }
               plugin.forEach((patch) => {
                 if (!patch.versions ||
                     semver.satisfies(version, patch.versions)) {

diff --git a/test/plugins/fixtures/grpc1/index.js → test/plugins/fixtures/grpc1.6/index.js b/test/plugins/fixtures/grpc1/index.js → test/plugins/fixtures/grpc1.6/index.js
diff --git a/test/plugins/fixtures/grpc1/package.json → test/plugins/fixtures/grpc1.6/package.json b/test/plugins/fixtures/grpc1/package.json → test/plugins/fixtures/grpc1.6/package.json
@@ -1,8 +1,8 @@
 {
-  "name": "grpc1",
+  "name": "grpc1.6",
   "version": "1.0.0",
   "main": "index.js",
   "dependencies": {
-    "grpc": "^1.0.0"
+    "grpc": "^1.6.0"
   }
 }
diff --git a/test/plugins/fixtures/grpc1.7/index.js b/test/plugins/fixtures/grpc1.7/index.js
@@ -0,0 +1 @@
+module.exports = require('grpc');
diff --git a/test/plugins/fixtures/grpc1.7/package.json b/test/plugins/fixtures/grpc1.7/package.json
@@ -0,0 +1,8 @@
+{
+  "name": "grpc1.7",
+  "version": "1.0.0",
+  "main": "index.js",
+  "dependencies": {
+    "grpc": "1.7.0-pre1"
+  }
+}
diff --git a/test/plugins/test-trace-grpc.ts b/test/plugins/test-trace-grpc.ts
@@ -26,7 +26,8 @@ var shimmer = require('shimmer');
 var common = require('./common'/*.js*/);
 
 var versions = {
-  grpc1: './fixtures/grpc1'
+  grpc1_6: './fixtures/grpc1.6',
+  grpc1_7: './fixtures/grpc1.7'
 };
 
 var protoFile = __dirname + '/../fixtures/test-grpc.proto';
@@ -281,7 +282,8 @@ Object.keys(versions).forEach(function(version) {
       agent = require('../..').start({
         projectId: '0',
         samplingRate: 0,
-        enhancedDatabaseReporting: true
+        enhancedDatabaseReporting: true,
+        forceNewAgent_: true
       });
 
       grpc = require(versions[version]);

diff --git a/test/test-grpc-context.ts b/test/test-grpc-context.ts
@@ -21,7 +21,8 @@ var assert = require('assert');
 var http = require('http');
 
 var versions = {
-  grpc1: './plugins/fixtures/grpc1'
+  grpc1_6: './plugins/fixtures/grpc1.6',
+  grpc1_7: './plugins/fixtures/grpc1.7'
 };
 
 var grpcPort = 50051;
@@ -48,18 +49,19 @@ function requestAndSendHTTPStatus(res, expectedReqs) {
   }, expectedReqs);
 }
 
+// Trace agent must be started out of the loop over gRPC versions,
+// because express can't be re-patched.
+var agent = require('..').start({
+  projectId: '0',
+  samplingRate: 0
+});
+var express = require('./plugins/fixtures/express4');
+
 Object.keys(versions).forEach(function(version) {
-  var agent;
-  var express;
   var grpc;
   var httpLogCount;
   describe('express + ' + version, function() {
     before(function(done) {
-      agent = require('..').start({
-        projectId: '0',
-        samplingRate: 0
-      });
-      express = require('./plugins/fixtures/express4');
       grpc = require(versions[version]);
 
       common.replaceWarnLogger(function(msg) {