BLIP Protocol Decoder for DarkRide

Decodes BLIP (Couchbase Sync Gateway) WebSocket frames in the DarkRide traffic inspector.

BLIP is the binary protocol used by Couchbase Lite to synchronise data with Couchbase Sync Gateway over WebSocket connections. This plugin decodes BLIP frames into human-readable messages showing request/response types, properties, and bodies.

Features

• Detects BLIP via the Sec-WebSocket-Protocol header
• Decodes MSG, RPY, ERR, and ACK frame types
• Reassembles multi-frame messages (fragmentation)
• Decompresses shared-context deflate streams
• Parses BLIP properties (Profile, Content-Type, etc.)
• Displays decoded messages in the traffic inspector's WebSocket tab

Install

From the DarkRide host:

• Via the Marketplace UI — open /ui/marketplace, find "BLIP (Couchbase Sync Gateway) Decoder", click Install, then click Restart Server when prompted.
• Via the CLI — darkride plugin install @darkrideapp/plugin-blip-decoder then restart the server.

The decoder activates automatically as soon as a captured WebSocket connection's Sec-WebSocket-Protocol header contains BLIP.

Development

git clone https://github.com/DarkRideApp/plugin-blip-decoder.git
cd plugin-blip-decoder
npm install
npm test
npm run build

To test against a local DarkRide checkout, drop this repo into the host's plugins/ directory; the host's Vite glob picks it up as an in-tree workspace plugin and HMR works through npm run dev.

Publishing

Tag and push to main; the GitHub Actions workflow publishes to npm on every v* tag. After publish, bump the plugin registry's latestVersion so the host UI offers the new version.

License

MIT