feat: introduce communities settings by 0x-r4bbit · Pull Request #2500 · status-im/status-go

0x-r4bbit · 2022-01-24T13:15:05Z

This commit introduces new communities settings that are needed for the
upcoming Community History Archive support.

Namely, we need to persist whether community owners will seed message
history archives and whether community members are interested in
fetching such archives.

The settings are defined as follows:

community_id - The id of the community the settings belong to
message_archive_seeding_enabled - Whether message history archives
will be created and seeded for this community
message_archive_fetching_enabled - Whether message history archives
will fetched for this community

The data is persisted in a newly introduced communities_settings
table.

Furthermore, the RPC API that returns Settings for the logged in
account will now include a communities-settings field of type:
[]CommunitySettings.

The community settings in the database will be added, updated an deleted
depending whether the user joins, leaves or edits the community in
question.

Tasks

Write tests
Correct formatting
Migration script to add community settings for existing communities

Closes #2495

ghost · 2022-01-24T13:15:11Z

Pull Request Checklist

Have you updated the documentation, if impacted (e.g. docs.status.im)?
Have you tested changes with mobile?
Have you tested changes with desktop?

status-im-auto · 2022-01-24T13:17:45Z

Jenkins Builds

Click to see older builds (6)

❔	Commit	#️⃣	Finished (UTC)	Duration	Platform	Result
✔️	`05ddbfc`	#1	2022-01-24 13:17:44	~2 min	`linux`	📦`zip`
✔️	`05ddbfc`	#1	2022-01-24 13:18:59	~3 min	`ios`	📦`zip`
✔️	`05ddbfc`	#1	2022-01-24 13:19:18	~3 min	`android`	📦`aar`

✔️	`4b4896d`	#2	2022-01-24 14:20:58	~1 min	`ios`	📦`zip`
✔️	`4b4896d`	#2	2022-01-24 14:21:18	~2 min	`linux`	📦`zip`
✔️	`4b4896d`	#2	2022-01-24 14:23:21	~4 min	`android`	📦`aar`

❔	Commit	#️⃣	Finished (UTC)	Duration	Platform	Result
✔️	`4c6b75f`	#3	2022-01-24 19:41:45	~1 min	`ios`	📦`zip`
✔️	`4c6b75f`	#3	2022-01-24 19:41:45	~1 min	`linux`	📦`zip`
✔️	`4c6b75f`	#3	2022-01-24 19:43:05	~3 min	`android`	📦`aar`

✔️	`7695cd4`	#4	2022-01-24 19:50:59	~1 min	`ios`	📦`zip`
✔️	`7695cd4`	#4	2022-01-24 19:51:19	~2 min	`linux`	📦`zip`
✔️	`7695cd4`	#4	2022-01-24 19:52:11	~2 min	`android`	📦`aar`

0x-r4bbit · 2022-01-24T13:18:02Z

multiaccounts/accounts/database.go

 	)

+  communitiesSettings, err := db.GetCommunitiesSettings()
+  s.CommunitiesSettings = communitiesSettings


Since communities_settings live in a separate table, I'm explicitly querying/assigning it here.

Let me know if this should not happen here and whether we prefer a separate RPC API so clients can request that data.

0x-r4bbit · 2022-01-24T13:19:59Z

params/config.go

+  CommunityID                     string          `json:"communityId"`
+  MessageArchiveFetchingEnabled   bool            `json:"messageArchiveFetchingEnabled"`
+  MessageArchiveSeedingEnabled    bool            `json:"messageArchiveSeedingEnabled"`
+}


This might not be the proper place to put this type.

Eventually, we probably need a type for enabling/disabling community history archive support in the CLI as well. Might as well leverage this type for that, which is why I put it here.

Happy to put it somewhere else.

0x-r4bbit · 2022-01-24T13:20:35Z

protocol/messenger_communities.go

+    CommunityID: communityID.String(),
+    MessageArchiveFetchingEnabled: true,
+    MessageArchiveSeedingEnabled: false,
+  }


These are the defaults when joining a community.

If could also introduce a GetDefaultCommunitySettings API if you prefer.

0x-r4bbit · 2022-01-24T13:21:33Z

protocol/requests/create_community_request.go

+	ImageBx                       int                                  `json:"imageBx"`
+	ImageBy                       int                                  `json:"imageBy"`
+  MessageArchiveSeedingEnabled  bool                                 `json:"messageArchiveSeedingEnabled,omitempty"`
+  MessageArchiveFetchingEnabled  bool                                 `json:"messageArchiveFetchingEnabled,omitempty"`


I made those two omitempty so we can potentially put these changes into production without having the need for desktop and/or mobile to do anything in particular.

0x-r4bbit · 2022-01-24T19:44:15Z

Have you updated the documentation, if impacted (e.g. docs.status.im)?

There's a pending PR for a protocol spec addition that eventually needs these changes: status-im/specs#164

