feat: add debug mode

Author: murongg

package.json

@@ -47,7 +47,7 @@
     "publish": "nr prepublishOnly && esno scripts/publish.ts",
     "release": "esno scripts/release.ts",
     "start": "esno src/index.ts",
-    "test": "vitest",
+    "test": "DEBUG=ora-stack:* vitest",
     "typecheck": "tsc --noEmit"
   },
   "devDependencies": {

packages/orap/src/debug.ts

@@ -0,0 +1,5 @@
+import { debug as debugFn } from '@ora-io/utils'
+
+export function debug(formatter: any, ...args: any[]) {
+  return debugFn('orap')(formatter, ...args)
+}

packages/orap/src/flow/orap.ts

@@ -3,6 +3,7 @@ import type { Fn } from '@ora-io/utils'
 import type { Interface, InterfaceAbi } from 'ethers'
 import { OrapVerse } from '../verse/orap'
 import type { EventSignalRegisterParams } from '../signal'
+import { debug } from '../debug'
 import { EventFlow } from './event'
 import type { Flow, HandleFn } from './interface'
 
@@ -35,6 +36,7 @@ export class OrapFlow implements Flow {
 
     const eventFlow = new EventFlow(this, params, handler)
     this.subflows.event.push(eventFlow)
+    debug('The event %s is registered, address: %s', params.eventName, params.address)
     return eventFlow
   }
 

packages/reku/src/debug.ts

@@ -0,0 +1,5 @@
+import { debug as debugFn } from '@ora-io/utils'
+
+export function debug(formatter: any, ...args: any[]) {
+  return debugFn('reku')(formatter, ...args)
+}

packages/reku/src/event/crosschecker/autochecker.ts

@@ -2,6 +2,7 @@ import type { ethers } from 'ethers'
 import { polling, sleep, timeoutWithRetry } from '@ora-io/utils'
 import { ETH_BLOCK_INTERVAL } from '../../constants'
 import type { Providers } from '../../types/w3'
+import { debug } from '../../debug'
 import { CrossCheckerCacheManager } from './cache/manager'
 import type { AutoCrossCheckParam, CrossCheckRangeParam, SimpleLog } from './interface'
 import { BaseCrossChecker } from './basechecker'
@@ -113,9 +114,13 @@ export class AutoCrossChecker extends BaseCrossChecker {
       // never ends if options.toBlock is not provided
       : () => false
 
+    debug('crosscheck running')
+
     // TODO: replace polling with schedule cron
     await polling(async () => {
-      if (await waitOrUpdateToBlock()) {
+      const wait = await waitOrUpdateToBlock()
+      debug('polling interval: %d, wait: %s', pollingInterval, wait)
+      if (wait) {
         await this.crossCheckRange(ccrOptions)
         // only update options after cc succ
         await updateCCROptions(ccrOptions)

packages/reku/src/event/crosschecker/basechecker.ts

@@ -2,6 +2,7 @@ import type { ethers } from 'ethers'
 import { timeoutWithRetry } from '@ora-io/utils'
 import { ETH_BLOCK_COUNT_ONE_HOUR } from '../../constants'
 import type { Providers } from '../../types/w3'
+import { debug } from '../../debug'
 import type { CrossCheckFromParam, CrossCheckRangeParam, CrossCheckRetroParam, SimpleLog } from './interface'
 
 export class BaseCrossChecker {
@@ -77,6 +78,13 @@ export class BaseCrossChecker {
     return block.number
   }
 
+  /**
+   * @deprecated
+   * @param logs
+   * @param txHashList
+   * @param logIndexList
+   * @returns
+   */
   async diff_old(logs: ethers.Log[], txHashList: string[], logIndexList: number[][]): Promise<ethers.Log[]> {
     const missing = (log: ethers.Log) => {
       const txIndex = txHashList?.indexOf(log.transactionHash) || -1
@@ -105,6 +113,7 @@ export class BaseCrossChecker {
   async _crossCheck(options: CrossCheckRangeParam) {
     // get period logs
     const { fromBlock, toBlock, address, topics } = options
+    debug('start crosscheck from %d to %d', fromBlock, toBlock)
     const params = {
       fromBlock,
       toBlock,
@@ -120,8 +129,10 @@ export class BaseCrossChecker {
       const missingLogs = ignoreLogs ? await this.diff(logs, ignoreLogs) : logs
 
       // callback on missing logs
-      for (const log of missingLogs)
+      for (const log of missingLogs) {
+        debug('missing tx hash: %s', log.transactionHash)
         await options.onMissingLog(log)
+      }
     }
   }
 }

packages/reku/src/provider/provider.ts

@@ -2,6 +2,7 @@ import { EventEmitter } from 'node:events'
 import type { InterfaceAbi } from 'ethers'
 import { Interface, WebSocketProvider, ethers } from 'ethers'
 import type { ErrorEvent, WebSocket } from 'ws'
+import { debug } from '../debug'
 import { ContractManager } from './contract'
 
 export interface RekuProviderManagerOptions {
@@ -127,6 +128,7 @@ export class RekuProviderManager {
   }
 
   reconnect() {
+    debug('reconnect provider running...')
     // destroy heartbeat
     this._clearHeartbeat()
     this._heartbeatTimer = undefined
@@ -142,11 +144,13 @@ export class RekuProviderManager {
       const socket = this._provider.websocket as WebSocket
       socket.removeAllListeners()
       socket.onerror = null
+      debug('remove all listeners of websocket provider')
     }
     this._provider?.destroy()
     this._provider = undefined
 
     setTimeout(() => {
+      debug('reconnect provider start')
       // reconnect provider
       this.connect()
       // reset contracts
@@ -164,15 +168,19 @@ export class RekuProviderManager {
       this._contracts = contracts
       // resend heartbeat
       this._sendHeartbeat()
+      debug('reconnect provider end')
     }, 100)
   }
 
   private _sendHeartbeat() {
     if (this._options?.disabledHeartbeat)
       return
+    debug('start heartbeat')
     this._heartbeatTimer = setInterval(() => {
       this._provider?.send('net_version', [])
-        .then()
+        .then((res) => {
+          debug('heartbeat response: %s', res)
+        })
         .catch((err) => {
           this.reconnect()
           this._event?.emit('error', err)
@@ -181,30 +189,36 @@ export class RekuProviderManager {
   }
 
   private _clearHeartbeat() {
-    if (this._heartbeatTimer)
+    if (this._heartbeatTimer) {
+      debug('clear heartbeat')
       clearInterval(this._heartbeatTimer)
+    }
   }
 
   private _handleError() {
     this._provider?.on('error', () => {
+      debug('provider error event emitted')
       this.reconnect()
       this._event?.emit('error', new Error('provider error'))
     })
 
     if (this._provider instanceof ethers.WebSocketProvider) {
       const websocket = this._provider.websocket as WebSocket
       websocket.onerror = (event: ErrorEvent) => {
+        debug('websocket error event emitted')
         this.reconnect()
         this._event?.emit('error', new Error('websocket error'), event)
       }
       websocket.on?.('close', (code: number, reason: string) => {
+        debug('websocket close event emitted')
         this.reconnect()
         this._event?.emit('close', code, reason)
       })
     }
   }
 
   destroy() {
+    debug('destroy provider running...')
     this._clearHeartbeat()
     this._provider?.removeAllListeners()
     this._provider?.destroy()
@@ -215,5 +229,6 @@ export class RekuProviderManager {
     this._contracts.clear()
     this._event?.removeAllListeners()
     this._event = undefined
+    debug('destroy provider end')
   }
 }

packages/utils/package.json

@@ -46,13 +46,15 @@
     "@murongg/utils": "^0.1.28",
     "cache-manager": "^5.7.6",
     "cache-manager-ioredis-yet": "^2.1.1",
+    "debug": "^4.3.7",
     "ioredis": "^5.4.1",
     "lodash.clonedeep": "^4.5.0",
     "lru-cache": "^11.0.1",
     "picocolors": "^1.0.1",
     "telejson": "^7.2.0"
   },
   "devDependencies": {
+    "@types/debug": "^4.1.12",
     "@types/lodash.clonedeep": "^4.5.9"
   }
 }

packages/utils/src/common/debug.ts

@@ -0,0 +1,5 @@
+import debugFn from 'debug'
+
+export function debug(workspace: string) {
+  return debugFn(`ora-stack:${workspace}`)
+}

packages/utils/src/common/index.ts

@@ -3,3 +3,4 @@ export * from './retry'
 export * from './type'
 export * from './basic'
 export * from './fn'
+export * from './debug'