chore: Remove WEBSOCKETS_ENABLED flag (#1383)
* chore: Remove WEBSOCKETS_ENALBED flag * lint
This commit is contained in:
parent
2cc6d7add8
commit
109efcaa27
|
@ -18,7 +18,6 @@ PORT=3000
|
||||||
FORCE_HTTPS=true
|
FORCE_HTTPS=true
|
||||||
|
|
||||||
ENABLE_UPDATES=true
|
ENABLE_UPDATES=true
|
||||||
WEBSOCKETS_ENABLED=true
|
|
||||||
DEBUG=cache,presenters,events
|
DEBUG=cache,presenters,events
|
||||||
|
|
||||||
# Third party signin credentials (at least one is required)
|
# Third party signin credentials (at least one is required)
|
||||||
|
|
5
app.json
5
app.json
|
@ -39,11 +39,6 @@
|
||||||
"value": "true",
|
"value": "true",
|
||||||
"required": true
|
"required": true
|
||||||
},
|
},
|
||||||
"WEBSOCKETS_ENABLED": {
|
|
||||||
"value": "true",
|
|
||||||
"required": true,
|
|
||||||
"description": "Allow realtime data to be pushed to clients over websockets"
|
|
||||||
},
|
|
||||||
"URL": {
|
"URL": {
|
||||||
"description": "https://{your app name}.herokuapp.com",
|
"description": "https://{your app name}.herokuapp.com",
|
||||||
"required": true
|
"required": true
|
||||||
|
|
|
@ -13,7 +13,6 @@ import PoliciesStore from "stores/PoliciesStore";
|
||||||
import ViewsStore from "stores/ViewsStore";
|
import ViewsStore from "stores/ViewsStore";
|
||||||
import AuthStore from "stores/AuthStore";
|
import AuthStore from "stores/AuthStore";
|
||||||
import UiStore from "stores/UiStore";
|
import UiStore from "stores/UiStore";
|
||||||
import env from "env";
|
|
||||||
|
|
||||||
export const SocketContext: any = React.createContext();
|
export const SocketContext: any = React.createContext();
|
||||||
|
|
||||||
|
@ -35,8 +34,6 @@ class SocketProvider extends React.Component<Props> {
|
||||||
@observable socket;
|
@observable socket;
|
||||||
|
|
||||||
componentDidMount() {
|
componentDidMount() {
|
||||||
if (!env.WEBSOCKETS_ENABLED) return;
|
|
||||||
|
|
||||||
this.socket = io(window.location.origin, {
|
this.socket = io(window.location.origin, {
|
||||||
path: "/realtime",
|
path: "/realtime",
|
||||||
});
|
});
|
||||||
|
|
6
index.js
6
index.js
|
@ -62,12 +62,6 @@ if (!process.env.REDIS_URL) {
|
||||||
process.exit(1);
|
process.exit(1);
|
||||||
}
|
}
|
||||||
|
|
||||||
if (!process.env.WEBSOCKETS_ENABLED) {
|
|
||||||
console.log(
|
|
||||||
"WARNING: Websockets are disabled. Set WEBSOCKETS_ENABLED env variable to true to enable"
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (process.env.NODE_ENV === "production") {
|
if (process.env.NODE_ENV === "production") {
|
||||||
console.log("\n\x1b[33m%s\x1b[0m", "Running Outline in production mode.");
|
console.log("\n\x1b[33m%s\x1b[0m", "Running Outline in production mode.");
|
||||||
} else if (process.env.NODE_ENV === "development") {
|
} else if (process.env.NODE_ENV === "development") {
|
||||||
|
|
|
@ -7,6 +7,5 @@ export default {
|
||||||
SLACK_KEY: process.env.SLACK_KEY,
|
SLACK_KEY: process.env.SLACK_KEY,
|
||||||
SLACK_APP_ID: process.env.SLACK_APP_ID,
|
SLACK_APP_ID: process.env.SLACK_APP_ID,
|
||||||
SUBDOMAINS_ENABLED: process.env.SUBDOMAINS_ENABLED === "true",
|
SUBDOMAINS_ENABLED: process.env.SUBDOMAINS_ENABLED === "true",
|
||||||
WEBSOCKETS_ENABLED: process.env.WEBSOCKETS_ENABLED === "true",
|
|
||||||
GOOGLE_ANALYTICS_ID: process.env.GOOGLE_ANALYTICS_ID,
|
GOOGLE_ANALYTICS_ID: process.env.GOOGLE_ANALYTICS_ID,
|
||||||
};
|
};
|
||||||
|
|
278
server/index.js
278
server/index.js
|
@ -12,168 +12,166 @@ import policy from "./policies";
|
||||||
const server = http.createServer(app.callback());
|
const server = http.createServer(app.callback());
|
||||||
let io;
|
let io;
|
||||||
|
|
||||||
if (process.env.WEBSOCKETS_ENABLED === "true") {
|
const { can } = policy;
|
||||||
const { can } = policy;
|
|
||||||
|
|
||||||
io = IO(server, {
|
io = IO(server, {
|
||||||
path: "/realtime",
|
path: "/realtime",
|
||||||
serveClient: false,
|
serveClient: false,
|
||||||
cookie: false,
|
cookie: false,
|
||||||
});
|
});
|
||||||
|
|
||||||
io.adapter(
|
io.adapter(
|
||||||
socketRedisAdapter({
|
socketRedisAdapter({
|
||||||
pubClient: client,
|
pubClient: client,
|
||||||
subClient: subscriber,
|
subClient: subscriber,
|
||||||
})
|
})
|
||||||
);
|
);
|
||||||
|
|
||||||
SocketAuth(io, {
|
SocketAuth(io, {
|
||||||
authenticate: async (socket, data, callback) => {
|
authenticate: async (socket, data, callback) => {
|
||||||
const { token } = data;
|
const { token } = data;
|
||||||
|
|
||||||
try {
|
try {
|
||||||
const user = await getUserForJWT(token);
|
const user = await getUserForJWT(token);
|
||||||
socket.client.user = user;
|
socket.client.user = user;
|
||||||
|
|
||||||
// store the mapping between socket id and user id in redis
|
// store the mapping between socket id and user id in redis
|
||||||
// so that it is accessible across multiple server nodes
|
// so that it is accessible across multiple server nodes
|
||||||
await client.hset(socket.id, "userId", user.id);
|
await client.hset(socket.id, "userId", user.id);
|
||||||
|
|
||||||
return callback(null, true);
|
return callback(null, true);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
return callback(err);
|
return callback(err);
|
||||||
|
}
|
||||||
|
},
|
||||||
|
postAuthenticate: async (socket, data) => {
|
||||||
|
const { user } = socket.client;
|
||||||
|
|
||||||
|
// the rooms associated with the current team
|
||||||
|
// and user so we can send authenticated events
|
||||||
|
let rooms = [`team-${user.teamId}`, `user-${user.id}`];
|
||||||
|
|
||||||
|
// the rooms associated with collections this user
|
||||||
|
// has access to on connection. New collection subscriptions
|
||||||
|
// are managed from the client as needed through the 'join' event
|
||||||
|
const collectionIds = await user.collectionIds();
|
||||||
|
collectionIds.forEach(collectionId =>
|
||||||
|
rooms.push(`collection-${collectionId}`)
|
||||||
|
);
|
||||||
|
|
||||||
|
// join all of the rooms at once
|
||||||
|
socket.join(rooms);
|
||||||
|
|
||||||
|
// allow the client to request to join rooms
|
||||||
|
socket.on("join", async event => {
|
||||||
|
// user is joining a collection channel, because their permissions have
|
||||||
|
// changed, granting them access.
|
||||||
|
if (event.collectionId) {
|
||||||
|
const collection = await Collection.scope({
|
||||||
|
method: ["withMembership", user.id],
|
||||||
|
}).findByPk(event.collectionId);
|
||||||
|
|
||||||
|
if (can(user, "read", collection)) {
|
||||||
|
socket.join(`collection-${event.collectionId}`);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
},
|
|
||||||
postAuthenticate: async (socket, data) => {
|
|
||||||
const { user } = socket.client;
|
|
||||||
|
|
||||||
// the rooms associated with the current team
|
// user is joining a document channel, because they have navigated to
|
||||||
// and user so we can send authenticated events
|
// view a document.
|
||||||
let rooms = [`team-${user.teamId}`, `user-${user.id}`];
|
if (event.documentId) {
|
||||||
|
const document = await Document.findByPk(event.documentId, {
|
||||||
|
userId: user.id,
|
||||||
|
});
|
||||||
|
|
||||||
// the rooms associated with collections this user
|
if (can(user, "read", document)) {
|
||||||
// has access to on connection. New collection subscriptions
|
|
||||||
// are managed from the client as needed through the 'join' event
|
|
||||||
const collectionIds = await user.collectionIds();
|
|
||||||
collectionIds.forEach(collectionId =>
|
|
||||||
rooms.push(`collection-${collectionId}`)
|
|
||||||
);
|
|
||||||
|
|
||||||
// join all of the rooms at once
|
|
||||||
socket.join(rooms);
|
|
||||||
|
|
||||||
// allow the client to request to join rooms
|
|
||||||
socket.on("join", async event => {
|
|
||||||
// user is joining a collection channel, because their permissions have
|
|
||||||
// changed, granting them access.
|
|
||||||
if (event.collectionId) {
|
|
||||||
const collection = await Collection.scope({
|
|
||||||
method: ["withMembership", user.id],
|
|
||||||
}).findByPk(event.collectionId);
|
|
||||||
|
|
||||||
if (can(user, "read", collection)) {
|
|
||||||
socket.join(`collection-${event.collectionId}`);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// user is joining a document channel, because they have navigated to
|
|
||||||
// view a document.
|
|
||||||
if (event.documentId) {
|
|
||||||
const document = await Document.findByPk(event.documentId, {
|
|
||||||
userId: user.id,
|
|
||||||
});
|
|
||||||
|
|
||||||
if (can(user, "read", document)) {
|
|
||||||
const room = `document-${event.documentId}`;
|
|
||||||
|
|
||||||
await View.touch(event.documentId, user.id, event.isEditing);
|
|
||||||
const editing = await View.findRecentlyEditingByDocument(
|
|
||||||
event.documentId
|
|
||||||
);
|
|
||||||
|
|
||||||
socket.join(room, () => {
|
|
||||||
// let everyone else in the room know that a new user joined
|
|
||||||
io.to(room).emit("user.join", {
|
|
||||||
userId: user.id,
|
|
||||||
documentId: event.documentId,
|
|
||||||
isEditing: event.isEditing,
|
|
||||||
});
|
|
||||||
|
|
||||||
// let this user know who else is already present in the room
|
|
||||||
io.in(room).clients(async (err, sockets) => {
|
|
||||||
if (err) throw err;
|
|
||||||
|
|
||||||
// because a single user can have multiple socket connections we
|
|
||||||
// need to make sure that only unique userIds are returned. A Map
|
|
||||||
// makes this easy.
|
|
||||||
let userIds = new Map();
|
|
||||||
for (const socketId of sockets) {
|
|
||||||
const userId = await client.hget(socketId, "userId");
|
|
||||||
userIds.set(userId, userId);
|
|
||||||
}
|
|
||||||
socket.emit("document.presence", {
|
|
||||||
documentId: event.documentId,
|
|
||||||
userIds: Array.from(userIds.keys()),
|
|
||||||
editingIds: editing.map(view => view.userId),
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
// allow the client to request to leave rooms
|
|
||||||
socket.on("leave", event => {
|
|
||||||
if (event.collectionId) {
|
|
||||||
socket.leave(`collection-${event.collectionId}`);
|
|
||||||
}
|
|
||||||
if (event.documentId) {
|
|
||||||
const room = `document-${event.documentId}`;
|
const room = `document-${event.documentId}`;
|
||||||
socket.leave(room, () => {
|
|
||||||
io.to(room).emit("user.leave", {
|
await View.touch(event.documentId, user.id, event.isEditing);
|
||||||
|
const editing = await View.findRecentlyEditingByDocument(
|
||||||
|
event.documentId
|
||||||
|
);
|
||||||
|
|
||||||
|
socket.join(room, () => {
|
||||||
|
// let everyone else in the room know that a new user joined
|
||||||
|
io.to(room).emit("user.join", {
|
||||||
userId: user.id,
|
userId: user.id,
|
||||||
documentId: event.documentId,
|
documentId: event.documentId,
|
||||||
|
isEditing: event.isEditing,
|
||||||
|
});
|
||||||
|
|
||||||
|
// let this user know who else is already present in the room
|
||||||
|
io.in(room).clients(async (err, sockets) => {
|
||||||
|
if (err) throw err;
|
||||||
|
|
||||||
|
// because a single user can have multiple socket connections we
|
||||||
|
// need to make sure that only unique userIds are returned. A Map
|
||||||
|
// makes this easy.
|
||||||
|
let userIds = new Map();
|
||||||
|
for (const socketId of sockets) {
|
||||||
|
const userId = await client.hget(socketId, "userId");
|
||||||
|
userIds.set(userId, userId);
|
||||||
|
}
|
||||||
|
socket.emit("document.presence", {
|
||||||
|
documentId: event.documentId,
|
||||||
|
userIds: Array.from(userIds.keys()),
|
||||||
|
editingIds: editing.map(view => view.userId),
|
||||||
|
});
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
});
|
}
|
||||||
|
});
|
||||||
|
|
||||||
socket.on("disconnecting", () => {
|
// allow the client to request to leave rooms
|
||||||
const rooms = Object.keys(socket.rooms);
|
socket.on("leave", event => {
|
||||||
|
if (event.collectionId) {
|
||||||
rooms.forEach(room => {
|
socket.leave(`collection-${event.collectionId}`);
|
||||||
if (room.startsWith("document-")) {
|
}
|
||||||
const documentId = room.replace("document-", "");
|
if (event.documentId) {
|
||||||
io.to(room).emit("user.leave", {
|
|
||||||
userId: user.id,
|
|
||||||
documentId,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
socket.on("presence", async event => {
|
|
||||||
const room = `document-${event.documentId}`;
|
const room = `document-${event.documentId}`;
|
||||||
|
socket.leave(room, () => {
|
||||||
if (event.documentId && socket.rooms[room]) {
|
io.to(room).emit("user.leave", {
|
||||||
const view = await View.touch(
|
|
||||||
event.documentId,
|
|
||||||
user.id,
|
|
||||||
event.isEditing
|
|
||||||
);
|
|
||||||
view.user = user;
|
|
||||||
|
|
||||||
io.to(room).emit("user.presence", {
|
|
||||||
userId: user.id,
|
userId: user.id,
|
||||||
documentId: event.documentId,
|
documentId: event.documentId,
|
||||||
isEditing: event.isEditing,
|
});
|
||||||
|
});
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
socket.on("disconnecting", () => {
|
||||||
|
const rooms = Object.keys(socket.rooms);
|
||||||
|
|
||||||
|
rooms.forEach(room => {
|
||||||
|
if (room.startsWith("document-")) {
|
||||||
|
const documentId = room.replace("document-", "");
|
||||||
|
io.to(room).emit("user.leave", {
|
||||||
|
userId: user.id,
|
||||||
|
documentId,
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
},
|
});
|
||||||
});
|
|
||||||
}
|
socket.on("presence", async event => {
|
||||||
|
const room = `document-${event.documentId}`;
|
||||||
|
|
||||||
|
if (event.documentId && socket.rooms[room]) {
|
||||||
|
const view = await View.touch(
|
||||||
|
event.documentId,
|
||||||
|
user.id,
|
||||||
|
event.isEditing
|
||||||
|
);
|
||||||
|
view.user = user;
|
||||||
|
|
||||||
|
io.to(room).emit("user.presence", {
|
||||||
|
userId: user.id,
|
||||||
|
documentId: event.documentId,
|
||||||
|
isEditing: event.isEditing,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
});
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
server.on("error", err => {
|
server.on("error", err => {
|
||||||
throw err;
|
throw err;
|
||||||
|
|
|
@ -13,7 +13,9 @@ import subHours from "date-fns/sub_hours";
|
||||||
|
|
||||||
export default class Websockets {
|
export default class Websockets {
|
||||||
async on(event: Event) {
|
async on(event: Event) {
|
||||||
if (process.env.WEBSOCKETS_ENABLED !== "true" || !socketio) return;
|
if (!socketio) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
switch (event.name) {
|
switch (event.name) {
|
||||||
case "documents.publish":
|
case "documents.publish":
|
||||||
|
|
Reference in New Issue