fix: stats for single shard

Signed-off-by: ferhat elmas <elmas.ferhat@gmail.com>

Author: ferhatelmas

src/internal/sharding/store.ts

@@ -25,6 +25,14 @@ export type ReservationRow = {
   created_at: string
 }
 
+export type ShardStats = Array<{
+  shardId: string
+  shardKey: string
+  capacity: number
+  used: number
+  free: number
+}>
+
 /** Factory that opens a transaction and passes a store bound to that tx */
 export interface ShardStoreFactory<Tnx = unknown> {
   withTransaction<T>(fn: (store: ShardStore) => Promise<T>): Promise<T>
@@ -101,11 +109,7 @@ export interface ShardStore {
   findShardByResourceId(tenantId: string, resourceId: string): Promise<ShardRow | null>
 
   // Stats
-  shardStats(
-    kind?: ResourceKind
-  ): Promise<
-    Array<{ shardId: string; shardKey: string; capacity: number; used: number; free: number }>
-  >
+  shardStats(kind?: ResourceKind): Promise<ShardStats>
 
   findShardById(shardId: number): Promise<ShardRow | null>
 }

src/internal/sharding/strategy/single-shard.ts

@@ -1,4 +1,4 @@
-import { ResourceKind, ShardRow, ShardStatus } from '@internal/sharding/store'
+import { ResourceKind, ShardRow, ShardStats, ShardStatus } from '@internal/sharding/store'
 import { Sharder, ShardResource } from '../sharder'
 
 export class SingleShard implements Sharder {
@@ -23,14 +23,16 @@ export class SingleShard implements Sharder {
     ])
   }
 
-  shardStats(): Promise<any> {
-    return Promise.resolve({
-      shardId: 1,
-      shardKey: this.singleShard.shardKey,
-      capacity: this.singleShard.capacity,
-      used: -1,
-      free: -1,
-    })
+  shardStats(): Promise<ShardStats> {
+    return Promise.resolve([
+      {
+        shardId: '1',
+        shardKey: this.singleShard.shardKey,
+        capacity: this.singleShard.capacity,
+        used: -1,
+        free: -1,
+      },
+    ])
   }
 
   withTnx(): Sharder {
@@ -108,8 +110,4 @@ export class SingleShard implements Sharder {
   setShardStatus(): Promise<void> {
     return Promise.resolve(undefined)
   }
-
-  shardStatsByKind(): Promise<any> {
-    return Promise.resolve(undefined)
-  }
 }

src/test/sharding.test.ts

@@ -2,7 +2,7 @@
 
 import { multitenantKnex } from '@internal/database'
 import { runMultitenantMigrations } from '@internal/database/migrations'
-import { KnexShardStoreFactory, ShardCatalog } from '@internal/sharding'
+import { KnexShardStoreFactory, ShardCatalog, SingleShard } from '@internal/sharding'
 import {
   ExpiredReservationError,
   NoActiveShardError,
@@ -798,3 +798,22 @@ describe('Sharding System', () => {
     })
   })
 })
+
+describe('SingleShard', () => {
+  it('returns shard stats in the canonical array shape', async () => {
+    const sharder = new SingleShard({
+      shardKey: 'single-shard-key',
+      capacity: 25,
+    })
+
+    await expect(sharder.shardStats()).resolves.toEqual([
+      {
+        shardId: '1',
+        shardKey: 'single-shard-key',
+        capacity: 25,
+        used: -1,
+        free: -1,
+      },
+    ])
+  })
+})