Skip to content

Commit 68fe7df

Browse files
Jambox11Jambox11
authored
Merge pull request #474 from silver257-web/feature/wallet-cache-layer-stub
Feature/wallet cache layer stub
2 parents ecd8a43 + df89218 commit 68fe7df

2 files changed

Lines changed: 369 additions & 0 deletions

File tree

‎src/wallets/wallet-cache.service.spec.ts‎

Lines changed: 227 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,227 @@
1+
import { Test, TestingModule } from '@nestjs/testing';
2+
import { WalletCacheService } from './wallet-cache.service';
3+
import { CacheService } from '../common/cache/cache.service';
4+
import { Wallet, WalletNetwork, WalletStatus } from './domain/wallet.model';
5+
6+
describe('WalletCacheService', () => {
7+
let service: WalletCacheService;
8+
let cacheService: CacheService;
9+
10+
const mockWallet: Wallet = {
11+
id: 'wallet-123',
12+
userId: 'user-456',
13+
publicKey: 'GABC123XYZ',
14+
encryptedSecret: 'encrypted-secret-data',
15+
network: WalletNetwork.TESTNET,
16+
status: WalletStatus.ACTIVE,
17+
secretVersion: 1,
18+
encryptionVersion: 'v1',
19+
keyVersion: 1,
20+
successorId: null,
21+
createdAt: new Date('2026-06-30'),
22+
updatedAt: new Date('2026-06-30'),
23+
};
24+
25+
beforeEach(async () => {
26+
const module: TestingModule = await Test.createTestingModule({
27+
providers: [WalletCacheService, CacheService],
28+
}).compile();
29+
30+
service = module.get<WalletCacheService>(WalletCacheService);
31+
cacheService = module.get<CacheService>(CacheService);
32+
});
33+
34+
afterEach(() => {
35+
cacheService.clear();
36+
});
37+
38+
describe('getWalletById', () => {
39+
it('should return null when wallet is not cached', () => {
40+
const result = service.getWalletById('non-existent-id');
41+
expect(result).toBeNull();
42+
});
43+
44+
it('should return cached wallet after setting', () => {
45+
service.setWalletById(mockWallet.id, mockWallet);
46+
const result = service.getWalletById(mockWallet.id);
47+
expect(result).toEqual(mockWallet);
48+
});
49+
});
50+
51+
describe('setWalletById', () => {
52+
it('should cache wallet with correct TTL', () => {
53+
service.setWalletById(mockWallet.id, mockWallet);
54+
const cached = cacheService.get<Wallet>(`wallet:${mockWallet.id}`);
55+
expect(cached).toEqual(mockWallet);
56+
});
57+
58+
it('should overwrite existing cached wallet', () => {
59+
service.setWalletById(mockWallet.id, mockWallet);
60+
const updatedWallet = { ...mockWallet, status: WalletStatus.SUSPENDED };
61+
service.setWalletById(mockWallet.id, updatedWallet);
62+
const result = service.getWalletById(mockWallet.id);
63+
expect(result?.status).toBe(WalletStatus.SUSPENDED);
64+
});
65+
});
66+
67+
describe('getWalletByUser', () => {
68+
it('should return null when wallet is not cached', () => {
69+
const result = service.getWalletByUser('user-999', WalletNetwork.TESTNET);
70+
expect(result).toBeNull();
71+
});
72+
73+
it('should return cached wallet for user and network', () => {
74+
service.setWalletByUser(
75+
mockWallet.userId,
76+
mockWallet.network,
77+
mockWallet,
78+
);
79+
const result = service.getWalletByUser(mockWallet.userId, mockWallet.network);
80+
expect(result).toEqual(mockWallet);
81+
});
82+
83+
it('should differentiate between networks for same user', () => {
84+
service.setWalletByUser(mockWallet.userId, WalletNetwork.TESTNET, mockWallet);
85+
const mainnetWallet = { ...mockWallet, network: WalletNetwork.MAINNET };
86+
service.setWalletByUser(mockWallet.userId, WalletNetwork.MAINNET, mainnetWallet);
87+
88+
const testnetResult = service.getWalletByUser(
89+
mockWallet.userId,
90+
WalletNetwork.TESTNET,
91+
);
92+
const mainnetResult = service.getWalletByUser(
93+
mockWallet.userId,
94+
WalletNetwork.MAINNET,
95+
);
96+
97+
expect(testnetResult?.network).toBe(WalletNetwork.TESTNET);
98+
expect(mainnetResult?.network).toBe(WalletNetwork.MAINNET);
99+
});
100+
});
101+
102+
describe('setWalletByUser', () => {
103+
it('should cache wallet by user and network', () => {
104+
service.setWalletByUser(
105+
mockWallet.userId,
106+
mockWallet.network,
107+
mockWallet,
108+
);
109+
const cached = cacheService.get<Wallet>(
110+
`wallet:user:${mockWallet.userId}:${mockWallet.network}`,
111+
);
112+
expect(cached).toEqual(mockWallet);
113+
});
114+
});
115+
116+
describe('invalidateWalletById', () => {
117+
it('should remove wallet from cache by ID', () => {
118+
service.setWalletById(mockWallet.id, mockWallet);
119+
expect(service.getWalletById(mockWallet.id)).toEqual(mockWallet);
120+
121+
service.invalidateWalletById(mockWallet.id);
122+
expect(service.getWalletById(mockWallet.id)).toBeNull();
123+
});
124+
125+
it('should not throw error when invalidating non-existent cache key', () => {
126+
expect(() => service.invalidateWalletById('non-existent')).not.toThrow();
127+
});
128+
});
129+
130+
describe('invalidateWalletByUser', () => {
131+
it('should remove wallet from cache by user and network', () => {
132+
service.setWalletByUser(
133+
mockWallet.userId,
134+
mockWallet.network,
135+
mockWallet,
136+
);
137+
expect(
138+
service.getWalletByUser(mockWallet.userId, mockWallet.network),
139+
).toEqual(mockWallet);
140+
141+
service.invalidateWalletByUser(mockWallet.userId, mockWallet.network);
142+
expect(
143+
service.getWalletByUser(mockWallet.userId, mockWallet.network),
144+
).toBeNull();
145+
});
146+
147+
it('should only invalidate specific user-network combination', () => {
148+
service.setWalletByUser(mockWallet.userId, WalletNetwork.TESTNET, mockWallet);
149+
service.setWalletByUser(mockWallet.userId, WalletNetwork.MAINNET, mockWallet);
150+
151+
service.invalidateWalletByUser(mockWallet.userId, WalletNetwork.TESTNET);
152+
153+
expect(
154+
service.getWalletByUser(mockWallet.userId, WalletNetwork.TESTNET),
155+
).toBeNull();
156+
expect(
157+
service.getWalletByUser(mockWallet.userId, WalletNetwork.MAINNET),
158+
).toEqual(mockWallet);
159+
});
160+
});
161+
162+
describe('invalidateUserWallets', () => {
163+
it('should invalidate all wallets for user across networks', () => {
164+
const networks = [WalletNetwork.TESTNET, WalletNetwork.MAINNET];
165+
networks.forEach((network) => {
166+
service.setWalletByUser(mockWallet.userId, network, mockWallet);
167+
});
168+
169+
service.invalidateUserWallets(mockWallet.userId, networks);
170+
171+
networks.forEach((network) => {
172+
expect(
173+
service.getWalletByUser(mockWallet.userId, network),
174+
).toBeNull();
175+
});
176+
});
177+
178+
it('should handle empty network list', () => {
179+
expect(() => service.invalidateUserWallets(mockWallet.userId, [])).not.toThrow();
180+
});
181+
});
182+
183+
describe('clearAllWalletCache', () => {
184+
it('should clear all cache entries', () => {
185+
service.setWalletById(mockWallet.id, mockWallet);
186+
service.setWalletByUser(
187+
mockWallet.userId,
188+
mockWallet.network,
189+
mockWallet,
190+
);
191+
192+
service.clearAllWalletCache();
193+
194+
expect(service.getWalletById(mockWallet.id)).toBeNull();
195+
expect(
196+
service.getWalletByUser(mockWallet.userId, mockWallet.network),
197+
).toBeNull();
198+
});
199+
});
200+
201+
describe('cache key building', () => {
202+
it('should use consistent cache key format for wallet ID', () => {
203+
service.setWalletById('test-wallet-id', mockWallet);
204+
const directCacheValue = cacheService.get(`wallet:test-wallet-id`);
205+
expect(directCacheValue).toEqual(mockWallet);
206+
});
207+
208+
it('should use consistent cache key format for user-network', () => {
209+
service.setWalletByUser('test-user', 'TESTNET', mockWallet);
210+
const directCacheValue = cacheService.get(`wallet:user:test-user:TESTNET`);
211+
expect(directCacheValue).toEqual(mockWallet);
212+
});
213+
});
214+
215+
describe('cache expiration', () => {
216+
it('should expire cached wallet after TTL', async () => {
217+
// This test verifies that cache entries expire after 5 minutes
218+
// For unit testing, we mock this by manually checking the cache service behavior
219+
service.setWalletById(mockWallet.id, mockWallet);
220+
const initialResult = service.getWalletById(mockWallet.id);
221+
expect(initialResult).not.toBeNull();
222+
223+
// Note: Real TTL validation would require async tests or mocking Date.now()
224+
// This test demonstrates the cache structure is set up correctly
225+
});
226+
});
227+
});