This commit introduces new communities settings that are needed for the upcoming Community History Archive support. Namely, we need to persist whether community owners will seed message history archives and whether community members are interested in fetching such archives. The settings are defined as follows: 1. `community_id` - The id of the community the settings belong to 2. `message_archive_seeding_enabled` - Whether message history archives will be created and seeded for this community 3. `message_archive_fetching_enabled` - Whether message history archives will fetched for this community The data is persisted in a newly introduced `communities_settings` table. Furthermore, the RPC API that returns `Settings` for the logged in account will now include a `communities-settings` field of type: `[]CommunitySettings`. The community settings in the database will be added, updated an deleted depending whether the user joins, leaves or edits the community in question. Closes status-im#2495

0x-r4bbit · 2022-01-24T19:54:14Z

The linting error caused in this PR: https://ci.status.im/blue/organizations/jenkins/status-go%2Fprs%2Ftests/detail/PR-2500/4/pipeline#step-60-log-3 seems to be unrelated to my changes.

0x-r4bbit · 2022-01-26T10:47:48Z

As discussed offline with @cammellos, introduction of communities_settings for existing communities (prior to this PR/commit) can possibly be done in an SQL migration script.

I'll give that a spin, so please don't merge this yet.

richard-ramos · 2022-01-26T11:57:58Z

protocol/requests/create_community_request.go

 	return description, nil
 }
+
+func (c *CreateCommunity) ToCommunitySettings(publicKey string) (params.CommunitySettings, error) {


Is an error expected? if not, it can be removed from the return parameters

It's not, wanted to stay consistent. But happy to change this!

richard-ramos · 2022-01-26T12:02:26Z

multiaccounts/accounts/database.go

 	return "", err
 }
+
+func (db *Database) SaveCommunitySettings(communitySettings params.CommunitySettings) error {


In protocol/communities/persistence.go live all the functions related to communities CRUD operations. What do you think of having these community settings functions live there too?

Happy to move it over!

Main reason I put them here was because I consider them more "settings" related to the account. Like.. we could also call the entire thing "node_settings" if we want (once we get to actually supporting all the settings like throttling etc). In that sense it wouldn't necessarily be community specific anymore.

But yea, I totally see where you're coming from, so I'll move it over for now. We can still migrate it to somewhere else once this stuff gets broader responsibility.

richard-ramos · 2022-01-26T12:05:25Z

appdatabase/migrations/sql/1642771235_add_communities_settings.up.sql

@@ -0,0 +1,5 @@
+CREATE TABLE communities_settings (
+  community_id TEXT PRIMARY KEY ON CONFLICT REPLACE,


In protocol/migrations/sqlite/1605075346_add_communities.up.sql the community_id is defined as
id BLOB NOT NULL PRIMARY KEY ON CONFLICT REPLACE. Consider using the same data type (blob)

richard-ramos · 2022-01-26T12:13:09Z

multiaccounts/accounts/database.go

+	if err != nil {
+		return err
+	}
+	return nil


Suggested change

if err != nil {

return err

}

return nil

return err

richard-ramos · 2022-01-26T12:18:03Z

multiaccounts/accounts/database.go

+	communitiesSettings, err := db.GetCommunitiesSettings()
+	s.CommunitiesSettings = communitiesSettings


If there's an err, it might end up being overwritten by a succesful db.getCommunitiesSetting() response

Suggested change

communitiesSettings, err := db.GetCommunitiesSettings()

s.CommunitiesSettings = communitiesSettings

if err != nil {

return s, err

}

communitiesSettings, err := db.GetCommunitiesSettings()

s.CommunitiesSettings = communitiesSettings

Good catch!!

0x-r4bbit · 2022-03-24T09:44:10Z

Closing in favour of #2574

0x-r4bbit commented Jan 24, 2022

View reviewed changes

0x-r4bbit force-pushed the chamvp branch from 05ddbfc to 4b4896d Compare January 24, 2022 14:18

0x-r4bbit requested review from alaibe and cammellos January 24, 2022 15:38

0x-r4bbit force-pushed the chamvp branch from 4b4896d to 4c6b75f Compare January 24, 2022 19:39

0x-r4bbit force-pushed the chamvp branch from 4c6b75f to 7695cd4 Compare January 24, 2022 19:49

richard-ramos reviewed Jan 26, 2022

View reviewed changes

0x-r4bbit closed this Mar 24, 2022

		@@ -0,0 +1,5 @@
		CREATE TABLE communities_settings (
		community_id TEXT PRIMARY KEY ON CONFLICT REPLACE,

		communitiesSettings, err := db.GetCommunitiesSettings()
		s.CommunitiesSettings = communitiesSettings

Comments

Conversation

0x-r4bbit commented Jan 24, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Tasks

Uh oh!

ghost commented Jan 24, 2022 • edited by 0x-r4bbit Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Checklist

Uh oh!

status-im-auto commented Jan 24, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Jenkins Builds

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

0x-r4bbit commented Jan 24, 2022

Uh oh!

0x-r4bbit commented Jan 24, 2022

Uh oh!

0x-r4bbit commented Jan 26, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

richard-ramos Jan 26, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

0x-r4bbit commented Mar 24, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

0x-r4bbit commented Jan 24, 2022 •

edited

Loading

ghost commented Jan 24, 2022 •

edited by 0x-r4bbit

Loading

status-im-auto commented Jan 24, 2022 •

edited

Loading

richard-ramos Jan 26, 2022 •

edited

Loading