[Service Bus] Linting error fixes (Azure#13935)

Author: ramya-rao-a

sdk/servicebus/service-bus/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+  "plugins": ["@azure/azure-sdk"],
+  "extends": ["plugin:@azure/azure-sdk/azure-sdk-base"],
+  "ignorePatterns": ["test/perf/track-1", "test/perf-js-libs", "test/stress"]
+}

sdk/servicebus/service-bus/review/service-bus.api.md

@@ -140,7 +140,7 @@ export interface GetMessageIteratorOptions extends OperationOptionsBase {
 }
 
 // @public
-export function isServiceBusError(err: any): err is ServiceBusError;
+export function isServiceBusError(err: unknown): err is ServiceBusError;
 
 // @public
 export interface MessageHandlers {

sdk/servicebus/service-bus/src/connectionContext.ts

@@ -432,7 +432,7 @@ export namespace ConnectionContext {
         //  ...What to do for sessions (connectionContext.messageSessions) ??
       }
 
-      await refreshConnection(connectionContext);
+      await refreshConnection();
       waitForConnectionRefreshResolve();
       waitForConnectionRefreshPromise = undefined;
       // The connection should always be brought back up if the sdk did not call connection.close()
@@ -494,10 +494,10 @@ export namespace ConnectionContext {
       }
     };
 
