chore: address comments, reduce diff

Author: danisharora099

…essage_channel/mem_local_history.spec.ts …rc/message_channel/local_history.spec.tspackages/sds/src/message_channel/mem_local_history.spec.ts renamed to packages/sds/src/message_channel/local_history.spec.ts packages/sds/src/message_channel/mem_local_history.spec.ts renamed to packages/sds/src/message_channel/local_history.spec.ts

@@ -1,13 +1,13 @@
 import { expect } from "chai";
 
-import { MemLocalHistory } from "./mem_local_history.js";
+import { MemLocalHistory } from "./local_history.js";
 import { ContentMessage } from "./message.js";
 
 describe("MemLocalHistory", () => {
   it("Cap max size when messages are pushed one at a time", () => {
     const maxSize = 2;
 
-    const hist = new MemLocalHistory({ maxSize: maxSize });
+    const hist = new MemLocalHistory({ maxSize });
 
     hist.push(
       new ContentMessage("1", "c", "a", [], 1n, undefined, new Uint8Array([1]))
@@ -31,7 +31,7 @@ describe("MemLocalHistory", () => {
   it("Cap max size when a pushed array is exceeding the cap", () => {
     const maxSize = 2;
 
-    const hist = new MemLocalHistory({ maxSize: maxSize });
+    const hist = new MemLocalHistory({ maxSize });
 
     hist.push(
       new ContentMessage("1", "c", "a", [], 1n, undefined, new Uint8Array([1]))

…src/message_channel/mem_local_history.ts …sds/src/message_channel/local_history.tspackages/sds/src/message_channel/mem_local_history.ts renamed to packages/sds/src/message_channel/local_history.ts packages/sds/src/message_channel/mem_local_history.ts renamed to packages/sds/src/message_channel/local_history.ts

@@ -2,6 +2,7 @@ import { Logger } from "@waku/utils";
 import _ from "lodash";
 
 import { type ChannelId, ContentMessage, isContentMessage } from "./message.js";
+import { ILocalHistory } from "./message_channel.js";
 import { PersistentStorage } from "./persistent_storage.js";
 
 export const DEFAULT_MAX_LENGTH = 10_000;
@@ -19,44 +20,15 @@ export const DEFAULT_MAX_LENGTH = 10_000;
  * If an array of items longer than `maxLength` is pushed, dropping will happen
  * at next push.
  */
-export interface ILocalHistory {
-  length: number;
-  push(...items: ContentMessage[]): number;
-  some(
-    predicate: (
-      value: ContentMessage,
-      index: number,
-      array: ContentMessage[]
-    ) => unknown,
-    thisArg?: any
-  ): boolean;
-  slice(start?: number, end?: number): ContentMessage[];
-  find(
-    predicate: (
-      value: ContentMessage,
-      index: number,
-      obj: ContentMessage[]
-    ) => unknown,
-    thisArg?: any
-  ): ContentMessage | undefined;
-  findIndex(
-    predicate: (
-      value: ContentMessage,
-      index: number,
-      obj: ContentMessage[]
-    ) => unknown,
-    thisArg?: any
-  ): number;
-}
 
-export type MemLocalHistoryOptions = {
+export type LocalHistoryOptions = {
   storage?: ChannelId | PersistentStorage;
   maxSize?: number;
 };
 
 const log = new Logger("sds:local-history");
 
-export class MemLocalHistory implements ILocalHistory {
+export class LocalHistory implements ILocalHistory {
   private items: ContentMessage[] = [];
   private readonly storage?: PersistentStorage;
   private readonly maxSize: number;
@@ -68,7 +40,7 @@ export class MemLocalHistory implements ILocalHistory {
    *   - storage: Optional persistent storage backend for message persistence or channelId to use with PersistentStorage.
    *   - maxSize: The maximum number of messages to store. Optional, defaults to DEFAULT_MAX_LENGTH.
    */
-  public constructor(opts: MemLocalHistoryOptions = {}) {
+  public constructor(opts: LocalHistoryOptions = {}) {
     const { storage, maxSize } = opts;
     this.maxSize = maxSize ?? DEFAULT_MAX_LENGTH;
     if (storage instanceof PersistentStorage) {

packages/sds/src/message_channel/message_channel.spec.ts

@@ -4,8 +4,8 @@ import { expect } from "chai";
 import { DefaultBloomFilter } from "../bloom_filter/bloom.js";
 
 import { MessageChannelEvent } from "./events.js";
-import { MemLocalHistory } from "./mem_local_history.js";
-import { ILocalHistory } from "./mem_local_history.js";
+import { MemLocalHistory } from "./local_history.js";
+import { ILocalHistory } from "./local_history.js";
 import {
   ContentMessage,
   HistoryEntry,

packages/sds/src/message_channel/message_channel.ts

@@ -7,7 +7,7 @@ import { DefaultBloomFilter } from "../bloom_filter/bloom.js";
 
 import { Command, Handlers, ParamsByAction, Task } from "./command_queue.js";
 import { MessageChannelEvent, MessageChannelEvents } from "./events.js";
-import { ILocalHistory, MemLocalHistory } from "./mem_local_history.js";
+import { LocalHistory } from "./local_history.js";
 import {
   ChannelId,
   ContentMessage,
@@ -23,8 +23,6 @@ import {
 } from "./message.js";
 import { RepairConfig, RepairManager } from "./repair/repair.js";
 
-export type { ILocalHistory };
-
 export const DEFAULT_BLOOM_FILTER_OPTIONS = {
   capacity: 10000,
   errorRate: 0.001
@@ -40,6 +38,11 @@ const DEFAULT_POSSIBLE_ACKS_THRESHOLD = 2;
 
 const log = new Logger("sds:message-channel");
 
+export type ILocalHistory = Pick<
+  Array<ContentMessage>,
+  "some" | "push" | "slice" | "find" | "length" | "findIndex"
+>;
+
 export interface MessageChannelOptions {
   causalHistorySize?: number;
   /**
@@ -115,7 +118,7 @@ export class MessageChannel extends TypedEventEmitter<MessageChannelEvents> {
     this.possibleAcks = new Map();
     this.incomingBuffer = [];
     this.localHistory =
-      localHistory ?? new MemLocalHistory({ storage: channelId });
+      localHistory ?? new LocalHistory({ storage: channelId });
     this.causalHistorySize =
       options.causalHistorySize ?? DEFAULT_CAUSAL_HISTORY_SIZE;
     // TODO: this should be determined based on the bloom filter parameters and number of hashes

packages/sds/src/message_channel/persistent_storage.spec.ts

@@ -1,6 +1,6 @@
 import { expect } from "chai";
 
-import { MemLocalHistory } from "./mem_local_history.js";
+import { MemLocalHistory } from "./local_history.js";
 import { ContentMessage } from "./message.js";
 import { HistoryStorage, PersistentStorage } from "./persistent_storage.js";