Compare commits

...

19 Commits

Author SHA1 Message Date
dwelle
0fe79f8819 [debug] 2023-07-28 10:40:11 +02:00
dwelle
772a9999b8 Merge branch 'master' into arnost/sockets-reconnecting
# Conflicts:
#	package.json
#	src/locales/en.json
#	yarn.lock
2023-07-28 10:03:21 +02:00
Arnošt Pleskot
28b0095c8a
fix: making linter happy 2023-07-14 20:49:25 +02:00
Arnošt Pleskot
c4ff0594e3
fix: get socketId from emitted message 2023-07-13 10:24:36 +02:00
Arnošt Pleskot
4608e809b1
feat: filter disconnected users 2023-07-13 10:07:31 +02:00
Arnošt Pleskot
db5149ab5d
feat: store userId in localStorage 2023-07-12 17:22:46 +02:00
Arnošt Pleskot
2bdf09153c
feat: use userId instead of socketId 2023-07-12 16:56:21 +02:00
Arnošt Pleskot
62df03d78d
feat: submit scene to firebase on collab pause 2023-07-11 16:55:21 +02:00
Arnošt Pleskot
a1d3350131
fix: connect users when resumed from firebase 2023-07-11 16:55:20 +02:00
Arnošt Pleskot
a2d371bf1d
feat: when no users in room fetch data from firebase immediately 2023-07-11 16:55:19 +02:00
Arnošt Pleskot
e340103250
feat: firebase fallback for resume collaboration 2023-07-11 16:55:18 +02:00
Arnošt Pleskot
0567af1bcb
fix: properly sync after reconnecting 2023-07-11 16:55:17 +02:00
Arnošt Pleskot
2ffeff442a
feat: disable viewMode on update and init message 2023-07-11 16:55:16 +02:00
Arnošt Pleskot
ef190ebf30
feat: add optional spinner into toast message 2023-07-11 16:55:15 +02:00
Arnošt Pleskot
e1ff9791f2
feat: move logic from index.tsx into Collab.tsx 2023-07-11 16:55:14 +02:00
Arnošt Pleskot
aa91af8f7d
fix: emit scene init event after reconnecting 2023-07-11 16:55:13 +02:00
Arnošt Pleskot
52254bca7c
fix: do not fire pause logic on window focus/blur event 2023-07-11 16:55:12 +02:00
Arnošt Pleskot
addf9d71fa
feat: pause collab when user switches tabs in the browser 2023-07-11 16:55:11 +02:00
Arnošt Pleskot
1badf14a93
chore: update socket.io-client 2023-07-11 16:55:00 +02:00
15 changed files with 593 additions and 589 deletions

View File

