feat: explicitly define logger

src/internal/client.ts

@@ -1,4 +1,4 @@
 import * as crypto from 'node:crypto'
 import * as fs from 'node:fs'
 import type { IncomingHttpHeaders } from 'node:http'
 import * as http from 'node:http'
@@ -128,6 +128,7 @@
   uploadPartParser,
 } from './xml-parser.ts'
 import * as xmlParsers from './xml-parser.ts'
+import { Logger } from './logger.ts'
 
 const xml = new xml2js.Builder({ renderOpts: { pretty: false }, headless: true })
 
@@ -186,6 +187,7 @@
   port?: number
   region?: Region
   transport?: Transport
+  logger?: Logger
   sessionToken?: string
   partSize?: number
   pathStyle?: boolean
@@ -222,6 +224,7 @@
 
 export class TypedClient {
   protected transport: Transport
+  protected logger: Logger
   protected host: string
   protected port: number
   protected protocol: string
@@ -320,6 +323,12 @@
       transportAgent = params.transportAgent
     }
 
+    if (params.logger) {
+      this.logger = params.logger
+    } else {
+      this.logger = console
+    }
+
     // User Agent should always following the below style.
     // Please open an issue to discuss any new changes here.
     //
@@ -770,6 +779,7 @@
       this.retryOptions.disableRetry === true ? 0 : this.retryOptions.maximumRetryCount,
       this.retryOptions.baseDelayMs,
       this.retryOptions.maximumDelayMs,
+      this.logger,
     )
     if (!response.statusCode) {
       throw new Error("BUG: response doesn't have a statusCode")
@@ -2403,7 +2413,7 @@
 
     const res = await this.makeRequestAsync({ method, bucketName, objectName, query }, payload)
     const body = await readAsBuffer(res)
-    return parseSelectObjectContentResponse(body)
+    return parseSelectObjectContentResponse(body, this.logger)
   }
 
   private async applyBucketLifecycle(bucketName: string, policyConfig: LifeCycleConfigParam): Promise<void> {

src/internal/logger.ts

@@ -0,0 +1,8 @@
+/**
+ * Logger provides a common interface for logging.
+ * This interface is compatible with the default `console` logger.
+ */
+export interface Logger {
+  warn(message: string, ...optionalParams: never[]): void
+  log(message: string, ...optionalParams: never[]): void
+}

src/internal/request.ts

@@ -1,10 +1,11 @@
 import type * as http from 'node:http'
 import type * as https from 'node:https'
 import type * as stream from 'node:stream'
 import { pipeline } from 'node:stream'
 import { promisify } from 'node:util'
 
 import type { Transport } from './type.ts'
+import { Logger } from './logger.ts'
 
 const pipelineAsync = promisify(pipeline)
 
@@ -65,6 +66,7 @@
   maxRetries: number = MAX_RETRIES,
   baseDelayMs: number = BASE_DELAY_MS,
   maximumDelayMs: number = MAX_DELAY_MS,
+  logger: Logger,
 ): Promise<http.IncomingMessage> {
   let attempt = 0
   let isRetryable = false
@@ -87,8 +89,7 @@
           throw new Error(`Request failed after ${maxRetries} retries: ${err}`)
         }
         const delay = getExpBackOffDelay(attempt, baseDelayMs, maximumDelayMs)
-        // eslint-disable-next-line no-console
-        console.warn(
+        logger.warn(
           `${new Date().toLocaleString()} Retrying request (attempt ${attempt}/${maxRetries}) after ${delay}ms due to: ${err}`,
         )
         await sleep(delay)

src/internal/xml-parser.ts

@@ -1,4 +1,4 @@
 import type * as http from 'node:http'
 import type stream from 'node:stream'
 
 import crc32 from 'buffer-crc32'
@@ -22,6 +22,7 @@
   Tags,
 } from './type.ts'
 import { RETENTION_VALIDITY_UNITS } from './type.ts'
+import { Logger } from './logger.ts'
 
 // parse XML response for bucket region
 export function parseBucketRegion(xml: string): string {
@@ -459,7 +460,7 @@
   return Buffer.from(stream.read(bodyLen)).toString()
 }
 
-export function parseSelectObjectContentResponse(res: Buffer) {
+export function parseSelectObjectContentResponse(res: Buffer, logger: Logger) {
   const selectResults = new SelectResults({}) // will be returned
 
   const responseStream = readableStream(res) // convert byte array to a readable responseStream
@@ -577,9 +578,8 @@
           default: {
             // Continuation message: Not sure if it is supported. did not find a reference or any message in response.
             // It does not have a payload.
-            const warningMessage = `Un implemented event detected  ${messageType}.`
-            // eslint-disable-next-line no-console
-            console.warn(warningMessage)
+            const warningMessage = `Unimplemented event detected  ${messageType}.`
+            logger.warn(warningMessage)
           }
         }
       }