feat: chat scaffold #5244

brianp · 2023-03-13T22:11:14Z

Description

Refactor the contacts crate for better organization.
Expand contacts with types, and capabilities for managing messaging over the existing comms network
Add cucumber tests to provide support for new functionality

Motivation and Context

We want to expand Tari's communication network to handle p2p chat services. This PR sets us off in the right direction for the core Tari processes to be able to handle message passing and storage. Currently chat clients will be able to send, and receive messages when online or offline. Utilizing store and forward for sending communications offline.

How Has This Been Tested?

Via cucumber only. The chat client within cucumber is currently the only interface for trials.

Caveats and known issues

Encryption at rest: We need to change the message storage to support encryption at rest

hansieodendaal

Looking good, I just have some comments about the cucumber scenarios.

integration_tests/tests/features/Chat.feature

hansieodendaal · 2023-04-03T08:19:55Z

integration_tests/tests/features/Chat.feature

+    Given I have a seed node SEED_A
+    When I have a chat client CHAT_A connected to seed node SEED_A
+    When I have a chat client CHAT_B connected to seed node SEED_A


Is it still necessary to have the 3rd party base node here?

Without the seed node the two chat clients don't seem to find each other after being added as contacts. We would probably need to introduce a peer dialing step for new contacts if the client doesn't otherwise have connectivity.

Maybe we can register an issue to monitor if this will be a problem for the mobile wallets, as they will most probably not connect to the same base node at startup.

integration_tests/tests/features/Chat.feature

SWvheerden

This is looking good

applications/tari_base_node/log4rs_sample.yml

base_layer/contacts/migrations/2023-03-14-101758_create_messages/up.sql

base_layer/contacts/src/contacts_service/handle.rs

base_layer/contacts/src/contacts_service/service.rs

base_layer/contacts/src/contacts_service/storage/database.rs

base_layer/contacts/src/contacts_service/storage/types/contacts.rs

SWvheerden · 2023-04-13T09:46:17Z

base_layer/contacts/src/contacts_service/storage/types/contacts.rs

+    pub address: Vec<u8>,
+    node_id: Vec<u8>,


Whats the reason we have both here?
address = [node_id][CRC + network]
Asking the node id from address is a simple slice read

SWvheerden · 2023-04-13T09:46:51Z

base_layer/contacts/src/contacts_service/types/contact.rs

+    pub address: TariAddress,
+    pub node_id: NodeId,


I asked above, but same here, why store both.

Ahh, not sure. This code was moved in the refactor, not written new for this PR.

comms/dht/src/outbound/requester.rs

integration_tests/log4rs/wallet.yml

This refactor reorganizes the contacts crate and builds out the possibility of sending messages to contacts via the already running comms services. Messages will be monitored for and stored locally for the client to retrieve and present in whatever form.

These references are out of date after the refactor and just needed a little guidance.

This provides a barebones chat client used for testing within cucumber. The client is relatively isolated from the test suite itself and could be expanded on in the future.

I was using the default encryption method, which happens to be plaintext. This caused all messages to go out unencrypted and allowed all clients to receive and read all messages. With the appropriate encryption methods client can't read messages not for them, and ignore them, or SAF.

Update the log4s to include the refactoring of contacts and surrounding services.

The ids shouldn't increment per client this would be a useless function. Having a single message between two clients share a common uuid increases ease of integration for future functionality such as validation messages have arrived and read receipts etc.

Instead of changing the default impl of an existing function, move the old function to the unencrypted name, make the new function with an encrypted name, and let any call to the old api fail.

SWvheerden · 2023-04-18T11:22:45Z

Ack

## [0.50.0-pre.1](v0.50.0-pre.0...v0.50.0-pre.1) (2023-05-08) ### Features * add miner timeout config option ([5331](#5331)) ([aea14f6](aea14f6)) * chat ffi ([5349](#5349)) ([f7cece2](f7cece2)) * chat scaffold ([5244](#5244)) ([5b09f8e](5b09f8e)) * improve message encryption ([5288](#5288)) ([7a80716](7a80716)) * **p2p:** allow listener bind to differ from the tor forward address ([5357](#5357)) ([857fb55](857fb55)) ### Bug Fixes * add SECURITY.md Vulnerability Disclosure Policy ([5351](#5351)) ([72daaf5](72daaf5)) * added missing log4rs features ([5356](#5356)) ([b9031bb](b9031bb)) * allow public addresses from command line ([5303](#5303)) ([349ac89](349ac89)) * clippy issues with config ([5334](#5334)) ([026f0d5](026f0d5)) * default network selection ([5333](#5333)) ([cf4b2c8](cf4b2c8)) * make the first output optional in the wallet ([5352](#5352)) ([bf16140](bf16140)) * remove wallet panic ([5338](#5338)) ([536d16d](536d16d)) * wallet .h file for lib wallets ([5330](#5330)) ([22a3a17](22a3a17))

