juspay/hyperswitch

[FEATURE] Have `get_required_value` to use `ValidationError` in `OptionExt`

Open

#860 opened on Apr 12, 2023

View on GitHub
 (12 comments) (0 reactions) (0 assignees)Rust (42,690 stars) (4,676 forks)batch import
C-featureC-refactorE-mediumP-lowgood first issuehelp wanted

Description

Feature Description

Currently, the OptionExt::get_required_value is more API oriented as it returns ApiErrorResponse. But, throughout the codebase it is being used in varying context, and the overall error framework generates inconsistent hierarchical error report. By using ValidationError as a error type inside the trait, it will provide a very consistent error report, with in future can be automated by error casting.

Possible Implementation

This issue involves changing the OptionExt trait definition and implementation. This change isn't heavy in solutioning, but involves a significant amount of change in the overall codebase

Have you spent some time to check if this feature request has been raised before?

  • I checked and didn't find similar issue

Have you read the Contributing Guidelines?

Are you willing to submit a PR?

No, but I'm happy to collaborate on a PR with someone else

Contributor guide

Tech stack
rust
Domain
backendapi
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Rust programmingUnderstanding of hyperswitch error handling
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
The issue requires changing the `OptionExt` trait definition to use `ValidationError` instead of `ApiErrorResponse`. This involves modifying the trait itself and all its implementations across the codebase. The key challenge is identifying all usages and ensuring the change does not break existing functionality. The contributor should start by examining the current `OptionExt` trait in the source code and then trace through its invocations to update error handling consistently.
[FEATURE] Have `get_required_value` to use `ValidationError` in `OptionExt` · juspay/hyperswitch#860 | Good First Issue