Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
436726dc57 |
@@ -180,7 +180,7 @@ For users who want to access the same session from multiple devices:
|
||||
- **Set password via IRC PASS command**: the authenticated client sends
|
||||
`POST /api/v1/messages` with `{"command":"PASS","body":["mypassword"]}`. The
|
||||
server hashes the password with bcrypt and stores it on the session. Password
|
||||
must be 8 to 72 bytes.
|
||||
must be at least 8 characters.
|
||||
- **Login from another client**: `POST /api/v1/login` with nick and password →
|
||||
server verifies the password, creates a new client for the existing session,
|
||||
and sets an auth cookie. Channel memberships are shared; the new client gets
|
||||
@@ -268,15 +268,10 @@ rules). Case-sensitive comparison is unambiguous.
|
||||
A single user session can have multiple clients (phone, laptop, terminal).
|
||||
|
||||
- Each client gets a **separate server-to-client (S2C) message queue**.
|
||||
- The server fans out messages and events from other users to every client queue
|
||||
for that user session.
|
||||
- When the user sends a `PRIVMSG`, `NOTICE`, `JOIN`, `PART`, `NICK`, `TOPIC`,
|
||||
`MODE` or `KICK` from one of its clients, the resulting event goes to every
|
||||
client queue of the user's own session, as well as to the other users it is
|
||||
meant for. The one exception is an IRC listener connection that sent the
|
||||
command, which gets nothing queued for it: it has already sent its user the
|
||||
echo, or, for `PRIVMSG` and `NOTICE`, IRC sends none.
|
||||
- Replies to a command (numerics) go only to the client that sent it.
|
||||
- The server fans out messages and events from other users, and the user's own
|
||||
DMs and the channel messages it sends over the HTTP API, to every client queue
|
||||
for that user session. Replies to a command (numerics) go only to the client
|
||||
that sent it.
|
||||
- `GET /api/v1/messages` delivers from the calling client's specific queue,
|
||||
identified by the auth cookie.
|
||||
- Client queues have **independent expiry/pruning** — one client going offline
|
||||
@@ -749,7 +744,7 @@ Leave a channel.
|
||||
{"command": "PART", "to": "#general", "body": ["goodbye"]}
|
||||
```
|
||||
|
||||
**S2C (broadcast to all channel members, including the departing user):**
|
||||
**S2C (broadcast to the other channel members):**
|
||||
|
||||
```json
|
||||
{
|
||||
@@ -765,8 +760,9 @@ Leave a channel.
|
||||
|
||||
**Behavior:**
|
||||
|
||||
- The PART event goes to every channel member, the departing user's own clients
|
||||
included. (An IRC listener connection that sends a PART echoes it itself.)
|
||||
- The PART event goes to the other channel members, not to the departing user;
|
||||
the HTTP response confirms the part. (The IRC listener echoes the PART to its
|
||||
own connection.)
|
||||
- If the channel is empty after the user leaves, the channel is **deleted**
|
||||
(ephemeral channels).
|
||||
- If the user is not in the channel, the server returns an error.
|
||||
@@ -839,11 +835,10 @@ Set a password on the current session, enabling multi-client login via
|
||||
|
||||
**Behavior:**
|
||||
|
||||
- `body[0]` is the password. Must be 8 to 72 bytes; bcrypt cannot hash a longer
|
||||
one.
|
||||
- `body[0]` is the password. Must be at least 8 characters.
|
||||
- On success, the server responds with `{"status": "ok"}`.
|
||||
- If the password is too short, too long or missing, the server sends
|
||||
ERR_NEEDMOREPARAMS (461) via the message queue.
|
||||
- If the password is too short or missing, the server sends ERR_NEEDMOREPARAMS
|
||||
(461) via the message queue.
|
||||
- Calling PASS again overwrites the previous password.
|
||||
- Once a password is set, `POST /api/v1/login` can be used with the nick and
|
||||
password to create additional clients on the same session.
|
||||
@@ -1023,8 +1018,9 @@ On the IRC listener, `MODE #channel <modes> [values...]` takes several letters
|
||||
in one string, e.g. `MODE #general +mt-i` or `MODE #general +ov alice bob`. It
|
||||
accepts `i`, `m`, `n`, `s`, `t`, `o` and `v` (with a nick) and `H` (with bits
|
||||
from 1 to 40 when setting), but not `b`, `k` or `l`. A letter whose value is
|
||||
missing is skipped. The changes made are sent to every channel member as one
|
||||
`MODE` line, e.g. `+o-v alice bob`; the operator gets that line once.
|
||||
missing is skipped. The changes made are echoed to the operator's connection and
|
||||
also sent to every channel member, the operator included, as one `MODE` line,
|
||||
e.g. `+o-v alice bob`.
|
||||
|
||||
**Channel errors:**
|
||||
|
||||
@@ -2682,11 +2678,9 @@ IRC_LISTEN_ADDR: ""
|
||||
|
||||
- **Wire format**: CR-LF delimited lines, max 512 bytes per line
|
||||
- **Connection registration**: Clients must send `NICK` and `USER` to register.
|
||||
An optional `PASS` before registration sets the session password (8 to 72
|
||||
bytes); one outside that range is refused with a `NOTICE` once registration
|
||||
completes, as `PASS` after registration is. Registering creates a session
|
||||
without a hashcash stamp; closing the connection ends the session, as `QUIT`
|
||||
does.
|
||||
An optional `PASS` before registration sets the session password (minimum 8
|
||||
characters). Registering creates a session without a hashcash stamp; closing
|
||||
the connection ends the session, as `QUIT` does.
|
||||
- **PING**: a connection that sends nothing for 90 seconds is sent a `PING`, and
|
||||
is closed if it sends nothing in the 30 seconds after that; any line, such as
|
||||
the client's `PONG`, starts both waits again.
|
||||
@@ -2723,9 +2717,7 @@ Each line of a multi-line `body` reaches an IRC listener user as its own
|
||||
is sent, so it cannot start a line of its own. A mode change made over the HTTP
|
||||
API reaches IRC listener members as an IRC `MODE` line with its value as a
|
||||
separate parameter, e.g. `MODE #general +k secretpass` or
|
||||
`MODE #general +o bob`. An `INVITE` from either transport reaches the invited
|
||||
IRC listener user as an IRC `INVITE` line from the inviter, e.g.
|
||||
`:alice!alice@* INVITE bob #general`.
|
||||
`MODE #general +o bob`.
|
||||
|
||||
### Docker Usage
|
||||
|
||||
@@ -3169,13 +3161,12 @@ creating one session pays once and keeps their session.
|
||||
### Why Hashcash and Not Rate Limits?
|
||||
|
||||
- **Little state to track**: No IP tables, no token buckets, no sliding windows.
|
||||
The server hashes the stamp and remembers the stamps already spent.
|
||||
The server verifies a single hash and remembers the stamps already spent.
|
||||
- **Works through NATs and proxies**: Doesn't punish shared IPs (university
|
||||
campuses, corporate networks, Tor exits). Every client computes their own
|
||||
proof independently.
|
||||
- **Cost falls on the requester**: The server's verification cost is constant
|
||||
regardless of difficulty: at most two SHA-256 hashes of the stamp per session
|
||||
request, one to check it and one to spend it. Only the client does more work.
|
||||
(one SHA-256 hash) regardless of difficulty. Only the client does more work.
|
||||
- **Fits the "no accounts" philosophy**: Proof-of-work is the cost of entry. No
|
||||
registration, no email, no phone number, no CAPTCHA. Just compute.
|
||||
- **Language-agnostic**: SHA-256 is available in every programming language. The
|
||||
|
||||
+46
-22
@@ -96,7 +96,20 @@ func (a *App) handleInput(text string) {
|
||||
a.ui.AddStatus(
|
||||
"[red]Send error: " + err.Error(),
|
||||
)
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
timestamp := time.Now().Format(timeFormat)
|
||||
|
||||
a.mu.Lock()
|
||||
nick := a.nick
|
||||
a.mu.Unlock()
|
||||
|
||||
a.ui.AddLine(target, fmt.Sprintf(
|
||||
"[gray]%s [green]<%s>[white] %s",
|
||||
timestamp, nick, text,
|
||||
))
|
||||
}
|
||||
|
||||
func (a *App) handleCommand(text string) {
|
||||
@@ -288,6 +301,9 @@ func (a *App) cmdJoin(channel string) {
|
||||
a.mu.Unlock()
|
||||
|
||||
a.ui.SwitchToBuffer(channel)
|
||||
a.ui.AddLine(channel,
|
||||
"[yellow]*** Joined "+channel,
|
||||
)
|
||||
a.ui.SetStatus(nick, channel, "connected")
|
||||
}
|
||||
|
||||
@@ -322,6 +338,10 @@ func (a *App) cmdPart(channel string) {
|
||||
return
|
||||
}
|
||||
|
||||
a.ui.AddLine(channel,
|
||||
"[yellow]*** Left "+channel,
|
||||
)
|
||||
|
||||
a.mu.Lock()
|
||||
if a.target == channel {
|
||||
a.target = ""
|
||||
@@ -348,6 +368,7 @@ func (a *App) cmdMsg(args string) {
|
||||
|
||||
a.mu.Lock()
|
||||
connected := a.connected
|
||||
nick := a.nick
|
||||
a.mu.Unlock()
|
||||
|
||||
if !connected {
|
||||
@@ -365,7 +386,16 @@ func (a *App) cmdMsg(args string) {
|
||||
a.ui.AddStatus(fmt.Sprintf(
|
||||
"[red]Send failed: %v", err,
|
||||
))
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
timestamp := time.Now().Format(timeFormat)
|
||||
|
||||
a.ui.AddLine(target, fmt.Sprintf(
|
||||
"[gray]%s [green]<%s>[white] %s",
|
||||
timestamp, nick, text,
|
||||
))
|
||||
}
|
||||
|
||||
func (a *App) cmdQuery(nick string) {
|
||||
@@ -727,7 +757,7 @@ func (a *App) handleServerMessage(msg *api.Message) {
|
||||
case irc.CmdJoin:
|
||||
a.handleJoinEvent(msg, timestamp)
|
||||
case irc.CmdPart:
|
||||
a.handlePartEvent(msg, timestamp, myNick)
|
||||
a.handlePartEvent(msg, timestamp)
|
||||
case irc.CmdQuit:
|
||||
a.handleQuitEvent(msg, timestamp)
|
||||
case irc.CmdNick:
|
||||
@@ -755,10 +785,12 @@ func (a *App) handlePrivmsgEvent(
|
||||
lines := msg.BodyLines()
|
||||
text := strings.Join(lines, " ")
|
||||
|
||||
// A direct message shows in the buffer of the other user:
|
||||
// the recipient of one the user sent, else the sender.
|
||||
if msg.From == myNick {
|
||||
return
|
||||
}
|
||||
|
||||
target := msg.To
|
||||
if !strings.HasPrefix(target, "#") && msg.From != myNick {
|
||||
if !strings.HasPrefix(target, "#") {
|
||||
target = msg.From
|
||||
}
|
||||
|
||||
@@ -781,11 +813,8 @@ func (a *App) handleJoinEvent(
|
||||
))
|
||||
}
|
||||
|
||||
// handlePartEvent shows a part in the channel's buffer. The
|
||||
// user's own part does not mark the channel unread: the user
|
||||
// has just left it.
|
||||
func (a *App) handlePartEvent(
|
||||
msg *api.Message, timestamp, myNick string,
|
||||
msg *api.Message, timestamp string,
|
||||
) {
|
||||
if msg.To == "" {
|
||||
return
|
||||
@@ -794,22 +823,17 @@ func (a *App) handlePartEvent(
|
||||
lines := msg.BodyLines()
|
||||
reason := strings.Join(lines, " ")
|
||||
|
||||
line := fmt.Sprintf(
|
||||
"[gray]%s [yellow]*** %s has left %s",
|
||||
timestamp, msg.From, msg.To,
|
||||
)
|
||||
|
||||
if reason != "" {
|
||||
line += " (" + reason + ")"
|
||||
a.ui.AddLine(msg.To, fmt.Sprintf(
|
||||
"[gray]%s [yellow]*** %s has left %s (%s)",
|
||||
timestamp, msg.From, msg.To, reason,
|
||||
))
|
||||
} else {
|
||||
a.ui.AddLine(msg.To, fmt.Sprintf(
|
||||
"[gray]%s [yellow]*** %s has left %s",
|
||||
timestamp, msg.From, msg.To,
|
||||
))
|
||||
}
|
||||
|
||||
if msg.From == myNick {
|
||||
a.ui.AddLineAsRead(msg.To, line)
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
a.ui.AddLine(msg.To, line)
|
||||
}
|
||||
|
||||
func (a *App) handleQuitEvent(
|
||||
|
||||
@@ -1,22 +1,9 @@
|
||||
package cli
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"testing"
|
||||
|
||||
"github.com/gdamore/tcell/v2"
|
||||
api "sneak.berlin/go/neoirc/internal/cli/api"
|
||||
"sneak.berlin/go/neoirc/pkg/irc"
|
||||
)
|
||||
|
||||
// The user's nick, a channel it is in, another user's nick and
|
||||
// a message text, for the tests below.
|
||||
const (
|
||||
testNick = "erin"
|
||||
testChannel = "#chan"
|
||||
testOtherNick = "bob"
|
||||
testText = "hello"
|
||||
)
|
||||
|
||||
func TestMemberPrefix(t *testing.T) {
|
||||
@@ -62,208 +49,3 @@ func TestMemberPrefix(t *testing.T) {
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// TestPartEvent checks that a PART event adds a line to the
|
||||
// channel's buffer and marks it unread, except that the
|
||||
// user's own part does not mark it unread.
|
||||
func TestPartEvent(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
from string
|
||||
wantUnread int
|
||||
}{
|
||||
{name: "own part", from: testNick, wantUnread: 0},
|
||||
{name: "other member", from: testOtherNick, wantUnread: 1},
|
||||
}
|
||||
|
||||
for _, test := range tests {
|
||||
t.Run(test.name, func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
app := &App{ui: NewUI(), nick: testNick}
|
||||
runUI(t, app.ui)
|
||||
|
||||
app.handleServerMessage(&api.Message{
|
||||
Command: irc.CmdPart, From: test.from, To: testChannel,
|
||||
})
|
||||
|
||||
lines, unread := bufferState(app.ui, testChannel)
|
||||
if lines != 1 || unread != test.wantUnread {
|
||||
t.Fatalf("got %d lines and %d unread, want 1 and %d",
|
||||
lines, unread, test.wantUnread)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// TestOwnCommandShownOnce checks that a message, join or
|
||||
// part made from neoirc-cli shows as one line in the
|
||||
// channel's buffer once the server's event for it arrives,
|
||||
// and does not mark the channel unread.
|
||||
func TestOwnCommandShownOnce(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
send func(app *App)
|
||||
event api.Message
|
||||
}{
|
||||
{
|
||||
name: "message",
|
||||
send: func(app *App) { app.handleInput(testText) },
|
||||
event: api.Message{
|
||||
Command: irc.CmdPrivmsg, From: testNick, To: testChannel,
|
||||
Body: []string{testText},
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "join",
|
||||
send: func(app *App) { app.cmdJoin(testChannel) },
|
||||
event: api.Message{
|
||||
Command: irc.CmdJoin, From: testNick, To: testChannel,
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "part",
|
||||
send: func(app *App) { app.cmdPart(testChannel) },
|
||||
event: api.Message{
|
||||
Command: irc.CmdPart, From: testNick, To: testChannel,
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
for _, test := range tests {
|
||||
t.Run(test.name, func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
// The server accepts every command and answers nothing.
|
||||
server := httptest.NewServer(http.HandlerFunc(
|
||||
func(http.ResponseWriter, *http.Request) {},
|
||||
))
|
||||
t.Cleanup(server.Close)
|
||||
|
||||
app := &App{
|
||||
ui: NewUI(),
|
||||
client: api.NewClient(server.URL),
|
||||
nick: testNick,
|
||||
target: testChannel,
|
||||
connected: true,
|
||||
}
|
||||
runUI(t, app.ui)
|
||||
app.ui.SwitchToBuffer(testChannel)
|
||||
|
||||
test.send(app)
|
||||
app.handleServerMessage(&test.event)
|
||||
|
||||
lines, unread := bufferState(app.ui, testChannel)
|
||||
if lines != 1 || unread != 0 {
|
||||
t.Fatalf("got %d lines and %d unread, want 1 and 0",
|
||||
lines, unread)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// TestOwnEventFromOtherClient checks that a message, notice,
|
||||
// join or part that the user's session makes from another
|
||||
// client shows as one line in the buffer it belongs to.
|
||||
func TestOwnEventFromOtherClient(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
event api.Message
|
||||
buffer string
|
||||
}{
|
||||
{
|
||||
name: "channel message",
|
||||
event: api.Message{
|
||||
Command: irc.CmdPrivmsg, From: testNick, To: testChannel,
|
||||
Body: []string{testText},
|
||||
},
|
||||
buffer: testChannel,
|
||||
},
|
||||
{
|
||||
name: "direct message",
|
||||
event: api.Message{
|
||||
Command: irc.CmdPrivmsg, From: testNick, To: testOtherNick,
|
||||
Body: []string{testText},
|
||||
},
|
||||
buffer: testOtherNick,
|
||||
},
|
||||
{
|
||||
name: "notice",
|
||||
event: api.Message{
|
||||
Command: irc.CmdNotice, From: testNick, To: testChannel,
|
||||
Body: []string{testText},
|
||||
},
|
||||
buffer: "(status)",
|
||||
},
|
||||
{
|
||||
name: "join",
|
||||
event: api.Message{
|
||||
Command: irc.CmdJoin, From: testNick, To: testChannel,
|
||||
},
|
||||
buffer: testChannel,
|
||||
},
|
||||
{
|
||||
name: "part",
|
||||
event: api.Message{
|
||||
Command: irc.CmdPart, From: testNick, To: testChannel,
|
||||
},
|
||||
buffer: testChannel,
|
||||
},
|
||||
}
|
||||
|
||||
for _, test := range tests {
|
||||
t.Run(test.name, func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
app := &App{ui: NewUI(), nick: testNick}
|
||||
runUI(t, app.ui)
|
||||
|
||||
app.handleServerMessage(&test.event)
|
||||
|
||||
lines, _ := bufferState(app.ui, test.buffer)
|
||||
if lines != 1 {
|
||||
t.Fatalf("got %d lines in %s, want 1", lines, test.buffer)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// bufferState returns the number of lines in the named
|
||||
// buffer and how many of them are unread.
|
||||
func bufferState(ui *UI, name string) (int, int) {
|
||||
var lines, unread int
|
||||
|
||||
ui.app.QueueUpdate(func() {
|
||||
buf := ui.getOrCreateBuffer(name)
|
||||
lines = len(buf.Lines)
|
||||
unread = buf.Unread
|
||||
})
|
||||
|
||||
return lines, unread
|
||||
}
|
||||
|
||||
// runUI runs ui on a simulated screen until the test ends.
|
||||
func runUI(t *testing.T, ui *UI) {
|
||||
t.Helper()
|
||||
|
||||
ui.app.SetScreen(tcell.NewSimulationScreen(""))
|
||||
|
||||
done := make(chan error)
|
||||
|
||||
go func() { done <- ui.Run() }()
|
||||
|
||||
t.Cleanup(func() {
|
||||
ui.Stop()
|
||||
|
||||
err := <-done
|
||||
if err != nil {
|
||||
t.Errorf("run ui: %v", err)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
@@ -95,19 +95,6 @@ func (ui *UI) AddLine(bufferName, line string) {
|
||||
})
|
||||
}
|
||||
|
||||
// AddLineAsRead adds a line to the specified buffer, as
|
||||
// AddLine does, but does not mark the buffer unread.
|
||||
func (ui *UI) AddLineAsRead(bufferName, line string) {
|
||||
ui.app.QueueUpdateDraw(func() {
|
||||
buf := ui.getOrCreateBuffer(bufferName)
|
||||
buf.Lines = append(buf.Lines, line)
|
||||
|
||||
if ui.buffers[ui.currentBuffer] == buf {
|
||||
_, _ = fmt.Fprintln(ui.messages, line)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
// AddStatus adds a line to the status buffer.
|
||||
func (ui *UI) AddStatus(line string) {
|
||||
ts := time.Now().Format("15:04")
|
||||
|
||||
+8
-30
@@ -264,25 +264,6 @@ func (database *Database) GetSessionByNick(
|
||||
return sessionID, nil
|
||||
}
|
||||
|
||||
// GetSessionNick returns the nick a session holds.
|
||||
func (database *Database) GetSessionNick(
|
||||
ctx context.Context,
|
||||
sessionID int64,
|
||||
) (string, error) {
|
||||
var nick string
|
||||
|
||||
err := database.conn.QueryRowContext(
|
||||
ctx,
|
||||
"SELECT nick FROM sessions WHERE id = ?",
|
||||
sessionID,
|
||||
).Scan(&nick)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("get session nick: %w", err)
|
||||
}
|
||||
|
||||
return nick, nil
|
||||
}
|
||||
|
||||
// SessionHostInfo holds the username, hostname, and IP
|
||||
// for a session.
|
||||
type SessionHostInfo struct {
|
||||
@@ -1227,12 +1208,11 @@ func insertMessageInTx(
|
||||
return dbID, msgUUID, nil
|
||||
}
|
||||
|
||||
// EnqueueToSession adds a message to the queues of all
|
||||
// clients of a session except client skipClientID, or of all
|
||||
// of them when skipClientID is 0.
|
||||
// EnqueueToSession adds a message to all clients of a
|
||||
// session's queues.
|
||||
func (database *Database) EnqueueToSession(
|
||||
ctx context.Context,
|
||||
sessionID, messageID, skipClientID int64,
|
||||
sessionID, messageID int64,
|
||||
) error {
|
||||
transaction, err := database.conn.BeginTx(ctx, nil)
|
||||
if err != nil {
|
||||
@@ -1241,9 +1221,7 @@ func (database *Database) EnqueueToSession(
|
||||
|
||||
defer func() { _ = transaction.Rollback() }()
|
||||
|
||||
err = enqueueToSessionInTx(
|
||||
ctx, transaction, sessionID, messageID, skipClientID,
|
||||
)
|
||||
err = enqueueToSessionInTx(ctx, transaction, sessionID, messageID)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
@@ -1261,15 +1239,15 @@ func (database *Database) EnqueueToSession(
|
||||
func enqueueToSessionInTx(
|
||||
ctx context.Context,
|
||||
transaction *sql.Tx,
|
||||
sessionID, messageID, skipClientID int64,
|
||||
sessionID, messageID int64,
|
||||
) error {
|
||||
_, err := transaction.ExecContext(ctx,
|
||||
`INSERT OR IGNORE INTO client_queues
|
||||
(client_id, message_id, created_at)
|
||||
SELECT c.id, ?, ?
|
||||
FROM clients c
|
||||
WHERE c.session_id = ? AND c.id != ?`,
|
||||
messageID, time.Now(), sessionID, skipClientID)
|
||||
WHERE c.session_id = ?`,
|
||||
messageID, time.Now(), sessionID)
|
||||
if err != nil {
|
||||
return fmt.Errorf(
|
||||
"enqueue to session: %w", err,
|
||||
@@ -1695,7 +1673,7 @@ func quitSessionInTx(
|
||||
|
||||
for _, peerID := range peerIDs {
|
||||
err = enqueueToSessionInTx(
|
||||
ctx, transaction, peerID, messageID, 0,
|
||||
ctx, transaction, peerID, messageID,
|
||||
)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
|
||||
@@ -675,7 +675,7 @@ func TestPollMessages(t *testing.T) {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
err = database.EnqueueToSession(ctx, sid, dbID, 0)
|
||||
err = database.EnqueueToSession(ctx, sid, dbID)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
+29
-30
@@ -813,14 +813,7 @@ func (hdlr *Handlers) HandleGetMessages() http.HandlerFunc {
|
||||
timeout = maxLongPollTimeout
|
||||
}
|
||||
|
||||
// Register with the broker before reading the queue.
|
||||
// Notify wakes only the channels registered at that
|
||||
// moment, so a message queued after the read below
|
||||
// must find this one there already.
|
||||
waitCh := hdlr.broker.Wait(sessionID)
|
||||
defer hdlr.broker.Remove(sessionID, waitCh)
|
||||
|
||||
msgs, lastQID, err := hdlr.pollMessages(
|
||||
msgs, lastQID, err := hdlr.params.Database.PollMessages(
|
||||
request.Context(), clientID,
|
||||
afterID, pollMessageLimit,
|
||||
)
|
||||
@@ -848,22 +841,19 @@ func (hdlr *Handlers) HandleGetMessages() http.HandlerFunc {
|
||||
|
||||
hdlr.longPoll(
|
||||
writer, request,
|
||||
waitCh, clientID, afterID, timeout,
|
||||
sessionID, clientID, afterID, timeout,
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
// longPoll waits up to timeout seconds for the broker to
|
||||
// signal waitCh, then answers with the messages queued for
|
||||
// clientID after afterID. It answers nothing if the client
|
||||
// goes away first.
|
||||
func (hdlr *Handlers) longPoll(
|
||||
writer http.ResponseWriter,
|
||||
request *http.Request,
|
||||
waitCh <-chan struct{},
|
||||
clientID, afterID int64,
|
||||
sessionID, clientID, afterID int64,
|
||||
timeout int,
|
||||
) {
|
||||
waitCh := hdlr.broker.Wait(sessionID)
|
||||
|
||||
timer := time.NewTimer(
|
||||
time.Duration(timeout) * time.Second,
|
||||
)
|
||||
@@ -874,10 +864,14 @@ func (hdlr *Handlers) longPoll(
|
||||
case <-waitCh:
|
||||
case <-timer.C:
|
||||
case <-request.Context().Done():
|
||||
hdlr.broker.Remove(sessionID, waitCh)
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
msgs, lastQID, err := hdlr.pollMessages(
|
||||
hdlr.broker.Remove(sessionID, waitCh)
|
||||
|
||||
msgs, lastQID, err := hdlr.params.Database.PollMessages(
|
||||
request.Context(), clientID,
|
||||
afterID, pollMessageLimit,
|
||||
)
|
||||
@@ -1257,11 +1251,9 @@ func (hdlr *Handlers) handleChannelMsg(
|
||||
) {
|
||||
ctx := request.Context()
|
||||
|
||||
// Delegate validation + fan-out to service layer. The
|
||||
// fan-out includes the sender's own session, so all
|
||||
// their clients see the message in long-poll responses.
|
||||
uuid, err := hdlr.svc.SendChannelMessage(
|
||||
ctx, sessionID, 0, nick,
|
||||
// Delegate validation + fan-out to service layer.
|
||||
dbID, uuid, err := hdlr.svc.SendChannelMessage(
|
||||
ctx, sessionID, nick,
|
||||
command, target, body, meta,
|
||||
)
|
||||
if hdlr.handleServiceError(
|
||||
@@ -1271,6 +1263,13 @@ func (hdlr *Handlers) handleChannelMsg(
|
||||
return
|
||||
}
|
||||
|
||||
// HTTP echo: enqueue to sender so all their clients
|
||||
// see the message in long-poll responses.
|
||||
_ = hdlr.params.Database.EnqueueToSession(
|
||||
ctx, sessionID, dbID,
|
||||
)
|
||||
hdlr.broker.Notify(sessionID)
|
||||
|
||||
hdlr.respondJSON(writer, request,
|
||||
map[string]string{"id": uuid, statusKey: "sent"},
|
||||
http.StatusOK)
|
||||
@@ -1285,7 +1284,7 @@ func (hdlr *Handlers) handleDirectMsg(
|
||||
meta json.RawMessage,
|
||||
) {
|
||||
result, err := hdlr.svc.SendDirectMessage(
|
||||
request.Context(), sessionID, 0, nick,
|
||||
request.Context(), sessionID, nick,
|
||||
command, target, body, meta,
|
||||
)
|
||||
if hdlr.handleServiceError(
|
||||
@@ -1356,7 +1355,7 @@ func (hdlr *Handlers) executeJoin(
|
||||
nick, channel, suppliedKey string,
|
||||
) {
|
||||
result, err := hdlr.svc.JoinChannel(
|
||||
request.Context(), sessionID, 0, nick,
|
||||
request.Context(), sessionID, nick,
|
||||
channel, suppliedKey,
|
||||
)
|
||||
if hdlr.handleServiceError(
|
||||
@@ -1540,7 +1539,7 @@ func (hdlr *Handlers) handlePart(
|
||||
}
|
||||
|
||||
err := hdlr.svc.PartChannel(
|
||||
request.Context(), sessionID, 0,
|
||||
request.Context(), sessionID,
|
||||
nick, channel, reason,
|
||||
)
|
||||
if hdlr.handleServiceError(
|
||||
@@ -1611,7 +1610,7 @@ func (hdlr *Handlers) executeNickChange(
|
||||
nick, newNick string,
|
||||
) {
|
||||
err := hdlr.svc.ChangeNick(
|
||||
request.Context(), sessionID, 0, nick, newNick,
|
||||
request.Context(), sessionID, nick, newNick,
|
||||
)
|
||||
if hdlr.handleServiceError(
|
||||
writer, request,
|
||||
@@ -1666,7 +1665,7 @@ func (hdlr *Handlers) handleTopic(
|
||||
topic := strings.Join(lines, " ")
|
||||
|
||||
err := hdlr.svc.SetTopic(
|
||||
request.Context(), sessionID, 0,
|
||||
request.Context(), sessionID,
|
||||
nick, channel, topic,
|
||||
)
|
||||
if hdlr.handleServiceError(
|
||||
@@ -2152,7 +2151,7 @@ func (hdlr *Handlers) applyUserMode(
|
||||
|
||||
modeText := modeArgs[0] + " " + targetNick
|
||||
hdlr.svc.BroadcastMode(
|
||||
request.Context(), 0, nick, channel, chID,
|
||||
request.Context(), nick, channel, chID,
|
||||
modeText,
|
||||
)
|
||||
|
||||
@@ -2198,7 +2197,7 @@ func (hdlr *Handlers) setChannelFlag(
|
||||
}
|
||||
|
||||
hdlr.svc.BroadcastMode(
|
||||
request.Context(), 0, nick, channel, chID,
|
||||
request.Context(), nick, channel, chID,
|
||||
modeStr,
|
||||
)
|
||||
|
||||
@@ -3645,7 +3644,7 @@ func (hdlr *Handlers) handleKick(
|
||||
}
|
||||
|
||||
err := hdlr.svc.KickUser(
|
||||
request.Context(), sessionID, 0, nick,
|
||||
request.Context(), sessionID, nick,
|
||||
channel, targetNick, reason,
|
||||
)
|
||||
if hdlr.handleServiceError(
|
||||
@@ -3718,7 +3717,7 @@ func (hdlr *Handlers) fanOut(
|
||||
|
||||
for _, sid := range sessionIDs {
|
||||
enqErr := hdlr.params.Database.EnqueueToSession(
|
||||
request.Context(), sid, dbID, 0,
|
||||
request.Context(), sid, dbID,
|
||||
)
|
||||
if enqErr != nil {
|
||||
hdlr.log.Error("enqueue failed",
|
||||
|
||||
+27
-436
@@ -140,7 +140,6 @@ type testServer struct {
|
||||
fxApp *fxtest.App
|
||||
broker *broker.Broker
|
||||
database *db.Database
|
||||
handlers *handlers.Handlers
|
||||
}
|
||||
|
||||
func newTestServer(
|
||||
@@ -171,7 +170,6 @@ func newTestServerWith(
|
||||
srv *server.Server
|
||||
brk *broker.Broker
|
||||
database *db.Database
|
||||
hdlr *handlers.Handlers
|
||||
)
|
||||
|
||||
app := fxtest.New(t,
|
||||
@@ -212,7 +210,7 @@ func newTestServerWith(
|
||||
newTestHandlers,
|
||||
newTestServerFx,
|
||||
),
|
||||
fx.Populate(&srv, &brk, &database, &hdlr),
|
||||
fx.Populate(&srv, &brk, &database),
|
||||
)
|
||||
|
||||
app.RequireStart()
|
||||
@@ -230,7 +228,6 @@ func newTestServerWith(
|
||||
fxApp: app,
|
||||
broker: brk,
|
||||
database: database,
|
||||
handlers: hdlr,
|
||||
}
|
||||
}
|
||||
|
||||
@@ -2557,364 +2554,6 @@ func TestLongPollTimeout(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
// TestLongPollReturnsMessageQueuedAfterFirstRead checks that
|
||||
// a message queued, and the broker notified, after the long
|
||||
// poll's first read of the queue found nothing but before the
|
||||
// poll waits, is returned at once and not when the poll times
|
||||
// out, and that the poll then holds no broker wait channel.
|
||||
func TestLongPollReturnsMessageQueuedAfterFirstRead(t *testing.T) {
|
||||
const (
|
||||
nick = "lp_late"
|
||||
sender = "lp_late_sender"
|
||||
|
||||
// pollTimeout is the long poll's timeout, in seconds.
|
||||
pollTimeout = 10
|
||||
|
||||
// atOnce is the longest the long poll may take to
|
||||
// return the message.
|
||||
atOnce = 5 * time.Second
|
||||
)
|
||||
|
||||
tserver := newTestServer(t)
|
||||
token := tserver.createSession(nick)
|
||||
|
||||
_, lastID := tserver.pollMessages(token, 0)
|
||||
|
||||
sessionID, err := tserver.database.GetSessionByNick(t.Context(), nick)
|
||||
if err != nil {
|
||||
t.Fatalf("get session of %s: %v", nick, err)
|
||||
}
|
||||
|
||||
queued := make(chan error, 1)
|
||||
|
||||
var once sync.Once
|
||||
|
||||
tserver.handlers.SetPollMessages(func(
|
||||
ctx context.Context,
|
||||
clientID, afterQueueID int64,
|
||||
limit int,
|
||||
) ([]db.IRCMessage, int64, error) {
|
||||
msgs, lastQID, pollErr := tserver.database.PollMessages(
|
||||
ctx, clientID, afterQueueID, limit,
|
||||
)
|
||||
|
||||
once.Do(func() {
|
||||
queued <- tserver.queueMessage(ctx, sessionID, sender, nick)
|
||||
})
|
||||
|
||||
return msgs, lastQID, pollErr
|
||||
})
|
||||
|
||||
start := time.Now()
|
||||
|
||||
msgs, err := tserver.longPoll(token, lastID, pollTimeout)
|
||||
if err != nil {
|
||||
t.Fatalf("long poll: %v", err)
|
||||
}
|
||||
|
||||
elapsed := time.Since(start)
|
||||
|
||||
select {
|
||||
case queueErr := <-queued:
|
||||
if queueErr != nil {
|
||||
t.Fatalf("queue message: %v", queueErr)
|
||||
}
|
||||
default:
|
||||
t.Fatal("the long poll did not read the queue")
|
||||
}
|
||||
|
||||
if elapsed > atOnce {
|
||||
t.Fatalf("the long poll returned after %v, want within %v",
|
||||
elapsed, atOnce)
|
||||
}
|
||||
|
||||
if !findMessage(msgs, privmsgCmd, sender) {
|
||||
t.Fatalf("long poll: got %v, want the PRIVMSG from %s",
|
||||
msgs, sender)
|
||||
}
|
||||
|
||||
tserver.checkWaitChannelRemoved(sessionID)
|
||||
}
|
||||
|
||||
// errReadFailed is what a test's replacement for
|
||||
// Database.PollMessages returns to make a read of the queue
|
||||
// fail.
|
||||
var errReadFailed = errors.New("read failed")
|
||||
|
||||
// TestGetMessagesRemovesWaitChannel checks that a request to
|
||||
// GET /api/v1/messages leaves no broker wait channel behind,
|
||||
// whether it is answered at once, after its timeout, or with
|
||||
// an error because a read of the queue failed.
|
||||
func TestGetMessagesRemovesWaitChannel(t *testing.T) {
|
||||
const (
|
||||
// longTimeout, in seconds, is the timeout of the
|
||||
// requests that must be answered without waiting.
|
||||
longTimeout = 10
|
||||
|
||||
// shortTimeout, in seconds, is the timeout of the
|
||||
// requests that wait it out.
|
||||
shortTimeout = 1
|
||||
)
|
||||
|
||||
// queued is whether a message is queued before the request,
|
||||
// whose timeout is in seconds. failingRead is as for
|
||||
// getMessagesFailingRead. wantReads is how many times the
|
||||
// handler reads the queue: once if it answers at once,
|
||||
// twice if it waits first.
|
||||
tests := []struct {
|
||||
name string
|
||||
queued bool
|
||||
timeout, failingRead int
|
||||
wantReads, wantStatus int
|
||||
}{
|
||||
{
|
||||
name: "nothing queued, timeout 0", timeout: 0,
|
||||
wantReads: 1, wantStatus: http.StatusOK,
|
||||
},
|
||||
{
|
||||
name: "message queued", queued: true, timeout: longTimeout,
|
||||
wantReads: 1, wantStatus: http.StatusOK,
|
||||
},
|
||||
{
|
||||
name: "timed out", timeout: shortTimeout,
|
||||
wantReads: 2, wantStatus: http.StatusOK,
|
||||
},
|
||||
{
|
||||
name: "first read failed", timeout: longTimeout, failingRead: 1,
|
||||
wantReads: 1, wantStatus: http.StatusInternalServerError,
|
||||
},
|
||||
{
|
||||
name: "read after the wait failed", timeout: shortTimeout,
|
||||
failingRead: 2, wantReads: 2,
|
||||
wantStatus: http.StatusInternalServerError,
|
||||
},
|
||||
}
|
||||
|
||||
for _, tc := range tests {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
const nick = "wc_poller"
|
||||
|
||||
tserver := newTestServer(t)
|
||||
token := tserver.createSession(nick)
|
||||
|
||||
_, lastID := tserver.pollMessages(token, 0)
|
||||
|
||||
sessionID, err := tserver.database.GetSessionByNick(
|
||||
t.Context(), nick,
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatalf("get session of %s: %v", nick, err)
|
||||
}
|
||||
|
||||
if tc.queued {
|
||||
err = tserver.queueMessage(
|
||||
t.Context(), sessionID, "wc_sender", nick,
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatalf("queue message: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
status, reads := tserver.getMessagesFailingRead(
|
||||
token, lastID, tc.timeout, tc.failingRead,
|
||||
)
|
||||
if status != tc.wantStatus {
|
||||
t.Errorf("status %d, want %d", status, tc.wantStatus)
|
||||
}
|
||||
|
||||
if reads != tc.wantReads {
|
||||
t.Errorf("the handler read the queue %d times, want %d",
|
||||
reads, tc.wantReads)
|
||||
}
|
||||
|
||||
tserver.checkWaitChannelRemoved(sessionID)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// getMessagesFailingRead sends GET /api/v1/messages for the
|
||||
// client token with timeout and after afterID. The handler's
|
||||
// read of the queue numbered failingRead, counting from 1,
|
||||
// fails; with 0, none does. It returns the response status
|
||||
// and how many times the handler read the queue.
|
||||
func (tserver *testServer) getMessagesFailingRead(
|
||||
token string,
|
||||
afterID int64,
|
||||
timeout, failingRead int,
|
||||
) (int, int) {
|
||||
tserver.t.Helper()
|
||||
|
||||
reads := 0
|
||||
|
||||
tserver.handlers.SetPollMessages(func(
|
||||
ctx context.Context,
|
||||
clientID, afterQueueID int64,
|
||||
limit int,
|
||||
) ([]db.IRCMessage, int64, error) {
|
||||
reads++
|
||||
|
||||
if reads == failingRead {
|
||||
return nil, 0, errReadFailed
|
||||
}
|
||||
|
||||
return tserver.database.PollMessages(
|
||||
ctx, clientID, afterQueueID, limit,
|
||||
)
|
||||
})
|
||||
|
||||
resp, err := doRequestAuth(
|
||||
tserver.t, http.MethodGet,
|
||||
tserver.url(fmt.Sprintf(
|
||||
"%s?timeout=%d&after=%d", apiMessages, timeout, afterID,
|
||||
)),
|
||||
token, nil,
|
||||
)
|
||||
if err != nil {
|
||||
tserver.t.Fatalf("get messages: %v", err)
|
||||
}
|
||||
|
||||
_ = resp.Body.Close()
|
||||
|
||||
return resp.StatusCode, reads
|
||||
}
|
||||
|
||||
// TestLongPollRemovesWaitChannelWhenClientGivesUp checks that
|
||||
// a long poll whose client gives up while it waits leaves no
|
||||
// broker wait channel behind.
|
||||
func TestLongPollRemovesWaitChannelWhenClientGivesUp(t *testing.T) {
|
||||
const (
|
||||
nick = "wc_leaver"
|
||||
|
||||
// pollTimeout is the long poll's timeout, in seconds.
|
||||
pollTimeout = 10
|
||||
|
||||
// readDeadline is how long the handler has to read
|
||||
// the queue.
|
||||
readDeadline = 5 * time.Second
|
||||
)
|
||||
|
||||
tserver := newTestServer(t)
|
||||
token := tserver.createSession(nick)
|
||||
|
||||
_, lastID := tserver.pollMessages(token, 0)
|
||||
|
||||
sessionID, err := tserver.database.GetSessionByNick(t.Context(), nick)
|
||||
if err != nil {
|
||||
t.Fatalf("get session of %s: %v", nick, err)
|
||||
}
|
||||
|
||||
read := make(chan struct{})
|
||||
|
||||
var once sync.Once
|
||||
|
||||
tserver.handlers.SetPollMessages(func(
|
||||
ctx context.Context,
|
||||
clientID, afterQueueID int64,
|
||||
limit int,
|
||||
) ([]db.IRCMessage, int64, error) {
|
||||
msgs, lastQID, pollErr := tserver.database.PollMessages(
|
||||
ctx, clientID, afterQueueID, limit,
|
||||
)
|
||||
|
||||
once.Do(func() { close(read) })
|
||||
|
||||
return msgs, lastQID, pollErr
|
||||
})
|
||||
|
||||
ctx, giveUp := context.WithCancel(t.Context())
|
||||
defer giveUp()
|
||||
|
||||
request, err := http.NewRequestWithContext(
|
||||
ctx, http.MethodGet,
|
||||
tserver.url(fmt.Sprintf(
|
||||
"%s?timeout=%d&after=%d", apiMessages, pollTimeout, lastID,
|
||||
)),
|
||||
nil,
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatalf("new request: %v", err)
|
||||
}
|
||||
|
||||
request.AddCookie(&http.Cookie{ //nolint:exhaustruct,gosec // only name+value
|
||||
Name: authCookieName,
|
||||
Value: token,
|
||||
})
|
||||
|
||||
done := make(chan struct{})
|
||||
|
||||
go func() {
|
||||
defer close(done)
|
||||
|
||||
resp, doErr := http.DefaultClient.Do(request)
|
||||
if doErr == nil {
|
||||
_ = resp.Body.Close()
|
||||
}
|
||||
}()
|
||||
|
||||
select {
|
||||
case <-read:
|
||||
case <-time.After(readDeadline):
|
||||
t.Fatal("the long poll did not read the queue")
|
||||
}
|
||||
|
||||
giveUp()
|
||||
<-done
|
||||
|
||||
tserver.checkWaitChannelRemoved(sessionID)
|
||||
}
|
||||
|
||||
// checkWaitChannelRemoved fails the test unless the broker
|
||||
// holds no wait channel for the session sessionID. A client
|
||||
// can have its response before the handler has returned, and
|
||||
// a handler notices a client that gives up only later, so it
|
||||
// waits up to removeDeadline for that.
|
||||
func (tserver *testServer) checkWaitChannelRemoved(sessionID int64) {
|
||||
tserver.t.Helper()
|
||||
|
||||
const (
|
||||
removeDeadline = 5 * time.Second
|
||||
checkStep = 10 * time.Millisecond
|
||||
)
|
||||
|
||||
deadline := time.Now().Add(removeDeadline)
|
||||
|
||||
for tserver.broker.ListenerCount(sessionID) != 0 {
|
||||
if time.Now().After(deadline) {
|
||||
tserver.t.Fatalf("got %d broker wait channels, want 0",
|
||||
tserver.broker.ListenerCount(sessionID))
|
||||
}
|
||||
|
||||
time.Sleep(checkStep)
|
||||
}
|
||||
}
|
||||
|
||||
// queueMessage stores a PRIVMSG from sender to nick, queues
|
||||
// it to the session sessionID and notifies the broker, as the
|
||||
// server does for a DM. It returns errors instead of failing
|
||||
// the test, so a handler's goroutine can call it.
|
||||
func (tserver *testServer) queueMessage(
|
||||
ctx context.Context,
|
||||
sessionID int64,
|
||||
sender, nick string,
|
||||
) error {
|
||||
msgID, _, err := tserver.database.InsertMessage(
|
||||
ctx, privmsgCmd, sender, nick, sessionID, 0,
|
||||
nil, json.RawMessage(`["hello"]`), nil,
|
||||
)
|
||||
if err != nil {
|
||||
return fmt.Errorf("insert message: %w", err)
|
||||
}
|
||||
|
||||
err = tserver.database.EnqueueToSession(ctx, sessionID, msgID, 0)
|
||||
if err != nil {
|
||||
return fmt.Errorf("enqueue: %w", err)
|
||||
}
|
||||
|
||||
tserver.broker.Notify(sessionID)
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func TestEphemeralChannelCleanup(t *testing.T) {
|
||||
const channel = "#ephemeral"
|
||||
|
||||
@@ -3267,73 +2906,32 @@ func TestPassCommand(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
// The shortest and longest password PASS accepts; bcrypt
|
||||
// cannot hash more than 72 bytes.
|
||||
const (
|
||||
minPasswordBytes = 8
|
||||
maxPasswordBytes = 72
|
||||
)
|
||||
func TestPassCommandShortPassword(t *testing.T) {
|
||||
tserver := newTestServer(t)
|
||||
token := tserver.createSession("shortpw")
|
||||
|
||||
// TestPassCommandLength checks that PASS stores a password of
|
||||
// 8 to 72 bytes and refuses any other with 461. The limit
|
||||
// counts bytes: "é" is two bytes in UTF-8, so 72 of them are
|
||||
// refused.
|
||||
func TestPassCommandLength(t *testing.T) {
|
||||
cases := []struct {
|
||||
name string
|
||||
password string
|
||||
stored bool
|
||||
}{
|
||||
{"empty", "", false},
|
||||
{"7 bytes", strings.Repeat("a", minPasswordBytes-1), false},
|
||||
{"8 bytes", strings.Repeat("a", minPasswordBytes), true},
|
||||
{"72 bytes", strings.Repeat("a", maxPasswordBytes), true},
|
||||
{"73 bytes", strings.Repeat("a", maxPasswordBytes+1), false},
|
||||
{"72 characters", strings.Repeat("é", maxPasswordBytes), false},
|
||||
// Drain initial messages.
|
||||
_, lastID := tserver.pollMessages(token, 0)
|
||||
|
||||
// Try short password — should fail.
|
||||
status, _ := tserver.sendCommand(
|
||||
token,
|
||||
map[string]any{
|
||||
commandKey: irc.CmdPass,
|
||||
bodyKey: []string{"short"},
|
||||
},
|
||||
)
|
||||
if status != http.StatusOK {
|
||||
t.Fatalf("expected 200, got %d", status)
|
||||
}
|
||||
|
||||
for _, tc := range cases {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
tserver := newTestServer(t)
|
||||
token := tserver.createSession("pwlength")
|
||||
msgs, _ := tserver.pollMessages(token, lastID)
|
||||
|
||||
_, lastID := tserver.pollMessages(token, 0)
|
||||
|
||||
status, result := tserver.sendCommand(
|
||||
token,
|
||||
map[string]any{
|
||||
commandKey: irc.CmdPass,
|
||||
bodyKey: []string{tc.password},
|
||||
},
|
||||
)
|
||||
if status != http.StatusOK {
|
||||
t.Fatalf("expected 200, got %d: %v", status, result)
|
||||
}
|
||||
|
||||
if !tc.stored {
|
||||
msgs, _ := tserver.pollMessages(token, lastID)
|
||||
if !findNumeric(msgs, "461") {
|
||||
t.Fatalf(
|
||||
"expected ERR_NEEDMOREPARAMS (461), got %v",
|
||||
msgs,
|
||||
)
|
||||
}
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
if result[statusKey] != "ok" {
|
||||
t.Fatalf("expected ok, got %v", result)
|
||||
}
|
||||
|
||||
postJSONExpectStatus(
|
||||
t, tserver, "/api/v1/login",
|
||||
map[string]string{
|
||||
nickKey: "pwlength", passwordKey: tc.password,
|
||||
},
|
||||
http.StatusOK,
|
||||
)
|
||||
})
|
||||
if !findNumeric(msgs, "461") {
|
||||
t.Fatalf(
|
||||
"expected ERR_NEEDMOREPARAMS (461), got %v",
|
||||
msgs,
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -4524,14 +4122,9 @@ func sessionCount(t *testing.T, tserver *testServer) int64 {
|
||||
// before its nick is looked at, that a request refused with
|
||||
// 400 or 409 does not spend its stamp, so the same stamp
|
||||
// then creates a session, that the stamp stays spent after
|
||||
// that, that a spent stamp with an invalid nick is refused
|
||||
// for its nick, and that no refused request creates a
|
||||
// session.
|
||||
// that, and that no refused request creates a session.
|
||||
func TestRefusedSessionLeavesStampUnspent(t *testing.T) {
|
||||
const (
|
||||
bits = 2
|
||||
badNick = "bad nick"
|
||||
)
|
||||
const bits = 2
|
||||
|
||||
tserver := newTestServerWith(t, bits, "", "")
|
||||
|
||||
@@ -4550,16 +4143,14 @@ func TestRefusedSessionLeavesStampUnspent(t *testing.T) {
|
||||
nick, username, stamp string
|
||||
want int
|
||||
}{
|
||||
{badNick, "", otherServerStamp, http.StatusPaymentRequired},
|
||||
{badNick, "", stamp, http.StatusBadRequest},
|
||||
{"bad nick", "", otherServerStamp, http.StatusPaymentRequired},
|
||||
{"bad nick", "", stamp, http.StatusBadRequest},
|
||||
{"fresh", "bad username", stamp, http.StatusBadRequest},
|
||||
{"taken", "", stamp, http.StatusConflict},
|
||||
{"fresh", "", stamp, http.StatusCreated},
|
||||
{"another", "", stamp, http.StatusPaymentRequired},
|
||||
// Refused as already spent, the stamp is not given back.
|
||||
{"later", "", stamp, http.StatusPaymentRequired},
|
||||
// Whether the stamp is spent is looked at after the nick.
|
||||
{badNick, "", stamp, http.StatusBadRequest},
|
||||
// The refused request for "another" left the nick free.
|
||||
{"another", "", api.MintHashcash(bits, "neoirc"), http.StatusCreated},
|
||||
}
|
||||
|
||||
@@ -8,12 +8,7 @@ import (
|
||||
"sneak.berlin/go/neoirc/pkg/irc"
|
||||
)
|
||||
|
||||
// A session password is 8 to 72 bytes; bcrypt cannot hash
|
||||
// a longer one.
|
||||
const (
|
||||
minPasswordLength = 8
|
||||
maxPasswordLength = 72
|
||||
)
|
||||
const minPasswordLength = 8
|
||||
|
||||
// HandleLogin authenticates a user with nick and password.
|
||||
func (hdlr *Handlers) HandleLogin() http.HandlerFunc {
|
||||
@@ -154,13 +149,12 @@ func (hdlr *Handlers) handlePass(
|
||||
|
||||
password := lines[0]
|
||||
|
||||
if len(password) < minPasswordLength ||
|
||||
len(password) > maxPasswordLength {
|
||||
if len(password) < minPasswordLength {
|
||||
hdlr.respondIRCError(
|
||||
writer, request, clientID, sessionID,
|
||||
irc.ErrNeedMoreParams, nick,
|
||||
[]string{irc.CmdPass},
|
||||
"Password must be 8 to 72 bytes",
|
||||
"Password must be at least 8 characters",
|
||||
)
|
||||
|
||||
return
|
||||
|
||||
@@ -1,19 +0,0 @@
|
||||
package handlers
|
||||
|
||||
import (
|
||||
"context"
|
||||
|
||||
"sneak.berlin/go/neoirc/internal/db"
|
||||
)
|
||||
|
||||
// SetPollMessages makes HandleGetMessages read the client
|
||||
// output queue with poll in place of Database.PollMessages.
|
||||
func (hdlr *Handlers) SetPollMessages(
|
||||
poll func(
|
||||
ctx context.Context,
|
||||
clientID, afterQueueID int64,
|
||||
limit int,
|
||||
) ([]db.IRCMessage, int64, error),
|
||||
) {
|
||||
hdlr.pollMessages = poll
|
||||
}
|
||||
@@ -64,16 +64,6 @@ type Handlers struct {
|
||||
loginLimiter *ratelimit.Limiter
|
||||
stats *stats.Tracker
|
||||
cancelCleanup context.CancelFunc
|
||||
|
||||
// pollMessages is Database.PollMessages, with which
|
||||
// HandleGetMessages reads the client output queue. Tests
|
||||
// replace it to act just after a read, or to make a read
|
||||
// fail.
|
||||
pollMessages func(
|
||||
ctx context.Context,
|
||||
clientID, afterQueueID int64,
|
||||
limit int,
|
||||
) ([]db.IRCMessage, int64, error)
|
||||
}
|
||||
|
||||
// New creates a new Handlers instance.
|
||||
@@ -105,7 +95,6 @@ func New(
|
||||
hashcashVal: hashcash.NewValidator(resource),
|
||||
loginLimiter: ratelimit.New(loginRate, loginBurst),
|
||||
stats: params.Stats,
|
||||
pollMessages: params.Database.PollMessages,
|
||||
}
|
||||
|
||||
lifecycle.Append(fx.Hook{
|
||||
|
||||
@@ -111,8 +111,7 @@ func TestReplayDetection(t *testing.T) {
|
||||
}
|
||||
|
||||
// TestCheckDoesNotSpendStamp checks that a stamp Check
|
||||
// accepts can still be claimed, and only once, and that
|
||||
// Check still accepts it once it is spent.
|
||||
// accepts can still be claimed, and only once.
|
||||
func TestCheckDoesNotSpendStamp(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
@@ -137,11 +136,6 @@ func TestCheckDoesNotSpendStamp(t *testing.T) {
|
||||
if err == nil {
|
||||
t.Fatal("replay not detected")
|
||||
}
|
||||
|
||||
err = validator.Check(stamp, testBits)
|
||||
if err != nil {
|
||||
t.Fatalf("spent stamp rejected by Check: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
// TestReleasedStampCanBeClaimedAgain checks that Release
|
||||
|
||||
@@ -81,10 +81,10 @@ func (c *Conn) handleNick(
|
||||
}
|
||||
|
||||
oldMask := c.hostmask()
|
||||
oldNick := c.currentNick()
|
||||
oldNick := c.nick
|
||||
|
||||
err := c.svc.ChangeNick(
|
||||
ctx, c.sessionID, c.clientID, oldNick, newNick,
|
||||
ctx, c.sessionID, oldNick, newNick,
|
||||
)
|
||||
if err != nil {
|
||||
c.sendIRCError(err)
|
||||
@@ -92,10 +92,9 @@ func (c *Conn) handleNick(
|
||||
return
|
||||
}
|
||||
|
||||
// Take the nick the session holds, not newNick: another
|
||||
// client of the session may have changed it again since
|
||||
// ChangeNick stored newNick.
|
||||
c.loadSessionNick(ctx)
|
||||
c.mu.Lock()
|
||||
c.nick = newNick
|
||||
c.mu.Unlock()
|
||||
|
||||
// Echo NICK change to the client on wire.
|
||||
c.send(FormatMessage(oldMask, "NICK", newNick))
|
||||
@@ -129,8 +128,8 @@ func (c *Conn) handlePrivmsg(
|
||||
body, _ := json.Marshal([]string{text}) //nolint:errchkjson
|
||||
|
||||
if strings.HasPrefix(target, "#") {
|
||||
_, err := c.svc.SendChannelMessage(
|
||||
ctx, c.sessionID, c.clientID, c.currentNick(),
|
||||
_, _, err := c.svc.SendChannelMessage(
|
||||
ctx, c.sessionID, c.nick,
|
||||
msg.Command, target, body, nil,
|
||||
)
|
||||
if err != nil {
|
||||
@@ -138,7 +137,7 @@ func (c *Conn) handlePrivmsg(
|
||||
}
|
||||
} else {
|
||||
result, err := c.svc.SendDirectMessage(
|
||||
ctx, c.sessionID, c.clientID, c.currentNick(),
|
||||
ctx, c.sessionID, c.nick,
|
||||
msg.Command, target, body, nil,
|
||||
)
|
||||
if err != nil {
|
||||
@@ -200,7 +199,7 @@ func (c *Conn) joinChannel(
|
||||
channel, key string,
|
||||
) {
|
||||
result, err := c.svc.JoinChannel(
|
||||
ctx, c.sessionID, c.clientID, c.currentNick(), channel, key,
|
||||
ctx, c.sessionID, c.nick, channel, key,
|
||||
)
|
||||
if err != nil {
|
||||
c.sendIRCError(err)
|
||||
@@ -338,7 +337,7 @@ func (c *Conn) partChannel(
|
||||
channel, reason string,
|
||||
) {
|
||||
err := c.svc.PartChannel(
|
||||
ctx, c.sessionID, c.clientID, c.currentNick(), channel, reason,
|
||||
ctx, c.sessionID, c.nick, channel, reason,
|
||||
)
|
||||
if err != nil {
|
||||
c.sendIRCError(err)
|
||||
@@ -402,7 +401,7 @@ func (c *Conn) handleTopic(
|
||||
newTopic := msg.Params[1]
|
||||
|
||||
err := c.svc.SetTopic(
|
||||
ctx, c.sessionID, c.clientID, c.currentNick(), channel, newTopic,
|
||||
ctx, c.sessionID, c.nick, channel, newTopic,
|
||||
)
|
||||
if err != nil {
|
||||
c.sendIRCError(err)
|
||||
@@ -709,7 +708,7 @@ func (c *Conn) applyChannelModes(
|
||||
c.send(FormatMessage(c.hostmask(), "MODE", params...))
|
||||
|
||||
c.svc.BroadcastMode(
|
||||
ctx, c.clientID, c.currentNick(), channel, chID, modeReply,
|
||||
ctx, c.nick, channel, chID, modeReply,
|
||||
)
|
||||
}
|
||||
}
|
||||
@@ -1186,7 +1185,7 @@ func (c *Conn) handleKick(
|
||||
}
|
||||
|
||||
err := c.svc.KickUser(
|
||||
ctx, c.sessionID, c.clientID, c.currentNick(),
|
||||
ctx, c.sessionID, c.nick,
|
||||
channel, targetNick, reason,
|
||||
)
|
||||
if err != nil {
|
||||
@@ -1217,16 +1216,17 @@ func (c *Conn) handlePassPostReg(
|
||||
}
|
||||
|
||||
password := msg.Params[0]
|
||||
if !c.checkPasswordLength(password) {
|
||||
if len(password) < minPasswordLen {
|
||||
c.sendFromServer("NOTICE", c.nick,
|
||||
"Password must be at least 8 characters",
|
||||
)
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
err := c.setPassword(ctx, password)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
c.setPassword(ctx, password)
|
||||
|
||||
c.sendFromServer("NOTICE", c.currentNick(),
|
||||
c.sendFromServer("NOTICE", c.nick,
|
||||
"Password set. You can reconnect using "+
|
||||
"PASS <password> with your nick.",
|
||||
)
|
||||
@@ -1250,7 +1250,7 @@ func (c *Conn) handleInvite(
|
||||
channel := msg.Params[1]
|
||||
|
||||
targetID, err := c.svc.InviteUser(
|
||||
ctx, c.sessionID, c.currentNick(), targetNick, channel,
|
||||
ctx, c.sessionID, c.nick, targetNick, channel,
|
||||
)
|
||||
if err != nil {
|
||||
c.sendIRCError(err)
|
||||
@@ -1262,13 +1262,14 @@ func (c *Conn) handleInvite(
|
||||
irc.RplInviting, targetNick, channel,
|
||||
)
|
||||
|
||||
// Queue the INVITE to the target with the body the HTTP
|
||||
// API uses.
|
||||
body, _ := json.Marshal([]string{channel}) //nolint:errchkjson
|
||||
// Send INVITE notice to target via service fan-out.
|
||||
body, _ := json.Marshal( //nolint:errchkjson
|
||||
[]string{"You have been invited to " + channel},
|
||||
)
|
||||
|
||||
_, _, _ = c.svc.FanOut( //nolint:dogsled // fire-and-forget broadcast
|
||||
ctx, "INVITE", c.currentNick(), targetNick, targetID, 0,
|
||||
nil, body, nil, []int64{targetID}, 0,
|
||||
ctx, "INVITE", c.nick, targetNick, targetID, 0,
|
||||
nil, body, nil, []int64{targetID},
|
||||
)
|
||||
}
|
||||
|
||||
|
||||
+13
-63
@@ -27,7 +27,6 @@ const (
|
||||
pingInterval = 90 * time.Second
|
||||
pongDeadline = 30 * time.Second
|
||||
minPasswordLen = 8
|
||||
maxPasswordLen = 72 // bcrypt cannot hash a longer one
|
||||
maxHashcashBits = 40
|
||||
)
|
||||
|
||||
@@ -63,7 +62,6 @@ type Conn struct {
|
||||
registered bool
|
||||
gotNick bool
|
||||
gotUser bool
|
||||
gotPass bool
|
||||
passWord string
|
||||
|
||||
lastQueueID int64
|
||||
@@ -72,6 +70,7 @@ type Conn struct {
|
||||
}
|
||||
|
||||
func newConn(
|
||||
ctx context.Context,
|
||||
tcpConn net.Conn,
|
||||
log *slog.Logger,
|
||||
database *db.Database,
|
||||
@@ -95,6 +94,7 @@ func newConn(
|
||||
svc: svc,
|
||||
serverSfx: srvName,
|
||||
remoteIP: host,
|
||||
hostname: resolveHost(ctx, host),
|
||||
}
|
||||
|
||||
conn.commands = conn.buildCommandMap()
|
||||
@@ -212,15 +212,12 @@ func resolveHost(ctx context.Context, addr string) string {
|
||||
}
|
||||
|
||||
// serve is the main loop for a single IRC client connection.
|
||||
// It first sets the client's hostname to what resolve returns
|
||||
// for the client's address.
|
||||
// Cancelling ctx when it returns stops the relay goroutine.
|
||||
// When nothing has been read for interval the client is sent
|
||||
// a PING, and when nothing is read within deadline after that
|
||||
// the connection is closed.
|
||||
func (c *Conn) serve(
|
||||
ctx context.Context,
|
||||
resolve func(ctx context.Context, addr string) string,
|
||||
interval, deadline time.Duration,
|
||||
) {
|
||||
ctx, cancel := context.WithCancel(ctx)
|
||||
@@ -229,11 +226,6 @@ func (c *Conn) serve(
|
||||
// still end the session then.
|
||||
defer c.cleanup(context.WithoutCancel(ctx))
|
||||
|
||||
// The hostname is looked up here, on this connection's
|
||||
// goroutine, and not when the connection is accepted, so
|
||||
// that a slow lookup holds up only this client.
|
||||
c.hostname = resolve(ctx, c.remoteIP)
|
||||
|
||||
ping := time.AfterFunc(interval, func() {
|
||||
c.send("PING :" + c.serverSfx)
|
||||
})
|
||||
@@ -313,22 +305,6 @@ func (c *Conn) currentNick() string {
|
||||
return c.nick
|
||||
}
|
||||
|
||||
// loadSessionNick sets c.nick to the nick the connection's
|
||||
// session holds in the database, read by session ID. The
|
||||
// connection's own NICK and the relay passing on a NICK line
|
||||
// both call it, and it reads and sets the nick under c.mu, so
|
||||
// whichever runs last leaves the connection on its session's
|
||||
// nick. If the read fails, c.nick is left as it is.
|
||||
func (c *Conn) loadSessionNick(ctx context.Context) {
|
||||
c.mu.Lock()
|
||||
defer c.mu.Unlock()
|
||||
|
||||
nick, err := c.database.GetSessionNick(ctx, c.sessionID)
|
||||
if err == nil {
|
||||
c.nick = nick
|
||||
}
|
||||
}
|
||||
|
||||
// send writes a formatted IRC line to the connection.
|
||||
func (c *Conn) send(line string) {
|
||||
c.sendWithin(writeTimeout, line)
|
||||
@@ -361,7 +337,7 @@ func (c *Conn) sendNumeric(
|
||||
code irc.IRCMessageType,
|
||||
params ...string,
|
||||
) {
|
||||
nick := c.currentNick()
|
||||
nick := c.nick
|
||||
if nick == "" {
|
||||
nick = "*"
|
||||
}
|
||||
@@ -385,11 +361,9 @@ func (c *Conn) sendFromServer(
|
||||
// hostmask returns the client's full hostmask
|
||||
// (nick!user@host).
|
||||
func (c *Conn) hostmask() string {
|
||||
nick := c.currentNick()
|
||||
|
||||
user := c.username
|
||||
if user == "" {
|
||||
user = nick
|
||||
user = c.nick
|
||||
}
|
||||
|
||||
host := c.hostname
|
||||
@@ -397,7 +371,7 @@ func (c *Conn) hostmask() string {
|
||||
host = c.remoteIP
|
||||
}
|
||||
|
||||
return nick + "!" + user + "@" + host
|
||||
return c.nick + "!" + user + "@" + host
|
||||
}
|
||||
|
||||
// handleMessage dispatches a parsed IRC message using
|
||||
@@ -456,7 +430,6 @@ func (c *Conn) handlePreRegistration(
|
||||
}
|
||||
|
||||
c.passWord = msg.Params[0]
|
||||
c.gotPass = true
|
||||
case irc.CmdNick:
|
||||
if len(msg.Params) < 1 {
|
||||
c.sendNumeric(
|
||||
@@ -571,20 +544,17 @@ func (c *Conn) completeRegistration(ctx context.Context) {
|
||||
// So that KILL, from either transport, can close it.
|
||||
c.svc.RegisterWireConn(sessionID, c)
|
||||
|
||||
// If PASS was provided before registration, set the
|
||||
// session password.
|
||||
if c.passWord != "" && len(c.passWord) >= minPasswordLen {
|
||||
c.setPassword(ctx, c.passWord)
|
||||
}
|
||||
|
||||
// Send welcome burst.
|
||||
c.deliverWelcome()
|
||||
c.deliverLusers(ctx)
|
||||
c.deliverMOTD()
|
||||
|
||||
// If PASS was given before registration, store its
|
||||
// password now, after the welcome burst, so that a
|
||||
// NOTICE refusing it reaches a registered client. A
|
||||
// failure to store it is only logged, as it is for PASS
|
||||
// after registration.
|
||||
if c.gotPass && c.checkPasswordLength(c.passWord) {
|
||||
_ = c.setPassword(ctx, c.passWord)
|
||||
}
|
||||
|
||||
// Start the message relay goroutine.
|
||||
go c.relayMessages(ctx)
|
||||
}
|
||||
@@ -667,33 +637,13 @@ func (c *Conn) deliverMOTD() {
|
||||
)
|
||||
}
|
||||
|
||||
// checkPasswordLength reports whether pw is 8 to 72 bytes
|
||||
// long, and sends the client a NOTICE saying so when it is
|
||||
// not.
|
||||
func (c *Conn) checkPasswordLength(pw string) bool {
|
||||
if len(pw) >= minPasswordLen && len(pw) <= maxPasswordLen {
|
||||
return true
|
||||
}
|
||||
|
||||
c.sendFromServer("NOTICE", c.currentNick(),
|
||||
"Password must be 8 to 72 bytes",
|
||||
)
|
||||
|
||||
return false
|
||||
}
|
||||
|
||||
// setPassword sets a bcrypt password on the session, and
|
||||
// logs and returns the error when it was not stored.
|
||||
func (c *Conn) setPassword(ctx context.Context, pw string) error {
|
||||
// setPassword sets a bcrypt password on the session.
|
||||
func (c *Conn) setPassword(ctx context.Context, pw string) {
|
||||
// Use the database's auth module to hash and store.
|
||||
err := c.database.SetPassword(ctx, c.sessionID, pw)
|
||||
if err != nil {
|
||||
c.log.Error(
|
||||
"failed to set password", "error", err,
|
||||
)
|
||||
|
||||
return err
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
@@ -15,8 +15,7 @@ import (
|
||||
|
||||
// NewTestServer creates a Server suitable for testing, whose
|
||||
// connections use interval and deadline in place of
|
||||
// pingInterval and pongDeadline, and resolve in place of
|
||||
// resolveHost.
|
||||
// pingInterval and pongDeadline.
|
||||
// The caller must call Stop() when finished.
|
||||
func NewTestServer(
|
||||
log *slog.Logger,
|
||||
@@ -24,7 +23,6 @@ func NewTestServer(
|
||||
database *db.Database,
|
||||
brk *broker.Broker,
|
||||
interval, deadline time.Duration,
|
||||
resolve func(ctx context.Context, addr string) string,
|
||||
) *Server {
|
||||
globs := &globals.Globals{
|
||||
Appname: "neoirc",
|
||||
@@ -46,16 +44,9 @@ func NewTestServer(
|
||||
|
||||
pingInterval: interval,
|
||||
pongDeadline: deadline,
|
||||
resolveHost: resolve,
|
||||
}
|
||||
}
|
||||
|
||||
// ResolveHost is the reverse DNS lookup that a server made by
|
||||
// New does for each client.
|
||||
func ResolveHost(ctx context.Context, addr string) string {
|
||||
return resolveHost(ctx, addr)
|
||||
}
|
||||
|
||||
// Start exposes the unexported start method for tests.
|
||||
func (s *Server) Start(addr string) error {
|
||||
return s.start(context.Background(), addr)
|
||||
@@ -71,11 +62,6 @@ func (s *Server) Listener() net.Listener {
|
||||
return s.listener
|
||||
}
|
||||
|
||||
// Service returns the service the server's connections use.
|
||||
func (s *Server) Service() *service.Service {
|
||||
return s.svc
|
||||
}
|
||||
|
||||
// PingTimes returns how long the server's connections wait
|
||||
// with nothing read before they are sent a PING, and after it
|
||||
// before they are closed.
|
||||
@@ -111,7 +97,10 @@ func NewTestConn(
|
||||
tcpConn net.Conn,
|
||||
nick string,
|
||||
) *Conn {
|
||||
conn := newConn(tcpConn, log, nil, nil, cfg, nil)
|
||||
conn := newConn(
|
||||
context.Background(), tcpConn, log,
|
||||
nil, nil, cfg, nil,
|
||||
)
|
||||
conn.nick = nick
|
||||
|
||||
return conn
|
||||
|
||||
@@ -1373,42 +1373,6 @@ func TestIntegrationInviteUserOnChannel(t *testing.T) {
|
||||
)
|
||||
}
|
||||
|
||||
// TestIntegrationInviteLine checks that an IRC listener user
|
||||
// invited by an IRC listener user, and then over the HTTP
|
||||
// API, gets an INVITE line from the inviter for the channel
|
||||
// each time.
|
||||
func TestIntegrationInviteLine(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
env := newTestEnv(t)
|
||||
|
||||
alice := env.dial(t)
|
||||
alice.register("alice")
|
||||
alice.joinAndDrain("#inv")
|
||||
|
||||
bob := env.dial(t)
|
||||
bob.register("bob")
|
||||
|
||||
alice.sendAndExpect("INVITE bob #inv", " 341 ")
|
||||
|
||||
got := bob.readLine()
|
||||
want := ":alice!alice@* INVITE bob #inv"
|
||||
|
||||
if got != want {
|
||||
t.Errorf("from the IRC listener: got %q, want %q", got, want)
|
||||
}
|
||||
|
||||
// The HTTP API queues an INVITE with the channel as its body.
|
||||
env.queueMessage(t, "bob", "INVITE", "carol", "bob", []string{"#inv"})
|
||||
|
||||
got = bob.readLine()
|
||||
want = ":carol!carol@* INVITE bob #inv"
|
||||
|
||||
if got != want {
|
||||
t.Errorf("over the HTTP API: got %q, want %q", got, want)
|
||||
}
|
||||
}
|
||||
|
||||
// TestIntegrationModeSecretList checks that LIST shows a +s
|
||||
// channel only to its members.
|
||||
func TestIntegrationModeSecretList(t *testing.T) {
|
||||
|
||||
+50
-27
@@ -27,22 +27,17 @@ func (c *Conn) relayMessages(ctx context.Context) {
|
||||
default:
|
||||
}
|
||||
|
||||
// Register with the broker before draining, so that a
|
||||
// message queued after the drain has read the queue
|
||||
// still signals waitCh.
|
||||
waitCh := c.brk.Wait(c.sessionID)
|
||||
|
||||
// Drain any available messages.
|
||||
delivered := c.drainQueue(ctx)
|
||||
|
||||
if delivered {
|
||||
c.brk.Remove(c.sessionID, waitCh)
|
||||
|
||||
// Tight loop while there are messages.
|
||||
continue
|
||||
}
|
||||
|
||||
// Wait for notification or timeout.
|
||||
waitCh := c.brk.Wait(c.sessionID)
|
||||
|
||||
select {
|
||||
case <-waitCh:
|
||||
// New message notification — loop back.
|
||||
@@ -92,7 +87,7 @@ func (c *Conn) drainQueue(ctx context.Context) bool {
|
||||
//
|
||||
//nolint:cyclop // dispatch table
|
||||
func (c *Conn) deliverIRCMessage(
|
||||
ctx context.Context,
|
||||
_ context.Context,
|
||||
msg *db.IRCMessage,
|
||||
) {
|
||||
command := msg.Command
|
||||
@@ -120,7 +115,7 @@ func (c *Conn) deliverIRCMessage(
|
||||
case command == irc.CmdPart:
|
||||
c.deliverPart(msg, text)
|
||||
case command == irc.CmdNick:
|
||||
c.deliverNickChange(ctx, msg, text)
|
||||
c.deliverNickChange(msg, text)
|
||||
case command == irc.CmdQuit:
|
||||
c.deliverQuitMsg(msg, text)
|
||||
case command == irc.CmdTopic:
|
||||
@@ -198,6 +193,15 @@ func (c *Conn) deliverTextMessage(
|
||||
from := msg.From
|
||||
target := msg.To
|
||||
|
||||
c.mu.Lock()
|
||||
nick := c.nick
|
||||
c.mu.Unlock()
|
||||
|
||||
// Don't echo our own messages back.
|
||||
if from == nick {
|
||||
return
|
||||
}
|
||||
|
||||
prefix := from
|
||||
if !strings.Contains(prefix, "!") {
|
||||
prefix = from + "!" + from + "@*"
|
||||
@@ -210,6 +214,16 @@ func (c *Conn) deliverTextMessage(
|
||||
|
||||
// deliverJoin sends a JOIN notification.
|
||||
func (c *Conn) deliverJoin(msg *db.IRCMessage) {
|
||||
c.mu.Lock()
|
||||
nick := c.nick
|
||||
c.mu.Unlock()
|
||||
|
||||
// Don't echo our own JOINs (we already sent them
|
||||
// during joinChannel).
|
||||
if msg.From == nick {
|
||||
return
|
||||
}
|
||||
|
||||
prefix := msg.From + "!" + msg.From + "@*"
|
||||
channel := msg.To
|
||||
|
||||
@@ -218,6 +232,14 @@ func (c *Conn) deliverJoin(msg *db.IRCMessage) {
|
||||
|
||||
// deliverPart sends a PART notification.
|
||||
func (c *Conn) deliverPart(msg *db.IRCMessage, text string) {
|
||||
c.mu.Lock()
|
||||
nick := c.nick
|
||||
c.mu.Unlock()
|
||||
|
||||
if msg.From == nick {
|
||||
return
|
||||
}
|
||||
|
||||
prefix := msg.From + "!" + msg.From + "@*"
|
||||
channel := msg.To
|
||||
|
||||
@@ -230,17 +252,18 @@ func (c *Conn) deliverPart(msg *db.IRCMessage, text string) {
|
||||
}
|
||||
}
|
||||
|
||||
// deliverNickChange sends a NICK change notification. The
|
||||
// change may be its own session's, made from another client,
|
||||
// so the connection first takes the nick its session holds
|
||||
// now. It does not go by the line's old nick: the connection
|
||||
// may have taken that nick after another user gave it up.
|
||||
// deliverNickChange sends a NICK change notification.
|
||||
func (c *Conn) deliverNickChange(
|
||||
ctx context.Context,
|
||||
msg *db.IRCMessage,
|
||||
newNick string,
|
||||
) {
|
||||
c.loadSessionNick(ctx)
|
||||
c.mu.Lock()
|
||||
nick := c.nick
|
||||
c.mu.Unlock()
|
||||
|
||||
if msg.From == nick {
|
||||
return
|
||||
}
|
||||
|
||||
prefix := msg.From + "!" + msg.From + "@*"
|
||||
|
||||
@@ -252,6 +275,14 @@ func (c *Conn) deliverQuitMsg(
|
||||
msg *db.IRCMessage,
|
||||
text string,
|
||||
) {
|
||||
c.mu.Lock()
|
||||
nick := c.nick
|
||||
c.mu.Unlock()
|
||||
|
||||
if msg.From == nick {
|
||||
return
|
||||
}
|
||||
|
||||
prefix := msg.From + "!" + msg.From + "@*"
|
||||
|
||||
if text != "" {
|
||||
@@ -304,24 +335,16 @@ func (c *Conn) deliverKickMsg(
|
||||
}
|
||||
}
|
||||
|
||||
// deliverInviteMsg sends an INVITE line from the inviter
|
||||
// for the channel named in text, or nothing when text names
|
||||
// no channel.
|
||||
// deliverInviteMsg sends an INVITE notification.
|
||||
func (c *Conn) deliverInviteMsg(
|
||||
msg *db.IRCMessage,
|
||||
_ *db.IRCMessage,
|
||||
text string,
|
||||
) {
|
||||
if text == "" {
|
||||
return
|
||||
}
|
||||
|
||||
c.mu.Lock()
|
||||
nick := c.nick
|
||||
c.mu.Unlock()
|
||||
|
||||
prefix := msg.From + "!" + msg.From + "@*"
|
||||
|
||||
c.send(FormatMessage(prefix, "INVITE", nick, text))
|
||||
c.sendFromServer("NOTICE", nick, text)
|
||||
}
|
||||
|
||||
// deliverWallops sends a WALLOPS notification.
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
package ircserver_test
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"slices"
|
||||
"strings"
|
||||
@@ -9,7 +8,6 @@ import (
|
||||
"time"
|
||||
|
||||
"sneak.berlin/go/neoirc/internal/ircserver"
|
||||
"sneak.berlin/go/neoirc/internal/service"
|
||||
)
|
||||
|
||||
// queueMessage queues a message for the user with nick
|
||||
@@ -41,7 +39,7 @@ func (env *testEnv) queueMessage(
|
||||
t.Fatalf("get session of %s: %v", recipient, err)
|
||||
}
|
||||
|
||||
err = env.database.EnqueueToSession(ctx, sessionID, msgID, 0)
|
||||
err = env.database.EnqueueToSession(ctx, sessionID, msgID)
|
||||
if err != nil {
|
||||
t.Fatalf("enqueue: %v", err)
|
||||
}
|
||||
@@ -49,13 +47,14 @@ func (env *testEnv) queueMessage(
|
||||
env.brk.Notify(sessionID)
|
||||
}
|
||||
|
||||
// TestRelayKeepsOneWaitChannel checks that an IRC listener
|
||||
// connection holds at most one broker wait channel across
|
||||
// several relay ticks, both while idle and after the relay
|
||||
// has delivered it a message, and none once it closes.
|
||||
// TestRelayKeepsOneWaitChannel checks that an idle IRC
|
||||
// listener connection holds at most one broker wait channel
|
||||
// across several relay ticks, and none once it closes.
|
||||
func TestRelayKeepsOneWaitChannel(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
const idleTicks = 5
|
||||
|
||||
env := newTestEnv(t)
|
||||
|
||||
client := env.dial(t)
|
||||
@@ -66,17 +65,15 @@ func TestRelayKeepsOneWaitChannel(t *testing.T) {
|
||||
t.Fatalf("get session of idle: %v", err)
|
||||
}
|
||||
|
||||
env.checkOneWaitChannel(t, sessionID)
|
||||
for tick := range idleTicks {
|
||||
time.Sleep(ircserver.PollInterval)
|
||||
|
||||
env.queueMessage(
|
||||
t, "idle", "PRIVMSG", "carol", "idle", []string{"hello"},
|
||||
)
|
||||
|
||||
client.readUntil(func(l string) bool {
|
||||
return strings.Contains(l, "hello")
|
||||
})
|
||||
|
||||
env.checkOneWaitChannel(t, sessionID)
|
||||
got := env.brk.ListenerCount(sessionID)
|
||||
if got > 1 {
|
||||
t.Fatalf("tick %d: got %d wait channels, want at most 1",
|
||||
tick+1, got)
|
||||
}
|
||||
}
|
||||
|
||||
err = client.conn.Close()
|
||||
if err != nil {
|
||||
@@ -95,28 +92,6 @@ func TestRelayKeepsOneWaitChannel(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
// checkOneWaitChannel fails the test if the session
|
||||
// sessionID holds more than one broker wait channel at any of
|
||||
// several relay ticks.
|
||||
func (env *testEnv) checkOneWaitChannel(
|
||||
t *testing.T,
|
||||
sessionID int64,
|
||||
) {
|
||||
t.Helper()
|
||||
|
||||
const ticks = 5
|
||||
|
||||
for tick := range ticks {
|
||||
time.Sleep(ircserver.PollInterval)
|
||||
|
||||
got := env.brk.ListenerCount(sessionID)
|
||||
if got > 1 {
|
||||
t.Fatalf("tick %d: got %d wait channels, want at most 1",
|
||||
tick+1, got)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// TestRelayMultiLineBody checks that each line of a PRIVMSG
|
||||
// or NOTICE body sent over the HTTP API reaches an IRC
|
||||
// listener user as its own line.
|
||||
@@ -213,38 +188,6 @@ func TestRelayModeParameters(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
// TestRelayInviteWithoutChannel checks that an INVITE whose
|
||||
// body names no channel sends the invited IRC listener user
|
||||
// no INVITE line.
|
||||
func TestRelayInviteWithoutChannel(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
env := newTestEnv(t)
|
||||
|
||||
bob := env.dial(t)
|
||||
bob.register("bob")
|
||||
|
||||
// A nil body is stored as JSON null, which is not an array.
|
||||
for _, body := range [][]string{nil, {}, {""}} {
|
||||
env.queueMessage(t, "bob", "INVITE", "carol", "bob", body)
|
||||
}
|
||||
|
||||
// The relay sends a user's queue in order, so this arrives
|
||||
// after anything sent for the INVITEs above.
|
||||
env.queueMessage(t, "bob", "PRIVMSG", "carol", "bob",
|
||||
[]string{"the end"})
|
||||
|
||||
lines := bob.readUntil(func(l string) bool {
|
||||
return strings.HasSuffix(l, " :the end")
|
||||
})
|
||||
|
||||
for _, line := range lines {
|
||||
if strings.Contains(line, " INVITE ") {
|
||||
t.Errorf("got %q, want no INVITE line", line)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// TestRelayLineBreaks checks that a CR, LF or NUL in a stored
|
||||
// body line, key or mask never reaches an IRC listener user
|
||||
// as a line break, so no extra line arrives, and that a body
|
||||
@@ -326,372 +269,3 @@ func TestRelayNickDiffersOnlyInCase(t *testing.T) {
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// TestRelayOwnChangeOnce checks that an IRC listener user who
|
||||
// sets a topic, changes a channel mode or kicks gets one TOPIC,
|
||||
// MODE or KICK line for it, and so does the other member.
|
||||
func TestRelayOwnChangeOnce(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
for _, step := range []struct {
|
||||
command, line string
|
||||
}{
|
||||
{"TOPIC", "TOPIC #dup :new topic"},
|
||||
{"MODE", "MODE #dup +m"},
|
||||
{"KICK", "KICK #dup carl :bye"},
|
||||
} {
|
||||
t.Run(step.command, func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
env := newTestEnv(t)
|
||||
|
||||
alice := env.dial(t)
|
||||
alice.register("alice")
|
||||
alice.joinAndDrain("#dup")
|
||||
|
||||
carl := env.dial(t)
|
||||
carl.register("carl")
|
||||
carl.joinAndDrain("#dup")
|
||||
|
||||
alice.send(step.line)
|
||||
|
||||
// The reply to alice's next command comes after her
|
||||
// command has finished, so her own copy comes before it.
|
||||
beforePong := alice.sendAndExpect("PING :done", "PONG")
|
||||
|
||||
// The relay sends a user's queue in order, so a message
|
||||
// queued now arrives after any relayed copy.
|
||||
for nick, client := range map[string]*testClient{
|
||||
"alice": alice, "carl": carl,
|
||||
} {
|
||||
env.queueMessage(
|
||||
t, nick, "PRIVMSG", "dave", nick,
|
||||
[]string{"after the change"},
|
||||
)
|
||||
|
||||
lines := client.readUntil(func(l string) bool {
|
||||
return strings.HasSuffix(l, " :after the change")
|
||||
})
|
||||
|
||||
if client == alice {
|
||||
lines = slices.Concat(beforePong, lines)
|
||||
}
|
||||
|
||||
var changes []string
|
||||
|
||||
for _, line := range lines {
|
||||
if strings.Contains(line, " "+step.command+" #dup ") {
|
||||
changes = append(changes, line)
|
||||
}
|
||||
}
|
||||
|
||||
if len(changes) != 1 {
|
||||
t.Errorf("%s got %q, want one %s line",
|
||||
nick, changes, step.command)
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// TestRelayOwnSessionOnce checks that a command a user makes
|
||||
// from one client of their session reaches each of the
|
||||
// session's clients once: an IRC listener connection and an
|
||||
// HTTP API client. The connection that sent a command gets
|
||||
// only its own echo, and none for PRIVMSG and NOTICE, which
|
||||
// IRC does not echo.
|
||||
//
|
||||
//nolint:funlen // table-driven test
|
||||
func TestRelayOwnSessionOnce(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
hello := json.RawMessage(`["hello"]`)
|
||||
|
||||
for _, step := range []struct {
|
||||
// line is the command as alice sends it on the IRC
|
||||
// listener.
|
||||
line string
|
||||
// api makes the same command for her session the way
|
||||
// the HTTP API does.
|
||||
api func(
|
||||
ctx context.Context, svc *service.Service, sessionID int64,
|
||||
) error
|
||||
// echoes is how many copies alice's connection gets of
|
||||
// line when it sends line itself.
|
||||
echoes int
|
||||
}{
|
||||
{"PRIVMSG #chan :hello", func(
|
||||
ctx context.Context, svc *service.Service, sessionID int64,
|
||||
) error {
|
||||
_, err := svc.SendChannelMessage(
|
||||
ctx, sessionID, 0, "alice", "PRIVMSG", "#chan", hello, nil,
|
||||
)
|
||||
|
||||
return err
|
||||
}, 0},
|
||||
{"NOTICE bob :hello", func(
|
||||
ctx context.Context, svc *service.Service, sessionID int64,
|
||||
) error {
|
||||
_, err := svc.SendDirectMessage(
|
||||
ctx, sessionID, 0, "alice", "NOTICE", "bob", hello, nil,
|
||||
)
|
||||
|
||||
return err
|
||||
}, 0},
|
||||
{"JOIN #other", func(
|
||||
ctx context.Context, svc *service.Service, sessionID int64,
|
||||
) error {
|
||||
_, err := svc.JoinChannel(ctx, sessionID, 0, "alice", "#other", "")
|
||||
|
||||
return err
|
||||
}, 1},
|
||||
{"PART #chan :bye", func(
|
||||
ctx context.Context, svc *service.Service, sessionID int64,
|
||||
) error {
|
||||
return svc.PartChannel(ctx, sessionID, 0, "alice", "#chan", "bye")
|
||||
}, 1},
|
||||
{"NICK alice2", func(
|
||||
ctx context.Context, svc *service.Service, sessionID int64,
|
||||
) error {
|
||||
return svc.ChangeNick(ctx, sessionID, 0, "alice", "alice2")
|
||||
}, 1},
|
||||
{"TOPIC #chan :new topic", func(
|
||||
ctx context.Context, svc *service.Service, sessionID int64,
|
||||
) error {
|
||||
return svc.SetTopic(
|
||||
ctx, sessionID, 0, "alice", "#chan", "new topic",
|
||||
)
|
||||
}, 1},
|
||||
{"MODE #chan +m", func(
|
||||
ctx context.Context, svc *service.Service, sessionID int64,
|
||||
) error {
|
||||
chID, err := svc.ValidateChannelOp(ctx, sessionID, "#chan")
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
err = svc.SetChannelFlag(ctx, chID, 'm', true)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
svc.BroadcastMode(ctx, 0, "alice", "#chan", chID, "+m")
|
||||
|
||||
return nil
|
||||
}, 1},
|
||||
{"KICK #chan bob :bye", func(
|
||||
ctx context.Context, svc *service.Service, sessionID int64,
|
||||
) error {
|
||||
return svc.KickUser(
|
||||
ctx, sessionID, 0, "alice", "#chan", "bob", "bye",
|
||||
)
|
||||
}, 1},
|
||||
} {
|
||||
command := strings.Fields(step.line)[0]
|
||||
|
||||
t.Run(command+" from IRC", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
ircCopies, httpCopies := ownSessionCopies(t, step.line, nil)
|
||||
if ircCopies != step.echoes || httpCopies != 1 {
|
||||
t.Errorf("connection got %d, HTTP client got %d, want %d and 1",
|
||||
ircCopies, httpCopies, step.echoes)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run(command+" from the HTTP API", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
ircCopies, httpCopies := ownSessionCopies(t, step.line, step.api)
|
||||
if ircCopies != 1 || httpCopies != 1 {
|
||||
t.Errorf("connection got %d, HTTP client got %d, want 1 and 1",
|
||||
ircCopies, httpCopies)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// ownSessionCopies sets up alice with aliceWithHTTPClient. It
|
||||
// makes the command line from her connection, or with api from
|
||||
// the HTTP API client when api is not nil, and returns how many
|
||||
// copies of it her connection and her HTTP API client got.
|
||||
func ownSessionCopies(
|
||||
t *testing.T,
|
||||
line string,
|
||||
api func(ctx context.Context, svc *service.Service, sessionID int64) error,
|
||||
) (int, int) {
|
||||
t.Helper()
|
||||
|
||||
ctx := t.Context()
|
||||
env := newTestEnv(t)
|
||||
alice, _, sessionID, httpClientID := aliceWithHTTPClient(t, env)
|
||||
|
||||
var lines []string
|
||||
|
||||
if api == nil {
|
||||
alice.send(line)
|
||||
|
||||
// Her echo comes before the reply to her next command.
|
||||
lines = alice.sendAndExpect("PING :done", "PONG")
|
||||
} else {
|
||||
err := api(ctx, env.srv.Service(), sessionID)
|
||||
if err != nil {
|
||||
t.Fatalf("%s over the HTTP API: %v", line, err)
|
||||
}
|
||||
}
|
||||
|
||||
msgs, _, err := env.database.PollMessages(ctx, httpClientID, 0, 0)
|
||||
if err != nil {
|
||||
t.Fatalf("poll the HTTP API client: %v", err)
|
||||
}
|
||||
|
||||
httpCopies := 0
|
||||
|
||||
for _, msg := range msgs {
|
||||
if msg.Command == strings.Fields(line)[0] {
|
||||
httpCopies++
|
||||
}
|
||||
}
|
||||
|
||||
// The relay sends a queue in order, so this arrives after any
|
||||
// copy. It is queued by session, as NICK changes her nick.
|
||||
endID, _, err := env.database.InsertMessage(
|
||||
ctx, "PRIVMSG", "dave", "alice", 0, 0,
|
||||
nil, json.RawMessage(`["the end"]`), nil,
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatalf("insert message: %v", err)
|
||||
}
|
||||
|
||||
err = env.database.EnqueueToSession(ctx, sessionID, endID, 0)
|
||||
if err != nil {
|
||||
t.Fatalf("enqueue: %v", err)
|
||||
}
|
||||
|
||||
env.brk.Notify(sessionID)
|
||||
|
||||
lines = append(lines, alice.readUntil(func(l string) bool {
|
||||
return strings.HasSuffix(l, " :the end")
|
||||
})...)
|
||||
|
||||
// A copy starts with the command and its first parameter.
|
||||
start := " " + strings.Join(strings.Fields(line)[:2], " ")
|
||||
ircCopies := strings.Count(strings.Join(lines, "\n"), start)
|
||||
|
||||
return ircCopies, httpCopies
|
||||
}
|
||||
|
||||
// aliceWithHTTPClient connects alice to the IRC listener and
|
||||
// has her join #chan, which bob is on too, then adds an HTTP API
|
||||
// client to her session with the password her connection set,
|
||||
// as POST /api/v1/login does. It returns her connection, bob's
|
||||
// connection, her session and her HTTP API client.
|
||||
func aliceWithHTTPClient(
|
||||
t *testing.T, env *testEnv,
|
||||
) (*testClient, *testClient, int64, int64) {
|
||||
t.Helper()
|
||||
|
||||
const password = "alicepass"
|
||||
|
||||
alice := env.dial(t)
|
||||
alice.send("PASS " + password)
|
||||
alice.register("alice")
|
||||
// Registration stores the password before the JOIN runs.
|
||||
alice.joinAndDrain("#chan")
|
||||
|
||||
bob := env.dial(t)
|
||||
bob.register("bob")
|
||||
bob.joinAndDrain("#chan")
|
||||
|
||||
sessionID, httpClientID, _, err := env.database.LoginUser(
|
||||
t.Context(), "alice", password, "127.0.0.1", "localhost",
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatalf("log in as alice: %v", err)
|
||||
}
|
||||
|
||||
return alice, bob, sessionID, httpClientID
|
||||
}
|
||||
|
||||
// TestRelayNickChangeFromHTTPAPI checks that once alice's nick
|
||||
// is changed from her HTTP API client, her IRC listener
|
||||
// connection uses the new nick: what she then sends from it
|
||||
// reaches bob under the new nick.
|
||||
func TestRelayNickChangeFromHTTPAPI(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
env := newTestEnv(t)
|
||||
alice, bob, sessionID, _ := aliceWithHTTPClient(t, env)
|
||||
|
||||
bob.joinAndDrain("#other")
|
||||
|
||||
// As the HTTP API does.
|
||||
err := env.srv.Service().ChangeNick(
|
||||
t.Context(), sessionID, 0, "alice", "alice2",
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatalf("change nick over the HTTP API: %v", err)
|
||||
}
|
||||
|
||||
// Her connection has taken the new nick once it has sent her
|
||||
// the change.
|
||||
const change = ":alice!alice@* NICK alice2"
|
||||
|
||||
alice.readUntil(func(l string) bool { return l == change })
|
||||
bob.readUntil(func(l string) bool { return l == change })
|
||||
|
||||
for _, step := range []struct {
|
||||
line, want string
|
||||
}{
|
||||
{"PRIVMSG #chan :hi there", ":alice2!alice2@* PRIVMSG #chan :hi there"},
|
||||
{"JOIN #other", ":alice2!alice2@* JOIN #other"},
|
||||
{"NICK alice3", ":alice2!alice2@* NICK alice3"},
|
||||
} {
|
||||
alice.send(step.line)
|
||||
|
||||
got := bob.readLine()
|
||||
if got != step.want {
|
||||
t.Errorf("%s: got %q, want %q", step.line, got, step.want)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// TestRelayNickChangeKeepsTakenNick checks that an IRC
|
||||
// listener connection which takes a nick another user has
|
||||
// given up keeps it when that user's change reaches it
|
||||
// afterwards: what it then sends goes out under the nick its
|
||||
// session holds.
|
||||
func TestRelayNickChangeKeepsTakenNick(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
env := newTestEnv(t)
|
||||
|
||||
bob := env.dial(t)
|
||||
bob.register("bob")
|
||||
bob.sendAndExpect("NICK bob2", " NICK bob2")
|
||||
|
||||
alice := env.dial(t)
|
||||
alice.register("alice")
|
||||
alice.sendAndExpect("NICK bob", " NICK bob")
|
||||
alice.joinAndDrain("#chan")
|
||||
|
||||
bob.joinAndDrain("#chan")
|
||||
|
||||
// Bob's change reaches alice only now, as it does when she
|
||||
// takes his old nick before her connection has passed the
|
||||
// change on. She holds bob now, so it is queued to bob.
|
||||
env.queueMessage(t, "bob", "NICK", "bob", "", []string{"bob2"})
|
||||
|
||||
alice.readUntil(func(l string) bool {
|
||||
return l == ":bob!bob@* NICK bob2"
|
||||
})
|
||||
|
||||
alice.send("PRIVMSG #chan :hi there")
|
||||
|
||||
const want = ":bob!bob@* PRIVMSG #chan :hi there"
|
||||
|
||||
got := bob.readLine()
|
||||
if got != want {
|
||||
t.Errorf("got %q, want %q", got, want)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -52,10 +52,6 @@ type Server struct {
|
||||
// same names, except in tests, which shorten them.
|
||||
pingInterval time.Duration
|
||||
pongDeadline time.Duration
|
||||
|
||||
// resolveHost is the function of the same name, except in
|
||||
// tests, which replace it with one that blocks.
|
||||
resolveHost func(ctx context.Context, addr string) string
|
||||
}
|
||||
|
||||
// New creates a new IRC Server and registers its lifecycle
|
||||
@@ -79,7 +75,6 @@ func New(
|
||||
|
||||
pingInterval: pingInterval,
|
||||
pongDeadline: pongDeadline,
|
||||
resolveHost: resolveHost,
|
||||
}
|
||||
|
||||
listenAddr := params.Config.IRCListenAddr
|
||||
@@ -180,7 +175,7 @@ func (s *Server) acceptLoop(ctx context.Context) {
|
||||
}
|
||||
|
||||
client := newConn(
|
||||
tcpConn, s.log,
|
||||
ctx, tcpConn, s.log,
|
||||
s.database, s.brk, s.cfg, s.svc,
|
||||
)
|
||||
|
||||
@@ -209,10 +204,7 @@ func (s *Server) acceptLoop(ctx context.Context) {
|
||||
s.mu.Unlock()
|
||||
}()
|
||||
|
||||
client.serve(
|
||||
ctx, s.resolveHost,
|
||||
s.pingInterval, s.pongDeadline,
|
||||
)
|
||||
client.serve(ctx, s.pingInterval, s.pongDeadline)
|
||||
}()
|
||||
}
|
||||
}
|
||||
|
||||
@@ -2,7 +2,6 @@ package ircserver_test
|
||||
|
||||
import (
|
||||
"bufio"
|
||||
"context"
|
||||
"crypto/rand"
|
||||
"database/sql"
|
||||
"errors"
|
||||
@@ -12,7 +11,6 @@ import (
|
||||
"os"
|
||||
"runtime"
|
||||
"strings"
|
||||
"sync/atomic"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
@@ -92,21 +90,6 @@ func newTestEnvWithPingTimes(
|
||||
) *testEnv {
|
||||
t.Helper()
|
||||
|
||||
return newTestEnvWithResolver(
|
||||
t, cfg, interval, deadline, ircserver.ResolveHost,
|
||||
)
|
||||
}
|
||||
|
||||
// newTestEnvWithResolver is newTestEnvWithPingTimes, except
|
||||
// that the server looks up a client's hostname with resolve.
|
||||
func newTestEnvWithResolver(
|
||||
t *testing.T,
|
||||
cfg *config.Config,
|
||||
interval, deadline time.Duration,
|
||||
resolve func(ctx context.Context, addr string) string,
|
||||
) *testEnv {
|
||||
t.Helper()
|
||||
|
||||
// A random name, so that no other test environment, not
|
||||
// even an earlier run of the same test, can share it.
|
||||
dsn := fmt.Sprintf(
|
||||
@@ -164,7 +147,7 @@ func newTestEnvWithResolver(
|
||||
))
|
||||
|
||||
srv := ircserver.NewTestServer(
|
||||
log, cfg, database, brk, interval, deadline, resolve,
|
||||
log, cfg, database, brk, interval, deadline,
|
||||
)
|
||||
|
||||
err = srv.Start(addr)
|
||||
@@ -432,49 +415,6 @@ func TestRegistration(t *testing.T) {
|
||||
assertContains(t, lines, " 001 ", "RPL_WELCOME")
|
||||
}
|
||||
|
||||
// TestRegistrationWhileAnotherLookupIsPending checks that a
|
||||
// client is accepted and registered while the hostname lookup
|
||||
// of an earlier client has not returned, and that it
|
||||
// registers with the hostname its own lookup returned.
|
||||
func TestRegistrationWhileAnotherLookupIsPending(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
const lookedUpHost = "client.example"
|
||||
|
||||
var lookups atomic.Int32
|
||||
|
||||
firstLookupStarted := make(chan struct{})
|
||||
|
||||
// The first lookup returns only when the server stops.
|
||||
resolve := func(ctx context.Context, _ string) string {
|
||||
if lookups.Add(1) == 1 {
|
||||
close(firstLookupStarted)
|
||||
<-ctx.Done()
|
||||
}
|
||||
|
||||
return lookedUpHost
|
||||
}
|
||||
|
||||
env := newTestEnvWithResolver(
|
||||
t, &config.Config{ServerName: testServerName},
|
||||
ircserver.PingInterval, ircserver.PongDeadline, resolve,
|
||||
)
|
||||
|
||||
env.dial(t)
|
||||
|
||||
select {
|
||||
case <-firstLookupStarted:
|
||||
case <-time.After(testTimeout):
|
||||
t.Fatal("the first client's lookup did not start")
|
||||
}
|
||||
|
||||
lines := env.dial(t).register("second")
|
||||
assertContains(
|
||||
t, lines, "second!second@"+lookedUpHost,
|
||||
"RPL_WELCOME with the looked-up hostname",
|
||||
)
|
||||
}
|
||||
|
||||
// TestEachTestEnvHasItsOwnDatabase checks that a test
|
||||
// environment starts on an empty database while another one
|
||||
// is still open.
|
||||
@@ -645,6 +585,8 @@ func TestNewPingTimes(t *testing.T) {
|
||||
func TestIdleCleanupKeepsActiveUser(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
const idleTimeout = 500 * time.Millisecond
|
||||
|
||||
env := newTestEnv(t)
|
||||
|
||||
active := env.dial(t)
|
||||
@@ -653,17 +595,13 @@ func TestIdleCleanupKeepsActiveUser(t *testing.T) {
|
||||
idle := env.dial(t)
|
||||
idle.register("idle")
|
||||
|
||||
// Both users were last seen before cutoff, and only active
|
||||
// sends a command after it, so the result does not depend
|
||||
// on how long the PONG takes to arrive.
|
||||
cutoff := time.Now()
|
||||
|
||||
time.Sleep(idleTimeout)
|
||||
active.sendAndExpect("PING :still here", "PONG")
|
||||
|
||||
// The idle cleanup in internal/handlers removes exactly
|
||||
// the users this returns.
|
||||
stale, err := env.database.GetStaleOrphanSessions(
|
||||
t.Context(), cutoff,
|
||||
t.Context(), time.Now().Add(-idleTimeout),
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatalf("get stale sessions: %v", err)
|
||||
@@ -1160,165 +1098,6 @@ func TestHandlePassPostRegistration(t *testing.T) {
|
||||
)
|
||||
}
|
||||
|
||||
// The shortest and longest password PASS accepts; bcrypt
|
||||
// cannot hash more than 72 bytes.
|
||||
const (
|
||||
minPasswordBytes = 8
|
||||
maxPasswordBytes = 72
|
||||
)
|
||||
|
||||
// passwordLengthNotice is the NOTICE text for a password that
|
||||
// is too short or too long.
|
||||
const passwordLengthNotice = "Password must be 8 to 72 bytes"
|
||||
|
||||
// passwordCase is a password a PASS test sends, and whether
|
||||
// the server should store it.
|
||||
type passwordCase struct {
|
||||
name string
|
||||
password string
|
||||
stored bool
|
||||
}
|
||||
|
||||
// passwordCases returns the passwords the PASS length tests
|
||||
// send: one of 8 to 72 bytes is stored and any other is
|
||||
// refused. The limit counts bytes: "é" is two bytes in UTF-8,
|
||||
// so 72 of them are refused.
|
||||
func passwordCases() []passwordCase {
|
||||
return []passwordCase{
|
||||
{"empty", "", false},
|
||||
{"7 bytes", strings.Repeat("a", minPasswordBytes-1), false},
|
||||
{"8 bytes", strings.Repeat("a", minPasswordBytes), true},
|
||||
{"72 bytes", strings.Repeat("a", maxPasswordBytes), true},
|
||||
{"73 bytes", strings.Repeat("a", maxPasswordBytes+1), false},
|
||||
{"72 characters", strings.Repeat("é", maxPasswordBytes), false},
|
||||
}
|
||||
}
|
||||
|
||||
// assertStored fails the test unless nick can log in with
|
||||
// password exactly when stored is true.
|
||||
func assertStored(
|
||||
t *testing.T, env *testEnv, nick, password string, stored bool,
|
||||
) {
|
||||
t.Helper()
|
||||
|
||||
_, _, token, err := env.database.LoginUser(
|
||||
t.Context(), nick, password, "127.0.0.1", "localhost",
|
||||
)
|
||||
|
||||
loggedIn := err == nil && token != ""
|
||||
if loggedIn != stored {
|
||||
t.Errorf(
|
||||
"log in as %s: logged in %v, want %v (error: %v)",
|
||||
nick, loggedIn, stored, err,
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
// TestPassPostRegistrationLength checks that PASS after
|
||||
// registration stores and confirms a password of 8 to 72
|
||||
// bytes, and refuses any other with a NOTICE.
|
||||
func TestPassPostRegistrationLength(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
env := newTestEnv(t)
|
||||
|
||||
for i, tc := range passwordCases() {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
nick := fmt.Sprintf("postpass%d", i)
|
||||
client := env.dial(t)
|
||||
|
||||
client.register(nick)
|
||||
client.send("PASS :" + tc.password)
|
||||
|
||||
// The server answers commands in order, so its
|
||||
// reply to PASS comes before the PONG.
|
||||
lines := client.sendAndExpect("PING :after", "PONG")
|
||||
|
||||
reply := passwordLengthNotice
|
||||
if tc.stored {
|
||||
reply = "Password set"
|
||||
}
|
||||
|
||||
assertContains(t, lines, reply, "reply to PASS")
|
||||
assertStored(t, env, nick, tc.password, tc.stored)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// TestPassPostRegistrationNotStored checks that PASS is not
|
||||
// confirmed when the password could not be stored.
|
||||
func TestPassPostRegistrationNotStored(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
env := newTestEnv(t)
|
||||
client := env.dial(t)
|
||||
|
||||
client.register("failpass")
|
||||
|
||||
_, err := env.database.GetDB().ExecContext(t.Context(),
|
||||
`CREATE TRIGGER refuse_password
|
||||
BEFORE UPDATE OF password_hash ON sessions
|
||||
BEGIN SELECT RAISE(ABORT, 'refused'); END`,
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatalf("create trigger: %v", err)
|
||||
}
|
||||
|
||||
client.send("PASS :mypassword123")
|
||||
|
||||
// The server answers commands in order, so anything it
|
||||
// sent about PASS comes before the PONG.
|
||||
lines := client.sendAndExpect("PING :after", "PONG")
|
||||
|
||||
assertNotContains(
|
||||
t, lines, "Password set",
|
||||
"confirmation of a password that was not stored",
|
||||
)
|
||||
}
|
||||
|
||||
// TestPassBeforeRegistrationLength checks that a PASS before
|
||||
// registration stores a password of 8 to 72 bytes, and that
|
||||
// any other is refused with a NOTICE once registration
|
||||
// completes.
|
||||
func TestPassBeforeRegistrationLength(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
env := newTestEnv(t)
|
||||
|
||||
for i, tc := range passwordCases() {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
nick := fmt.Sprintf("prepass%d", i)
|
||||
client := env.dial(t)
|
||||
|
||||
client.send("PASS :" + tc.password)
|
||||
client.register(nick)
|
||||
|
||||
// The password is checked after the welcome
|
||||
// burst, which register reads; the PONG comes
|
||||
// after that.
|
||||
lines := client.sendAndExpect("PING :after", "PONG")
|
||||
|
||||
if tc.stored {
|
||||
assertNotContains(
|
||||
t, lines, passwordLengthNotice,
|
||||
"refusal of a valid password",
|
||||
)
|
||||
} else {
|
||||
assertContains(
|
||||
t, lines, passwordLengthNotice,
|
||||
"refusal after registration",
|
||||
)
|
||||
}
|
||||
|
||||
assertStored(t, env, nick, tc.password, tc.stored)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestPreRegistrationNotRegistered(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
|
||||
+68
-64
@@ -312,7 +312,7 @@ func (s *Service) SendWallops(
|
||||
|
||||
_, _, err = s.FanOut(
|
||||
ctx, irc.CmdWallops, nick, "*", 0, 0,
|
||||
nil, body, nil, recipients, 0,
|
||||
nil, body, nil, recipients,
|
||||
)
|
||||
if err != nil {
|
||||
return fmt.Errorf("wallops: %w", err)
|
||||
@@ -347,19 +347,12 @@ type DirectMsgResult struct {
|
||||
// session IDs, notifying each via the broker. toSessionID
|
||||
// and toChannelID are the recipient InsertMessage records
|
||||
// for history, 0 when there is none.
|
||||
//
|
||||
// skipClientID is the client whose queue the message is
|
||||
// not added to: the IRC listener connection that sent the
|
||||
// command, which has already shown it to its user. The HTTP
|
||||
// API passes 0, as its clients see their own commands
|
||||
// through their queues.
|
||||
func (s *Service) FanOut(
|
||||
ctx context.Context,
|
||||
command, from, to string,
|
||||
toSessionID, toChannelID int64,
|
||||
params, body, meta json.RawMessage,
|
||||
sessionIDs []int64,
|
||||
skipClientID int64,
|
||||
) (int64, string, error) {
|
||||
dbID, msgUUID, err := s.db.InsertMessage(
|
||||
ctx, command, from, to,
|
||||
@@ -370,40 +363,58 @@ func (s *Service) FanOut(
|
||||
}
|
||||
|
||||
for _, sid := range sessionIDs {
|
||||
_ = s.db.EnqueueToSession(ctx, sid, dbID, skipClientID)
|
||||
_ = s.db.EnqueueToSession(ctx, sid, dbID)
|
||||
s.broker.Notify(sid)
|
||||
}
|
||||
|
||||
return dbID, msgUUID, nil
|
||||
}
|
||||
|
||||
// excludeSession returns a copy of ids without the given
|
||||
// session.
|
||||
func excludeSession(
|
||||
ids []int64,
|
||||
exclude int64,
|
||||
) []int64 {
|
||||
out := make([]int64, 0, len(ids))
|
||||
|
||||
for _, id := range ids {
|
||||
if id != exclude {
|
||||
out = append(out, id)
|
||||
}
|
||||
}
|
||||
|
||||
return out
|
||||
}
|
||||
|
||||
// SendChannelMessage checks membership, bans and
|
||||
// moderation, then the hashcash stamp of a PRIVMSG to a +H
|
||||
// channel, then fans out a message to all channel members,
|
||||
// the sender's session included, skipping client
|
||||
// skipClientID as FanOut does. The stamp is checked after
|
||||
// the other checks so that a message they refuse does not
|
||||
// spend it. Returns the message UUID and any error.
|
||||
// channel, then fans out a message to all channel members
|
||||
// except the sender. The stamp is checked after the other
|
||||
// checks so that a message they refuse does not spend it.
|
||||
// Returns the database row ID, message UUID, and any error.
|
||||
// The dbID lets callers enqueue the same message to the
|
||||
// sender when echo is needed (HTTP transport).
|
||||
func (s *Service) SendChannelMessage(
|
||||
ctx context.Context,
|
||||
sessionID, skipClientID int64,
|
||||
sessionID int64,
|
||||
nick, command, channel string,
|
||||
body, meta json.RawMessage,
|
||||
) (string, error) {
|
||||
) (int64, string, error) {
|
||||
noSuchChannel := &IRCError{
|
||||
irc.ErrNoSuchChannel, []string{channel}, msgNoSuchChannel,
|
||||
}
|
||||
|
||||
chID, err := s.db.GetChannelByName(ctx, channel)
|
||||
if err != nil {
|
||||
return "", noSuchChannel
|
||||
return 0, "", noSuchChannel
|
||||
}
|
||||
|
||||
isMember, _ := s.db.IsChannelMember(
|
||||
ctx, chID, sessionID,
|
||||
)
|
||||
if !isMember {
|
||||
return "", &IRCError{
|
||||
return 0, "", &IRCError{
|
||||
irc.ErrCannotSendToChan,
|
||||
[]string{channel},
|
||||
"Cannot send to channel",
|
||||
@@ -415,7 +426,7 @@ func (s *Service) SendChannelMessage(
|
||||
ctx, chID, sessionID,
|
||||
)
|
||||
if banErr == nil && isBanned {
|
||||
return "", &IRCError{
|
||||
return 0, "", &IRCError{
|
||||
irc.ErrCannotSendToChan,
|
||||
[]string{channel},
|
||||
"Cannot send to channel (+b)",
|
||||
@@ -432,7 +443,7 @@ func (s *Service) SendChannelMessage(
|
||||
)
|
||||
|
||||
if !isOp && !isVoiced {
|
||||
return "", &IRCError{
|
||||
return 0, "", &IRCError{
|
||||
irc.ErrCannotSendToChan,
|
||||
[]string{channel},
|
||||
"Cannot send to channel (+m)",
|
||||
@@ -445,35 +456,35 @@ func (s *Service) SendChannelMessage(
|
||||
ctx, chID, channel, body, meta,
|
||||
)
|
||||
if err != nil {
|
||||
return "", err
|
||||
return 0, "", err
|
||||
}
|
||||
}
|
||||
|
||||
memberIDs, _ := s.db.GetChannelMemberIDs(ctx, chID)
|
||||
recipients := excludeSession(memberIDs, sessionID)
|
||||
|
||||
_, uuid, fanErr := s.FanOut(
|
||||
dbID, uuid, fanErr := s.FanOut(
|
||||
ctx, command, nick, channel, 0, chID,
|
||||
nil, body, meta, memberIDs, skipClientID,
|
||||
nil, body, meta, recipients,
|
||||
)
|
||||
// The channel was deleted after the lookup above.
|
||||
if db.IsForeignKeyConstraintError(fanErr) {
|
||||
return "", noSuchChannel
|
||||
return 0, "", noSuchChannel
|
||||
}
|
||||
|
||||
if fanErr != nil {
|
||||
return "", fanErr
|
||||
return 0, "", fanErr
|
||||
}
|
||||
|
||||
return uuid, nil
|
||||
return dbID, uuid, nil
|
||||
}
|
||||
|
||||
// SendDirectMessage validates the target and sends a
|
||||
// direct message to the target and the sender's session,
|
||||
// skipping client skipClientID as FanOut does, and returns
|
||||
// the message UUID and any away message set on the target.
|
||||
// direct message, returning the message UUID and any away
|
||||
// message set on the target.
|
||||
func (s *Service) SendDirectMessage(
|
||||
ctx context.Context,
|
||||
sessionID, skipClientID int64,
|
||||
sessionID int64,
|
||||
nick, command, target string,
|
||||
body, meta json.RawMessage,
|
||||
) (*DirectMsgResult, error) {
|
||||
@@ -495,7 +506,7 @@ func (s *Service) SendDirectMessage(
|
||||
|
||||
_, uuid, fanErr := s.FanOut(
|
||||
ctx, command, nick, target, targetSID, 0,
|
||||
nil, body, meta, recipients, skipClientID,
|
||||
nil, body, meta, recipients,
|
||||
)
|
||||
// The target's session was deleted after the lookup above.
|
||||
if db.IsForeignKeyConstraintError(fanErr) {
|
||||
@@ -511,12 +522,11 @@ func (s *Service) SendDirectMessage(
|
||||
|
||||
// JoinChannel creates or joins a channel, making the
|
||||
// first joiner the operator. Fans out the JOIN to all
|
||||
// channel members, skipping client skipClientID as FanOut
|
||||
// does. A channel name that validChannelRe does not match
|
||||
// gets ERR_NOSUCHCHANNEL.
|
||||
// channel members. A channel name that validChannelRe
|
||||
// does not match gets ERR_NOSUCHCHANNEL.
|
||||
func (s *Service) JoinChannel(
|
||||
ctx context.Context,
|
||||
sessionID, skipClientID int64,
|
||||
sessionID int64,
|
||||
nick, channel, suppliedKey string,
|
||||
) (*JoinResult, error) {
|
||||
if !validChannelRe.MatchString(channel) {
|
||||
@@ -539,7 +549,7 @@ func (s *Service) JoinChannel(
|
||||
|
||||
_, _, _ = s.FanOut( //nolint:dogsled // fire-and-forget broadcast
|
||||
ctx, irc.CmdJoin, nick, channel, 0, chID,
|
||||
nil, body, nil, memberIDs, skipClientID,
|
||||
nil, body, nil, memberIDs,
|
||||
)
|
||||
|
||||
return &JoinResult{
|
||||
@@ -548,12 +558,12 @@ func (s *Service) JoinChannel(
|
||||
}, nil
|
||||
}
|
||||
|
||||
// PartChannel validates membership, broadcasts PART to all
|
||||
// channel members, skipping client skipClientID as FanOut
|
||||
// does, removes the user, and cleans up empty channels.
|
||||
// PartChannel validates membership, broadcasts PART to
|
||||
// remaining members, removes the user, and cleans up empty
|
||||
// channels.
|
||||
func (s *Service) PartChannel(
|
||||
ctx context.Context,
|
||||
sessionID, skipClientID int64,
|
||||
sessionID int64,
|
||||
nick, channel, reason string,
|
||||
) error {
|
||||
chID, err := s.db.GetChannelByName(ctx, channel)
|
||||
@@ -577,11 +587,12 @@ func (s *Service) PartChannel(
|
||||
}
|
||||
|
||||
memberIDs, _ := s.db.GetChannelMemberIDs(ctx, chID)
|
||||
recipients := excludeSession(memberIDs, sessionID)
|
||||
body, _ := json.Marshal([]string{reason}) //nolint:errchkjson
|
||||
|
||||
_, _, _ = s.FanOut( //nolint:dogsled // fire-and-forget broadcast
|
||||
ctx, irc.CmdPart, nick, channel, 0, chID,
|
||||
nil, body, nil, memberIDs, skipClientID,
|
||||
nil, body, nil, recipients,
|
||||
)
|
||||
|
||||
s.db.PartChannelAndDeleteIfEmpty(ctx, chID, sessionID) //nolint:errcheck,gosec
|
||||
@@ -590,11 +601,10 @@ func (s *Service) PartChannel(
|
||||
}
|
||||
|
||||
// SetTopic validates membership and topic-lock, sets the
|
||||
// topic, and broadcasts the change to all channel members,
|
||||
// skipping client skipClientID as FanOut does.
|
||||
// topic, and broadcasts the change.
|
||||
func (s *Service) SetTopic(
|
||||
ctx context.Context,
|
||||
sessionID, skipClientID int64,
|
||||
sessionID int64,
|
||||
nick, channel, topic string,
|
||||
) error {
|
||||
chID, err := s.db.GetChannelByName(ctx, channel)
|
||||
@@ -643,19 +653,18 @@ func (s *Service) SetTopic(
|
||||
|
||||
_, _, _ = s.FanOut( //nolint:dogsled // fire-and-forget broadcast
|
||||
ctx, irc.CmdTopic, nick, channel, 0, chID,
|
||||
nil, body, nil, memberIDs, skipClientID,
|
||||
nil, body, nil, memberIDs,
|
||||
)
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// KickUser validates operator status and target
|
||||
// membership, broadcasts the KICK to all channel members,
|
||||
// skipping client skipClientID as FanOut does, removes the
|
||||
// target, and cleans up empty channels.
|
||||
// membership, broadcasts the KICK, removes the target,
|
||||
// and cleans up empty channels.
|
||||
func (s *Service) KickUser(
|
||||
ctx context.Context,
|
||||
sessionID, skipClientID int64,
|
||||
sessionID int64,
|
||||
nick, channel, targetNick, reason string,
|
||||
) error {
|
||||
chID, err := s.db.GetChannelByName(ctx, channel)
|
||||
@@ -708,7 +717,7 @@ func (s *Service) KickUser(
|
||||
|
||||
_, _, _ = s.FanOut( //nolint:dogsled // fire-and-forget broadcast
|
||||
ctx, irc.CmdKick, nick, channel, 0, chID,
|
||||
params, body, nil, memberIDs, skipClientID,
|
||||
params, body, nil, memberIDs,
|
||||
)
|
||||
|
||||
s.db.PartChannelAndDeleteIfEmpty(ctx, chID, targetSID) //nolint:errcheck,gosec
|
||||
@@ -789,11 +798,10 @@ func (s *Service) InviteUser(
|
||||
}
|
||||
|
||||
// ChangeNick changes a user's nickname and broadcasts the
|
||||
// change to the user's own session and all users sharing
|
||||
// channels, skipping client skipClientID as FanOut does.
|
||||
// change to all users sharing channels.
|
||||
func (s *Service) ChangeNick(
|
||||
ctx context.Context,
|
||||
sessionID, skipClientID int64,
|
||||
sessionID int64,
|
||||
oldNick, newNick string,
|
||||
) error {
|
||||
err := s.db.ChangeNick(ctx, sessionID, newNick)
|
||||
@@ -814,9 +822,7 @@ func (s *Service) ChangeNick(
|
||||
}
|
||||
}
|
||||
|
||||
s.broadcastNickChange(
|
||||
ctx, sessionID, skipClientID, oldNick, newNick,
|
||||
)
|
||||
s.broadcastNickChange(ctx, sessionID, oldNick, newNick)
|
||||
|
||||
return nil
|
||||
}
|
||||
@@ -1036,10 +1042,9 @@ func (s *Service) SetChannelFlag(
|
||||
}
|
||||
|
||||
// BroadcastMode fans out a MODE change to all channel
|
||||
// members, skipping client skipClientID as FanOut does.
|
||||
// members.
|
||||
func (s *Service) BroadcastMode(
|
||||
ctx context.Context,
|
||||
skipClientID int64,
|
||||
nick, channel string,
|
||||
chID int64,
|
||||
modeText string,
|
||||
@@ -1049,7 +1054,7 @@ func (s *Service) BroadcastMode(
|
||||
|
||||
_, _, _ = s.FanOut( //nolint:dogsled // fire-and-forget broadcast
|
||||
ctx, irc.CmdMode, nick, channel, 0, chID,
|
||||
nil, body, nil, memberIDs, skipClientID,
|
||||
nil, body, nil, memberIDs,
|
||||
)
|
||||
}
|
||||
|
||||
@@ -1301,12 +1306,11 @@ func (s *Service) checkChannelHashcash(
|
||||
return nil
|
||||
}
|
||||
|
||||
// broadcastNickChange notifies the user's own session,
|
||||
// except client skipClientID, and channel peers of a nick
|
||||
// broadcastNickChange notifies channel peers of a nick
|
||||
// change.
|
||||
func (s *Service) broadcastNickChange(
|
||||
ctx context.Context,
|
||||
sessionID, skipClientID int64,
|
||||
sessionID int64,
|
||||
oldNick, newNick string,
|
||||
) {
|
||||
channels, err := s.db.GetSessionChannels(
|
||||
@@ -1328,7 +1332,7 @@ func (s *Service) broadcastNickChange(
|
||||
}
|
||||
|
||||
// Notify the user themselves (for multi-client sync).
|
||||
_ = s.db.EnqueueToSession(ctx, sessionID, dbID, skipClientID)
|
||||
_ = s.db.EnqueueToSession(ctx, sessionID, dbID)
|
||||
s.broker.Notify(sessionID)
|
||||
notified[sessionID] = true
|
||||
|
||||
@@ -1347,7 +1351,7 @@ func (s *Service) broadcastNickChange(
|
||||
|
||||
notified[mid] = true
|
||||
|
||||
_ = s.db.EnqueueToSession(ctx, mid, dbID, 0)
|
||||
_ = s.db.EnqueueToSession(ctx, mid, dbID)
|
||||
s.broker.Notify(mid)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -168,7 +168,7 @@ func TestFanOut(t *testing.T) {
|
||||
dbID, uuid, err := env.svc.FanOut(
|
||||
ctx, irc.CmdPrivmsg, "alice", "#test", 0, 0,
|
||||
nil, body, nil,
|
||||
[]int64{sid1, sid2}, 0,
|
||||
[]int64{sid1, sid2},
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatalf("FanOut: %v", err)
|
||||
@@ -190,7 +190,7 @@ func TestJoinChannel(t *testing.T) {
|
||||
sid := createSession(ctx, t, env.db, "alice")
|
||||
|
||||
result, err := env.svc.JoinChannel(
|
||||
ctx, sid, 0, "alice", "#general", "",
|
||||
ctx, sid, "alice", "#general", "",
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatalf("JoinChannel: %v", err)
|
||||
@@ -208,7 +208,7 @@ func TestJoinChannel(t *testing.T) {
|
||||
sid2 := createSession(ctx, t, env.db, "bob")
|
||||
|
||||
result2, err := env.svc.JoinChannel(
|
||||
ctx, sid2, 0, "bob", "#general", "",
|
||||
ctx, sid2, "bob", "#general", "",
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatalf("JoinChannel bob: %v", err)
|
||||
@@ -230,14 +230,14 @@ func TestPartChannel(t *testing.T) {
|
||||
sid := createSession(ctx, t, env.db, "alice")
|
||||
|
||||
_, err := env.svc.JoinChannel(
|
||||
ctx, sid, 0, "alice", "#general", "",
|
||||
ctx, sid, "alice", "#general", "",
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatalf("JoinChannel: %v", err)
|
||||
}
|
||||
|
||||
err = env.svc.PartChannel(
|
||||
ctx, sid, 0, "alice", "#general", "bye",
|
||||
ctx, sid, "alice", "#general", "bye",
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatalf("PartChannel: %v", err)
|
||||
@@ -245,7 +245,7 @@ func TestPartChannel(t *testing.T) {
|
||||
|
||||
// Parting a non-existent channel returns error.
|
||||
err = env.svc.PartChannel(
|
||||
ctx, sid, 0, "alice", "#nonexistent", "",
|
||||
ctx, sid, "alice", "#nonexistent", "",
|
||||
)
|
||||
if err == nil {
|
||||
t.Error("expected error for non-existent channel")
|
||||
@@ -309,7 +309,7 @@ func joinConcurrently(
|
||||
|
||||
joins[i] = func() error {
|
||||
result, err := env.svc.JoinChannel(
|
||||
ctx, sessionID, 0, nick, channel, "",
|
||||
ctx, sessionID, nick, channel, "",
|
||||
)
|
||||
results[i] = result
|
||||
|
||||
@@ -335,7 +335,7 @@ func TestConcurrentJoinsRespectUserLimit(t *testing.T) {
|
||||
opSID := createSession(ctx, t, env.db, opNick)
|
||||
|
||||
created, err := env.svc.JoinChannel(
|
||||
ctx, opSID, 0, opNick, channel, "",
|
||||
ctx, opSID, opNick, channel, "",
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatalf("join %s: %v", opNick, err)
|
||||
@@ -448,7 +448,7 @@ func TestJoinConcurrentWithLastPart(t *testing.T) {
|
||||
joinerSID := createSession(ctx, t, env.db, joinerNick)
|
||||
|
||||
_, err := env.svc.JoinChannel(
|
||||
ctx, leaverSID, 0, leaverNick, channel, "",
|
||||
ctx, leaverSID, leaverNick, channel, "",
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatalf("join %s: %v", leaverNick, err)
|
||||
@@ -457,12 +457,12 @@ func TestJoinConcurrentWithLastPart(t *testing.T) {
|
||||
errs := runConcurrently(
|
||||
func() error {
|
||||
return env.svc.PartChannel(
|
||||
ctx, leaverSID, 0, leaverNick, channel, "",
|
||||
ctx, leaverSID, leaverNick, channel, "",
|
||||
)
|
||||
},
|
||||
func() error {
|
||||
_, joinErr := env.svc.JoinChannel(
|
||||
ctx, joinerSID, 0, joinerNick, channel, "",
|
||||
ctx, joinerSID, joinerNick, channel, "",
|
||||
)
|
||||
|
||||
return joinErr
|
||||
@@ -513,7 +513,7 @@ func TestJoinConcurrentWithLastQuit(t *testing.T) {
|
||||
joinerSID := createSession(ctx, t, env.db, joinerNick)
|
||||
|
||||
created, err := env.svc.JoinChannel(
|
||||
ctx, leaverSID, 0, leaverNick, channel, "",
|
||||
ctx, leaverSID, leaverNick, channel, "",
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatalf("join %s: %v", leaverNick, err)
|
||||
@@ -545,7 +545,7 @@ func TestJoinConcurrentWithLastQuit(t *testing.T) {
|
||||
)
|
||||
|
||||
joined, joinErr = env.svc.JoinChannel(
|
||||
ctx, joinerSID, 0, joinerNick, channel, "",
|
||||
ctx, joinerSID, joinerNick, channel, "",
|
||||
)
|
||||
if !errors.As(joinErr, &ircErr) ||
|
||||
ircErr.Code != irc.ErrBadChannelKey {
|
||||
@@ -592,7 +592,7 @@ func TestQuitQueuedAheadOfNewNickHoldersJoin(t *testing.T) {
|
||||
quitterSID := createSession(ctx, t, env.db, nick)
|
||||
|
||||
for _, channel := range []string{crowd, shared} {
|
||||
_, err := env.svc.JoinChannel(ctx, quitterSID, 0, nick, channel, "")
|
||||
_, err := env.svc.JoinChannel(ctx, quitterSID, nick, channel, "")
|
||||
if err != nil {
|
||||
t.Fatalf("join %s: %v", channel, err)
|
||||
}
|
||||
@@ -602,7 +602,7 @@ func TestQuitQueuedAheadOfNewNickHoldersJoin(t *testing.T) {
|
||||
memberNick := fmt.Sprintf("crowd%dx%d", trial, member)
|
||||
memberSID := createSession(ctx, t, env.db, memberNick)
|
||||
|
||||
_, err := env.svc.JoinChannel(ctx, memberSID, 0, memberNick, crowd, "")
|
||||
_, err := env.svc.JoinChannel(ctx, memberSID, memberNick, crowd, "")
|
||||
if err != nil {
|
||||
t.Fatalf("join %s: %v", memberNick, err)
|
||||
}
|
||||
@@ -617,7 +617,7 @@ func TestQuitQueuedAheadOfNewNickHoldersJoin(t *testing.T) {
|
||||
t.Fatalf("create session %s: %v", watcherNick, err)
|
||||
}
|
||||
|
||||
_, err = env.svc.JoinChannel(ctx, watcherSID, 0, watcherNick, shared, "")
|
||||
_, err = env.svc.JoinChannel(ctx, watcherSID, watcherNick, shared, "")
|
||||
if err != nil {
|
||||
t.Fatalf("join %s: %v", watcherNick, err)
|
||||
}
|
||||
@@ -678,7 +678,7 @@ func takeNickAndJoin(
|
||||
return err
|
||||
}
|
||||
|
||||
_, err = env.svc.JoinChannel(ctx, sessionID, 0, nick, channel, "")
|
||||
_, err = env.svc.JoinChannel(ctx, sessionID, nick, channel, "")
|
||||
|
||||
return err
|
||||
}
|
||||
@@ -710,7 +710,7 @@ func TestJoinUsesUpInvite(t *testing.T) {
|
||||
opSID := createSession(ctx, t, env.db, "op")
|
||||
guestSID := createSession(ctx, t, env.db, "guest")
|
||||
|
||||
created, err := env.svc.JoinChannel(ctx, opSID, 0, "op", channel, "")
|
||||
created, err := env.svc.JoinChannel(ctx, opSID, "op", channel, "")
|
||||
if err != nil {
|
||||
t.Fatalf("join op: %v", err)
|
||||
}
|
||||
@@ -725,17 +725,17 @@ func TestJoinUsesUpInvite(t *testing.T) {
|
||||
t.Fatalf("invite guest: %v", err)
|
||||
}
|
||||
|
||||
_, err = env.svc.JoinChannel(ctx, guestSID, 0, "guest", channel, "")
|
||||
_, err = env.svc.JoinChannel(ctx, guestSID, "guest", channel, "")
|
||||
if err != nil {
|
||||
t.Fatalf("invited join: %v", err)
|
||||
}
|
||||
|
||||
err = env.svc.PartChannel(ctx, guestSID, 0, "guest", channel, "")
|
||||
err = env.svc.PartChannel(ctx, guestSID, "guest", channel, "")
|
||||
if err != nil {
|
||||
t.Fatalf("part guest: %v", err)
|
||||
}
|
||||
|
||||
_, err = env.svc.JoinChannel(ctx, guestSID, 0, "guest", channel, "")
|
||||
_, err = env.svc.JoinChannel(ctx, guestSID, "guest", channel, "")
|
||||
|
||||
var ircErr *service.IRCError
|
||||
if !errors.As(err, &ircErr) || ircErr.Code != irc.ErrInviteOnlyChan {
|
||||
@@ -754,7 +754,7 @@ func TestJoinRefusedByHostmaskBan(t *testing.T) {
|
||||
|
||||
opSID := createSession(ctx, t, env.db, "op")
|
||||
|
||||
created, err := env.svc.JoinChannel(ctx, opSID, 0, "op", channel, "")
|
||||
created, err := env.svc.JoinChannel(ctx, opSID, "op", channel, "")
|
||||
if err != nil {
|
||||
t.Fatalf("join op: %v", err)
|
||||
}
|
||||
@@ -773,7 +773,7 @@ func TestJoinRefusedByHostmaskBan(t *testing.T) {
|
||||
t.Fatalf("create session guest: %v", err)
|
||||
}
|
||||
|
||||
_, err = env.svc.JoinChannel(ctx, guestSID, 0, "guest", channel, "")
|
||||
_, err = env.svc.JoinChannel(ctx, guestSID, "guest", channel, "")
|
||||
|
||||
var ircErr *service.IRCError
|
||||
if !errors.As(err, &ircErr) || ircErr.Code != irc.ErrBannedFromChan {
|
||||
@@ -793,17 +793,17 @@ func TestPartDeletesChannelOnlyWhenEmpty(t *testing.T) {
|
||||
aliceSID := createSession(ctx, t, env.db, "alice")
|
||||
bobSID := createSession(ctx, t, env.db, "bob")
|
||||
|
||||
_, err := env.svc.JoinChannel(ctx, aliceSID, 0, "alice", channel, "")
|
||||
_, err := env.svc.JoinChannel(ctx, aliceSID, "alice", channel, "")
|
||||
if err != nil {
|
||||
t.Fatalf("join alice: %v", err)
|
||||
}
|
||||
|
||||
_, err = env.svc.JoinChannel(ctx, bobSID, 0, "bob", channel, "")
|
||||
_, err = env.svc.JoinChannel(ctx, bobSID, "bob", channel, "")
|
||||
if err != nil {
|
||||
t.Fatalf("join bob: %v", err)
|
||||
}
|
||||
|
||||
err = env.svc.PartChannel(ctx, aliceSID, 0, "alice", channel, "")
|
||||
err = env.svc.PartChannel(ctx, aliceSID, "alice", channel, "")
|
||||
if err != nil {
|
||||
t.Fatalf("part alice: %v", err)
|
||||
}
|
||||
@@ -818,7 +818,7 @@ func TestPartDeletesChannelOnlyWhenEmpty(t *testing.T) {
|
||||
t.Fatal("bob is not on the channel after alice parted")
|
||||
}
|
||||
|
||||
err = env.svc.PartChannel(ctx, bobSID, 0, "bob", channel, "")
|
||||
err = env.svc.PartChannel(ctx, bobSID, "bob", channel, "")
|
||||
if err != nil {
|
||||
t.Fatalf("part bob: %v", err)
|
||||
}
|
||||
@@ -839,12 +839,12 @@ func TestKickOfLastMemberDeletesChannel(t *testing.T) {
|
||||
|
||||
sid := createSession(ctx, t, env.db, "alice")
|
||||
|
||||
_, err := env.svc.JoinChannel(ctx, sid, 0, "alice", channel, "")
|
||||
_, err := env.svc.JoinChannel(ctx, sid, "alice", channel, "")
|
||||
if err != nil {
|
||||
t.Fatalf("join alice: %v", err)
|
||||
}
|
||||
|
||||
err = env.svc.KickUser(ctx, sid, 0, "alice", channel, "alice", "")
|
||||
err = env.svc.KickUser(ctx, sid, "alice", channel, "alice", "")
|
||||
if err != nil {
|
||||
t.Fatalf("kick alice: %v", err)
|
||||
}
|
||||
@@ -863,14 +863,14 @@ func TestSendChannelMessage(t *testing.T) {
|
||||
sid2 := createSession(ctx, t, env.db, "bob")
|
||||
|
||||
_, err := env.svc.JoinChannel(
|
||||
ctx, sid1, 0, "alice", "#chat", "",
|
||||
ctx, sid1, "alice", "#chat", "",
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatalf("join alice: %v", err)
|
||||
}
|
||||
|
||||
_, err = env.svc.JoinChannel(
|
||||
ctx, sid2, 0, "bob", "#chat", "",
|
||||
ctx, sid2, "bob", "#chat", "",
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatalf("join bob: %v", err)
|
||||
@@ -878,14 +878,18 @@ func TestSendChannelMessage(t *testing.T) {
|
||||
|
||||
body, _ := json.Marshal([]string{"hello world"}) //nolint:errchkjson
|
||||
|
||||
uuid, err := env.svc.SendChannelMessage(
|
||||
ctx, sid1, 0, "alice",
|
||||
dbID, uuid, err := env.svc.SendChannelMessage(
|
||||
ctx, sid1, "alice",
|
||||
irc.CmdPrivmsg, "#chat", body, nil,
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatalf("SendChannelMessage: %v", err)
|
||||
}
|
||||
|
||||
if dbID == 0 {
|
||||
t.Error("expected non-zero dbID")
|
||||
}
|
||||
|
||||
if uuid == "" {
|
||||
t.Error("expected non-empty UUID")
|
||||
}
|
||||
@@ -893,8 +897,8 @@ func TestSendChannelMessage(t *testing.T) {
|
||||
// Non-member cannot send.
|
||||
sid3 := createSession(ctx, t, env.db, "charlie")
|
||||
|
||||
_, err = env.svc.SendChannelMessage(
|
||||
ctx, sid3, 0, "charlie",
|
||||
_, _, err = env.svc.SendChannelMessage(
|
||||
ctx, sid3, "charlie",
|
||||
irc.CmdPrivmsg, "#chat", body, nil,
|
||||
)
|
||||
if err == nil {
|
||||
@@ -910,14 +914,14 @@ func TestBroadcastQuit(t *testing.T) {
|
||||
sid2 := createSession(ctx, t, env.db, "bob")
|
||||
|
||||
_, err := env.svc.JoinChannel(
|
||||
ctx, sid1, 0, "alice", "#room", "",
|
||||
ctx, sid1, "alice", "#room", "",
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatalf("join alice: %v", err)
|
||||
}
|
||||
|
||||
_, err = env.svc.JoinChannel(
|
||||
ctx, sid2, 0, "bob", "#room", "",
|
||||
ctx, sid2, "bob", "#room", "",
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatalf("join bob: %v", err)
|
||||
@@ -959,7 +963,7 @@ func TestSendDirectMessageTargetQuits(t *testing.T) {
|
||||
body, _ := json.Marshal([]string{"hi"}) //nolint:errchkjson
|
||||
|
||||
_, err = env.svc.SendDirectMessage(
|
||||
ctx, sid, 0, "alice", irc.CmdPrivmsg, "bob", body, nil,
|
||||
ctx, sid, "alice", irc.CmdPrivmsg, "bob", body, nil,
|
||||
)
|
||||
|
||||
var ircErr *service.IRCError
|
||||
@@ -979,7 +983,7 @@ func TestSendChannelMessageChannelDeleted(t *testing.T) {
|
||||
|
||||
sid := createSession(ctx, t, env.db, "alice")
|
||||
|
||||
_, err := env.svc.JoinChannel(ctx, sid, 0, "alice", "#gone", "")
|
||||
_, err := env.svc.JoinChannel(ctx, sid, "alice", "#gone", "")
|
||||
if err != nil {
|
||||
t.Fatalf("join alice: %v", err)
|
||||
}
|
||||
@@ -996,8 +1000,8 @@ func TestSendChannelMessageChannelDeleted(t *testing.T) {
|
||||
|
||||
body, _ := json.Marshal([]string{"hi"}) //nolint:errchkjson
|
||||
|
||||
_, err = env.svc.SendChannelMessage(
|
||||
ctx, sid, 0, "alice", irc.CmdPrivmsg, "#gone", body, nil,
|
||||
_, _, err = env.svc.SendChannelMessage(
|
||||
ctx, sid, "alice", irc.CmdPrivmsg, "#gone", body, nil,
|
||||
)
|
||||
|
||||
var ircErr *service.IRCError
|
||||
@@ -1015,14 +1019,14 @@ func TestSendChannelMessage_Moderated(t *testing.T) {
|
||||
sid2 := createSession(ctx, t, env.db, "bob")
|
||||
|
||||
result, err := env.svc.JoinChannel(
|
||||
ctx, sid1, 0, "alice", "#modchat", "",
|
||||
ctx, sid1, "alice", "#modchat", "",
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatalf("join alice: %v", err)
|
||||
}
|
||||
|
||||
_, err = env.svc.JoinChannel(
|
||||
ctx, sid2, 0, "bob", "#modchat", "",
|
||||
ctx, sid2, "bob", "#modchat", "",
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatalf("join bob: %v", err)
|
||||
@@ -1035,8 +1039,8 @@ func TestSendChannelMessage_Moderated(t *testing.T) {
|
||||
body, _ := json.Marshal([]string{"test"}) //nolint:errchkjson
|
||||
|
||||
// Bob (non-op, non-voiced) should fail to send.
|
||||
_, err = env.svc.SendChannelMessage(
|
||||
ctx, sid2, 0, "bob",
|
||||
_, _, err = env.svc.SendChannelMessage(
|
||||
ctx, sid2, "bob",
|
||||
irc.CmdPrivmsg, "#modchat", body, nil,
|
||||
)
|
||||
if err == nil {
|
||||
@@ -1044,8 +1048,8 @@ func TestSendChannelMessage_Moderated(t *testing.T) {
|
||||
}
|
||||
|
||||
// Alice (operator) should succeed.
|
||||
_, err = env.svc.SendChannelMessage(
|
||||
ctx, sid1, 0, "alice",
|
||||
_, _, err = env.svc.SendChannelMessage(
|
||||
ctx, sid1, "alice",
|
||||
irc.CmdPrivmsg, "#modchat", body, nil,
|
||||
)
|
||||
if err != nil {
|
||||
@@ -1070,7 +1074,7 @@ func TestRefusedChannelMessageLeavesStampUnspent(t *testing.T) {
|
||||
refuse func(ctx context.Context, env *testEnv, chID, bobSID int64) error
|
||||
}{
|
||||
{"not a member", func(ctx context.Context, env *testEnv, _, bobSID int64) error {
|
||||
return env.svc.PartChannel(ctx, bobSID, 0, "bob", channel, "")
|
||||
return env.svc.PartChannel(ctx, bobSID, "bob", channel, "")
|
||||
}},
|
||||
{"banned", func(ctx context.Context, env *testEnv, chID, _ int64) error {
|
||||
return env.db.AddChannelBan(ctx, chID, "bob!*@*", "alice")
|
||||
@@ -1090,12 +1094,12 @@ func TestRefusedChannelMessageLeavesStampUnspent(t *testing.T) {
|
||||
aliceSID := createSession(ctx, t, env.db, "alice")
|
||||
bobSID := createSession(ctx, t, env.db, "bob")
|
||||
|
||||
joined, err := env.svc.JoinChannel(ctx, aliceSID, 0, "alice", channel, "")
|
||||
joined, err := env.svc.JoinChannel(ctx, aliceSID, "alice", channel, "")
|
||||
if err != nil {
|
||||
t.Fatalf("join alice: %v", err)
|
||||
}
|
||||
|
||||
_, err = env.svc.JoinChannel(ctx, bobSID, 0, "bob", channel, "")
|
||||
_, err = env.svc.JoinChannel(ctx, bobSID, "bob", channel, "")
|
||||
if err != nil {
|
||||
t.Fatalf("join bob: %v", err)
|
||||
}
|
||||
@@ -1115,8 +1119,8 @@ func TestRefusedChannelMessageLeavesStampUnspent(t *testing.T) {
|
||||
)
|
||||
meta, _ := json.Marshal(map[string]string{"hashcash": stamp})
|
||||
|
||||
_, err = env.svc.SendChannelMessage(
|
||||
ctx, bobSID, 0, "bob", irc.CmdPrivmsg, channel, body, meta,
|
||||
_, _, err = env.svc.SendChannelMessage(
|
||||
ctx, bobSID, "bob", irc.CmdPrivmsg, channel, body, meta,
|
||||
)
|
||||
|
||||
var ircErr *service.IRCError
|
||||
@@ -1125,8 +1129,8 @@ func TestRefusedChannelMessageLeavesStampUnspent(t *testing.T) {
|
||||
t.Fatalf("bob: want ERR_CANNOTSENDTOCHAN, got %v", err)
|
||||
}
|
||||
|
||||
_, err = env.svc.SendChannelMessage(
|
||||
ctx, aliceSID, 0, "alice", irc.CmdPrivmsg, channel, body, meta,
|
||||
_, _, err = env.svc.SendChannelMessage(
|
||||
ctx, aliceSID, "alice", irc.CmdPrivmsg, channel, body, meta,
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatalf("alice with the same stamp: %v", err)
|
||||
|
||||
+63
-114
@@ -58,13 +58,13 @@ async function mintHashcash(bits, resource) {
|
||||
}
|
||||
}
|
||||
|
||||
// Requests are authenticated by the auth cookie, which the browser
|
||||
// sends on its own.
|
||||
function api(path, opts = {}) {
|
||||
const token = localStorage.getItem("neoirc_token");
|
||||
const headers = {
|
||||
"Content-Type": "application/json",
|
||||
...(opts.headers || {}),
|
||||
};
|
||||
if (token) headers["Authorization"] = `Bearer ${token}`;
|
||||
const { signal, ...rest } = opts;
|
||||
|
||||
return fetch(API + path, { ...rest, headers, signal }).then(async (r) => {
|
||||
@@ -122,11 +122,12 @@ function LoginScreen({ onLogin }) {
|
||||
if (s.name) hashcashResourceRef.current = s.name;
|
||||
})
|
||||
.catch(() => {});
|
||||
// Resume the session if the browser still holds a valid auth
|
||||
// cookie; a 401 leaves the login form up.
|
||||
api("/state?initChannelState=1")
|
||||
.then((u) => onLogin(u.nick, true))
|
||||
.catch(() => {});
|
||||
const saved = localStorage.getItem("neoirc_token");
|
||||
if (saved) {
|
||||
api("/state?initChannelState=1")
|
||||
.then((u) => onLogin(u.nick, true))
|
||||
.catch(() => localStorage.removeItem("neoirc_token"));
|
||||
}
|
||||
inputRef.current?.focus();
|
||||
}, []);
|
||||
|
||||
@@ -151,6 +152,7 @@ function LoginScreen({ onLogin }) {
|
||||
method: "POST",
|
||||
body: JSON.stringify(reqBody),
|
||||
});
|
||||
localStorage.setItem("neoirc_token", res.token);
|
||||
onLogin(res.nick);
|
||||
} catch (err) {
|
||||
setError(err.data?.error || "Connection failed");
|
||||
@@ -225,9 +227,10 @@ function UserList({ members, onNickClick }) {
|
||||
const regular = [];
|
||||
|
||||
for (const m of members) {
|
||||
if (m.isOperator) {
|
||||
const mode = m.mode || "";
|
||||
if (mode === "o") {
|
||||
ops.push(m);
|
||||
} else if (m.isVoiced) {
|
||||
} else if (mode === "v") {
|
||||
voiced.push(m);
|
||||
} else {
|
||||
regular.push(m);
|
||||
@@ -300,14 +303,11 @@ function App() {
|
||||
nickRef.current = nick;
|
||||
}, [nick]);
|
||||
|
||||
// Persist joined channels, once logged in: before then only the
|
||||
// Server tab exists, and writing would erase the saved channels
|
||||
// that onLogin rejoins.
|
||||
// Persist joined channels.
|
||||
useEffect(() => {
|
||||
if (!loggedIn) return;
|
||||
const channels = tabs.filter((t) => t.type === "channel").map((t) => t.name);
|
||||
localStorage.setItem("neoirc_channels", JSON.stringify(channels));
|
||||
}, [loggedIn, tabs]);
|
||||
}, [tabs]);
|
||||
|
||||
// Clear unread on tab switch.
|
||||
useEffect(() => {
|
||||
@@ -366,9 +366,7 @@ function App() {
|
||||
command: msg.command,
|
||||
};
|
||||
|
||||
// A numeric reply carries its number in `code` and its name in
|
||||
// `command`; other messages have no `code`.
|
||||
switch (msg.code || msg.command) {
|
||||
switch (msg.command) {
|
||||
case "PRIVMSG":
|
||||
case "NOTICE": {
|
||||
let text = body;
|
||||
@@ -466,18 +464,8 @@ function App() {
|
||||
|
||||
break;
|
||||
}
|
||||
case "MODE": {
|
||||
// The body is the change, with its value where it has one:
|
||||
// ["+o bob"], ["+m"], ["+k", "secretpass"].
|
||||
const modes = Array.isArray(msg.body) ? msg.body.join(" ") : "";
|
||||
const text = `${msg.from} sets mode ${modes} on ${msg.to}`;
|
||||
if (msg.to) addMessage(msg.to, { ...base, text, system: true });
|
||||
|
||||
break;
|
||||
}
|
||||
case 353: {
|
||||
// RPL_NAMREPLY — each name is a hostmask (nick!user@host),
|
||||
// prefixed with @ for an operator or + for a voiced member.
|
||||
case "353": {
|
||||
// RPL_NAMREPLY — parse mode prefixes from names list.
|
||||
if (
|
||||
Array.isArray(msg.params) &&
|
||||
msg.params.length >= 2 &&
|
||||
@@ -489,18 +477,21 @@ function App() {
|
||||
: String(msg.body);
|
||||
const names = namesStr.split(/\s+/).filter(Boolean);
|
||||
const parsed = names.map((n) => {
|
||||
const isOperator = n.startsWith("@");
|
||||
const isVoiced = n.startsWith("+");
|
||||
const hostmask = isOperator || isVoiced ? n.slice(1) : n;
|
||||
if (n.startsWith("@")) {
|
||||
return { nick: n.slice(1), mode: "o" };
|
||||
}
|
||||
if (n.startsWith("+")) {
|
||||
return { nick: n.slice(1), mode: "v" };
|
||||
}
|
||||
|
||||
return { nick: hostmask.split("!")[0], isOperator, isVoiced };
|
||||
return { nick: n, mode: "" };
|
||||
});
|
||||
setMembers((prev) => ({ ...prev, [channel]: parsed }));
|
||||
}
|
||||
|
||||
break;
|
||||
}
|
||||
case 332: {
|
||||
case "332": {
|
||||
// RPL_TOPIC — set topic from server.
|
||||
if (Array.isArray(msg.params) && msg.params.length >= 1) {
|
||||
const channel = msg.params[0];
|
||||
@@ -512,7 +503,7 @@ function App() {
|
||||
|
||||
break;
|
||||
}
|
||||
case 322: {
|
||||
case "322": {
|
||||
// RPL_LIST — channel, member count, topic.
|
||||
if (Array.isArray(msg.params) && msg.params.length >= 2) {
|
||||
const chName = msg.params[0];
|
||||
@@ -527,7 +518,7 @@ function App() {
|
||||
|
||||
break;
|
||||
}
|
||||
case 323:
|
||||
case "323":
|
||||
addMessage("Server", {
|
||||
...base,
|
||||
text: body || "End of channel list",
|
||||
@@ -535,7 +526,7 @@ function App() {
|
||||
});
|
||||
|
||||
break;
|
||||
case 352: {
|
||||
case "352": {
|
||||
// RPL_WHOREPLY — channel, user, host, server, nick, flags.
|
||||
if (Array.isArray(msg.params) && msg.params.length >= 5) {
|
||||
const whoCh = msg.params[0];
|
||||
@@ -550,7 +541,7 @@ function App() {
|
||||
|
||||
break;
|
||||
}
|
||||
case 315:
|
||||
case "315":
|
||||
addMessage("Server", {
|
||||
...base,
|
||||
text: body || "End of /WHO list",
|
||||
@@ -558,20 +549,20 @@ function App() {
|
||||
});
|
||||
|
||||
break;
|
||||
case 311: {
|
||||
// RPL_WHOISUSER — params nick, user, host, *; body realname.
|
||||
if (Array.isArray(msg.params) && msg.params.length >= 3) {
|
||||
const [wiNick, wiUser, wiHost] = msg.params;
|
||||
case "311": {
|
||||
// RPL_WHOISUSER — nick, user, host, *, realname.
|
||||
if (Array.isArray(msg.params) && msg.params.length >= 1) {
|
||||
const wiNick = msg.params[0];
|
||||
addMessage("Server", {
|
||||
...base,
|
||||
text: `${wiNick} is ${wiUser}@${wiHost} (${body})`,
|
||||
text: `${wiNick} (${body})`,
|
||||
system: true,
|
||||
});
|
||||
}
|
||||
|
||||
break;
|
||||
}
|
||||
case 312: {
|
||||
case "312": {
|
||||
// RPL_WHOISSERVER — nick, server, server info.
|
||||
if (Array.isArray(msg.params) && msg.params.length >= 2) {
|
||||
const wiNick = msg.params[0];
|
||||
@@ -585,33 +576,7 @@ function App() {
|
||||
|
||||
break;
|
||||
}
|
||||
case 313: {
|
||||
// RPL_WHOISOPERATOR — nick; body "is an IRC operator".
|
||||
if (Array.isArray(msg.params) && msg.params.length >= 1) {
|
||||
addMessage("Server", {
|
||||
...base,
|
||||
text: `${msg.params[0]} ${body}`,
|
||||
system: true,
|
||||
});
|
||||
}
|
||||
|
||||
break;
|
||||
}
|
||||
case 317: {
|
||||
// RPL_WHOISIDLE — nick, idle seconds, signon time (Unix).
|
||||
if (Array.isArray(msg.params) && msg.params.length >= 3) {
|
||||
const [wiNick, idle, signon] = msg.params;
|
||||
const signedOn = new Date(Number(signon) * 1000).toLocaleString();
|
||||
addMessage("Server", {
|
||||
...base,
|
||||
text: `${wiNick} has been idle ${idle}s, signed on ${signedOn}`,
|
||||
system: true,
|
||||
});
|
||||
}
|
||||
|
||||
break;
|
||||
}
|
||||
case 319: {
|
||||
case "319": {
|
||||
// RPL_WHOISCHANNELS — nick, channels.
|
||||
if (Array.isArray(msg.params) && msg.params.length >= 1) {
|
||||
const wiNick = msg.params[0];
|
||||
@@ -624,7 +589,7 @@ function App() {
|
||||
|
||||
break;
|
||||
}
|
||||
case 318:
|
||||
case "318":
|
||||
addMessage("Server", {
|
||||
...base,
|
||||
text: body || "End of /WHOIS list",
|
||||
@@ -632,21 +597,9 @@ function App() {
|
||||
});
|
||||
|
||||
break;
|
||||
case 324: {
|
||||
// RPL_CHANNELMODEIS — channel, mode string.
|
||||
if (Array.isArray(msg.params) && msg.params.length >= 2) {
|
||||
addMessage("Server", {
|
||||
...base,
|
||||
text: `${msg.params[0]} modes: ${msg.params[1]}`,
|
||||
system: true,
|
||||
});
|
||||
}
|
||||
|
||||
break;
|
||||
}
|
||||
case 375:
|
||||
case 372:
|
||||
case 376:
|
||||
case "375":
|
||||
case "372":
|
||||
case "376":
|
||||
addMessage("Server", { ...base, text: body, system: true });
|
||||
|
||||
break;
|
||||
@@ -684,14 +637,6 @@ function App() {
|
||||
} catch (err) {
|
||||
if (!alive) break;
|
||||
if (err.name === "AbortError") continue;
|
||||
// 401: the session is gone (QUIT from another client, or
|
||||
// expiry). Reloading drops this page's state and brings
|
||||
// back the login screen.
|
||||
if (err.status === 401) {
|
||||
window.location.reload();
|
||||
|
||||
return;
|
||||
}
|
||||
setConnected(false);
|
||||
await new Promise((r) => setTimeout(r, RECONNECT_DELAY));
|
||||
}
|
||||
@@ -771,11 +716,6 @@ function App() {
|
||||
|
||||
const onLogin = useCallback(
|
||||
async (userNick, isResumed) => {
|
||||
// Read before setLoggedIn(true): from then on the effect under
|
||||
// "Persist joined channels" writes the open channel tabs over it.
|
||||
const saved = JSON.parse(
|
||||
localStorage.getItem("neoirc_channels") || "[]",
|
||||
);
|
||||
setNick(userNick);
|
||||
setLoggedIn(true);
|
||||
addSystemMessage("Server", `Connected as ${userNick}`);
|
||||
@@ -800,6 +740,9 @@ function App() {
|
||||
}
|
||||
|
||||
// Fresh session — join any previously saved channels.
|
||||
const saved = JSON.parse(
|
||||
localStorage.getItem("neoirc_channels") || "[]",
|
||||
);
|
||||
for (const ch of saved) {
|
||||
try {
|
||||
await api("/messages", {
|
||||
@@ -1029,22 +972,27 @@ function App() {
|
||||
|
||||
break;
|
||||
}
|
||||
// With no arguments MODE is a query. A change is one sign and
|
||||
// letter, then its value where it takes one: +m, +o nick.
|
||||
const modeArgs = parts.slice(1);
|
||||
const body =
|
||||
modeArgs.length > 0
|
||||
? { command: "MODE", to: tab.name, body: modeArgs }
|
||||
: { command: "MODE", to: tab.name };
|
||||
try {
|
||||
await api("/messages", {
|
||||
method: "POST",
|
||||
body: JSON.stringify(body),
|
||||
});
|
||||
} catch (err) {
|
||||
if (modeArgs.length > 0) {
|
||||
try {
|
||||
await api("/messages", {
|
||||
method: "POST",
|
||||
body: JSON.stringify({
|
||||
command: "MODE",
|
||||
to: tab.name,
|
||||
params: modeArgs,
|
||||
}),
|
||||
});
|
||||
} catch (err) {
|
||||
addSystemMessage(
|
||||
"Server",
|
||||
`Mode change failed: ${err.data?.error || "error"}`,
|
||||
);
|
||||
}
|
||||
} else {
|
||||
addSystemMessage(
|
||||
"Server",
|
||||
`MODE failed: ${err.data?.error || "error"}`,
|
||||
"Usage: /mode <+/-mode> [params]",
|
||||
);
|
||||
}
|
||||
|
||||
@@ -1061,6 +1009,7 @@ function App() {
|
||||
} catch (e) {
|
||||
// Ignore.
|
||||
}
|
||||
localStorage.removeItem("neoirc_token");
|
||||
localStorage.removeItem("neoirc_channels");
|
||||
window.location.reload();
|
||||
|
||||
@@ -1179,7 +1128,7 @@ function App() {
|
||||
" /me action — Send an action",
|
||||
" /nick newnick — Change your nickname",
|
||||
" /topic [text] — View or set channel topic",
|
||||
" /mode [+/-flag [arg]] — View or set channel modes",
|
||||
" /mode +/-flags — Set channel modes",
|
||||
" /motd — Display the message of the day",
|
||||
" /list — List all channels",
|
||||
" /who [#channel] — List users in a channel",
|
||||
|
||||
Reference in New Issue
Block a user