2019-11-21 16:19:22 +00:00
|
|
|
package protocol
|
|
|
|
|
|
|
|
import (
|
2020-12-10 10:12:51 +00:00
|
|
|
"bytes"
|
2019-11-21 16:19:22 +00:00
|
|
|
"database/sql"
|
2023-03-28 14:40:00 +00:00
|
|
|
"fmt"
|
2019-11-21 16:19:22 +00:00
|
|
|
"math"
|
|
|
|
"sort"
|
|
|
|
"strconv"
|
|
|
|
"strings"
|
|
|
|
"testing"
|
2020-10-28 13:41:22 +00:00
|
|
|
"time"
|
2019-11-21 16:19:22 +00:00
|
|
|
|
2020-01-02 09:10:19 +00:00
|
|
|
"github.com/stretchr/testify/require"
|
|
|
|
|
2023-10-02 09:28:42 +00:00
|
|
|
"github.com/status-im/status-go/appdatabase"
|
2020-09-01 10:34:28 +00:00
|
|
|
"github.com/status-im/status-go/eth-node/crypto"
|
|
|
|
"github.com/status-im/status-go/eth-node/types"
|
2020-09-01 13:27:01 +00:00
|
|
|
"github.com/status-im/status-go/protocol/common"
|
Move to protobuf for Message type (#1706)
* Use a single Message type `v1/message.go` and `message.go` are the same now, and they embed `protobuf.ChatMessage`
* Use `SendChatMessage` for sending chat messages, this is basically the old `Send` but a bit more flexible so we can send different message types (stickers,commands), and not just text.
* Remove dedup from services/shhext. Because now we process in status-protocol, dedup makes less sense, as those messages are going to be processed anyway, so removing for now, we can re-evaluate if bringing it to status-go or not.
* Change the various retrieveX method to a single one:
`RetrieveAll` will be processing those messages that it can process (Currently only `Message`), and return the rest in `RawMessages` (still transit). The format for the response is:
`Chats`: -> The chats updated by receiving the message
`Messages`: -> The messages retrieved (already matched to a chat)
`Contacts`: -> The contacts updated by the messages
`RawMessages` -> Anything else that can't be parsed, eventually as we move everything to status-protocol-go this will go away.
2019-12-05 16:25:34 +00:00
|
|
|
"github.com/status-im/status-go/protocol/protobuf"
|
2019-11-21 16:19:22 +00:00
|
|
|
"github.com/status-im/status-go/protocol/sqlite"
|
2023-10-02 09:28:42 +00:00
|
|
|
"github.com/status-im/status-go/t/helpers"
|
2019-11-21 16:19:22 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
func TestTableUserMessagesAllFieldsCount(t *testing.T) {
|
|
|
|
db := sqlitePersistence{}
|
2020-05-20 12:16:12 +00:00
|
|
|
expected := len(strings.Split(db.tableUserMessagesAllFields(), ","))
|
|
|
|
require.Equal(t, expected, db.tableUserMessagesAllFieldsCount())
|
2019-11-21 16:19:22 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
func TestSaveMessages(t *testing.T) {
|
|
|
|
db, err := openTestDB()
|
|
|
|
require.NoError(t, err)
|
2022-03-28 10:10:40 +00:00
|
|
|
p := newSQLitePersistence(db)
|
2019-11-21 16:19:22 +00:00
|
|
|
|
|
|
|
for i := 0; i < 10; i++ {
|
|
|
|
id := strconv.Itoa(i)
|
|
|
|
err := insertMinimalMessage(p, id)
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
m, err := p.MessageByID(id)
|
|
|
|
require.NoError(t, err)
|
|
|
|
require.EqualValues(t, id, m.ID)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
Add replies to messages
Currently replies to messages are handled in status-react.
This causes some issues with the fact that sometimes replies might come
out of order, they might be offloaded to the database etc.
This commit changes the behavior so that status-go always returns the
replies, and in case a reply comes out of order (first the reply, later
the message being replied to), it will include in the messages the
updated message.
It also adds some fields (RTL,Replace,LineCount) to the database which
were not previously saved, resulting in some potential bugs.
The method that we use to pull replies is currently a bit naive, we just
pull all the message again from the database, but has the advantage of
being simple. It will go through performance testing to make sure
performnace are acceptable, if so I think it's reasonable to avoid some
complexity.
2020-04-08 13:42:02 +00:00
|
|
|
func TestMessagesByIDs(t *testing.T) {
|
|
|
|
db, err := openTestDB()
|
|
|
|
require.NoError(t, err)
|
2022-03-28 10:10:40 +00:00
|
|
|
p := newSQLitePersistence(db)
|
Add replies to messages
Currently replies to messages are handled in status-react.
This causes some issues with the fact that sometimes replies might come
out of order, they might be offloaded to the database etc.
This commit changes the behavior so that status-go always returns the
replies, and in case a reply comes out of order (first the reply, later
the message being replied to), it will include in the messages the
updated message.
It also adds some fields (RTL,Replace,LineCount) to the database which
were not previously saved, resulting in some potential bugs.
The method that we use to pull replies is currently a bit naive, we just
pull all the message again from the database, but has the advantage of
being simple. It will go through performance testing to make sure
performnace are acceptable, if so I think it's reasonable to avoid some
complexity.
2020-04-08 13:42:02 +00:00
|
|
|
|
|
|
|
var ids []string
|
|
|
|
for i := 0; i < 10; i++ {
|
|
|
|
id := strconv.Itoa(i)
|
|
|
|
err := insertMinimalMessage(p, id)
|
|
|
|
require.NoError(t, err)
|
|
|
|
ids = append(ids, id)
|
|
|
|
|
|
|
|
}
|
|
|
|
m, err := p.MessagesByIDs(ids)
|
|
|
|
require.NoError(t, err)
|
|
|
|
require.Len(t, m, 10)
|
|
|
|
}
|
|
|
|
|
2022-09-20 09:13:44 +00:00
|
|
|
func TestMessagesByIDs_WithDiscordMessagesPayload(t *testing.T) {
|
|
|
|
db, err := openTestDB()
|
|
|
|
require.NoError(t, err)
|
|
|
|
p := newSQLitePersistence(db)
|
|
|
|
|
|
|
|
var ids []string
|
|
|
|
for i := 0; i < 10; i++ {
|
|
|
|
id := strconv.Itoa(i)
|
|
|
|
err := insertMinimalMessage(p, id)
|
|
|
|
require.NoError(t, err)
|
|
|
|
err = insertMinimalDiscordMessage(p, id, id)
|
|
|
|
require.NoError(t, err)
|
|
|
|
ids = append(ids, id)
|
|
|
|
}
|
|
|
|
|
|
|
|
m, err := p.MessagesByIDs(ids)
|
|
|
|
require.NoError(t, err)
|
|
|
|
require.Len(t, m, 10)
|
|
|
|
|
|
|
|
for _, _m := range m {
|
|
|
|
require.NotNil(t, _m.GetDiscordMessage())
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-11-21 16:19:22 +00:00
|
|
|
func TestMessageByID(t *testing.T) {
|
|
|
|
db, err := openTestDB()
|
|
|
|
require.NoError(t, err)
|
2022-03-28 10:10:40 +00:00
|
|
|
p := newSQLitePersistence(db)
|
2019-11-21 16:19:22 +00:00
|
|
|
id := "1"
|
|
|
|
|
|
|
|
err = insertMinimalMessage(p, id)
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
m, err := p.MessageByID(id)
|
|
|
|
require.NoError(t, err)
|
|
|
|
require.EqualValues(t, id, m.ID)
|
|
|
|
}
|
|
|
|
|
2022-08-04 16:16:56 +00:00
|
|
|
func TestMessageByID_WithDiscordMessagePayload(t *testing.T) {
|
|
|
|
|
|
|
|
db, err := openTestDB()
|
|
|
|
require.NoError(t, err)
|
|
|
|
p := newSQLitePersistence(db)
|
|
|
|
id := "1"
|
|
|
|
discordMessageID := "2"
|
|
|
|
|
|
|
|
err = insertMinimalDiscordMessage(p, id, discordMessageID)
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
m, err := p.MessageByID(id)
|
|
|
|
require.NoError(t, err)
|
|
|
|
require.EqualValues(t, id, m.ID)
|
|
|
|
require.NotNil(t, m.GetDiscordMessage())
|
|
|
|
require.EqualValues(t, discordMessageID, m.GetDiscordMessage().Id)
|
|
|
|
require.EqualValues(t, "2", m.GetDiscordMessage().Author.Id)
|
|
|
|
}
|
|
|
|
|
2022-09-20 09:13:44 +00:00
|
|
|
func TestMessageByID_WithDiscordMessageAttachmentPayload(t *testing.T) {
|
|
|
|
|
|
|
|
db, err := openTestDB()
|
|
|
|
require.NoError(t, err)
|
|
|
|
p := newSQLitePersistence(db)
|
|
|
|
id := "1"
|
|
|
|
discordMessageID := "2"
|
|
|
|
|
|
|
|
err = insertDiscordMessageWithAttachments(p, id, discordMessageID)
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
m, err := p.MessageByID(id)
|
|
|
|
require.NoError(t, err)
|
|
|
|
require.EqualValues(t, id, m.ID)
|
|
|
|
|
|
|
|
dm := m.GetDiscordMessage()
|
|
|
|
require.NotNil(t, dm)
|
|
|
|
require.EqualValues(t, discordMessageID, dm.Id)
|
|
|
|
|
|
|
|
require.NotNil(t, dm.Attachments)
|
|
|
|
require.Len(t, dm.Attachments, 2)
|
|
|
|
}
|
|
|
|
|
2019-11-21 16:19:22 +00:00
|
|
|
func TestMessagesExist(t *testing.T) {
|
|
|
|
db, err := openTestDB()
|
|
|
|
require.NoError(t, err)
|
2022-03-28 10:10:40 +00:00
|
|
|
p := newSQLitePersistence(db)
|
2019-11-21 16:19:22 +00:00
|
|
|
|
|
|
|
err = insertMinimalMessage(p, "1")
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
result, err := p.MessagesExist([]string{"1"})
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
require.True(t, result["1"])
|
|
|
|
|
|
|
|
err = insertMinimalMessage(p, "2")
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
result, err = p.MessagesExist([]string{"1", "2", "3"})
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
require.True(t, result["1"])
|
|
|
|
require.True(t, result["2"])
|
|
|
|
require.False(t, result["3"])
|
|
|
|
}
|
|
|
|
|
|
|
|
func TestMessageByChatID(t *testing.T) {
|
|
|
|
db, err := openTestDB()
|
|
|
|
require.NoError(t, err)
|
2022-03-28 10:10:40 +00:00
|
|
|
p := newSQLitePersistence(db)
|
2020-02-21 14:48:53 +00:00
|
|
|
chatID := testPublicChatID
|
2019-11-21 16:19:22 +00:00
|
|
|
count := 1000
|
|
|
|
pageSize := 50
|
|
|
|
|
2020-09-01 13:27:01 +00:00
|
|
|
var messages []*common.Message
|
2019-11-21 16:19:22 +00:00
|
|
|
for i := 0; i < count; i++ {
|
2020-09-01 13:27:01 +00:00
|
|
|
messages = append(messages, &common.Message{
|
Move to protobuf for Message type (#1706)
* Use a single Message type `v1/message.go` and `message.go` are the same now, and they embed `protobuf.ChatMessage`
* Use `SendChatMessage` for sending chat messages, this is basically the old `Send` but a bit more flexible so we can send different message types (stickers,commands), and not just text.
* Remove dedup from services/shhext. Because now we process in status-protocol, dedup makes less sense, as those messages are going to be processed anyway, so removing for now, we can re-evaluate if bringing it to status-go or not.
* Change the various retrieveX method to a single one:
`RetrieveAll` will be processing those messages that it can process (Currently only `Message`), and return the rest in `RawMessages` (still transit). The format for the response is:
`Chats`: -> The chats updated by receiving the message
`Messages`: -> The messages retrieved (already matched to a chat)
`Contacts`: -> The contacts updated by the messages
`RawMessages` -> Anything else that can't be parsed, eventually as we move everything to status-protocol-go this will go away.
2019-12-05 16:25:34 +00:00
|
|
|
ID: strconv.Itoa(i),
|
|
|
|
LocalChatID: chatID,
|
2023-08-18 11:39:59 +00:00
|
|
|
ChatMessage: &protobuf.ChatMessage{
|
Move to protobuf for Message type (#1706)
* Use a single Message type `v1/message.go` and `message.go` are the same now, and they embed `protobuf.ChatMessage`
* Use `SendChatMessage` for sending chat messages, this is basically the old `Send` but a bit more flexible so we can send different message types (stickers,commands), and not just text.
* Remove dedup from services/shhext. Because now we process in status-protocol, dedup makes less sense, as those messages are going to be processed anyway, so removing for now, we can re-evaluate if bringing it to status-go or not.
* Change the various retrieveX method to a single one:
`RetrieveAll` will be processing those messages that it can process (Currently only `Message`), and return the rest in `RawMessages` (still transit). The format for the response is:
`Chats`: -> The chats updated by receiving the message
`Messages`: -> The messages retrieved (already matched to a chat)
`Contacts`: -> The contacts updated by the messages
`RawMessages` -> Anything else that can't be parsed, eventually as we move everything to status-protocol-go this will go away.
2019-12-05 16:25:34 +00:00
|
|
|
Clock: uint64(i),
|
|
|
|
},
|
2023-01-20 18:51:36 +00:00
|
|
|
From: testPK,
|
2019-11-21 16:19:22 +00:00
|
|
|
})
|
|
|
|
|
|
|
|
// Add some other chats.
|
|
|
|
if count%5 == 0 {
|
2020-09-01 13:27:01 +00:00
|
|
|
messages = append(messages, &common.Message{
|
Move to protobuf for Message type (#1706)
* Use a single Message type `v1/message.go` and `message.go` are the same now, and they embed `protobuf.ChatMessage`
* Use `SendChatMessage` for sending chat messages, this is basically the old `Send` but a bit more flexible so we can send different message types (stickers,commands), and not just text.
* Remove dedup from services/shhext. Because now we process in status-protocol, dedup makes less sense, as those messages are going to be processed anyway, so removing for now, we can re-evaluate if bringing it to status-go or not.
* Change the various retrieveX method to a single one:
`RetrieveAll` will be processing those messages that it can process (Currently only `Message`), and return the rest in `RawMessages` (still transit). The format for the response is:
`Chats`: -> The chats updated by receiving the message
`Messages`: -> The messages retrieved (already matched to a chat)
`Contacts`: -> The contacts updated by the messages
`RawMessages` -> Anything else that can't be parsed, eventually as we move everything to status-protocol-go this will go away.
2019-12-05 16:25:34 +00:00
|
|
|
ID: strconv.Itoa(count + i),
|
|
|
|
LocalChatID: "other-chat",
|
2023-08-18 11:39:59 +00:00
|
|
|
ChatMessage: &protobuf.ChatMessage{
|
Move to protobuf for Message type (#1706)
* Use a single Message type `v1/message.go` and `message.go` are the same now, and they embed `protobuf.ChatMessage`
* Use `SendChatMessage` for sending chat messages, this is basically the old `Send` but a bit more flexible so we can send different message types (stickers,commands), and not just text.
* Remove dedup from services/shhext. Because now we process in status-protocol, dedup makes less sense, as those messages are going to be processed anyway, so removing for now, we can re-evaluate if bringing it to status-go or not.
* Change the various retrieveX method to a single one:
`RetrieveAll` will be processing those messages that it can process (Currently only `Message`), and return the rest in `RawMessages` (still transit). The format for the response is:
`Chats`: -> The chats updated by receiving the message
`Messages`: -> The messages retrieved (already matched to a chat)
`Contacts`: -> The contacts updated by the messages
`RawMessages` -> Anything else that can't be parsed, eventually as we move everything to status-protocol-go this will go away.
2019-12-05 16:25:34 +00:00
|
|
|
Clock: uint64(i),
|
|
|
|
},
|
|
|
|
|
2023-01-20 18:51:36 +00:00
|
|
|
From: testPK,
|
2019-11-21 16:19:22 +00:00
|
|
|
})
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// Add some out-of-order message. Add more than page size.
|
|
|
|
outOfOrderCount := pageSize + 1
|
|
|
|
allCount := count + outOfOrderCount
|
|
|
|
for i := 0; i < pageSize+1; i++ {
|
2020-09-01 13:27:01 +00:00
|
|
|
messages = append(messages, &common.Message{
|
Move to protobuf for Message type (#1706)
* Use a single Message type `v1/message.go` and `message.go` are the same now, and they embed `protobuf.ChatMessage`
* Use `SendChatMessage` for sending chat messages, this is basically the old `Send` but a bit more flexible so we can send different message types (stickers,commands), and not just text.
* Remove dedup from services/shhext. Because now we process in status-protocol, dedup makes less sense, as those messages are going to be processed anyway, so removing for now, we can re-evaluate if bringing it to status-go or not.
* Change the various retrieveX method to a single one:
`RetrieveAll` will be processing those messages that it can process (Currently only `Message`), and return the rest in `RawMessages` (still transit). The format for the response is:
`Chats`: -> The chats updated by receiving the message
`Messages`: -> The messages retrieved (already matched to a chat)
`Contacts`: -> The contacts updated by the messages
`RawMessages` -> Anything else that can't be parsed, eventually as we move everything to status-protocol-go this will go away.
2019-12-05 16:25:34 +00:00
|
|
|
ID: strconv.Itoa(count*2 + i),
|
|
|
|
LocalChatID: chatID,
|
2023-08-18 11:39:59 +00:00
|
|
|
ChatMessage: &protobuf.ChatMessage{
|
Move to protobuf for Message type (#1706)
* Use a single Message type `v1/message.go` and `message.go` are the same now, and they embed `protobuf.ChatMessage`
* Use `SendChatMessage` for sending chat messages, this is basically the old `Send` but a bit more flexible so we can send different message types (stickers,commands), and not just text.
* Remove dedup from services/shhext. Because now we process in status-protocol, dedup makes less sense, as those messages are going to be processed anyway, so removing for now, we can re-evaluate if bringing it to status-go or not.
* Change the various retrieveX method to a single one:
`RetrieveAll` will be processing those messages that it can process (Currently only `Message`), and return the rest in `RawMessages` (still transit). The format for the response is:
`Chats`: -> The chats updated by receiving the message
`Messages`: -> The messages retrieved (already matched to a chat)
`Contacts`: -> The contacts updated by the messages
`RawMessages` -> Anything else that can't be parsed, eventually as we move everything to status-protocol-go this will go away.
2019-12-05 16:25:34 +00:00
|
|
|
Clock: uint64(i),
|
|
|
|
},
|
|
|
|
|
2023-01-20 18:51:36 +00:00
|
|
|
From: testPK,
|
2019-11-21 16:19:22 +00:00
|
|
|
})
|
|
|
|
}
|
|
|
|
|
2020-05-20 12:16:12 +00:00
|
|
|
err = p.SaveMessages(messages)
|
2019-11-21 16:19:22 +00:00
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
var (
|
2020-09-01 13:27:01 +00:00
|
|
|
result []*common.Message
|
2019-11-21 16:19:22 +00:00
|
|
|
cursor string
|
|
|
|
iter int
|
|
|
|
)
|
|
|
|
for {
|
|
|
|
var (
|
2020-09-01 13:27:01 +00:00
|
|
|
items []*common.Message
|
2019-11-21 16:19:22 +00:00
|
|
|
err error
|
|
|
|
)
|
|
|
|
|
|
|
|
items, cursor, err = p.MessageByChatID(chatID, cursor, pageSize)
|
|
|
|
require.NoError(t, err)
|
|
|
|
result = append(result, items...)
|
|
|
|
|
|
|
|
iter++
|
|
|
|
if len(cursor) == 0 || iter > count {
|
|
|
|
break
|
|
|
|
}
|
|
|
|
}
|
|
|
|
require.Equal(t, "", cursor) // for loop should exit because of cursor being empty
|
|
|
|
require.EqualValues(t, math.Ceil(float64(allCount)/float64(pageSize)), iter)
|
|
|
|
require.Equal(t, len(result), allCount)
|
|
|
|
require.True(
|
|
|
|
t,
|
|
|
|
// Verify descending order.
|
|
|
|
sort.SliceIsSorted(result, func(i, j int) bool {
|
Move to protobuf for Message type (#1706)
* Use a single Message type `v1/message.go` and `message.go` are the same now, and they embed `protobuf.ChatMessage`
* Use `SendChatMessage` for sending chat messages, this is basically the old `Send` but a bit more flexible so we can send different message types (stickers,commands), and not just text.
* Remove dedup from services/shhext. Because now we process in status-protocol, dedup makes less sense, as those messages are going to be processed anyway, so removing for now, we can re-evaluate if bringing it to status-go or not.
* Change the various retrieveX method to a single one:
`RetrieveAll` will be processing those messages that it can process (Currently only `Message`), and return the rest in `RawMessages` (still transit). The format for the response is:
`Chats`: -> The chats updated by receiving the message
`Messages`: -> The messages retrieved (already matched to a chat)
`Contacts`: -> The contacts updated by the messages
`RawMessages` -> Anything else that can't be parsed, eventually as we move everything to status-protocol-go this will go away.
2019-12-05 16:25:34 +00:00
|
|
|
return result[i].Clock > result[j].Clock
|
2019-11-21 16:19:22 +00:00
|
|
|
}),
|
|
|
|
)
|
|
|
|
}
|
|
|
|
|
2022-12-11 19:08:51 +00:00
|
|
|
func TestFirstUnseenMessageIDByChatID(t *testing.T) {
|
|
|
|
db, err := openTestDB()
|
|
|
|
require.NoError(t, err)
|
|
|
|
p := newSQLitePersistence(db)
|
|
|
|
|
|
|
|
messageID, err := p.FirstUnseenMessageID(testPublicChatID)
|
|
|
|
require.NoError(t, err)
|
|
|
|
require.Equal(t, "", messageID)
|
|
|
|
|
|
|
|
err = p.SaveMessages([]*common.Message{
|
|
|
|
{
|
|
|
|
ID: "1",
|
|
|
|
LocalChatID: testPublicChatID,
|
2023-08-18 11:39:59 +00:00
|
|
|
ChatMessage: &protobuf.ChatMessage{
|
2022-12-11 19:08:51 +00:00
|
|
|
Clock: 1,
|
|
|
|
Text: "some-text"},
|
2023-01-20 18:51:36 +00:00
|
|
|
From: testPK,
|
2022-12-11 19:08:51 +00:00
|
|
|
Seen: true,
|
|
|
|
},
|
|
|
|
{
|
|
|
|
ID: "2",
|
|
|
|
LocalChatID: testPublicChatID,
|
2023-08-18 11:39:59 +00:00
|
|
|
ChatMessage: &protobuf.ChatMessage{
|
2022-12-11 19:08:51 +00:00
|
|
|
Clock: 2,
|
|
|
|
Text: "some-text"},
|
2023-01-20 18:51:36 +00:00
|
|
|
From: testPK,
|
2022-12-11 19:08:51 +00:00
|
|
|
Seen: false,
|
|
|
|
},
|
|
|
|
{
|
|
|
|
ID: "3",
|
|
|
|
LocalChatID: testPublicChatID,
|
2023-08-18 11:39:59 +00:00
|
|
|
ChatMessage: &protobuf.ChatMessage{
|
2022-12-11 19:08:51 +00:00
|
|
|
Clock: 3,
|
|
|
|
Text: "some-text"},
|
2023-01-20 18:51:36 +00:00
|
|
|
From: testPK,
|
2022-12-11 19:08:51 +00:00
|
|
|
Seen: false,
|
|
|
|
},
|
|
|
|
})
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
messageID, err = p.FirstUnseenMessageID(testPublicChatID)
|
|
|
|
require.NoError(t, err)
|
|
|
|
require.Equal(t, "2", messageID)
|
|
|
|
}
|
|
|
|
|
2022-11-17 10:11:58 +00:00
|
|
|
func TestLatestMessageByChatID(t *testing.T) {
|
|
|
|
db, err := openTestDB()
|
|
|
|
require.NoError(t, err)
|
|
|
|
p := newSQLitePersistence(db)
|
|
|
|
|
|
|
|
var ids []string
|
|
|
|
for i := 0; i < 10; i++ {
|
|
|
|
id := strconv.Itoa(i)
|
|
|
|
err := insertMinimalMessage(p, id)
|
|
|
|
require.NoError(t, err)
|
|
|
|
ids = append(ids, id)
|
|
|
|
}
|
|
|
|
|
|
|
|
id := strconv.Itoa(10)
|
|
|
|
err = insertMinimalDeletedMessage(p, id)
|
|
|
|
require.NoError(t, err)
|
|
|
|
ids = append(ids, id)
|
|
|
|
|
|
|
|
id = strconv.Itoa(11)
|
|
|
|
err = insertMinimalDeletedForMeMessage(p, id)
|
|
|
|
require.NoError(t, err)
|
|
|
|
ids = append(ids, id)
|
|
|
|
|
|
|
|
m, err := p.LatestMessageByChatID(testPublicChatID)
|
|
|
|
require.NoError(t, err)
|
|
|
|
require.Equal(t, m[0].ID, ids[9])
|
|
|
|
}
|
|
|
|
|
2022-09-02 08:36:07 +00:00
|
|
|
func TestOldestMessageWhisperTimestampByChatID(t *testing.T) {
|
|
|
|
db, err := openTestDB()
|
|
|
|
require.NoError(t, err)
|
|
|
|
p := newSQLitePersistence(db)
|
|
|
|
chatID := testPublicChatID
|
|
|
|
|
|
|
|
_, hasMessage, err := p.OldestMessageWhisperTimestampByChatID(chatID)
|
|
|
|
require.NoError(t, err)
|
|
|
|
require.False(t, hasMessage)
|
|
|
|
|
|
|
|
var messages []*common.Message
|
|
|
|
for i := 0; i < 10; i++ {
|
|
|
|
messages = append(messages, &common.Message{
|
|
|
|
ID: strconv.Itoa(i),
|
|
|
|
LocalChatID: chatID,
|
2023-08-18 11:39:59 +00:00
|
|
|
ChatMessage: &protobuf.ChatMessage{
|
2022-09-02 08:36:07 +00:00
|
|
|
Clock: uint64(i),
|
|
|
|
},
|
|
|
|
WhisperTimestamp: uint64(i + 10),
|
2023-01-20 18:51:36 +00:00
|
|
|
From: testPK,
|
2022-09-02 08:36:07 +00:00
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
err = p.SaveMessages(messages)
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
timestamp, hasMessage, err := p.OldestMessageWhisperTimestampByChatID(chatID)
|
|
|
|
require.NoError(t, err)
|
|
|
|
require.True(t, hasMessage)
|
|
|
|
require.Equal(t, uint64(10), timestamp)
|
|
|
|
}
|
|
|
|
|
2021-05-14 21:22:50 +00:00
|
|
|
func TestPinMessageByChatID(t *testing.T) {
|
|
|
|
db, err := openTestDB()
|
|
|
|
require.NoError(t, err)
|
|
|
|
p := sqlitePersistence{db: db}
|
|
|
|
chatID := "chat-with-pinned-messages"
|
|
|
|
messagesCount := 1000
|
|
|
|
pageSize := 5
|
|
|
|
pinnedMessagesCount := 0
|
|
|
|
|
|
|
|
var messages []*common.Message
|
|
|
|
var pinMessages []*common.PinMessage
|
|
|
|
for i := 0; i < messagesCount; i++ {
|
|
|
|
messages = append(messages, &common.Message{
|
|
|
|
ID: strconv.Itoa(i),
|
|
|
|
LocalChatID: chatID,
|
2023-08-18 11:39:59 +00:00
|
|
|
ChatMessage: &protobuf.ChatMessage{
|
2021-05-14 21:22:50 +00:00
|
|
|
Clock: uint64(i),
|
|
|
|
},
|
2023-01-20 18:51:36 +00:00
|
|
|
From: testPK,
|
2021-05-14 21:22:50 +00:00
|
|
|
})
|
|
|
|
|
|
|
|
// Pin this message
|
|
|
|
if i%100 == 0 {
|
2023-01-20 18:51:36 +00:00
|
|
|
from := testPK
|
2021-06-08 15:23:32 +00:00
|
|
|
if i == 100 {
|
|
|
|
from = "them"
|
|
|
|
}
|
|
|
|
|
2023-08-18 11:39:59 +00:00
|
|
|
pinMessage := common.NewPinMessage()
|
|
|
|
pinMessage.ID = strconv.Itoa(i)
|
|
|
|
pinMessage.LocalChatID = chatID
|
|
|
|
pinMessage.From = from
|
2021-05-14 21:22:50 +00:00
|
|
|
|
|
|
|
pinMessage.MessageId = strconv.Itoa(i)
|
|
|
|
pinMessage.Clock = 111
|
|
|
|
pinMessage.Pinned = true
|
|
|
|
pinMessages = append(pinMessages, pinMessage)
|
|
|
|
pinnedMessagesCount++
|
|
|
|
|
|
|
|
if i%200 == 0 {
|
|
|
|
// unpin a message
|
2023-08-18 11:39:59 +00:00
|
|
|
unpinMessage := common.NewPinMessage()
|
|
|
|
|
|
|
|
unpinMessage.ID = strconv.Itoa(i)
|
|
|
|
unpinMessage.LocalChatID = chatID
|
|
|
|
unpinMessage.From = testPK
|
|
|
|
|
2021-05-14 21:22:50 +00:00
|
|
|
pinMessage.MessageId = strconv.Itoa(i)
|
|
|
|
unpinMessage.Clock = 333
|
|
|
|
unpinMessage.Pinned = false
|
|
|
|
pinMessages = append(pinMessages, unpinMessage)
|
|
|
|
pinnedMessagesCount--
|
|
|
|
|
|
|
|
// pinned before the unpin
|
2023-08-18 11:39:59 +00:00
|
|
|
pinMessage2 := common.NewPinMessage()
|
|
|
|
pinMessage2.ID = strconv.Itoa(i)
|
|
|
|
pinMessage2.LocalChatID = chatID
|
|
|
|
pinMessage2.From = testPK
|
|
|
|
|
2021-05-14 21:22:50 +00:00
|
|
|
pinMessage2.MessageId = strconv.Itoa(i)
|
|
|
|
pinMessage2.Clock = 222
|
|
|
|
pinMessage2.Pinned = true
|
|
|
|
pinMessages = append(pinMessages, pinMessage2)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// Add some other chats.
|
|
|
|
if i%5 == 0 {
|
|
|
|
messages = append(messages, &common.Message{
|
|
|
|
ID: strconv.Itoa(messagesCount + i),
|
|
|
|
LocalChatID: "chat-without-pinned-messages",
|
2023-08-18 11:39:59 +00:00
|
|
|
ChatMessage: &protobuf.ChatMessage{
|
2021-05-14 21:22:50 +00:00
|
|
|
Clock: uint64(i),
|
|
|
|
},
|
|
|
|
|
2023-01-20 18:51:36 +00:00
|
|
|
From: testPK,
|
2021-05-14 21:22:50 +00:00
|
|
|
})
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
err = p.SaveMessages(messages)
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
err = p.SavePinMessages(pinMessages)
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
var (
|
|
|
|
result []*common.PinnedMessage
|
|
|
|
cursor string
|
|
|
|
iter int
|
|
|
|
)
|
|
|
|
for {
|
|
|
|
var (
|
|
|
|
items []*common.PinnedMessage
|
|
|
|
err error
|
|
|
|
)
|
|
|
|
|
|
|
|
items, cursor, err = p.PinnedMessageByChatID(chatID, cursor, pageSize)
|
|
|
|
require.NoError(t, err)
|
|
|
|
result = append(result, items...)
|
|
|
|
|
|
|
|
iter++
|
|
|
|
if len(cursor) == 0 || iter > messagesCount {
|
|
|
|
break
|
|
|
|
}
|
|
|
|
}
|
2021-06-08 15:23:32 +00:00
|
|
|
|
2021-05-14 21:22:50 +00:00
|
|
|
require.Equal(t, "", cursor) // for loop should exit because of cursor being empty
|
|
|
|
require.EqualValues(t, pinnedMessagesCount, len(result))
|
|
|
|
require.EqualValues(t, math.Ceil(float64(pinnedMessagesCount)/float64(pageSize)), iter)
|
|
|
|
require.True(
|
|
|
|
t,
|
|
|
|
// Verify descending order.
|
|
|
|
sort.SliceIsSorted(result, func(i, j int) bool {
|
2021-06-08 15:23:32 +00:00
|
|
|
return result[i].Message.Clock > result[j].Message.Clock
|
2021-05-14 21:22:50 +00:00
|
|
|
}),
|
|
|
|
)
|
2021-06-08 15:23:32 +00:00
|
|
|
|
|
|
|
require.Equal(t, "them", result[len(result)-1].PinnedBy)
|
|
|
|
for i := 0; i < len(result)-1; i++ {
|
2023-01-20 18:51:36 +00:00
|
|
|
require.Equal(t, testPK, result[i].PinnedBy)
|
2021-06-08 15:23:32 +00:00
|
|
|
}
|
2021-05-14 21:22:50 +00:00
|
|
|
}
|
|
|
|
|
2019-11-21 16:19:22 +00:00
|
|
|
func TestMessageReplies(t *testing.T) {
|
|
|
|
db, err := openTestDB()
|
|
|
|
require.NoError(t, err)
|
2022-03-28 10:10:40 +00:00
|
|
|
p := newSQLitePersistence(db)
|
2020-02-21 14:48:53 +00:00
|
|
|
chatID := testPublicChatID
|
2020-09-01 13:27:01 +00:00
|
|
|
message1 := &common.Message{
|
Move to protobuf for Message type (#1706)
* Use a single Message type `v1/message.go` and `message.go` are the same now, and they embed `protobuf.ChatMessage`
* Use `SendChatMessage` for sending chat messages, this is basically the old `Send` but a bit more flexible so we can send different message types (stickers,commands), and not just text.
* Remove dedup from services/shhext. Because now we process in status-protocol, dedup makes less sense, as those messages are going to be processed anyway, so removing for now, we can re-evaluate if bringing it to status-go or not.
* Change the various retrieveX method to a single one:
`RetrieveAll` will be processing those messages that it can process (Currently only `Message`), and return the rest in `RawMessages` (still transit). The format for the response is:
`Chats`: -> The chats updated by receiving the message
`Messages`: -> The messages retrieved (already matched to a chat)
`Contacts`: -> The contacts updated by the messages
`RawMessages` -> Anything else that can't be parsed, eventually as we move everything to status-protocol-go this will go away.
2019-12-05 16:25:34 +00:00
|
|
|
ID: "id-1",
|
|
|
|
LocalChatID: chatID,
|
2023-08-18 11:39:59 +00:00
|
|
|
ChatMessage: &protobuf.ChatMessage{
|
Move to protobuf for Message type (#1706)
* Use a single Message type `v1/message.go` and `message.go` are the same now, and they embed `protobuf.ChatMessage`
* Use `SendChatMessage` for sending chat messages, this is basically the old `Send` but a bit more flexible so we can send different message types (stickers,commands), and not just text.
* Remove dedup from services/shhext. Because now we process in status-protocol, dedup makes less sense, as those messages are going to be processed anyway, so removing for now, we can re-evaluate if bringing it to status-go or not.
* Change the various retrieveX method to a single one:
`RetrieveAll` will be processing those messages that it can process (Currently only `Message`), and return the rest in `RawMessages` (still transit). The format for the response is:
`Chats`: -> The chats updated by receiving the message
`Messages`: -> The messages retrieved (already matched to a chat)
`Contacts`: -> The contacts updated by the messages
`RawMessages` -> Anything else that can't be parsed, eventually as we move everything to status-protocol-go this will go away.
2019-12-05 16:25:34 +00:00
|
|
|
Text: "content-1",
|
|
|
|
Clock: uint64(1),
|
|
|
|
},
|
|
|
|
From: "1",
|
2019-11-21 16:19:22 +00:00
|
|
|
}
|
2020-09-01 13:27:01 +00:00
|
|
|
message2 := &common.Message{
|
Move to protobuf for Message type (#1706)
* Use a single Message type `v1/message.go` and `message.go` are the same now, and they embed `protobuf.ChatMessage`
* Use `SendChatMessage` for sending chat messages, this is basically the old `Send` but a bit more flexible so we can send different message types (stickers,commands), and not just text.
* Remove dedup from services/shhext. Because now we process in status-protocol, dedup makes less sense, as those messages are going to be processed anyway, so removing for now, we can re-evaluate if bringing it to status-go or not.
* Change the various retrieveX method to a single one:
`RetrieveAll` will be processing those messages that it can process (Currently only `Message`), and return the rest in `RawMessages` (still transit). The format for the response is:
`Chats`: -> The chats updated by receiving the message
`Messages`: -> The messages retrieved (already matched to a chat)
`Contacts`: -> The contacts updated by the messages
`RawMessages` -> Anything else that can't be parsed, eventually as we move everything to status-protocol-go this will go away.
2019-12-05 16:25:34 +00:00
|
|
|
ID: "id-2",
|
|
|
|
LocalChatID: chatID,
|
2023-08-18 11:39:59 +00:00
|
|
|
ChatMessage: &protobuf.ChatMessage{
|
Move to protobuf for Message type (#1706)
* Use a single Message type `v1/message.go` and `message.go` are the same now, and they embed `protobuf.ChatMessage`
* Use `SendChatMessage` for sending chat messages, this is basically the old `Send` but a bit more flexible so we can send different message types (stickers,commands), and not just text.
* Remove dedup from services/shhext. Because now we process in status-protocol, dedup makes less sense, as those messages are going to be processed anyway, so removing for now, we can re-evaluate if bringing it to status-go or not.
* Change the various retrieveX method to a single one:
`RetrieveAll` will be processing those messages that it can process (Currently only `Message`), and return the rest in `RawMessages` (still transit). The format for the response is:
`Chats`: -> The chats updated by receiving the message
`Messages`: -> The messages retrieved (already matched to a chat)
`Contacts`: -> The contacts updated by the messages
`RawMessages` -> Anything else that can't be parsed, eventually as we move everything to status-protocol-go this will go away.
2019-12-05 16:25:34 +00:00
|
|
|
Text: "content-2",
|
|
|
|
Clock: uint64(2),
|
|
|
|
ResponseTo: "id-1",
|
|
|
|
},
|
|
|
|
|
|
|
|
From: "2",
|
2019-11-21 16:19:22 +00:00
|
|
|
}
|
|
|
|
|
2020-09-01 13:27:01 +00:00
|
|
|
message3 := &common.Message{
|
Move to protobuf for Message type (#1706)
* Use a single Message type `v1/message.go` and `message.go` are the same now, and they embed `protobuf.ChatMessage`
* Use `SendChatMessage` for sending chat messages, this is basically the old `Send` but a bit more flexible so we can send different message types (stickers,commands), and not just text.
* Remove dedup from services/shhext. Because now we process in status-protocol, dedup makes less sense, as those messages are going to be processed anyway, so removing for now, we can re-evaluate if bringing it to status-go or not.
* Change the various retrieveX method to a single one:
`RetrieveAll` will be processing those messages that it can process (Currently only `Message`), and return the rest in `RawMessages` (still transit). The format for the response is:
`Chats`: -> The chats updated by receiving the message
`Messages`: -> The messages retrieved (already matched to a chat)
`Contacts`: -> The contacts updated by the messages
`RawMessages` -> Anything else that can't be parsed, eventually as we move everything to status-protocol-go this will go away.
2019-12-05 16:25:34 +00:00
|
|
|
ID: "id-3",
|
|
|
|
LocalChatID: chatID,
|
2023-08-18 11:39:59 +00:00
|
|
|
ChatMessage: &protobuf.ChatMessage{
|
Move to protobuf for Message type (#1706)
* Use a single Message type `v1/message.go` and `message.go` are the same now, and they embed `protobuf.ChatMessage`
* Use `SendChatMessage` for sending chat messages, this is basically the old `Send` but a bit more flexible so we can send different message types (stickers,commands), and not just text.
* Remove dedup from services/shhext. Because now we process in status-protocol, dedup makes less sense, as those messages are going to be processed anyway, so removing for now, we can re-evaluate if bringing it to status-go or not.
* Change the various retrieveX method to a single one:
`RetrieveAll` will be processing those messages that it can process (Currently only `Message`), and return the rest in `RawMessages` (still transit). The format for the response is:
`Chats`: -> The chats updated by receiving the message
`Messages`: -> The messages retrieved (already matched to a chat)
`Contacts`: -> The contacts updated by the messages
`RawMessages` -> Anything else that can't be parsed, eventually as we move everything to status-protocol-go this will go away.
2019-12-05 16:25:34 +00:00
|
|
|
Text: "content-3",
|
|
|
|
Clock: uint64(3),
|
|
|
|
ResponseTo: "non-existing",
|
|
|
|
},
|
|
|
|
From: "3",
|
2019-11-21 16:19:22 +00:00
|
|
|
}
|
|
|
|
|
2023-01-09 16:38:24 +00:00
|
|
|
// Message that is deleted
|
|
|
|
message4 := &common.Message{
|
|
|
|
ID: "id-4",
|
|
|
|
LocalChatID: chatID,
|
|
|
|
Deleted: true,
|
2023-08-18 11:39:59 +00:00
|
|
|
ChatMessage: &protobuf.ChatMessage{
|
2023-01-09 16:38:24 +00:00
|
|
|
Text: "content-4",
|
|
|
|
Clock: uint64(4),
|
|
|
|
},
|
|
|
|
From: "2",
|
|
|
|
}
|
|
|
|
|
|
|
|
// Message replied to a deleted message. It will not have QuotedMessage info
|
|
|
|
message5 := &common.Message{
|
|
|
|
ID: "id-5",
|
|
|
|
LocalChatID: chatID,
|
2023-08-18 11:39:59 +00:00
|
|
|
ChatMessage: &protobuf.ChatMessage{
|
2023-01-09 16:38:24 +00:00
|
|
|
Text: "content-4",
|
|
|
|
Clock: uint64(5),
|
|
|
|
ResponseTo: "id-4",
|
|
|
|
},
|
|
|
|
From: "3",
|
|
|
|
}
|
|
|
|
|
|
|
|
// messages := []*common.Message{message1, message2, message3}
|
|
|
|
messages := []*common.Message{message1, message2, message3, message4, message5}
|
2019-11-21 16:19:22 +00:00
|
|
|
|
2020-05-20 12:16:12 +00:00
|
|
|
err = p.SaveMessages(messages)
|
2019-11-21 16:19:22 +00:00
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
retrievedMessages, _, err := p.MessageByChatID(chatID, "", 10)
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
2023-01-09 16:38:24 +00:00
|
|
|
require.Equal(t, "non-existing", retrievedMessages[2].ResponseTo)
|
|
|
|
require.Nil(t, retrievedMessages[2].QuotedMessage)
|
2019-11-21 16:19:22 +00:00
|
|
|
|
2023-01-09 16:38:24 +00:00
|
|
|
require.Equal(t, "id-1", retrievedMessages[3].ResponseTo)
|
|
|
|
require.Equal(t, &common.QuotedMessage{ID: "id-1", From: "1", Text: "content-1"}, retrievedMessages[3].QuotedMessage)
|
2019-11-21 16:19:22 +00:00
|
|
|
|
2023-01-09 16:38:24 +00:00
|
|
|
require.Equal(t, "", retrievedMessages[4].ResponseTo)
|
|
|
|
require.Nil(t, retrievedMessages[4].QuotedMessage)
|
|
|
|
|
2023-01-11 21:09:40 +00:00
|
|
|
// We have a ResponseTo, but no QuotedMessage only gives the ID and Deleted
|
2023-01-09 16:38:24 +00:00
|
|
|
require.Equal(t, "id-4", retrievedMessages[0].ResponseTo)
|
2023-01-11 21:09:40 +00:00
|
|
|
require.Equal(t, &common.QuotedMessage{ID: "id-4", Deleted: true}, retrievedMessages[0].QuotedMessage)
|
2019-11-21 16:19:22 +00:00
|
|
|
}
|
|
|
|
|
Move to protobuf for Message type (#1706)
* Use a single Message type `v1/message.go` and `message.go` are the same now, and they embed `protobuf.ChatMessage`
* Use `SendChatMessage` for sending chat messages, this is basically the old `Send` but a bit more flexible so we can send different message types (stickers,commands), and not just text.
* Remove dedup from services/shhext. Because now we process in status-protocol, dedup makes less sense, as those messages are going to be processed anyway, so removing for now, we can re-evaluate if bringing it to status-go or not.
* Change the various retrieveX method to a single one:
`RetrieveAll` will be processing those messages that it can process (Currently only `Message`), and return the rest in `RawMessages` (still transit). The format for the response is:
`Chats`: -> The chats updated by receiving the message
`Messages`: -> The messages retrieved (already matched to a chat)
`Contacts`: -> The contacts updated by the messages
`RawMessages` -> Anything else that can't be parsed, eventually as we move everything to status-protocol-go this will go away.
2019-12-05 16:25:34 +00:00
|
|
|
func TestMessageByChatIDWithTheSameClocks(t *testing.T) {
|
2019-11-21 16:19:22 +00:00
|
|
|
db, err := openTestDB()
|
|
|
|
require.NoError(t, err)
|
2022-03-28 10:10:40 +00:00
|
|
|
p := newSQLitePersistence(db)
|
2020-02-21 14:48:53 +00:00
|
|
|
chatID := testPublicChatID
|
Move to protobuf for Message type (#1706)
* Use a single Message type `v1/message.go` and `message.go` are the same now, and they embed `protobuf.ChatMessage`
* Use `SendChatMessage` for sending chat messages, this is basically the old `Send` but a bit more flexible so we can send different message types (stickers,commands), and not just text.
* Remove dedup from services/shhext. Because now we process in status-protocol, dedup makes less sense, as those messages are going to be processed anyway, so removing for now, we can re-evaluate if bringing it to status-go or not.
* Change the various retrieveX method to a single one:
`RetrieveAll` will be processing those messages that it can process (Currently only `Message`), and return the rest in `RawMessages` (still transit). The format for the response is:
`Chats`: -> The chats updated by receiving the message
`Messages`: -> The messages retrieved (already matched to a chat)
`Contacts`: -> The contacts updated by the messages
`RawMessages` -> Anything else that can't be parsed, eventually as we move everything to status-protocol-go this will go away.
2019-12-05 16:25:34 +00:00
|
|
|
clockValues := []uint64{10, 10, 9, 9, 9, 11, 12, 11, 100000, 6, 4, 5, 5, 5, 5}
|
2019-11-21 16:19:22 +00:00
|
|
|
count := len(clockValues)
|
|
|
|
pageSize := 2
|
|
|
|
|
2020-09-01 13:27:01 +00:00
|
|
|
var messages []*common.Message
|
2019-11-21 16:19:22 +00:00
|
|
|
|
|
|
|
for i, clock := range clockValues {
|
2020-09-01 13:27:01 +00:00
|
|
|
messages = append(messages, &common.Message{
|
Move to protobuf for Message type (#1706)
* Use a single Message type `v1/message.go` and `message.go` are the same now, and they embed `protobuf.ChatMessage`
* Use `SendChatMessage` for sending chat messages, this is basically the old `Send` but a bit more flexible so we can send different message types (stickers,commands), and not just text.
* Remove dedup from services/shhext. Because now we process in status-protocol, dedup makes less sense, as those messages are going to be processed anyway, so removing for now, we can re-evaluate if bringing it to status-go or not.
* Change the various retrieveX method to a single one:
`RetrieveAll` will be processing those messages that it can process (Currently only `Message`), and return the rest in `RawMessages` (still transit). The format for the response is:
`Chats`: -> The chats updated by receiving the message
`Messages`: -> The messages retrieved (already matched to a chat)
`Contacts`: -> The contacts updated by the messages
`RawMessages` -> Anything else that can't be parsed, eventually as we move everything to status-protocol-go this will go away.
2019-12-05 16:25:34 +00:00
|
|
|
ID: strconv.Itoa(i),
|
|
|
|
LocalChatID: chatID,
|
2023-08-18 11:39:59 +00:00
|
|
|
ChatMessage: &protobuf.ChatMessage{
|
Move to protobuf for Message type (#1706)
* Use a single Message type `v1/message.go` and `message.go` are the same now, and they embed `protobuf.ChatMessage`
* Use `SendChatMessage` for sending chat messages, this is basically the old `Send` but a bit more flexible so we can send different message types (stickers,commands), and not just text.
* Remove dedup from services/shhext. Because now we process in status-protocol, dedup makes less sense, as those messages are going to be processed anyway, so removing for now, we can re-evaluate if bringing it to status-go or not.
* Change the various retrieveX method to a single one:
`RetrieveAll` will be processing those messages that it can process (Currently only `Message`), and return the rest in `RawMessages` (still transit). The format for the response is:
`Chats`: -> The chats updated by receiving the message
`Messages`: -> The messages retrieved (already matched to a chat)
`Contacts`: -> The contacts updated by the messages
`RawMessages` -> Anything else that can't be parsed, eventually as we move everything to status-protocol-go this will go away.
2019-12-05 16:25:34 +00:00
|
|
|
Clock: clock,
|
|
|
|
},
|
2023-01-20 18:51:36 +00:00
|
|
|
From: testPK,
|
2019-11-21 16:19:22 +00:00
|
|
|
})
|
|
|
|
}
|
|
|
|
|
2020-05-20 12:16:12 +00:00
|
|
|
err = p.SaveMessages(messages)
|
2019-11-21 16:19:22 +00:00
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
var (
|
2020-09-01 13:27:01 +00:00
|
|
|
result []*common.Message
|
2019-11-21 16:19:22 +00:00
|
|
|
cursor string
|
|
|
|
iter int
|
|
|
|
)
|
|
|
|
for {
|
|
|
|
var (
|
2020-09-01 13:27:01 +00:00
|
|
|
items []*common.Message
|
2019-11-21 16:19:22 +00:00
|
|
|
err error
|
|
|
|
)
|
|
|
|
|
|
|
|
items, cursor, err = p.MessageByChatID(chatID, cursor, pageSize)
|
|
|
|
require.NoError(t, err)
|
|
|
|
result = append(result, items...)
|
|
|
|
|
|
|
|
iter++
|
|
|
|
if cursor == "" || iter > count {
|
|
|
|
break
|
|
|
|
}
|
|
|
|
}
|
|
|
|
require.Empty(t, cursor) // for loop should exit because of cursor being empty
|
|
|
|
require.Len(t, result, count)
|
|
|
|
// Verify the order.
|
Move to protobuf for Message type (#1706)
* Use a single Message type `v1/message.go` and `message.go` are the same now, and they embed `protobuf.ChatMessage`
* Use `SendChatMessage` for sending chat messages, this is basically the old `Send` but a bit more flexible so we can send different message types (stickers,commands), and not just text.
* Remove dedup from services/shhext. Because now we process in status-protocol, dedup makes less sense, as those messages are going to be processed anyway, so removing for now, we can re-evaluate if bringing it to status-go or not.
* Change the various retrieveX method to a single one:
`RetrieveAll` will be processing those messages that it can process (Currently only `Message`), and return the rest in `RawMessages` (still transit). The format for the response is:
`Chats`: -> The chats updated by receiving the message
`Messages`: -> The messages retrieved (already matched to a chat)
`Contacts`: -> The contacts updated by the messages
`RawMessages` -> Anything else that can't be parsed, eventually as we move everything to status-protocol-go this will go away.
2019-12-05 16:25:34 +00:00
|
|
|
expectedClocks := make([]uint64, len(clockValues))
|
|
|
|
copy(expectedClocks, clockValues)
|
|
|
|
sort.Slice(expectedClocks, func(i, j int) bool {
|
|
|
|
return expectedClocks[i] > expectedClocks[j]
|
2019-11-21 16:19:22 +00:00
|
|
|
})
|
Move to protobuf for Message type (#1706)
* Use a single Message type `v1/message.go` and `message.go` are the same now, and they embed `protobuf.ChatMessage`
* Use `SendChatMessage` for sending chat messages, this is basically the old `Send` but a bit more flexible so we can send different message types (stickers,commands), and not just text.
* Remove dedup from services/shhext. Because now we process in status-protocol, dedup makes less sense, as those messages are going to be processed anyway, so removing for now, we can re-evaluate if bringing it to status-go or not.
* Change the various retrieveX method to a single one:
`RetrieveAll` will be processing those messages that it can process (Currently only `Message`), and return the rest in `RawMessages` (still transit). The format for the response is:
`Chats`: -> The chats updated by receiving the message
`Messages`: -> The messages retrieved (already matched to a chat)
`Contacts`: -> The contacts updated by the messages
`RawMessages` -> Anything else that can't be parsed, eventually as we move everything to status-protocol-go this will go away.
2019-12-05 16:25:34 +00:00
|
|
|
resultClocks := make([]uint64, 0, len(clockValues))
|
2019-11-21 16:19:22 +00:00
|
|
|
for _, m := range result {
|
Move to protobuf for Message type (#1706)
* Use a single Message type `v1/message.go` and `message.go` are the same now, and they embed `protobuf.ChatMessage`
* Use `SendChatMessage` for sending chat messages, this is basically the old `Send` but a bit more flexible so we can send different message types (stickers,commands), and not just text.
* Remove dedup from services/shhext. Because now we process in status-protocol, dedup makes less sense, as those messages are going to be processed anyway, so removing for now, we can re-evaluate if bringing it to status-go or not.
* Change the various retrieveX method to a single one:
`RetrieveAll` will be processing those messages that it can process (Currently only `Message`), and return the rest in `RawMessages` (still transit). The format for the response is:
`Chats`: -> The chats updated by receiving the message
`Messages`: -> The messages retrieved (already matched to a chat)
`Contacts`: -> The contacts updated by the messages
`RawMessages` -> Anything else that can't be parsed, eventually as we move everything to status-protocol-go this will go away.
2019-12-05 16:25:34 +00:00
|
|
|
resultClocks = append(resultClocks, m.Clock)
|
2019-11-21 16:19:22 +00:00
|
|
|
}
|
Move to protobuf for Message type (#1706)
* Use a single Message type `v1/message.go` and `message.go` are the same now, and they embed `protobuf.ChatMessage`
* Use `SendChatMessage` for sending chat messages, this is basically the old `Send` but a bit more flexible so we can send different message types (stickers,commands), and not just text.
* Remove dedup from services/shhext. Because now we process in status-protocol, dedup makes less sense, as those messages are going to be processed anyway, so removing for now, we can re-evaluate if bringing it to status-go or not.
* Change the various retrieveX method to a single one:
`RetrieveAll` will be processing those messages that it can process (Currently only `Message`), and return the rest in `RawMessages` (still transit). The format for the response is:
`Chats`: -> The chats updated by receiving the message
`Messages`: -> The messages retrieved (already matched to a chat)
`Contacts`: -> The contacts updated by the messages
`RawMessages` -> Anything else that can't be parsed, eventually as we move everything to status-protocol-go this will go away.
2019-12-05 16:25:34 +00:00
|
|
|
require.EqualValues(t, expectedClocks, resultClocks)
|
2019-11-21 16:19:22 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
func TestDeleteMessageByID(t *testing.T) {
|
|
|
|
db, err := openTestDB()
|
|
|
|
require.NoError(t, err)
|
2022-03-28 10:10:40 +00:00
|
|
|
p := newSQLitePersistence(db)
|
2019-11-21 16:19:22 +00:00
|
|
|
id := "1"
|
|
|
|
|
|
|
|
err = insertMinimalMessage(p, id)
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
m, err := p.MessageByID(id)
|
|
|
|
require.NoError(t, err)
|
|
|
|
require.Equal(t, id, m.ID)
|
|
|
|
|
|
|
|
err = p.DeleteMessage(m.ID)
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
_, err = p.MessageByID(id)
|
|
|
|
require.EqualError(t, err, "record not found")
|
|
|
|
}
|
|
|
|
|
|
|
|
func TestDeleteMessagesByChatID(t *testing.T) {
|
|
|
|
db, err := openTestDB()
|
|
|
|
require.NoError(t, err)
|
2022-03-28 10:10:40 +00:00
|
|
|
p := newSQLitePersistence(db)
|
2019-11-21 16:19:22 +00:00
|
|
|
|
|
|
|
err = insertMinimalMessage(p, "1")
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
err = insertMinimalMessage(p, "2")
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
2020-09-01 13:27:01 +00:00
|
|
|
m, _, err := p.MessageByChatID(testPublicChatID, "", 10)
|
2019-11-21 16:19:22 +00:00
|
|
|
require.NoError(t, err)
|
|
|
|
require.Equal(t, 2, len(m))
|
|
|
|
|
2020-09-01 13:27:01 +00:00
|
|
|
err = p.DeleteMessagesByChatID(testPublicChatID)
|
2019-11-21 16:19:22 +00:00
|
|
|
require.NoError(t, err)
|
|
|
|
|
2020-09-01 13:27:01 +00:00
|
|
|
m, _, err = p.MessageByChatID(testPublicChatID, "", 10)
|
2019-11-21 16:19:22 +00:00
|
|
|
require.NoError(t, err)
|
|
|
|
require.Equal(t, 0, len(m))
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
func TestMarkMessageSeen(t *testing.T) {
|
Move to protobuf for Message type (#1706)
* Use a single Message type `v1/message.go` and `message.go` are the same now, and they embed `protobuf.ChatMessage`
* Use `SendChatMessage` for sending chat messages, this is basically the old `Send` but a bit more flexible so we can send different message types (stickers,commands), and not just text.
* Remove dedup from services/shhext. Because now we process in status-protocol, dedup makes less sense, as those messages are going to be processed anyway, so removing for now, we can re-evaluate if bringing it to status-go or not.
* Change the various retrieveX method to a single one:
`RetrieveAll` will be processing those messages that it can process (Currently only `Message`), and return the rest in `RawMessages` (still transit). The format for the response is:
`Chats`: -> The chats updated by receiving the message
`Messages`: -> The messages retrieved (already matched to a chat)
`Contacts`: -> The contacts updated by the messages
`RawMessages` -> Anything else that can't be parsed, eventually as we move everything to status-protocol-go this will go away.
2019-12-05 16:25:34 +00:00
|
|
|
chatID := "test-chat"
|
2019-11-21 16:19:22 +00:00
|
|
|
db, err := openTestDB()
|
|
|
|
require.NoError(t, err)
|
2022-03-28 10:10:40 +00:00
|
|
|
p := newSQLitePersistence(db)
|
2019-11-21 16:19:22 +00:00
|
|
|
id := "1"
|
|
|
|
|
|
|
|
err = insertMinimalMessage(p, id)
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
m, err := p.MessageByID(id)
|
|
|
|
require.NoError(t, err)
|
|
|
|
require.False(t, m.Seen)
|
|
|
|
|
2021-08-31 08:49:39 +00:00
|
|
|
count, countWithMention, err := p.MarkMessagesSeen(chatID, []string{m.ID})
|
2019-11-21 16:19:22 +00:00
|
|
|
require.NoError(t, err)
|
2020-04-06 12:08:53 +00:00
|
|
|
require.Equal(t, uint64(1), count)
|
2021-08-31 08:49:39 +00:00
|
|
|
require.Equal(t, uint64(0), countWithMention)
|
2019-11-21 16:19:22 +00:00
|
|
|
|
|
|
|
m, err = p.MessageByID(id)
|
|
|
|
require.NoError(t, err)
|
|
|
|
require.True(t, m.Seen)
|
|
|
|
}
|
|
|
|
|
|
|
|
func TestUpdateMessageOutgoingStatus(t *testing.T) {
|
|
|
|
db, err := openTestDB()
|
|
|
|
require.NoError(t, err)
|
2022-03-28 10:10:40 +00:00
|
|
|
p := newSQLitePersistence(db)
|
2019-11-21 16:19:22 +00:00
|
|
|
id := "1"
|
|
|
|
|
|
|
|
err = insertMinimalMessage(p, id)
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
err = p.UpdateMessageOutgoingStatus(id, "new-status")
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
m, err := p.MessageByID(id)
|
|
|
|
require.NoError(t, err)
|
|
|
|
require.Equal(t, "new-status", m.OutgoingStatus)
|
|
|
|
}
|
|
|
|
|
2020-12-15 14:43:41 +00:00
|
|
|
func TestMessagesIDsByType(t *testing.T) {
|
|
|
|
db, err := openTestDB()
|
|
|
|
require.NoError(t, err)
|
2022-03-28 10:10:40 +00:00
|
|
|
p := newSQLitePersistence(db)
|
2020-12-15 14:43:41 +00:00
|
|
|
|
|
|
|
ids, err := p.RawMessagesIDsByType(protobuf.ApplicationMetadataMessage_CHAT_MESSAGE)
|
|
|
|
require.NoError(t, err)
|
|
|
|
require.Empty(t, ids)
|
|
|
|
|
|
|
|
err = p.SaveRawMessage(minimalRawMessage("chat-message-id", protobuf.ApplicationMetadataMessage_CHAT_MESSAGE))
|
|
|
|
require.NoError(t, err)
|
|
|
|
ids, err = p.RawMessagesIDsByType(protobuf.ApplicationMetadataMessage_CHAT_MESSAGE)
|
|
|
|
require.NoError(t, err)
|
|
|
|
require.Equal(t, 1, len(ids))
|
|
|
|
require.Equal(t, "chat-message-id", ids[0])
|
|
|
|
|
|
|
|
ids, err = p.RawMessagesIDsByType(protobuf.ApplicationMetadataMessage_EMOJI_REACTION)
|
|
|
|
require.NoError(t, err)
|
|
|
|
require.Empty(t, ids)
|
|
|
|
|
|
|
|
err = p.SaveRawMessage(minimalRawMessage("emoji-message-id", protobuf.ApplicationMetadataMessage_EMOJI_REACTION))
|
|
|
|
require.NoError(t, err)
|
|
|
|
ids, err = p.RawMessagesIDsByType(protobuf.ApplicationMetadataMessage_EMOJI_REACTION)
|
|
|
|
require.NoError(t, err)
|
|
|
|
require.Equal(t, 1, len(ids))
|
|
|
|
require.Equal(t, "emoji-message-id", ids[0])
|
|
|
|
}
|
|
|
|
|
2021-11-17 09:11:51 +00:00
|
|
|
func TestExpiredMessagesIDs(t *testing.T) {
|
2020-12-15 14:43:41 +00:00
|
|
|
db, err := openTestDB()
|
|
|
|
require.NoError(t, err)
|
2022-03-28 10:10:40 +00:00
|
|
|
p := newSQLitePersistence(db)
|
2020-12-15 14:43:41 +00:00
|
|
|
|
2021-11-17 09:11:51 +00:00
|
|
|
ids, err := p.ExpiredMessagesIDs(messageResendMaxCount)
|
2020-12-15 14:43:41 +00:00
|
|
|
require.NoError(t, err)
|
|
|
|
require.Empty(t, ids)
|
|
|
|
|
|
|
|
//save expired emoji message
|
|
|
|
rawEmojiReaction := minimalRawMessage("emoji-message-id", protobuf.ApplicationMetadataMessage_EMOJI_REACTION)
|
|
|
|
rawEmojiReaction.Sent = false
|
|
|
|
err = p.SaveRawMessage(rawEmojiReaction)
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
//make sure it appered in expired emoji reactions list
|
2021-11-17 09:11:51 +00:00
|
|
|
ids, err = p.ExpiredMessagesIDs(messageResendMaxCount)
|
2020-12-15 14:43:41 +00:00
|
|
|
require.NoError(t, err)
|
|
|
|
require.Equal(t, 1, len(ids))
|
|
|
|
|
|
|
|
//save non-expired emoji reaction
|
|
|
|
rawEmojiReaction2 := minimalRawMessage("emoji-message-id2", protobuf.ApplicationMetadataMessage_EMOJI_REACTION)
|
|
|
|
rawEmojiReaction2.Sent = true
|
|
|
|
err = p.SaveRawMessage(rawEmojiReaction2)
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
//make sure it didn't appear in expired emoji reactions list
|
2021-11-17 09:11:51 +00:00
|
|
|
ids, err = p.ExpiredMessagesIDs(messageResendMaxCount)
|
2020-12-15 14:43:41 +00:00
|
|
|
require.NoError(t, err)
|
|
|
|
require.Equal(t, 1, len(ids))
|
|
|
|
}
|
|
|
|
|
2023-06-19 13:10:21 +00:00
|
|
|
func TestDontOverwriteSentStatus(t *testing.T) {
|
|
|
|
db, err := openTestDB()
|
|
|
|
require.NoError(t, err)
|
|
|
|
p := newSQLitePersistence(db)
|
|
|
|
|
|
|
|
//save rawMessage
|
|
|
|
rawMessage := minimalRawMessage("chat-message-id", protobuf.ApplicationMetadataMessage_CHAT_MESSAGE)
|
|
|
|
rawMessage.Sent = true
|
|
|
|
err = p.SaveRawMessage(rawMessage)
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
rawMessage.Sent = false
|
|
|
|
rawMessage.ResendAutomatically = true
|
|
|
|
err = p.SaveRawMessage(rawMessage)
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
m, err := p.RawMessageByID(rawMessage.ID)
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
require.True(t, m.Sent)
|
|
|
|
require.True(t, m.ResendAutomatically)
|
|
|
|
}
|
|
|
|
|
2020-07-27 15:57:01 +00:00
|
|
|
func TestPersistenceEmojiReactions(t *testing.T) {
|
|
|
|
db, err := openTestDB()
|
|
|
|
require.NoError(t, err)
|
2022-03-28 10:10:40 +00:00
|
|
|
p := newSQLitePersistence(db)
|
2020-07-27 15:57:01 +00:00
|
|
|
// reverse order as we use DESC
|
|
|
|
id1 := "1"
|
|
|
|
id2 := "2"
|
|
|
|
id3 := "3"
|
|
|
|
|
|
|
|
from1 := "from-1"
|
|
|
|
from2 := "from-2"
|
|
|
|
from3 := "from-3"
|
|
|
|
|
2020-09-01 13:27:01 +00:00
|
|
|
chatID := testPublicChatID
|
2020-07-27 15:57:01 +00:00
|
|
|
|
|
|
|
err = insertMinimalMessage(p, id1)
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
err = insertMinimalMessage(p, id2)
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
err = insertMinimalMessage(p, id3)
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
// Insert normal emoji reaction
|
|
|
|
require.NoError(t, p.SaveEmojiReaction(&EmojiReaction{
|
2023-08-18 11:39:59 +00:00
|
|
|
EmojiReaction: &protobuf.EmojiReaction{
|
2020-07-27 15:57:01 +00:00
|
|
|
Clock: 1,
|
|
|
|
MessageId: id3,
|
|
|
|
ChatId: chatID,
|
|
|
|
Type: protobuf.EmojiReaction_SAD,
|
|
|
|
},
|
2020-07-28 07:53:32 +00:00
|
|
|
LocalChatID: chatID,
|
|
|
|
From: from1,
|
2020-07-27 15:57:01 +00:00
|
|
|
}))
|
|
|
|
|
|
|
|
// Insert retracted emoji reaction
|
|
|
|
require.NoError(t, p.SaveEmojiReaction(&EmojiReaction{
|
2023-08-18 11:39:59 +00:00
|
|
|
EmojiReaction: &protobuf.EmojiReaction{
|
2020-07-27 15:57:01 +00:00
|
|
|
Clock: 1,
|
|
|
|
MessageId: id3,
|
|
|
|
ChatId: chatID,
|
|
|
|
Type: protobuf.EmojiReaction_SAD,
|
|
|
|
Retracted: true,
|
|
|
|
},
|
2020-07-28 07:53:32 +00:00
|
|
|
LocalChatID: chatID,
|
|
|
|
From: from2,
|
2020-07-27 15:57:01 +00:00
|
|
|
}))
|
|
|
|
|
|
|
|
// Insert retracted emoji reaction out of pagination
|
|
|
|
require.NoError(t, p.SaveEmojiReaction(&EmojiReaction{
|
2023-08-18 11:39:59 +00:00
|
|
|
EmojiReaction: &protobuf.EmojiReaction{
|
2020-07-27 15:57:01 +00:00
|
|
|
Clock: 1,
|
|
|
|
MessageId: id1,
|
|
|
|
ChatId: chatID,
|
|
|
|
Type: protobuf.EmojiReaction_SAD,
|
|
|
|
},
|
2020-07-28 07:53:32 +00:00
|
|
|
LocalChatID: chatID,
|
|
|
|
From: from2,
|
2020-07-27 15:57:01 +00:00
|
|
|
}))
|
|
|
|
|
|
|
|
// Insert retracted emoji reaction out of pagination
|
|
|
|
require.NoError(t, p.SaveEmojiReaction(&EmojiReaction{
|
2023-08-18 11:39:59 +00:00
|
|
|
EmojiReaction: &protobuf.EmojiReaction{
|
2020-07-27 15:57:01 +00:00
|
|
|
Clock: 1,
|
|
|
|
MessageId: id1,
|
|
|
|
ChatId: chatID,
|
|
|
|
Type: protobuf.EmojiReaction_SAD,
|
|
|
|
},
|
2020-07-28 07:53:32 +00:00
|
|
|
LocalChatID: chatID,
|
|
|
|
From: from3,
|
|
|
|
}))
|
|
|
|
|
|
|
|
// Wrong local chat id
|
|
|
|
require.NoError(t, p.SaveEmojiReaction(&EmojiReaction{
|
2023-08-18 11:39:59 +00:00
|
|
|
EmojiReaction: &protobuf.EmojiReaction{
|
2020-07-28 07:53:32 +00:00
|
|
|
Clock: 1,
|
|
|
|
MessageId: id1,
|
|
|
|
ChatId: chatID,
|
|
|
|
Type: protobuf.EmojiReaction_LOVE,
|
|
|
|
},
|
|
|
|
LocalChatID: "wrong-chat-id",
|
|
|
|
From: from3,
|
2020-07-27 15:57:01 +00:00
|
|
|
}))
|
|
|
|
|
|
|
|
reactions, err := p.EmojiReactionsByChatID(chatID, "", 1)
|
|
|
|
require.NoError(t, err)
|
|
|
|
require.Len(t, reactions, 1)
|
|
|
|
require.Equal(t, id3, reactions[0].MessageId)
|
|
|
|
|
|
|
|
// Try with a cursor
|
|
|
|
_, cursor, err := p.MessageByChatID(chatID, "", 1)
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
reactions, err = p.EmojiReactionsByChatID(chatID, cursor, 2)
|
|
|
|
require.NoError(t, err)
|
|
|
|
require.Len(t, reactions, 2)
|
|
|
|
require.Equal(t, id1, reactions[0].MessageId)
|
|
|
|
require.Equal(t, id1, reactions[1].MessageId)
|
|
|
|
}
|
|
|
|
|
2019-11-21 16:19:22 +00:00
|
|
|
func openTestDB() (*sql.DB, error) {
|
2023-10-02 09:28:42 +00:00
|
|
|
db, err := helpers.SetupTestMemorySQLDB(appdatabase.DbInitializer{})
|
2019-11-21 16:19:22 +00:00
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
2023-10-02 09:28:42 +00:00
|
|
|
|
|
|
|
return db, sqlite.Migrate(db)
|
2019-11-21 16:19:22 +00:00
|
|
|
}
|
|
|
|
|
2021-03-09 12:48:15 +00:00
|
|
|
func insertMinimalMessage(p *sqlitePersistence, id string) error {
|
2020-09-01 13:27:01 +00:00
|
|
|
return p.SaveMessages([]*common.Message{{
|
Move to protobuf for Message type (#1706)
* Use a single Message type `v1/message.go` and `message.go` are the same now, and they embed `protobuf.ChatMessage`
* Use `SendChatMessage` for sending chat messages, this is basically the old `Send` but a bit more flexible so we can send different message types (stickers,commands), and not just text.
* Remove dedup from services/shhext. Because now we process in status-protocol, dedup makes less sense, as those messages are going to be processed anyway, so removing for now, we can re-evaluate if bringing it to status-go or not.
* Change the various retrieveX method to a single one:
`RetrieveAll` will be processing those messages that it can process (Currently only `Message`), and return the rest in `RawMessages` (still transit). The format for the response is:
`Chats`: -> The chats updated by receiving the message
`Messages`: -> The messages retrieved (already matched to a chat)
`Contacts`: -> The contacts updated by the messages
`RawMessages` -> Anything else that can't be parsed, eventually as we move everything to status-protocol-go this will go away.
2019-12-05 16:25:34 +00:00
|
|
|
ID: id,
|
2020-09-01 13:27:01 +00:00
|
|
|
LocalChatID: testPublicChatID,
|
2023-08-18 11:39:59 +00:00
|
|
|
ChatMessage: &protobuf.ChatMessage{Text: "some-text"},
|
2023-01-20 18:51:36 +00:00
|
|
|
From: testPK,
|
2019-11-21 16:19:22 +00:00
|
|
|
}})
|
|
|
|
}
|
2020-07-30 06:26:19 +00:00
|
|
|
|
2022-11-17 10:11:58 +00:00
|
|
|
func insertMinimalDeletedMessage(p *sqlitePersistence, id string) error {
|
|
|
|
return p.SaveMessages([]*common.Message{{
|
|
|
|
ID: id,
|
|
|
|
Deleted: true,
|
|
|
|
LocalChatID: testPublicChatID,
|
2023-08-18 11:39:59 +00:00
|
|
|
ChatMessage: &protobuf.ChatMessage{Text: "some-text"},
|
2023-01-20 18:51:36 +00:00
|
|
|
From: testPK,
|
2022-11-17 10:11:58 +00:00
|
|
|
}})
|
|
|
|
}
|
|
|
|
|
|
|
|
func insertMinimalDeletedForMeMessage(p *sqlitePersistence, id string) error {
|
|
|
|
return p.SaveMessages([]*common.Message{{
|
|
|
|
ID: id,
|
|
|
|
DeletedForMe: true,
|
|
|
|
LocalChatID: testPublicChatID,
|
2023-08-18 11:39:59 +00:00
|
|
|
ChatMessage: &protobuf.ChatMessage{Text: "some-text"},
|
2023-01-20 18:51:36 +00:00
|
|
|
From: testPK,
|
2022-11-17 10:11:58 +00:00
|
|
|
}})
|
|
|
|
}
|
|
|
|
|
2022-09-20 09:13:44 +00:00
|
|
|
func insertDiscordMessageWithAttachments(p *sqlitePersistence, id string, discordMessageID string) error {
|
|
|
|
err := insertMinimalDiscordMessage(p, id, discordMessageID)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
attachment := &protobuf.DiscordMessageAttachment{
|
|
|
|
Id: "1",
|
|
|
|
MessageId: discordMessageID,
|
|
|
|
Url: "https://does-not-exist.com",
|
|
|
|
Payload: []byte{1, 2, 3, 4},
|
|
|
|
}
|
|
|
|
|
|
|
|
attachment2 := &protobuf.DiscordMessageAttachment{
|
|
|
|
Id: "2",
|
|
|
|
MessageId: discordMessageID,
|
|
|
|
Url: "https://does-not-exist.com",
|
|
|
|
Payload: []byte{5, 6, 7, 8},
|
|
|
|
}
|
|
|
|
|
|
|
|
return p.SaveDiscordMessageAttachments([]*protobuf.DiscordMessageAttachment{
|
|
|
|
attachment,
|
|
|
|
attachment2,
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
2022-08-04 16:16:56 +00:00
|
|
|
func insertMinimalDiscordMessage(p *sqlitePersistence, id string, discordMessageID string) error {
|
|
|
|
discordMessage := &protobuf.DiscordMessage{
|
|
|
|
Id: discordMessageID,
|
|
|
|
Type: "Default",
|
|
|
|
Timestamp: "123456",
|
|
|
|
Content: "This is the message",
|
|
|
|
Author: &protobuf.DiscordMessageAuthor{
|
|
|
|
Id: "2",
|
|
|
|
},
|
|
|
|
Reference: &protobuf.DiscordMessageReference{},
|
|
|
|
}
|
|
|
|
|
|
|
|
err := p.SaveDiscordMessage(discordMessage)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
return p.SaveMessages([]*common.Message{{
|
|
|
|
ID: id,
|
|
|
|
LocalChatID: testPublicChatID,
|
2023-01-20 18:51:36 +00:00
|
|
|
From: testPK,
|
2023-08-18 11:39:59 +00:00
|
|
|
ChatMessage: &protobuf.ChatMessage{
|
2022-08-04 16:16:56 +00:00
|
|
|
Text: "some-text",
|
|
|
|
ContentType: protobuf.ChatMessage_DISCORD_MESSAGE,
|
|
|
|
ChatId: testPublicChatID,
|
|
|
|
Payload: &protobuf.ChatMessage_DiscordMessage{
|
|
|
|
DiscordMessage: discordMessage,
|
|
|
|
},
|
|
|
|
},
|
|
|
|
}})
|
|
|
|
}
|
|
|
|
|
2020-12-15 14:43:41 +00:00
|
|
|
func minimalRawMessage(id string, messageType protobuf.ApplicationMetadataMessage_Type) *common.RawMessage {
|
|
|
|
return &common.RawMessage{
|
|
|
|
ID: id,
|
|
|
|
LocalChatID: "test-chat",
|
|
|
|
MessageType: messageType,
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-07-30 06:26:19 +00:00
|
|
|
// Regression test making sure that if audio_duration_ms is null, no error is thrown
|
|
|
|
func TestMessagesAudioDurationMsNull(t *testing.T) {
|
|
|
|
db, err := openTestDB()
|
|
|
|
require.NoError(t, err)
|
2022-03-28 10:10:40 +00:00
|
|
|
p := newSQLitePersistence(db)
|
2020-07-30 06:26:19 +00:00
|
|
|
id := "message-id-1"
|
|
|
|
|
|
|
|
err = insertMinimalMessage(p, id)
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
_, err = p.db.Exec("UPDATE user_messages SET audio_duration_ms = NULL")
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
m, err := p.MessagesByIDs([]string{id})
|
|
|
|
require.NoError(t, err)
|
|
|
|
require.Len(t, m, 1)
|
|
|
|
|
2020-09-01 13:27:01 +00:00
|
|
|
m, _, err = p.MessageByChatID(testPublicChatID, "", 10)
|
2020-07-30 06:26:19 +00:00
|
|
|
require.NoError(t, err)
|
|
|
|
require.Len(t, m, 1)
|
|
|
|
}
|
2020-08-17 06:37:18 +00:00
|
|
|
|
|
|
|
func TestSaveChat(t *testing.T) {
|
|
|
|
db, err := openTestDB()
|
|
|
|
require.NoError(t, err)
|
2022-03-28 10:10:40 +00:00
|
|
|
p := newSQLitePersistence(db)
|
2020-08-17 06:37:18 +00:00
|
|
|
|
|
|
|
chat := CreatePublicChat("test-chat", &testTimeSource{})
|
2023-08-18 11:39:59 +00:00
|
|
|
chat.LastMessage = common.NewMessage()
|
2021-01-11 10:32:51 +00:00
|
|
|
err = p.SaveChat(*chat)
|
2020-08-17 06:37:18 +00:00
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
retrievedChat, err := p.Chat(chat.ID)
|
|
|
|
require.NoError(t, err)
|
2021-01-11 10:32:51 +00:00
|
|
|
require.Equal(t, chat, retrievedChat)
|
2020-08-17 06:37:18 +00:00
|
|
|
}
|
2020-09-01 10:34:28 +00:00
|
|
|
|
|
|
|
func TestSaveMentions(t *testing.T) {
|
2020-09-01 13:27:01 +00:00
|
|
|
chatID := testPublicChatID
|
2020-09-01 10:34:28 +00:00
|
|
|
db, err := openTestDB()
|
|
|
|
require.NoError(t, err)
|
2022-03-28 10:10:40 +00:00
|
|
|
p := newSQLitePersistence(db)
|
2020-09-01 10:34:28 +00:00
|
|
|
|
|
|
|
key, err := crypto.GenerateKey()
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
pkString := types.EncodeHex(crypto.FromECDSAPub(&key.PublicKey))
|
|
|
|
|
2020-09-01 13:27:01 +00:00
|
|
|
message := common.Message{
|
2020-09-01 10:34:28 +00:00
|
|
|
ID: "1",
|
|
|
|
LocalChatID: chatID,
|
2023-08-18 11:39:59 +00:00
|
|
|
ChatMessage: &protobuf.ChatMessage{Text: "some-text"},
|
2023-01-20 18:51:36 +00:00
|
|
|
From: testPK,
|
2020-09-01 10:34:28 +00:00
|
|
|
Mentions: []string{pkString},
|
|
|
|
}
|
|
|
|
|
2020-09-01 13:27:01 +00:00
|
|
|
err = p.SaveMessages([]*common.Message{&message})
|
2020-09-01 10:34:28 +00:00
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
retrievedMessages, _, err := p.MessageByChatID(chatID, "", 10)
|
|
|
|
require.NoError(t, err)
|
|
|
|
require.Len(t, retrievedMessages, 1)
|
|
|
|
require.Len(t, retrievedMessages[0].Mentions, 1)
|
|
|
|
require.Equal(t, retrievedMessages[0].Mentions, message.Mentions)
|
2020-10-28 13:18:24 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
func TestSqlitePersistence_GetWhenChatIdentityLastPublished(t *testing.T) {
|
|
|
|
db, err := openTestDB()
|
|
|
|
require.NoError(t, err)
|
2022-03-28 10:10:40 +00:00
|
|
|
p := newSQLitePersistence(db)
|
2020-10-28 13:41:22 +00:00
|
|
|
|
2020-11-24 23:16:19 +00:00
|
|
|
chatID := "0xabcd1234"
|
2020-12-10 10:12:51 +00:00
|
|
|
hash := []byte{0x1}
|
2020-10-28 13:41:22 +00:00
|
|
|
now := time.Now().Unix()
|
2020-10-28 13:18:24 +00:00
|
|
|
|
2020-12-10 10:12:51 +00:00
|
|
|
err = p.SaveWhenChatIdentityLastPublished(chatID, hash)
|
2020-10-28 13:18:24 +00:00
|
|
|
require.NoError(t, err)
|
|
|
|
|
2020-12-10 10:12:51 +00:00
|
|
|
ts, actualHash, err := p.GetWhenChatIdentityLastPublished(chatID)
|
2020-10-28 13:18:24 +00:00
|
|
|
require.NoError(t, err)
|
2020-09-01 10:34:28 +00:00
|
|
|
|
2020-10-28 13:59:51 +00:00
|
|
|
// Check that the save happened in the last 2 seconds
|
2020-12-16 18:28:34 +00:00
|
|
|
diff := ts - now
|
2020-10-28 13:41:22 +00:00
|
|
|
require.LessOrEqual(t, diff, int64(2))
|
2020-10-28 13:59:51 +00:00
|
|
|
|
2020-12-10 10:12:51 +00:00
|
|
|
require.True(t, bytes.Equal(hash, actualHash))
|
|
|
|
|
2020-10-28 13:59:51 +00:00
|
|
|
// Require unsaved values to be zero
|
2020-12-10 10:12:51 +00:00
|
|
|
ts2, actualHash2, err := p.GetWhenChatIdentityLastPublished("0xdeadbeef")
|
2020-10-28 13:59:51 +00:00
|
|
|
require.NoError(t, err)
|
2020-12-16 18:28:34 +00:00
|
|
|
require.Exactly(t, int64(0), ts2)
|
2020-12-10 10:12:51 +00:00
|
|
|
require.Nil(t, actualHash2)
|
2020-09-01 10:34:28 +00:00
|
|
|
}
|
2020-10-27 17:35:28 +00:00
|
|
|
|
2022-08-02 12:56:26 +00:00
|
|
|
func TestSaveContactChatIdentity(t *testing.T) {
|
2020-12-15 15:28:05 +00:00
|
|
|
db, err := openTestDB()
|
|
|
|
require.NoError(t, err)
|
2022-03-28 10:10:40 +00:00
|
|
|
p := newSQLitePersistence(db)
|
2020-12-15 15:28:05 +00:00
|
|
|
|
|
|
|
key, err := crypto.GenerateKey()
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
contactID := types.EncodeHex(crypto.FromECDSAPub(&key.PublicKey))
|
|
|
|
|
|
|
|
err = p.SaveContact(&Contact{ID: contactID}, nil)
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
jpegType := []byte{0xff, 0xd8, 0xff, 0x1}
|
|
|
|
identityImages := make(map[string]*protobuf.IdentityImage)
|
|
|
|
identityImages["large"] = &protobuf.IdentityImage{
|
|
|
|
Payload: jpegType,
|
|
|
|
SourceType: protobuf.IdentityImage_RAW_PAYLOAD,
|
|
|
|
ImageType: protobuf.ImageType_PNG,
|
|
|
|
}
|
|
|
|
|
|
|
|
identityImages["small"] = &protobuf.IdentityImage{
|
|
|
|
Payload: jpegType,
|
|
|
|
SourceType: protobuf.IdentityImage_RAW_PAYLOAD,
|
|
|
|
ImageType: protobuf.ImageType_PNG,
|
|
|
|
}
|
|
|
|
|
2022-08-02 12:56:26 +00:00
|
|
|
toArrayOfPointers := func(array []protobuf.SocialLink) (result []*protobuf.SocialLink) {
|
|
|
|
result = make([]*protobuf.SocialLink, len(array))
|
|
|
|
for i := range array {
|
|
|
|
result[i] = &array[i]
|
|
|
|
}
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
|
|
|
chatIdentity := &protobuf.ChatIdentity{
|
2020-12-15 15:28:05 +00:00
|
|
|
Clock: 1,
|
|
|
|
Images: identityImages,
|
2022-08-02 12:56:26 +00:00
|
|
|
SocialLinks: toArrayOfPointers([]protobuf.SocialLink{
|
|
|
|
{
|
|
|
|
Text: "Personal Site",
|
|
|
|
Url: "status.im",
|
|
|
|
},
|
|
|
|
{
|
|
|
|
Text: "Twitter",
|
|
|
|
Url: "Status_ico",
|
|
|
|
},
|
|
|
|
}),
|
2020-12-15 15:28:05 +00:00
|
|
|
}
|
|
|
|
|
2022-08-02 12:56:26 +00:00
|
|
|
clockUpdated, imagesUpdated, err := p.SaveContactChatIdentity(contactID, chatIdentity)
|
|
|
|
require.NoError(t, err)
|
|
|
|
require.True(t, clockUpdated)
|
|
|
|
require.True(t, imagesUpdated)
|
|
|
|
|
|
|
|
// Save again same clock and data
|
|
|
|
clockUpdated, imagesUpdated, err = p.SaveContactChatIdentity(contactID, chatIdentity)
|
2020-12-15 15:28:05 +00:00
|
|
|
require.NoError(t, err)
|
2022-08-02 12:56:26 +00:00
|
|
|
require.False(t, clockUpdated)
|
|
|
|
require.False(t, imagesUpdated)
|
2020-12-15 15:28:05 +00:00
|
|
|
|
2022-08-02 12:56:26 +00:00
|
|
|
// Save again newer clock and no images
|
|
|
|
chatIdentity.Clock = 2
|
|
|
|
chatIdentity.Images = make(map[string]*protobuf.IdentityImage)
|
|
|
|
clockUpdated, imagesUpdated, err = p.SaveContactChatIdentity(contactID, chatIdentity)
|
2020-12-15 15:28:05 +00:00
|
|
|
require.NoError(t, err)
|
2022-08-02 12:56:26 +00:00
|
|
|
require.True(t, clockUpdated)
|
|
|
|
require.False(t, imagesUpdated)
|
2020-12-15 15:28:05 +00:00
|
|
|
|
|
|
|
contacts, err := p.Contacts()
|
|
|
|
require.NoError(t, err)
|
|
|
|
require.Len(t, contacts, 1)
|
|
|
|
|
|
|
|
require.Len(t, contacts[0].Images, 2)
|
2022-08-02 12:56:26 +00:00
|
|
|
require.Len(t, contacts[0].SocialLinks, 2)
|
|
|
|
require.Equal(t, "Personal Site", contacts[0].SocialLinks[0].Text)
|
|
|
|
require.Equal(t, "status.im", contacts[0].SocialLinks[0].URL)
|
|
|
|
require.Equal(t, "Twitter", contacts[0].SocialLinks[1].Text)
|
|
|
|
require.Equal(t, "Status_ico", contacts[0].SocialLinks[1].URL)
|
2020-12-15 15:28:05 +00:00
|
|
|
}
|
|
|
|
|
2020-10-27 17:35:28 +00:00
|
|
|
func TestSaveLinks(t *testing.T) {
|
|
|
|
chatID := testPublicChatID
|
|
|
|
db, err := openTestDB()
|
|
|
|
require.NoError(t, err)
|
2022-03-28 10:10:40 +00:00
|
|
|
p := newSQLitePersistence(db)
|
2020-10-27 17:35:28 +00:00
|
|
|
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
message := common.Message{
|
|
|
|
ID: "1",
|
|
|
|
LocalChatID: chatID,
|
2023-08-18 11:39:59 +00:00
|
|
|
ChatMessage: &protobuf.ChatMessage{Text: "some-text"},
|
2023-01-20 18:51:36 +00:00
|
|
|
From: testPK,
|
2022-07-17 13:37:14 +00:00
|
|
|
Links: []string{"https://github.com/status-im/status-mobile"},
|
2020-10-27 17:35:28 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
err = p.SaveMessages([]*common.Message{&message})
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
retrievedMessages, _, err := p.MessageByChatID(chatID, "", 10)
|
|
|
|
require.NoError(t, err)
|
|
|
|
require.Len(t, retrievedMessages, 1)
|
|
|
|
require.Len(t, retrievedMessages[0].Links, 1)
|
|
|
|
require.Equal(t, retrievedMessages[0].Links, message.Links)
|
URL unfurling (initial implementation) (#3471)
This is the initial implementation for the new URL unfurling requirements. The
most important one is that only the message sender will pay the privacy cost for
unfurling and extracting metadata from websites. Once the message is sent, the
unfurled data will be stored at the protocol level and receivers will just
profit and happily decode the metadata to render it.
Further development of this URL unfurling capability will be mostly guided by
issues created on clients. For the moment in status-mobile:
https://github.com/status-im/status-mobile/labels/url-preview
- https://github.com/status-im/status-mobile/issues/15918
- https://github.com/status-im/status-mobile/issues/15917
- https://github.com/status-im/status-mobile/issues/15910
- https://github.com/status-im/status-mobile/issues/15909
- https://github.com/status-im/status-mobile/issues/15908
- https://github.com/status-im/status-mobile/issues/15906
- https://github.com/status-im/status-mobile/issues/15905
### Terminology
In the code, I've tried to stick to the word "unfurl URL" to really mean the
process of extracting metadata from a website, sort of lower level. I use "link
preview" to mean a higher level structure which is enriched by unfurled data.
"link preview" is also how designers refer to it.
### User flows
1. Carol needs to see link previews while typing in the chat input field. Notice
from the diagram nothing is persisted and that status-go endpoints are
essentially stateless.
```
#+begin_src plantuml :results verbatim
Client->>Server: Call wakuext_getTextURLs
Server-->>Client: Normalized URLs
Client->>Client: Render cached unfurled URLs
Client->>Server: Unfurl non-cached URLs.\nCall wakuext_unfurlURLs
Server->>Website: Fetch metadata
Website-->>Server: Metadata (thumbnail URL, title, etc)
Server->>Website: Fetch thumbnail
Server->>Website: Fetch favicon
Website-->>Server: Favicon bytes
Website-->>Server: Thumbnail bytes
Server->>Server: Decode & process images
Server-->>Client: Unfurled data (thumbnail data URI, etc)
#+end_src
```
```
,------. ,------. ,-------.
|Client| |Server| |Website|
`--+---' `--+---' `---+---'
| Call wakuext_getTextURLs | |
| ---------------------------------------> |
| | |
| Normalized URLs | |
| <- - - - - - - - - - - - - - - - - - - - |
| | |
|----. | |
| | Render cached unfurled URLs | |
|<---' | |
| | |
| Unfurl non-cached URLs. | |
| Call wakuext_unfurlURLs | |
| ---------------------------------------> |
| | |
| | Fetch metadata |
| | ------------------------------------>
| | |
| | Metadata (thumbnail URL, title, etc)|
| | <- - - - - - - - - - - - - - - - - -
| | |
| | Fetch thumbnail |
| | ------------------------------------>
| | |
| | Fetch favicon |
| | ------------------------------------>
| | |
| | Favicon bytes |
| | <- - - - - - - - - - - - - - - - - -
| | |
| | Thumbnail bytes |
| | <- - - - - - - - - - - - - - - - - -
| | |
| |----. |
| | | Decode & process images |
| |<---' |
| | |
| Unfurled data (thumbnail data URI, etc)| |
| <- - - - - - - - - - - - - - - - - - - - |
,--+---. ,--+---. ,---+---.
|Client| |Server| |Website|
`------' `------' `-------'
```
2. Carol sends the text message with link previews in the RPC request
wakuext_sendChatMessages. status-go assumes the link previews are good
because it can't and shouldn't attempt to re-unfurl them.
```
#+begin_src plantuml :results verbatim
Client->>Server: Call wakuext_sendChatMessages
Server->>Server: Transform link previews to\nbe proto-marshalled
Server->DB: Write link previews serialized as JSON
Server-->>Client: Updated message response
#+end_src
```
```
,------. ,------. ,--.
|Client| |Server| |DB|
`--+---' `--+---' `+-'
| Call wakuext_sendChatMessages| |
| -----------------------------> |
| | |
| |----. |
| | | Transform link previews to |
| |<---' be proto-marshalled |
| | |
| | |
| | Write link previews serialized as JSON|
| | -------------------------------------->
| | |
| Updated message response | |
| <- - - - - - - - - - - - - - - |
,--+---. ,--+---. ,+-.
|Client| |Server| |DB|
`------' `------' `--'
```
3. The message was sent over waku and persisted locally in Carol's device. She
should now see the link previews in the chat history. There can be many link
previews shared by other chat members, therefore it is important to serve the
assets via the media server to avoid overloading the ReactNative bridge with
lots of big JSON payloads containing base64 encoded data URIs (maybe this
concern is meaningless for desktop). When a client is rendering messages with
link previews, they will have the field linkPreviews, and the thumbnail URL
will point to the local media server.
```
#+begin_src plantuml :results verbatim
Client->>Server: GET /link-preview/thumbnail (media server)
Server->>DB: Read from user_messages.unfurled_links
Server->Server: Unmarshal JSON
Server-->>Client: HTTP Content-Type: image/jpeg/etc
#+end_src
```
```
,------. ,------. ,--.
|Client| |Server| |DB|
`--+---' `--+---' `+-'
| GET /link-preview/thumbnail (media server)| |
| ------------------------------------------> |
| | |
| | Read from user_messages.unfurled_links|
| | -------------------------------------->
| | |
| |----. |
| | | Unmarshal JSON |
| |<---' |
| | |
| HTTP Content-Type: image/jpeg/etc | |
| <- - - - - - - - - - - - - - - - - - - - - |
,--+---. ,--+---. ,+-.
|Client| |Server| |DB|
`------' `------' `--'
```
### Some limitations of the current implementation
The following points will become separate issues in status-go that I'll work on
over the next couple weeks. In no order of importance:
- Improve how multiple links are fetched; retries on failure and testing how
unfurling behaves around the timeout limits (deterministically, not by making
real HTTP calls as I did). https://github.com/status-im/status-go/issues/3498
- Unfurl favicons and store them in the protobuf too.
- For this PR, I added unfurling support only for websites with OpenGraph
https://ogp.me/ meta tags. Other unfurlers will be implemented on demand. The
next one will probably be for oEmbed https://oembed.com/, the protocol
supported by YouTube, for example.
- Resize and/or compress thumbnails (and favicons). Often times, thumbnails are
huge for the purposes of link previews. There is already support for
compressing JPEGs in status-go, but I prefer to work with compression in a
separate PR because I'd like to also solve the problem for PNGs (probably
convert them to JPEGs, plus compress them). This would be a safe choice for
thumbnails, favicons not so much because transparency is desirable.
- Editing messages is not yet supported.
- I haven't coded any artificial limit on the number of previews or on the size
of the thumbnail payload. This will be done in a separate issue. I have heard
the ideal solution may be to split messages into smaller chunks of ~125 KiB
because of libp2p, but that might be too complicated at this stage of the
product (?).
- Link preview deletion.
- For the moment, OpenGraph metadata is extracted by requesting data for the
English language (and fallback to whatever is available). In the future, we'll
want to unfurl by respecting the user's local device language. Some websites,
like GoDaddy, are already localized based on the device's IP, but many aren't.
- The website's description text should be limited by a certain number of
characters, especially because it's outside our control. Exactly how much has
not been decided yet, so it'll be done separately.
- URL normalization can be tricky, so I implemented only the basics to help with
caching. For example, the url https://status.im and HTTPS://status.im are
considered identical. Also, a URL is considered valid for unfurling if its TLD
exists according to publicsuffix.EffectiveTLDPlusOne. This was essential,
otherwise the default Go url.Parse approach would consider many invalid URLs
valid, and thus the server would waste resources trying to unfurl the
unfurleable.
### Other requirements
- If the message is edited, the link previews should reflect the edited text,
not the original one. This has been aligned with the design team as well.
- If the website's thumbnail or the favicon can't be fetched, just ignore them.
The only mandatory piece of metadata is the website's title and URL.
- Link previews in clients should be generated in near real-time, that is, as
the user types, previews are updated. In mobile this performs very well, and
it's what other clients like WhatsApp, Telegram, and Facebook do.
### Decisions
- While the user typing in the input field, the client is constantly (debounced)
asking status-go to parse the text and extract normalized URLs and then the
client checks if they're already in its in-memory cache. If they are, no RPC
call is made. I chose this approach to achieve the best possible performance
in mobile and avoid the whole RPC overhead, since the chat experience is
already not smooth enough. The mobile client uses URLs as cache keys in a
hashmap, i.e. if the key is present, it means the preview is readily available
(naive, but good enough for now). This decision also gave me more flexibility
to find the best UX at this stage of the feature.
- Due to the requirement that users should be able to see independent loading
indicators for each link preview, when status-go can't unfurl a URL, it
doesn't return it in the response.
- As an initial implementation, I added the BLOB column unfurled_links to the
user_messages table. The preview data is then serialized as JSON before being
stored in this column. I felt that creating a separate table and the related
code for this initial PR would be inconvenient. Is that reasonable to you?
Once things stabilize I can create a proper table if we want to avoid this
kind of solution with serialized columns.
2023-05-18 18:43:06 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
func TestSaveWithUnfurledLinks(t *testing.T) {
|
|
|
|
db, err := openTestDB()
|
|
|
|
require.NoError(t, err)
|
|
|
|
p := newSQLitePersistence(db)
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
chatID := testPublicChatID
|
|
|
|
message := common.Message{
|
|
|
|
ID: "1",
|
|
|
|
LocalChatID: chatID,
|
|
|
|
From: testPK,
|
2023-08-18 11:39:59 +00:00
|
|
|
ChatMessage: &protobuf.ChatMessage{
|
URL unfurling (initial implementation) (#3471)
This is the initial implementation for the new URL unfurling requirements. The
most important one is that only the message sender will pay the privacy cost for
unfurling and extracting metadata from websites. Once the message is sent, the
unfurled data will be stored at the protocol level and receivers will just
profit and happily decode the metadata to render it.
Further development of this URL unfurling capability will be mostly guided by
issues created on clients. For the moment in status-mobile:
https://github.com/status-im/status-mobile/labels/url-preview
- https://github.com/status-im/status-mobile/issues/15918
- https://github.com/status-im/status-mobile/issues/15917
- https://github.com/status-im/status-mobile/issues/15910
- https://github.com/status-im/status-mobile/issues/15909
- https://github.com/status-im/status-mobile/issues/15908
- https://github.com/status-im/status-mobile/issues/15906
- https://github.com/status-im/status-mobile/issues/15905
### Terminology
In the code, I've tried to stick to the word "unfurl URL" to really mean the
process of extracting metadata from a website, sort of lower level. I use "link
preview" to mean a higher level structure which is enriched by unfurled data.
"link preview" is also how designers refer to it.
### User flows
1. Carol needs to see link previews while typing in the chat input field. Notice
from the diagram nothing is persisted and that status-go endpoints are
essentially stateless.
```
#+begin_src plantuml :results verbatim
Client->>Server: Call wakuext_getTextURLs
Server-->>Client: Normalized URLs
Client->>Client: Render cached unfurled URLs
Client->>Server: Unfurl non-cached URLs.\nCall wakuext_unfurlURLs
Server->>Website: Fetch metadata
Website-->>Server: Metadata (thumbnail URL, title, etc)
Server->>Website: Fetch thumbnail
Server->>Website: Fetch favicon
Website-->>Server: Favicon bytes
Website-->>Server: Thumbnail bytes
Server->>Server: Decode & process images
Server-->>Client: Unfurled data (thumbnail data URI, etc)
#+end_src
```
```
,------. ,------. ,-------.
|Client| |Server| |Website|
`--+---' `--+---' `---+---'
| Call wakuext_getTextURLs | |
| ---------------------------------------> |
| | |
| Normalized URLs | |
| <- - - - - - - - - - - - - - - - - - - - |
| | |
|----. | |
| | Render cached unfurled URLs | |
|<---' | |
| | |
| Unfurl non-cached URLs. | |
| Call wakuext_unfurlURLs | |
| ---------------------------------------> |
| | |
| | Fetch metadata |
| | ------------------------------------>
| | |
| | Metadata (thumbnail URL, title, etc)|
| | <- - - - - - - - - - - - - - - - - -
| | |
| | Fetch thumbnail |
| | ------------------------------------>
| | |
| | Fetch favicon |
| | ------------------------------------>
| | |
| | Favicon bytes |
| | <- - - - - - - - - - - - - - - - - -
| | |
| | Thumbnail bytes |
| | <- - - - - - - - - - - - - - - - - -
| | |
| |----. |
| | | Decode & process images |
| |<---' |
| | |
| Unfurled data (thumbnail data URI, etc)| |
| <- - - - - - - - - - - - - - - - - - - - |
,--+---. ,--+---. ,---+---.
|Client| |Server| |Website|
`------' `------' `-------'
```
2. Carol sends the text message with link previews in the RPC request
wakuext_sendChatMessages. status-go assumes the link previews are good
because it can't and shouldn't attempt to re-unfurl them.
```
#+begin_src plantuml :results verbatim
Client->>Server: Call wakuext_sendChatMessages
Server->>Server: Transform link previews to\nbe proto-marshalled
Server->DB: Write link previews serialized as JSON
Server-->>Client: Updated message response
#+end_src
```
```
,------. ,------. ,--.
|Client| |Server| |DB|
`--+---' `--+---' `+-'
| Call wakuext_sendChatMessages| |
| -----------------------------> |
| | |
| |----. |
| | | Transform link previews to |
| |<---' be proto-marshalled |
| | |
| | |
| | Write link previews serialized as JSON|
| | -------------------------------------->
| | |
| Updated message response | |
| <- - - - - - - - - - - - - - - |
,--+---. ,--+---. ,+-.
|Client| |Server| |DB|
`------' `------' `--'
```
3. The message was sent over waku and persisted locally in Carol's device. She
should now see the link previews in the chat history. There can be many link
previews shared by other chat members, therefore it is important to serve the
assets via the media server to avoid overloading the ReactNative bridge with
lots of big JSON payloads containing base64 encoded data URIs (maybe this
concern is meaningless for desktop). When a client is rendering messages with
link previews, they will have the field linkPreviews, and the thumbnail URL
will point to the local media server.
```
#+begin_src plantuml :results verbatim
Client->>Server: GET /link-preview/thumbnail (media server)
Server->>DB: Read from user_messages.unfurled_links
Server->Server: Unmarshal JSON
Server-->>Client: HTTP Content-Type: image/jpeg/etc
#+end_src
```
```
,------. ,------. ,--.
|Client| |Server| |DB|
`--+---' `--+---' `+-'
| GET /link-preview/thumbnail (media server)| |
| ------------------------------------------> |
| | |
| | Read from user_messages.unfurled_links|
| | -------------------------------------->
| | |
| |----. |
| | | Unmarshal JSON |
| |<---' |
| | |
| HTTP Content-Type: image/jpeg/etc | |
| <- - - - - - - - - - - - - - - - - - - - - |
,--+---. ,--+---. ,+-.
|Client| |Server| |DB|
`------' `------' `--'
```
### Some limitations of the current implementation
The following points will become separate issues in status-go that I'll work on
over the next couple weeks. In no order of importance:
- Improve how multiple links are fetched; retries on failure and testing how
unfurling behaves around the timeout limits (deterministically, not by making
real HTTP calls as I did). https://github.com/status-im/status-go/issues/3498
- Unfurl favicons and store them in the protobuf too.
- For this PR, I added unfurling support only for websites with OpenGraph
https://ogp.me/ meta tags. Other unfurlers will be implemented on demand. The
next one will probably be for oEmbed https://oembed.com/, the protocol
supported by YouTube, for example.
- Resize and/or compress thumbnails (and favicons). Often times, thumbnails are
huge for the purposes of link previews. There is already support for
compressing JPEGs in status-go, but I prefer to work with compression in a
separate PR because I'd like to also solve the problem for PNGs (probably
convert them to JPEGs, plus compress them). This would be a safe choice for
thumbnails, favicons not so much because transparency is desirable.
- Editing messages is not yet supported.
- I haven't coded any artificial limit on the number of previews or on the size
of the thumbnail payload. This will be done in a separate issue. I have heard
the ideal solution may be to split messages into smaller chunks of ~125 KiB
because of libp2p, but that might be too complicated at this stage of the
product (?).
- Link preview deletion.
- For the moment, OpenGraph metadata is extracted by requesting data for the
English language (and fallback to whatever is available). In the future, we'll
want to unfurl by respecting the user's local device language. Some websites,
like GoDaddy, are already localized based on the device's IP, but many aren't.
- The website's description text should be limited by a certain number of
characters, especially because it's outside our control. Exactly how much has
not been decided yet, so it'll be done separately.
- URL normalization can be tricky, so I implemented only the basics to help with
caching. For example, the url https://status.im and HTTPS://status.im are
considered identical. Also, a URL is considered valid for unfurling if its TLD
exists according to publicsuffix.EffectiveTLDPlusOne. This was essential,
otherwise the default Go url.Parse approach would consider many invalid URLs
valid, and thus the server would waste resources trying to unfurl the
unfurleable.
### Other requirements
- If the message is edited, the link previews should reflect the edited text,
not the original one. This has been aligned with the design team as well.
- If the website's thumbnail or the favicon can't be fetched, just ignore them.
The only mandatory piece of metadata is the website's title and URL.
- Link previews in clients should be generated in near real-time, that is, as
the user types, previews are updated. In mobile this performs very well, and
it's what other clients like WhatsApp, Telegram, and Facebook do.
### Decisions
- While the user typing in the input field, the client is constantly (debounced)
asking status-go to parse the text and extract normalized URLs and then the
client checks if they're already in its in-memory cache. If they are, no RPC
call is made. I chose this approach to achieve the best possible performance
in mobile and avoid the whole RPC overhead, since the chat experience is
already not smooth enough. The mobile client uses URLs as cache keys in a
hashmap, i.e. if the key is present, it means the preview is readily available
(naive, but good enough for now). This decision also gave me more flexibility
to find the best UX at this stage of the feature.
- Due to the requirement that users should be able to see independent loading
indicators for each link preview, when status-go can't unfurl a URL, it
doesn't return it in the response.
- As an initial implementation, I added the BLOB column unfurled_links to the
user_messages table. The preview data is then serialized as JSON before being
stored in this column. I felt that creating a separate table and the related
code for this initial PR would be inconvenient. Is that reasonable to you?
Once things stabilize I can create a proper table if we want to avoid this
kind of solution with serialized columns.
2023-05-18 18:43:06 +00:00
|
|
|
Text: "some-text",
|
|
|
|
UnfurledLinks: []*protobuf.UnfurledLink{
|
|
|
|
{
|
2023-08-21 16:48:07 +00:00
|
|
|
Type: protobuf.UnfurledLink_LINK,
|
URL unfurling (initial implementation) (#3471)
This is the initial implementation for the new URL unfurling requirements. The
most important one is that only the message sender will pay the privacy cost for
unfurling and extracting metadata from websites. Once the message is sent, the
unfurled data will be stored at the protocol level and receivers will just
profit and happily decode the metadata to render it.
Further development of this URL unfurling capability will be mostly guided by
issues created on clients. For the moment in status-mobile:
https://github.com/status-im/status-mobile/labels/url-preview
- https://github.com/status-im/status-mobile/issues/15918
- https://github.com/status-im/status-mobile/issues/15917
- https://github.com/status-im/status-mobile/issues/15910
- https://github.com/status-im/status-mobile/issues/15909
- https://github.com/status-im/status-mobile/issues/15908
- https://github.com/status-im/status-mobile/issues/15906
- https://github.com/status-im/status-mobile/issues/15905
### Terminology
In the code, I've tried to stick to the word "unfurl URL" to really mean the
process of extracting metadata from a website, sort of lower level. I use "link
preview" to mean a higher level structure which is enriched by unfurled data.
"link preview" is also how designers refer to it.
### User flows
1. Carol needs to see link previews while typing in the chat input field. Notice
from the diagram nothing is persisted and that status-go endpoints are
essentially stateless.
```
#+begin_src plantuml :results verbatim
Client->>Server: Call wakuext_getTextURLs
Server-->>Client: Normalized URLs
Client->>Client: Render cached unfurled URLs
Client->>Server: Unfurl non-cached URLs.\nCall wakuext_unfurlURLs
Server->>Website: Fetch metadata
Website-->>Server: Metadata (thumbnail URL, title, etc)
Server->>Website: Fetch thumbnail
Server->>Website: Fetch favicon
Website-->>Server: Favicon bytes
Website-->>Server: Thumbnail bytes
Server->>Server: Decode & process images
Server-->>Client: Unfurled data (thumbnail data URI, etc)
#+end_src
```
```
,------. ,------. ,-------.
|Client| |Server| |Website|
`--+---' `--+---' `---+---'
| Call wakuext_getTextURLs | |
| ---------------------------------------> |
| | |
| Normalized URLs | |
| <- - - - - - - - - - - - - - - - - - - - |
| | |
|----. | |
| | Render cached unfurled URLs | |
|<---' | |
| | |
| Unfurl non-cached URLs. | |
| Call wakuext_unfurlURLs | |
| ---------------------------------------> |
| | |
| | Fetch metadata |
| | ------------------------------------>
| | |
| | Metadata (thumbnail URL, title, etc)|
| | <- - - - - - - - - - - - - - - - - -
| | |
| | Fetch thumbnail |
| | ------------------------------------>
| | |
| | Fetch favicon |
| | ------------------------------------>
| | |
| | Favicon bytes |
| | <- - - - - - - - - - - - - - - - - -
| | |
| | Thumbnail bytes |
| | <- - - - - - - - - - - - - - - - - -
| | |
| |----. |
| | | Decode & process images |
| |<---' |
| | |
| Unfurled data (thumbnail data URI, etc)| |
| <- - - - - - - - - - - - - - - - - - - - |
,--+---. ,--+---. ,---+---.
|Client| |Server| |Website|
`------' `------' `-------'
```
2. Carol sends the text message with link previews in the RPC request
wakuext_sendChatMessages. status-go assumes the link previews are good
because it can't and shouldn't attempt to re-unfurl them.
```
#+begin_src plantuml :results verbatim
Client->>Server: Call wakuext_sendChatMessages
Server->>Server: Transform link previews to\nbe proto-marshalled
Server->DB: Write link previews serialized as JSON
Server-->>Client: Updated message response
#+end_src
```
```
,------. ,------. ,--.
|Client| |Server| |DB|
`--+---' `--+---' `+-'
| Call wakuext_sendChatMessages| |
| -----------------------------> |
| | |
| |----. |
| | | Transform link previews to |
| |<---' be proto-marshalled |
| | |
| | |
| | Write link previews serialized as JSON|
| | -------------------------------------->
| | |
| Updated message response | |
| <- - - - - - - - - - - - - - - |
,--+---. ,--+---. ,+-.
|Client| |Server| |DB|
`------' `------' `--'
```
3. The message was sent over waku and persisted locally in Carol's device. She
should now see the link previews in the chat history. There can be many link
previews shared by other chat members, therefore it is important to serve the
assets via the media server to avoid overloading the ReactNative bridge with
lots of big JSON payloads containing base64 encoded data URIs (maybe this
concern is meaningless for desktop). When a client is rendering messages with
link previews, they will have the field linkPreviews, and the thumbnail URL
will point to the local media server.
```
#+begin_src plantuml :results verbatim
Client->>Server: GET /link-preview/thumbnail (media server)
Server->>DB: Read from user_messages.unfurled_links
Server->Server: Unmarshal JSON
Server-->>Client: HTTP Content-Type: image/jpeg/etc
#+end_src
```
```
,------. ,------. ,--.
|Client| |Server| |DB|
`--+---' `--+---' `+-'
| GET /link-preview/thumbnail (media server)| |
| ------------------------------------------> |
| | |
| | Read from user_messages.unfurled_links|
| | -------------------------------------->
| | |
| |----. |
| | | Unmarshal JSON |
| |<---' |
| | |
| HTTP Content-Type: image/jpeg/etc | |
| <- - - - - - - - - - - - - - - - - - - - - |
,--+---. ,--+---. ,+-.
|Client| |Server| |DB|
`------' `------' `--'
```
### Some limitations of the current implementation
The following points will become separate issues in status-go that I'll work on
over the next couple weeks. In no order of importance:
- Improve how multiple links are fetched; retries on failure and testing how
unfurling behaves around the timeout limits (deterministically, not by making
real HTTP calls as I did). https://github.com/status-im/status-go/issues/3498
- Unfurl favicons and store them in the protobuf too.
- For this PR, I added unfurling support only for websites with OpenGraph
https://ogp.me/ meta tags. Other unfurlers will be implemented on demand. The
next one will probably be for oEmbed https://oembed.com/, the protocol
supported by YouTube, for example.
- Resize and/or compress thumbnails (and favicons). Often times, thumbnails are
huge for the purposes of link previews. There is already support for
compressing JPEGs in status-go, but I prefer to work with compression in a
separate PR because I'd like to also solve the problem for PNGs (probably
convert them to JPEGs, plus compress them). This would be a safe choice for
thumbnails, favicons not so much because transparency is desirable.
- Editing messages is not yet supported.
- I haven't coded any artificial limit on the number of previews or on the size
of the thumbnail payload. This will be done in a separate issue. I have heard
the ideal solution may be to split messages into smaller chunks of ~125 KiB
because of libp2p, but that might be too complicated at this stage of the
product (?).
- Link preview deletion.
- For the moment, OpenGraph metadata is extracted by requesting data for the
English language (and fallback to whatever is available). In the future, we'll
want to unfurl by respecting the user's local device language. Some websites,
like GoDaddy, are already localized based on the device's IP, but many aren't.
- The website's description text should be limited by a certain number of
characters, especially because it's outside our control. Exactly how much has
not been decided yet, so it'll be done separately.
- URL normalization can be tricky, so I implemented only the basics to help with
caching. For example, the url https://status.im and HTTPS://status.im are
considered identical. Also, a URL is considered valid for unfurling if its TLD
exists according to publicsuffix.EffectiveTLDPlusOne. This was essential,
otherwise the default Go url.Parse approach would consider many invalid URLs
valid, and thus the server would waste resources trying to unfurl the
unfurleable.
### Other requirements
- If the message is edited, the link previews should reflect the edited text,
not the original one. This has been aligned with the design team as well.
- If the website's thumbnail or the favicon can't be fetched, just ignore them.
The only mandatory piece of metadata is the website's title and URL.
- Link previews in clients should be generated in near real-time, that is, as
the user types, previews are updated. In mobile this performs very well, and
it's what other clients like WhatsApp, Telegram, and Facebook do.
### Decisions
- While the user typing in the input field, the client is constantly (debounced)
asking status-go to parse the text and extract normalized URLs and then the
client checks if they're already in its in-memory cache. If they are, no RPC
call is made. I chose this approach to achieve the best possible performance
in mobile and avoid the whole RPC overhead, since the chat experience is
already not smooth enough. The mobile client uses URLs as cache keys in a
hashmap, i.e. if the key is present, it means the preview is readily available
(naive, but good enough for now). This decision also gave me more flexibility
to find the best UX at this stage of the feature.
- Due to the requirement that users should be able to see independent loading
indicators for each link preview, when status-go can't unfurl a URL, it
doesn't return it in the response.
- As an initial implementation, I added the BLOB column unfurled_links to the
user_messages table. The preview data is then serialized as JSON before being
stored in this column. I felt that creating a separate table and the related
code for this initial PR would be inconvenient. Is that reasonable to you?
Once things stabilize I can create a proper table if we want to avoid this
kind of solution with serialized columns.
2023-05-18 18:43:06 +00:00
|
|
|
Url: "https://github.com",
|
|
|
|
Title: "Build software better, together",
|
|
|
|
Description: "GitHub is where people build software.",
|
|
|
|
ThumbnailPayload: []byte("abc"),
|
|
|
|
},
|
|
|
|
{
|
2023-08-21 16:48:07 +00:00
|
|
|
Type: protobuf.UnfurledLink_LINK,
|
URL unfurling (initial implementation) (#3471)
This is the initial implementation for the new URL unfurling requirements. The
most important one is that only the message sender will pay the privacy cost for
unfurling and extracting metadata from websites. Once the message is sent, the
unfurled data will be stored at the protocol level and receivers will just
profit and happily decode the metadata to render it.
Further development of this URL unfurling capability will be mostly guided by
issues created on clients. For the moment in status-mobile:
https://github.com/status-im/status-mobile/labels/url-preview
- https://github.com/status-im/status-mobile/issues/15918
- https://github.com/status-im/status-mobile/issues/15917
- https://github.com/status-im/status-mobile/issues/15910
- https://github.com/status-im/status-mobile/issues/15909
- https://github.com/status-im/status-mobile/issues/15908
- https://github.com/status-im/status-mobile/issues/15906
- https://github.com/status-im/status-mobile/issues/15905
### Terminology
In the code, I've tried to stick to the word "unfurl URL" to really mean the
process of extracting metadata from a website, sort of lower level. I use "link
preview" to mean a higher level structure which is enriched by unfurled data.
"link preview" is also how designers refer to it.
### User flows
1. Carol needs to see link previews while typing in the chat input field. Notice
from the diagram nothing is persisted and that status-go endpoints are
essentially stateless.
```
#+begin_src plantuml :results verbatim
Client->>Server: Call wakuext_getTextURLs
Server-->>Client: Normalized URLs
Client->>Client: Render cached unfurled URLs
Client->>Server: Unfurl non-cached URLs.\nCall wakuext_unfurlURLs
Server->>Website: Fetch metadata
Website-->>Server: Metadata (thumbnail URL, title, etc)
Server->>Website: Fetch thumbnail
Server->>Website: Fetch favicon
Website-->>Server: Favicon bytes
Website-->>Server: Thumbnail bytes
Server->>Server: Decode & process images
Server-->>Client: Unfurled data (thumbnail data URI, etc)
#+end_src
```
```
,------. ,------. ,-------.
|Client| |Server| |Website|
`--+---' `--+---' `---+---'
| Call wakuext_getTextURLs | |
| ---------------------------------------> |
| | |
| Normalized URLs | |
| <- - - - - - - - - - - - - - - - - - - - |
| | |
|----. | |
| | Render cached unfurled URLs | |
|<---' | |
| | |
| Unfurl non-cached URLs. | |
| Call wakuext_unfurlURLs | |
| ---------------------------------------> |
| | |
| | Fetch metadata |
| | ------------------------------------>
| | |
| | Metadata (thumbnail URL, title, etc)|
| | <- - - - - - - - - - - - - - - - - -
| | |
| | Fetch thumbnail |
| | ------------------------------------>
| | |
| | Fetch favicon |
| | ------------------------------------>
| | |
| | Favicon bytes |
| | <- - - - - - - - - - - - - - - - - -
| | |
| | Thumbnail bytes |
| | <- - - - - - - - - - - - - - - - - -
| | |
| |----. |
| | | Decode & process images |
| |<---' |
| | |
| Unfurled data (thumbnail data URI, etc)| |
| <- - - - - - - - - - - - - - - - - - - - |
,--+---. ,--+---. ,---+---.
|Client| |Server| |Website|
`------' `------' `-------'
```
2. Carol sends the text message with link previews in the RPC request
wakuext_sendChatMessages. status-go assumes the link previews are good
because it can't and shouldn't attempt to re-unfurl them.
```
#+begin_src plantuml :results verbatim
Client->>Server: Call wakuext_sendChatMessages
Server->>Server: Transform link previews to\nbe proto-marshalled
Server->DB: Write link previews serialized as JSON
Server-->>Client: Updated message response
#+end_src
```
```
,------. ,------. ,--.
|Client| |Server| |DB|
`--+---' `--+---' `+-'
| Call wakuext_sendChatMessages| |
| -----------------------------> |
| | |
| |----. |
| | | Transform link previews to |
| |<---' be proto-marshalled |
| | |
| | |
| | Write link previews serialized as JSON|
| | -------------------------------------->
| | |
| Updated message response | |
| <- - - - - - - - - - - - - - - |
,--+---. ,--+---. ,+-.
|Client| |Server| |DB|
`------' `------' `--'
```
3. The message was sent over waku and persisted locally in Carol's device. She
should now see the link previews in the chat history. There can be many link
previews shared by other chat members, therefore it is important to serve the
assets via the media server to avoid overloading the ReactNative bridge with
lots of big JSON payloads containing base64 encoded data URIs (maybe this
concern is meaningless for desktop). When a client is rendering messages with
link previews, they will have the field linkPreviews, and the thumbnail URL
will point to the local media server.
```
#+begin_src plantuml :results verbatim
Client->>Server: GET /link-preview/thumbnail (media server)
Server->>DB: Read from user_messages.unfurled_links
Server->Server: Unmarshal JSON
Server-->>Client: HTTP Content-Type: image/jpeg/etc
#+end_src
```
```
,------. ,------. ,--.
|Client| |Server| |DB|
`--+---' `--+---' `+-'
| GET /link-preview/thumbnail (media server)| |
| ------------------------------------------> |
| | |
| | Read from user_messages.unfurled_links|
| | -------------------------------------->
| | |
| |----. |
| | | Unmarshal JSON |
| |<---' |
| | |
| HTTP Content-Type: image/jpeg/etc | |
| <- - - - - - - - - - - - - - - - - - - - - |
,--+---. ,--+---. ,+-.
|Client| |Server| |DB|
`------' `------' `--'
```
### Some limitations of the current implementation
The following points will become separate issues in status-go that I'll work on
over the next couple weeks. In no order of importance:
- Improve how multiple links are fetched; retries on failure and testing how
unfurling behaves around the timeout limits (deterministically, not by making
real HTTP calls as I did). https://github.com/status-im/status-go/issues/3498
- Unfurl favicons and store them in the protobuf too.
- For this PR, I added unfurling support only for websites with OpenGraph
https://ogp.me/ meta tags. Other unfurlers will be implemented on demand. The
next one will probably be for oEmbed https://oembed.com/, the protocol
supported by YouTube, for example.
- Resize and/or compress thumbnails (and favicons). Often times, thumbnails are
huge for the purposes of link previews. There is already support for
compressing JPEGs in status-go, but I prefer to work with compression in a
separate PR because I'd like to also solve the problem for PNGs (probably
convert them to JPEGs, plus compress them). This would be a safe choice for
thumbnails, favicons not so much because transparency is desirable.
- Editing messages is not yet supported.
- I haven't coded any artificial limit on the number of previews or on the size
of the thumbnail payload. This will be done in a separate issue. I have heard
the ideal solution may be to split messages into smaller chunks of ~125 KiB
because of libp2p, but that might be too complicated at this stage of the
product (?).
- Link preview deletion.
- For the moment, OpenGraph metadata is extracted by requesting data for the
English language (and fallback to whatever is available). In the future, we'll
want to unfurl by respecting the user's local device language. Some websites,
like GoDaddy, are already localized based on the device's IP, but many aren't.
- The website's description text should be limited by a certain number of
characters, especially because it's outside our control. Exactly how much has
not been decided yet, so it'll be done separately.
- URL normalization can be tricky, so I implemented only the basics to help with
caching. For example, the url https://status.im and HTTPS://status.im are
considered identical. Also, a URL is considered valid for unfurling if its TLD
exists according to publicsuffix.EffectiveTLDPlusOne. This was essential,
otherwise the default Go url.Parse approach would consider many invalid URLs
valid, and thus the server would waste resources trying to unfurl the
unfurleable.
### Other requirements
- If the message is edited, the link previews should reflect the edited text,
not the original one. This has been aligned with the design team as well.
- If the website's thumbnail or the favicon can't be fetched, just ignore them.
The only mandatory piece of metadata is the website's title and URL.
- Link previews in clients should be generated in near real-time, that is, as
the user types, previews are updated. In mobile this performs very well, and
it's what other clients like WhatsApp, Telegram, and Facebook do.
### Decisions
- While the user typing in the input field, the client is constantly (debounced)
asking status-go to parse the text and extract normalized URLs and then the
client checks if they're already in its in-memory cache. If they are, no RPC
call is made. I chose this approach to achieve the best possible performance
in mobile and avoid the whole RPC overhead, since the chat experience is
already not smooth enough. The mobile client uses URLs as cache keys in a
hashmap, i.e. if the key is present, it means the preview is readily available
(naive, but good enough for now). This decision also gave me more flexibility
to find the best UX at this stage of the feature.
- Due to the requirement that users should be able to see independent loading
indicators for each link preview, when status-go can't unfurl a URL, it
doesn't return it in the response.
- As an initial implementation, I added the BLOB column unfurled_links to the
user_messages table. The preview data is then serialized as JSON before being
stored in this column. I felt that creating a separate table and the related
code for this initial PR would be inconvenient. Is that reasonable to you?
Once things stabilize I can create a proper table if we want to avoid this
kind of solution with serialized columns.
2023-05-18 18:43:06 +00:00
|
|
|
Url: "https://www.youtube.com/watch?v=mzOyYtfXkb0",
|
|
|
|
Title: "Status Town Hall #67 - 12 October 2020",
|
|
|
|
Description: "",
|
|
|
|
ThumbnailPayload: []byte("def"),
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
}
|
2020-10-27 17:35:28 +00:00
|
|
|
|
URL unfurling (initial implementation) (#3471)
This is the initial implementation for the new URL unfurling requirements. The
most important one is that only the message sender will pay the privacy cost for
unfurling and extracting metadata from websites. Once the message is sent, the
unfurled data will be stored at the protocol level and receivers will just
profit and happily decode the metadata to render it.
Further development of this URL unfurling capability will be mostly guided by
issues created on clients. For the moment in status-mobile:
https://github.com/status-im/status-mobile/labels/url-preview
- https://github.com/status-im/status-mobile/issues/15918
- https://github.com/status-im/status-mobile/issues/15917
- https://github.com/status-im/status-mobile/issues/15910
- https://github.com/status-im/status-mobile/issues/15909
- https://github.com/status-im/status-mobile/issues/15908
- https://github.com/status-im/status-mobile/issues/15906
- https://github.com/status-im/status-mobile/issues/15905
### Terminology
In the code, I've tried to stick to the word "unfurl URL" to really mean the
process of extracting metadata from a website, sort of lower level. I use "link
preview" to mean a higher level structure which is enriched by unfurled data.
"link preview" is also how designers refer to it.
### User flows
1. Carol needs to see link previews while typing in the chat input field. Notice
from the diagram nothing is persisted and that status-go endpoints are
essentially stateless.
```
#+begin_src plantuml :results verbatim
Client->>Server: Call wakuext_getTextURLs
Server-->>Client: Normalized URLs
Client->>Client: Render cached unfurled URLs
Client->>Server: Unfurl non-cached URLs.\nCall wakuext_unfurlURLs
Server->>Website: Fetch metadata
Website-->>Server: Metadata (thumbnail URL, title, etc)
Server->>Website: Fetch thumbnail
Server->>Website: Fetch favicon
Website-->>Server: Favicon bytes
Website-->>Server: Thumbnail bytes
Server->>Server: Decode & process images
Server-->>Client: Unfurled data (thumbnail data URI, etc)
#+end_src
```
```
,------. ,------. ,-------.
|Client| |Server| |Website|
`--+---' `--+---' `---+---'
| Call wakuext_getTextURLs | |
| ---------------------------------------> |
| | |
| Normalized URLs | |
| <- - - - - - - - - - - - - - - - - - - - |
| | |
|----. | |
| | Render cached unfurled URLs | |
|<---' | |
| | |
| Unfurl non-cached URLs. | |
| Call wakuext_unfurlURLs | |
| ---------------------------------------> |
| | |
| | Fetch metadata |
| | ------------------------------------>
| | |
| | Metadata (thumbnail URL, title, etc)|
| | <- - - - - - - - - - - - - - - - - -
| | |
| | Fetch thumbnail |
| | ------------------------------------>
| | |
| | Fetch favicon |
| | ------------------------------------>
| | |
| | Favicon bytes |
| | <- - - - - - - - - - - - - - - - - -
| | |
| | Thumbnail bytes |
| | <- - - - - - - - - - - - - - - - - -
| | |
| |----. |
| | | Decode & process images |
| |<---' |
| | |
| Unfurled data (thumbnail data URI, etc)| |
| <- - - - - - - - - - - - - - - - - - - - |
,--+---. ,--+---. ,---+---.
|Client| |Server| |Website|
`------' `------' `-------'
```
2. Carol sends the text message with link previews in the RPC request
wakuext_sendChatMessages. status-go assumes the link previews are good
because it can't and shouldn't attempt to re-unfurl them.
```
#+begin_src plantuml :results verbatim
Client->>Server: Call wakuext_sendChatMessages
Server->>Server: Transform link previews to\nbe proto-marshalled
Server->DB: Write link previews serialized as JSON
Server-->>Client: Updated message response
#+end_src
```
```
,------. ,------. ,--.
|Client| |Server| |DB|
`--+---' `--+---' `+-'
| Call wakuext_sendChatMessages| |
| -----------------------------> |
| | |
| |----. |
| | | Transform link previews to |
| |<---' be proto-marshalled |
| | |
| | |
| | Write link previews serialized as JSON|
| | -------------------------------------->
| | |
| Updated message response | |
| <- - - - - - - - - - - - - - - |
,--+---. ,--+---. ,+-.
|Client| |Server| |DB|
`------' `------' `--'
```
3. The message was sent over waku and persisted locally in Carol's device. She
should now see the link previews in the chat history. There can be many link
previews shared by other chat members, therefore it is important to serve the
assets via the media server to avoid overloading the ReactNative bridge with
lots of big JSON payloads containing base64 encoded data URIs (maybe this
concern is meaningless for desktop). When a client is rendering messages with
link previews, they will have the field linkPreviews, and the thumbnail URL
will point to the local media server.
```
#+begin_src plantuml :results verbatim
Client->>Server: GET /link-preview/thumbnail (media server)
Server->>DB: Read from user_messages.unfurled_links
Server->Server: Unmarshal JSON
Server-->>Client: HTTP Content-Type: image/jpeg/etc
#+end_src
```
```
,------. ,------. ,--.
|Client| |Server| |DB|
`--+---' `--+---' `+-'
| GET /link-preview/thumbnail (media server)| |
| ------------------------------------------> |
| | |
| | Read from user_messages.unfurled_links|
| | -------------------------------------->
| | |
| |----. |
| | | Unmarshal JSON |
| |<---' |
| | |
| HTTP Content-Type: image/jpeg/etc | |
| <- - - - - - - - - - - - - - - - - - - - - |
,--+---. ,--+---. ,+-.
|Client| |Server| |DB|
`------' `------' `--'
```
### Some limitations of the current implementation
The following points will become separate issues in status-go that I'll work on
over the next couple weeks. In no order of importance:
- Improve how multiple links are fetched; retries on failure and testing how
unfurling behaves around the timeout limits (deterministically, not by making
real HTTP calls as I did). https://github.com/status-im/status-go/issues/3498
- Unfurl favicons and store them in the protobuf too.
- For this PR, I added unfurling support only for websites with OpenGraph
https://ogp.me/ meta tags. Other unfurlers will be implemented on demand. The
next one will probably be for oEmbed https://oembed.com/, the protocol
supported by YouTube, for example.
- Resize and/or compress thumbnails (and favicons). Often times, thumbnails are
huge for the purposes of link previews. There is already support for
compressing JPEGs in status-go, but I prefer to work with compression in a
separate PR because I'd like to also solve the problem for PNGs (probably
convert them to JPEGs, plus compress them). This would be a safe choice for
thumbnails, favicons not so much because transparency is desirable.
- Editing messages is not yet supported.
- I haven't coded any artificial limit on the number of previews or on the size
of the thumbnail payload. This will be done in a separate issue. I have heard
the ideal solution may be to split messages into smaller chunks of ~125 KiB
because of libp2p, but that might be too complicated at this stage of the
product (?).
- Link preview deletion.
- For the moment, OpenGraph metadata is extracted by requesting data for the
English language (and fallback to whatever is available). In the future, we'll
want to unfurl by respecting the user's local device language. Some websites,
like GoDaddy, are already localized based on the device's IP, but many aren't.
- The website's description text should be limited by a certain number of
characters, especially because it's outside our control. Exactly how much has
not been decided yet, so it'll be done separately.
- URL normalization can be tricky, so I implemented only the basics to help with
caching. For example, the url https://status.im and HTTPS://status.im are
considered identical. Also, a URL is considered valid for unfurling if its TLD
exists according to publicsuffix.EffectiveTLDPlusOne. This was essential,
otherwise the default Go url.Parse approach would consider many invalid URLs
valid, and thus the server would waste resources trying to unfurl the
unfurleable.
### Other requirements
- If the message is edited, the link previews should reflect the edited text,
not the original one. This has been aligned with the design team as well.
- If the website's thumbnail or the favicon can't be fetched, just ignore them.
The only mandatory piece of metadata is the website's title and URL.
- Link previews in clients should be generated in near real-time, that is, as
the user types, previews are updated. In mobile this performs very well, and
it's what other clients like WhatsApp, Telegram, and Facebook do.
### Decisions
- While the user typing in the input field, the client is constantly (debounced)
asking status-go to parse the text and extract normalized URLs and then the
client checks if they're already in its in-memory cache. If they are, no RPC
call is made. I chose this approach to achieve the best possible performance
in mobile and avoid the whole RPC overhead, since the chat experience is
already not smooth enough. The mobile client uses URLs as cache keys in a
hashmap, i.e. if the key is present, it means the preview is readily available
(naive, but good enough for now). This decision also gave me more flexibility
to find the best UX at this stage of the feature.
- Due to the requirement that users should be able to see independent loading
indicators for each link preview, when status-go can't unfurl a URL, it
doesn't return it in the response.
- As an initial implementation, I added the BLOB column unfurled_links to the
user_messages table. The preview data is then serialized as JSON before being
stored in this column. I felt that creating a separate table and the related
code for this initial PR would be inconvenient. Is that reasonable to you?
Once things stabilize I can create a proper table if we want to avoid this
kind of solution with serialized columns.
2023-05-18 18:43:06 +00:00
|
|
|
err = p.SaveMessages([]*common.Message{&message})
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
mgs, _, err := p.MessageByChatID(chatID, "", 10)
|
|
|
|
require.NoError(t, err)
|
|
|
|
require.Len(t, mgs, 1)
|
|
|
|
require.Len(t, mgs[0].UnfurledLinks, 2)
|
|
|
|
require.Equal(t, mgs[0].UnfurledLinks, message.UnfurledLinks)
|
2020-10-27 17:35:28 +00:00
|
|
|
}
|
2020-12-07 15:13:39 +00:00
|
|
|
|
|
|
|
func TestHideMessage(t *testing.T) {
|
|
|
|
db, err := openTestDB()
|
|
|
|
require.NoError(t, err)
|
2022-03-28 10:10:40 +00:00
|
|
|
p := newSQLitePersistence(db)
|
2020-12-07 15:13:39 +00:00
|
|
|
chatID := testPublicChatID
|
|
|
|
message := &common.Message{
|
|
|
|
ID: "id-1",
|
|
|
|
LocalChatID: chatID,
|
2023-08-18 11:39:59 +00:00
|
|
|
ChatMessage: &protobuf.ChatMessage{
|
2020-12-07 15:13:39 +00:00
|
|
|
Text: "content-1",
|
|
|
|
Clock: uint64(1),
|
|
|
|
},
|
|
|
|
From: "1",
|
|
|
|
}
|
|
|
|
|
|
|
|
messages := []*common.Message{message}
|
|
|
|
|
|
|
|
err = p.SaveMessages(messages)
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
err = p.HideMessage(message.ID)
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
var actualHidden, actualSeen bool
|
|
|
|
err = p.db.QueryRow("SELECT hide, seen FROM user_messages WHERE id = ?", message.ID).Scan(&actualHidden, &actualSeen)
|
|
|
|
|
|
|
|
require.NoError(t, err)
|
|
|
|
require.True(t, actualHidden)
|
|
|
|
require.True(t, actualSeen)
|
|
|
|
}
|
2020-12-22 10:49:25 +00:00
|
|
|
|
|
|
|
func TestDeactivatePublicChat(t *testing.T) {
|
|
|
|
db, err := openTestDB()
|
|
|
|
require.NoError(t, err)
|
2022-03-28 10:10:40 +00:00
|
|
|
p := newSQLitePersistence(db)
|
2020-12-22 10:49:25 +00:00
|
|
|
publicChatID := "public-chat-id"
|
|
|
|
var currentClockValue uint64 = 10
|
|
|
|
|
|
|
|
timesource := &testTimeSource{}
|
|
|
|
lastMessage := common.Message{
|
|
|
|
ID: "0x01",
|
|
|
|
LocalChatID: publicChatID,
|
2023-08-18 11:39:59 +00:00
|
|
|
ChatMessage: &protobuf.ChatMessage{Text: "some-text"},
|
2023-01-20 18:51:36 +00:00
|
|
|
From: testPK,
|
2020-12-22 10:49:25 +00:00
|
|
|
}
|
|
|
|
lastMessage.Clock = 20
|
|
|
|
|
|
|
|
require.NoError(t, p.SaveMessages([]*common.Message{&lastMessage}))
|
|
|
|
|
|
|
|
publicChat := CreatePublicChat(publicChatID, timesource)
|
|
|
|
publicChat.LastMessage = &lastMessage
|
|
|
|
publicChat.UnviewedMessagesCount = 1
|
|
|
|
|
2022-12-07 19:34:48 +00:00
|
|
|
err = p.DeactivateChat(publicChat, currentClockValue, true)
|
2020-12-22 10:49:25 +00:00
|
|
|
|
|
|
|
// It does not set deleted at for a public chat
|
|
|
|
require.NoError(t, err)
|
|
|
|
require.Equal(t, uint64(0), publicChat.DeletedAtClockValue)
|
|
|
|
|
|
|
|
// It sets the lastMessage to nil
|
|
|
|
require.Nil(t, publicChat.LastMessage)
|
|
|
|
|
|
|
|
// It sets unviewed messages count
|
|
|
|
require.Equal(t, uint(0), publicChat.UnviewedMessagesCount)
|
|
|
|
|
|
|
|
// It sets active as false
|
|
|
|
require.False(t, publicChat.Active)
|
|
|
|
|
|
|
|
// It deletes messages
|
|
|
|
messages, _, err := p.MessageByChatID(publicChatID, "", 10)
|
|
|
|
require.NoError(t, err)
|
|
|
|
require.Len(t, messages, 0)
|
|
|
|
|
|
|
|
// Reload chat to make sure it has been save
|
|
|
|
dbChat, err := p.Chat(publicChatID)
|
|
|
|
|
|
|
|
require.NoError(t, err)
|
|
|
|
require.NotNil(t, dbChat)
|
|
|
|
|
|
|
|
// Same checks on the chat pulled from the db
|
|
|
|
// It does not set deleted at for a public chat
|
|
|
|
require.NoError(t, err)
|
|
|
|
require.Equal(t, uint64(0), dbChat.DeletedAtClockValue)
|
|
|
|
|
|
|
|
// It sets the lastMessage to nil
|
|
|
|
require.Nil(t, dbChat.LastMessage)
|
|
|
|
|
|
|
|
// It sets unviewed messages count
|
|
|
|
require.Equal(t, uint(0), dbChat.UnviewedMessagesCount)
|
|
|
|
|
|
|
|
// It sets active as false
|
|
|
|
require.False(t, dbChat.Active)
|
|
|
|
}
|
|
|
|
|
|
|
|
func TestDeactivateOneToOneChat(t *testing.T) {
|
|
|
|
key, err := crypto.GenerateKey()
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
pkString := types.EncodeHex(crypto.FromECDSAPub(&key.PublicKey))
|
|
|
|
|
|
|
|
db, err := openTestDB()
|
|
|
|
require.NoError(t, err)
|
2022-03-28 10:10:40 +00:00
|
|
|
p := newSQLitePersistence(db)
|
2020-12-22 10:49:25 +00:00
|
|
|
var currentClockValue uint64 = 10
|
|
|
|
|
|
|
|
timesource := &testTimeSource{}
|
|
|
|
|
|
|
|
chat := CreateOneToOneChat(pkString, &key.PublicKey, timesource)
|
|
|
|
|
|
|
|
lastMessage := common.Message{
|
|
|
|
ID: "0x01",
|
|
|
|
LocalChatID: chat.ID,
|
2023-08-18 11:39:59 +00:00
|
|
|
ChatMessage: &protobuf.ChatMessage{Text: "some-text"},
|
2023-01-20 18:51:36 +00:00
|
|
|
From: testPK,
|
2020-12-22 10:49:25 +00:00
|
|
|
}
|
|
|
|
lastMessage.Clock = 20
|
|
|
|
|
|
|
|
require.NoError(t, p.SaveMessages([]*common.Message{&lastMessage}))
|
|
|
|
|
|
|
|
chat.LastMessage = &lastMessage
|
|
|
|
chat.UnviewedMessagesCount = 1
|
|
|
|
|
2022-12-07 19:34:48 +00:00
|
|
|
err = p.DeactivateChat(chat, currentClockValue, true)
|
2020-12-22 10:49:25 +00:00
|
|
|
|
|
|
|
// It does set deleted at for a public chat
|
|
|
|
require.NoError(t, err)
|
|
|
|
require.NotEqual(t, uint64(0), chat.DeletedAtClockValue)
|
|
|
|
|
|
|
|
// It sets the lastMessage to nil
|
|
|
|
require.Nil(t, chat.LastMessage)
|
|
|
|
|
|
|
|
// It sets unviewed messages count
|
|
|
|
require.Equal(t, uint(0), chat.UnviewedMessagesCount)
|
|
|
|
|
|
|
|
// It sets active as false
|
|
|
|
require.False(t, chat.Active)
|
|
|
|
|
|
|
|
// It deletes messages
|
|
|
|
messages, _, err := p.MessageByChatID(chat.ID, "", 10)
|
|
|
|
require.NoError(t, err)
|
|
|
|
require.Len(t, messages, 0)
|
|
|
|
|
|
|
|
// Reload chat to make sure it has been save
|
|
|
|
dbChat, err := p.Chat(chat.ID)
|
|
|
|
|
|
|
|
require.NoError(t, err)
|
|
|
|
require.NotNil(t, dbChat)
|
|
|
|
|
|
|
|
// Same checks on the chat pulled from the db
|
|
|
|
// It does set deleted at for a public chat
|
|
|
|
require.NoError(t, err)
|
|
|
|
require.NotEqual(t, uint64(0), dbChat.DeletedAtClockValue)
|
|
|
|
|
|
|
|
// It sets the lastMessage to nil
|
|
|
|
require.Nil(t, dbChat.LastMessage)
|
|
|
|
|
|
|
|
// It sets unviewed messages count
|
|
|
|
require.Equal(t, uint(0), dbChat.UnviewedMessagesCount)
|
|
|
|
|
|
|
|
// It sets active as false
|
|
|
|
require.False(t, dbChat.Active)
|
|
|
|
}
|
2021-03-09 12:48:15 +00:00
|
|
|
|
|
|
|
func TestConfirmations(t *testing.T) {
|
|
|
|
dataSyncID1 := []byte("datsync-id-1")
|
|
|
|
dataSyncID2 := []byte("datsync-id-2")
|
|
|
|
dataSyncID3 := []byte("datsync-id-3")
|
|
|
|
dataSyncID4 := []byte("datsync-id-3")
|
|
|
|
|
|
|
|
messageID1 := []byte("message-id-1")
|
|
|
|
messageID2 := []byte("message-id-2")
|
|
|
|
|
|
|
|
publicKey1 := []byte("pk-1")
|
|
|
|
publicKey2 := []byte("pk-2")
|
|
|
|
publicKey3 := []byte("pk-3")
|
|
|
|
|
|
|
|
db, err := openTestDB()
|
|
|
|
require.NoError(t, err)
|
2022-03-28 10:10:40 +00:00
|
|
|
p := newSQLitePersistence(db)
|
2021-03-09 12:48:15 +00:00
|
|
|
|
|
|
|
confirmation1 := &common.RawMessageConfirmation{
|
|
|
|
DataSyncID: dataSyncID1,
|
|
|
|
MessageID: messageID1,
|
|
|
|
PublicKey: publicKey1,
|
|
|
|
}
|
|
|
|
|
|
|
|
// Same datasyncID and same messageID, different pubkey
|
|
|
|
confirmation2 := &common.RawMessageConfirmation{
|
|
|
|
DataSyncID: dataSyncID2,
|
|
|
|
MessageID: messageID1,
|
|
|
|
PublicKey: publicKey2,
|
|
|
|
}
|
|
|
|
|
|
|
|
// Different datasyncID and same messageID, different pubkey
|
|
|
|
confirmation3 := &common.RawMessageConfirmation{
|
|
|
|
DataSyncID: dataSyncID3,
|
|
|
|
MessageID: messageID1,
|
|
|
|
PublicKey: publicKey3,
|
|
|
|
}
|
|
|
|
|
|
|
|
// Same dataSyncID, different messageID
|
|
|
|
confirmation4 := &common.RawMessageConfirmation{
|
|
|
|
DataSyncID: dataSyncID4,
|
|
|
|
MessageID: messageID2,
|
|
|
|
PublicKey: publicKey1,
|
|
|
|
}
|
|
|
|
|
|
|
|
require.NoError(t, p.InsertPendingConfirmation(confirmation1))
|
|
|
|
require.NoError(t, p.InsertPendingConfirmation(confirmation2))
|
|
|
|
require.NoError(t, p.InsertPendingConfirmation(confirmation3))
|
|
|
|
require.NoError(t, p.InsertPendingConfirmation(confirmation4))
|
|
|
|
|
|
|
|
// We confirm the first datasync message, no confirmations
|
|
|
|
messageID, err := p.MarkAsConfirmed(dataSyncID1, false)
|
|
|
|
require.NoError(t, err)
|
|
|
|
require.Nil(t, messageID)
|
|
|
|
|
|
|
|
// We confirm the second datasync message, no confirmations
|
|
|
|
messageID, err = p.MarkAsConfirmed(dataSyncID2, false)
|
|
|
|
require.NoError(t, err)
|
|
|
|
require.Nil(t, messageID)
|
|
|
|
|
|
|
|
// We confirm the third datasync message, messageID1 should be confirmed
|
|
|
|
messageID, err = p.MarkAsConfirmed(dataSyncID3, false)
|
|
|
|
require.NoError(t, err)
|
|
|
|
require.Equal(t, messageID, types.HexBytes(messageID1))
|
|
|
|
}
|
|
|
|
|
|
|
|
func TestConfirmationsAtLeastOne(t *testing.T) {
|
|
|
|
dataSyncID1 := []byte("datsync-id-1")
|
|
|
|
dataSyncID2 := []byte("datsync-id-2")
|
|
|
|
dataSyncID3 := []byte("datsync-id-3")
|
|
|
|
|
|
|
|
messageID1 := []byte("message-id-1")
|
|
|
|
|
|
|
|
publicKey1 := []byte("pk-1")
|
|
|
|
publicKey2 := []byte("pk-2")
|
|
|
|
publicKey3 := []byte("pk-3")
|
|
|
|
|
|
|
|
db, err := openTestDB()
|
|
|
|
require.NoError(t, err)
|
2022-03-28 10:10:40 +00:00
|
|
|
p := newSQLitePersistence(db)
|
2021-03-09 12:48:15 +00:00
|
|
|
|
|
|
|
confirmation1 := &common.RawMessageConfirmation{
|
|
|
|
DataSyncID: dataSyncID1,
|
|
|
|
MessageID: messageID1,
|
|
|
|
PublicKey: publicKey1,
|
|
|
|
}
|
|
|
|
|
|
|
|
// Same datasyncID and same messageID, different pubkey
|
|
|
|
confirmation2 := &common.RawMessageConfirmation{
|
|
|
|
DataSyncID: dataSyncID2,
|
|
|
|
MessageID: messageID1,
|
|
|
|
PublicKey: publicKey2,
|
|
|
|
}
|
|
|
|
|
|
|
|
// Different datasyncID and same messageID, different pubkey
|
|
|
|
confirmation3 := &common.RawMessageConfirmation{
|
|
|
|
DataSyncID: dataSyncID3,
|
|
|
|
MessageID: messageID1,
|
|
|
|
PublicKey: publicKey3,
|
|
|
|
}
|
|
|
|
|
|
|
|
require.NoError(t, p.InsertPendingConfirmation(confirmation1))
|
|
|
|
require.NoError(t, p.InsertPendingConfirmation(confirmation2))
|
|
|
|
require.NoError(t, p.InsertPendingConfirmation(confirmation3))
|
|
|
|
|
|
|
|
// We confirm the first datasync message, messageID1 and 3 should be confirmed
|
|
|
|
messageID, err := p.MarkAsConfirmed(dataSyncID1, true)
|
|
|
|
require.NoError(t, err)
|
|
|
|
require.NotNil(t, messageID)
|
|
|
|
require.Equal(t, types.HexBytes(messageID1), messageID)
|
|
|
|
}
|
2021-04-07 12:57:14 +00:00
|
|
|
|
2021-06-01 12:13:17 +00:00
|
|
|
func TestSaveCommunityChat(t *testing.T) {
|
|
|
|
db, err := openTestDB()
|
|
|
|
require.NoError(t, err)
|
2022-03-28 10:10:40 +00:00
|
|
|
p := newSQLitePersistence(db)
|
2021-06-01 12:13:17 +00:00
|
|
|
|
|
|
|
identity := &protobuf.ChatIdentity{
|
2022-09-02 08:36:07 +00:00
|
|
|
DisplayName: "community-chat-name",
|
|
|
|
Description: "community-chat-name-description",
|
|
|
|
FirstMessageTimestamp: 1,
|
2021-06-01 12:13:17 +00:00
|
|
|
}
|
|
|
|
permissions := &protobuf.CommunityPermissions{
|
|
|
|
Access: protobuf.CommunityPermissions_NO_MEMBERSHIP,
|
|
|
|
}
|
|
|
|
|
|
|
|
communityChat := &protobuf.CommunityChat{
|
|
|
|
Identity: identity,
|
|
|
|
Permissions: permissions,
|
|
|
|
}
|
|
|
|
|
|
|
|
chat := CreateCommunityChat("test-or-gid", "test-chat-id", communityChat, &testTimeSource{})
|
2023-08-18 11:39:59 +00:00
|
|
|
chat.LastMessage = common.NewMessage()
|
2021-06-01 12:13:17 +00:00
|
|
|
err = p.SaveChat(*chat)
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
retrievedChat, err := p.Chat(chat.ID)
|
|
|
|
require.NoError(t, err)
|
|
|
|
require.Equal(t, chat, retrievedChat)
|
|
|
|
}
|
2021-12-10 14:34:16 +00:00
|
|
|
|
2022-07-21 19:34:03 +00:00
|
|
|
func TestSaveDiscordMessageAuthor(t *testing.T) {
|
|
|
|
|
|
|
|
db, err := openTestDB()
|
|
|
|
require.NoError(t, err)
|
|
|
|
p := newSQLitePersistence(db)
|
|
|
|
|
2022-09-15 09:05:30 +00:00
|
|
|
testAuthor := &protobuf.DiscordMessageAuthor{
|
|
|
|
Id: "1",
|
|
|
|
Name: "Testuser",
|
|
|
|
Discriminator: "1234",
|
|
|
|
Nickname: "User",
|
|
|
|
AvatarUrl: "http://example.com/profile.jpg",
|
|
|
|
AvatarImagePayload: []byte{1, 2, 3},
|
|
|
|
}
|
|
|
|
|
|
|
|
require.NoError(t, p.SaveDiscordMessageAuthor(testAuthor))
|
2022-07-21 19:34:03 +00:00
|
|
|
|
|
|
|
exists, err := p.HasDiscordMessageAuthor("1")
|
|
|
|
require.NoError(t, err)
|
|
|
|
require.True(t, exists)
|
2022-09-15 09:05:30 +00:00
|
|
|
author, err := p.GetDiscordMessageAuthorByID("1")
|
|
|
|
require.NoError(t, err)
|
|
|
|
require.Equal(t, author.Id, testAuthor.Id)
|
|
|
|
require.Equal(t, author.Name, testAuthor.Name)
|
|
|
|
}
|
|
|
|
|
|
|
|
func TestGetDiscordMessageAuthorImagePayloadByID(t *testing.T) {
|
|
|
|
db, err := openTestDB()
|
|
|
|
require.NoError(t, err)
|
|
|
|
p := newSQLitePersistence(db)
|
|
|
|
|
|
|
|
testAuthor := &protobuf.DiscordMessageAuthor{
|
|
|
|
Id: "1",
|
|
|
|
Name: "Testuser",
|
|
|
|
Discriminator: "1234",
|
|
|
|
Nickname: "User",
|
|
|
|
AvatarUrl: "http://example.com/profile.jpg",
|
|
|
|
AvatarImagePayload: []byte{1, 2, 3},
|
|
|
|
}
|
|
|
|
|
|
|
|
require.NoError(t, p.SaveDiscordMessageAuthor(testAuthor))
|
|
|
|
|
|
|
|
payload, err := p.GetDiscordMessageAuthorImagePayloadByID("1")
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
require.Equal(t, testAuthor.AvatarImagePayload, payload)
|
2022-07-21 19:34:03 +00:00
|
|
|
}
|
2022-08-04 16:16:56 +00:00
|
|
|
|
|
|
|
func TestSaveDiscordMessage(t *testing.T) {
|
|
|
|
|
|
|
|
db, err := openTestDB()
|
|
|
|
require.NoError(t, err)
|
|
|
|
p := newSQLitePersistence(db)
|
|
|
|
|
|
|
|
require.NoError(t, p.SaveDiscordMessage(&protobuf.DiscordMessage{
|
|
|
|
Id: "1",
|
|
|
|
Type: "Default",
|
|
|
|
Timestamp: "123456",
|
|
|
|
Content: "This is the message",
|
|
|
|
Author: &protobuf.DiscordMessageAuthor{
|
|
|
|
Id: "2",
|
|
|
|
},
|
|
|
|
Reference: &protobuf.DiscordMessageReference{},
|
|
|
|
}))
|
|
|
|
|
|
|
|
require.NoError(t, err)
|
|
|
|
}
|
|
|
|
|
|
|
|
func TestSaveDiscordMessages(t *testing.T) {
|
|
|
|
db, err := openTestDB()
|
|
|
|
require.NoError(t, err)
|
|
|
|
p := newSQLitePersistence(db)
|
|
|
|
|
|
|
|
for i := 0; i < 10; i++ {
|
|
|
|
id := strconv.Itoa(i)
|
|
|
|
err := insertMinimalDiscordMessage(p, id, id)
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
m, err := p.MessageByID(id)
|
|
|
|
require.NoError(t, err)
|
|
|
|
dm := m.GetDiscordMessage()
|
|
|
|
require.NotNil(t, dm)
|
|
|
|
require.EqualValues(t, id, dm.Id)
|
2022-08-19 12:30:11 +00:00
|
|
|
require.EqualValues(t, "2", dm.Author.Id)
|
2022-08-04 16:16:56 +00:00
|
|
|
}
|
|
|
|
}
|
2022-09-20 09:14:11 +00:00
|
|
|
|
|
|
|
func TestUpdateDiscordMessageAuthorImage(t *testing.T) {
|
|
|
|
|
|
|
|
db, err := openTestDB()
|
|
|
|
require.NoError(t, err)
|
|
|
|
p := newSQLitePersistence(db)
|
|
|
|
|
|
|
|
require.NoError(t, p.SaveDiscordMessageAuthor(&protobuf.DiscordMessageAuthor{
|
|
|
|
Id: "1",
|
|
|
|
Name: "Testuser",
|
|
|
|
Discriminator: "1234",
|
|
|
|
Nickname: "User",
|
|
|
|
AvatarUrl: "http://example.com/profile.jpg",
|
|
|
|
}))
|
|
|
|
|
|
|
|
exists, err := p.HasDiscordMessageAuthor("1")
|
|
|
|
require.NoError(t, err)
|
|
|
|
require.True(t, exists)
|
|
|
|
|
|
|
|
err = p.UpdateDiscordMessageAuthorImage("1", []byte{0, 1, 2, 3})
|
|
|
|
require.NoError(t, err)
|
|
|
|
payload, err := p.GetDiscordMessageAuthorImagePayloadByID("1")
|
|
|
|
require.NoError(t, err)
|
|
|
|
require.Equal(t, []byte{0, 1, 2, 3}, payload)
|
|
|
|
}
|
2022-09-21 16:05:29 +00:00
|
|
|
|
|
|
|
func TestSaveHashRatchetMessage(t *testing.T) {
|
|
|
|
db, err := openTestDB()
|
|
|
|
require.NoError(t, err)
|
|
|
|
p := newSQLitePersistence(db)
|
|
|
|
|
|
|
|
groupID1 := []byte("group-id-1")
|
|
|
|
groupID2 := []byte("group-id-2")
|
2023-10-12 15:45:23 +00:00
|
|
|
keyID := []byte("key-id")
|
2022-09-21 16:05:29 +00:00
|
|
|
|
|
|
|
message1 := &types.Message{
|
|
|
|
Hash: []byte{1},
|
|
|
|
Sig: []byte{2},
|
|
|
|
TTL: 1,
|
|
|
|
Timestamp: 2,
|
|
|
|
Payload: []byte{3},
|
|
|
|
}
|
|
|
|
|
|
|
|
require.NoError(t, p.SaveHashRatchetMessage(groupID1, keyID, message1))
|
|
|
|
|
|
|
|
message2 := &types.Message{
|
|
|
|
Hash: []byte{2},
|
|
|
|
Sig: []byte{2},
|
|
|
|
TTL: 1,
|
|
|
|
Topic: types.BytesToTopic([]byte{5}),
|
|
|
|
Timestamp: 2,
|
|
|
|
Payload: []byte{3},
|
|
|
|
Dst: []byte{4},
|
|
|
|
P2P: true,
|
|
|
|
}
|
|
|
|
|
|
|
|
require.NoError(t, p.SaveHashRatchetMessage(groupID2, keyID, message2))
|
|
|
|
|
2023-10-12 15:45:23 +00:00
|
|
|
fetchedMessages, err := p.GetHashRatchetMessages(keyID)
|
2022-09-21 16:05:29 +00:00
|
|
|
require.NoError(t, err)
|
|
|
|
require.NotNil(t, fetchedMessages)
|
2023-10-12 15:45:23 +00:00
|
|
|
require.Len(t, fetchedMessages, 2)
|
2022-09-21 16:05:29 +00:00
|
|
|
}
|
2023-03-28 14:40:00 +00:00
|
|
|
|
|
|
|
func TestCountActiveChattersInCommunity(t *testing.T) {
|
|
|
|
db, err := openTestDB()
|
|
|
|
require.NoError(t, err)
|
|
|
|
p := newSQLitePersistence(db)
|
|
|
|
|
|
|
|
channel1 := Chat{
|
|
|
|
ID: "channel1",
|
|
|
|
Name: "channel1",
|
|
|
|
CommunityID: "testCommunity",
|
|
|
|
}
|
|
|
|
|
|
|
|
channel2 := Chat{
|
|
|
|
ID: "channel2",
|
|
|
|
Name: "channel2",
|
|
|
|
CommunityID: "testCommunity",
|
|
|
|
}
|
|
|
|
|
|
|
|
require.NoError(t, p.SaveChat(channel1))
|
|
|
|
require.NoError(t, p.SaveChat(channel2))
|
|
|
|
|
|
|
|
fillChatWithMessages := func(chat *Chat, offset int) {
|
|
|
|
count := 5
|
|
|
|
var messages []*common.Message
|
|
|
|
for i := 0; i < count; i++ {
|
|
|
|
messages = append(messages, &common.Message{
|
|
|
|
ID: fmt.Sprintf("%smsg%d", chat.Name, i),
|
|
|
|
LocalChatID: chat.ID,
|
2023-08-18 11:39:59 +00:00
|
|
|
ChatMessage: &protobuf.ChatMessage{
|
2023-03-28 14:40:00 +00:00
|
|
|
Clock: uint64(i),
|
|
|
|
Timestamp: uint64(i + offset),
|
|
|
|
},
|
|
|
|
From: fmt.Sprintf("user%d", i),
|
|
|
|
})
|
|
|
|
}
|
|
|
|
require.NoError(t, p.SaveMessages(messages))
|
|
|
|
}
|
|
|
|
|
|
|
|
// timestamp/user/msgID
|
|
|
|
// channel1: 0/user0/channel1msg0 1/user1/channel1msg1 2/user2/channel1msg2 3/user3/channel1msg3 4/user4/channel1msg4
|
|
|
|
// channel2: 3/user0/channel2msg0 4/user1/channel2msg1 5/user2/channel2msg2 6/user3/channel2msg3 7/user4/channel2msg4
|
|
|
|
fillChatWithMessages(&channel1, 0)
|
|
|
|
fillChatWithMessages(&channel2, 3)
|
|
|
|
|
|
|
|
checker := func(activeAfterTimestamp int64, expected uint) {
|
|
|
|
result, err := p.CountActiveChattersInCommunity("testCommunity", activeAfterTimestamp)
|
|
|
|
require.NoError(t, err)
|
|
|
|
require.Equal(t, expected, result)
|
|
|
|
}
|
|
|
|
checker(0, 5)
|
|
|
|
checker(3, 5)
|
|
|
|
checker(4, 4)
|
|
|
|
checker(5, 3)
|
|
|
|
checker(6, 2)
|
|
|
|
checker(7, 1)
|
|
|
|
checker(8, 0)
|
|
|
|
}
|