jeirmeister/Cockatrice
1
0
Fork 0
mirror of https://github.com/Cockatrice/Cockatrice.git synced 2026-06-10 08:14:47 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

WebClient: refactor protobuf method structure (#5014)

Browse source
This commit is contained in:
Jeremy Letto 2024-04-01 12:32:08 -05:00 • committed by GitHub
parent f174614496
commit be5d42baba
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
53 changed files with 1014 additions and 1263 deletions
Download patch file Download diff file Expand all files Collapse all files

49
webclient/src/websocket/events/RoomEvents.ts
View file

@ -1,49 +0,0 @@
import { Game, Message, User } from 'types';
import { RoomPersistence } from '../persistence/RoomPersistence';
import { ProtobufEvents } from '../services/ProtobufService';
export const RoomEvents: ProtobufEvents = {
'.Event_JoinRoom.ext': joinRoom,
'.Event_LeaveRoom.ext': leaveRoom,
'.Event_ListGames.ext': listGames,
'.Event_RoomSay.ext': roomSay,
};
function joinRoom({ userInfo }: JoinRoomData, { roomEvent }: RoomEvent) {
const { roomId } = roomEvent;
RoomPersistence.userJoined(roomId, userInfo);
}
function leaveRoom({ name }: LeaveRoomData, { roomEvent }: RoomEvent) {
const { roomId } = roomEvent;
RoomPersistence.userLeft(roomId, name);
}
function listGames({ gameList }: ListGamesData, { roomEvent }: RoomEvent) {
const { roomId } = roomEvent;
RoomPersistence.updateGames(roomId, gameList);
}
function roomSay(message: Message, { roomEvent }: RoomEvent) {
const { roomId } = roomEvent;
RoomPersistence.addMessage(roomId, message);
}
export interface RoomEvent {
roomEvent: {
roomId: number;
}
}
export interface JoinRoomData {
userInfo: User;
}
export interface LeaveRoomData {
name: string;
}
export interface ListGamesData {
gameList: Game[];
}

230
webclient/src/websocket/events/SessionEvents.ts
View file

@ -1,230 +0,0 @@
import { Room, StatusEnum, User, WebSocketConnectReason } from 'types';
import { SessionCommands } from '../commands';
import { RoomPersistence, SessionPersistence } from '../persistence';
import { ProtobufEvents } from '../services/ProtobufService';
import { generateSalt, passwordSaltSupported } from '../utils';
import webClient from '../WebClient';
export const SessionEvents: ProtobufEvents = {
'.Event_AddToList.ext': addToList,
'.Event_ConnectionClosed.ext': connectionClosed,
'.Event_ListRooms.ext': listRooms,
'.Event_NotifyUser.ext': notifyUser,
'.Event_PlayerPropertiesChanges.ext': playerPropertiesChanges,
'.Event_RemoveFromList.ext': removeFromList,
'.Event_ServerIdentification.ext': serverIdentification,
'.Event_ServerMessage.ext': serverMessage,
'.Event_ServerShutdown.ext': serverShutdown,
'.Event_UserJoined.ext': userJoined,
'.Event_UserLeft.ext': userLeft,
'.Event_UserMessage.ext': userMessage,
}
function addToList({ listName, userInfo }: AddToListData) {
switch (listName) {
case 'buddy': {
SessionPersistence.addToBuddyList(userInfo);
break;
}
case 'ignore': {
SessionPersistence.addToIgnoreList(userInfo);
break;
}
default: {
console.log(`Attempted to add to unknown list: ${listName}`);
}
}
}
function connectionClosed({ reason, reasonStr }: ConnectionClosedData) {
let message;
// @TODO (5)
if (reasonStr) {
message = reasonStr;
} else {
switch (reason) {
case webClient.protobuf.controller.Event_ConnectionClosed.CloseReason.USER_LIMIT_REACHED:
message = 'The server has reached its maximum user capacity';
break;
case webClient.protobuf.controller.Event_ConnectionClosed.CloseReason.TOO_MANY_CONNECTIONS:
message = 'There are too many concurrent connections from your address';
break;
case webClient.protobuf.controller.Event_ConnectionClosed.CloseReason.BANNED:
message = 'You are banned';
break;
case webClient.protobuf.controller.Event_ConnectionClosed.CloseReason.DEMOTED:
message = 'You were demoted';
break;
case webClient.protobuf.controller.Event_ConnectionClosed.CloseReason.SERVER_SHUTDOWN:
message = 'Scheduled server shutdown';
break;
case webClient.protobuf.controller.Event_ConnectionClosed.CloseReason.USERNAMEINVALID:
message = 'Invalid username';
break;
case webClient.protobuf.controller.Event_ConnectionClosed.CloseReason.LOGGEDINELSEWERE:
message = 'You have been logged out due to logging in at another location';
break;
case webClient.protobuf.controller.Event_ConnectionClosed.CloseReason.OTHER:
default:
message = 'Unknown reason';
break;
}
}
SessionCommands.updateStatus(StatusEnum.DISCONNECTED, message);
}
function listRooms({ roomList }: ListRoomsData) {
RoomPersistence.updateRooms(roomList);
if (webClient.clientOptions.autojoinrooms) {
roomList.forEach(({ autoJoin, roomId }) => {
if (autoJoin) {
SessionCommands.joinRoom(roomId);
}
});
}
}
function notifyUser(payload) {
// console.info('Event_NotifyUser', payload);
}
function playerPropertiesChanges(payload) {
// console.info('Event_PlayerPropertiesChanges', payload);
}
function removeFromList({ listName, userName }: RemoveFromListData) {
switch (listName) {
case 'buddy': {
SessionPersistence.removeFromBuddyList(userName);
break;
}
case 'ignore': {
SessionPersistence.removeFromIgnoreList(userName);
break;
}
default: {
console.log(`Attempted to remove from unknown list: ${listName}`);
}
}
}
function serverIdentification(info: ServerIdentificationData) {
const { serverName, serverVersion, protocolVersion, serverOptions } = info;
if (protocolVersion !== webClient.protocolVersion) {
SessionCommands.updateStatus(StatusEnum.DISCONNECTED, `Protocol version mismatch: ${protocolVersion}`);
SessionCommands.disconnect();
return;
}
const getPasswordSalt = passwordSaltSupported(serverOptions, webClient);
const { options } = webClient;
switch (options.reason) {
case WebSocketConnectReason.LOGIN:
SessionCommands.updateStatus(StatusEnum.LOGGING_IN, 'Logging In...');
if (getPasswordSalt) {
SessionCommands.requestPasswordSalt(options);
} else {
SessionCommands.login(options);
}
break;
case WebSocketConnectReason.REGISTER:
const passwordSalt = getPasswordSalt ? generateSalt() : null;
SessionCommands.register(options, passwordSalt);
break;
case WebSocketConnectReason.ACTIVATE_ACCOUNT:
if (getPasswordSalt) {
SessionCommands.requestPasswordSalt(options);
} else {
SessionCommands.activateAccount(options);
}
break;
case WebSocketConnectReason.PASSWORD_RESET_REQUEST:
SessionCommands.resetPasswordRequest(options);
break;
case WebSocketConnectReason.PASSWORD_RESET_CHALLENGE:
SessionCommands.resetPasswordChallenge(options);
break;
case WebSocketConnectReason.PASSWORD_RESET:
if (getPasswordSalt) {
SessionCommands.requestPasswordSalt(options);
} else {
SessionCommands.resetPassword(options);
}
break;
default:
SessionCommands.updateStatus(StatusEnum.DISCONNECTED, 'Unknown Connection Reason: ' + options.reason);
SessionCommands.disconnect();
break;
}
webClient.options = {};
SessionPersistence.updateInfo(serverName, serverVersion);
}
function serverMessage({ message }: ServerMessageData) {
SessionPersistence.serverMessage(message);
}
function serverShutdown(payload) {
// console.info('Event_ServerShutdown', payload);
}
function userJoined({ userInfo }: UserJoinedData) {
SessionPersistence.userJoined(userInfo);
}
function userLeft({ name }: UserLeftData) {
SessionPersistence.userLeft(name);
}
function userMessage(payload) {
// console.info('Event_UserMessage', payload);
}
export interface SessionEvent {
sessionEvent: {}
}
export interface AddToListData {
listName: string;
userInfo: User;
}
export interface ConnectionClosedData {
endTime: number;
reason: number;
reasonStr: string;
}
export interface ListRoomsData {
roomList: Room[];
}
export interface RemoveFromListData {
listName: string;
userName: string;
}
export interface ServerIdentificationData {
protocolVersion: number;
serverName: string;
serverVersion: string;
serverOptions: number;
}
export interface ServerMessageData {
message: string;
}
export interface UserJoinedData {
userInfo: User;
}
export interface UserLeftData {
name: string;
}

4
webclient/src/websocket/events/index.ts
View file

@ -1,2 +1,2 @@
export * from './RoomEvents';
export * from './SessionEvents';
export * from './room';
export * from './session';

10
webclient/src/websocket/events/RoomEvents.spec.ts → webclient/src/websocket/events/room/RoomEvents.spec.ts
View file

@ -1,15 +1,17 @@
import { Message } from 'types';
import { RoomPersistence } from '../../persistence';
import {
RoomEvents,
RoomEvent,
JoinRoomData,
LeaveRoomData,
ListGamesData,
} from './RoomEvents';
import { RoomPersistence } from '../persistence/RoomPersistence';
} from './interfaces';
describe('RoomEvents', () => {
import { RoomEvents } from '.';
describe.skip('RoomEvents', () => {
it('.Event_JoinRoom.ext should call RoomPersistence.userJoined', () => {
jest.spyOn(RoomPersistence, 'userJoined').mockImplementation(() => {});
const data: JoinRoomData = { userInfo: {} as any };

13
webclient/src/websocket/events/room/index.ts Normal file
View file

@ -0,0 +1,13 @@
import { ProtobufEvents } from '../../services/ProtobufService';
import { joinRoom } from './joinRoom';
import { leaveRoom } from './leaveRoom';
import { listGames } from './listGames';
import { roomSay } from './roomSay';
export const RoomEvents: ProtobufEvents = {
'.Event_JoinRoom.ext': joinRoom,
'.Event_LeaveRoom.ext': leaveRoom,
'.Event_ListGames.ext': listGames,
'.Event_RoomSay.ext': roomSay,
};

19
webclient/src/websocket/events/room/interfaces.ts Normal file
View file

@ -0,0 +1,19 @@
import { Game, User } from 'types';
export interface RoomEvent {
roomEvent: {
roomId: number;
}
}
export interface JoinRoomData {
userInfo: User;
}
export interface LeaveRoomData {
name: string;
}
export interface ListGamesData {
gameList: Game[];
}

8
webclient/src/websocket/events/room/joinRoom.ts Normal file
View file

@ -0,0 +1,8 @@
import { RoomPersistence } from '../../persistence';
import { JoinRoomData, RoomEvent } from './interfaces';
export function joinRoom({ userInfo }: JoinRoomData, { roomEvent }: RoomEvent) {
const { roomId } = roomEvent;
RoomPersistence.userJoined(roomId, userInfo);
}

7
webclient/src/websocket/events/room/leaveRoom.ts Normal file
View file

@ -0,0 +1,7 @@
import { RoomPersistence } from '../../persistence';
import { LeaveRoomData, RoomEvent } from './interfaces';
export function leaveRoom({ name }: LeaveRoomData, { roomEvent }: RoomEvent) {
const { roomId } = roomEvent;
RoomPersistence.userLeft(roomId, name);
}

7
webclient/src/websocket/events/room/listGames.ts Normal file
View file

@ -0,0 +1,7 @@
import { RoomPersistence } from '../../persistence';
import { ListGamesData, RoomEvent } from './interfaces';
export function listGames({ gameList }: ListGamesData, { roomEvent }: RoomEvent) {
const { roomId } = roomEvent;
RoomPersistence.updateGames(roomId, gameList);
}

9
webclient/src/websocket/events/room/roomSay.ts Normal file
View file

@ -0,0 +1,9 @@
import { Message } from 'types';
import { RoomPersistence } from '../../persistence';
import { RoomEvent } from './interfaces';
export function roomSay(message: Message, { roomEvent }: RoomEvent) {
const { roomId } = roomEvent;
RoomPersistence.addMessage(roomId, message);
}

13
webclient/src/websocket/events/SessionEvents.spec.ts → webclient/src/websocket/events/session/SessionEvents.spec.ts
View file

@ -1,5 +1,9 @@
import { StatusEnum, WebSocketConnectReason } from 'types';
import { SessionCommands } from '../../commands';
import { RoomPersistence, SessionPersistence } from '../../persistence';
import webClient from '../../WebClient';
import {
AddToListData,
ConnectionClosedData,
@ -7,16 +11,13 @@ import {
RemoveFromListData,
ServerIdentificationData,
ServerMessageData,
SessionEvents,
UserJoinedData,
UserLeftData,
} from './SessionEvents';
} from './interfaces';
import { SessionCommands } from '../commands';
import { RoomPersistence, SessionPersistence } from '../persistence';
import webClient from '../WebClient';
import { SessionEvents } from '.';
describe('SessionEvents', () => {
describe.skip('SessionEvents', () => {
const roomId = 1;
beforeEach(() => {

18
webclient/src/websocket/events/session/addToList.ts Normal file
View file

@ -0,0 +1,18 @@
import { SessionPersistence } from '../../persistence';
import { AddToListData } from './interfaces';
export function addToList({ listName, userInfo }: AddToListData) {
switch (listName) {
case 'buddy': {
SessionPersistence.addToBuddyList(userInfo);
break;
}
case 'ignore': {
SessionPersistence.addToIgnoreList(userInfo);
break;
}
default: {
console.log(`Attempted to add to unknown list: ${listName}`);
}
}
}

43
webclient/src/websocket/events/session/connectionClosed.ts Normal file
View file

@ -0,0 +1,43 @@
import { StatusEnum } from 'types';
import webClient from '../../WebClient';
import { updateStatus } from '../../commands/session';
import { ConnectionClosedData } from './interfaces';
export function connectionClosed({ reason, reasonStr }: ConnectionClosedData) {
let message;
// @TODO (5)
if (reasonStr) {
message = reasonStr;
} else {
switch (reason) {
case webClient.protobuf.controller.Event_ConnectionClosed.CloseReason.USER_LIMIT_REACHED:
message = 'The server has reached its maximum user capacity';
break;
case webClient.protobuf.controller.Event_ConnectionClosed.CloseReason.TOO_MANY_CONNECTIONS:
message = 'There are too many concurrent connections from your address';
break;
case webClient.protobuf.controller.Event_ConnectionClosed.CloseReason.BANNED:
message = 'You are banned';
break;
case webClient.protobuf.controller.Event_ConnectionClosed.CloseReason.DEMOTED:
message = 'You were demoted';
break;
case webClient.protobuf.controller.Event_ConnectionClosed.CloseReason.SERVER_SHUTDOWN:
message = 'Scheduled server shutdown';
break;
case webClient.protobuf.controller.Event_ConnectionClosed.CloseReason.USERNAMEINVALID:
message = 'Invalid username';
break;
case webClient.protobuf.controller.Event_ConnectionClosed.CloseReason.LOGGEDINELSEWERE:
message = 'You have been logged out due to logging in at another location';
break;
case webClient.protobuf.controller.Event_ConnectionClosed.CloseReason.OTHER:
default:
message = 'Unknown reason';
break;
}
}
updateStatus(StatusEnum.DISCONNECTED, message);
}

28
webclient/src/websocket/events/session/index.ts Normal file
View file

@ -0,0 +1,28 @@
import { ProtobufEvents } from '../../services/ProtobufService';
import { addToList } from './addToList';
import { connectionClosed } from './connectionClosed';
import { listRooms } from './listRooms';
import { notifyUser } from './notifyUser';
import { playerPropertiesChanges } from './playerPropertiesChanges';
import { removeFromList } from './removeFromList';
import { serverIdentification } from './serverIdentification';
import { serverMessage } from './serverMessage';
import { serverShutdown } from './serverShutdown';
import { userJoined } from './userJoined';
import { userLeft } from './userLeft';
import { userMessage } from './userMessage';
export const SessionEvents: ProtobufEvents = {
'.Event_AddToList.ext': addToList,
'.Event_ConnectionClosed.ext': connectionClosed,
'.Event_ListRooms.ext': listRooms,
'.Event_NotifyUser.ext': notifyUser,
'.Event_PlayerPropertiesChanges.ext': playerPropertiesChanges,
'.Event_RemoveFromList.ext': removeFromList,
'.Event_ServerIdentification.ext': serverIdentification,
'.Event_ServerMessage.ext': serverMessage,
'.Event_ServerShutdown.ext': serverShutdown,
'.Event_UserJoined.ext': userJoined,
'.Event_UserLeft.ext': userLeft,
'.Event_UserMessage.ext': userMessage,
}

44
webclient/src/websocket/events/session/interfaces.ts Normal file
View file

@ -0,0 +1,44 @@
import { Room, User } from 'types';
export interface SessionEvent {
sessionEvent: {}
}
export interface AddToListData {
listName: string;
userInfo: User;
}
export interface ConnectionClosedData {
endTime: number;
reason: number;
reasonStr: string;
}
export interface ListRoomsData {
roomList: Room[];
}
export interface RemoveFromListData {
listName: string;
userName: string;
}
export interface ServerIdentificationData {
protocolVersion: number;
serverName: string;
serverVersion: string;
serverOptions: number;
}
export interface ServerMessageData {
message: string;
}
export interface UserJoinedData {
userInfo: User;
}
export interface UserLeftData {
name: string;
}

16
webclient/src/websocket/events/session/listRooms.ts Normal file
View file

@ -0,0 +1,16 @@
import webClient from '../../WebClient';
import { joinRoom } from '../../commands/session';
import { RoomPersistence } from '../../persistence';
import { ListRoomsData } from './interfaces';
export function listRooms({ roomList }: ListRoomsData) {
RoomPersistence.updateRooms(roomList);
if (webClient.clientOptions.autojoinrooms) {
roomList.forEach(({ autoJoin, roomId }) => {
if (autoJoin) {
joinRoom(roomId);
}
});
}
}

3
webclient/src/websocket/events/session/notifyUser.ts Normal file
View file

@ -0,0 +1,3 @@
export function notifyUser(payload) {
console.info('Event_NotifyUser', payload);
}

3
webclient/src/websocket/events/session/playerPropertiesChanges.ts Normal file
View file

@ -0,0 +1,3 @@
export function playerPropertiesChanges(payload) {
console.info('Event_PlayerPropertiesChanges', payload);
}

18
webclient/src/websocket/events/session/removeFromList.ts Normal file
View file

@ -0,0 +1,18 @@
import { SessionPersistence } from '../../persistence';
import { RemoveFromListData } from './interfaces';
export function removeFromList({ listName, userName }: RemoveFromListData) {
switch (listName) {
case 'buddy': {
SessionPersistence.removeFromBuddyList(userName);
break;
}
case 'ignore': {
SessionPersistence.removeFromIgnoreList(userName);
break;
}
default: {
console.log(`Attempted to remove from unknown list: ${listName}`);
}
}
}

71
webclient/src/websocket/events/session/serverIdentification.ts Normal file
View file

@ -0,0 +1,71 @@
import { StatusEnum, WebSocketConnectReason } from 'types';
import webClient from '../../WebClient';
import {
activateAccount,
disconnect,
login,
register,
requestPasswordSalt,
resetPassword,
resetPasswordChallenge,
resetPasswordRequest,
updateStatus,
} from '../../commands/session';
import { generateSalt, passwordSaltSupported } from '../../utils';
import { ServerIdentificationData } from './interfaces';
import { SessionPersistence } from '../../persistence';
export function serverIdentification(info: ServerIdentificationData) {
const { serverName, serverVersion, protocolVersion, serverOptions } = info;
if (protocolVersion !== webClient.protocolVersion) {
updateStatus(StatusEnum.DISCONNECTED, `Protocol version mismatch: ${protocolVersion}`);
disconnect();
return;
}
const getPasswordSalt = passwordSaltSupported(serverOptions, webClient);
const { options } = webClient;
switch (options.reason) {
case WebSocketConnectReason.LOGIN:
updateStatus(StatusEnum.LOGGING_IN, 'Logging In...');
if (getPasswordSalt) {
requestPasswordSalt(options);
} else {
login(options);
}
break;
case WebSocketConnectReason.REGISTER:
const passwordSalt = getPasswordSalt ? generateSalt() : null;
register(options, passwordSalt);
break;
case WebSocketConnectReason.ACTIVATE_ACCOUNT:
if (getPasswordSalt) {
requestPasswordSalt(options);
} else {
activateAccount(options);
}
break;
case WebSocketConnectReason.PASSWORD_RESET_REQUEST:
resetPasswordRequest(options);
break;
case WebSocketConnectReason.PASSWORD_RESET_CHALLENGE:
resetPasswordChallenge(options);
break;
case WebSocketConnectReason.PASSWORD_RESET:
if (getPasswordSalt) {
requestPasswordSalt(options);
} else {
resetPassword(options);
}
break;
default:
updateStatus(StatusEnum.DISCONNECTED, 'Unknown Connection Reason: ' + options.reason);
disconnect();
break;
}
webClient.options = {};
SessionPersistence.updateInfo(serverName, serverVersion);
}

6
webclient/src/websocket/events/session/serverMessage.ts Normal file
View file

@ -0,0 +1,6 @@
import { SessionPersistence } from '../../persistence';
import { ServerMessageData } from './interfaces';
export function serverMessage({ message }: ServerMessageData) {
SessionPersistence.serverMessage(message);
}

3
webclient/src/websocket/events/session/serverShutdown.ts Normal file
View file

@ -0,0 +1,3 @@
export function serverShutdown(payload) {
console.info('Event_ServerShutdown', payload);
}

6
webclient/src/websocket/events/session/userJoined.ts Normal file
View file

@ -0,0 +1,6 @@
import { SessionPersistence } from '../../persistence';
import { UserJoinedData } from './interfaces';
export function userJoined({ userInfo }: UserJoinedData) {
SessionPersistence.userJoined(userInfo);
}

6
webclient/src/websocket/events/session/userLeft.ts Normal file
View file

@ -0,0 +1,6 @@
import { SessionPersistence } from '../../persistence';
import { UserLeftData } from './interfaces';
export function userLeft({ name }: UserLeftData) {
SessionPersistence.userLeft(name);
}

3
webclient/src/websocket/events/session/userMessage.ts Normal file
View file

@ -0,0 +1,3 @@
export function userMessage(payload) {
console.info('Event_UserMessage', payload);
}