nandi/frqpublic Fork 0
ab83b42c62ecdf8ed290f736dac46a7945d8690f
Commits
Clone
git clone https://git.rickub.com/nandi/frq.git
git clone ssh://git@rickub.com/nandi/frq.git

Host key fingerprint (ed25519): SHA256:iycHnxEyq0Q7uyVpB7JlznP0G7JrTPXLYRcAU5CSLhc — verify it before your first connect.

README.md · 238 lines · 12.1 KBmarkdown Blame HistoryRaw
A freeq client in jolt, as glimmer components on Vidya 4719d6f nandi 21d ago1# frq
2
3A **[freeq](https://github.com/codegod100/freeq)** client written in
4**[jolt](https://github.com/jolt-lang/jolt)**, as
5[glimmer](https://github.com/jolt-lang/glimmer) components painted by
6**[Vidya](https://tangled.org/nandi.uk/vidya)**/egui.
7
8It is a proof of concept port of [sleek](../sleek), which is the same client in
9Rust against egui directly. The screens are sleek's — connect, chats, chat,
10discover, settings, under a tab bar — but each is hiccup over glimmer's widget
11tags rather than immediate-mode drawing code, and state lives in ratoms instead
12of an `AppState` struct.
13
14```
Sign in with Bluesky OAuth, through freeq's broker 2d4a377 nandi 21d ago15src/frq/atproto.jolt handle → DID → PDS → session, and the SASL payloads
16src/frq/oauth.jolt the broker flow: login URL, loopback capture, /session
Remember an OAuth sign-in across restarts 4aa71e7 nandi 21d ago17src/frq/store.jolt the saved sign-in, mode 600 in the config directory
Show who is talking, with their Bluesky picture f5548bd nandi 20d ago18src/frq/avatars.jolt profile pictures, by DID or handle
Copy sleek's profiles b79ebc4 nandi 20d ago19src/frq/profile.jolt who someone is: the Bluesky profile behind a nick
Show the pictures people paste 56cdac3 nandi 20d ago20src/frq/media.jolt image links: spot them, fetch them once, cache on disk
Send a picture by pasting it 8a491ba nandi 20d ago21src/frq/upload.jolt a pasted picture to freeq's media endpoint, as multipart
Calls f31ad3d nandi 20d ago22src/frq/av.jolt calls: the signaling, and a handle on the media plane
Say when each thing was said dbf3b86 nandi 20d ago23src/frq/clock.jolt the reader's own zone, twelve-hour times, day headings
Pick any emoji, in colour 18c5ccd nandi 20d ago24src/frq/emoji.jolt the picker's catalog: every drawable emoji and its name
Sign in with a Bluesky identity 5192124 nandi 21d ago25src/frq/irc.jolt IRC over TLS or TCP: parser, reader thread, SASL, PRIVMSG
A freeq client in jolt, as glimmer components on Vidya 4719d6f nandi 21d ago26src/frq/state.jolt the ratoms every screen reads, and `apply-msg!`
27src/frq/app.jolt the screens
28```
29
Stop mistaking a quiet connection for a closed one a225fb1 nandi 20d ago30## Tracing
31
32`FRQ_TRACE=1` prints every IRC line sent and received to stderr, which on
33Android is logcat.
34
A freeq client in jolt, as glimmer components on Vidya 4719d6f nandi 21d ago35## Running
36
Take both native libraries from one place a66d1c1 nandi 20d ago37Both native libraries, then the app:
A freeq client in jolt, as glimmer components on Vidya 4719d6f nandi 21d ago38
39```bash
40just lib
41just run
42```
43
Take every jolt-native half from the release, and only from there a008d3b nandi 19d ago44`just lib` fetches both shared objects this client loads —
45[jolt-native](https://gitlab.com/nandithebull/jolt-native)'s `libvidya`, the
46retained-tree ABI glimmer paints through, and `libjoltmoq`, the AV media plane
47— out of that project's release, by the digests in `scripts/*.dotslash`, and
48links them into `build/lib`. Nothing is compiled: no Rust toolchain, and no
49jolt-native checkout beside this one. It needs `patchelf`, and only to name
50libasound in `libjoltmoq.so`, which v0.1.3 does not — see the comment in
51`scripts/lib.bb`; that goes away with the release that links it. `just bump` moves every pin to the
52latest release at once, and `just bump v0.1.2` to a named one.
53
54`just run` is `jolt -M:frq` with `LD_LIBRARY_PATH` pointed at `build/lib`. It
55connects to `irc.freeq.at:6697` over TLS and joins `#test`. Untick TLS on the
56connect screen (or point it at `127.0.0.1`) for a local server's
A freeq client in jolt, as glimmer components on Vidya 4719d6f nandi 21d ago57plain listener:
58
59```bash
60cargo run --release --bin freeq-server # in the freeq checkout
61```
62
Paint the same screens into a terminal ab83b42 nandi 18d ago63## In a terminal
64
65The screens are hiccup over glimmer's reconciler, and the reconciler does not
66know what is under it — so the same tree paints into a terminal through
67jolt-native's `libjolttui`, which exports libvidya's retained-tree ABI over a
68grid of cells instead of a GPU window. `src/frq/tui.jolt` is the whole of what
69that costs on this side: it requires `glimmer-tui.core` after `frq.app`, so the
70backend installed last is the terminal, and seeds a `#tui` buffer so a session
71started for a look at the layout has a conversation in it.
72
73```bash
74just tui # the terminal, until Ctrl-Q
75just tui --headless --cols=90 --rows=60 # one screenshot on stdout
76```
77
78The headless one is `tui_headless` — the same layout and the same painting with
79the writer taken off the end — which is what a screenshot in a bug report or a
80CI check should be.
81
82Two things are unpinned here, because the terminal backend is not in a
83jolt-native release yet: `libjolttui.so` comes out of a jolt-native checkout's
84target directory (`JOLT_NATIVE=…`, or beside this tree), and `glimmer-tui` is
85resolved from the same checkout. Both become pins like every other when it
86ships.
87
88What a terminal has not got, frq does without: pictures, avatars, the lightbox
89and calls draw nothing. And frq's spacing is written in points, for a window —
90`scripts/tui.bb` hands the backend `:points-per-cell 8` so those numbers land
91in cells, but `below-messages` in `src/frq/app.jolt` is point *arithmetic*
92rather than a point *length*, and a scale cannot fix it: it reserves about
93thirteen rows more than the compose bar needs, so the bottom of the backlog is
94pushed out of the list.
95
Sign in with a Bluesky identity 5192124 nandi 21d ago96## Signing in
97
Sign in with Bluesky OAuth, through freeq's broker 2d4a377 nandi 21d ago98Three modes on the connect screen.
Sign in with a Bluesky identity 5192124 nandi 21d ago99
Sign in with Bluesky OAuth, through freeq's broker 2d4a377 nandi 21d ago100**Bluesky** (OAuth, the default way in) follows sleek's flow: frq binds a
101loopback port, puts it in `return_to`, and opens
102`auth.freeq.at/auth/login?handle=…`. The broker runs the OAuth dance with the
103PDS and redirects back to that port with the handoff in the URL *fragment*, so
104it never reaches a server as a query string. The page frq serves there has one
105job: POST the fragment back to itself. What comes back is a single-use SASL
106`web-token` and a durable `broker_token`; later connections mint a fresh token
107from the durable one at `/session` and skip the browser.
Sign in with a Bluesky identity 5192124 nandi 21d ago108
Remember an OAuth sign-in across restarts 4aa71e7 nandi 21d ago109The durable token is saved to `$XDG_CONFIG_HOME/frq/session.edn` (mode 600) so
Connect on launch when an account is remembered 9237cf4 nandi 20d ago110a restart resumes without one, along with the handle and nick it belongs to —
111and it connects on its own at launch when one is there.
Remember an OAuth sign-in across restarts 4aa71e7 nandi 21d ago112The web-token beside it is single-use and deliberately not saved. A token the
113broker no longer honours is dropped — from disk and memory — and the browser
114flow runs once more, rather than failing the same way on every Connect.
115
Sign in with Bluesky OAuth, through freeq's broker 2d4a377 nandi 21d ago116**App password** signs in without a browser, straight to the user's own PDS:
117`resolveHandle` → DID → PDS from the DID document → `createSession`. The
118password goes to that PDS and nowhere else, is never written to disk, and is
119dropped once the session exists.
Sign in with a Bluesky identity 5192124 nandi 21d ago120
Sign in with Bluesky OAuth, through freeq's broker 2d4a377 nandi 21d ago121Either way freeq sees only a token. The SASL mechanism is
122`ATPROTO-CHALLENGE` in both cases — `method: "web-token"`, which the server
123resolves through its own token store, or `method: "pds-session"` with the
124server's nonce echoed back so the token cannot be replayed elsewhere.
125
126A refused sign-in is reported and the connection carries on as a guest.
Sign in with a Bluesky identity 5192124 nandi 21d ago127
A freeq client in jolt, as glimmer components on Vidya 4719d6f nandi 21d ago128## Android
129
Take every jolt-native half from the release, and only from there a008d3b nandi 19d ago130An APK whose native halves come from jolt-native's release and whose Jolt half
131is frq's: `libvidya.so` (the Rust/egui C ABI, which owns the event loop as the
132NativeActivity's own library), `libjoltmoq.so` (the media plane) and
133`libjoltapp.so` (frq compiled to a Chez boot image, linked against both).
A freeq client in jolt, as glimmer components on Vidya 4719d6f nandi 21d ago134
135```bash
Write the build in babashka, and pin the babashka 34832a8 nandi 19d ago136./android/build-apk.bb run # build, install, launch on a connected device
137./android/build-apk.bb log # logcat, filtered
A freeq client in jolt, as glimmer components on Vidya 4719d6f nandi 21d ago138```
139
Take every jolt-native half from the release, and only from there a008d3b nandi 19d ago140Needs an SDK and a cross-built Chez in `~/.cache/vidya-chez-android`; the NDK
141comes down through `scripts/android-ndk.dotslash`. `just apk` builds the same
142APK as a buck2 graph, which is the incremental way in.
A freeq client in jolt, as glimmer components on Vidya 4719d6f nandi 21d ago143
144TLS does not work there: jolt reaches OpenSSL through the dynamic loader, and
145Android has no public `libssl` to load. The connect screen falls back to the
146plain `:6667` listener on its own, which is why the plain transport is the raw
147`socket`/`connect`/`send`/`recv` calls rather than jolt's `java.net.Socket`
148surface — that surface does not work on Android either, while the syscalls do.
149
150## What the PoC covers
151
152* TLS (`:6697`, via jolt.mvn-http's OpenSSL bindings) or plain TCP (`:6667`)
153* Guest connect (`NICK`/`USER`), `001` welcome, `PING`/`PONG` keepalive
154* Auto-joins `#test` on `irc.freeq.at`
155* Join channels, channel buffers with unread counts, send and receive `PRIVMSG`
Ask for the backlog freeq restores channels without 94e59a2 nandi 20d ago156* Backlog on join, and `CHATHISTORY` for the channels freeq restores instead
Say when each thing was said dbf3b86 nandi 20d ago157* Twelve-hour timestamps from the server's own clock, with a heading wherever
158 the day changes
Answer a message, not just read that one was answered 4876db8 nandi 20d ago159* A chip above a reply quoting what it answers, and a click that goes there;
160 ↩ beside a sender to answer them, with `+draft/reply` on the way out
Pick any emoji, in colour 18c5ccd nandi 20d ago161* Emoji reactions: colour pills under a message, ☺ beside the sender to open a
162 picker over every emoji Vidya can draw (popular first, then Unicode's own
163 groups, searchable by name), and a second click on a pill to take yours off
164 — sent as `TAGMSG`, and restored from the server's own tally when the
165 backlog comes back
Show the pictures people paste 56cdac3 nandi 20d ago166* Inline previews for PNG links, fetched once and cached under
Click a picture to see it full size 563ada3 nandi 20d ago167 `$XDG_CACHE_HOME/frq/media`; click one to see it full size
Send a picture by pasting it 8a491ba nandi 20d ago168* Ctrl+V in the draft attaches the picture on the clipboard: it is previewed
169 under the box and uploaded to freeq's media endpoint while you write the line
170 it goes with, and only on the way out does it become the link — which is the
171 whole of what sending an image over IRC means. The draft itself is never
172 written into. Text pastes as text, as it always did: the picture path is the
173 keystroke the field had no text to answer with
A freeq client in jolt, as glimmer components on Vidya 4719d6f nandi 21d ago174* Join/part notices, DMs bucketed under the sender's nick
175* Discover list, search over buffers, disconnect
Remember which rooms this client has been in 1d062fd nandi 20d ago176* The rooms you have opened, remembered across runs and listed in the order
177 you last used them (`$XDG_CONFIG_HOME/frq/channels.edn`)
Order the chat list by what you were last in 75e557e nandi 20d ago178* Conversations listed most recently opened first
Show who is talking, with their Bluesky picture f5548bd nandi 20d ago179* Bluesky avatars beside the sender, resolved from the DID freeq tags each
180 message with
Calls f31ad3d nandi 20d ago181* Calls: a Call button opens one in a channel, a banner offers Join where
182 somebody already has, and in one there is mute, deafen, video and leave. Mute
183 and deafen are separate — a deafened microphone still carries your voice.
184 Whoever turns a camera on appears as a tile; the self-view is labelled You
185 and sits last, where it cannot push a face you are talking to off the row
186
187## Calls
188
189Signaling is IRC and lives here: `+freeq.at/av-start`, `av-join` and `av-leave`
190go out as TAGMSGs and the server broadcasts `+freeq.at/av-state` back, which is
191what actually moves this client's state — a press is optimistic, and the server
192settles it. Losing a race to open a call (`start-collision`) is answered by
193joining the call that won rather than by reporting an error, since the person
194asked to be in a call in that room and there is one.
195
196Media is not IRC and is not here. Audio and video ride MoQ — Media over QUIC —
197through freeq's SFU, and that is `libjoltmoq`: Opus, H.264, capture and
198transport, lifted out of sleek rather than written a second time in jolt.
199`src/frq/av.jolt` is the whole of what frq says to it, and two of its rules
200shape this side:
201
202* **Nothing calls back.** Status and video are polled, drained by a timer that
203 glimmer runs on the loop thread — the only thread allowed to touch a node.
204* **A frame is borrowed.** The decoder's own buffer is handed to Vidya as a
205 pointer and painted by an `:image` with a `:feed`. The pixels never become a
206 jolt value and are never copied on this side, which is the only way thirty
207 frames a second is affordable here.
208
209The SFU is dialled once the server has minted a token, not when we ask to join:
210a remote SFU refuses a connection without one, and the MoQ client then retries
211in a loop that looks exactly like a hang.
A freeq client in jolt, as glimmer components on Vidya 4719d6f nandi 21d ago212
213## Limits
214
215* **TLS and plain TCP only** — no WebSocket, no iroh. On Android, plain only.
Sign in with Bluesky OAuth, through freeq's broker 2d4a377 nandi 21d ago216* **No `did:key` signing, no credential gates, no E2EE.** Sign-in of either
217 kind needs TLS, so it is desktop-only — the Android build connects as a
218 guest.
Remember an OAuth sign-in across restarts 4aa71e7 nandi 21d ago219* **Only the broker token is persisted**, and only for OAuth. An app-password
220 sign-in is not remembered.
Show the pictures people paste 56cdac3 nandi 20d ago221* **Previews are PNG only** — the tree backend's decoder reads no other
222 format, and a fetch needs TLS, so the phone shows links. The link is left in
223 place either way.
224* **Nothing evicts the media cache.**
Calls f31ad3d nandi 20d ago225* **Calls are desktop-only.** `libjoltmoq` is not built for Android here, and
226 the camera and microphone paths that are would still need the runtime
227 permissions the APK does not ask for.
228* **One call at a time**, which is the media plane's rule and the microphone's.
229* **No call is offered in a DM** — freeq's AV signaling is a channel's.
Send a picture by pasting it 8a491ba nandi 20d ago230* **Pasting a picture needs a sign-in and a desktop.** The upload is filed
231 under the DID of a live session, so a guest cannot make one; and it is read
232 off the clipboard through the ABI's `vidya_clipboard_image_png`, which
233 arboard backs on desktop and nothing backs on Android. It also shares
234 nothing to your PDS and posts nothing to Bluesky — those fields are opt-in
235 and this client does not send them.
Calls f31ad3d nandi 20d ago236* **No scrollback trimming or threads.**
Stop mistaking a quiet connection for a closed one a225fb1 nandi 20d ago237* A sent line waits up to 200ms for the reader thread to flush it.
A freeq client in jolt, as glimmer components on Vidya 4719d6f nandi 21d ago238* Message lists are keyed vboxes; glimmer-vidya has no `:listbox` yet.