PurchasesError actual data doesn't match interface

[wsamoht]

Hi RevenueCat team! I thought I'd bring this up since it is still an issue in v9. I know it has been an issue since at least v7.

The actual data for PurchasesError doesn't match the interface. This is on Android at least, I don't remember on iOS 😬

There are two issues that I see. First, most of the data is wrapped in a data object. I know this has been around since v7.

Second, it says readableErrorCode is deprecated, "access readableErrorCode through userInfo.readableErrorCode". But userInfo doesn't exist in the actual data.

Actual data

The PurchaseError Interface

export interface PurchasesError {
    code: PURCHASES_ERROR_CODE;
    message: string;
    /**
     * @deprecated access readableErrorCode through userInfo.readableErrorCode
     */
    readableErrorCode: string;
    userInfo: ErrorInfo;
    underlyingErrorMessage: string;
    /**
     * @deprecated use code === Purchases.PURCHASES_ERROR_CODE.PURCHASE_CANCELLED_ERROR instead
     */
    userCancelled: boolean | null;
}

Workaround

My current workaround is a custom interface wrapping PurchaseError and a custom class.

interface PurchasesErrorWithDataInterface extends PurchasesError {
    data?: PurchasesError
}

export class PurchasesErrorWithData {
    private error: PurchasesErrorWithDataInterface

    public get code(): PURCHASES_ERROR_CODE {
        return this.error.code
    }

    public get message(): string {
        return this.error.data?.message ?? this.error.message
    }

    public get readableErrorCode(): string {
        return (
            this.error.data?.userInfo?.readableErrorCode ??
            this.error.userInfo?.readableErrorCode ??
            this.error.data?.readableErrorCode ??
            this.error.readableErrorCode
        )
    }

    public get underlyingErrorMessage(): string {
        return this.error.data?.underlyingErrorMessage ?? this.error.underlyingErrorMessage
    }

    public constructor(error: PurchasesError) {
        this.error = error
    }
}

[RCGitBot]

👀 We've just linked this issue to our internal tracker and notified the team. Thank you for reporting, we're checking this out!

[wsamoht]

iOS for a purchasePackage error looks like this: