6fa8c11382
This is the initial implementation for the new URL unfurling requirements. The most important one is that only the message sender will pay the privacy cost for unfurling and extracting metadata from websites. Once the message is sent, the unfurled data will be stored at the protocol level and receivers will just profit and happily decode the metadata to render it. Further development of this URL unfurling capability will be mostly guided by issues created on clients. For the moment in status-mobile: https://github.com/status-im/status-mobile/labels/url-preview - https://github.com/status-im/status-mobile/issues/15918 - https://github.com/status-im/status-mobile/issues/15917 - https://github.com/status-im/status-mobile/issues/15910 - https://github.com/status-im/status-mobile/issues/15909 - https://github.com/status-im/status-mobile/issues/15908 - https://github.com/status-im/status-mobile/issues/15906 - https://github.com/status-im/status-mobile/issues/15905 ### Terminology In the code, I've tried to stick to the word "unfurl URL" to really mean the process of extracting metadata from a website, sort of lower level. I use "link preview" to mean a higher level structure which is enriched by unfurled data. "link preview" is also how designers refer to it. ### User flows 1. Carol needs to see link previews while typing in the chat input field. Notice from the diagram nothing is persisted and that status-go endpoints are essentially stateless. ``` #+begin_src plantuml :results verbatim Client->>Server: Call wakuext_getTextURLs Server-->>Client: Normalized URLs Client->>Client: Render cached unfurled URLs Client->>Server: Unfurl non-cached URLs.\nCall wakuext_unfurlURLs Server->>Website: Fetch metadata Website-->>Server: Metadata (thumbnail URL, title, etc) Server->>Website: Fetch thumbnail Server->>Website: Fetch favicon Website-->>Server: Favicon bytes Website-->>Server: Thumbnail bytes Server->>Server: Decode & process images Server-->>Client: Unfurled data (thumbnail data URI, etc) #+end_src ``` ``` ,------. ,------. ,-------. |Client| |Server| |Website| `--+---' `--+---' `---+---' | Call wakuext_getTextURLs | | | ---------------------------------------> | | | | | Normalized URLs | | | <- - - - - - - - - - - - - - - - - - - - | | | | |----. | | | | Render cached unfurled URLs | | |<---' | | | | | | Unfurl non-cached URLs. | | | Call wakuext_unfurlURLs | | | ---------------------------------------> | | | | | | Fetch metadata | | | ------------------------------------> | | | | | Metadata (thumbnail URL, title, etc)| | | <- - - - - - - - - - - - - - - - - - | | | | | Fetch thumbnail | | | ------------------------------------> | | | | | Fetch favicon | | | ------------------------------------> | | | | | Favicon bytes | | | <- - - - - - - - - - - - - - - - - - | | | | | Thumbnail bytes | | | <- - - - - - - - - - - - - - - - - - | | | | |----. | | | | Decode & process images | | |<---' | | | | | Unfurled data (thumbnail data URI, etc)| | | <- - - - - - - - - - - - - - - - - - - - | ,--+---. ,--+---. ,---+---. |Client| |Server| |Website| `------' `------' `-------' ``` 2. Carol sends the text message with link previews in the RPC request wakuext_sendChatMessages. status-go assumes the link previews are good because it can't and shouldn't attempt to re-unfurl them. ``` #+begin_src plantuml :results verbatim Client->>Server: Call wakuext_sendChatMessages Server->>Server: Transform link previews to\nbe proto-marshalled Server->DB: Write link previews serialized as JSON Server-->>Client: Updated message response #+end_src ``` ``` ,------. ,------. ,--. |Client| |Server| |DB| `--+---' `--+---' `+-' | Call wakuext_sendChatMessages| | | -----------------------------> | | | | | |----. | | | | Transform link previews to | | |<---' be proto-marshalled | | | | | | | | | Write link previews serialized as JSON| | | --------------------------------------> | | | | Updated message response | | | <- - - - - - - - - - - - - - - | ,--+---. ,--+---. ,+-. |Client| |Server| |DB| `------' `------' `--' ``` 3. The message was sent over waku and persisted locally in Carol's device. She should now see the link previews in the chat history. There can be many link previews shared by other chat members, therefore it is important to serve the assets via the media server to avoid overloading the ReactNative bridge with lots of big JSON payloads containing base64 encoded data URIs (maybe this concern is meaningless for desktop). When a client is rendering messages with link previews, they will have the field linkPreviews, and the thumbnail URL will point to the local media server. ``` #+begin_src plantuml :results verbatim Client->>Server: GET /link-preview/thumbnail (media server) Server->>DB: Read from user_messages.unfurled_links Server->Server: Unmarshal JSON Server-->>Client: HTTP Content-Type: image/jpeg/etc #+end_src ``` ``` ,------. ,------. ,--. |Client| |Server| |DB| `--+---' `--+---' `+-' | GET /link-preview/thumbnail (media server)| | | ------------------------------------------> | | | | | | Read from user_messages.unfurled_links| | | --------------------------------------> | | | | |----. | | | | Unmarshal JSON | | |<---' | | | | | HTTP Content-Type: image/jpeg/etc | | | <- - - - - - - - - - - - - - - - - - - - - | ,--+---. ,--+---. ,+-. |Client| |Server| |DB| `------' `------' `--' ``` ### Some limitations of the current implementation The following points will become separate issues in status-go that I'll work on over the next couple weeks. In no order of importance: - Improve how multiple links are fetched; retries on failure and testing how unfurling behaves around the timeout limits (deterministically, not by making real HTTP calls as I did). https://github.com/status-im/status-go/issues/3498 - Unfurl favicons and store them in the protobuf too. - For this PR, I added unfurling support only for websites with OpenGraph https://ogp.me/ meta tags. Other unfurlers will be implemented on demand. The next one will probably be for oEmbed https://oembed.com/, the protocol supported by YouTube, for example. - Resize and/or compress thumbnails (and favicons). Often times, thumbnails are huge for the purposes of link previews. There is already support for compressing JPEGs in status-go, but I prefer to work with compression in a separate PR because I'd like to also solve the problem for PNGs (probably convert them to JPEGs, plus compress them). This would be a safe choice for thumbnails, favicons not so much because transparency is desirable. - Editing messages is not yet supported. - I haven't coded any artificial limit on the number of previews or on the size of the thumbnail payload. This will be done in a separate issue. I have heard the ideal solution may be to split messages into smaller chunks of ~125 KiB because of libp2p, but that might be too complicated at this stage of the product (?). - Link preview deletion. - For the moment, OpenGraph metadata is extracted by requesting data for the English language (and fallback to whatever is available). In the future, we'll want to unfurl by respecting the user's local device language. Some websites, like GoDaddy, are already localized based on the device's IP, but many aren't. - The website's description text should be limited by a certain number of characters, especially because it's outside our control. Exactly how much has not been decided yet, so it'll be done separately. - URL normalization can be tricky, so I implemented only the basics to help with caching. For example, the url https://status.im and HTTPS://status.im are considered identical. Also, a URL is considered valid for unfurling if its TLD exists according to publicsuffix.EffectiveTLDPlusOne. This was essential, otherwise the default Go url.Parse approach would consider many invalid URLs valid, and thus the server would waste resources trying to unfurl the unfurleable. ### Other requirements - If the message is edited, the link previews should reflect the edited text, not the original one. This has been aligned with the design team as well. - If the website's thumbnail or the favicon can't be fetched, just ignore them. The only mandatory piece of metadata is the website's title and URL. - Link previews in clients should be generated in near real-time, that is, as the user types, previews are updated. In mobile this performs very well, and it's what other clients like WhatsApp, Telegram, and Facebook do. ### Decisions - While the user typing in the input field, the client is constantly (debounced) asking status-go to parse the text and extract normalized URLs and then the client checks if they're already in its in-memory cache. If they are, no RPC call is made. I chose this approach to achieve the best possible performance in mobile and avoid the whole RPC overhead, since the chat experience is already not smooth enough. The mobile client uses URLs as cache keys in a hashmap, i.e. if the key is present, it means the preview is readily available (naive, but good enough for now). This decision also gave me more flexibility to find the best UX at this stage of the feature. - Due to the requirement that users should be able to see independent loading indicators for each link preview, when status-go can't unfurl a URL, it doesn't return it in the response. - As an initial implementation, I added the BLOB column unfurled_links to the user_messages table. The preview data is then serialized as JSON before being stored in this column. I felt that creating a separate table and the related code for this initial PR would be inconvenient. Is that reasonable to you? Once things stabilize I can create a proper table if we want to avoid this kind of solution with serialized columns. |
||
|---|---|---|
| .. | ||
| anonmetrics | ||
| audio | ||
| common | ||
| communities | ||
| datasync | ||
| discord | ||
| encryption | ||
| ens | ||
| identity | ||
| internal/sqlite | ||
| linkpreview | ||
| migrations | ||
| protobuf | ||
| pushnotificationclient | ||
| pushnotificationserver | ||
| requests | ||
| sqlite | ||
| subscription | ||
| transport | ||
| tt | ||
| urls | ||
| v1 | ||
| verification | ||
| wakusync | ||
| zaputil | ||
| LICENSE | ||
| README.md | ||
| activity_center.go | ||
| activity_center_persistence.go | ||
| activity_center_persistence_test.go | ||
| chat.go | ||
| chat_group_proxy.go | ||
| chat_test.go | ||
| communities_messenger_test.go | ||
| contact.go | ||
| contact_test.go | ||
| delete_message.go | ||
| edit_message.go | ||
| emoji_reaction.go | ||
| errors.go | ||
| group_chat_invitation.go | ||
| group_chat_system_messages.go | ||
| identity_images.go | ||
| local_notifications.go | ||
| message_builder.go | ||
| message_persistence.go | ||
| message_validator.go | ||
| message_validator_test.go | ||
| messenger.go | ||
| messenger_activity_center.go | ||
| messenger_activity_center_test.go | ||
| messenger_auto_message.go | ||
| messenger_backup.go | ||
| messenger_backup_handler.go | ||
| messenger_backup_test.go | ||
| messenger_base_test.go | ||
| messenger_bookmarks.go | ||
| messenger_browsers.go | ||
| messenger_browsers_test.go | ||
| messenger_chats.go | ||
| messenger_collapsed_community_categories.go | ||
| messenger_collapsed_community_categories_test.go | ||
| messenger_communities.go | ||
| messenger_config.go | ||
| messenger_contact_requests_test.go | ||
| messenger_contact_update_test.go | ||
| messenger_contact_verification.go | ||
| messenger_contact_verification_test.go | ||
| messenger_contacts.go | ||
| messenger_delete_message_for_everyone_test.go | ||
| messenger_delete_message_for_me_test.go | ||
| messenger_delete_message_test.go | ||
| messenger_discv5.go | ||
| messenger_edit_message_test.go | ||
| messenger_emoji_test.go | ||
| messenger_ens.go | ||
| messenger_group_chat.go | ||
| messenger_group_chat_test.go | ||
| messenger_handler.go | ||
| messenger_handler_test.go | ||
| messenger_identity.go | ||
| messenger_identity_image_test.go | ||
| messenger_installations_test.go | ||
| messenger_keycard.go | ||
| messenger_mailserver.go | ||
| messenger_mailserver_cycle.go | ||
| messenger_mailserver_processMailserverBatch_test.go | ||
| messenger_maps.go | ||
| messenger_mention.go | ||
| messenger_mention_test.go | ||
| messenger_messages.go | ||
| messenger_mute_test.go | ||
| messenger_peers.go | ||
| messenger_pin_message_test.go | ||
| messenger_pin_messages.go | ||
| messenger_reply_test.go | ||
| messenger_response.go | ||
| messenger_response_test.go | ||
| messenger_saved_address.go | ||
| messenger_send_images_album_test.go | ||
| messenger_share_image_test.go | ||
| messenger_status_updates.go | ||
| messenger_status_updates_test.go | ||
| messenger_switcher_cards.go | ||
| messenger_sync_bookmark_test.go | ||
| messenger_sync_chat_test.go | ||
| messenger_sync_clear_history_test.go | ||
| messenger_sync_keycard_change_test.go | ||
| messenger_sync_keycards_state_test.go | ||
| messenger_sync_profile_picture_test.go | ||
| messenger_sync_raw_messages.go | ||
| messenger_sync_saved_addresses_test.go | ||
| messenger_sync_settings.go | ||
| messenger_sync_settings_test.go | ||
| messenger_sync_verification_test.go | ||
| messenger_sync_wallets_test.go | ||
| messenger_test.go | ||
| messenger_walletconnect.go | ||
| messenger_walletconnect_test.go | ||
| persistence.go | ||
| persistence_collapsed_community_categories.go | ||
| persistence_test.go | ||
| push_notification_test.go | ||
| status_update.go | ||
| switcher_card.go | ||
| transaction_validator.go | ||
| transaction_validator_test.go | ||
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.gois the main file which exportsMessengerstruct. 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 byMessengeras 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.