2022-07-25 11:01:37 +00:00
|
|
|
## This module defines a message store interface. Implementations of
|
|
|
|
## MessageStore are used by the `WakuStore` protocol to store and
|
|
|
|
## retrieve historical messages
|
2022-11-04 09:52:27 +00:00
|
|
|
when (NimMajor, NimMinor) < (1, 4):
|
|
|
|
{.push raises: [Defect].}
|
|
|
|
else:
|
|
|
|
{.push raises: [].}
|
2021-07-14 17:58:46 +00:00
|
|
|
|
2021-01-22 09:39:16 +00:00
|
|
|
import
|
2022-09-26 09:50:15 +00:00
|
|
|
std/[options, times],
|
|
|
|
stew/results
|
2022-08-01 12:09:41 +00:00
|
|
|
import
|
2022-11-09 17:50:18 +00:00
|
|
|
../../utils/time,
|
2022-09-28 11:36:05 +00:00
|
|
|
../waku_message,
|
2022-11-09 17:50:18 +00:00
|
|
|
./common
|
2021-01-22 09:39:16 +00:00
|
|
|
|
|
|
|
|
2022-08-01 12:09:41 +00:00
|
|
|
type
|
2021-01-22 09:39:16 +00:00
|
|
|
MessageStoreResult*[T] = Result[T, string]
|
2022-08-01 12:09:41 +00:00
|
|
|
|
2022-11-09 17:50:18 +00:00
|
|
|
MessageStoreRow* = (PubsubTopic, WakuMessage, seq[byte], Timestamp)
|
2021-01-22 09:39:16 +00:00
|
|
|
|
|
|
|
MessageStore* = ref object of RootObj
|
|
|
|
|
2022-07-25 11:01:37 +00:00
|
|
|
|
2021-01-22 09:39:16 +00:00
|
|
|
# MessageStore interface
|
2022-11-09 17:50:18 +00:00
|
|
|
|
2022-11-09 08:55:47 +00:00
|
|
|
method put*(ms: MessageStore, pubsubTopic: PubsubTopic, message: WakuMessage, digest: MessageDigest, receivedTime: Timestamp): MessageStoreResult[void] {.base.} = discard
|
2022-09-26 09:50:15 +00:00
|
|
|
|
2022-11-09 08:55:47 +00:00
|
|
|
method put*(ms: MessageStore, pubsubTopic: PubsubTopic, message: WakuMessage): MessageStoreResult[void] {.base.} =
|
2022-09-26 09:50:15 +00:00
|
|
|
let
|
|
|
|
digest = computeDigest(message)
|
2022-10-05 15:58:24 +00:00
|
|
|
receivedTime = if message.timestamp > 0: message.timestamp
|
2022-11-09 17:50:18 +00:00
|
|
|
else: getNanosecondTime(getTime().toUnixFloat())
|
2022-09-26 09:50:15 +00:00
|
|
|
|
|
|
|
ms.put(pubsubTopic, message, digest, receivedTime)
|
|
|
|
|
2022-08-01 12:09:41 +00:00
|
|
|
|
2022-08-01 16:21:11 +00:00
|
|
|
method getAllMessages*(ms: MessageStore): MessageStoreResult[seq[MessageStoreRow]] {.base.} = discard
|
2022-08-01 12:09:41 +00:00
|
|
|
|
|
|
|
method getMessagesByHistoryQuery*(
|
2022-08-01 16:21:11 +00:00
|
|
|
ms: MessageStore,
|
2022-08-01 12:09:41 +00:00
|
|
|
contentTopic = none(seq[ContentTopic]),
|
2022-11-09 17:50:18 +00:00
|
|
|
pubsubTopic = none(PubsubTopic),
|
|
|
|
cursor = none(HistoryCursor),
|
2022-08-01 12:09:41 +00:00
|
|
|
startTime = none(Timestamp),
|
|
|
|
endTime = none(Timestamp),
|
2022-09-27 09:47:25 +00:00
|
|
|
maxPageSize = DefaultPageSize,
|
2022-08-01 12:09:41 +00:00
|
|
|
ascendingOrder = true
|
2022-10-03 15:36:17 +00:00
|
|
|
): MessageStoreResult[seq[MessageStoreRow]] {.base.} = discard
|
2022-09-09 14:31:33 +00:00
|
|
|
|
2022-09-15 19:12:13 +00:00
|
|
|
|
|
|
|
# Store manipulation
|
|
|
|
|
2022-09-15 16:13:30 +00:00
|
|
|
method getMessagesCount*(ms: MessageStore): MessageStoreResult[int64] {.base.} = discard
|
2022-09-15 19:12:13 +00:00
|
|
|
|
|
|
|
method getOldestMessageTimestamp*(ms: MessageStore): MessageStoreResult[Timestamp] {.base.} = discard
|
|
|
|
|
|
|
|
method getNewestMessageTimestamp*(ms: MessageStore): MessageStoreResult[Timestamp] {.base.} = discard
|
|
|
|
|
|
|
|
|
|
|
|
method deleteMessagesOlderThanTimestamp*(ms: MessageStore, ts: Timestamp): MessageStoreResult[void] {.base.} = discard
|
|
|
|
|
|
|
|
method deleteOldestMessagesNotWithinLimit*(ms: MessageStore, limit: int): MessageStoreResult[void] {.base.} = discard
|