-    async function refreshConnection(connectionContext: ConnectionContext): Promise<void> {
+    async function refreshConnection(): Promise<void> {
       const originalConnectionId = connectionContext.connectionId;
       try {
-        await cleanConnectionContext(connectionContext);
+        await cleanConnectionContext();
       } catch (err) {
         logger.logError(
           err,
@@ -520,7 +520,7 @@ export namespace ConnectionContext {
       connection.on(ConnectionEvents.error, error);
     }
 
-    async function cleanConnectionContext(connectionContext: ConnectionContext) {
+    async function cleanConnectionContext() {
       // Remove listeners from the connection object.
       connectionContext.connection.removeListener(
         ConnectionEvents.connectionOpen,

sdk/servicebus/service-bus/src/core/batchingReceiver.ts

@@ -50,11 +50,15 @@ export class BatchingReceiver extends MessageReceiver {
           onSessionError: (context) => {
             lastError = context?.session?.error;
           },
-          // ignored for now - the next call will just fail so they'll get an appropriate error from somewhere else.
-          onClose: async () => {},
-          onSessionClose: async () => {},
-          // we don't add credits initially so we don't need to worry about handling any messages.
-          onMessage: async () => {}
+          onClose: async () => {
+            /** Nothing to do here - the next call will just fail so they'll get an appropriate error from somewhere else. */
+          },
+          onSessionClose: async () => {
+            /** Nothing to do here - the next call will just fail so they'll get an appropriate error from somewhere else. */
+          },
+          onMessage: async () => {
+            /** Nothing to do here -  we don't add credits initially so we don't need to worry about handling any messages.*/
+          }
         });
 
         await this._init(rcvrOptions, abortSignal);

sdk/servicebus/service-bus/src/core/managementClient.ts

@@ -49,6 +49,7 @@ import { AbortSignalLike } from "@azure/abort-controller";
 import { ReceiveMode } from "../models";
 import { translateServiceBusError } from "../serviceBusError";
 import { defaultDataTransformer } from "../dataTransformer";
+import { isDefined, isObjectWithProperties } from "../util/typeGuards";
 
 /**
  * @internal
@@ -248,16 +249,17 @@ export class ManagementClient extends LinkEntity<RequestResponseLink> {
         abortSignal
       );
     } catch (err) {
-      err = translateServiceBusError(err);
+      const translatedError = translateServiceBusError(err);
       managementClientLogger.logError(
-        err,
+        translatedError,
         `${this.logPrefix} An error occurred while establishing the $management links`
       );
-      throw err;
+      throw translatedError;
     }
   }
 
   protected async createRheaLink(
+    // eslint-disable-next-line @azure/azure-sdk/ts-naming-options
     options: RequestResponseLinkOptions
   ): Promise<RequestResponseLink> {
     const rheaLink = await RequestResponseLink.create(
@@ -294,13 +296,13 @@ export class ManagementClient extends LinkEntity<RequestResponseLink> {
     internalLogger: ServiceBusLogger,
     sendRequestOptions: SendManagementRequestOptions = {}
   ): Promise<RheaMessage> {
-    if (request.message_id == undefined) {
+    if (request.message_id === undefined) {
       request.message_id = generate_uuid();
     }
     const retryTimeoutInMs =
       sendRequestOptions.timeoutInMs ?? Constants.defaultOperationTimeoutInMs;
     const initOperationStartTime = Date.now();
-    const actionAfterTimeout = (reject: (reason?: any) => void) => {
+    const actionAfterTimeout = (reject: (reason?: any) => void): void => {
       const desc: string = `The request with message_id "${request.message_id}" timed out. Please try again later.`;
       const e: Error = {
         name: "OperationTimeoutError",
@@ -333,16 +335,14 @@ export class ManagementClient extends LinkEntity<RequestResponseLink> {
       if (!request.message_id) request.message_id = generate_uuid();
       return await this.link!.sendRequest(request, sendRequestOptions);
     } catch (err) {
-      err = translateServiceBusError(err);
+      const translatedError = translateServiceBusError(err);
       internalLogger.logError(
-        err,
-        "%s An error occurred during send on management request-response link with address " +
-          "'%s': %O",
+        translatedError,
+        "%s An error occurred during send on management request-response link with address '%s'",
         this.logPrefix,
-        this.address,
-        err
+        this.address
       );
-      throw err;
+      throw translatedError;
     }
   }
 
@@ -463,7 +463,7 @@ export class ManagementClient extends LinkEntity<RequestResponseLink> {
         Buffer.from(fromSequenceNumber.toBytesBE())
       );
       messageBody[Constants.messageCount] = types.wrap_int(maxMessageCount!);
-      if (sessionId != undefined) {
+      if (isDefined(sessionId)) {
         messageBody[Constants.sessionIdMapKey] = sessionId;
       }
       const request: RheaMessage = {
@@ -525,6 +525,7 @@ export class ManagementClient extends LinkEntity<RequestResponseLink> {
    * @param options - Options that can be set while sending the request.
    * @returns New lock token expiry date and time in UTC format.
    */
+  // eslint-disable-next-line @azure/azure-sdk/ts-naming-options
   async renewLock(lockToken: string, options?: SendManagementRequestOptions): Promise<Date> {
     throwErrorIfConnectionClosed(this._context);
     if (!options) options = {};
@@ -945,7 +946,7 @@ export class ManagementClient extends LinkEntity<RequestResponseLink> {
    */
   async setSessionState(
     sessionId: string,
-    state: any,
+    state: unknown,
     options?: OperationOptionsBase & SendManagementRequestOptions
   ): Promise<void> {
     throwErrorIfConnectionClosed(this._context);
@@ -1255,7 +1256,9 @@ export class ManagementClient extends LinkEntity<RequestResponseLink> {
     if (
       typeof filter !== "boolean" &&
       typeof filter !== "string" &&
-      !correlationProperties.some((validProperty) => filter.hasOwnProperty(validProperty))
+      !correlationProperties.some((validProperty) =>
+        isObjectWithProperties(filter, [validProperty])
+      )
     ) {
       throw new TypeError(
         `The parameter "filter" should be either a boolean, string or implement the CorrelationRuleFilter interface.`

sdk/servicebus/service-bus/src/core/messageReceiver.ts

@@ -191,15 +191,20 @@ export abstract class MessageReceiver extends LinkEntity<Receiver> {
       // Thus make sure that the receiver is present in the client cache.
       this._context.messageReceivers[this.name] = this as any;
     } catch (err) {
-      err = translateServiceBusError(err);
-      logger.logError(err, "%s An error occured while creating the receiver", this.logPrefix);
+      const translatedError = translateServiceBusError(err);
+      logger.logError(
+        translatedError,
+        "%s An error occured while creating the receiver",
+        this.logPrefix
+      );
 
       // Fix the unhelpful error messages for the OperationTimeoutError that comes from `rhea-promise`.
-      if ((err as MessagingError).code === "OperationTimeoutError") {
-        err.message = "Failed to create a receiver within allocated time and retry attempts.";
+      if ((translatedError as MessagingError).code === "OperationTimeoutError") {
+        translatedError.message =
+          "Failed to create a receiver within allocated time and retry attempts.";
       }
 
-      throw err;
+      throw translatedError;
     }
   }
 

sdk/servicebus/service-bus/src/core/messageSender.ts

@@ -37,6 +37,7 @@ import { OperationOptionsBase } from "../modelsToBeSharedWithEventHubs";
 import { AbortSignalLike } from "@azure/abort-controller";
 import { translateServiceBusError } from "../serviceBusError";
 import { defaultDataTransformer } from "../dataTransformer";
+import { isDefined } from "../util/typeGuards";
 
 /**
  * @internal
@@ -169,10 +170,9 @@ export class MessageSender extends LinkEntity<AwaitableSender> {
     options: OperationOptionsBase | undefined
   ): Promise<void> {
     const abortSignal = options?.abortSignal;
-    const timeoutInMs =
-      this._retryOptions.timeoutInMs == undefined
-        ? Constants.defaultOperationTimeoutInMs
-        : this._retryOptions.timeoutInMs;
+    const timeoutInMs = !isDefined(this._retryOptions.timeoutInMs)
+      ? Constants.defaultOperationTimeoutInMs
+      : this._retryOptions.timeoutInMs;
 
     const sendEventPromise = async (): Promise<void> => {
       const initStartTime = Date.now();
@@ -188,14 +188,14 @@ export class MessageSender extends LinkEntity<AwaitableSender> {
               `to operation timeout.`
           });
         } catch (err) {
-          err = translateServiceBusError(err);
+          const translatedError = translateServiceBusError(err);
           logger.logError(
-            err,
+            translatedError,
             "%s An error occurred while creating the sender",
             this.logPrefix,
             this.name
           );
-          throw err;
+          throw translatedError;
         }
       }
 
@@ -271,9 +271,12 @@ export class MessageSender extends LinkEntity<AwaitableSender> {
           delivery.id
         );
       } catch (error) {
-        error = translateServiceBusError(error.innerError || error);
-        logger.logError(error, `${this.logPrefix} An error occurred while sending the message`);
-        throw error;
+        const translatedError = translateServiceBusError(error.innerError || error);
+        logger.logError(
+          translatedError,
+          `${this.logPrefix} An error occurred while sending the message`
+        );
+        throw translatedError;
       }
     };
     const config: RetryConfig<void> = {
@@ -306,13 +309,17 @@ export class MessageSender extends LinkEntity<AwaitableSender> {
       }
       await this.initLink(options, abortSignal);
     } catch (err) {
-      err = translateServiceBusError(err);
-      logger.logError(err, `${this.logPrefix} An error occurred while creating the sender`);
+      const translatedError = translateServiceBusError(err);
+      logger.logError(
+        translatedError,
+        `${this.logPrefix} An error occurred while creating the sender`
+      );
       // Fix the unhelpful error messages for the OperationTimeoutError that comes from `rhea-promise`.
-      if ((err as MessagingError).code === "OperationTimeoutError") {
-        err.message = "Failed to create a sender within allocated time and retry attempts.";
+      if ((translatedError as MessagingError).code === "OperationTimeoutError") {
+        translatedError.message =
+          "Failed to create a sender within allocated time and retry attempts.";
       }
-      throw err;
+      throw translatedError;
     }
   }
 

sdk/servicebus/service-bus/src/dataTransformer.ts

@@ -5,6 +5,7 @@ import { message } from "rhea-promise";
 import isBuffer from "is-buffer";
 import { Buffer } from "buffer";
 import { logErrorStackTrace, logger } from "./log";
+import { isObjectWithProperties } from "./util/typeGuards";
 
 /**
  * The default data transformer that will be used by the Azure SDK.
@@ -22,7 +23,7 @@ export const defaultDataTransformer = {
    * - content: The given AMQP message body as a Buffer.
    * - multiple: true | undefined.
    */
-  encode(body: any): any {
+  encode(body: unknown): any {
     let result: any;
     if (isBuffer(body)) {
       result = message.data_section(body);
@@ -55,10 +56,10 @@ export const defaultDataTransformer = {
    * @param body - The AMQP message body
    * @returns decoded body or the given body as-is.
    */
-  decode(body: any): any {
+  decode(body: unknown): any {
     let processedBody: any = body;
     try {
-      if (body.content && isBuffer(body.content)) {
+      if (isObjectWithProperties(body, ["content"]) && isBuffer(body.content)) {
         // This indicates that we are getting the AMQP described type. Let us try decoding it.
         processedBody = body.content;
       }

sdk/servicebus/service-bus/src/log.ts

@@ -3,6 +3,7 @@
 
 import { AzureLogger, createClientLogger } from "@azure/logger";
 import { AmqpError } from "rhea-promise";
+import { isObjectWithProperties } from "./util/typeGuards";
 
 /**
  * The `@azure/logger` configuration for this package.
@@ -52,8 +53,8 @@ export const managementClientLogger = createServiceBusLogger("service-bus:manage
  * @param error - Error containing a stack trace.
  * @internal
  */
-export function logErrorStackTrace(_logger: AzureLogger, error: any): void {
-  if (error && error.stack) {
+export function logErrorStackTrace(_logger: AzureLogger, error: unknown): void {
+  if (isObjectWithProperties(error, ["stack"]) && error.stack) {
     _logger.verbose(error.stack);
   }
 }
@@ -78,7 +79,7 @@ export interface ServiceBusLogger extends AzureLogger {
  * Creates an AzureLogger with any additional methods for standardized logging (for example, with errors)
  * @internal
  */
-export function createServiceBusLogger(namespace: string) {
+export function createServiceBusLogger(namespace: string): ServiceBusLogger {
   const _logger = createClientLogger(namespace) as ServiceBusLogger;
 
   _logger["logError"] = (err: Error | AmqpError | undefined, ...args: any[]): void => {

sdk/servicebus/service-bus/src/receivers/receiver.ts

@@ -43,6 +43,16 @@ import { createProcessingSpan } from "../diagnostics/instrumentServiceBusMessage
 import { receiverLogger as logger } from "../log";
 import { translateServiceBusError } from "../serviceBusError";
 
+/**
+ * The default time to wait for messages _after_ the first message
+ * has been received.
+ *
+ * This timeout only applies to receiveMessages()
+ *
+ * @internal
+ */
+export const defaultMaxTimeAfterFirstMessageForBatchingMs = 1000;
+
 /**
  * A receiver that does not handle sessions.
  */
@@ -745,13 +755,3 @@ export class ServiceBusReceiverImpl implements ServiceBusReceiver {
     return;
   }
 }
-
-/**
- * The default time to wait for messages _after_ the first message
- * has been received.
- *
- * This timeout only applies to receiveMessages()
- *
- * @internal
- */
-export const defaultMaxTimeAfterFirstMessageForBatchingMs = 1000;