@ -54,7 +54,7 @@
"react-dom": "18.2.0", "react-dom": "18.2.0",
"roughjs": "4.5.2", "roughjs": "4.5.2",
"sass": "1.51.0", "sass": "1.51.0",
"socket.io-client": "2.3.1", "socket.io-client": "4.6.1",
"tunnel-rat": "0.1.2" "tunnel-rat": "0.1.2"
}, },
"devDependencies": { "devDependencies": {

View File

@ -2748,6 +2748,7 @@ class App extends React.Component<AppProps, AppState> {
toast: { toast: {
message: string; message: string;
closable?: boolean; closable?: boolean;
spinner?: boolean;
duration?: number; duration?: number;
} | null, } | null,
) => { ) => {

View File

@ -25,6 +25,17 @@
white-space: pre-wrap; white-space: pre-wrap;
} }
.Toast__message--spinner {
padding: 0 3rem;
}
.Toast__spinner {
position: absolute;
left: 1.5rem;
top: 50%;
margin-top: -8px;
}
.close { .close {
position: absolute; position: absolute;
top: 0; top: 0;

View File

@ -1,5 +1,7 @@
import clsx from "clsx";
import { useCallback, useEffect, useRef } from "react"; import { useCallback, useEffect, useRef } from "react";
import { CloseIcon } from "./icons"; import { CloseIcon } from "./icons";
import Spinner from "./Spinner";
import "./Toast.scss"; import "./Toast.scss";
import { ToolButton } from "./ToolButton"; import { ToolButton } from "./ToolButton";
@ -9,12 +11,14 @@ export const Toast = ({
message, message,
onClose, onClose,
closable = false, closable = false,
spinner = true,
// To prevent autoclose, pass duration as Infinity // To prevent autoclose, pass duration as Infinity
duration = DEFAULT_TOAST_TIMEOUT, duration = DEFAULT_TOAST_TIMEOUT,
}: { }: {
message: string; message: string;
onClose: () => void; onClose: () => void;
closable?: boolean; closable?: boolean;
spinner?: boolean;
duration?: number; duration?: number;
}) => { }) => {
const timerRef = useRef<number>(0); const timerRef = useRef<number>(0);
@ -44,7 +48,18 @@ export const Toast = ({
onMouseEnter={onMouseEnter} onMouseEnter={onMouseEnter}
onMouseLeave={onMouseLeave} onMouseLeave={onMouseLeave}
> >
<p className="Toast__message">{message}</p> {spinner && (
<div className="Toast__spinner">
<Spinner />
</div>
)}
<p
className={clsx("Toast__message", {
"Toast__message--spinner": spinner,
})}
>
{message}
</p>
{closable && ( {closable && (
<ToolButton <ToolButton
icon={CloseIcon} icon={CloseIcon}

View File

@ -7,6 +7,8 @@ export const SYNC_FULL_SCENE_INTERVAL_MS = 20000;
export const SYNC_BROWSER_TABS_TIMEOUT = 50; export const SYNC_BROWSER_TABS_TIMEOUT = 50;
export const CURSOR_SYNC_TIMEOUT = 33; // ~30fps export const CURSOR_SYNC_TIMEOUT = 33; // ~30fps
export const DELETED_ELEMENT_TIMEOUT = 24 * 60 * 60 * 1000; // 1 day export const DELETED_ELEMENT_TIMEOUT = 24 * 60 * 60 * 1000; // 1 day
export const PAUSE_COLLABORATION_TIMEOUT = 2000;
export const RESUME_FALLBACK_TIMEOUT = 5000;
export const FILE_UPLOAD_MAX_BYTES = 3 * 1024 * 1024; // 3 MiB export const FILE_UPLOAD_MAX_BYTES = 3 * 1024 * 1024; // 3 MiB
// 1 year (https://stackoverflow.com/a/25201898/927631) // 1 year (https://stackoverflow.com/a/25201898/927631)

View File

@ -1,6 +1,6 @@
import throttle from "lodash.throttle"; import throttle from "lodash.throttle";
import { PureComponent } from "react"; import { PureComponent } from "react";
import { ExcalidrawImperativeAPI } from "../../types"; import { ExcalidrawImperativeAPI, PauseCollaborationState } from "../../types";
import { ErrorDialog } from "../../components/ErrorDialog"; import { ErrorDialog } from "../../components/ErrorDialog";
import { APP_NAME, ENV, EVENT } from "../../constants"; import { APP_NAME, ENV, EVENT } from "../../constants";
import { ImportedDataState } from "../../data/types"; import { ImportedDataState } from "../../data/types";
@ -16,6 +16,7 @@ import { Collaborator, Gesture } from "../../types";
import { import {
preventUnload, preventUnload,
resolvablePromise, resolvablePromise,
upsertMap,
withBatchedUpdates, withBatchedUpdates,
} from "../../utils"; } from "../../utils";
import { import {
@ -24,12 +25,15 @@ import {
FIREBASE_STORAGE_PREFIXES, FIREBASE_STORAGE_PREFIXES,
INITIAL_SCENE_UPDATE_TIMEOUT, INITIAL_SCENE_UPDATE_TIMEOUT,
LOAD_IMAGES_TIMEOUT, LOAD_IMAGES_TIMEOUT,
PAUSE_COLLABORATION_TIMEOUT,
WS_SCENE_EVENT_TYPES, WS_SCENE_EVENT_TYPES,
SYNC_FULL_SCENE_INTERVAL_MS, SYNC_FULL_SCENE_INTERVAL_MS,
RESUME_FALLBACK_TIMEOUT,
} from "../app_constants"; } from "../app_constants";
import { import {
generateCollaborationLinkData, generateCollaborationLinkData,
getCollaborationLink, getCollaborationLink,
getCollaborationLinkData,
getCollabServer, getCollabServer,
getSyncableElements, getSyncableElements,
SocketUpdateDataSource, SocketUpdateDataSource,
@ -43,8 +47,8 @@ import {
saveToFirebase, saveToFirebase,
} from "../data/firebase"; } from "../data/firebase";
import { import {
importUsernameFromLocalStorage, importUsernameAndIdFromLocalStorage,
saveUsernameToLocalStorage, saveUsernameAndIdToLocalStorage,
} from "../data/localStorage"; } from "../data/localStorage";
import Portal from "./Portal"; import Portal from "./Portal";
import RoomDialog from "./RoomDialog"; import RoomDialog from "./RoomDialog";
@ -71,16 +75,19 @@ import { resetBrowserStateVersions } from "../data/tabSync";
import { LocalData } from "../data/LocalData"; import { LocalData } from "../data/LocalData";
import { atom, useAtom } from "jotai"; import { atom, useAtom } from "jotai";
import { appJotaiStore } from "../app-jotai"; import { appJotaiStore } from "../app-jotai";
import { nanoid } from "nanoid";
export const collabAPIAtom = atom<CollabAPI | null>(null); export const collabAPIAtom = atom<CollabAPI | null>(null);
export const collabDialogShownAtom = atom(false); export const collabDialogShownAtom = atom(false);
export const isCollaboratingAtom = atom(false); export const isCollaboratingAtom = atom(false);
export const isOfflineAtom = atom(false); export const isOfflineAtom = atom(false);
export const isCollaborationPausedAtom = atom(false);
interface CollabState { interface CollabState {
errorMessage: string; errorMessage: string;
username: string; username: string;
activeRoomLink: string; activeRoomLink: string;
userId: string;
} }
type CollabInstance = InstanceType<typeof Collab>; type CollabInstance = InstanceType<typeof Collab>;
@ -94,6 +101,7 @@ export interface CollabAPI {
syncElements: CollabInstance["syncElements"]; syncElements: CollabInstance["syncElements"];
fetchImageFilesFromFirebase: CollabInstance["fetchImageFilesFromFirebase"]; fetchImageFilesFromFirebase: CollabInstance["fetchImageFilesFromFirebase"];
setUsername: (username: string) => void; setUsername: (username: string) => void;
isPaused: () => boolean;
} }
interface PublicProps { interface PublicProps {
@ -108,6 +116,7 @@ class Collab extends PureComponent<Props, CollabState> {
excalidrawAPI: Props["excalidrawAPI"]; excalidrawAPI: Props["excalidrawAPI"];
activeIntervalId: number | null; activeIntervalId: number | null;
idleTimeoutId: number | null; idleTimeoutId: number | null;
pauseTimeoutId: number | null;
private socketInitializationTimer?: number; private socketInitializationTimer?: number;
private lastBroadcastedOrReceivedSceneVersion: number = -1; private lastBroadcastedOrReceivedSceneVersion: number = -1;
@ -115,9 +124,13 @@ class Collab extends PureComponent<Props, CollabState> {
constructor(props: Props) { constructor(props: Props) {
super(props); super(props);
const { username, userId } = importUsernameAndIdFromLocalStorage() || {};
this.state = { this.state = {
errorMessage: "", errorMessage: "",
username: importUsernameFromLocalStorage() || "", username: username || "",
userId: userId || "",
activeRoomLink: "", activeRoomLink: "",
}; };
this.portal = new Portal(this); this.portal = new Portal(this);
@ -149,6 +162,7 @@ class Collab extends PureComponent<Props, CollabState> {
this.excalidrawAPI = props.excalidrawAPI; this.excalidrawAPI = props.excalidrawAPI;
this.activeIntervalId = null; this.activeIntervalId = null;
this.idleTimeoutId = null; this.idleTimeoutId = null;
this.pauseTimeoutId = null;
} }
componentDidMount() { componentDidMount() {
@ -167,6 +181,7 @@ class Collab extends PureComponent<Props, CollabState> {
fetchImageFilesFromFirebase: this.fetchImageFilesFromFirebase, fetchImageFilesFromFirebase: this.fetchImageFilesFromFirebase,
stopCollaboration: this.stopCollaboration, stopCollaboration: this.stopCollaboration,
setUsername: this.setUsername, setUsername: this.setUsername,
isPaused: this.isPaused,
}; };
appJotaiStore.set(collabAPIAtom, collabAPI); appJotaiStore.set(collabAPIAtom, collabAPI);
@ -192,10 +207,13 @@ class Collab extends PureComponent<Props, CollabState> {
window.removeEventListener(EVENT.BEFORE_UNLOAD, this.beforeUnload); window.removeEventListener(EVENT.BEFORE_UNLOAD, this.beforeUnload);
window.removeEventListener(EVENT.UNLOAD, this.onUnload); window.removeEventListener(EVENT.UNLOAD, this.onUnload);
window.removeEventListener(EVENT.POINTER_MOVE, this.onPointerMove); window.removeEventListener(EVENT.POINTER_MOVE, this.onPointerMove);
window.removeEventListener( // window.removeEventListener(
EVENT.VISIBILITY_CHANGE, // EVENT.VISIBILITY_CHANGE,
this.onVisibilityChange, // this.onVisibilityChange,
); // );
window.removeEventListener(EVENT.BLUR, this.onVisibilityChange);
window.removeEventListener(EVENT.FOCUS, this.onVisibilityChange);
if (this.activeIntervalId) { if (this.activeIntervalId) {
window.clearInterval(this.activeIntervalId); window.clearInterval(this.activeIntervalId);
this.activeIntervalId = null; this.activeIntervalId = null;
@ -204,6 +222,10 @@ class Collab extends PureComponent<Props, CollabState> {
window.clearTimeout(this.idleTimeoutId); window.clearTimeout(this.idleTimeoutId);
this.idleTimeoutId = null; this.idleTimeoutId = null;
} }
if (this.pauseTimeoutId) {
window.clearTimeout(this.pauseTimeoutId);
this.pauseTimeoutId = null;
}
} }
isCollaborating = () => appJotaiStore.get(isCollaboratingAtom)!; isCollaborating = () => appJotaiStore.get(isCollaboratingAtom)!;
@ -307,6 +329,128 @@ class Collab extends PureComponent<Props, CollabState> {
} }
}; };
fallbackResumeTimeout: null | ReturnType<typeof setTimeout> = null;
/**
* Handles the pause and resume states of a collaboration session.
* This function gets triggered when a change in the collaboration pause state is detected.
* Based on the state, the function carries out the following actions:
* 1. `PAUSED`: Saves the current scene to Firebase, disconnects the socket, and updates the scene to view mode.
* 2. `RESUMED`: Connects the socket, shows a toast message, sets a fallback to fetch data from Firebase, and resets the pause timeout if any.
* 3. `SYNCED`: Clears the fallback timeout if any, updates the collaboration pause state, and updates the scene to editing mode.
*
* @param state - The new state of the collaboration session. It is one of the values of `PauseCollaborationState` enum, which includes `PAUSED`, `RESUMED`, and `SYNCED`.
*/
onPauseCollaborationChange = (state: PauseCollaborationState) => {
switch (state) {
case PauseCollaborationState.PAUSED: {
if (this.portal.socket) {
// Save current scene to firebase
this.saveCollabRoomToFirebase(
getSyncableElements(
this.excalidrawAPI.getSceneElementsIncludingDeleted(),
),
);
this.portal.socket.disconnect();
this.portal.socketInitialized = false;
this.setIsCollaborationPaused(true);
this.excalidrawAPI.updateScene({
appState: { viewModeEnabled: true },
});
}
break;
}
case PauseCollaborationState.RESUMED: {
if (this.portal.socket && this.isPaused()) {
this.portal.socket.connect();
this.portal.socket.emit(WS_SCENE_EVENT_TYPES.INIT);
console.log("setting toast");
this.excalidrawAPI.setToast({
message: t("toast.reconnectRoomServer"),
duration: Infinity,
spinner: true,
closable: false,
});
// Fallback to fetch data from firebase when reconnecting to scene without collaborators
const fallbackResumeHandler = async () => {
const roomLinkData = getCollaborationLinkData(
this.state.activeRoomLink,
);
if (!roomLinkData) {
return;
}
const elements = await loadFromFirebase(
roomLinkData.roomId,
roomLinkData.roomKey,
this.portal.socket,
);
if (elements) {
this.setLastBroadcastedOrReceivedSceneVersion(
getSceneVersion(elements),
);
this.excalidrawAPI.updateScene({
elements,
});
}
this.onPauseCollaborationChange(PauseCollaborationState.SYNCED);
};
// Set timeout to fallback to fetch data from firebase
this.fallbackResumeTimeout = setTimeout(
fallbackResumeHandler,
RESUME_FALLBACK_TIMEOUT,
);
// When no users are in the room, we fallback to fetch data from firebase immediately and clear fallback timeout
this.portal.socket.on("first-in-room", () => {
if (this.portal.socket) {
this.portal.socket.off("first-in-room");
// Recall init event to initialize collab with other users (fixes https://github.com/excalidraw/excalidraw/pull/6638#issuecomment-1600799080)
this.portal.socket.emit(WS_SCENE_EVENT_TYPES.INIT);
}
fallbackResumeHandler();
});
}
// Clear pause timeout if exists
if (this.pauseTimeoutId) {
clearTimeout(this.pauseTimeoutId);
}
break;
}
case PauseCollaborationState.SYNCED: {
if (this.fallbackResumeTimeout) {
clearTimeout(this.fallbackResumeTimeout);
this.fallbackResumeTimeout = null;
}
if (this.isPaused()) {
this.setIsCollaborationPaused(false);
this.excalidrawAPI.updateScene({
appState: { viewModeEnabled: false },
});
console.log("resetting toast");
this.excalidrawAPI.setToast(null);
this.excalidrawAPI.scrollToContent();
}
}
}
};
isPaused = () => appJotaiStore.get(isCollaborationPausedAtom)!;
setIsCollaborationPaused = (isPaused: boolean) => {
appJotaiStore.set(isCollaborationPausedAtom, isPaused);
};
private destroySocketClient = (opts?: { isUnload: boolean }) => { private destroySocketClient = (opts?: { isUnload: boolean }) => {
this.lastBroadcastedOrReceivedSceneVersion = -1; this.lastBroadcastedOrReceivedSceneVersion = -1;
this.portal.close(); this.portal.close();
@ -385,6 +529,11 @@ class Collab extends PureComponent<Props, CollabState> {
}); });
} }
if (!this.state.userId) {
const userId = nanoid();
this.onUserIdChange(userId);
}
if (this.portal.socket) { if (this.portal.socket) {
return null; return null;
} }
@ -499,6 +648,7 @@ class Collab extends PureComponent<Props, CollabState> {
elements: reconciledElements, elements: reconciledElements,
scrollToContent: true, scrollToContent: true,
}); });
this.onPauseCollaborationChange(PauseCollaborationState.SYNCED);
} }
break; break;
} }
@ -508,33 +658,45 @@ class Collab extends PureComponent<Props, CollabState> {
); );
break; break;
case "MOUSE_LOCATION": { case "MOUSE_LOCATION": {
const { pointer, button, username, selectedElementIds } = const {
decryptedData.payload; pointer,
const socketId: SocketUpdateDataSource["MOUSE_LOCATION"]["payload"]["socketId"] = button,
decryptedData.payload.socketId || username,
// @ts-ignore legacy, see #2094 (#2097) selectedElementIds,
decryptedData.payload.socketID; userId,
socketId,
const collaborators = new Map(this.collaborators); } = decryptedData.payload;
const user = collaborators.get(socketId) || {}!; const collaborators = upsertMap(
user.pointer = pointer; userId,
user.button = button; {
user.selectedElementIds = selectedElementIds; username,
user.username = username; pointer,
collaborators.set(socketId, user); button,
selectedElementIds,
socketId,
},
this.collaborators,
);
this.excalidrawAPI.updateScene({ this.excalidrawAPI.updateScene({
collaborators, collaborators: new Map(collaborators),
}); });
break; break;
} }
case "IDLE_STATUS": { case "IDLE_STATUS": {
const { userState, socketId, username } = decryptedData.payload; const { userState, username, userId, socketId } =
const collaborators = new Map(this.collaborators); decryptedData.payload;
const user = collaborators.get(socketId) || {}!; const collaborators = upsertMap(
user.userState = userState; userId,
user.username = username; {
username,
userState,
userId,
socketId,
},
this.collaborators,
);
this.excalidrawAPI.updateScene({ this.excalidrawAPI.updateScene({
collaborators, collaborators: new Map(collaborators),
}); });
break; break;
} }
@ -543,6 +705,7 @@ class Collab extends PureComponent<Props, CollabState> {
); );
this.portal.socket.on("first-in-room", async () => { this.portal.socket.on("first-in-room", async () => {
console.log("first in room");
if (this.portal.socket) { if (this.portal.socket) {
this.portal.socket.off("first-in-room"); this.portal.socket.off("first-in-room");
} }
@ -684,7 +847,9 @@ class Collab extends PureComponent<Props, CollabState> {
}; };
private onVisibilityChange = () => { private onVisibilityChange = () => {
if (document.hidden) { // if (document.hidden) {
console.log("VIS CHANGE");
if (!document.hasFocus()) {
if (this.idleTimeoutId) { if (this.idleTimeoutId) {
window.clearTimeout(this.idleTimeoutId); window.clearTimeout(this.idleTimeoutId);
this.idleTimeoutId = null; this.idleTimeoutId = null;
@ -693,6 +858,10 @@ class Collab extends PureComponent<Props, CollabState> {
window.clearInterval(this.activeIntervalId); window.clearInterval(this.activeIntervalId);
this.activeIntervalId = null; this.activeIntervalId = null;
} }
this.pauseTimeoutId = window.setTimeout(
() => this.onPauseCollaborationChange(PauseCollaborationState.PAUSED),
PAUSE_COLLABORATION_TIMEOUT,
);
this.onIdleStateChange(UserIdleState.AWAY); this.onIdleStateChange(UserIdleState.AWAY);
} else { } else {
this.idleTimeoutId = window.setTimeout(this.reportIdle, IDLE_THRESHOLD); this.idleTimeoutId = window.setTimeout(this.reportIdle, IDLE_THRESHOLD);
@ -701,6 +870,11 @@ class Collab extends PureComponent<Props, CollabState> {
ACTIVE_THRESHOLD, ACTIVE_THRESHOLD,
); );
this.onIdleStateChange(UserIdleState.ACTIVE); this.onIdleStateChange(UserIdleState.ACTIVE);
if (this.pauseTimeoutId) {
window.clearTimeout(this.pauseTimeoutId);
this.onPauseCollaborationChange(PauseCollaborationState.RESUMED);
this.pauseTimeoutId = null;
}
} }
}; };
@ -717,22 +891,19 @@ class Collab extends PureComponent<Props, CollabState> {
}; };
private initializeIdleDetector = () => { private initializeIdleDetector = () => {
document.addEventListener(EVENT.POINTER_MOVE, this.onPointerMove); // document.addEventListener(EVENT.POINTER_MOVE, this.onPointerMove);
document.addEventListener(EVENT.VISIBILITY_CHANGE, this.onVisibilityChange); // document.addEventListener(EVENT.VISIBILITY_CHANGE, this.onVisibilityChange);
window.addEventListener(EVENT.BLUR, this.onVisibilityChange);
window.addEventListener(EVENT.FOCUS, this.onVisibilityChange);
}; };
setCollaborators(sockets: string[]) { setCollaborators(sockets: string[]) {
const collaborators: InstanceType<typeof Collab>["collaborators"] = this.collaborators.forEach((value, key) => {
new Map(); if (value.socketId && !sockets.includes(value.socketId)) {
for (const socketId of sockets) { this.collaborators.delete(key);
if (this.collaborators.has(socketId)) {
collaborators.set(socketId, this.collaborators.get(socketId)!);
} else {
collaborators.set(socketId, {});
} }
} });
this.collaborators = collaborators; this.excalidrawAPI.updateScene({ collaborators: this.collaborators });
this.excalidrawAPI.updateScene({ collaborators });
} }
public setLastBroadcastedOrReceivedSceneVersion = (version: number) => { public setLastBroadcastedOrReceivedSceneVersion = (version: number) => {
@ -818,7 +989,12 @@ class Collab extends PureComponent<Props, CollabState> {
onUsernameChange = (username: string) => { onUsernameChange = (username: string) => {
this.setUsername(username); this.setUsername(username);
saveUsernameToLocalStorage(username); saveUsernameAndIdToLocalStorage(username, this.state.userId);
};
onUserIdChange = (userId: string) => {
this.setState({ userId });
saveUsernameAndIdToLocalStorage(this.state.username, userId);
}; };
render() { render() {

View File

@ -34,26 +34,12 @@ class Portal {
open(socket: SocketIOClient.Socket, id: string, key: string) { open(socket: SocketIOClient.Socket, id: string, key: string) {
this.socket = socket; this.socket = socket;
// @ts-ignore
window.socket = socket;
this.roomId = id; this.roomId = id;
this.roomKey = key; this.roomKey = key;
// Initialize socket listeners this.initializeSocketListeners();
this.socket.on("init-room", () => {
if (this.socket) {
this.socket.emit("join-room", this.roomId);
trackEvent("share", "room joined");
}
});
this.socket.on("new-user", async (_socketId: string) => {
this.broadcastScene(
WS_SCENE_EVENT_TYPES.INIT,
this.collab.getSceneElementsIncludingDeleted(),
/* syncAll */ true,
);
});
this.socket.on("room-user-change", (clients: string[]) => {
this.collab.setCollaborators(clients);
});
return socket; return socket;
} }
@ -71,6 +57,31 @@ class Portal {
this.broadcastedElementVersions = new Map(); this.broadcastedElementVersions = new Map();
} }
initializeSocketListeners() {
if (!this.socket) {
return;
}
// Initialize socket listeners
this.socket.on("init-room", () => {
console.log("join room");
if (this.socket) {
this.socket.emit("join-room", this.roomId);
trackEvent("share", "room joined");
}
});
this.socket.on("new-user", async (_socketId: string) => {
this.broadcastScene(
WS_SCENE_EVENT_TYPES.INIT,
this.collab.getSceneElementsIncludingDeleted(),
/* syncAll */ true,
);
});
this.socket.on("room-user-change", (clients: string[]) => {
this.collab.setCollaborators(clients);
});
}
isOpen() { isOpen() {
return !!( return !!(
this.socketInitialized && this.socketInitialized &&
@ -181,13 +192,14 @@ class Portal {
}; };
broadcastIdleChange = (userState: UserIdleState) => { broadcastIdleChange = (userState: UserIdleState) => {
if (this.socket?.id) { if (this.socket) {
const data: SocketUpdateDataSource["IDLE_STATUS"] = { const data: SocketUpdateDataSource["IDLE_STATUS"] = {
type: "IDLE_STATUS", type: "IDLE_STATUS",
payload: { payload: {
socketId: this.socket.id,
userState, userState,
username: this.collab.state.username, username: this.collab.state.username,
userId: this.collab.state.userId,
socketId: this.socket.id,
}, },
}; };
return this._broadcastSocketData( return this._broadcastSocketData(
@ -201,16 +213,17 @@ class Portal {
pointer: SocketUpdateDataSource["MOUSE_LOCATION"]["payload"]["pointer"]; pointer: SocketUpdateDataSource["MOUSE_LOCATION"]["payload"]["pointer"];
button: SocketUpdateDataSource["MOUSE_LOCATION"]["payload"]["button"]; button: SocketUpdateDataSource["MOUSE_LOCATION"]["payload"]["button"];
}) => { }) => {
if (this.socket?.id) { if (this.socket) {
const data: SocketUpdateDataSource["MOUSE_LOCATION"] = { const data: SocketUpdateDataSource["MOUSE_LOCATION"] = {
type: "MOUSE_LOCATION", type: "MOUSE_LOCATION",
payload: { payload: {
socketId: this.socket.id,
pointer: payload.pointer, pointer: payload.pointer,
button: payload.button || "up", button: payload.button || "up",
selectedElementIds: selectedElementIds:
this.collab.excalidrawAPI.getAppState().selectedElementIds, this.collab.excalidrawAPI.getAppState().selectedElementIds,
username: this.collab.state.username, username: this.collab.state.username,
userId: this.collab.state.userId,
socketId: this.socket.id,
}, },
}; };
return this._broadcastSocketData( return this._broadcastSocketData(

View File

@ -106,19 +106,21 @@ export type SocketUpdateDataSource = {
MOUSE_LOCATION: { MOUSE_LOCATION: {
type: "MOUSE_LOCATION"; type: "MOUSE_LOCATION";
payload: { payload: {
socketId: string;
pointer: { x: number; y: number }; pointer: { x: number; y: number };
button: "down" | "up"; button: "down" | "up";
selectedElementIds: AppState["selectedElementIds"]; selectedElementIds: AppState["selectedElementIds"];
username: string; username: string;
userId: string;
socketId: string;
}; };
}; };
IDLE_STATUS: { IDLE_STATUS: {
type: "IDLE_STATUS"; type: "IDLE_STATUS";
payload: { payload: {
socketId: string;
userState: UserIdleState; userState: UserIdleState;
username: string; username: string;
userId: string;
socketId: string;
}; };
}; };
}; };

View File

@ -8,11 +8,14 @@ import { clearElementsForLocalStorage } from "../../element";
import { STORAGE_KEYS } from "../app_constants"; import { STORAGE_KEYS } from "../app_constants";
import { ImportedDataState } from "../../data/types"; import { ImportedDataState } from "../../data/types";
export const saveUsernameToLocalStorage = (username: string) => { export const saveUsernameAndIdToLocalStorage = (
username: string,
userId: string,
) => {
try { try {
localStorage.setItem( localStorage.setItem(
STORAGE_KEYS.LOCAL_STORAGE_COLLAB, STORAGE_KEYS.LOCAL_STORAGE_COLLAB,
JSON.stringify({ username }), JSON.stringify({ username, userId }),
); );
} catch (error: any) { } catch (error: any) {
// Unable to access window.localStorage // Unable to access window.localStorage
@ -20,11 +23,14 @@ export const saveUsernameToLocalStorage = (username: string) => {
} }
}; };
export const importUsernameFromLocalStorage = (): string | null => { export const importUsernameAndIdFromLocalStorage = (): {
username: string;
userId: string;
} | null => {
try { try {
const data = localStorage.getItem(STORAGE_KEYS.LOCAL_STORAGE_COLLAB); const data = localStorage.getItem(STORAGE_KEYS.LOCAL_STORAGE_COLLAB);
if (data) { if (data) {
return JSON.parse(data).username; return JSON.parse(data);
} }
} catch (error: any) { } catch (error: any) {
// Unable to access localStorage // Unable to access localStorage

View File

@ -65,7 +65,7 @@ import {
import { import {
getLibraryItemsFromStorage, getLibraryItemsFromStorage,
importFromLocalStorage, importFromLocalStorage,
importUsernameFromLocalStorage, importUsernameAndIdFromLocalStorage,
} from "./data/localStorage"; } from "./data/localStorage";
import CustomStats from "./CustomStats"; import CustomStats from "./CustomStats";
import { restore, restoreAppState, RestoredDataState } from "../data/restore"; import { restore, restoreAppState, RestoredDataState } from "../data/restore";
@ -425,7 +425,8 @@ const ExcalidrawWrapper = () => {
// don't sync if local state is newer or identical to browser state // don't sync if local state is newer or identical to browser state
if (isBrowserStorageStateNewer(STORAGE_KEYS.VERSION_DATA_STATE)) { if (isBrowserStorageStateNewer(STORAGE_KEYS.VERSION_DATA_STATE)) {
const localDataState = importFromLocalStorage(); const localDataState = importFromLocalStorage();
const username = importUsernameFromLocalStorage(); const username =
importUsernameAndIdFromLocalStorage()?.username ?? "";
let langCode = languageDetector.detect() || defaultLang.code; let langCode = languageDetector.detect() || defaultLang.code;
if (Array.isArray(langCode)) { if (Array.isArray(langCode)) {
langCode = langCode[0]; langCode = langCode[0];

View File

@ -425,7 +425,8 @@
"selection": "selection", "selection": "selection",
"pasteAsSingleElement": "Use {{shortcut}} to paste as a single element,\nor paste into an existing text editor", "pasteAsSingleElement": "Use {{shortcut}} to paste as a single element,\nor paste into an existing text editor",
"unableToEmbed": "Embedding this url is currently not allowed. Raise an issue on GitHub to request the url whitelisted", "unableToEmbed": "Embedding this url is currently not allowed. Raise an issue on GitHub to request the url whitelisted",
"unrecognizedLinkFormat": "The link you embedded does not match the expected format. Please try to paste the 'embed' string provided by the source site" "unrecognizedLinkFormat": "The link you embedded does not match the expected format. Please try to paste the 'embed' string provided by the source site",
"reconnectRoomServer": "Reconnecting to server"
}, },
"colors": { "colors": {
"transparent": "Transparent", "transparent": "Transparent",

View File

@ -707,8 +707,8 @@ export const _renderScene = ({
if (renderConfig.remoteSelectedElementIds[element.id]) { if (renderConfig.remoteSelectedElementIds[element.id]) {
selectionColors.push( selectionColors.push(
...renderConfig.remoteSelectedElementIds[element.id].map( ...renderConfig.remoteSelectedElementIds[element.id].map(
(socketId) => { (userId) => {
const background = getClientColor(socketId); const background = getClientColor(userId);
return background; return background;
}, },
), ),

View File

@ -56,6 +56,7 @@ export type Collaborator = {
avatarUrl?: string; avatarUrl?: string;
// user id. If supplied, we'll filter out duplicates when rendering user avatars. // user id. If supplied, we'll filter out duplicates when rendering user avatars.
id?: string; id?: string;
socketId?: string;
}; };
export type DataURL = string & { _brand: "DataURL" }; export type DataURL = string & { _brand: "DataURL" };
@ -401,6 +402,12 @@ export enum UserIdleState {
IDLE = "idle", IDLE = "idle",
} }
export enum PauseCollaborationState {
PAUSED = "paused",
RESUMED = "resumed",
SYNCED = "synced",
}
export type ExportOpts = { export type ExportOpts = {
saveFileToDisk?: boolean; saveFileToDisk?: boolean;
onExportToBackend?: ( onExportToBackend?: (

View File

@ -914,3 +914,14 @@ export const isOnlyExportingSingleFrame = (
) )
); );
}; };
export const upsertMap = <T>(key: T, value: object, map: Map<T, object>) => {
if (!map.has(key)) {
map.set(key, value);
} else {
const old = map.get(key);
map.set(key, { ...old, ...value });
}
return map;
};

782
yarn.lock

File diff suppressed because it is too large Load Diff