Ability for users to signal that they are done (#321)

antoinejaussoin · Oct 17, 2021 · 99e581d · 99e581d
1 parent fbb3ab7
commit 99e581d
Show file tree

Hide file tree

Showing 31 changed files with 231 additions and 41 deletions.
diff --git a/README.md b/README.md
@@ -87,6 +87,7 @@ This will run a demo version, which you can turn into a fully licenced version b
 
 ### Version 4.9.1 (unreleased)
 
+- Add the ability for users to signal if they are done with their posts, to help the moderator
 - ⏫ Upgrading dependencies
 
 ### Version 4.9.0

diff --git a/backend/src/db/actions/sessions.ts b/backend/src/db/actions/sessions.ts
@@ -437,3 +437,21 @@ export function isAllowed(
 
   return { allowed: true };
 }
+
+export async function toggleReady(
+  sessionId: string,
+  userId: string
+): Promise<boolean> {
+  return await transaction(async (manager) => {
+    const sessionRepository = manager.getCustomRepository(SessionRepository);
+    const session = await sessionRepository.findOne(sessionId);
+    if (!session) {
+      return false;
+    }
+    session.ready = session.ready.includes(userId)
+      ? session.ready.filter((id) => id !== userId)
+      : [...session.ready, userId];
+    await sessionRepository.save(session);
+    return session.ready.includes(userId);
+  });
+}
diff --git a/backend/src/db/entities/Session.ts b/backend/src/db/entities/Session.ts
@@ -57,6 +57,8 @@ export default class SessionEntity {
   visitors: UserEntity[] | undefined;
   @Column({ default: false })
   public locked: boolean;
+  @Column('text', { array: true, default: '{}' })
+  public ready: string[];
   @CreateDateColumn({ type: 'timestamp with time zone' })
   public created: Date | undefined;
   @UpdateDateColumn({ type: 'timestamp with time zone' })
@@ -75,6 +77,7 @@ export default class SessionEntity {
       posts: this.posts === undefined ? [] : this.posts.map((p) => p.toJson()),
       encrypted: this.encrypted,
       locked: this.locked,
+      ready: this.ready,
     };
   }
 
@@ -90,5 +93,6 @@ export default class SessionEntity {
     this.options = new SessionOptionsEntity(options);
     this.encrypted = null;
     this.locked = false;
+    this.ready = [];
   }
 }
diff --git a/backend/src/db/migrations/1634486639965-ReadyUsers.ts b/backend/src/db/migrations/1634486639965-ReadyUsers.ts
@@ -0,0 +1,14 @@
+import {MigrationInterface, QueryRunner} from "typeorm";
+
+export class ReadyUsers1634486639965 implements MigrationInterface {
+    name = 'ReadyUsers1634486639965'
+
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`ALTER TABLE "sessions" ADD "ready" text array NOT NULL DEFAULT '{}'`);
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`ALTER TABLE "sessions" DROP COLUMN "ready"`);
+    }
+
+}
diff --git a/backend/src/game.ts b/backend/src/game.ts
@@ -19,6 +19,7 @@ import {
   WsErrorPayload,
   WebsocketMessage,
   WsGroupUpdatePayload,
+  WsUserReadyPayload,
 } from '@retrospected/common';
 import { RateLimiterMemory } from 'rate-limiter-flexible';
 import chalk from 'chalk';