‎src/wallets/wallet-cache.service.ts‎

Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
import { Injectable, Logger } from '@nestjs/common';
2+
import { CacheService } from '../common/cache/cache.service';
3+
import { Wallet } from './domain/wallet.model';
4+
5+
/**
6+
* Wallet Cache Service
7+
*
8+
* Manages caching for wallet lookups and data to reduce database queries.
9+
* Provides cache management operations including get, set, and invalidation.
10+
*
11+
* Cache Keys:
12+
* - wallet:<walletId> - Cached wallet by ID
13+
* - wallet:user:<userId>:<network> - Cached wallet by user and network
14+
*/
15+
@Injectable()
16+
export class WalletCacheService {
17+
private readonly logger = new Logger(WalletCacheService.name);
18+
19+
// Cache TTL (5 minutes in milliseconds)
20+
private readonly WALLET_CACHE_TTL = 5 * 60 * 1000;
21+
22+
// Cache key prefixes
23+
private readonly WALLET_ID_PREFIX = 'wallet:';
24+
private readonly WALLET_USER_PREFIX = 'wallet:user:';
25+
26+
constructor(private readonly cache: CacheService) {}
27+
28+
/**
29+
* Get cached wallet by ID
30+
* @param walletId - The wallet ID to retrieve
31+
* @returns Cached wallet or null if not found or expired
32+
*/
33+
getWalletById(walletId: string): Wallet | null {
34+
const cacheKey = this.buildWalletIdKey(walletId);
35+
return this.cache.get<Wallet>(cacheKey);
36+
}
37+
38+
/**
39+
* Set wallet in cache by ID
40+
* @param walletId - The wallet ID
41+
* @param wallet - The wallet data to cache
42+
*/
43+
setWalletById(walletId: string, wallet: Wallet): void {
44+
const cacheKey = this.buildWalletIdKey(walletId);
45+
this.cache.set(cacheKey, wallet, this.WALLET_CACHE_TTL);
46+
this.logger.debug(`Cached wallet ${walletId} with TTL ${this.WALLET_CACHE_TTL}ms`);
47+
}
48+
49+
/**
50+
* Get cached wallet by user and network
51+
* @param userId - The user ID
52+
* @param network - The network (e.g., TESTNET, MAINNET)
53+
* @returns Cached wallet or null if not found or expired
54+
*/
55+
getWalletByUser(userId: string, network: string): Wallet | null {
56+
const cacheKey = this.buildWalletUserKey(userId, network);
57+
return this.cache.get<Wallet>(cacheKey);
58+
}
59+
60+
/**
61+
* Set wallet in cache by user and network
62+
* @param userId - The user ID
63+
* @param network - The network
64+
* @param wallet - The wallet data to cache
65+
*/
66+
setWalletByUser(userId: string, network: string, wallet: Wallet): void {
67+
const cacheKey = this.buildWalletUserKey(userId, network);
68+
this.cache.set(cacheKey, wallet, this.WALLET_CACHE_TTL);
69+
this.logger.debug(
70+
`Cached wallet for user ${userId} on ${network} with TTL ${this.WALLET_CACHE_TTL}ms`,
71+
);
72+
}
73+
74+
/**
75+
* Invalidate cached wallet by ID
76+
* Clears cache entry when wallet is updated or deleted
77+
* @param walletId - The wallet ID to invalidate
78+
*/
79+
invalidateWalletById(walletId: string): void {
80+
const cacheKey = this.buildWalletIdKey(walletId);
81+
const deleted = this.cache.delete(cacheKey);
82+
if (deleted) {
83+
this.logger.debug(`Invalidated cache for wallet ${walletId}`);
84+
}
85+
}
86+
87+
/**
88+
* Invalidate cached wallet by user and network
89+
* Clears cache entry when wallet is updated or deleted
90+
* @param userId - The user ID
91+
* @param network - The network
92+
*/
93+
invalidateWalletByUser(userId: string, network: string): void {
94+
const cacheKey = this.buildWalletUserKey(userId, network);
95+
const deleted = this.cache.delete(cacheKey);
96+
if (deleted) {
97+
this.logger.debug(
98+
`Invalidated cache for wallet user ${userId} on ${network}`,
99+
);
100+
}
101+
}
102+
103+
/**
104+
* Invalidate all cached entries for a user across all networks
105+
* Useful when user is deleted or suspended
106+
* @param userId - The user ID
107+
* @param networks - List of networks to invalidate (e.g., ['TESTNET', 'MAINNET'])
108+
*/
109+
invalidateUserWallets(userId: string, networks: string[]): void {
110+
networks.forEach((network) => {
111+
this.invalidateWalletByUser(userId, network);
112+
});
113+
this.logger.debug(
114+
`Invalidated all wallet caches for user ${userId} across ${networks.length} networks`,
115+
);
116+
}
117+
118+
/**
119+
* Clear all wallet-related cache entries
120+
* Use with caution - typically only needed during cache maintenance
121+
*/
122+
clearAllWalletCache(): void {
123+
this.cache.clear();
124+
this.logger.warn('Cleared all wallet cache entries');
125+
}
126+
127+
/**
128+
* Build cache key for wallet lookup by ID
129+
* @private
130+
*/
131+
private buildWalletIdKey(walletId: string): string {
132+
return `${this.WALLET_ID_PREFIX}${walletId}`;
133+
}
134+
135+
/**
136+
* Build cache key for wallet lookup by user and network
137+
* @private
138+
*/
139+
private buildWalletUserKey(userId: string, network: string): string {
140+
return `${this.WALLET_USER_PREFIX}${userId}:${network}`;
141+
}
142+
}

0 commit comments

Comments
 (0)