fix: improve error handling

Author: noomorph

package-e2e/test.ts

@@ -32,4 +32,4 @@ assertType<DetoxAllure2AdapterDeviceLogsOptions>({
 
 assertType<DetoxAllure2AdapterDeviceScreenshotOptions>({
   saveAll: true,
-});
+});

src/listener.ts

@@ -22,6 +22,7 @@ export const listener: EnvironmentListenerFn = (
     useSteps = false,
     deviceLogs = false,
     deviceScreenshots = false,
+    onError,
   }: DetoxAllure2AdapterOptions = {},
 ) => {
   let logHandler: ReturnType<typeof createLogHandler>;
@@ -47,13 +48,15 @@ export const listener: EnvironmentListenerFn = (
         logs = new LogBuffer({
           device: detox.device,
           options: deviceLogs,
+          onError,
         });
       }
 
       if (deviceScreenshots) {
         screenshots = new ScreenshotHelper({
           device: detox.device,
           options: deviceScreenshots,
+          onError,
         });
       }
     })

src/logs/log-buffer.ts

@@ -10,6 +10,7 @@ type AnyEntry = AndroidEntry & IosEntry;
 export interface LogBufferOptions {
   device: Detox.Device;
   options: true | DetoxAllure2AdapterDeviceLogsOptions;
+  onError?: (error: Error) => void;
 }
 
 export interface StepLogRecorder {
@@ -22,6 +23,8 @@ export interface StepLogRecorder {
   close(): Promise<void>;
 }
 
+const noop = () => {};
+
 export class LogBuffer implements StepLogRecorder {
   private readonly _emitter: Emitter;
   private _entries: AnyEntry[] = [];
@@ -48,6 +51,7 @@ export class LogBuffer implements StepLogRecorder {
           });
 
     this._emitter.on('entry', this._onEntry);
+    this._emitter.on('error', this._config.onError ?? noop);
   }
 
   public resetPid() {
@@ -91,6 +95,7 @@ export class LogBuffer implements StepLogRecorder {
 
   public async close() {
     await this._emitter.close();
+    this._emitter.removeAllListeners();
   }
 
   public attachBefore(allure: AllureRuntime) {

src/screenshots/helpers.ts

@@ -7,6 +7,7 @@ import type { DetoxAllure2AdapterDeviceScreenshotOptions } from '../types';
 export interface ScreenshotHelperConfig {
   device: Detox.Device;
   options: true | DetoxAllure2AdapterDeviceScreenshotOptions;
+  onError?: (error: Error) => void;
 }
 
 export class ScreenshotHelper {
@@ -15,13 +16,13 @@ export class ScreenshotHelper {
   private readonly _options: DetoxAllure2AdapterDeviceScreenshotOptions;
   private readonly _kitten: Screenkitten;
 
-  constructor({ device, options }: ScreenshotHelperConfig) {
+  constructor({ device, options, onError }: ScreenshotHelperConfig) {
     this._device = device;
     this._platform = device.getPlatform();
     this._options = typeof options === 'boolean' ? {} : options;
     this._kitten = screenkitten({
       platform: this._platform,
-      onError: 'ignore', // Don't throw on errors, just log them
+      onError: onError ?? 'ignore',
     });
   }
 

src/steps/wrapWithSteps.ts

@@ -37,15 +37,15 @@ export function wrapWithSteps(options: WrapWithStepsOptions) {
     const ws = worker._client._asyncWebSocket;
     const send = ws.send.bind(ws) as (...args: any[]) => Promise<{ type?: string }>;
     const onActionSuccess = async () => {
-      await logs?.attachAfterSuccess(allure);
+      logs?.attachAfterSuccess(allure);
     };
     const onActionFailure = async (shouldSetStatus: boolean) => {
       if (shouldSetStatus) {
         allure.status('failed');
       }
 
       await screenshots?.attachFailure(allure);
-      await logs?.attachAfterFailure(allure);
+      logs?.attachAfterFailure(allure);
     };
     ws.send = async (...args: any[]) => {
       const desc = descriptionMaker(args[0]);
@@ -97,19 +97,20 @@ function wrapDeviceMethod(
       }
 
       try {
+        logs?.attachBefore(allure);
         const result = await originalMethod.apply(device, args);
 
         if (PID_CHANGING_METHODS.has(methodName)) {
           logs?.refreshPid();
         }
 
         await screenshots?.attach(allure, false);
-        await logs?.attachAfterSuccess(allure);
+        logs?.attachAfterSuccess(allure);
 
         return result;
       } catch (error) {
         await screenshots?.attachFailure(allure);
-        await logs?.attachAfterFailure(allure);
+        logs?.attachAfterFailure(allure);
 
         throw error; // Re-throw the error
       }

src/types.ts

@@ -14,6 +14,10 @@ export type DetoxAllure2AdapterOptions = {
    * Device screenshots configuration for per-step logging
    */
   deviceScreenshots?: boolean | DetoxAllure2AdapterDeviceScreenshotOptions;
+  /**
+   * Callback to handle errors
+   */
+  onError?: (error: Error) => void;
 };
 
 export interface DetoxAllure2AdapterDeviceLogsOptions {