feat: add debug package (#1062)

Author: Cafe137

package-lock.json

@@ -63,6 +63,7 @@
   "dependencies": {
     "axios": "^0.30.0",
     "cafe-utility": "^31.0.0",
+    "debug": "^4.4.1",
     "isomorphic-ws": "^4.0.1",
     "semver": "^7.3.5",
     "ws": "^8.7.0"
@@ -78,6 +79,7 @@
     "@commitlint/config-conventional": "^17.4.2",
     "@jest/types": "^29.6.3",
     "@naholyr/cross-env": "^1.0.0",
+    "@types/debug": "^4.1.12",
     "@types/jest": "^29.5.13",
     "@types/node": "^18.11.11",
     "@types/semver": "^7.3.9",

package.json

@@ -1,9 +1,12 @@
 import { Binary, MerkleTree, Optional, Uint8ArrayReader } from 'cafe-utility'
+import _debug from 'debug'
 import { Bee, BeeRequestOptions, DownloadOptions, NULL_ADDRESS, UploadOptions, UploadResult } from '..'
 import { FeedPayloadResult } from '../modules/feed'
 import { Bytes } from '../utils/bytes'
 import { BatchId, Reference } from '../utils/typed-bytes'
 
+const debug = _debug('bee-js:manifest')
+
 const ENCODER = new TextEncoder()
 const DECODER = new TextDecoder()
 
@@ -80,6 +83,12 @@ export class Fork {
     }
     data.push(this.node.selfAddress)
 
+    debug('marshalling fork', {
+      prefixLength: this.prefix.length,
+      prefix: DECODER.decode(this.prefix),
+      address: Binary.uint8ArrayToHex(this.node.selfAddress),
+    })
+
     if (this.node.metadata) {
       const metadataBytes = Binary.padEndToMultiple(
         new Uint8Array([0x00, 0x00, ...ENCODER.encode(JSON.stringify(this.node.metadata))]),
@@ -100,6 +109,12 @@ export class Fork {
     const prefix = reader.read(prefixLength)
     reader.read(30 - prefixLength)
     const selfAddress = reader.read(addressLength)
+    debug('unmarshalling fork', {
+      prefixLength,
+      prefix: DECODER.decode(prefix),
+      addressLength,
+      address: Binary.uint8ArrayToHex(selfAddress),
+    })
     let metadata: Record<string, string> | undefined = undefined
 
     if (isType(type, TYPE_WITH_METADATA)) {
@@ -313,6 +328,7 @@ export class MantarayNode {
   ) {
     this.selfAddress = null
     path = path instanceof Uint8Array ? path : ENCODER.encode(path)
+    debug('adding fork', { path: DECODER.decode(path), reference: new Reference(reference).represent() })
     // TODO: this should not be ignored
     // eslint-disable-next-line @typescript-eslint/no-this-alias
     let tip: MantarayNode = this

src/manifest/manifest.ts

@@ -1,7 +1,10 @@
 import axios, { AxiosRequestConfig, AxiosResponse } from 'axios'
 import { Dates, Objects, Strings, System } from 'cafe-utility'
+import _debug from 'debug'
 import { BeeRequestOptions, BeeResponseError } from '../index'
 
+const debug = _debug('bee-js:http')
+
 const { AxiosError } = axios
 
 const MAX_FAILED_ATTEMPTS = 100_000
@@ -46,6 +49,13 @@ export async function http<T>(options: BeeRequestOptions, config: AxiosRequestCo
   let failedAttempts = 0
   while (failedAttempts < MAX_FAILED_ATTEMPTS) {
     try {
+      debug(
+        `${requestConfig.method || 'get'} ${Strings.joinUrl([
+          requestConfig.baseURL as string,
+          requestConfig.url as string,
+        ])}`,
+        { headers: { ...requestConfig.headers } as Record<string, string>, params: requestConfig.params },
+      )
       maybeRunOnRequestHook(options, requestConfig)
       const response = await axios(requestConfig)