feat: Add XEP-0231 Bits of Binary support #3922

sreeshanth-soma · 2026-01-26T11:14:10Z

Summary

Implements XEP-0231: Bits of Binary, enabling Converse.js to receive and display inline binary data such as custom smileys from clients like Pidgin.
Closes #3611

Implementation

New `converse-bob` Plugin

In-memory cache with TTL and max-age expiration
API: api.bob.get(), api.bob.store(), api.bob.has()
IQ handling: Fetches uncached BOB data via <iq type="get">
Message parsing: Extracts <data xmlns="urn:xmpp:bob"> elements
Disco feature: Registers urn:xmpp:bob
Security: Image MIME types only, 8KB size limit per spec

Test Results

TOTAL: 94 SUCCESS

New Tests (7)

Cache storage, retrieval, expiration
Size and MIME validation
Message parsing and IQ requests
Error handling

Capability Hash

Adding urn:xmpp:bob updates XEP-0115 verification string from 1T0pIfIxYO645OaT9gpXVXOvb9s= to ZXDrJD54GWZYlZif9IuMxum/u+g=

jcbrand · 2026-01-29T20:38:09Z

src/headless/plugins/bob/plugin.js

+import _converse from '../../shared/_converse.js';
+import log from '@converse/log';
+
+const { Strophe, $iq } = converse.env;


Please pay attention to these security bot messages.

src/headless/plugins/bob/plugin.js

jcbrand

Thanks for your pull request @sreeshanth-soma

You noted that the headless tests failed, but there are also non-headless tests which now fail due to the new urn:xmpp:bob feature supported.

Please fix those as well.

- Add converse-bob plugin for receiving BOB images (custom smileys) - Implements cache, API, IQ handling, and message parsing - Register urn:xmpp:bob disco feature - Add comprehensive test suite (7 tests) - Update capability hashes for new feature

Update XEP-0115 entity capability verification hashes in test files to account for the added urn:xmpp:bob feature. Headless tests now use: 9zuZdgDXVE0fkcAjeaokq9JxHJw= Non-headless tests now use: KjyaPNsNXajTrXVlYimRsIvje2g= RAI tests now use: 3Tday6wfQnY1R8zGPMO3CBYFrik=

sreeshanth-soma · 2026-01-27T12:59:25Z

Hello @jcbrand . I've addressed your feedback. The non-headless tests that were failing due to the urn:xmpp:bob feature have been fixed:

Updated all capability hashes in the non-headless test files
Added TypeScript type definitions for the BOB plugin
All tests are now passing locally (matching upstream/master behavior). Ready for re-review!

jcbrand

Thanks @sreeshanth-soma, please see my review comments.

jcbrand · 2026-01-29T06:33:57Z

src/headless/plugins/bob/plugin.js

+const MAX_BOB_SIZE = 8192;
+
+// In-memory cache for BOB data
+const bob_cache = new Map();


I'm not convinced that an in-memory cache is the right way to go here.

Every time you reload the tab the cache will be wiped and then you lose all the images.
If you then try to refetch the images, you might not get all of them due to the sender being offline.

So instead, we should probably create a persistent collection of BOB images, similar to what we do with VCards: https://github.com/conversejs/converse.js/blob/master/src/headless/plugins/vcard/vcards.js

Thanks for the feedback! I've replaced the in-memory Map with a persistent Skeletor Collection, following the VCards pattern:

Created bob.js model with isExpired() and getBlobURL() methods.

Created bobs.js collection using initStorage() for IndexedDB persistence

Collection is initialized on connected event and cleaned up on clearSession

BOB images now persist across page reloads and remain available even if the sender goes offline.

jcbrand · 2026-01-29T06:37:49Z

src/shared/texture/texture.js

