apps/BareRTC
1
0
Fork 0
Code Issues 14 Pull Requests Packages Projects Releases Wiki Activity
ipad-testing
BareRTC/pkg/messages/messages.go

126 lines
4.5 KiB
Go
Raw Permalink Normal View History

BareBot Chatbot Client
2023-08-14 02:21:27 +00:00
package messages
Initial commit
2023-01-11 06:38:48 +00:00
Deadlock detection, DND, and Frontend Fixes * Deadlock detection: the chatbot handlers will spin off a background goroutine to ping DMs at itself and test for responsiveness. If the echoes don't return for a minute, issue a /api/shutdown command to the HTTP server to force a reboot. * New admin API endpoint: /api/shutdown, equivalent to the operator '/shutdown' command sent in chat. Requires your AdminAPIKey to call it. Used by the chatbot as part of deadlock detection. * Adjust some uses of mutexes to hopefully mitigate deadlocks a bit. * Do Not Disturb: if users opt to "Ignore unsolicited DMs" they will set a DND status on the server which will grey-out their DM icon for other chatters. * Bring back an option for ChatServer to notify you when somebody begins watching your camera (on by default). * Automatically focus the message entry box when changing channels. * Lower webcam resolution hints to 480p to test performance implications.
2023-08-29 00:49:50 +00:00
import "sync"
Message Takebacks
2023-06-24 20:08:15 +00:00
// Auto incrementing Message ID for anything pushed out by the server.
Deadlock detection, DND, and Frontend Fixes * Deadlock detection: the chatbot handlers will spin off a background goroutine to ping DMs at itself and test for responsiveness. If the echoes don't return for a minute, issue a /api/shutdown command to the HTTP server to force a reboot. * New admin API endpoint: /api/shutdown, equivalent to the operator '/shutdown' command sent in chat. Requires your AdminAPIKey to call it. Used by the chatbot as part of deadlock detection. * Adjust some uses of mutexes to hopefully mitigate deadlocks a bit. * Do Not Disturb: if users opt to "Ignore unsolicited DMs" they will set a DND status on the server which will grey-out their DM icon for other chatters. * Bring back an option for ChatServer to notify you when somebody begins watching your camera (on by default). * Automatically focus the message entry box when changing channels. * Lower webcam resolution hints to 480p to test performance implications.
2023-08-29 00:49:50 +00:00
var (
messageID int
mu sync.Mutex
)
// NextMessageID atomically increments and returns a new MessageID.
func NextMessageID() int {
mu.Lock()
defer mu.Unlock()
messageID++
var mid = messageID
return mid
}
Message Takebacks
2023-06-24 20:08:15 +00:00
Photo sharing support
2023-03-22 04:29:24 +00:00
/*
Message is the basic carrier of WebSocket chat protocol actions.
Every message (client or server) has an Action and the rest of the
fields may vary depending on the action. Many messages target (or carry)
a Username, chat Channel and carry an arbitrary Message.
*/
Initial commit
2023-01-11 06:38:48 +00:00
type Message struct {
NSFW Cameras and Moderator Commands
2023-02-11 06:46:39 +00:00
Action string `json:"action,omitempty"`
Channel string `json:"channel,omitempty"`
Username string `json:"username,omitempty"`
Message string `json:"message,omitempty"`
Progress on Chat Server * Reworked full screen CSS layout for the chat.html, still using Bulma components with some custom CSS Grid. * Duplicate username handling: server can push a new username to change the client's selection. * Who List sync between clients. * Local video casting works so far - plays back your camera in the local feed. Your video broadcasting boolean is synced to backend, which lights up the video button in the Who List.
2023-01-27 04:34:58 +00:00
JWT Token-based Authentication * Add support for JWT tokens to authenticate users from your external app. * JWT backed users can have profile pictures, profile URLs, and operator status (admin). Note that no operator features exist yet. * Add WelcomeMessages to settings.toml for default ChatServer messages to write to each public channel directed at a new user logging in. * Markdown support for chat messages!
2023-02-06 01:42:09 +00:00
// JWT token for `login` actions.
JWTToken string `json:"jwt,omitempty"`
Progress on Chat Server * Reworked full screen CSS layout for the chat.html, still using Bulma components with some custom CSS Grid. * Duplicate username handling: server can push a new username to change the client's selection. * Who List sync between clients. * Local video casting works so far - plays back your camera in the local feed. Your video broadcasting boolean is synced to backend, which lights up the video button in the Who List.
2023-01-27 04:34:58 +00:00
// WhoList for `who` actions
Initial WebRTC Code * WebRTC pees exchange local/remote descriptions ("offer" and "answer") * They don't seem to exchange ICE candidates yet * Some back and forth happens but the final WebRTC stream connection isn't established yet.
2023-01-27 06:54:02 +00:00
WhoList []WhoList `json:"whoList,omitempty"`
Progress on Chat Server * Reworked full screen CSS layout for the chat.html, still using Bulma components with some custom CSS Grid. * Duplicate username handling: server can push a new username to change the client's selection. * Who List sync between clients. * Local video casting works so far - plays back your camera in the local feed. Your video broadcasting boolean is synced to backend, which lights up the video button in the Who List.
2023-01-27 04:34:58 +00:00
// Sent on `me` actions along with Username
Video Status Bitflags + Improvements * Consolidate all the Video flags (active, nsfw, mutual, mutualOpen) into a bitmask flag (single integer) * New video flag for when the source has muted their video, to show a crossed out grey mic on their camera for other chatters * Bugfixes around syncing the mute state for self and other videos when videos are opened, closed and opened again * Profile pictures on the DMs list
2023-07-01 01:41:06 +00:00
VideoStatus int `json:"video,omitempty"` // user video flags
ChatStatus string `json:"status,omitempty"` // online vs. away
Deadlock detection, DND, and Frontend Fixes * Deadlock detection: the chatbot handlers will spin off a background goroutine to ping DMs at itself and test for responsiveness. If the echoes don't return for a minute, issue a /api/shutdown command to the HTTP server to force a reboot. * New admin API endpoint: /api/shutdown, equivalent to the operator '/shutdown' command sent in chat. Requires your AdminAPIKey to call it. Used by the chatbot as part of deadlock detection. * Adjust some uses of mutexes to hopefully mitigate deadlocks a bit. * Do Not Disturb: if users opt to "Ignore unsolicited DMs" they will set a DND status on the server which will grey-out their DM icon for other chatters. * Bring back an option for ChatServer to notify you when somebody begins watching your camera (on by default). * Automatically focus the message entry box when changing channels. * Lower webcam resolution hints to 480p to test performance implications.
2023-08-29 00:49:50 +00:00
DND bool `json:"dnd,omitempty"` // Do Not Disturb, e.g. DMs are closed
Initial WebRTC Code * WebRTC pees exchange local/remote descriptions ("offer" and "answer") * They don't seem to exchange ICE candidates yet * Some back and forth happens but the final WebRTC stream connection isn't established yet.
2023-01-27 06:54:02 +00:00
Message Takebacks
2023-06-24 20:08:15 +00:00
// Message ID to support takebacks/local deletions
MessageID int `json:"msgID,omitempty"`
Initial WebRTC Code * WebRTC pees exchange local/remote descriptions ("offer" and "answer") * They don't seem to exchange ICE candidates yet * Some back and forth happens but the final WebRTC stream connection isn't established yet.
2023-01-27 06:54:02 +00:00
// Sent on `open` actions along with the (other) Username.
OpenSecret string `json:"openSecret,omitempty"`
Photo sharing support
2023-03-22 04:29:24 +00:00
// Send on `file` actions, passing e.g. image data.
Bytes []byte `json:"bytes,omitempty"`
Cached Blocklist from your website * New API endpoint: /api/blocklist where your site can pre-deliver muted username lists for users before they enter the chat. * Image sharing in DMs is allowed if either party is an operator.
2023-07-30 17:32:08 +00:00
// Send on `blocklist` actions, for doing a `mute` on a list of users
Usernames []string `json:"usernames,omitempty"`
Webhooks and Report Users * Added support for Webhooks and you can configure a Report Message hook to let users report messages on chat. * Add /reconfigure command to dynamically reload the server settings.toml * TODO: documentation for the webhooks.
2023-08-13 04:35:41 +00:00
// Sent on `report` actions.
Timestamp string `json:"timestamp,omitempty"`
Reason string `json:"reason,omitempty"`
Comment string `json:"comment,omitempty"`
Photo sharing support
2023-03-22 04:29:24 +00:00
// WebRTC negotiation messages: proxy their signaling messages
// between the two users to negotiate peer connection.
Stringify WebRTC candidate/sdp payloads
2023-02-25 01:42:38 +00:00
Candidate string `json:"candidate,omitempty"` // candidate
Description string `json:"description,omitempty"` // sdp
Initial commit
2023-01-11 06:38:48 +00:00
}
const (
Progress on Chat Server * Reworked full screen CSS layout for the chat.html, still using Bulma components with some custom CSS Grid. * Duplicate username handling: server can push a new username to change the client's selection. * Who List sync between clients. * Local video casting works so far - plays back your camera in the local feed. Your video broadcasting boolean is synced to backend, which lights up the video button in the Who List.
2023-01-27 04:34:58 +00:00
// Actions sent by the client side only
Cached Blocklist from your website * New API endpoint: /api/blocklist where your site can pre-deliver muted username lists for users before they enter the chat. * Image sharing in DMs is allowed if either party is an operator.
2023-07-30 17:32:08 +00:00
ActionLogin = "login" // post the username to backend
ActionBoot = "boot" // boot a user off your video feed
ActionMute = "mute" // mute a user's chat messages
ActionUnmute = "unmute"
ActionBlocklist = "blocklist" // mute in bulk for usernames
Webhooks and Report Users * Added support for Webhooks and you can configure a Report Message hook to let users report messages on chat. * Add /reconfigure command to dynamically reload the server settings.toml * TODO: documentation for the webhooks.
2023-08-13 04:35:41 +00:00
ActionReport = "report" // user reports a message
Progress on Chat Server * Reworked full screen CSS layout for the chat.html, still using Bulma components with some custom CSS Grid. * Duplicate username handling: server can push a new username to change the client's selection. * Who List sync between clients. * Local video casting works so far - plays back your camera in the local feed. Your video broadcasting boolean is synced to backend, which lights up the video button in the Who List.
2023-01-27 04:34:58 +00:00
// Actions sent by server or client
Message Takebacks
2023-06-24 20:08:15 +00:00
ActionMessage = "message" // post a message to the room
ActionMe = "me" // user self-info sent by FE or BE
ActionOpen = "open" // user wants to view a webcam (open WebRTC)
ActionRing = "ring" // receiver of a WebRTC open request
ActionWatch = "watch" // user has received video and is watching you
ActionUnwatch = "unwatch" // user has closed your video
ActionFile = "file" // image sharing in chat
ActionTakeback = "takeback" // user takes back (deletes) their message for everybody
Emoji reactions
2023-07-01 03:00:21 +00:00
ActionReact = "react" // emoji reaction to a chat message
Progress on Chat Server * Reworked full screen CSS layout for the chat.html, still using Bulma components with some custom CSS Grid. * Duplicate username handling: server can push a new username to change the client's selection. * Who List sync between clients. * Local video casting works so far - plays back your camera in the local feed. Your video broadcasting boolean is synced to backend, which lights up the video button in the Who List.
2023-01-27 04:34:58 +00:00
// Actions sent by server only
Camera connectivity established! * Two users can activate their cameras locally and then connect them together with WebRTC with video and audio support working! * Limitation: users need to be broadcasting video themselves before they can connect to someone's camera. If the offerer doesn't add tracks of their own, the SDP offer doesn't request video channels; so even though the answerer adds their tracks to the connection, they aren't used by the offerer. * As currently implemented, the offerer's camera feed will also appear on screen for the answerer - every video connection opens the feed both ways. Compared to the previous commit (where clients shared SDP messages but not ICE candidates or anything further) the fixes and learnings were: * The back-end was trying to relay candidate messages, but there was a JSON marshalling error (json object casted into a string) - changed the Message type to map[string]interface{} and both sides could exchange ICE candidates. * Both sides needed to add their video tracks to the connection so that there was anything of value to be sent over the WebRTC channel. Other changes: * Server will send a ping message every minute to connected WebSockets.
2023-02-05 05:00:01 +00:00
ActionPing = "ping"
NSFW Cameras and Moderator Commands
2023-02-11 06:46:39 +00:00
ActionWhoList = "who" // server pushes the Who List
ActionPresence = "presence" // a user joined or left the room
ActionError = "error" // ChatServer errors
ActionKick = "disconnect" // client should disconnect (e.g. have been kicked).
Initial WebRTC Code * WebRTC pees exchange local/remote descriptions ("offer" and "answer") * They don't seem to exchange ICE candidates yet * Some back and forth happens but the final WebRTC stream connection isn't established yet.
2023-01-27 06:54:02 +00:00
// WebRTC signaling messages.
ActionCandidate = "candidate"
ActionSDP = "sdp"
Initial commit
2023-01-11 06:38:48 +00:00
)
Progress on Chat Server * Reworked full screen CSS layout for the chat.html, still using Bulma components with some custom CSS Grid. * Duplicate username handling: server can push a new username to change the client's selection. * Who List sync between clients. * Local video casting works so far - plays back your camera in the local feed. Your video broadcasting boolean is synced to backend, which lights up the video button in the Who List.
2023-01-27 04:34:58 +00:00
// WhoList is a member entry in the chat room.
type WhoList struct {
Video Status Bitflags + Improvements * Consolidate all the Video flags (active, nsfw, mutual, mutualOpen) into a bitmask flag (single integer) * New video flag for when the source has muted their video, to show a crossed out grey mic on their camera for other chatters * Bugfixes around syncing the mute state for self and other videos when videos are opened, closed and opened again * Profile pictures on the DMs list
2023-07-01 01:41:06 +00:00
Username string `json:"username"`
Nickname string `json:"nickname,omitempty"`
Status string `json:"status"`
Video int `json:"video"`
Deadlock detection, DND, and Frontend Fixes * Deadlock detection: the chatbot handlers will spin off a background goroutine to ping DMs at itself and test for responsiveness. If the echoes don't return for a minute, issue a /api/shutdown command to the HTTP server to force a reboot. * New admin API endpoint: /api/shutdown, equivalent to the operator '/shutdown' command sent in chat. Requires your AdminAPIKey to call it. Used by the chatbot as part of deadlock detection. * Adjust some uses of mutexes to hopefully mitigate deadlocks a bit. * Do Not Disturb: if users opt to "Ignore unsolicited DMs" they will set a DND status on the server which will grey-out their DM icon for other chatters. * Bring back an option for ChatServer to notify you when somebody begins watching your camera (on by default). * Automatically focus the message entry box when changing channels. * Lower webcam resolution hints to 480p to test performance implications.
2023-08-29 00:49:50 +00:00
DND bool `json:"dnd,omitempty"`
Order the Who List by Logged-in Time
2023-08-07 04:06:27 +00:00
LoginAt int64 `json:"loginAt"`
JWT Token-based Authentication * Add support for JWT tokens to authenticate users from your external app. * JWT backed users can have profile pictures, profile URLs, and operator status (admin). Note that no operator features exist yet. * Add WelcomeMessages to settings.toml for default ChatServer messages to write to each public channel directed at a new user logging in. * Markdown support for chat messages!
2023-02-06 01:42:09 +00:00
// JWT auth extra settings.
Operator bool `json:"op"`
NSFW Cameras and Moderator Commands
2023-02-11 06:46:39 +00:00
Avatar string `json:"avatar,omitempty"`
ProfileURL string `json:"profileURL,omitempty"`
Emojis and gender flags for users
2023-08-06 02:38:04 +00:00
Emoji string `json:"emoji,omitempty"`
Gender string `json:"gender,omitempty"`
Progress on Chat Server * Reworked full screen CSS layout for the chat.html, still using Bulma components with some custom CSS Grid. * Duplicate username handling: server can push a new username to change the client's selection. * Who List sync between clients. * Local video casting works so far - plays back your camera in the local feed. Your video broadcasting boolean is synced to backend, which lights up the video button in the Who List.
2023-01-27 04:34:58 +00:00
}
Video Status Bitflags + Improvements * Consolidate all the Video flags (active, nsfw, mutual, mutualOpen) into a bitmask flag (single integer) * New video flag for when the source has muted their video, to show a crossed out grey mic on their camera for other chatters * Bugfixes around syncing the mute state for self and other videos when videos are opened, closed and opened again * Profile pictures on the DMs list
2023-07-01 01:41:06 +00:00
// VideoFlags to convey the state and setting of users' cameras concisely.
// Also see the VideoFlag object in BareRTC.js for front-end sync.
const (
VideoFlagActive int = 1 << iota // user's camera is enabled/broadcasting
VideoFlagNSFW // viewer's camera is marked as NSFW
VideoFlagMuted // user source microphone is muted
VideoFlagIsTalking // broadcaster seems to be talking
VideoFlagMutualRequired // video wants viewers to share their camera too
VideoFlagMutualOpen // viewer wants to auto-open viewers' cameras
)
Reference in New Issue Copy Permalink