E2EE text messaging example. #3754
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Shows how to prepare an existing room for end-to-end-encryption (E2EE) and send a text message.
github-actions
bot
added
the
Z-Community-PR
dbkr
requested changes
Mar 21, 2024
There was a problem hiding this comment.
A few specific points but I think this would need a bit of work generally before being an example we could accept. Some more general points:
- Comments, comments, comments! This is documentation so it needs to be explaining what it's doing and why in detail so the reader understands the process. eg. why does it need to wait for the 'PREPARED' sync state?
- It really ought to conform to our code style. In fact it would be nice if it got checked by the linters.
- It would be even nicer if it got run as part of CI to make sure it still worked every time
- We don't tend to use the 'mjs' extension - is it necessary? Why?
- You've use MemoryCryptoStore: this is great for this example but again, needs a comment to say why it's appropriate here and what the limitations are.
- Some doc of how to run it would feel useful too.
| @@ -0,0 +1,126 @@ | |||
| // Description: | |||
There was a problem hiding this comment.
Don't forget license header and copyright attribution (to yourself)
| // | ||
| // - NodeJS v18.17.1 | ||
| // - matrix-js-sdk v28.2.0 | ||
| // - olm v3.1.5 |
There was a problem hiding this comment.
This probably wants to be a block comment?
| function log(msg) | ||
| { | ||
| console.log(`${sLogPrefix}${msg}`); | ||
| }; |
There was a problem hiding this comment.
This whole log wrapper and prefix feels weird and distracting for an example, especially since the prefix is hardcoded.
| import olm from 'olm'; | ||
|
|
||
| const sLogPrefix = '*** MAIN ***: ', | ||
| sC = { |
| process.exit(1); | ||
| } | ||
|
|
||
| // Marking all devices as verified: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Shows how to prepare an existing room for end-to-end-encryption (E2EE) and send a text message.
Addresses issues #437 and #1156.
Signed-off-by: Marcel Timm [email protected]
Here's what your changelog entry will look like:
✨ Features