+     * @param {number} offset - The index of the passed in text relative to
+     *  the start of the message body text.
+     */
+    async addBOBImages(text, offset) {


This function should go into a bob-views plugin and then in that plugin you should listen for the afterMessageBodyTransformed event in order to call this function.

See here:

converse.js/src/plugins/omemo-views/index.js

Line 34 in 0ea38d7

api.listen.on('afterMessageBodyTransformed', handleEncryptedFiles);

Done! Created a new bob-views plugin that:

Listens to afterMessageBodyTransformed event (following the omemo-views pattern)

Moved the BOB image handling logic from texture.js to the new plugin

Registered it in src/index.js and added to VIEW_PLUGINS whitelist

This properly separates the headless BOB storage from the view-layer rendering.

…ugin

src/shared/texture/texture.js

 import { until } from "lit/directives/until.js";
 import { Directive, directive } from "lit/directive.js";
 import { api, u } from "@converse/headless";
+import log from "@converse/log";


jcbrand · 2026-01-29T20:33:29Z

src/headless/plugins/bob/bob.js

+            const binary = atob(data);
+            const bytes = new Uint8Array(binary.length);
+            for (let i = 0; i < binary.length; i++) {
+                bytes[i] = binary.charCodeAt(i);
+            }


Suggested change

const binary = atob(data);

const bytes = new Uint8Array(binary.length);

for (let i = 0; i < binary.length; i++) {

bytes[i] = binary.charCodeAt(i);

}

const bytes = Uint8Array.from(atob(data), c => c.charCodeAt(0));

jcbrand · 2026-01-29T20:35:09Z

src/headless/plugins/bob/bobs.js

+        await this.fetchBOBs();
+
+        // Clean up expired entries
+        this.cleanupExpired();


Please remove comments like this. It's already clear from the code what's happening.

jcbrand · 2026-01-29T20:36:46Z

src/headless/plugins/bob/bobs.js

+        const expired = this.filter((bob) => bob.isExpired());
+        expired.forEach((bob) => bob.destroy());


Suggested change

const expired = this.filter((bob) => bob.isExpired());

expired.forEach((bob) => bob.destroy());

this.forEach((bob) => if (bob.isExpired()) bob.destroy());

jcbrand · 2026-01-29T20:38:09Z

src/headless/plugins/bob/plugin.js

+import _converse from '../../shared/_converse.js';
+import log from '@converse/log';
+
+const { Strophe, $iq } = converse.env;


Please pay attention to these security bot messages.

jcbrand · 2026-01-29T20:39:44Z

src/headless/plugins/bob/plugin.js

+const { Strophe, $iq } = converse.env;
+
+// Maximum size for BOB data (8KB as per XEP-0231)
+const MAX_BOB_SIZE = 8192;


I think this can be made configurable.

Where you init the plugin:

// Configure plugin settings api.settings.extend({ max_bob_size: 8192 });

jcbrand · 2026-01-29T20:40:20Z

src/headless/plugins/bob/plugin.js

+
+        // Export classes
+        const exports = { BOB, BOBs };
+        Object.assign(_converse, exports); // XXX DEPRECATED


Please don't add deprecated lines to new files.

jcbrand · 2026-01-29T20:40:51Z

src/headless/plugins/bob/plugin.js

+        Object.assign(_converse, exports); // XXX DEPRECATED
+        Object.assign(_converse.exports, exports);
+
+        // Register namespace


Unnecessary comment

jcbrand · 2026-01-29T20:46:19Z

src/shared/chat/message-body.js

            media_urls: this.model.get('media_urls'),
            mentions: this.model.get('references'),
            nick: this.model.chatbox.get('nick'),
+            from_jid: this.model.get('from'),


This line is no longer necessary

jcbrand · 2026-01-29T20:47:13Z

src/shared/texture/texture.js

     *  which create new Texture instances (as happens with XEP-393 styling directives).
     * @param {Object} [options]
     * @param {string} [options.nick] - The current user's nickname (only relevant if the message is in a XEP-0045 MUC)
+     * @param {string} [options.from_jid] - The JID of the message sender (needed for fetching BOB images)


The changes in this file are no longer necessary. Please look through your changes yourself before asking me to review. You could easily have seen this.

jcbrand · 2026-01-29T20:51:07Z

src/headless/plugins/bob/plugin.js

+                    if (!bob) return false;
+
+                    if (bob.isExpired()) {
+                        bob.destroy();


I don't think calling has should have the side effect of deleting expired blobs.

If should return true, even if the blob is expired.

Instead you can use setInterval to call a function every 10 minutes, to check for expired blobs and then delete them.

…eanup Use configurable max_bob_size setting, add setInterval for expired blob cleanup, and update test fixtures for new caps hashes

sreeshanth-soma mentioned this pull request Jan 26, 2026

XEP-0231: Bits of Binary - for custom smileys and CAPTCHA #3611

Open

github-advanced-security bot found potential problems Jan 26, 2026

View reviewed changes

jcbrand requested changes Jan 26, 2026

View reviewed changes

sreeshanth-soma added 2 commits January 27, 2026 01:59

sreeshanth-soma force-pushed the xep-0231-bits-of-binary branch from 06c6529 to 6deb51b Compare January 27, 2026 02:14

sreeshanth-soma added 2 commits January 27, 2026 09:47

fix: Make message-images test null-safe to prevent intermittent failures

bc9c335

chore: Add TypeScript type definitions for BOB plugin

b2ab10a

sreeshanth-soma requested a review from jcbrand January 28, 2026 06:59

jcbrand requested changes Jan 29, 2026

View reviewed changes

refactor(bob): use persistent collection storage and add bob-views pl…

1a7018f

…ugin

sreeshanth-soma requested a review from jcbrand January 29, 2026 07:53

Merge branch 'conversejs:master' into xep-0231-bits-of-binary

2a03f11

github-advanced-security bot found potential problems Jan 29, 2026

View reviewed changes

jcbrand requested changes Jan 29, 2026

View reviewed changes

refactor(bob): simplify BOB plugin implementation and add periodic cl…

de4ff0e

…eanup Use configurable max_bob_size setting, add setInterval for expired blob cleanup, and update test fixtures for new caps hashes

sreeshanth-soma requested a review from jcbrand January 29, 2026 22:18

		const expired = this.filter((bob) => bob.isExpired());
		expired.forEach((bob) => bob.destroy());

	const expired = this.filter((bob) => bob.isExpired());
	expired.forEach((bob) => bob.destroy());
	this.forEach((bob) => if (bob.isExpired()) bob.destroy());

Uh oh!

feat: Add XEP-0231 Bits of Binary support #3922

Are you sure you want to change the base?

feat: Add XEP-0231 Bits of Binary support #3922

Uh oh!

Conversation

sreeshanth-soma commented Jan 26, 2026

Summary

Implementation

New converse-bob Plugin

Test Results

New Tests (7)

Capability Hash

Uh oh!

Check notice

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jcbrand left a comment

Choose a reason for hiding this comment

Uh oh!

sreeshanth-soma commented Jan 27, 2026

Uh oh!

jcbrand left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Check notice

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

New `converse-bob` Plugin