valkey-io/valkey-glide

Node: Reduce Non-Null Assertions about BaseClient's config

Open

#2,679 opened on Nov 13, 2024

View on GitHub
 (5 comments) (0 reactions) (2 assignees)Java (166 forks)auto 404
Task 🔧Users Paingood first issuenode 🐢

Repository metrics

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

Description

Description

I noticed that while the BaseClient constructor's options parameter is marked as optional (options?: BaseClientConfiguration), it's always provided with a non-null value in all creation paths through createClient()[1][2]. This creates an unnecessary nullable context that leads to multiple non-null assertions (!)[1][2][3] throughout the codebase.

This change would make the code more straightforward and remove potentially confusing null-checking context for developers first encountering the codebase. The nullable parameter currently serves no practical purpose since options are always provided during client creation.

Checklist

  • Make the options parameter required or give default value (e.g. {}) in the BaseClient constructor
  • Remove non-null assertions where this.config is used
  • Simplify the type safety guarantees

Additional Notes

No response

Contributor guide

Research direction
Examine the BaseClient constructor signature and all call sites in GlideClient.ts and GlideClusterClient.ts. Then remove the optionality of the options parameter and eliminate non null assertions in the class.
Tech stack
typescriptnodejs
Domain
backend
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.
1-3 hours
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
TypeScriptGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80