brianp changed the title ~~feature: wip chat scaffold~~ feat: wip chat scaffold Mar 13, 2023

brianp force-pushed the feature-chat-scaffold branch 2 times, most recently from 2ee0044 to 300fa2d Compare March 14, 2023 13:10

brianp force-pushed the feature-chat-scaffold branch 3 times, most recently from 1c8cd19 to deffd19 Compare March 29, 2023 15:27

ghpbot-tari-project added P-acks_required Process - Requires more ACKs or utACKs P-reviews_required Process - Requires a review from a lead maintainer to be merged labels Mar 29, 2023

brianp force-pushed the feature-chat-scaffold branch 2 times, most recently from ee8560f to 848d3d7 Compare March 29, 2023 15:44

brianp closed this Mar 31, 2023

brianp deleted the feature-chat-scaffold branch March 31, 2023 08:18

brianp restored the feature-chat-scaffold branch March 31, 2023 08:19

brianp reopened this Mar 31, 2023

brianp force-pushed the feature-chat-scaffold branch 2 times, most recently from a8259ea to e81351a Compare March 31, 2023 21:36

brianp marked this pull request as ready for review March 31, 2023 21:36

brianp requested review from SWvheerden and hansieodendaal March 31, 2023 21:36

brianp changed the title ~~feat: wip chat scaffold~~ feat: chat scaffold Apr 2, 2023

hansieodendaal reviewed Apr 3, 2023

View reviewed changes

brianp force-pushed the feature-chat-scaffold branch from e246d5a to ceb8ec2 Compare April 12, 2023 07:41

SWvheerden reviewed Apr 13, 2023

View reviewed changes

brianp force-pushed the feature-chat-scaffold branch from ceb8ec2 to 46f710b Compare April 17, 2023 21:21

brianp added 6 commits April 18, 2023 10:33

Fixup lingering references to the contacts crate

ae4d8fb

These references are out of date after the refactor and just needed a little guidance.

Add cucumber tests for chat

62e42b5

This provides a barebones chat client used for testing within cucumber. The client is relatively isolated from the test suite itself and could be expanded on in the future.

Clippy fixes and function updating

54d8f43

Correct the timestamps so it doesn't put us years into the future

23ae67d

Remove cucumber waits and add timeout loops

3afc64e

brianp added 13 commits April 18, 2023 10:33

Remove client LocalNet dependency

e521170

Use the authenticated origin, not the source

843425e

Get direct sends working

2b4b10f

Make sure we be logging good like

d93f692

Update the log4s to include the refactoring of contacts and surrounding services.

Stop the base node to ensure comms are going direct

3da8633

Move the encrypted send direct into the requester

9887a43

Updates after rebase

5be843d

Remove unused paging params

d98a532

Update as per review

e3ec11c

Remove old function name

c30482b

Instead of changing the default impl of an existing function, move the old function to the unencrypted name, make the new function with an encrypted name, and let any call to the old api fail.

Ignore prost in contacts when running machete

ee230a5

brianp force-pushed the feature-chat-scaffold branch from f4edc95 to ee230a5 Compare April 18, 2023 08:33

SWvheerden approved these changes Apr 18, 2023

View reviewed changes

ghpbot-tari-project removed the P-reviews_required Process - Requires a review from a lead maintainer to be merged label Apr 18, 2023

Merge branch 'development' into feature-chat-scaffold

415a85a

SWvheerden merged commit 5b09f8e into tari-project:development Apr 18, 2023
9 of 10 checks passed

SWvheerden mentioned this pull request May 8, 2023

chore: new version for development #5371

Merged

brianp deleted the feature-chat-scaffold branch October 2, 2023 14:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: chat scaffold #5244

feat: chat scaffold #5244

brianp commented Mar 13, 2023 •

edited

hansieodendaal left a comment

hansieodendaal Apr 3, 2023

brianp Apr 3, 2023

hansieodendaal Apr 3, 2023

SWvheerden left a comment

SWvheerden Apr 13, 2023

SWvheerden Apr 13, 2023

brianp Apr 13, 2023

SWvheerden commented Apr 18, 2023

feat: chat scaffold #5244

feat: chat scaffold #5244

Conversation

brianp commented Mar 13, 2023 • edited

Description

Motivation and Context

How Has This Been Tested?

Caveats and known issues

hansieodendaal left a comment

Choose a reason for hiding this comment

hansieodendaal Apr 3, 2023

Choose a reason for hiding this comment

brianp Apr 3, 2023

Choose a reason for hiding this comment

hansieodendaal Apr 3, 2023

Choose a reason for hiding this comment

SWvheerden left a comment

Choose a reason for hiding this comment

SWvheerden Apr 13, 2023

Choose a reason for hiding this comment

SWvheerden Apr 13, 2023

Choose a reason for hiding this comment

brianp Apr 13, 2023

Choose a reason for hiding this comment

SWvheerden commented Apr 18, 2023

brianp commented Mar 13, 2023 •

edited