@fire-spark/payments-clisitef-client 0.7.0 → 0.7.1

package/android/src/main/java/dev/firespark/payments/clisitef/BoundedRunner.kt

@@ -47,6 +47,8 @@ internal class BoundedRunner {
       Lane.ABORT -> abort
       Lane.RECOVERY -> recovery
     }
+    // TODO(debug-clisitef): remove.
+    Log.d(DEBUG_TAG, "runner.$operation › queued lane=$lane timeoutMs=$timeoutMs")
     val timer = if (timeoutMs > 0) {
       watchdog.schedule({
         if (settled.compareAndSet(false, true)) {
@@ -62,6 +64,8 @@ internal class BoundedRunner {
     }
     try {
       target.execute {
+        // TODO(debug-clisitef): remove.
+        Log.d(DEBUG_TAG, "runner.$operation › running thread=${Thread.currentThread().name} waited=${System.currentTimeMillis() - startedAt}ms")
         val outcome = runCatching(block)
         timer?.cancel(false)
         if (!settled.compareAndSet(false, true)) {
@@ -70,6 +74,8 @@ internal class BoundedRunner {
         }
         lastCallOperation = operation
         lastCallDurationMs = System.currentTimeMillis() - startedAt
+        // TODO(debug-clisitef): remove.
+        Log.d(DEBUG_TAG, "runner.$operation › settled ok=${outcome.isSuccess} value=${outcome.getOrNull()} error=${outcome.exceptionOrNull()?.message} ms=$lastCallDurationMs")
         outcome
           .onSuccess {
             consecutiveTimeouts.set(0)
@@ -122,6 +128,8 @@ internal class BoundedRunner {
 
   private companion object {
     const val TAG = "CliSiTef"
+    // TODO(debug-clisitef): remove.
+    const val DEBUG_TAG = "CLISITEF_DEBUG"
 
     fun daemon(name: String): ThreadFactory {
       val sequence = AtomicInteger(0)

package/android/src/main/java/dev/firespark/payments/clisitef/CliSiTefBridge.kt

@@ -17,14 +17,37 @@ internal class CliSiTefBridge(
   private val listener = object : ICliSiTefListener {
     override fun onData(stage: Int, command: Int, fieldId: Int, minLength: Int, maxLength: Int, input: ByteArray?) {
       val text = input?.let { String(it) } ?: ""
+      // TODO(debug-clisitef): remove.
+      debug("listener.onData", "stage=$stage command=$command fieldId=$fieldId min=$minLength max=$maxLength input=\"$text\"")
       onData(DataEvent(stage, command, fieldId, minLength, maxLength, text))
     }
 
     override fun onTransactionResult(stage: Int, resultCode: Int) {
+      // TODO(debug-clisitef): remove.
+      debug("listener.onTransactionResult", "stage=$stage resultCode=$resultCode")
       onResult(stage, resultCode)
     }
   }
 
+  // TODO(debug-clisitef): remove with every `traced` / `debug` call.
+  private fun debug(scope: String, message: String) {
+    Log.d(DEBUG_TAG, "$scope › $message [thread=${Thread.currentThread().name}]")
+  }
+
+  // TODO(debug-clisitef): remove; call `block()` directly.
+  private fun <T> traced(scope: String, input: String, block: () -> T): T {
+    val startedAt = System.currentTimeMillis()
+    debug(scope, "→ jar in $input")
+    try {
+      val output = block()
+      debug(scope, "← jar out $output (${System.currentTimeMillis() - startedAt}ms)")
+      return output
+    } catch (error: Throwable) {
+      debug(scope, "✕ jar error ${error.javaClass.simpleName}: ${error.message} (${System.currentTimeMillis() - startedAt}ms)")
+      throw error
+    }
+  }
+
   init {
     // CliSiTef copies CLSIT on instantiation but does not overwrite an existing copy, and files/
     // survives app updates; sync first so this APK's CLSIT wins.
@@ -37,47 +60,66 @@ internal class CliSiTefBridge(
 
   fun configure(params: ConfigureParams): Int {
     val additional = withAppDir(params.additionalParams, appDirectory)
-    return clisitef.configure(params.serverIp, params.storeCode, params.terminalNumber, additional)
+    val input = "serverIp=${params.serverIp} storeCode=${params.storeCode} terminal=${params.terminalNumber} additional=$additional"
+    return traced("configure", input) {
+      clisitef.configure(params.serverIp, params.storeCode, params.terminalNumber, additional)
+    }
   }
 
-  fun start(params: StartParams): Int = clisitef.startTransaction(
-    listener,
-    params.modality,
-    params.value,
-    params.fiscalCoupon,
-    params.fiscalDate,
-    params.time,
-    params.operator,
-    params.restrictions
-  )
+  fun start(params: StartParams): Int {
+    val input = "modality=${params.modality} value=${params.value} coupon=${params.fiscalCoupon} " +
+      "date=${params.fiscalDate} time=${params.time} operator=${params.operator} restrictions=${params.restrictions}"
+    return traced("startTransaction", input) {
+      clisitef.startTransaction(
+        listener,
+        params.modality,
+        params.value,
+        params.fiscalCoupon,
+        params.fiscalDate,
+        params.time,
+        params.operator,
+        params.restrictions
+      )
+    }
+  }
 
-  fun continueTransaction(data: String): Int = clisitef.continueTransaction(data)
+  fun continueTransaction(data: String): Int =
+    traced("continueTransaction", "data=\"$data\"") { clisitef.continueTransaction(data) }
 
   /** Without coupon, date and time the library reuses the ones from `startTransaction`. */
   fun finish(params: FinishParams): Int {
     val full = params.fiscalCoupon.isNotEmpty() && params.fiscalDate.isNotEmpty() && params.time.isNotEmpty()
-    if (!full) return clisitef.finishTransaction(params.confirm)
-    return clisitef.finishTransaction(params.confirm, params.fiscalCoupon, params.fiscalDate, params.time, params.additionalParams)
+    val input = "confirm=${params.confirm} full=$full coupon=${params.fiscalCoupon} " +
+      "date=${params.fiscalDate} time=${params.time} additional=${params.additionalParams}"
+    return traced("finishTransaction", input) {
+      if (!full) return@traced clisitef.finishTransaction(params.confirm)
+      clisitef.finishTransaction(params.confirm, params.fiscalCoupon, params.fiscalDate, params.time, params.additionalParams)
+    }
   }
 
-  fun abort(continueFlag: Int): Int = clisitef.abortTransaction(continueFlag)
+  fun abort(continueFlag: Int): Int =
+    traced("abortTransaction", "continueFlag=$continueFlag") { clisitef.abortTransaction(continueFlag) }
 
   fun pendingCount(fiscalDate: String, fiscalCoupon: String): Int =
-    clisitef.getQttPendingTransactions(fiscalDate, fiscalCoupon)
+    traced("getQttPendingTransactions", "date=$fiscalDate coupon=$fiscalCoupon") {
+      clisitef.getQttPendingTransactions(fiscalDate, fiscalCoupon)
+    }
 
-  fun submitPending(): Int = clisitef.submitPendingMessages()
+  fun submitPending(): Int = traced("submitPendingMessages", "") { clisitef.submitPendingMessages() }
 
-  fun version(): String = clisitef.getVersion()
+  fun version(): String = traced("getVersion", "") { clisitef.getVersion() }
 
-  fun closePinPad(): Int = clisitef.closePinPad()
+  fun closePinPad(): Int = traced("closePinPad", "") { clisitef.closePinPad() }
 
   fun disconnectSitef(): Int {
-    clisitef.disconnectSitef()
+    traced("disconnectSitef", "") { clisitef.disconnectSitef() }
     return 0
   }
 
   companion object {
     private const val TAG = "CliSiTef"
+    // TODO(debug-clisitef): remove.
+    private const val DEBUG_TAG = "CLISITEF_DEBUG"
     private const val CLSIT = "CLSIT"
     private val APP_DIR = Regex("DiretorioApp=[^;\\]]*")
 
@@ -101,6 +143,8 @@ internal class CliSiTefBridge(
       val temp = File(context.filesDir, "$CLSIT.new")
       try {
         val shipped = context.assets.open(CLSIT).use { it.readBytes() }
+        // TODO(debug-clisitef): remove.
+        Log.d(DEBUG_TAG, "syncClsit › shipped=${shipped.size}B target=${target.absolutePath} exists=${target.isFile}")
         if (shipped.isEmpty()) return
         if (target.isFile && target.readBytes().contentEquals(shipped)) return
         temp.outputStream().use { out ->

package/android/src/main/java/dev/firespark/payments/clisitef/CliSiTefModule.kt

@@ -12,6 +12,8 @@ class CliSiTefModule : Module() {
   private fun bridge(): CliSiTefBridge = synchronized(this) {
     bridge?.let { return it }
     val context = appContext.reactContext?.applicationContext ?: throw Exceptions.ReactContextLost()
+    // TODO(debug-clisitef): remove.
+    android.util.Log.d("CLISITEF_DEBUG", "module › creating bridge dataDir=${context.applicationInfo.dataDir}")
     CliSiTefBridge(
       context,
       onData = { event -> sendEvent("onData", event.toMap()) },

package/dist/index.d.mts

@@ -137,6 +137,12 @@ declare const CLISITEF_JS_GRACE_MS = 5000;
 declare const CLISITEF_DEFAULT_TIME_ZONE = "America/Sao_Paulo";
 declare const CLISITEF_DEFAULT_PINPAD = "ANDROID_USB";
 //#endregion
+//#region src/debug.d.ts
+/** Logs one step: `[CLISITEF_DEBUG] scope › event { data }`. */
+declare const clisitefDebug: (scope: string, event: string, data?: unknown) => void;
+/** Logs the input, the output or the error, and the duration of a call. */
+declare const clisitefDebugCall: <T>(scope: string, input: unknown, call: () => Promise<T>) => Promise<T>;
+//#endregion
 //#region src/errors.d.ts
 declare class ClisitefUnavailableError extends Error {
   readonly code = "CLISITEF_UNAVAILABLE";
@@ -190,4 +196,4 @@ declare const parseClisitefMenu: (input: string) => ClisitefMenuOption[];
 /** Shared client bound to the device's native module; one per app. */
 declare const clisitef: ClisitefClient;
 //#endregion
-export { CLISITEF_ABORT_FLAG, CLISITEF_CONFIRM, CLISITEF_DEFAULT_PINPAD, CLISITEF_DEFAULT_TIME_ZONE, CLISITEF_JS_GRACE_MS, CLISITEF_MODALITY, CLISITEF_RESULT, CLISITEF_TIMEOUT_CODE, CLISITEF_TIMEOUT_MS, ClisitefAdditionalParamsInput, ClisitefClient, ClisitefClientOptions, ClisitefConfigureParams, ClisitefDataEvent, ClisitefEvents, ClisitefFinishParams, ClisitefFiscalDateTime, ClisitefHealth, ClisitefMenuOption, ClisitefNativeModule, ClisitefOperation, ClisitefResultEvent, ClisitefStartParams, ClisitefSubscription, ClisitefTimeoutError, ClisitefTimeoutInfo, ClisitefUnavailableError, clisitef, clisitefAdditionalParams, clisitefConfigSignature, clisitefFiscalDateTime, createClisitefClient, formatClisitefAmount, parseClisitefMenu, toClisitefTimeout };
+export { CLISITEF_ABORT_FLAG, CLISITEF_CONFIRM, CLISITEF_DEFAULT_PINPAD, CLISITEF_DEFAULT_TIME_ZONE, CLISITEF_JS_GRACE_MS, CLISITEF_MODALITY, CLISITEF_RESULT, CLISITEF_TIMEOUT_CODE, CLISITEF_TIMEOUT_MS, ClisitefAdditionalParamsInput, ClisitefClient, ClisitefClientOptions, ClisitefConfigureParams, ClisitefDataEvent, ClisitefEvents, ClisitefFinishParams, ClisitefFiscalDateTime, ClisitefHealth, ClisitefMenuOption, ClisitefNativeModule, ClisitefOperation, ClisitefResultEvent, ClisitefStartParams, ClisitefSubscription, ClisitefTimeoutError, ClisitefTimeoutInfo, ClisitefUnavailableError, clisitef, clisitefAdditionalParams, clisitefConfigSignature, clisitefDebug, clisitefDebugCall, clisitefFiscalDateTime, createClisitefClient, formatClisitefAmount, parseClisitefMenu, toClisitefTimeout };

package/dist/index.mjs

@@ -36,6 +36,49 @@ const CLISITEF_JS_GRACE_MS = 5e3;
 const CLISITEF_DEFAULT_TIME_ZONE = "America/Sao_Paulo";
 const CLISITEF_DEFAULT_PINPAD = "ANDROID_USB";
 //#endregion
+//#region src/debug.ts
+const TAG = "[CLISITEF_DEBUG]";
+const elapsed = (startedAt) => Date.now() - startedAt;
+const safe = (value) => {
+	if (value instanceof Map) return Object.fromEntries(value);
+	if (value instanceof Error) {
+		const code = value.code;
+		return {
+			name: value.name,
+			message: value.message,
+			code
+		};
+	}
+	return value;
+};
+/** Logs one step: `[CLISITEF_DEBUG] scope › event { data }`. */
+const clisitefDebug = (scope, event, data) => {
+	const time = (/* @__PURE__ */ new Date()).toISOString();
+	if (data === void 0) return console.log(TAG, time, `${scope} › ${event}`);
+	console.log(TAG, time, `${scope} › ${event}`, safe(data));
+};
+/** Logs the input, the output or the error, and the duration of a call. */
+const clisitefDebugCall = async (scope, input, call) => {
+	const startedAt = Date.now();
+	clisitefDebug(scope, "→ in", input);
+	try {
+		const output = await call();
+		const ms = elapsed(startedAt);
+		clisitefDebug(scope, "← out", {
+			output: safe(output),
+			ms
+		});
+		return output;
+	} catch (error) {
+		const ms = elapsed(startedAt);
+		clisitefDebug(scope, "✕ error", {
+			error: safe(error),
+			ms
+		});
+		throw error;
+	}
+};
+//#endregion
 //#region src/errors.ts
 var ClisitefUnavailableError = class extends Error {
 	code = "CLISITEF_UNAVAILABLE";
@@ -160,7 +203,10 @@ const createClisitefClient = (native, options = {}) => {
 		if (!native) throw new ClisitefUnavailableError();
 		return native;
 	};
-	const bounded = async (operation, call) => {
+	const bounded = async (operation, call, input) => {
+		return clisitefDebugCall(`client.${operation}`, input, () => boundedCall(operation, call));
+	};
+	const boundedCall = async (operation, call) => {
 		const module = requireNative();
 		const ceiling = CLISITEF_TIMEOUT_MS[operation];
 		let timer;
@@ -181,6 +227,7 @@ const createClisitefClient = (native, options = {}) => {
 		} catch (error) {
 			const timeout = error instanceof ClisitefTimeoutError ? error : toClisitefTimeout(error);
 			if (!timeout) throw error;
+			clisitefDebug(`client.${operation}`, "timeout", timeout.info);
 			signature = null;
 			throw timeout;
 		} finally {
@@ -189,28 +236,58 @@ const createClisitefClient = (native, options = {}) => {
 	};
 	const configure = async (config) => {
 		const next = clisitefConfigSignature(config);
-		if (next === signature) return 0;
-		const code = await bounded("configure", (module) => module.configure(config));
+		if (next === signature) {
+			clisitefDebug("client.configure", "skipped (same config)", config);
+			return 0;
+		}
+		const call = (module) => module.configure(config);
+		const code = await bounded("configure", call, config);
 		signature = code === 0 ? next : null;
 		return code;
 	};
+	const listen = (event, listener) => {
+		const logged = ((payload) => {
+			clisitefDebug(`client.event.${event}`, "← native", payload);
+			listener(payload);
+		});
+		clisitefDebug(`client.event.${event}`, "subscribe");
+		const subscription = requireNative().addListener(event, logged);
+		return { remove: () => {
+			clisitefDebug(`client.event.${event}`, "unsubscribe");
+			subscription.remove();
+		} };
+	};
 	return {
 		available: native !== null,
 		configure,
 		invalidate: () => {
+			clisitefDebug("client.invalidate", "signature cleared");
 			signature = null;
 		},
-		startTransaction: (params) => bounded("startTransaction", (module) => module.startTransaction(params)),
+		startTransaction: (params) => {
+			const call = (m) => m.startTransaction(params);
+			return bounded("startTransaction", call, params);
+		},
 		continueTransaction: (data) => {
-			return bounded("continueTransaction", (m) => m.continueTransaction(data));
+			const call = (m) => m.continueTransaction(data);
+			return bounded("continueTransaction", call, { data });
+		},
+		finishTransaction: (params) => {
+			const call = (m) => m.finishTransaction(params);
+			return bounded("finishTransaction", call, params);
+		},
+		abortTransaction: (flag) => {
+			const call = (m) => m.abortTransaction(flag);
+			return bounded("abortTransaction", call, { continueFlag: flag });
 		},
-		finishTransaction: (params) => bounded("finishTransaction", (module) => module.finishTransaction(params)),
-		abortTransaction: (flag) => bounded("abortTransaction", (module) => module.abortTransaction(flag)),
 		getQttPendingTransactions: (date, coupon) => {
 			const call = (m) => {
 				return m.getQttPendingTransactions(date, coupon);
 			};
-			return bounded("getQttPendingTransactions", call);
+			return bounded("getQttPendingTransactions", call, {
+				fiscalDate: date,
+				fiscalCoupon: coupon
+			});
 		},
 		submitPendingMessages: () => {
 			return bounded("submitPendingMessages", (m) => m.submitPendingMessages());
@@ -218,9 +295,13 @@ const createClisitefClient = (native, options = {}) => {
 		getVersion: () => bounded("getVersion", (module) => module.getVersion()),
 		closePinPad: () => bounded("closePinPad", (module) => module.closePinPad()),
 		disconnectSitef: () => bounded("disconnectSitef", (module) => module.disconnectSitef()),
-		getHealth: () => native?.getHealth() ?? null,
-		onData: (listener) => requireNative().addListener("onData", listener),
-		onTransactionResult: (listener) => requireNative().addListener("onTransactionResult", listener)
+		getHealth: () => {
+			const health = native?.getHealth() ?? null;
+			clisitefDebug("client.getHealth", "← out", health);
+			return health;
+		},
+		onData: (listener) => listen("onData", listener),
+		onTransactionResult: (listener) => listen("onTransactionResult", listener)
 	};
 };
 //#endregion
@@ -228,4 +309,4 @@ const createClisitefClient = (native, options = {}) => {
 /** Shared client bound to the device's native module; one per app. */
 const clisitef = createClisitefClient(requireOptionalNativeModule("CliSiTef"));
 //#endregion
-export { CLISITEF_ABORT_FLAG, CLISITEF_CONFIRM, CLISITEF_DEFAULT_PINPAD, CLISITEF_DEFAULT_TIME_ZONE, CLISITEF_JS_GRACE_MS, CLISITEF_MODALITY, CLISITEF_RESULT, CLISITEF_TIMEOUT_CODE, CLISITEF_TIMEOUT_MS, ClisitefTimeoutError, ClisitefUnavailableError, clisitef, clisitefAdditionalParams, clisitefConfigSignature, clisitefFiscalDateTime, createClisitefClient, formatClisitefAmount, parseClisitefMenu, toClisitefTimeout };
+export { CLISITEF_ABORT_FLAG, CLISITEF_CONFIRM, CLISITEF_DEFAULT_PINPAD, CLISITEF_DEFAULT_TIME_ZONE, CLISITEF_JS_GRACE_MS, CLISITEF_MODALITY, CLISITEF_RESULT, CLISITEF_TIMEOUT_CODE, CLISITEF_TIMEOUT_MS, ClisitefTimeoutError, ClisitefUnavailableError, clisitef, clisitefAdditionalParams, clisitefConfigSignature, clisitefDebug, clisitefDebugCall, clisitefFiscalDateTime, createClisitefClient, formatClisitefAmount, parseClisitefMenu, toClisitefTimeout };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fire-spark/payments-clisitef-client",
-  "version": "0.7.0",
+  "version": "0.7.1",
   "description": "Fire Spark native client for CliSiTef (Software Express) on Android: SiTef server and pinpad bridge shared by the CliSiTef adapters",
   "sideEffects": false,
   "files": [