status-go/protocol
Samuel Hawksby-Robinson 07e46714f0
Anon Metrics Broadcast (#2198)
* Protobufs and adapters

* Added basic anon metric service and config init

* Added fibonacci interval incrementer

* Added basic Client.Start func and integrated interval incrementer

* Added new processed field to app metrics table

* Added id column to app metrics table

* Added migration clean up

* Added appmetrics GetUnprocessed and SetToProcessedByIDs and tests

There was a wierd bug where metrics in the db that did not explicitly insert a  value would be NULL, so could not be found by . In addition I've added a new primary id field to the app_metrics table so that updates could be done against very specific metric rows.

* Updated adaptors and db to handle proto_id

I need a way to distinguish individual metric items from each other so that I can ignore the ones that have been seen before.

* Moved incrementer into dedicated file

* Resolve incrementer test fail

* Finalised the main loop functionality

* Implemented delete loop framework

* Updated adaptors file name

* Added delete loop delay and quit, and tweak on RawMessage gen

* Completed delete loop logic

* Added DBLock to prevent deletion during mainLoop

* Added postgres DB connection, integrated into anonmetrics.Server

* Removed proto_id from SQL migration and model

* Integrated postgres with Server and updated adaptors

* Function name update

* Added sample config files for client and server

* Fixes and testing for low level e2e

* make generate

* Fix lint

* Fix for receiving an anonMetricBatch not in server mode

* Postgres test fixes

* Tidy up, make vendor and make generate

* delinting

* Fixing database tests

* Attempted fix of does:  cannot open `does' (No such file or directory)
not:   cannot open `not' (No such file or directory)
exist: cannot open `exist' (No such file or directory) error on sql resource loas

* Moved all anon metric postgres migration logic and sources into a the protocol/anonmetrics package or sub packages. I don't know if this will fix the does:  cannot open `does' (No such file or directory)
not:   cannot open `not' (No such file or directory)
exist: cannot open `exist' (No such file or directory) error that happens in Jenkins but this could work

* Lint for the lint god

* Why doesn't the linter list all its problems at once?

* test tweaks

* Fix for wakuV2 change

* DB reset change

* Fix for postgres db migrations fails

* More robust implementation of postgres test setup and teardown

* Added block for anon metrics functionality

* Version Bump to 0.84.0

* Added test to check anon metrics broadcast is deactivated

* Protobufs and adapters

* Added basic anon metric service and config init

* Added new processed field to app metrics table

* Added id column to app metrics table

* Added migration clean up

* Added appmetrics GetUnprocessed and SetToProcessedByIDs and tests

There was a wierd bug where metrics in the db that did not explicitly insert a  value would be NULL, so could not be found by . In addition I've added a new primary id field to the app_metrics table so that updates could be done against very specific metric rows.

* Updated adaptors and db to handle proto_id

I need a way to distinguish individual metric items from each other so that I can ignore the ones that have been seen before.

* Added postgres DB connection, integrated into anonmetrics.Server

* Removed proto_id from SQL migration and model

* Integrated postgres with Server and updated adaptors

* Added sample config files for client and server

* Fix lint

* Fix for receiving an anonMetricBatch not in server mode

* Postgres test fixes

* Tidy up, make vendor and make generate

* Moved all anon metric postgres migration logic and sources into a the protocol/anonmetrics package or sub packages. I don't know if this will fix the does:  cannot open `does' (No such file or directory)
not:   cannot open `not' (No such file or directory)
exist: cannot open `exist' (No such file or directory) error that happens in Jenkins but this could work
2021-09-01 13:02:18 +01:00
..
anonmetrics Anon Metrics Broadcast (#2198) 2021-09-01 13:02:18 +01:00
audio Add audio messages 2020-07-27 17:14:50 +02:00
common Delete messages (#2279) 2021-07-26 17:06:32 -04:00
communities fix: allow empty category id when sorting chats and fix error messages (#2301) 2021-08-25 12:52:28 -04:00
datasync Rename MessageProcessor to MessageSender (#2264) 2021-06-23 17:13:48 +03:00
encryption using zap.NewNop() ignores configured log level 2021-08-19 11:35:40 +02:00
ens Request/Decline access to communities 2021-02-26 15:35:43 +01:00
identity add transparent background to identicon 2020-03-25 09:02:58 +01:00
images Resolved linting issues 2020-12-17 14:10:00 +01:00
internal/sqlite Move to protobuf for Message type (#1706) 2019-12-05 17:25:34 +01:00
migrations Anon Metrics Broadcast (#2198) 2021-09-01 13:02:18 +01:00
protobuf Anon Metrics Broadcast (#2198) 2021-09-01 13:02:18 +01:00
pushnotificationclient Sync Communities (#2253) 2021-08-06 16:40:23 +01:00
pushnotificationserver Sync Communities (#2253) 2021-08-06 16:40:23 +01:00
requests fix: allow empty category id when sorting chats and fix error messages (#2301) 2021-08-25 12:52:28 -04:00
sqlite Refactorings: whisper transport removed (#2200) 2021-04-22 16:36:18 +03:00
subscription Move to monorepo structure (#1684) 2019-11-21 17:19:22 +01:00
transport Anon Metrics Broadcast (#2198) 2021-09-01 13:02:18 +01:00
tt Move to monorepo structure (#1684) 2019-11-21 17:19:22 +01:00
urls feat: Re-enable unfurling for tenor (#2302) 2021-08-20 15:13:10 -04:00
v1 Anon Metrics Broadcast (#2198) 2021-09-01 13:02:18 +01:00
zaputil Move to monorepo structure (#1684) 2019-11-21 17:19:22 +01:00
LICENSE Move to monorepo structure (#1684) 2019-11-21 17:19:22 +01:00
README.md Added basic history of the protocol package (#1984) 2020-06-04 11:23:09 +01:00
activity_center.go Add reply message to activity center notification of type reply (#2272) 2021-07-15 17:21:44 -03:00
activity_center_persistence.go Delete activity center notifications for deleted messages (#2319) 2021-08-23 11:23:55 -03:00
anon_metrics_test.go Anon Metrics Broadcast (#2198) 2021-09-01 13:02:18 +01:00
chat.go Change community channel description (#2236) 2021-06-01 15:13:17 +03:00
chat_group_proxy.go Clean up protocol package (#1890) 2020-03-09 07:19:23 +01:00
chat_test.go Add mentioned field 2021-05-26 08:33:38 +02:00
communities_messenger_test.go Sync Communities (#2253) 2021-08-06 16:40:23 +01:00
contact.go Add mailserver logic 2021-05-21 07:22:58 +02:00
delete_message.go Delete messages (#2279) 2021-07-26 17:06:32 -04:00
edit_message.go address feedback 2021-06-29 13:15:15 +02:00
emoji_reaction.go Skip wrapping emojis in private group chats 2021-01-26 09:39:47 +01:00
errors.go Add ClearHistory & DeactivateChat methods 2021-01-11 13:36:05 +01:00
group_chat_invitation.go group chat invitation 2020-09-07 12:15:58 +02:00
group_chat_system_messages.go Add mentioned field 2021-05-26 08:33:38 +02:00
local_notifications.go [status-im/status-react#12450] Add push notification for deleted message 2021-08-20 11:26:46 +03:00
message_builder.go add PinMessage and PinnedMessage (#2180) 2021-05-14 23:22:50 +02:00
message_persistence.go Return counter for messages with mention which are marked as seen 2021-08-31 11:49:40 +03:00
message_validator.go Delete messages (#2279) 2021-07-26 17:06:32 -04:00
message_validator_test.go Fix protobuf ImageType change 2020-12-17 14:10:00 +01:00
messenger.go Anon Metrics Broadcast (#2198) 2021-09-01 13:02:18 +01:00
messenger_activity_center.go Make it possible to mark individual notifications as read (#2256) 2021-06-11 12:47:53 -04:00
messenger_activity_center_test.go Fix some tests and restore private/public RPC client 2021-07-20 10:57:38 +02:00
messenger_chats.go Register public and community chats for push notifications after creation 2021-09-01 12:30:42 +03:00
messenger_communities.go Register public and community chats for push notifications after creation 2021-09-01 12:30:42 +03:00
messenger_config.go Anon Metrics Broadcast (#2198) 2021-09-01 13:02:18 +01:00
messenger_contact_update_test.go Fix some tests and restore private/public RPC client 2021-07-20 10:57:38 +02:00
messenger_contacts.go Add mailserver logic 2021-05-21 07:22:58 +02:00
messenger_delete_message_test.go Add chatID to removed messages 2021-08-25 12:21:40 +03:00
messenger_edit_message_test.go Delete messages (#2279) 2021-07-26 17:06:32 -04:00
messenger_emoji_test.go Fix some tests and restore private/public RPC client 2021-07-20 10:57:38 +02:00
messenger_ens.go Request/Decline access to communities 2021-02-26 15:35:43 +01:00
messenger_handler.go Anon Metrics Broadcast (#2198) 2021-09-01 13:02:18 +01:00
messenger_handler_test.go address feedback 2021-06-29 13:15:15 +02:00
messenger_installations_test.go Fix some tests and restore private/public RPC client 2021-07-20 10:57:38 +02:00
messenger_mailserver.go Set timeout on mailserver requests 2021-08-03 11:16:37 +02:00
messenger_maps.go Add activity center & messages from contacts only 2021-04-16 20:42:40 +02:00
messenger_messages.go Add chatID to removed messages 2021-08-25 12:21:40 +03:00
messenger_mute_test.go Fix some tests and restore private/public RPC client 2021-07-20 10:57:38 +02:00
messenger_pin_message_test.go Fix some tests and restore private/public RPC client 2021-07-20 10:57:38 +02:00
messenger_pin_messages.go add PinMessage and PinnedMessage (#2180) 2021-05-14 23:22:50 +02:00
messenger_response.go Anon Metrics Broadcast (#2198) 2021-09-01 13:02:18 +01:00
messenger_response_test.go address feedback 2021-06-29 13:15:15 +02:00
messenger_status_updates.go Sync Communities (#2253) 2021-08-06 16:40:23 +01:00
messenger_test.go Return counter for messages with mention which are marked as seen 2021-08-31 11:49:40 +03:00
persistence.go feat: user status (#2276) 2021-07-22 13:41:49 -04:00
persistence_test.go Return counter for messages with mention which are marked as seen 2021-08-31 11:49:40 +03:00
push_notification_test.go Fix some tests and restore private/public RPC client 2021-07-20 10:57:38 +02:00
status_update.go feat: user status (#2276) 2021-07-22 13:41:49 -04:00
transaction_validator.go Move message to common namespace 2020-09-09 21:22:12 +02:00
transaction_validator_test.go Move message to common namespace 2020-09-09 21:22:12 +02:00

README.md

status-go/protocol

This is an implementation of the secure transport and payloads which are a part of the Status Client specification.

This implementation uses SQLite and SQLCipher for persistent storage.

The payloads are encoded using protocol-buffers.

Content

  • messenger.go is the main file which exports Messenger struct. This is a public API to interact with this implementation of the Status Chat Protocol.
  • protobuf/ contains protobuf files implementing payloads described in the Payloads spec.
  • encryption/ implements the Secure Transport spec.
  • transport/ connects the Status Chat Protocol with a wire-protocol which in our case is either Whisper or Waku.
  • datasync/ is an adapter for MVDS.
  • applicationmetadata/ is an outer layer wrapping a payload with an app-specific metadata like a signature.
  • identity/ implements details related to creating a three-word name and identicon.
  • migrations/ contains implementation specific migrations for the sqlite database which is used by Messenger as a persistent data store.

History

Originally this package was a dedicated repo called status-protocol-go and was migrated into status-go. The new status-go/protocol package maintained its own dependencies until sub modules were removed and the root go.mod file managed all dependencies for the entire status-go repo.