feat: support prepareMessage and sendPreparedMessage #100
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
dmccartney
commented
Sep 7, 2023
Comment on lines
+105
to
+109
| const prepared = await bobConversation.prepareMessage("hi"); | ||
|
|
||
| // Either of these should work: | ||
| await bobConversation.sendPreparedMessage(prepared); | ||
| // await bob.sendPreparedMessage(prepared); |
There was a problem hiding this comment.
This is the expected typical scenario for JS-only apps -- calling .prepareMessage immediately upon user input and then attempting .sendPreparedMessage (or waiting to (re)try when connectivity resumes).
dmccartney
commented
Sep 7, 2023
Comment on lines
+52
to
+69
| // For native integrations (e.g. if you have native code for a robust | ||
| // pending-message queue in a background task) you can load the referenced | ||
| // `preparedFileUri` as a serialized `PreparedMessage` with the native SDKs. | ||
| // The contained `envelopes` can then be directly `.publish()`ed with the native `Client`. | ||
| // e.g. on iOS: | ||
| // let preparedFileUrl = URL(string: preparedFileUri) | ||
| // let preparedData = try Data(contentsOf: preparedFileUrl) | ||
| // let prepared = try PreparedMessage.fromSerializedData(preparedData) | ||
| // try await client.publish(envelopes: prepared.envelopes) | ||
| // e.g. on Android: | ||
| // val preparedFileUri = Uri.parse(preparedFileUri) | ||
| // val preparedData = contentResolver.openInputStream(preparedFileUrl)!! | ||
| // .use { it.buffered().readBytes() } | ||
| // val prepared = PreparedMessage.fromSerializedData(preparedData) | ||
| // client.publish(envelopes = prepared.envelopes) | ||
| // | ||
| // You can also stuff the `preparedData` elsewhere (e.g. in a database) if that | ||
| // is more convenient for your use case. |
There was a problem hiding this comment.
Some apps implement a native background task for robust pending-message queues (e.g. to gracefully handle outages and restarts outside of a JS context). Here are some pieces of a recipe to handle publishing these prepared messages using the native SDKs.
nplasterer
approved these changes
Sep 7, 2023
|
🎉 This PR is included in version 1.12.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
This was referenced Sep 7, 2023
Closed
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.
This adds support for
.preparedMessage()to the SDK with a specific eye toward supporting robust pending-message queues.This fixes #82
See also xmtp/xmtp-ios#152 and xmtp/xmtp-android#113