@@ -44,6 +45,7 @@ import {
   saveTemplate,
   doesSessionExists,
   wasSessionCreatedBy,
+  toggleReady,
 } from './db/actions/sessions';
 import { getUser, getUserView } from './db/actions/users';
 import {
@@ -69,6 +71,8 @@ const {
   RECEIVE_EDIT_POST,
   RECEIVE_DELETE_POST_GROUP,
   RECEIVE_EDIT_POST_GROUP,
+  RECEIVE_USER_READY,
+  USER_READY,
   ADD_POST_SUCCESS,
   ADD_POST_GROUP_SUCCESS,
   DELETE_POST,
@@ -201,6 +205,12 @@ export default (io: Server) => {
     }
   }
 
+  /**
+   * Check that UserIds is not null
+   * @param userIds User IDs
+   * @param socket Socket
+   * @returns Whether User is not null
+   */
   function checkUser(
     userIds: UserIds | null,
     socket: Socket
@@ -356,6 +366,21 @@ export default (io: Server) => {
     }
   };
 
+  const onUserReady = async (
+    userIds: UserIds | null,
+    sessionId: string,
+    _data: void,
+    socket: Socket
+  ) => {
+    if (checkUser(userIds, socket)) {
+      const ready = await toggleReady(sessionId, userIds.userId);
+      sendToAll<WsUserReadyPayload>(socket, sessionId, RECEIVE_USER_READY, {
+        userId: userIds.userId,
+        ready,
+      });
+    }
+  };
+
   const onDeletePost = async (
     userIds: UserIds | null,
     sessionId: string,
@@ -563,6 +588,7 @@ export default (io: Server) => {
       { type: REQUEST_BOARD, handler: onRequestBoard },
       { type: RENAME_SESSION, handler: onRenameSession },
       { type: LEAVE_SESSION, handler: onLeaveSession },
+      { type: USER_READY, handler: onUserReady },
       { type: EDIT_OPTIONS, handler: onEditOptions, onlyAuthor: true },
       { type: EDIT_COLUMNS, handler: onEditColumns, onlyAuthor: true },
       { type: SAVE_TEMPLATE, handler: onSaveTemplate, onlyAuthor: true },

diff --git a/common/src/actions.ts b/common/src/actions.ts
@@ -16,6 +16,7 @@ export default {
   SAVE_TEMPLATE: 'retrospected/session/template/save',
   LOCK_SESSION: 'retrospected/session/lock',
   REQUEST_BOARD: 'retrospected/session/request',
+  USER_READY: 'retrospected/user-ready',
 
   RECEIVE_POST: 'retrospected/posts/receive/add',
   RECEIVE_DELETE_POST: 'retrospected/posts/receive/delete',
@@ -34,4 +35,5 @@ export default {
   RECEIVE_UNAUTHORIZED: 'retrospected/session/receive/unauthorized',
   RECEIVE_RATE_LIMITED: 'retrospected/rate-limited-error',
   RECEIVE_ERROR: 'retrospected/receive/error',
+  RECEIVE_USER_READY: 'retrospected/receive/user-ready',
 };
diff --git a/common/src/models.ts b/common/src/models.ts
@@ -28,4 +28,5 @@ export const defaultSession: Omit<Session, 'createdBy'> = {
   options: { ...defaultOptions },
   encrypted: null,
   locked: false,
+  ready: [],
 };
diff --git a/common/src/types.ts b/common/src/types.ts
@@ -7,6 +7,7 @@ export interface Session extends PostContainer, Entity {
   encrypted: string | null;
   locked: boolean;
   createdBy: User;
+  ready: string[];
 }
 
 export interface SessionMetadata extends Entity {

diff --git a/common/src/ws.ts b/common/src/ws.ts
@@ -54,6 +54,11 @@ export interface WsSaveTemplatePayload {
   options: SessionOptions;
 }
 
+export interface WsUserReadyPayload {
+  userId: string;
+  ready: boolean;
+}
+
 export type WsErrorType =
   | 'cannot_save_post'
   | 'cannot_save_group'

diff --git a/frontend/package.json b/frontend/package.json
@@ -63,7 +63,7 @@
     "recoil": "^0.4.1",
     "rehype-raw": "^6.1.0",
     "shortid": "^2.2.16",
-    "socket.io-client": "4.2.0",
+    "socket.io-client": "4.3.2",
     "source-map-explorer": "^2.5.2",
     "typescript": "^4.4.4",
     "uuid": "^8.3.2",

diff --git a/frontend/src/testing/index.tsx b/frontend/src/testing/index.tsx
@@ -27,6 +27,7 @@ export const initialSession: Session = {
   options: {
     ...defaultOptions,
   },
+  ready: [],
 };
 
 export const AllTheProviders: React.FC = ({ children }) => {

diff --git a/frontend/src/translations/ar.ts b/frontend/src/translations/ar.ts
@@ -109,6 +109,8 @@ export default {
     notLoggedIn: undefined,
     error: undefined,
     maxPostsReached: undefined,
+    iAmDone: undefined,
+    iAmNotDoneYet: undefined,
   },
   GameMenu: {
     board: undefined,

diff --git a/frontend/src/translations/de.ts b/frontend/src/translations/de.ts
@@ -114,6 +114,8 @@ export default {
     notLoggedIn: undefined,
     error: undefined,
     maxPostsReached: undefined,
+    iAmDone: undefined,
+    iAmNotDoneYet: undefined,
   },
   GameMenu: {
     board: undefined,

diff --git a/frontend/src/translations/en.ts b/frontend/src/translations/en.ts
@@ -149,6 +149,8 @@ export default {
       }
     },
     maxPostsReached: `You have reached the maximum number of posts set by the moderator.`,
+    iAmDone: "I'm done!",
+    iAmNotDoneYet: "I'm not done yet...",
   },
   GameMenu: {
     board: 'Board',

diff --git a/frontend/src/translations/es.ts b/frontend/src/translations/es.ts
@@ -110,6 +110,8 @@ export default {
     notLoggedIn: undefined,
     error: undefined,
     maxPostsReached: undefined,
+    iAmDone: undefined,
+    iAmNotDoneYet: undefined,
   },
   GameMenu: {
     board: undefined,

diff --git a/frontend/src/translations/fr.ts b/frontend/src/translations/fr.ts
@@ -151,6 +151,8 @@ export default {
       }
     },
     maxPostsReached: `Vous avez atteint le nombre de posts maximum prévu par le modérateur.`,
+    iAmDone: "J'ai fini !",
+    iAmNotDoneYet: "Je n'ai pas encore fini...",
   },
   GameMenu: {
     board: 'Board', // Si qqn à une suggestion de traduction...

diff --git a/frontend/src/translations/hu.ts b/frontend/src/translations/hu.ts
@@ -110,6 +110,8 @@ export default {
     notLoggedIn: undefined,
     error: undefined,
     maxPostsReached: undefined,
+    iAmDone: undefined,
+    iAmNotDoneYet: undefined,
   },
   GameMenu: {
     board: undefined,

diff --git a/frontend/src/translations/it.ts b/frontend/src/translations/it.ts
@@ -118,6 +118,8 @@ export default {
     notLoggedIn:
       'Non sei autenticato. Puoi assistere a questa sessione come spettatore ma non puoi partecipare',
     maxPostsReached: undefined,
+    iAmDone: undefined,
+    iAmNotDoneYet: undefined,
   },
   GameMenu: {
     board: 'Board',

diff --git a/frontend/src/translations/ja.ts b/frontend/src/translations/ja.ts
@@ -110,6 +110,8 @@ export default {
     notLoggedIn: undefined,
     error: undefined,
     maxPostsReached: undefined,
+    iAmDone: undefined,
+    iAmNotDoneYet: undefined,
   },
   GameMenu: {
     board: undefined,

diff --git a/frontend/src/translations/nl.ts b/frontend/src/translations/nl.ts
@@ -118,6 +118,8 @@ export default {
     notLoggedIn:
       'Je bent niet ingelogd. Je kan de sessie bekijken als toeschouwer maar moet inloggen om deel te nemen.',
     maxPostsReached: undefined,
+    iAmDone: undefined,
+    iAmNotDoneYet: undefined,
   },
   GameMenu: {
     board: 'Bord',

diff --git a/frontend/src/translations/pl.ts b/frontend/src/translations/pl.ts
@@ -110,6 +110,8 @@ export default {
     notLoggedIn: undefined,
     error: undefined,
     maxPostsReached: undefined,
+    iAmDone: undefined,
+    iAmNotDoneYet: undefined,
   },
   GameMenu: {
     board: undefined,

diff --git a/frontend/src/translations/pt-br.ts b/frontend/src/translations/pt-br.ts
@@ -110,6 +110,8 @@ export default {
     notLoggedIn: undefined,
     error: undefined,
     maxPostsReached: undefined,
+    iAmDone: undefined,
+    iAmNotDoneYet: undefined,
   },
   GameMenu: {
     board: undefined,

diff --git a/frontend/src/translations/ru.ts b/frontend/src/translations/ru.ts
@@ -110,6 +110,8 @@ export default {
     notLoggedIn: undefined,
     error: undefined,
     maxPostsReached: undefined,
+    iAmDone: undefined,
+    iAmNotDoneYet: undefined,
   },
   GameMenu: {
     board: 'Записи',

diff --git a/frontend/src/translations/types.ts b/frontend/src/translations/types.ts
@@ -112,6 +112,8 @@ export interface Translation {
     notLoggedIn?: string;
     error?: (error: WsErrorType) => string;
     maxPostsReached?: string;
+    iAmDone?: string;
+    iAmNotDoneYet?: string;
   };
   GameMenu: {
     board?: string;

diff --git a/frontend/src/translations/zh-cn.ts b/frontend/src/translations/zh-cn.ts
@@ -110,6 +110,8 @@ export default {
     notLoggedIn: undefined,
     error: undefined,
     maxPostsReached: undefined,
+    iAmDone: undefined,
+    iAmNotDoneYet: undefined,
   },
   GameMenu: {
     board: undefined,

diff --git a/frontend/src/translations/zh-tw.ts b/frontend/src/translations/zh-tw.ts
@@ -110,6 +110,8 @@ export default {
     notLoggedIn: undefined,
     error: undefined,
     maxPostsReached: undefined,
+    iAmDone: undefined,
+    iAmNotDoneYet: undefined,
   },
   GameMenu: {
     board: undefined,

diff --git a/frontend/src/views/Game.tsx b/frontend/src/views/Game.tsx
@@ -68,6 +68,7 @@ function GamePage() {
     onEditColumns,
     onSaveTemplate,
     onLockSession,
+    onUserReady,
     reconnect,
   } = useGame(gameId);
 
@@ -182,7 +183,7 @@ function GamePage() {
         />
       ) : null}
       <ParticipantContainer>
-        <Participants />
+        <Participants onReady={onUserReady} />
       </ParticipantContainer>
     </div>
   );