mirror of
https://github.com/owncast/owncast.git
synced 2024-11-26 23:24:29 +03:00
bc2caadb74
* Implement webhook events for external integrations (#574) * Implement webhook events for external integrations Reference #556 * move message type to models and remove duplicate * add json header so content type can be determined * Pass at migrating webhooks to datastore + management apis (#589) * Pass at migrating webhooks to datastore + management apis * Support nil lastUsed timestamps and return back the new webhook on create * Cleanup from review feedback * Simplify a bit Co-authored-by: Aaron Ogle <aaron@geekgonecrazy.com> Co-authored-by: Gabe Kangas <gabek@real-ity.com> * Webhook query cleanup * Access tokens + Send system message external API (#585) * New add, get and delete access token APIs * Create auth token middleware * Update last_used timestamp when using an access token * Add auth'ed endpoint for sending system messages * Cleanup * Update api spec for new apis * Commit updated API documentation * Add auth'ed endpoint for sending user chat messages * Return access token string * Commit updated API documentation * Fix route * Support nil lastUsed time * Commit updated Javascript packages * Remove duplicate function post rebase * Fix msg id generation * Update controllers/admin/chat.go Co-authored-by: Aaron Ogle <geekgonecrazy@users.noreply.github.com> * Webhook query cleanup * Add SystemMessageSent to EventType Co-authored-by: Owncast <owncast@owncast.online> Co-authored-by: Aaron Ogle <geekgonecrazy@users.noreply.github.com> * Set webhook as used on completion. Closes #610 * Display webhook errors as errors * Commit updated API documentation * Add user joined chat event * Change integration API paths. Update API spec * Update development version of admin that supports integration apis * Commit updated API documentation * Add automated tests for external integration APIs * check error * quiet this test for now * Route up some additional 3rd party apis. #638 * Commit updated API documentation * Save username on user joined event * Add missing scope to valid scopes list * Add generic chat action event API for 3rd parties. Closes #666 * Commit updated API documentation * First pass at moving WIP config framework into project for #234 * Only support exported fields in custom types * Using YP get/set key as a first pass at using the data layer. Fixes + integration. * Ignore test db * Start adding getters and setters for config values * More get/set config work. Starting to populate api with data * Wire up some config edit endpoints * More endpoints * Disable cors middleware * Add more endpoints and add test to test them * Remove the in-memory change APIs * Add endpoint for changing tags * Add more config endpoints * Starting to point more things away from config file and to the datastore * Populate YP with db data * Create new util method for parsing page body markdown and return it in api * Verify proposed path to ffmpeg * For development purposes show the config key in logs * Move stats values to datastore * Moving over more values to the datastore * Move S3 config to datastore * First pass the config -> db migrator * Add the start of the video config apis * It builds pointing everything away from the config * Tweak ffmpeg path error message * Backup database every hour. Closes #549 * Config + defaults + migration work for db * Cleanup logging * Remove all the old config structs * Add descriptive info about migration * Tweak ffmpeg validation logic * Fix db backup path. backup on db version migration * Set video and s3 configurations * Update api spec with new config endpoints * Add migrator for stats file * Commit updated API documentation * Use a dynamic system port for internal HLS writes. Closes #577 (#626) * Use a dynamic system port for internal HLS writes. Closes #577 * Cleanup * YP key migration to datastore * Create a backup directory if needed before migrations * Remove config test that no longer makes sense. Cleanup. * Change number types from float32 to float64 * Update automated test suite * Allow restoring a database backup via command line flags. Closes #549 * Add new hls segment config api * Commit updated API documentation * Update apis to require a value container property * add socialHandles api * Commit updated API documentation * Add new latancy level setting to replace segment settings * Commit updated API documentation * Fix spelling * Commit updated API documentation * hardcode a json api of available social platforms * Add additional icons * Return social handles in server config api * Add socialhandles validation to test * Move list of hard coded social platforms to an api * Remove audio only code from transcoder since we do not use it * Add latency levels api + snapshot of video settings as current broadcast * Add config/serverurl endpoint * Return 404 on YP api if disabled * Surface stream title in YP response * Add stream title to web ui * Cleanup log message. Closes #520 * Rename ffmpeg package to transcoder * Add ws package for testing * Reduce chat backlog to past 5hrs, max 50. Closes #548 * Fix error formatting * Add endpoint for resetting yp registration * Add yp/reset to api spec. return status in response * Return zero viewer count if stream is offline. Closes #422 * Post-rebase fixes * Fix merge conflict in openapi file * Commit updated API documentation * Standardize controller names * Support setting the stream key via the command line. Closes #665 * Return social handles with YP data. First half of https://github.com/owncast/owncast-yp/issues/28 * Give the YP package access to server status regardless if enabled or not * Change delay in automated tests * Add stream title integration API. For #638 * Commit updated API documentation * Add storage to the migrator * Missing returning NSFW value in server config * Add flag to ignore websocket client. Closes #537 * Add error for parsing broadcaster metadata * Add support for a cli specified http server port. Closes #674 * Add cpu usage levels and a temporary mapping between it and libx264 presets * Test for valid url endpoint when saving s3 config * Re-configure storage on every stream to allow changing storage providers * After 5 minutes of a stream being stopped clear the stream title * Hide viewer count once stream goes offline instead of when player stops * Pull steamTitle from the status that gets updated instead of the config * Commit updated API documentation * Optionally show stream title in the header * Reset stream title when server starts * Show chat action when stream title is updated * Allow system messages to come back in persistence * Split out getting chat history for moderation + fix tests * Remove server title and standardize on name only * Commit updated API documentation * Bump github.com/aws/aws-sdk-go from 1.37.1 to 1.37.2 (#680) Bumps [github.com/aws/aws-sdk-go](https://github.com/aws/aws-sdk-go) from 1.37.1 to 1.37.2. - [Release notes](https://github.com/aws/aws-sdk-go/releases) - [Changelog](https://github.com/aws/aws-sdk-go/blob/master/CHANGELOG.md) - [Commits](https://github.com/aws/aws-sdk-go/compare/v1.37.1...v1.37.2) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Add video variant and stream latency config file migrator * Remove mostly unused disable upgrade check bool * Commit updated API documentation * Allow bundling the admin from the 0.0.6 branch * Fix saving port numbers * Use name instead of old title on window focus * Work on latency levels. Fix test to use levels. Clean up transcoder to only reference levels * Another place where title -> name * Fix test * Bump github.com/aws/aws-sdk-go from 1.37.2 to 1.37.3 (#690) Bumps [github.com/aws/aws-sdk-go](https://github.com/aws/aws-sdk-go) from 1.37.2 to 1.37.3. - [Release notes](https://github.com/aws/aws-sdk-go/releases) - [Changelog](https://github.com/aws/aws-sdk-go/blob/master/CHANGELOG.md) - [Commits](https://github.com/aws/aws-sdk-go/compare/v1.37.2...v1.37.3) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Update dependabot config * Bump github.com/aws/aws-sdk-go from 1.37.3 to 1.37.5 (#693) Bumps [github.com/aws/aws-sdk-go](https://github.com/aws/aws-sdk-go) from 1.37.3 to 1.37.5. - [Release notes](https://github.com/aws/aws-sdk-go/releases) - [Changelog](https://github.com/aws/aws-sdk-go/blob/master/CHANGELOG.md) - [Commits](https://github.com/aws/aws-sdk-go/compare/v1.37.3...v1.37.5) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump video.js from 7.10.2 to 7.11.4 in /build/javascript (#694) * Bump video.js from 7.10.2 to 7.11.4 in /build/javascript Bumps [video.js](https://github.com/videojs/video.js) from 7.10.2 to 7.11.4. - [Release notes](https://github.com/videojs/video.js/releases) - [Changelog](https://github.com/videojs/video.js/blob/main/CHANGELOG.md) - [Commits](https://github.com/videojs/video.js/compare/v7.10.2...v7.11.4) Signed-off-by: dependabot[bot] <support@github.com> * Commit updated Javascript packages Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Owncast <owncast@owncast.online> * Make the latency migrator dynamic so I can tweak values easier * Split out fetching ffmpeg path from validating the path so it can be changed in the admin * Some commenting and linter cleanup * Validate the path for a logo change and throw an error if it does not exist * Logo change requests have to be a real file now * Cleanup, making linter happy * Format javascript on push * Only format js in master * Tweak latency level values * Remove unused config file examples * Fix thumbnail generation after messing with the ffmpeg path getter * Reduce how often we report high hardware utilization warnings * Bundle the 0.0.6 branch version of the admin * Return validated ffmpeg path in admin server config * Change the logo to be stored in the data directory instead of webroot * Bump postcss from 8.2.4 to 8.2.5 in /build/javascript (#702) Bumps [postcss](https://github.com/postcss/postcss) from 8.2.4 to 8.2.5. - [Release notes](https://github.com/postcss/postcss/releases) - [Changelog](https://github.com/postcss/postcss/blob/main/CHANGELOG.md) - [Commits](https://github.com/postcss/postcss/compare/8.2.4...8.2.5) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Default config file no longer used * don't show stream title when offline addresses https://github.com/owncast/owncast/issues/677 * Remove auto-clearing stream title. #677 * webroot -> data when using logo as thumbnail * Do not list websocket/access token create/delete as integration APIs * Commit updated API documentation * Bundle updated admin * Remove pointing to the 0.0.6 admin branch * Linter cleanup * Linter cleanup * Add donations and follow links to show up under social handles * Prettified Code! * More linter cleanup * Update admin bundle * Remove use of platforms.js and return icons with social handles. Closes #732 * Update admin bundle * Support custom config path for use in migration * Remove unused platform-logos.gif * Reduce log level of message * Remove unused logo files in static dir * Handle dev vs. release build info * Restore logo.png for initial thumbnail * Cleanup some files from the build process that are not needed * Fix incorrect build-time injection var * Fix missing file getting copied to the build * Remove console directory message. * Update admin bundle * Fix comment * Report storage setup error * add some value set error checking * Use validated dynamic ffmpeg path for animated gif preview * Make chat message links be white so they don't hide in the bg. Closes #599 * Restore conditional that was accidentally removed Co-authored-by: Aaron Ogle <geekgonecrazy@users.noreply.github.com> Co-authored-by: Owncast <owncast@owncast.online> Co-authored-by: Ginger Wong <omqmail@gmail.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: nebunez <uoj2y7wak869@opayq.net> Co-authored-by: gabek <gabek@users.noreply.github.com>
167 lines
4.6 KiB
JavaScript
167 lines
4.6 KiB
JavaScript
import { URL_WEBSOCKET } from './constants.js';
|
|
/**
|
|
* These are the types of messages that we can handle with the websocket.
|
|
* Mostly used by `websocket.js` but if other components need to handle
|
|
* different types then it can import this file.
|
|
*/
|
|
export const SOCKET_MESSAGE_TYPES = {
|
|
CHAT: 'CHAT',
|
|
PING: 'PING',
|
|
NAME_CHANGE: 'NAME_CHANGE',
|
|
PONG: 'PONG',
|
|
SYSTEM: 'SYSTEM',
|
|
USER_JOINED: 'USER_JOINED',
|
|
CHAT_ACTION: 'CHAT_ACTION'
|
|
};
|
|
|
|
const IGNORE_CLIENT_FLAG = 'IGNORE_CLIENT';
|
|
|
|
export const CALLBACKS = {
|
|
RAW_WEBSOCKET_MESSAGE_RECEIVED: 'rawWebsocketMessageReceived',
|
|
WEBSOCKET_CONNECTED: 'websocketConnected',
|
|
WEBSOCKET_DISCONNECTED: 'websocketDisconnected',
|
|
}
|
|
|
|
const TIMER_WEBSOCKET_RECONNECT = 5000; // ms
|
|
|
|
export default class Websocket {
|
|
constructor(ignoreClient) {
|
|
this.websocket = null;
|
|
this.websocketReconnectTimer = null;
|
|
|
|
this.websocketConnectedListeners = [];
|
|
this.websocketDisconnectListeners = [];
|
|
this.rawMessageListeners = [];
|
|
|
|
this.send = this.send.bind(this);
|
|
this.createAndConnect = this.createAndConnect.bind(this);
|
|
this.scheduleReconnect = this.scheduleReconnect.bind(this);
|
|
|
|
this.ignoreClient = ignoreClient;
|
|
|
|
this.createAndConnect();
|
|
}
|
|
|
|
createAndConnect() {
|
|
const extraFlags = this.ignoreClient ? [IGNORE_CLIENT_FLAG] : [];
|
|
const ws = new WebSocket(URL_WEBSOCKET, extraFlags);
|
|
ws.onopen = this.onOpen.bind(this);
|
|
ws.onclose = this.onClose.bind(this);
|
|
ws.onerror = this.onError.bind(this);
|
|
ws.onmessage = this.onMessage.bind(this);
|
|
|
|
this.websocket = ws;
|
|
}
|
|
|
|
// Other components should register for websocket callbacks.
|
|
addListener(type, callback) {
|
|
if (type == CALLBACKS.WEBSOCKET_CONNECTED) {
|
|
this.websocketConnectedListeners.push(callback);
|
|
} else if (type == CALLBACKS.WEBSOCKET_DISCONNECTED) {
|
|
this.websocketDisconnectListeners.push(callback);
|
|
} else if (type == CALLBACKS.RAW_WEBSOCKET_MESSAGE_RECEIVED) {
|
|
this.rawMessageListeners.push(callback);
|
|
}
|
|
}
|
|
|
|
// Interface with other components
|
|
|
|
// Outbound: Other components can pass an object to `send`.
|
|
send(message) {
|
|
// Sanity check that what we're sending is a valid type.
|
|
if (!message.type || !SOCKET_MESSAGE_TYPES[message.type]) {
|
|
console.warn(
|
|
`Outbound message: Unknown socket message type: "${message.type}" sent.`
|
|
);
|
|
}
|
|
|
|
const messageJSON = JSON.stringify(message);
|
|
this.websocket.send(messageJSON);
|
|
}
|
|
|
|
// Private methods
|
|
|
|
// Fire the callbacks of the listeners.
|
|
|
|
notifyWebsocketConnectedListeners(message) {
|
|
this.websocketConnectedListeners.forEach(function (callback) {
|
|
callback(message);
|
|
});
|
|
}
|
|
|
|
notifyWebsocketDisconnectedListeners(message) {
|
|
this.websocketDisconnectListeners.forEach(function (callback) {
|
|
callback(message);
|
|
});
|
|
}
|
|
|
|
notifyRawMessageListeners(message) {
|
|
this.rawMessageListeners.forEach(function (callback) {
|
|
callback(message);
|
|
});
|
|
}
|
|
|
|
// Internal websocket callbacks
|
|
|
|
onOpen(e) {
|
|
if (this.websocketReconnectTimer) {
|
|
clearTimeout(this.websocketReconnectTimer);
|
|
}
|
|
|
|
this.notifyWebsocketConnectedListeners();
|
|
}
|
|
|
|
onClose(e) {
|
|
// connection closed, discard old websocket and create a new one in 5s
|
|
this.websocket = null;
|
|
this.notifyWebsocketDisconnectedListeners();
|
|
this.handleNetworkingError('Websocket closed.');
|
|
this.scheduleReconnect();
|
|
}
|
|
|
|
// On ws error just close the socket and let it re-connect again for now.
|
|
onError(e) {
|
|
this.handleNetworkingError(`Socket error: ${JSON.parse(e)}`);
|
|
this.websocket.close();
|
|
this.scheduleReconnect();
|
|
}
|
|
|
|
scheduleReconnect() {
|
|
this.websocketReconnectTimer = setTimeout(
|
|
this.createAndConnect,
|
|
TIMER_WEBSOCKET_RECONNECT
|
|
);
|
|
}
|
|
|
|
/*
|
|
onMessage is fired when an inbound object comes across the websocket.
|
|
If the message is of type `PING` we send a `PONG` back and do not
|
|
pass it along to listeners.
|
|
*/
|
|
onMessage(e) {
|
|
try {
|
|
var model = JSON.parse(e.data);
|
|
} catch (e) {
|
|
console.log(e);
|
|
}
|
|
|
|
// Send PONGs
|
|
if (model.type === SOCKET_MESSAGE_TYPES.PING) {
|
|
this.sendPong();
|
|
return;
|
|
}
|
|
|
|
// Notify any of the listeners via the raw socket message callback.
|
|
this.notifyRawMessageListeners(model);
|
|
}
|
|
|
|
// Reply to a PING as a keep alive.
|
|
sendPong() {
|
|
const pong = { type: SOCKET_MESSAGE_TYPES.PONG };
|
|
this.send(pong);
|
|
}
|
|
|
|
handleNetworkingError(error) {
|
|
console.error(`Websocket Error. Chat is likely not working. Visit troubleshooting steps to resolve. https://owncast.online/docs/troubleshooting/#chat-is-disabled: ${error}`);
|
|
}
|
|
}
|