Update logging references in DaprClient

shubham1172 · shubham1172 · commit b34af28a22df · 2022-06-07T12:22:21.000+05:30
Signed-off-by: Shubham Sharma &lt;shubhash@microsoft.com&gt;
diff --git a/src/implementation/Client/DaprClient.ts b/src/implementation/Client/DaprClient.ts
@@ -50,12 +50,14 @@ import HTTPClient from './HTTPClient/HTTPClient';
 import CommunicationProtocolEnum from '../../enum/CommunicationProtocol.enum';
 import { DaprClientOptions } from '../../types/DaprClientOptions';
 import { Settings } from '../../utils/Settings.util';
+import { Logger } from '../../logger/Logger';
 
 export default class DaprClient {
   readonly daprHost: string;
   readonly daprPort: string;
   readonly options: DaprClientOptions;
   readonly communicationProtocol: CommunicationProtocolEnum;
+  readonly logger: Logger;
 
   readonly daprClient: IClient;
   readonly pubsub: IClientPubSub;
@@ -74,13 +76,14 @@ export default class DaprClient {
     , daprPort?: string
     , communicationProtocol: CommunicationProtocolEnum = CommunicationProtocolEnum.HTTP
     , options: DaprClientOptions = {
-      isKeepAlive: true
-    }
+      isKeepAlive: true,
+    },
   ) {
     this.daprHost = daprHost ?? Settings.getDefaultHost();
     this.daprPort = daprPort ?? Settings.getDefaultPort(communicationProtocol);
     this.communicationProtocol = communicationProtocol;
     this.options = options;
+    this.logger = new Logger(this.options.loggerOptions);
 
     // Validation on port
     if (!/^[0-9]+$/.test(this.daprPort)) {
@@ -90,11 +93,11 @@ export default class DaprClient {
     // Builder
     switch (communicationProtocol) {
       case CommunicationProtocolEnum.GRPC: {
-        const client = new GRPCClient(this.daprHost, this.daprPort, this.options);
+        const client = new GRPCClient(this.daprHost, this.daprPort, this.options, this.logger);
         this.daprClient = client;
 
         this.state = new GRPCClientState(client);
-        this.pubsub = new GRPCClientPubSub(client);
+        this.pubsub = new GRPCClientPubSub(client, this.logger);
         this.binding = new GRPCClientBinding(client);
         this.invoker = new GRPCClientInvoker(client);
         this.secret = new GRPCClientSecret(client);
@@ -107,11 +110,11 @@ export default class DaprClient {
       }
       case CommunicationProtocolEnum.HTTP:
       default: {
-        const client = new HTTPClient(this.daprHost, this.daprPort, this.options);
+        const client = new HTTPClient(this.daprHost, this.daprPort, this.options, this.logger);
         this.daprClient = client;
 
         this.state = new HTTPClientState(client);
-        this.pubsub = new HTTPClientPubSub(client);
+        this.pubsub = new HTTPClientPubSub(client, this.logger);
         this.binding = new HTTPClientBinding(client);
         this.invoker = new HTTPClientInvoker(client);
         this.secret = new HTTPClientSecret(client);
diff --git a/src/implementation/Client/GRPCClient/GRPCClient.ts b/src/implementation/Client/GRPCClient/GRPCClient.ts
@@ -18,27 +18,34 @@ import IClient from "../../../interfaces/Client/IClient";
 import CommunicationProtocolEnum from "../../../enum/CommunicationProtocol.enum";
 import { DaprClientOptions } from "../../../types/DaprClientOptions";
 import { Settings } from '../../../utils/Settings.util';
+import { Logger } from "../../../logger/Logger";
 
 export default class GRPCClient implements IClient {
   private readonly client: DaprClient;
   private readonly clientCredentials: grpc.ChannelCredentials;
   private readonly clientHost: string;
   private readonly clientPort: string;
   private readonly options: DaprClientOptions;
+  private readonly logger: Logger;
+
+  private readonly LOG_COMPONENT: string = "GRPCClient";
+  private readonly LOG_AREA: string = "GRPCClient";
 
   constructor(
     host = Settings.getDefaultHost()
     , port = Settings.getDefaultGrpcPort()
     , options: DaprClientOptions = {
       isKeepAlive: true
-    }
+    },
+    logger: Logger,
   ) {
     this.clientHost = host;
     this.clientPort = port;
     this.clientCredentials = ChannelCredentials.createInsecure();
     this.options = options;
+    this.logger = logger;
 
-    console.log(`[Dapr-JS][gRPC] Opening connection to ${this.clientHost}:${this.clientPort}`);
+    this.logger.info(this.LOG_COMPONENT, this.LOG_AREA,`Opening connection to ${this.clientHost}:${this.clientPort}`);
     this.client = new DaprClient(`${this.clientHost}:${this.clientPort}`, this.clientCredentials);
   }
 
diff --git a/src/implementation/Client/GRPCClient/pubsub.ts b/src/implementation/Client/GRPCClient/pubsub.ts
@@ -14,13 +14,19 @@ limitations under the License.
 import GRPCClient from './GRPCClient';
 import { PublishEventRequest } from "../../../proto/dapr/proto/runtime/v1/dapr_pb";
 import IClientPubSub from "../../../interfaces/Client/IClientPubSub";
+import { Logger } from '../../../logger/Logger';
 
 // https://docs.dapr.io/reference/api/pubsub_api/
 export default class GRPCClientPubSub implements IClientPubSub {
   client: GRPCClient;
+  
+  private readonly logger: Logger;
+  private readonly LOG_COMPONENT: string = "GRPCClient";
+  private readonly LOG_AREA: string = "PubSub";
 
-  constructor(client: GRPCClient) {
+  constructor(client: GRPCClient, logger: Logger) {
     this.client = client;
+    this.logger = logger;
   }
 
   // @todo: should return a specific typed Promise<TypePubSubPublishResponse> instead of Promise<any>
@@ -34,7 +40,7 @@ export default class GRPCClientPubSub implements IClientPubSub {
       const client = this.client.getClient();
       client.publishEvent(msgService, (err, _res) => {
         if (err) {
-          console.error(err);
+          this.logger.error(this.LOG_COMPONENT, this.LOG_AREA, `publish failed: ${err}`);
           return reject(false);
         }
 
diff --git a/src/implementation/Client/HTTPClient/HTTPClient.ts b/src/implementation/Client/HTTPClient/HTTPClient.ts
@@ -18,27 +18,34 @@ import http from "http";
 import https from "https";
 import { DaprClientOptions } from "../../../types/DaprClientOptions";
 import { Settings } from '../../../utils/Settings.util';
+import { Logger } from "../../../logger/Logger";
 
 export default class HTTPClient implements IClient {
   private client: typeof fetch;
   private readonly clientHost: string;
   private readonly clientPort: string;
   private readonly clientUrl: string;
   private readonly options: DaprClientOptions;
+  private readonly logger: Logger;
 
   private readonly httpAgent;
   private readonly httpsAgent;
 
+  private readonly LOG_COMPONENT: string = "HTTPClient";
+  private readonly LOG_AREA: string = "HTTPClient";
+
   constructor(
     host = Settings.getDefaultHost()
     , port = Settings.getDefaultHttpPort()
     , options: DaprClientOptions = {
       isKeepAlive: true
-    }
+    },
+    logger: Logger,
   ) {
     this.clientHost = host;
     this.clientPort = port;
     this.options = options;
+    this.logger = logger;
 
     if (!this.clientHost.startsWith('http://') && !this.clientHost.startsWith('https://')) {
       this.clientUrl = `http://${this.clientHost}:${this.clientPort}/v1.0`;
@@ -109,7 +116,7 @@ export default class HTTPClient implements IClient {
           params.headers["Content-Type"] = "text/plain";
           break;
         default:
-          console.log(`Unknown body type: ${typeof params?.body}, defaulting to "text/plain"`);
+          this.logger.warn(this.LOG_COMPONENT, this.LOG_AREA, `Unknown body type: ${typeof params?.body}, defaulting to "text/plain"`);
           params.headers["Content-Type"] = "text/plain";
           break;
       }
@@ -120,7 +127,7 @@ export default class HTTPClient implements IClient {
     const agent = urlFull.startsWith("https") ? this.httpsAgent : this.httpAgent;
     params.agent = agent;
 
-    // console.log(`${params.method} - ${urlFull} (${params.body})`);
+    this.logger.debug(this.LOG_COMPONENT, this.LOG_AREA, `Fetching ${params.method} ${urlFull} with body: (${params.body})`);
     const res = await fetch(urlFull, params);
 
     // Parse body
@@ -151,7 +158,7 @@ export default class HTTPClient implements IClient {
     }
     // All the others
     else {
-      console.log(txtParsed);
+      this.logger.debug(this.LOG_COMPONENT, this.LOG_AREA, "Response text: %s", txtParsed);
       throw new Error(JSON.stringify({
         error: "UNKNOWN",
         error_msg: `An unknown problem occured and we got the status ${res.status} with response ${JSON.stringify(res)}`
diff --git a/src/implementation/Client/HTTPClient/pubsub.ts b/src/implementation/Client/HTTPClient/pubsub.ts
@@ -13,13 +13,18 @@ limitations under the License.
 
 import HTTPClient from './HTTPClient';
 import IClientPubSub from '../../../interfaces/Client/IClientPubSub';
+import { Logger } from '../../../logger/Logger';
 
 // https://docs.dapr.io/reference/api/pubsub_api/
 export default class HTTPClientPubSub implements IClientPubSub {
   client: HTTPClient;
+  private readonly logger: Logger;
+  private readonly LOG_COMPONENT: string = "HTTPClient";
+  private readonly LOG_AREA: string = "PubSub";
 
-  constructor(client: HTTPClient) {
+  constructor(client: HTTPClient, logger: Logger) {
     this.client = client;
+    this.logger = logger;
   }
 
   async publish(pubSubName: string, topic: string, data: object = {}): Promise<boolean> {
@@ -31,8 +36,8 @@ export default class HTTPClientPubSub implements IClientPubSub {
         },
         body: JSON.stringify(data),
       });
-    } catch (e) {
-      console.error(e);
+    } catch (e: any) {
+      this.logger.error(this.LOG_COMPONENT, this.LOG_AREA, `publish failed: ${e}`);
       return false;
     }
 
diff --git a/src/interfaces/Client/IClient.ts b/src/interfaces/Client/IClient.ts
@@ -13,6 +13,7 @@ limitations under the License.
 
 import CommunicationProtocolEnum from "../../enum/CommunicationProtocol.enum";
 import { DaprClientOptions } from "../../types/DaprClientOptions";
+import { LoggerOptions } from "../../types/logger/LoggerOptions";
 
 export default interface IClient {
   getClient(): any; // dependent on implementation
diff --git a/src/types/DaprClientOptions.ts b/src/types/DaprClientOptions.ts
@@ -11,6 +11,9 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+import { LoggerOptions } from "./logger/LoggerOptions";
+
 export type DaprClientOptions = {
   isKeepAlive: boolean;
+  loggerOptions?: LoggerOptions;
 }

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,9 @@ See the License for the specific language governing permissions and`
`11`	`11`	`limitations under the License.`
`12`	`12`	`*/`
`13`	`13`
	`14`	`+import { LoggerOptions } from "./logger/LoggerOptions";`
	`15`	`+`
`14`	`16`	`export type DaprClientOptions = {`
`15`	`17`	`isKeepAlive: boolean;`
	`18`	`+ loggerOptions?: LoggerOptions;`
`16`	`19`	`}`