feat: add cache factory, unify client interface, remove fallback (#4558)

[jasuwienas]

Description

1. The Cache Client creation process has been moved into a dedicated factory.
2. A single, unified client interface is now used instead of separate interfaces for each client (IRedisClient and IClient).
3. The fallback mechanism has been removed from the cache service, along with all conditions determining which client to use - the service now relies on a single client.
4. Most of the changes are in the tests. Since the cache service creation method has been updated, all test cases that instantiate it now follow the new logic.

Related issue(s)

Fixes #4558

Testing Guide

1. Run all tests with debug mode on WITHOUT this tasks changes applied.
2. Make sure they all pass.

Changes from original design (optional)

Additional work needed

The Redis cache service still implements an additional, unnecessary interface and only measures logs and delegates calls to the underlying client. It will be removed entirely in this PR.

Checklist

• I've assigned an assignee to this PR and related issue(s) (if applicable)
• I've assigned a label to this PR and related issue(s) (if applicable)
• I've assigned a milestone to this PR and related issue(s) (if applicable)
• I've updated documentation (code comments, README, etc. if applicable)
• I've done sufficient testing (unit, integration, etc.)

[quiet-node]

@jasuwienas Nice work it's a big one! However, The issue #4558 seems to ask for a fairly simple change: adding a CacheFactory to choose between RedisCache and LocalCache, right? That would make it consistent with PendingTransactionStorageFactory, the upcoming LockStrategyFactory, and IPRateLimiterFactory. But this PR seems to include a lot more than that.

I’m also seeing things like MeasureCache and FallbackCache, which look like new concepts. Have we had a design session as a team about these changes? I’m just wondering if we’re adding more complexity than needed for what was supposed to be a straightforward technical-debt fix.

[jasuwienas]

@quiet-node Right, I'll prepare an ADR.

to choose between RedisCache and LocalCache

Not exactly. Our current implementation works like this:

1. We first attempt to communicate with the Redis client.
2. If it succeeds - great, we use Redis.
3. If it fails - we fall back to LRU.

This is precisely what the FallbackClient was originally designed to support.
I wanted to maintain a single ClientInterface returned by Factory (as required in the task) while keeping the existing fallback behavior unchanged.

With that approach, the factory would still return one unified client object with a consistent interface.

The alternative would be this: https://github.com/hiero-ledger/hiero-json-rpc-relay/pull/4628/files

the factory returns both the shared and internal clients here, allowing us to keep cacheService as it is.

Or this:

https://github.com/jasuwienas/hiero-json-rpc-relay/tree/4558-factory-for-cache-client-simplified-2

(we are calling the factory twice)

[jasuwienas]

Dropping the fallback mechanism is a breaking change! During review, please take a look at:
packages/relay/tests/lib/services/cacheService/cacheService.spec.ts
to see what has changed

[jasuwienas]

BTW. To investigate the retry strategy take a look at packages/relay/src/lib/client/redisClientManager.ts

I think we already have it covered there.

[codecov]

Codecov Report

❌ Patch coverage is 81.98198% with 60 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
...kages/relay/src/lib/clients/cache/localLRUCache.ts	64.17%	24 Missing ⚠️
...elay/src/lib/services/cacheService/cacheService.ts	57.44%	20 Missing ⚠️
...src/lib/clients/cache/redisCache/safeRedisCache.ts	94.18%	10 Missing ⚠️
...ckages/relay/src/lib/clients/cache/ICacheClient.ts	0.00%	4 Missing ⚠️
...lay/src/lib/clients/cache/redisCache/redisCache.ts	90.00%	1 Missing ⚠️
...ages/relay/src/lib/factories/cacheClientFactory.ts	95.45%	1 Missing ⚠️

❌ Your project check has failed because the head coverage (68.38%) is below the target coverage (80.00%). You can increase the head coverage or adjust the target coverage.

❗ There is a different number of reports uploaded between BASE (91ec34c) and HEAD (fd8e5b7). Click for more details.

HEAD has 19 uploads less than BASE

Flag	BASE (91ec34c)	HEAD (fd8e5b7)
	17	2
relay	1	0
server	1	0
ws-server	1	0
config-service	1	0

@@             Coverage Diff             @@
##             main    #4623       +/-   ##
===========================================
- Coverage   95.47%   68.38%   -27.09%     
===========================================
  Files         129      131        +2     
  Lines       20928    21019       +91     
  Branches     1795      519     -1276     
===========================================
- Hits        19981    14374     -5607     
- Misses        927     6631     +5704     
+ Partials       20       14        -6     

Flag	Coverage Δ
config-service	?
relay	?
server	?
ws-server	?

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
...es/relay/src/lib/clients/cache/redisCache/index.ts	100.00% <100.00%> (ø)
packages/relay/src/lib/clients/index.ts	100.00% <100.00%> (ø)
packages/relay/src/lib/relay.ts	95.48% <100.00%> (-3.15%)	⬇️
...lay/src/lib/clients/cache/redisCache/redisCache.ts	74.73% <90.00%> (ø)
...ages/relay/src/lib/factories/cacheClientFactory.ts	95.45% <95.45%> (ø)
...ckages/relay/src/lib/clients/cache/ICacheClient.ts	0.00% <0.00%> (ø)
...src/lib/clients/cache/redisCache/safeRedisCache.ts	94.18% <94.18%> (ø)
...elay/src/lib/services/cacheService/cacheService.ts	86.72% <57.44%> (-10.78%)	⬇️
...kages/relay/src/lib/clients/cache/localLRUCache.ts	57.95% <64.17%> (-38.90%)	⬇️

... and 72 files with indirect coverage changes

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.