Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/master' into bot
Browse files Browse the repository at this point in the history
# Conflicts:
#	backend/canisters/user_index/CHANGELOG.md
#	backend/canisters/user_index/api/can.did
#	backend/canisters/user_index/api/src/queries/explore_bots.rs
#	backend/canisters/user_index/impl/src/model/user_map.rs
#	backend/libraries/types/src/bots.rs
  • Loading branch information
megrogan committed Nov 29, 2024
2 parents eb5a35c + 066ab88 commit 4ed4f25
Show file tree
Hide file tree
Showing 12 changed files with 254 additions and 5 deletions.
2 changes: 2 additions & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions backend/canisters/community/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
- Consolidate member verification logic into `get_verified_member` ([#6926](https://github.com/open-chat-labs/open-chat/pull/6926))
- Move members to `MembersMap` in prep for stable memory ([#6927](https://github.com/open-chat-labs/open-chat/pull/6927))
- Only handle a single bot action ([#6929](https://github.com/open-chat-labs/open-chat/pull/6929))
- Implement `MembersStableStorage` which stores members in stable memory ([#6931](https://github.com/open-chat-labs/open-chat/pull/6931))

## [[2.0.1479](https://github.com/open-chat-labs/open-chat/releases/tag/v2.0.1479-community)] - 2024-11-28

Expand Down
2 changes: 2 additions & 0 deletions backend/canisters/cycles_dispenser/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

## [unreleased]

## [[2.0.1485](https://github.com/open-chat-labs/open-chat/releases/tag/v2.0.1485-cycles_dispenser)] - 2024-11-29

### Added

- Add an error log with http endpoint ([#6608](https://github.com/open-chat-labs/open-chat/pull/6608))
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,10 @@ fn post_upgrade(args: Args) {
let memory = get_upgrades_memory();
let reader = get_reader(&memory);

let (data, logs, traces): (Data, Vec<LogEntry>, Vec<LogEntry>) = msgpack::deserialize(reader).unwrap();
let (data, errors, logs, traces): (Data, Vec<LogEntry>, Vec<LogEntry>, Vec<LogEntry>) =
msgpack::deserialize(reader).unwrap();

// TODO: After release change this to
// let (data, errors, logs, traces): (Data, Vec<LogEntry>, Vec<LogEntry>, Vec<LogEntry>) = msgpack::deserialize(reader).unwrap();
canister_logger::init_with_logs(data.test_mode, Vec::new(), logs, traces);
canister_logger::init_with_logs(data.test_mode, errors, logs, traces);

let env = init_env(data.rng_seed);
init_state(env, data, args.wasm_version);
Expand Down
1 change: 1 addition & 0 deletions backend/canisters/group/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
- Consolidate member verification logic into `get_verified_member` ([#6926](https://github.com/open-chat-labs/open-chat/pull/6926))
- Move members to `MembersMap` in prep for stable memory ([#6927](https://github.com/open-chat-labs/open-chat/pull/6927))
- Only handle a single bot action ([#6929](https://github.com/open-chat-labs/open-chat/pull/6929))
- Implement `MembersStableStorage` which stores members in stable memory ([#6931](https://github.com/open-chat-labs/open-chat/pull/6931))

## [[2.0.1480](https://github.com/open-chat-labs/open-chat/releases/tag/v2.0.1480-group)] - 2024-11-28

Expand Down
2 changes: 2 additions & 0 deletions backend/canisters/neuron_controller/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

## [unreleased]

## [[2.0.1484](https://github.com/open-chat-labs/open-chat/releases/tag/v2.0.1484-neuron_controller)] - 2024-11-29

### Changed

- Spawn maturity from neurons that are dissolving and can no longer vote ([#6920](https://github.com/open-chat-labs/open-chat/pull/6920))
Expand Down
2 changes: 2 additions & 0 deletions backend/canisters/registry/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

## [unreleased]

## [[2.0.1483](https://github.com/open-chat-labs/open-chat/releases/tag/v2.0.1483-registry)] - 2024-11-29

### Added

- Store airdrop config in the Registry ([#6893](https://github.com/open-chat-labs/open-chat/pull/6893))
Expand Down
1 change: 0 additions & 1 deletion backend/canisters/registry/impl/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,6 @@ struct Data {
message_filters: MessageFilters,
total_supply: Timestamped<u128>,
circulating_supply: Timestamped<u128>,
#[serde(default)]
airdrop_config: Timestamped<Option<AirdropConfig>>,
rng_seed: [u8; 32],
test_mode: bool,
Expand Down
3 changes: 3 additions & 0 deletions backend/libraries/group_chat_core/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,16 @@ event_store_producer = { workspace = true }
group_community_common = { path = "../group_community_common" }
itertools = { workspace = true }
lazy_static = { workspace = true }
msgpack = { path = "../msgpack" }
regex-lite = { workspace = true }
search = { path = "../search" }
serde = { workspace = true }
stable_memory_map = { path = "../stable_memory_map" }
types = { path = "../types" }
utils = { path = "../utils" }

[dev-dependencies]
msgpack = { path = "../msgpack" }
proptest = { workspace = true }
rand = { workspace = true }
test-strategy = { workspace = true }
1 change: 1 addition & 0 deletions backend/libraries/group_chat_core/src/members.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ use utils::timestamped_set::TimestampedSet;

#[cfg(test)]
mod proptests;
mod stable_memory;

const MAX_MEMBERS_PER_GROUP: u32 = 100_000;

Expand Down
228 changes: 228 additions & 0 deletions backend/libraries/group_chat_core/src/members/stable_memory.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,228 @@
use crate::members_map::MembersMap;
use crate::GroupMemberInternal;
use candid::{Deserialize, Principal};
use serde::de::{Error, Visitor};
use serde::{Deserializer, Serialize, Serializer};
use stable_memory_map::{with_map, with_map_mut, KeyType};
use std::fmt::Formatter;
use types::{MultiUserChat, UserId};

#[derive(Serialize, Deserialize)]
pub struct MembersStableStorage {
prefix: KeyPrefix,
}

impl MembersStableStorage {
#[allow(dead_code)]
pub fn new(chat: MultiUserChat, member: GroupMemberInternal) -> Self {
let mut map = MembersStableStorage { prefix: chat.into() };
map.insert(member);
map
}

fn key(&self, user_id: UserId) -> Key {
Key::new(self.prefix, user_id)
}
}

impl MembersMap for MembersStableStorage {
fn get(&self, user_id: &UserId) -> Option<GroupMemberInternal> {
with_map(|m| m.get(&self.key(*user_id).to_vec()).map(bytes_to_member))
}

fn insert(&mut self, member: GroupMemberInternal) {
with_map_mut(|m| m.insert(self.key(member.user_id).to_vec(), member_to_bytes(&member)));
}

fn remove(&mut self, user_id: &UserId) -> Option<GroupMemberInternal> {
with_map_mut(|m| m.remove(&self.key(*user_id).to_vec()).map(bytes_to_member))
}
}

fn member_to_bytes(member: &GroupMemberInternal) -> Vec<u8> {
msgpack::serialize_then_unwrap(member)
}

fn bytes_to_member(bytes: Vec<u8>) -> GroupMemberInternal {
msgpack::deserialize_then_unwrap(&bytes)
}

#[derive(Eq, PartialEq, Ord, PartialOrd, Debug)]
pub struct Key {
prefix: KeyPrefix,
user_id: UserId,
}

impl Key {
fn new(prefix: KeyPrefix, user_id: UserId) -> Self {
Self { prefix, user_id }
}
}

impl Key {
fn to_vec(&self) -> Vec<u8> {
let user_id_bytes = self.user_id.as_slice();
let mut bytes = Vec::with_capacity(1 + self.prefix.byte_len() + user_id_bytes.len());
bytes.push(KeyType::ChatMember as u8);
bytes.extend_from_slice(&self.prefix.to_vec());
bytes.extend_from_slice(user_id_bytes);
bytes
}
}

impl TryFrom<&[u8]> for Key {
type Error = ();

fn try_from(value: &[u8]) -> Result<Self, Self::Error> {
match value.split_first() {
Some((kt, tail)) if *kt == KeyType::ChatMember as u8 => {
let prefix_len = match tail.first() {
Some(1) => 1,
Some(2) => 5,
_ => return Err(()),
};
let prefix = KeyPrefix::try_from(&tail[..prefix_len])?;
let user_id = Principal::from_slice(&tail[prefix_len..]).into();

Ok(Key::new(prefix, user_id))
}
_ => Err(()),
}
}
}

#[derive(Clone, Copy, Eq, PartialEq, Ord, PartialOrd, Debug)]
pub enum KeyPrefix {
GroupChat,
Channel(u32),
}

impl KeyPrefix {
fn to_vec(self) -> Vec<u8> {
match self {
KeyPrefix::GroupChat => vec![1],
KeyPrefix::Channel(channel_id) => {
let mut vec = Vec::with_capacity(5);
vec.push(2);
vec.extend_from_slice(&channel_id.to_be_bytes());
vec
}
}
}

fn byte_len(&self) -> usize {
match self {
KeyPrefix::GroupChat => 1,
KeyPrefix::Channel(_) => 5,
}
}
}

impl TryFrom<&[u8]> for KeyPrefix {
type Error = ();

fn try_from(value: &[u8]) -> Result<Self, Self::Error> {
match value.split_first() {
Some((1, _)) => Ok(KeyPrefix::GroupChat),
Some((2, bytes)) if bytes.len() >= 4 => Ok(KeyPrefix::Channel(u32::from_be_bytes(bytes[..4].try_into().unwrap()))),
_ => Err(()),
}
}
}

impl From<MultiUserChat> for KeyPrefix {
fn from(value: MultiUserChat) -> Self {
match value {
MultiUserChat::Group(_) => KeyPrefix::GroupChat,
MultiUserChat::Channel(_, c) => KeyPrefix::Channel(c.as_u32()),
}
}
}

impl Serialize for KeyPrefix {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: Serializer,
{
serializer.serialize_bytes(&self.to_vec())
}
}

struct KeyPrefixVisitor;

impl<'de> Visitor<'de> for KeyPrefixVisitor {
type Value = KeyPrefix;

fn expecting(&self, formatter: &mut Formatter) -> std::fmt::Result {
formatter.write_str("a byte array")
}

fn visit_bytes<E: Error>(self, v: &[u8]) -> Result<Self::Value, E> {
KeyPrefix::try_from(v).map_err(|_| E::custom("invalid key prefix"))
}
}

impl<'de> Deserialize<'de> for KeyPrefix {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: Deserializer<'de>,
{
deserializer.deserialize_bytes(KeyPrefixVisitor)
}
}

#[cfg(test)]
mod tests {
use super::*;
use rand::{thread_rng, Rng, RngCore};

#[test]
fn group_key_roundtrip() {
for _ in 0..100 {
let user_id_bytes: [u8; 10] = thread_rng().gen();
let user_id = Principal::from_slice(&user_id_bytes).into();

let key_in = Key::new(KeyPrefix::GroupChat, user_id);
let bytes = key_in.to_vec();
let key_out = Key::try_from(&bytes[..]).unwrap();

assert_eq!(key_in, key_out);
}
}

#[test]
fn channel_key_roundtrip() {
for _ in 0..100 {
let channel_id: u32 = thread_rng().next_u32();
let user_id_bytes: [u8; 10] = thread_rng().gen();
let user_id = Principal::from_slice(&user_id_bytes).into();

let key_in = Key::new(KeyPrefix::Channel(channel_id), user_id);
let bytes = key_in.to_vec();
let key_out = Key::try_from(&bytes[..]).unwrap();

assert_eq!(key_in, key_out);
}
}

#[test]
fn group_key_prefix_serialization_roundtrip() {
let key_prefix_in = KeyPrefix::GroupChat;
let bytes = msgpack::serialize_then_unwrap(key_prefix_in);
let key_prefix_out = msgpack::deserialize_then_unwrap(&bytes);

assert_eq!(key_prefix_in, key_prefix_out);
}

#[test]
fn channel_key_prefix_serialization_roundtrip() {
for _ in 0..100 {
let channel_id: u32 = thread_rng().next_u32();
let key_prefix_in = KeyPrefix::Channel(channel_id);
let bytes = msgpack::serialize_then_unwrap(key_prefix_in);
let key_prefix_out = msgpack::deserialize_then_unwrap(&bytes);

assert_eq!(key_prefix_in, key_prefix_out);
}
}
}
9 changes: 9 additions & 0 deletions backend/libraries/types/src/user.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ use candid::{CandidType, Principal};
use icrc_ledger_types::icrc1::account::Account;
use serde::{Deserialize, Serialize};
use std::fmt::{Debug, Display, Formatter};
use std::ops::Deref;
use ts_export::ts_export;

#[ts_export]
Expand Down Expand Up @@ -48,6 +49,14 @@ impl Display for UserId {
}
}

impl Deref for UserId {
type Target = Principal;

fn deref(&self) -> &Self::Target {
&self.0
}
}

#[ts_export]
#[derive(CandidType, Serialize, Deserialize, Debug, Clone)]
pub struct User {
Expand Down

0 comments on commit 4ed4f25

Please sign in to comment.