19 |
38 |
39 | );
40 | };
41 |
42 | export default ChatList;
43 |
--------------------------------------------------------------------------------
/client/src/components/Chat/components/MessageList/components/SenderMessage.jsx:
--------------------------------------------------------------------------------
1 | // @ts-check
2 | import moment from "moment";
3 | import React from "react";
4 | import ClockIcon from "./ClockIcon";
5 | import OnlineIndicator from "../../OnlineIndicator";
6 |
7 | const SenderMessage = ({
8 | user,
9 | message = "Lorem ipsum dolor...",
10 | date,
11 | onUserClicked,
12 | }) => (
13 |
20 |
22 | Chats
21 |
23 |
36 |
37 |
24 | {processedRooms.map((room) => (
25 |
28 | dispatch({ type: "set current room", payload: room.id })
29 | }
30 | active={currentRoom === room.id}
31 | room={room}
32 | />
33 | ))}
34 |
35 |
14 |
44 | );
45 |
46 | export default SenderMessage;
47 |
--------------------------------------------------------------------------------
/Dockerfile:
--------------------------------------------------------------------------------
1 | # Copyright 2020 Google LLC
2 | #
3 | # Licensed under the Apache License, Version 2.0 (the "License");
4 | # you may not use this file except in compliance with the License.
5 | # You may obtain a copy of the License at
6 | #
7 | # https://www.apache.org/licenses/LICENSE-2.0
8 | #
9 | # Unless required by applicable law or agreed to in writing, software
10 | # distributed under the License is distributed on an "AS IS" BASIS,
11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | # See the License for the specific language governing permissions and
13 | # limitations under the License.
14 |
15 | # [START cloudrun_helloworld_dockerfile]
16 | # [START run_helloworld_dockerfile]
17 |
18 | # Use the official lightweight Node.js 12 image.
19 | # https://hub.docker.com/_/node
20 | FROM node:12-slim
21 |
22 | # Create and change to the app directory.
23 | WORKDIR /usr/src/app
24 |
25 | # Copy application dependency manifests to the container image.
26 | # A wildcard is used to ensure copying both package.json AND package-lock.json (when available).
27 | # Copying this first prevents re-running npm install on every code change.
28 | COPY package*.json ./
29 |
30 | # Install production dependencies.
31 | # If you add a package-lock.json, speed your build by switching to 'npm ci'.
32 | # RUN npm ci --only=production
33 | RUN npm install --only=production
34 |
35 | # Copy local code to the container image.
36 | COPY . ./
37 |
38 | # Run the web service on container startup.
39 | CMD [ "node", "server/index.js" ]
40 |
41 | # [END run_helloworld_dockerfile]
42 | # [END cloudrun_helloworld_dockerfile]
--------------------------------------------------------------------------------
/client/build/static/js/2.0a039c31.chunk.js.LICENSE.txt:
--------------------------------------------------------------------------------
1 | /*
2 | object-assign
3 | (c) Sindre Sorhus
4 | @license MIT
5 | */
6 |
7 | /*!
8 | Copyright (c) 2017 Jed Watson.
9 | Licensed under the MIT License (MIT), see
10 | http://jedwatson.github.io/classnames
11 | */
12 |
13 | /*!
14 | * The buffer module from node.js, for the browser.
15 | *
16 | * @author Feross Aboukhadijeh
15 |
42 |
43 |
19 |
41 |
20 | {user && (
21 |
40 |
22 |
34 | )}
35 |
30 | {user.username}
31 |
32 | {message}
36 |
37 |
13 | {true ? (
14 | <>
15 |
25 | );
26 |
27 | const LogoutButton = ({ onLogOut, col = 5, noinfo = false }) => (
28 |
33 |
35 | );
36 |
37 | const UserInfo = ({ user, col = 7, noinfo = false }) => (
38 |
43 |
56 | );
57 |
58 | export default Footer;
59 |
--------------------------------------------------------------------------------
/client/src/utils.js:
--------------------------------------------------------------------------------
1 | // @ts-check
2 |
3 | import { getUsers } from "./api";
4 |
5 | /**
6 | * @param {string[]} names
7 | * @param {string} username
8 | */
9 | export const parseRoomName = (names, username) => {
10 | for (let name of names) {
11 | if (typeof name !== 'string') {
12 | name = name[0];
13 | }
14 | if (name !== username) {
15 | return name;
16 | }
17 | }
18 | return names[0];
19 | };
20 |
21 | /** Get an avatar for a room or a user */
22 | export const getAvatarByUserAndRoomId = (roomId = "1") => {
23 | const TOTAL_IMAGES = 13;
24 | const seed1 = 654;
25 | const seed2 = 531;
26 |
27 | const uidParsed = +roomId.split(":").pop();
28 | let roomIdParsed = +roomId.split(":").reverse().pop();
29 | if (roomIdParsed < 0) {
30 | roomIdParsed += 3555;
31 | }
32 |
33 | const theId = (uidParsed * seed1 + roomIdParsed * seed2) % TOTAL_IMAGES;
34 |
35 | return `${process.env.PUBLIC_URL}/avatars/${theId}.jpg`;
36 | };
37 |
38 | const jdenticon = require("jdenticon");
39 |
40 | const avatars = {};
41 | export const getAvatar = (username) => {
42 | let av = avatars[username];
43 | if (av === undefined) {
44 | av =
45 | "data:image/svg+xml;base64," + window.btoa(jdenticon.toSvg(username, 50));
46 | avatars[username] = av;
47 | }
48 | return av;
49 | };
50 |
51 | export const populateUsersFromLoadedMessages = async (users, dispatch, messages) => {
52 | const userIds = {};
53 | messages.forEach((message) => {
54 | userIds[message.from] = 1;
55 | });
56 |
57 | const ids = Object.keys(userIds).filter(
58 | (id) => users[id] === undefined
59 | );
60 |
61 | if (ids.length !== 0) {
62 | /** We need to fetch users first */
63 | const newUsers = await getUsers(ids);
64 | dispatch({
65 | type: "append users",
66 | payload: newUsers,
67 | });
68 | }
69 |
70 | };
--------------------------------------------------------------------------------
/client/build/index.html:
--------------------------------------------------------------------------------
1 |
44 |
46 | {!noinfo && (
47 |
48 |
54 | )}
55 | {user.username}
49 |
50 |
53 | Active
52 |
33 |
74 | );
75 | }
76 |
--------------------------------------------------------------------------------
/client/src/components/Navbar.jsx:
--------------------------------------------------------------------------------
1 | // @ts-check
2 | import React, { useEffect, useState } from "react";
3 | import { getButtonLinks } from "../api";
4 |
5 | const Navbar = () => {
6 | /**
7 | * @type {[{
8 | * heroku?: string;
9 | * google_cloud?: string;
10 | * vercel?: string;
11 | * github?: string;
12 | * }, React.Dispatch
34 |
73 |
35 |
43 | {/* Chat Box*/}
44 |
45 | {
63 | e.preventDefault();
64 | onMessageSend(message.trim(), roomId);
65 | setMessage("");
66 |
67 | messageListElement.current.scrollTop =
68 | messageListElement.current.scrollHeight;
69 | }}
70 | />
71 |
72 |
46 |
48 | {room ? room.name : "Room"}
47 |
23 | {messages === undefined ? (
24 |
88 | );
89 | export default MessageList;
90 |
--------------------------------------------------------------------------------
/server/utils.js:
--------------------------------------------------------------------------------
1 | // @ts-check
2 | const bcrypt = require('bcrypt');
3 | const { incr, set, hmset, sadd, hmget, exists,
4 | client: redisClient,
5 | } = require('./redis');
6 |
7 | /** Redis key for the username (for getting the user id) */
8 | const makeUsernameKey = (username) => {
9 | const usernameKey = `username:${username}`;
10 | return usernameKey;
11 | };
12 |
13 | /**
14 | * Creates a user and adds default chat rooms
15 | * @param {string} username
16 | * @param {string} password
17 | */
18 | const createUser = async (username, password) => {
19 | const usernameKey = makeUsernameKey(username);
20 | /** Create user */
21 | const hashedPassword = await bcrypt.hash(password, 10);
22 | const nextId = await incr("total_users");
23 | const userKey = `user:${nextId}`;
24 | await set(usernameKey, userKey);
25 | await hmset(userKey, ["username", username, "password", hashedPassword]);
26 |
27 | /**
28 | * Each user has a set of rooms he is in
29 | * let's define the default ones
30 | */
31 | await sadd(`user:${nextId}:rooms`, `${0}`); // Main room
32 |
33 | /** This one should go to the session */
34 | return { id: nextId, username };
35 | };
36 |
37 | const getPrivateRoomId = (user1, user2) => {
38 | if (isNaN(user1) || isNaN(user2) || user1 === user2) {
39 | return null;
40 | }
41 | const minUserId = user1 > user2 ? user2 : user1;
42 | const maxUserId = user1 > user2 ? user1 : user2;
43 | return `${minUserId}:${maxUserId}`;
44 | };
45 |
46 | /**
47 | * Create a private room and add users to it
48 | * @returns {Promise<[{
49 | * id: string;
50 | * names: any[];
51 | * }, boolean]>}
52 | */
53 | const createPrivateRoom = async (user1, user2) => {
54 | const roomId = getPrivateRoomId(user1, user2);
55 |
56 | if (roomId === null) {
57 | return [null, true];
58 | }
59 |
60 | /** Add rooms to those users */
61 | await sadd(`user:${user1}:rooms`, `${roomId}`);
62 | await sadd(`user:${user2}:rooms`, `${roomId}`);
63 |
64 | return [{
65 | id: roomId,
66 | names: [
67 | await hmget(`user:${user1}`, "username"),
68 | await hmget(`user:${user2}`, "username"),
69 | ],
70 | }, false];
71 | };
72 |
73 |
74 | const getMessages = async (roomId = "0", offset = 0, size = 50) => {
75 | /**
76 | * Logic:
77 | * 1. Check if room with id exists
78 | * 2. Fetch messages from last hour
79 | **/
80 | const roomKey = `room:${roomId}`;
81 | const roomExists = await exists(roomKey);
82 | if (!roomExists) {
83 | return [];
84 | } else {
85 | return new Promise((resolve, reject) => {
86 | redisClient.zrevrange(roomKey, offset, offset + size, (err, values) => {
87 | if (err) {
88 | reject(err);
89 | }
90 | resolve(values.map((val) => JSON.parse(val)));
91 | });
92 | });
93 | }
94 | };
95 |
96 | const sanitise = (text) => {
97 | let sanitisedText = text;
98 |
99 | if (text.indexOf('<') > -1 || text.indexOf('>') > -1) {
100 | sanitisedText = text.replace(//g, '>');
101 | }
102 |
103 | return sanitisedText;
104 | };
105 |
106 | module.exports = {
107 | getMessages,
108 | sanitise,
109 | createUser,
110 | makeUsernameKey,
111 | createPrivateRoom,
112 | getPrivateRoomId
113 | };
--------------------------------------------------------------------------------
/client/src/components/Chat/use-chat-handlers.js:
--------------------------------------------------------------------------------
1 | // @ts-check
2 | import { useCallback } from "react";
3 | import { useEffect, useState, useRef } from "react";
4 | import { addRoom, getMessages } from "../../api";
5 | import { useAppState } from "../../state";
6 | import { parseRoomName, populateUsersFromLoadedMessages } from "../../utils";
7 |
8 | /** Lifecycle hooks with callbacks for the Chat component */
9 | const useChatHandlers = (/** @type {import("../../state").UserEntry} */ user) => {
10 | const [state, dispatch] = useAppState();
11 | const messageListElement = useRef(null);
12 |
13 | /** @type {import("../../state").Room} */
14 | const room = state.rooms[state.currentRoom];
15 | const roomId = room?.id;
16 | const messages = room?.messages;
17 |
18 | const [message, setMessage] = useState("");
19 |
20 | const scrollToTop = useCallback(() => {
21 | setTimeout(() => {
22 | if (messageListElement.current) {
23 | messageListElement.current.scrollTop = 0;
24 | }
25 | }, 0);
26 | }, []);
27 |
28 | const scrollToBottom = useCallback(() => {
29 | if (messageListElement.current) {
30 | messageListElement.current.scrollTo({
31 | top: messageListElement.current.scrollHeight,
32 | });
33 | }
34 | }, []);
35 |
36 | useEffect(() => {
37 | scrollToBottom();
38 | }, [messages, scrollToBottom]);
39 |
40 | const onFetchMessages = useCallback(
41 | (offset = 0, prepend = false) => {
42 | getMessages(roomId, offset).then(async (messages) => {
43 | /** We've got messages but it's possible we might not have the cached user entires which correspond to those messages */
44 | await populateUsersFromLoadedMessages(state.users, dispatch, messages);
45 |
46 | dispatch({
47 | type: prepend ? "prepend messages" : "set messages",
48 | payload: { id: roomId, messages: messages },
49 | });
50 | if (prepend) {
51 | setTimeout(() => {
52 | scrollToTop();
53 | }, 10);
54 | } else {
55 | scrollToBottom();
56 | }
57 | });
58 | },
59 | [dispatch, roomId, scrollToBottom, scrollToTop, state.users]
60 | );
61 |
62 | useEffect(() => {
63 | if (roomId === undefined) {
64 | return;
65 | }
66 | if (messages === undefined) {
67 | /** Fetch logic goes here */
68 | onFetchMessages();
69 | }
70 | }, [
71 | messages,
72 | dispatch,
73 | roomId,
74 | state.users,
75 | state,
76 | scrollToBottom,
77 | onFetchMessages,
78 | ]);
79 |
80 | useEffect(() => {
81 | if (messageListElement.current) {
82 | scrollToBottom();
83 | }
84 | }, [scrollToBottom, roomId]);
85 |
86 | const onUserClicked = async (userId) => {
87 | /** Check if room exists. */
88 | const targetUser = state.users[userId];
89 | let roomId = targetUser.room;
90 | if (roomId === undefined) {
91 | // @ts-ignore
92 | const room = await addRoom(userId, user.id);
93 | roomId = room.id;
94 | /** We need to set this room id to user. */
95 | dispatch({ type: "set user", payload: { ...targetUser, room: roomId } });
96 | /** Then a new room should be added to the store. */
97 | dispatch({
98 | type: "add room",
99 | // @ts-ignore
100 | payload: { id: roomId, name: parseRoomName(room.names, user.username) },
101 | });
102 | }
103 | /** Then a room should be changed */
104 | dispatch({ type: "set current room", payload: roomId });
105 | };
106 |
107 | const onLoadMoreMessages = useCallback(() => {
108 | onFetchMessages(room.offset, true);
109 | }, [onFetchMessages, room]);
110 |
111 | return {
112 | onLoadMoreMessages,
113 | onUserClicked,
114 | message,
115 | setMessage,
116 | dispatch,
117 | room,
118 | rooms: state.rooms,
119 | currentRoom: state.currentRoom,
120 | messageListElement,
121 | roomId,
122 | users: state.users,
123 | messages,
124 | };
125 | };
126 | export default useChatHandlers;
--------------------------------------------------------------------------------
/client/src/components/Chat/components/ChatList/components/ChatListItem/index.jsx:
--------------------------------------------------------------------------------
1 | // @ts-check
2 | import "./style.css";
3 | import React, { useMemo } from "react";
4 | import { useAppState } from "../../../../../../state";
5 | import moment from "moment";
6 | import { useEffect } from "react";
7 | import { getMessages } from "../../../../../../api";
8 | import AvatarImage from "../AvatarImage";
9 | import OnlineIndicator from "../../../OnlineIndicator";
10 |
11 | /**
12 | * @param {{ active: boolean; room: import('../../../../../../state').Room; onClick: () => void; }} props
13 | */
14 | const ChatListItem = ({ room, active = false, onClick }) => {
15 | const { online, name, lastMessage, userId } = useChatListItemHandlers(room);
16 | return (
17 |
31 | {messages && messages.length !== 0 && (
32 | <>
33 | {room.offset && room.offset >= MESSAGES_TO_LOAD ? (
34 | onUserClicked(message.from)}
66 | key={key}
67 | message={message.message}
68 | date={message.date}
69 | user={users[message.from]}
70 | />
71 | );
72 | }
73 | return (
74 |
87 |
35 |
38 |
54 | ) : (
55 | <>
56 | )}
57 | {messages.map((message, x) => {
58 | const key = message.message + message.date + message.from + x;
59 | if (message.from === "info") {
60 | return
39 |
49 |
50 |
53 |
23 |
41 | );
42 | };
43 |
44 | const useChatListItemHandlers = (
45 | /** @type {import("../../../../../../state").Room} */ room
46 | ) => {
47 | const { id, name } = room;
48 | const [state] = useAppState();
49 |
50 | /** Here we want to associate the room with a user by its name (since it's unique). */
51 | const [isUser, online, userId] = useMemo(() => {
52 | try {
53 | let pseudoUserId = Math.abs(parseInt(id.split(":").reverse().pop()));
54 | const isUser = pseudoUserId > 0;
55 | const usersFiltered = Object.entries(state.users)
56 | .filter(([, user]) => user.username === name)
57 | .map(([, user]) => user);
58 | let online = false;
59 | if (usersFiltered.length > 0) {
60 | online = usersFiltered[0].online;
61 | pseudoUserId = +usersFiltered[0].id;
62 | }
63 | return [isUser, online, pseudoUserId];
64 | } catch (_) {
65 | return [false, false, "0"];
66 | }
67 | }, [id, name, state.users]);
68 |
69 | const lastMessage = useLastMessage(room);
70 |
71 | return {
72 | isUser,
73 | online,
74 | userId,
75 | name: room.name,
76 | lastMessage,
77 | };
78 | };
79 |
80 | const useLastMessage = (
81 | /** @type {import("../../../../../../state").Room} */ room
82 | ) => {
83 | const [, dispatch] = useAppState();
84 | const { lastMessage } = room;
85 | useEffect(() => {
86 | if (lastMessage === undefined) {
87 | /** need to fetch it */
88 | if (room.messages === undefined) {
89 | getMessages(room.id, 0, 1).then((messages) => {
90 | let message = null;
91 | if (messages.length !== 0) {
92 | message = messages.pop();
93 | }
94 | dispatch({
95 | type: "set last message",
96 | payload: { id: room.id, lastMessage: message },
97 | });
98 | });
99 | } else if (room.messages.length === 0) {
100 | dispatch({
101 | type: "set last message",
102 | payload: { id: room.id, lastMessage: null },
103 | });
104 | } else {
105 | dispatch({
106 | type: "set last message",
107 | payload: {
108 | id: room.id,
109 | lastMessage: room.messages[room.messages.length - 1],
110 | },
111 | });
112 | }
113 | }
114 | }, [lastMessage, dispatch, room]);
115 |
116 | return lastMessage;
117 | };
118 |
119 | export default ChatListItem;
120 |
--------------------------------------------------------------------------------
/client/src/hooks.js:
--------------------------------------------------------------------------------
1 | // @ts-check
2 | import { useEffect, useRef, useState } from "react";
3 | import { getMe, login, logOut } from "./api";
4 | import io from "socket.io-client";
5 | import { parseRoomName } from "./utils";
6 |
7 | /**
8 | * @param {import('./state').UserEntry} newUser
9 | */
10 | const updateUser = (newUser, dispatch, infoMessage) => {
11 | dispatch({ type: "set user", payload: newUser });
12 | if (infoMessage !== undefined) {
13 | dispatch({
14 | type: "append message",
15 | payload: {
16 | id: "0",
17 | message: {
18 | /** Date isn't shown in the info message, so we only need a unique value */
19 | date: Math.random() * 10000,
20 | from: "info",
21 | message: infoMessage,
22 | },
23 | },
24 | });
25 | }
26 | };
27 |
28 | /** @returns {[SocketIOClient.Socket, boolean]} */
29 | const useSocket = (user, dispatch) => {
30 | const [connected, setConnected] = useState(false);
31 | /** @type {React.MutableRefObject
24 |
26 |
27 |
29 |
30 |
35 | {lastMessage && (
36 | {name}
31 | {lastMessage && ( 32 |{lastMessage.message}
33 | )} 34 |
37 | {moment.unix(lastMessage.date).format("LT")}
38 |
39 | )}
40 |
38 |
45 |
25 |
132 |
133 | );
134 | }
135 |
136 | const UsernameSelect = ({ username, setUsername, names = [""] }) => {
137 | const [open, setOpen] = useState(false);
138 | const [width, setWidth] = useState(0);
139 | const ref = useRef();
140 | /** @ts-ignore */
141 | const clientRectWidth = ref.current?.getBoundingClientRect().width;
142 | useEffect(() => {
143 | /** @ts-ignore */
144 | setWidth(clientRectWidth);
145 | }, [clientRectWidth]);
146 |
147 | /** Click away listener */
148 | useEffect(() => {
149 | if (open) {
150 | const listener = () => setOpen(false);
151 | document.addEventListener("click", listener);
152 | return () => document.removeEventListener("click", listener);
153 | }
154 | }, [open]);
155 |
156 | /** Make the current div focused */
157 | useEffect(() => {
158 | if (open) {
159 | /** @ts-ignore */
160 | ref.current?.focus();
161 | }
162 | }, [open]);
163 |
164 | return (
165 |
31 |
131 |
32 |
71 |
72 |
130 |
43 |
55 |
44 |
47 | Welcome Back !
45 |Sign in to continue
46 |
48 | 
53 |
54 |
53 |
59 |
70 |
67 |
69 | setOpen((o) => !o)}
170 | >
171 |
194 | );
195 | };
196 |
--------------------------------------------------------------------------------
/client/build/static/js/runtime-main.120840cb.js.map:
--------------------------------------------------------------------------------
1 | {"version":3,"sources":["../webpack/bootstrap"],"names":["webpackJsonpCallback","data","moduleId","chunkId","chunkIds","moreModules","executeModules","i","resolves","length","Object","prototype","hasOwnProperty","call","installedChunks","push","modules","parentJsonpFunction","shift","deferredModules","apply","checkDeferredModules","result","deferredModule","fulfilled","j","depId","splice","__webpack_require__","s","installedModules","1","exports","module","l","m","c","d","name","getter","o","defineProperty","enumerable","get","r","Symbol","toStringTag","value","t","mode","__esModule","ns","create","key","bind","n","object","property","p","jsonpArray","this","oldJsonpFunction","slice"],"mappings":"aACE,SAASA,EAAqBC,GAQ7B,IAPA,IAMIC,EAAUC,EANVC,EAAWH,EAAK,GAChBI,EAAcJ,EAAK,GACnBK,EAAiBL,EAAK,GAIHM,EAAI,EAAGC,EAAW,GACpCD,EAAIH,EAASK,OAAQF,IACzBJ,EAAUC,EAASG,GAChBG,OAAOC,UAAUC,eAAeC,KAAKC,EAAiBX,IAAYW,EAAgBX,IACpFK,EAASO,KAAKD,EAAgBX,GAAS,IAExCW,EAAgBX,GAAW,EAE5B,IAAID,KAAYG,EACZK,OAAOC,UAAUC,eAAeC,KAAKR,EAAaH,KACpDc,EAAQd,GAAYG,EAAYH,IAKlC,IAFGe,GAAqBA,EAAoBhB,GAEtCO,EAASC,QACdD,EAASU,OAATV,GAOD,OAHAW,EAAgBJ,KAAKK,MAAMD,EAAiBb,GAAkB,IAGvDe,IAER,SAASA,IAER,IADA,IAAIC,EACIf,EAAI,EAAGA,EAAIY,EAAgBV,OAAQF,IAAK,CAG/C,IAFA,IAAIgB,EAAiBJ,EAAgBZ,GACjCiB,GAAY,EACRC,EAAI,EAAGA,EAAIF,EAAed,OAAQgB,IAAK,CAC9C,IAAIC,EAAQH,EAAeE,GACG,IAA3BX,EAAgBY,KAAcF,GAAY,GAE3CA,IACFL,EAAgBQ,OAAOpB,IAAK,GAC5Be,EAASM,EAAoBA,EAAoBC,EAAIN,EAAe,KAItE,OAAOD,EAIR,IAAIQ,EAAmB,GAKnBhB,EAAkB,CACrBiB,EAAG,GAGAZ,EAAkB,GAGtB,SAASS,EAAoB1B,GAG5B,GAAG4B,EAAiB5B,GACnB,OAAO4B,EAAiB5B,GAAU8B,QAGnC,IAAIC,EAASH,EAAiB5B,GAAY,CACzCK,EAAGL,EACHgC,GAAG,EACHF,QAAS,IAUV,OANAhB,EAAQd,GAAUW,KAAKoB,EAAOD,QAASC,EAAQA,EAAOD,QAASJ,GAG/DK,EAAOC,GAAI,EAGJD,EAAOD,QAKfJ,EAAoBO,EAAInB,EAGxBY,EAAoBQ,EAAIN,EAGxBF,EAAoBS,EAAI,SAASL,EAASM,EAAMC,GAC3CX,EAAoBY,EAAER,EAASM,IAClC5B,OAAO+B,eAAeT,EAASM,EAAM,CAAEI,YAAY,EAAMC,IAAKJ,KAKhEX,EAAoBgB,EAAI,SAASZ,GACX,qBAAXa,QAA0BA,OAAOC,aAC1CpC,OAAO+B,eAAeT,EAASa,OAAOC,YAAa,CAAEC,MAAO,WAE7DrC,OAAO+B,eAAeT,EAAS,aAAc,CAAEe,OAAO,KAQvDnB,EAAoBoB,EAAI,SAASD,EAAOE,GAEvC,GADU,EAAPA,IAAUF,EAAQnB,EAAoBmB,IAC/B,EAAPE,EAAU,OAAOF,EACpB,GAAW,EAAPE,GAA8B,kBAAVF,GAAsBA,GAASA,EAAMG,WAAY,OAAOH,EAChF,IAAII,EAAKzC,OAAO0C,OAAO,MAGvB,GAFAxB,EAAoBgB,EAAEO,GACtBzC,OAAO+B,eAAeU,EAAI,UAAW,CAAET,YAAY,EAAMK,MAAOA,IACtD,EAAPE,GAA4B,iBAATF,EAAmB,IAAI,IAAIM,KAAON,EAAOnB,EAAoBS,EAAEc,EAAIE,EAAK,SAASA,GAAO,OAAON,EAAMM,IAAQC,KAAK,KAAMD,IAC9I,OAAOF,GAIRvB,EAAoB2B,EAAI,SAAStB,GAChC,IAAIM,EAASN,GAAUA,EAAOiB,WAC7B,WAAwB,OAAOjB,EAAgB,SAC/C,WAA8B,OAAOA,GAEtC,OADAL,EAAoBS,EAAEE,EAAQ,IAAKA,GAC5BA,GAIRX,EAAoBY,EAAI,SAASgB,EAAQC,GAAY,OAAO/C,OAAOC,UAAUC,eAAeC,KAAK2C,EAAQC,IAGzG7B,EAAoB8B,EAAI,IAExB,IAAIC,EAAaC,KAAyB,mBAAIA,KAAyB,oBAAK,GACxEC,EAAmBF,EAAW5C,KAAKuC,KAAKK,GAC5CA,EAAW5C,KAAOf,EAClB2D,EAAaA,EAAWG,QACxB,IAAI,IAAIvD,EAAI,EAAGA,EAAIoD,EAAWlD,OAAQF,IAAKP,EAAqB2D,EAAWpD,IAC3E,IAAIU,EAAsB4C,EAI1BxC,I","file":"static/js/runtime-main.120840cb.js","sourcesContent":[" \t// install a JSONP callback for chunk loading\n \tfunction webpackJsonpCallback(data) {\n \t\tvar chunkIds = data[0];\n \t\tvar moreModules = data[1];\n \t\tvar executeModules = data[2];\n\n \t\t// add \"moreModules\" to the modules object,\n \t\t// then flag all \"chunkIds\" as loaded and fire callback\n \t\tvar moduleId, chunkId, i = 0, resolves = [];\n \t\tfor(;i < chunkIds.length; i++) {\n \t\t\tchunkId = chunkIds[i];\n \t\t\tif(Object.prototype.hasOwnProperty.call(installedChunks, chunkId) && installedChunks[chunkId]) {\n \t\t\t\tresolves.push(installedChunks[chunkId][0]);\n \t\t\t}\n \t\t\tinstalledChunks[chunkId] = 0;\n \t\t}\n \t\tfor(moduleId in moreModules) {\n \t\t\tif(Object.prototype.hasOwnProperty.call(moreModules, moduleId)) {\n \t\t\t\tmodules[moduleId] = moreModules[moduleId];\n \t\t\t}\n \t\t}\n \t\tif(parentJsonpFunction) parentJsonpFunction(data);\n\n \t\twhile(resolves.length) {\n \t\t\tresolves.shift()();\n \t\t}\n\n \t\t// add entry modules from loaded chunk to deferred list\n \t\tdeferredModules.push.apply(deferredModules, executeModules || []);\n\n \t\t// run deferred modules when all chunks ready\n \t\treturn checkDeferredModules();\n \t};\n \tfunction checkDeferredModules() {\n \t\tvar result;\n \t\tfor(var i = 0; i < deferredModules.length; i++) {\n \t\t\tvar deferredModule = deferredModules[i];\n \t\t\tvar fulfilled = true;\n \t\t\tfor(var j = 1; j < deferredModule.length; j++) {\n \t\t\t\tvar depId = deferredModule[j];\n \t\t\t\tif(installedChunks[depId] !== 0) fulfilled = false;\n \t\t\t}\n \t\t\tif(fulfilled) {\n \t\t\t\tdeferredModules.splice(i--, 1);\n \t\t\t\tresult = __webpack_require__(__webpack_require__.s = deferredModule[0]);\n \t\t\t}\n \t\t}\n\n \t\treturn result;\n \t}\n\n \t// The module cache\n \tvar installedModules = {};\n\n \t// object to store loaded and loading chunks\n \t// undefined = chunk not loaded, null = chunk preloaded/prefetched\n \t// Promise = chunk loading, 0 = chunk loaded\n \tvar installedChunks = {\n \t\t1: 0\n \t};\n\n \tvar deferredModules = [];\n\n \t// The require function\n \tfunction __webpack_require__(moduleId) {\n\n \t\t// Check if module is in cache\n \t\tif(installedModules[moduleId]) {\n \t\t\treturn installedModules[moduleId].exports;\n \t\t}\n \t\t// Create a new module (and put it into the cache)\n \t\tvar module = installedModules[moduleId] = {\n \t\t\ti: moduleId,\n \t\t\tl: false,\n \t\t\texports: {}\n \t\t};\n\n \t\t// Execute the module function\n \t\tmodules[moduleId].call(module.exports, module, module.exports, __webpack_require__);\n\n \t\t// Flag the module as loaded\n \t\tmodule.l = true;\n\n \t\t// Return the exports of the module\n \t\treturn module.exports;\n \t}\n\n\n \t// expose the modules object (__webpack_modules__)\n \t__webpack_require__.m = modules;\n\n \t// expose the module cache\n \t__webpack_require__.c = installedModules;\n\n \t// define getter function for harmony exports\n \t__webpack_require__.d = function(exports, name, getter) {\n \t\tif(!__webpack_require__.o(exports, name)) {\n \t\t\tObject.defineProperty(exports, name, { enumerable: true, get: getter });\n \t\t}\n \t};\n\n \t// define __esModule on exports\n \t__webpack_require__.r = function(exports) {\n \t\tif(typeof Symbol !== 'undefined' && Symbol.toStringTag) {\n \t\t\tObject.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });\n \t\t}\n \t\tObject.defineProperty(exports, '__esModule', { value: true });\n \t};\n\n \t// create a fake namespace object\n \t// mode & 1: value is a module id, require it\n \t// mode & 2: merge all properties of value into the ns\n \t// mode & 4: return value when already ns object\n \t// mode & 8|1: behave like require\n \t__webpack_require__.t = function(value, mode) {\n \t\tif(mode & 1) value = __webpack_require__(value);\n \t\tif(mode & 8) return value;\n \t\tif((mode & 4) && typeof value === 'object' && value && value.__esModule) return value;\n \t\tvar ns = Object.create(null);\n \t\t__webpack_require__.r(ns);\n \t\tObject.defineProperty(ns, 'default', { enumerable: true, value: value });\n \t\tif(mode & 2 && typeof value != 'string') for(var key in value) __webpack_require__.d(ns, key, function(key) { return value[key]; }.bind(null, key));\n \t\treturn ns;\n \t};\n\n \t// getDefaultExport function for compatibility with non-harmony modules\n \t__webpack_require__.n = function(module) {\n \t\tvar getter = module && module.__esModule ?\n \t\t\tfunction getDefault() { return module['default']; } :\n \t\t\tfunction getModuleExports() { return module; };\n \t\t__webpack_require__.d(getter, 'a', getter);\n \t\treturn getter;\n \t};\n\n \t// Object.prototype.hasOwnProperty.call\n \t__webpack_require__.o = function(object, property) { return Object.prototype.hasOwnProperty.call(object, property); };\n\n \t// __webpack_public_path__\n \t__webpack_require__.p = \"/\";\n\n \tvar jsonpArray = this[\"webpackJsonpclient\"] = this[\"webpackJsonpclient\"] || [];\n \tvar oldJsonpFunction = jsonpArray.push.bind(jsonpArray);\n \tjsonpArray.push = webpackJsonpCallback;\n \tjsonpArray = jsonpArray.slice();\n \tfor(var i = 0; i < jsonpArray.length; i++) webpackJsonpCallback(jsonpArray[i]);\n \tvar parentJsonpFunction = oldJsonpFunction;\n\n\n \t// run deferred modules from other chunks\n \tcheckDeferredModules();\n"],"sourceRoot":""}
--------------------------------------------------------------------------------
/client/build/static/css/main.85225e57.chunk.css:
--------------------------------------------------------------------------------
1 | :root{--primary:#556ee6!important;--light:#f5f5f8!important;--success:#34c38f!important}.bg-success{background-color:#34c38f!important;background-color:var(--success)!important}.bg-light{background-color:#f5f5f8!important;background-color:var(--light)!important}.bg-gray{background-color:var(--gray)!important}.bg-primary{background-color:#556ee6!important;background-color:var(--primary)!important}.text-primary{color:#556ee6!important;color:var(--primary)!important}.list-group-item.active{background-color:#556ee6!important;background-color:var(--primary)!important;border-color:#556ee6!important;border-color:var(--primary)!important}.btn-rounded{border-radius:30px!important}.btn{display:inline-block;font-weight:400;color:#495057;text-align:center;vertical-align:middle;-webkit-user-select:none;-ms-user-select:none;user-select:none;background-color:transparent;border:1px solid transparent;border-radius:30px!important;padding:.47rem .75rem;font-size:.8125rem;line-height:1.5;border-radius:.25rem;transition:color .15s ease-in-out,background-color .15s ease-in-out,border-color .15s ease-in-out,box-shadow .15s ease-in-out}.btn-primary{color:#fff;background-color:#556ee6;background-color:var(--primary);border-color:#556ee6;border-color:var(--primary)}.btn-primary.focus,.btn-primary:focus,.btn-primary:hover{color:#fff;background-color:#3452e1;border-color:#2948df}.font-size-14{font-size:14px!important}.font-size-11{font-size:11px!important}.font-size-12{font-size:12px!important}.font-size-15{font-size:15px!important}.w-md{min-width:110px}body{font-family:"Poppins",Arial,Helvetica,sans-serif;font-size:13px;color:#495057}.navbar{box-shadow:0 12px 24px 0 rgba(18,38,63,.03)}.navbar-brand{font-size:16px}.chats-title{padding-left:14px}.login-page{display:flex;align-items:center;flex-direction:column;justify-content:center;padding-bottom:190px;height:100vh}.form-signin{width:100%;max-width:330px;padding:15px;margin:0 auto}.text-small{font-size:.9rem}.chat-box,.messages-box{width:100%}.chat-box-wrapper{flex:1 1;overflow-y:scroll}.rounded-lg{border-radius:.5rem}input::-webkit-input-placeholder{font-size:.9rem;color:#999}input:-ms-input-placeholder{font-size:.9rem;color:#999}input::-ms-input-placeholder{font-size:.9rem;color:#999}input::placeholder{font-size:.9rem;color:#999}.centered-box{width:100%;height:100vh;display:flex;align-items:center;justify-content:center}.login-error-anchor{position:relative}.toast-box{text-align:left;margin-top:30px;position:absolute;width:100%;top:0;display:flex;flex-direction:row;justify-content:center}.full-height{height:100vh;flex-direction:column;display:flex}.full-height .container{flex:1 1}.container .row{height:100%}.flex-column{display:flex;flex-direction:column}.bg-white.flex-column{height:100%}.flex{flex:1 1}.logout-button{cursor:pointer;display:flex;flex-direction:row;align-items:center;padding:15px 20px}.logout-button svg{margin-right:15px}.no-messages{opacity:.5;height:100%;width:100%}.avatar-box{width:50px;height:50px;object-fit:cover;object-position:50%;overflow:hidden;border-radius:4px}.avatar-box,.user-link{cursor:pointer}.user-link:hover{text-decoration:underline}.online-indicator{width:14px;height:14px;border:2px solid #fff;bottom:-7px;right:-7px;background-color:#4df573}.online-indicator.selected{border:none;width:12px;height:12px;bottom:-5px;right:-5px}.online-indicator.offline{background-color:#bbb}span.pseudo-link{font-size:14px;text-decoration:underline;color:var(--blue);cursor:pointer}span.pseudo-link:hover{text-decoration:none}.list-group-item{cursor:pointer;height:70px;box-sizing:border-box;transition:background-color .1s ease-out}.chat-icon{width:45px;height:45px;border-radius:4px;background-color:#eee}.chat-icon.active{background-color:var(--blue)}.chats-title{font-size:15px}.chat-body{border-radius:10px!important}.chat-list-container{height:100%}.chat-input{border-radius:30px!important;background-color:#eff2f7!important;border-color:#eff2f7!important;padding-right:120px}.form-control::-webkit-input-placeholder{font-size:13px}.form-control:-ms-input-placeholder{font-size:13px}.form-control::-ms-input-placeholder{font-size:13px}.form-control::placeholder{font-size:13px}.form-control{display:block;width:100%;height:calc(1.5em + .94rem + 2px);padding:7.5px 12px;font-size:13px;font-weight:400;line-height:1.5;color:#495057;background-color:#fff;background-clip:padding-box;border:1px solid #ced4da;transition:border-color .15s ease-in-out,box-shadow .15s ease-in-out}.rounded-button{border-radius:30px;background-color:var(--light)}@font-face{font-family:"Poppins";font-style:normal;font-weight:300;font-display:swap;src:url(https://fonts.gstatic.com/s/poppins/v15/pxiByp8kv8JHgFVrLDz8Z11lFd2JQEl8qw.woff2) format("woff2");unicode-range:U+0900-097f,U+1cd0-1cf6,U+1cf8-1cf9,U+200c-200d,U+20a8,U+20b9,U+25cc,U+a830-a839,U+a8e0-a8fb}@font-face{font-family:"Poppins";font-style:normal;font-weight:300;font-display:swap;src:url(https://fonts.gstatic.com/s/poppins/v15/pxiByp8kv8JHgFVrLDz8Z1JlFd2JQEl8qw.woff2) format("woff2");unicode-range:U+0100-024f,U+0259,U+1e??,U+2020,U+20a0-20ab,U+20ad-20cf,U+2113,U+2c60-2c7f,U+a720-a7ff}@font-face{font-family:"Poppins";font-style:normal;font-weight:300;font-display:swap;src:url(https://fonts.gstatic.com/s/poppins/v15/pxiByp8kv8JHgFVrLDz8Z1xlFd2JQEk.woff2) format("woff2");unicode-range:U+00??,U+0131,U+0152-0153,U+02bb-02bc,U+02c6,U+02da,U+02dc,U+2000-206f,U+2074,U+20ac,U+2122,U+2191,U+2193,U+2212,U+2215,U+feff,U+fffd}@font-face{font-family:"Poppins";font-style:normal;font-weight:400;font-display:swap;src:url(https://fonts.gstatic.com/s/poppins/v15/pxiEyp8kv8JHgFVrJJbecnFHGPezSQ.woff2) format("woff2");unicode-range:U+0900-097f,U+1cd0-1cf6,U+1cf8-1cf9,U+200c-200d,U+20a8,U+20b9,U+25cc,U+a830-a839,U+a8e0-a8fb}@font-face{font-family:"Poppins";font-style:normal;font-weight:400;font-display:swap;src:url(https://fonts.gstatic.com/s/poppins/v15/pxiEyp8kv8JHgFVrJJnecnFHGPezSQ.woff2) format("woff2");unicode-range:U+0100-024f,U+0259,U+1e??,U+2020,U+20a0-20ab,U+20ad-20cf,U+2113,U+2c60-2c7f,U+a720-a7ff}@font-face{font-family:"Poppins";font-style:normal;font-weight:400;font-display:swap;src:url(https://fonts.gstatic.com/s/poppins/v15/pxiEyp8kv8JHgFVrJJfecnFHGPc.woff2) format("woff2");unicode-range:U+00??,U+0131,U+0152-0153,U+02bb-02bc,U+02c6,U+02da,U+02dc,U+2000-206f,U+2074,U+20ac,U+2122,U+2191,U+2193,U+2212,U+2215,U+feff,U+fffd}@font-face{font-family:"Poppins";font-style:normal;font-weight:500;font-display:swap;src:url(https://fonts.gstatic.com/s/poppins/v15/pxiByp8kv8JHgFVrLGT9Z11lFd2JQEl8qw.woff2) format("woff2");unicode-range:U+0900-097f,U+1cd0-1cf6,U+1cf8-1cf9,U+200c-200d,U+20a8,U+20b9,U+25cc,U+a830-a839,U+a8e0-a8fb}@font-face{font-family:"Poppins";font-style:normal;font-weight:500;font-display:swap;src:url(https://fonts.gstatic.com/s/poppins/v15/pxiByp8kv8JHgFVrLGT9Z1JlFd2JQEl8qw.woff2) format("woff2");unicode-range:U+0100-024f,U+0259,U+1e??,U+2020,U+20a0-20ab,U+20ad-20cf,U+2113,U+2c60-2c7f,U+a720-a7ff}@font-face{font-family:"Poppins";font-style:normal;font-weight:500;font-display:swap;src:url(https://fonts.gstatic.com/s/poppins/v15/pxiByp8kv8JHgFVrLGT9Z1xlFd2JQEk.woff2) format("woff2");unicode-range:U+00??,U+0131,U+0152-0153,U+02bb-02bc,U+02c6,U+02da,U+02dc,U+2000-206f,U+2074,U+20ac,U+2122,U+2191,U+2193,U+2212,U+2215,U+feff,U+fffd}@font-face{font-family:"Poppins";font-style:normal;font-weight:600;font-display:swap;src:url(https://fonts.gstatic.com/s/poppins/v15/pxiByp8kv8JHgFVrLEj6Z11lFd2JQEl8qw.woff2) format("woff2");unicode-range:U+0900-097f,U+1cd0-1cf6,U+1cf8-1cf9,U+200c-200d,U+20a8,U+20b9,U+25cc,U+a830-a839,U+a8e0-a8fb}@font-face{font-family:"Poppins";font-style:normal;font-weight:600;font-display:swap;src:url(https://fonts.gstatic.com/s/poppins/v15/pxiByp8kv8JHgFVrLEj6Z1JlFd2JQEl8qw.woff2) format("woff2");unicode-range:U+0100-024f,U+0259,U+1e??,U+2020,U+20a0-20ab,U+20ad-20cf,U+2113,U+2c60-2c7f,U+a720-a7ff}@font-face{font-family:"Poppins";font-style:normal;font-weight:600;font-display:swap;src:url(https://fonts.gstatic.com/s/poppins/v15/pxiByp8kv8JHgFVrLEj6Z1xlFd2JQEk.woff2) format("woff2");unicode-range:U+00??,U+0131,U+0152-0153,U+02bb-02bc,U+02c6,U+02da,U+02dc,U+2000-206f,U+2074,U+20ac,U+2122,U+2191,U+2193,U+2212,U+2215,U+feff,U+fffd}@font-face{font-family:"Poppins";font-style:normal;font-weight:700;font-display:swap;src:url(https://fonts.gstatic.com/s/poppins/v15/pxiByp8kv8JHgFVrLCz7Z11lFd2JQEl8qw.woff2) format("woff2");unicode-range:U+0900-097f,U+1cd0-1cf6,U+1cf8-1cf9,U+200c-200d,U+20a8,U+20b9,U+25cc,U+a830-a839,U+a8e0-a8fb}@font-face{font-family:"Poppins";font-style:normal;font-weight:700;font-display:swap;src:url(https://fonts.gstatic.com/s/poppins/v15/pxiByp8kv8JHgFVrLCz7Z1JlFd2JQEl8qw.woff2) format("woff2");unicode-range:U+0100-024f,U+0259,U+1e??,U+2020,U+20a0-20ab,U+20ad-20cf,U+2113,U+2c60-2c7f,U+a720-a7ff}@font-face{font-family:"Poppins";font-style:normal;font-weight:700;font-display:swap;src:url(https://fonts.gstatic.com/s/poppins/v15/pxiByp8kv8JHgFVrLCz7Z1xlFd2JQEk.woff2) format("woff2");unicode-range:U+00??,U+0131,U+0152-0153,U+02bb-02bc,U+02c6,U+02da,U+02dc,U+2000-206f,U+2074,U+20ac,U+2122,U+2191,U+2193,U+2212,U+2215,U+feff,U+fffd}.login-form .username-select button{background-color:transparent!important;color:inherit;padding:7.5px 12px!important;display:block!important;border:1px solid #ced4da!important;border-radius:4px!important;width:100%!important;text-align:left!important}.login-form .username-select .btn-primary:not(:disabled):not(.disabled).active,.login-form .username-select .btn-primary:not(:disabled):not(.disabled):active,.show>.btn-primary.dropdown-toggle{color:inherit}.login-form .username-select .dropdown-menu.show.dropdown-menu-right{transform:translateY(38px)!important}.username-select-dropdown{position:relative;display:flex!important;align-items:center;background-color:transparent!important;color:inherit;padding:0 12px!important;border:1px solid #ced4da!important;border-radius:4px!important;width:100%!important;text-align:left!important;height:calc(1.5em + .94rem + 2px)!important;cursor:pointer}.username-select-dropdown .username-select-block{background-color:var(--white);position:absolute;top:-1138px;left:0;opacity:0;transform:scale(.5);transform-origin:top left;transition:opacity .2s ease,transform .2s ease;border:1px solid #ced4da!important;border-radius:4px!important;padding:8px 0}.username-select-dropdown:focus{outline:none;border-color:#80bdff!important;box-shadow:0 0 0 .2rem rgba(0,123,255,.25)}.username-select-dropdown .username-select-block.open{top:42px;transform:scale(1);opacity:1}.username-select-row{display:flex;width:100%;justify-content:space-between;align-items:center}.username-select-dropdown .username-select-block .username-select-block-item{padding:4px 24px}.username-select-dropdown .username-select-block .username-select-block-item:hover{background-color:var(--light)}.chat-list-item{cursor:pointer;padding:14px 16px}.mdi-circle:before{content:""}.mdi-set,.mdi:before{display:inline-block;font:normal normal normal 24px/1 Material Design Icons;font-size:inherit;text-rendering:auto;line-height:inherit;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}
2 | /*# sourceMappingURL=main.85225e57.chunk.css.map */
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Basic Redis Chat App Demo (Node.js)
2 |
3 | Showcases how to impliment chat app in Node.js, Socket.IO and Redis. This example uses **pub/sub** feature combined with web-sockets for implementing the message communication between client and server.
4 |
5 |
172 |
179 | {username}
173 |
174 |
177 |
178 |
183 | {names.map((name) => (
184 |
193 | setUsername(name)}
188 | >
189 | {name}
190 |
191 | ))}
192 | 
6 | 
7 |
8 | # Overview video
9 |
10 | Here's a short video that explains the project and how it uses Redis:
11 |
12 | [](https://www.youtube.com/watch?v=miK7xDkDXF0)
13 |
14 | ## Technical Stacks
15 |
16 | - Frontend - _React_, _Socket_ (Socket.IO)
17 | - Backend - _Node.js_, _Redis_
18 |
19 | ## How it works?
20 |
21 | ### Initialization
22 |
23 | For simplicity, a key with **total_users** value is checked: if it does not exist, we fill the Redis database with initial data.
24 | `EXISTS total_users` (checks if the key exists)
25 |
26 | The demo data initialization is handled in multiple steps:
27 |
28 | **Creating of demo users:**
29 | We create a new user id: `INCR total_users`. Then we set a user ID lookup key by user name: **_e.g._** `SET username:nick user:1`. And finally, the rest of the data is written to the hash set: **_e.g._** `HSET user:1 username "nick" password "bcrypt_hashed_password"`.
30 |
31 | Additionally, each user is added to the default "General" room. For handling rooms for each user, we have a set that holds the room ids. Here's an example command of how to add the room: **_e.g._** `SADD user:1:rooms "0"`.
32 |
33 | **Populate private messages between users.**
34 | At first, private rooms are created: if a private room needs to be established, for each user a room id: `room:1:2` is generated, where numbers correspond to the user ids in ascending order.
35 |
36 | **_E.g._** Create a private room between 2 users: `SADD user:1:rooms 1:2` and `SADD user:2:rooms 1:2`.
37 |
38 | Then we add messages to this room by writing to a sorted set:
39 |
40 | **_E.g._** `ZADD room:1:2 1615480369 "{'from': 1, 'date': 1615480369, 'message': 'Hello', 'roomId': '1:2'}"`.
41 |
42 | We use a stringified _JSON_ for keeping the message structure and simplify the implementation details for this demo-app.
43 |
44 | **Populate the "General" room with messages.** Messages are added to the sorted set with id of the "General" room: `room:0`
45 |
46 | ### Registration
47 |
48 | 
49 |
50 | Redis is used mainly as a database to keep the user/messages data and for sending messages between connected servers.
51 |
52 | #### How the data is stored:
53 |
54 | - The chat data is stored in various keys and various data types.
55 | - User data is stored in a hash set where each user entry contains the next values:
56 | - `username`: unique user name;
57 | - `password`: hashed password
58 |
59 | * User hash set is accessed by key `user:{userId}`. The data for it stored with `HSET key field data`. User id is calculated by incrementing the `total_users`.
60 |
61 | - E.g `INCR total_users`
62 |
63 | * Username is stored as a separate key (`username:{username}`) which returns the userId for quicker access.
64 | - E.g `SET username:Alex 4`
65 |
66 | #### How the data is accessed:
67 |
68 | - **Get User** `HGETALL user:{id}`
69 |
70 | - E.g `HGETALL user:2`, where we get data for the user with id: 2.
71 |
72 | - **Online users:** will return ids of users which are online
73 | - E.g `SMEMBERS online_users`
74 |
75 | #### Code Example: Prepare User Data in Redis HashSet
76 |
77 | ```JavaScript
78 | const usernameKey = makeUsernameKey(username);
79 | /** Create user */
80 | const hashedPassword = await bcrypt.hash(password, 10);
81 | const nextId = await incr("total_users");
82 | const userKey = `user:${nextId}`;
83 | await set(usernameKey, userKey);
84 | await hmset(userKey, ["username", username, "password", hashedPassword]);
85 |
86 | /**
87 | * Each user has a set of rooms he is in
88 | * let's define the default ones
89 | */
90 | await sadd(`user:${nextId}:rooms`, `${0}`); // Main room
91 | ```
92 |
93 | ### Rooms
94 |
95 | 
96 |
97 | #### How the data is stored:
98 |
99 | Each user has a set of rooms associated with them.
100 |
101 | **Rooms** are sorted sets which contains messages where score is the timestamp for each message. Each room has a name associated with it.
102 |
103 | - Rooms which user belongs too are stored at `user:{userId}:rooms` as a set of room ids.
104 |
105 | - E.g `SADD user:Alex:rooms 1`
106 |
107 | - Set room name: `SET room:{roomId}:name {name}`
108 | - E.g `SET room:1:name General`
109 |
110 | #### How the data is accessed:
111 |
112 | - **Get room name** `GET room:{roomId}:name`.
113 |
114 | - E. g `GET room:0:name`. This should return "General"
115 |
116 | - **Get room ids of a user:** `SMEMBERS user:{id}:rooms`.
117 | - E. g `SMEMBERS user:2:rooms`. This will return IDs of rooms for user with ID: 2
118 |
119 | #### Code Example: Get all My Rooms
120 |
121 | ```JavaScript
122 | const rooms = [];
123 | for (let x = 0; x < roomIds.length; x++) {
124 | const roomId = roomIds[x];
125 |
126 | let name = await get(`room:${roomId}:name`);
127 | /** It's a room without a name, likey the one with private messages */
128 | if (!name) {
129 | /**
130 | * Make sure we don't add private rooms with empty messages
131 | * It's okay to add custom (named rooms)
132 | */
133 | const roomExists = await exists(`room:${roomId}`);
134 | if (!roomExists) {
135 | continue;
136 | }
137 |
138 | const userIds = roomId.split(":");
139 | if (userIds.length !== 2) {
140 | return res.sendStatus(400);
141 | }
142 | rooms.push({
143 | id: roomId,
144 | names: [
145 | await hmget(`user:${userIds[0]}`, "username"),
146 | await hmget(`user:${userIds[1]}`, "username"),
147 | ],
148 | });
149 | } else {
150 | rooms.push({
151 | id: roomId,
152 | names: [name]
153 | });
154 | }
155 | }
156 | return rooms;
157 | ```
158 |
159 | ### Messages
160 |
161 | #### Pub/sub
162 |
163 | After initialization, a pub/sub subscription is created: `SUBSCRIBE MESSAGES`. At the same time, each server instance will run a listener on a message on this channel to receive real-time updates.
164 |
165 | Again, for simplicity, each message is serialized to **_JSON_**, which we parse and then handle in the same manner, as WebSocket messages.
166 |
167 | Pub/sub allows connecting multiple servers written in different platforms without taking into consideration the implementation detail of each server.
168 |
169 | #### How the data is stored:
170 |
171 | - Messages are stored at `room:{roomId}` key in a sorted set (as mentioned above). They are added with `ZADD room:{roomId} {timestamp} {message}` command. Message is serialized to an app-specific JSON string.
172 | - E.g `ZADD room:0 1617197047 { "From": "2", "Date": 1617197047, "Message": "Hello", "RoomId": "1:2" }`
173 |
174 | #### How the data is accessed:
175 |
176 | - **Get list of messages** `ZREVRANGE room:{roomId} {offset_start} {offset_end}`.
177 | - E.g `ZREVRANGE room:1:2 0 50` will return 50 messages with 0 offsets for the private room between users with IDs 1 and 2.
178 |
179 | #### Code Example: Send Message
180 |
181 | ```Javascript
182 | async (message) => {
183 | /** Make sure nothing illegal is sent here. */
184 | message = {
185 | ...message,
186 | message: sanitise(message.message)
187 | };
188 | /**
189 | * The user might be set as offline if he tried to access the chat from another tab, pinging by message
190 | * resets the user online status
191 | */
192 | await sadd("online_users", message.from);
193 | /** We've got a new message. Store it in db, then send back to the room. */
194 | const messageString = JSON.stringify(message);
195 | const roomKey = `room:${message.roomId}`;
196 | /**
197 | * It may be possible that the room is private and new, so it won't be shown on the other
198 | * user's screen, check if the roomKey exist. If not then broadcast message that the room is appeared
199 | */
200 | const isPrivate = !(await exists(`${roomKey}:name`));
201 | const roomHasMessages = await exists(roomKey);
202 | if (isPrivate && !roomHasMessages) {
203 | const ids = message.roomId.split(":");
204 | const msg = {
205 | id: message.roomId,
206 | names: [
207 | await hmget(`user:${ids[0]}`, "username"),
208 | await hmget(`user:${ids[1]}`, "username"),
209 | ],
210 | };
211 | publish("show.room", msg);
212 | socket.broadcast.emit(`show.room`, msg);
213 | }
214 | await zadd(roomKey, "" + message.date, messageString);
215 | publish("message", message);
216 | io.to(roomKey).emit("message", message);
217 | }
218 | ```
219 |
220 | ### Session handling
221 |
222 | The chat server works as a basic _REST_ API which involves keeping the session and handling the user state in the chat rooms (besides the WebSocket/real-time part).
223 |
224 | When a WebSocket/real-time server is instantiated, which listens for the next events:
225 |
226 | **Connection**. A new user is connected. At this point, a user ID is captured and saved to the session (which is cached in Redis). Note, that session caching is language/library-specific and it's used here purely for persistence and maintaining the state between server reloads.
227 |
228 | A global set with `online_users` key is used for keeping the online state for each user. So on a new connection, a user ID is written to that set:
229 |
230 | **E.g.** `SADD online_users 1` (We add user with id 1 to the set **online_users**).
231 |
232 | After that, a message is broadcasted to the clients to notify them that a new user is joined the chat.
233 |
234 | **Disconnect**. It works similarly to the connection event, except we need to remove the user for **online_users** set and notify the clients: `SREM online_users 1` (makes user with id 1 offline).
235 |
236 | **Message**. A user sends a message, and it needs to be broadcasted to the other clients. The pub/sub allows us also to broadcast this message to all server instances which are connected to this Redis:
237 |
238 | `PUBLISH message "{'serverId': 4132, 'type':'message', 'data': {'from': 1, 'date': 1615480369, 'message': 'Hello', 'roomId': '1:2'}}"`
239 |
240 | Note we send additional data related to the type of the message and the server id. Server id is used to discard the messages by the server instance which sends them since it is connected to the same `MESSAGES` channel.
241 |
242 | `type` field of the serialized JSON corresponds to the real-time method we use for real-time communication (connect/disconnect/message).
243 |
244 | `data` is method-specific information. In the example above it's related to the new message.
245 |
246 | #### How the data is stored / accessed:
247 |
248 | The session data is stored in Redis by utilizing the [**connect-redis**](https://www.npmjs.com/package/connect-redis) client.
249 |
250 | ```JavaScript
251 | const session = require("express-session");
252 | let RedisStore = require("connect-redis")(session);
253 | const sessionMiddleware = session({
254 | store: new RedisStore({ client: redisClient }),
255 | secret: "keyboard cat",
256 | saveUninitialized: true,
257 | resave: true,
258 | });
259 | ```
260 |
261 | ## How to run it locally?
262 |
263 | #### Write in environment variable or Dockerfile actual connection to Redis:
264 |
265 | ```
266 | REDIS_ENDPOINT_URL = "Redis server URI"
267 | REDIS_PASSWORD = "Password to the server"
268 | ```
269 |
270 | #### Run frontend
271 |
272 | ```sh
273 | cd client
274 | yarn install
275 | yarn start
276 | ```
277 |
278 | #### Run backend
279 |
280 | ```sh
281 | yarn install
282 | yarn start
283 | ```
284 |
285 | ## Try it out
286 |
287 | #### Deploy to Heroku
288 |
289 |
290 |
291 | 
292 |
293 |
298 |
299 | 
300 |
301 |