reclaimprotocol/reclaim-js-sdk

Improve and Standardize Error Handling and Logging Strategy

Open

#6 opened on Oct 1, 2024

View on GitHubContributor guide
 (6 comments) (0 reactions) (1 assignee)TypeScript (14 forks)auto 404
enhancementgood first issuehacktoberfest

Repository metrics

Stars
 (38 stars)
PR merge metrics
 (PR metrics pending)

Description

Improve and Standardize Error Handling and Logging Strategy

Description

While we already use pino for logging in our SDK, our error handling approach is inconsistent across the codebase. We need to standardize our error handling and improve our use of the existing logging system to enhance debugging, error reporting, and overall reliability of the SDK. Some error messages donot provide the entire context on what caused the issue and what action user to take to solve the issue.

//eg: does not give us the entire information what can cause the identifier mismatch 
//and there are no logs showing what is the expected identifier and what was the indetifier that was calculated
throw new ProofNotVerifiedError('Identifier Mismatch')

Goals

  • Implement a consistent error handling mechanism across the SDK
  • Standardize the use of the existing pino logger
  • Create custom error types for better error identification
  • Improve error messages for better developer experience

Current State

We currently use pino for logging:

Contributor guide

Research direction
Review the current error handling patterns across the SDK, identify inconsistencies, and design a unified error handling system using custom error classes and standardized logging with pino. Focus on improving error messages to include context and actionable steps.
Tech stack
typescriptnodejs
Domain
backendapi
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitNode.jsTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70