[#256] Refactor gRPC client initialization and remove unused metadata handling

Author: feelform

lib/client/call-arguments-builder.js

@@ -17,10 +17,6 @@ class CallArguments {
         return this.callback
     }
 
-    getMetadata() {
-        return this.metadata
-    }
-
     getOptions() {
         const options = this.options
         if (this.deadlineMilliseconds) {
@@ -40,7 +36,6 @@ class CallArgumentsBuilder {
 
     constructor(callback) {
         this.callback = callback
-        this.metadata = new grpc.Metadata()
         this.options = {}
     }
 
@@ -49,14 +44,8 @@ class CallArgumentsBuilder {
         return this
     }
 
-    setMetadata(key, value) {
-        this.metadata.set(key, value)
-        return this
-    }
-
     build() {
         const callArguments = new CallArguments(this.callback)
-        callArguments.metadata = this.metadata
         callArguments.options = this.options
         callArguments.deadlineMilliseconds = this.deadlineMilliseconds ?? DEFAULT_CLIENT_REQUEST_TIMEOUT
         return callArguments

lib/client/grpc-data-sender.js

@@ -30,8 +30,14 @@ const DEFAULT_AGENT_INFO_REFRESH_INTERVAL_MS = 24 * 60 * 60 * 1000
 class GrpcDataSender {
   constructor(collectorIp, collectorTcpPort, collectorStatPort, collectorSpanPort, agentInfo, config) {
     this.agentInfo = agentInfo
-    this.initializeClients(collectorIp, collectorTcpPort, config)
-    this.initializeMetadataClients(collectorIp, collectorTcpPort, config)
+    this.config = config
+    this.collectorIp = collectorIp
+    this.collectorTcpPort = collectorTcpPort
+    this.collectorStatPort = collectorStatPort
+    this.collectorSpanPort = collectorSpanPort
+
+    this.initializeClients()
+    this.initializeMetadataClients()
     this.initializeSpanStream(collectorIp, collectorSpanPort, config)
     this.initializeStatStream(collectorIp, collectorStatPort, config)
     this.initializePingStream()
@@ -74,27 +80,35 @@ class GrpcDataSender {
     }
   }
 
-  initializeClients(collectorIp, collectorTcpPort, config) {
-    const agentBuilder = new OptionsBuilder()
+  initializeClients() {
+    const agentBuilder = this.agentClientOptionsBuilder()
+
+    if (this.config && this.config.grpcServiceConfig && typeof this.config.grpcServiceConfig.getAgent === 'function') {
+      agentBuilder.setGrpcServiceConfig(this.config.grpcServiceConfig.getAgent())
+    }
+    this.agentClient = new services.AgentClient(this.collectorIp + ":" + this.collectorTcpPort, grpc.credentials.createInsecure(), agentBuilder.build())
+  }
+
+  agentClientOptionsBuilder() {
+    return new OptionsBuilder()
       .addInterceptor(makeAgentInformationMetadataInterceptor(this.agentInfo))
       .addInterceptor(socketIdInterceptor)
       .addInterceptor(grpcBuiltInRetryHeaderInterceptor)
+  }
 
-    if (config && config.grpcServiceConfig && typeof config.grpcServiceConfig.getAgent === 'function') {
-      agentBuilder.setGrpcServiceConfig(config.grpcServiceConfig.getAgent())
+  initializeMetadataClients() {
+    const metadataBuilder = this.metadataClientOptionsBuilder()
+
+    if (this.config && this.config.grpcServiceConfig && typeof this.config.grpcServiceConfig.getMetadata === 'function') {
+      metadataBuilder.setGrpcServiceConfig(this.config.grpcServiceConfig.getMetadata())
     }
-    this.agentClient = new services.AgentClient(collectorIp + ":" + collectorTcpPort, grpc.credentials.createInsecure(), agentBuilder.build())
+    this.metadataClient = new services.MetadataClient(this.collectorIp + ":" + this.collectorTcpPort, grpc.credentials.createInsecure(), metadataBuilder.build())
   }
 
-  initializeMetadataClients(collectorIp, collectorTcpPort, config) {
-    const metadataBuilder = new OptionsBuilder()
+  metadataClientOptionsBuilder() {
+    return new OptionsBuilder()
       .addInterceptor(makeAgentInformationMetadataInterceptor(this.agentInfo))
       .addInterceptor(grpcBuiltInRetryHeaderInterceptor)
-
-    if (config && config.grpcServiceConfig && typeof config.grpcServiceConfig.getMetadata === 'function') {
-      metadataBuilder.setGrpcServiceConfig(config.grpcServiceConfig.getMetadata())
-    }
-    this.metadataClient = new services.MetadataClient(collectorIp + ":" + collectorTcpPort, grpc.credentials.createInsecure(), metadataBuilder.build())
   }
 
   initializeSpanStream(collectorIp, collectorSpanPort, config) {
@@ -188,10 +202,9 @@ class GrpcDataSender {
   makeActiveThreadCountStream(callArguments) {
     this.activeThreadCountStream = new GrpcReadableStream(() => {
       callArguments = guardCallArguments(callArguments)
-      const metadata = callArguments.getMetadata()
       let options = callArguments.getOptions()
       const callback = callArguments.getCallback()
-      return this.profilerClient.commandStreamActiveThreadCount(metadata, options, (err, response) => {
+      return this.profilerClient.commandStreamActiveThreadCount(options, (err, response) => {
         if (err) {
           log.error(err)
         }
@@ -213,10 +226,9 @@ class GrpcDataSender {
     }
 
     callArguments = guardCallArguments(callArguments)
-    const metadata = callArguments.getMetadata()
     let options = callArguments.getOptions()
     const callback = callArguments.getCallback()
-    this.agentClient.requestAgentInfo(pAgentInfo, metadata, options, (err, response) => {
+    this.agentClient.requestAgentInfo(pAgentInfo, options, (err, response) => {
       if (typeof callback === 'function') {
         callback(err, response)
       }
@@ -226,7 +238,7 @@ class GrpcDataSender {
     if (this.agentInfoDailyScheduler) {
       this.removeJobForAgentInfo = this.agentInfoDailyScheduler.addJob(() => {
         options = callArguments.getOptions()
-        this.agentClient.requestAgentInfo(pAgentInfo, metadata, options, (err, response) => {
+        this.agentClient.requestAgentInfo(pAgentInfo, options, (err, response) => {
           if (typeof callback === 'function') {
             callback(err, response)
           }
@@ -243,10 +255,9 @@ class GrpcDataSender {
     }
 
     callArguments = guardCallArguments(callArguments)
-    const metadata = callArguments.getMetadata()
-    let options = callArguments.getOptions()
+    const options = callArguments.getOptions()
     const callback = callArguments.getCallback()
-    this.metadataClient.requestApiMetaData(pApiMetaData, metadata, options, (err, response) => {
+    this.metadataClient.requestApiMetaData(pApiMetaData, options, (err, response) => {
       if (err) {
         log.error(err)
       }
@@ -263,10 +274,9 @@ class GrpcDataSender {
     }
 
     callArguments = guardCallArguments(callArguments)
-    const metadata = callArguments.getMetadata()
     let options = callArguments.getOptions()
     const callback = callArguments.getCallback()
-    this.metadataClient.requestStringMetaData(pStringMetaData, metadata, options, (err, response) => {
+    this.metadataClient.requestStringMetaData(pStringMetaData, options, (err, response) => {
       if (err) {
         log.error(err)
       }
@@ -282,10 +292,9 @@ class GrpcDataSender {
       log.debug(`sendSqlMetaInfo sqlMetaData: ${JSON.stringify(pSqlMetaData.toObject())}`)
     }
     callArguments = guardCallArguments(callArguments)
-    const metadata = callArguments.getMetadata()
     let options = callArguments.getOptions()
     const callback = callArguments.getCallback()
-    this.metadataClient.requestSqlMetaData(pSqlMetaData, metadata, options, (err, response) => {
+    this.metadataClient.requestSqlMetaData(pSqlMetaData, options, (err, response) => {
       if (err) {
         log.error(err)
       }
@@ -301,10 +310,9 @@ class GrpcDataSender {
       log.debug(`sendSqlMetaInfo sqlMetaData: ${JSON.stringify(pSqlMetaData.toObject())}`)
     }
     callArguments = guardCallArguments(callArguments)
-    const metadata = callArguments.getMetadata()
     let options = callArguments.getOptions()
     const callback = callArguments.getCallback()
-    this.metadataClient.requestSqlUidMetaData(pSqlMetaData, metadata, options, (err, response) => {
+    this.metadataClient.requestSqlUidMetaData(pSqlMetaData, options, (err, response) => {
       if (err) {
         log.error(err)
       }
@@ -370,10 +378,9 @@ class GrpcDataSender {
 
   sendCommandEcho(commandEchoResponse, callArguments) {
     callArguments = guardCallArguments(callArguments)
-    const metadata = callArguments.getMetadata()
     let options = callArguments.getOptions()
     const callback = callArguments.getCallback()
-    this.profilerClient.commandEcho(commandEchoResponse, metadata, options, (err, response) => {
+    this.profilerClient.commandEcho(commandEchoResponse, options, (err, response) => {
       if (err) {
         log.error(err)
       }

lib/utils/logger.js

@@ -56,7 +56,7 @@ class Logger {
   }
 
   error() {
-    this.logger.error.apply(null, arguments)
+    this.logger.info.apply(null, arguments)
   }
 }
 

test/client/grpc-data-sender.test.js

@@ -516,6 +516,7 @@ test('sendSupportedServicesCommand and commandEcho', (t) => {
   const server = new grpc.Server()
   server.addService(services.ProfilerCommandServiceService, {
     handleCommandV2: handleCommandV2Service,
+    handleCommand: handleCommandV2Service,
     commandEcho: emptyResponseService
   })
 
@@ -546,6 +547,7 @@ test('CommandStreamActiveThreadCount', (t) => {
   const server = new grpc.Server()
   server.addService(services.ProfilerCommandServiceService, {
     handleCommandV2: handleCommandV2Service,
+    handleCommand: handleCommandV2Service,
     commandEcho: emptyResponseService,
     commandStreamActiveThreadCount: emptyResponseService
   })