Skip to content

API 2.0; now, instead of hiring a mailman, you set a message listener #34

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Aug 8, 2015
Merged

API 2.0; now, instead of hiring a mailman, you set a message listener #34

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8790938
removed getMessage, added setMessageListener, KISSed sendMessage
acostarelli Aug 8, 2015
a420b37
LoginController now conforms to the new API
acostarelli Aug 8, 2015
9eb2aed
sends JSON.parse -d data, rather than the entire JSON message
acostarelli Aug 8, 2015
ac5137f
removed testing logs
acostarelli Aug 8, 2015
fe56e05
now conforms to the new API, setup a command map.
acostarelli Aug 8, 2015
dfb02ad
added addEventTypes and removeMessageListener
acostarelli Aug 8, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
128 changes: 65 additions & 63 deletions lobby/lobby_controller.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
CardshifterApp.controller("LobbyController", function($scope, $interval, $timeout) {
CardshifterApp.controller("LobbyController", function($scope, $timeout) {
var CHAT_FEED_LIMIT = 10;
var POLL_FREQ = 2000;
var MESSAGE_DELAY = 3000;
var ENTER_KEY = 13;

$scope.users = [];
Expand All @@ -15,54 +13,20 @@ CardshifterApp.controller("LobbyController", function($scope, $interval, $timeou
};
$scope.gotInvite = false;

var getUsersMessage = new CardshifterServerAPI.messageTypes.ServerQueryMessage("USERS", "");
CardshifterServerAPI.sendMessage(getUsersMessage); // get all online users

$interval(function() { // update chat and users
while(message = CardshifterServerAPI.getMessage()) {
switch(message.command) {
case "userstatus":
// do conditional checking if user is offline
if(message.status === "OFFLINE") {
for(var i = 0, length = $scope.users.length; i < length; i++) {

if($scope.users[i].userId === message.userId) {
$scope.users.splice(i, 1); // remove that user from the array
}
}
} else {
$scope.users.push(message);
}

break;
case "chat":
if($scope.chatMessages.length === CHAT_FEED_LIMIT) {
// remove the latest (opposite of earliest) chat message
$scope.chatMessages.shift();
}

var now = new Date();
var YMD = now.getFullYear() + "-" + (now.getMonth() + 1) + "-" + now.getDate();
var HMS = now.getHours() + ":" + now.getMinutes() + ":" + now.getSeconds();
message.timestamp = YMD + " " + HMS;

$scope.chatMessages.push(message);
break;
var commandMap = {
"userstatus": updateUserList,
"chat": addChatMessage,
"inviteRequest": displayInvite,
"availableMods": displayMods
};

case "inviteRequest":
console.log("got invite");
$scope.invite.id = message.id;
$scope.invite.name = message.name;
$scope.invite.type = message.gameType;
$scope.gotInvite = true;
var getUsers = new CardshifterServerAPI.messageTypes.ServerQueryMessage("USERS", "");
CardshifterServerAPI.sendMessage(getUsers);

break;
case "availableMods":
$scope.mods = message.mods;
break;
}
}
}, POLL_FREQ);
CardshifterServerAPI.setMessageListener(function(message) {
commandMap[message.command](message);
$scope.$apply(); // needs to manually updated since this is an event
}, ["userstatus", "chat", "inviteRequest", "availableMods"]);

$scope.sendMessage = function(e) {
if(e && e.keyCode !== ENTER_KEY) { // user may hit "enter" key
Expand All @@ -78,30 +42,68 @@ CardshifterApp.controller("LobbyController", function($scope, $interval, $timeou
$scope.sending = false;
}, MESSAGE_DELAY);
}

$scope.startGame = function() {
if($scope.selected_mod && $scope.selected_opponent) {
var startGameMessage = new CardshifterServerAPI.messageTypes.StartGameRequest($scope.selected_opponent,
$scope.selected_mod);
CardshifterServerAPI.sendMessage(startGameMessage, function(returnMessage) {
if(returnMessage.command !== "wait") {
console.log("server didn't like that")
}
});
console.log("start");
} else {
// user needs to choose an opponent and/or a mod
console.log("need to choose mod and/or opponent");
}
}

$scope.acceptInvite = function(accept) {
console.log("accept");
}

var inviteResponse = new CardshifterServerAPI.messageTypes.InviteResponse($scope.invite.id, accept);
CardshifterServerAPI.sendMessage(inviteResponse);
$scope.gotInvite = false;

if(accept) {
// switch to game page
// The command map functions:
/**
* Based on the content of message, will add or remove
* a user from the user list.
*/
function updateUserList(message) {
if(message.status === "OFFLINE") {
for(var i = 0, length = $scope.users.length; i < length; i++) {
if($scope.users[i].userId === message.userId) {
$scope.users.splice(i, 1); // remove that user from the array
break;
}
}
} else {
$scope.users.push(message);
}
}
/**
* Adds a chat message to the message feed. If the message
* feed is at the maximum limit of messages, deletes the oldest
* message.
*/
function addChatMessage(message) {
if($scope.chatMessages.length === CHAT_FEED_LIMIT) {
// remove the oldest chat message
$scope.chatMessages.shift();
}

var now = new Date();
var YMD = now.getFullYear() + "-" + (now.getMonth() + 1) + "-" + now.getDate();
var HMS = now.getHours() + ":" + now.getMinutes() + ":" + now.getSeconds();
message.timestamp = YMD + " " + HMS;

$scope.chatMessages.push(message);
}
/**
* Shows buttons and a message to this client for accepting
* or declining a game request.
*/
function displayInvite(message) {
$scope.invite.id = message.id;
$scope.invite.name = message.name;
$scope.invite.type = message.gameType;
$scope.gotInvite = true;
}
/**
* Shows to the user a list of all available mods.
*/
function displayMods(message) {
$scope.mods = message.mods;
}
});
15 changes: 6 additions & 9 deletions login/login_controller.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,26 +9,23 @@ CardshifterApp.controller("LoginController", function($scope, $location, $rootSc
var login = new CardshifterServerAPI.messageTypes.LoginMessage($scope.username);

try {
CardshifterServerAPI.sendMessage(login, function(serverResponse) {
if(serverResponse.status === SUCCESS && serverResponse.message === "OK") {

CardshifterServerAPI.setMessageListener(function(welcome) {
if(welcome.status === SUCCESS && welcome.message === "OK") {
// taking the easy way out
window.currentUser = {
username: $scope.username,
id: serverResponse.userId
id: welcome.userId
}

$rootScope.$apply(function() {
$location.path("/lobby");
});
} else {
// I don't actually know what the server will respond with
// notify the user that there was an issue logging in (custom server issue ???)

console.log("server message: " + serverResponse.message);
console.log("server messsage: " + welcome.message);
$scope.loggedIn = false;
}
});
}, ["loginresponse"]);
CardshifterServerAPI.sendMessage(login);

} catch(e) {
// notify the user that there was an issue logging in (loginmessage issue)
Expand Down
74 changes: 38 additions & 36 deletions server_interface/server_interface.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@

window.CardshifterServerAPI = {
socket: null,
incomingMessages: [],
eventTypes: [],
messageTypes: {
/**
* Incoming login message.
Expand Down Expand Up @@ -236,10 +236,6 @@
var protocolAddon = (wsProtocolFinder.test(server) ? "" : "ws" + secureAddon + "://");
var socket = new WebSocket(protocolAddon + server);

socket.onmessage = function(message) {
self.incomingMessages.push(JSON.parse(message.data));
}

socket.onopen = onReady;

socket.onerror = function() {
Expand All @@ -250,54 +246,60 @@
this.socket = socket;
},

/**
* Sends a message to the server.
*
* @param message:Message -- The message to send.
* @param onReceive:Function (OPTIONAL) -- A function to run when a message has returned
* @error NotInitializedException -- If the API has not been initialized yet.
*
* This will use websocket setup by `this.init` to send a message to the server.
*
* NOTE: The onReceive function will NOT NECESSARILY be run when the desired request
* is received. However, it is likely.
*/
sendMessage: function(message, onReceive) {
sendMessage: function(message) {
var socket = this.socket;
var self = this;
if(socket) {
if(socket.readyState === SOCKET_OPEN) {
this.socket.send(JSON.stringify(flatten(message)));
if(onReceive) {
this.socket.onmessage = function(msg) {
onReceive(JSON.parse(msg.data));
this.onmessage = function(msg2) {
self.incomingMessages.push(JSON.parse(msg2.data));
}
}
}
} else {
throw new SocketNotReadyException("The Websocket is not yet ready to be used", socket.readyState);
throw new SocketNotReadyException("The Websocket is not ready to be used.", socket.readyState);
}
} else {
throw new NotInitializedException("The API has not yet been initialized.");
}
},

/**
* Gets a message from the recieved message queue.
* Sets an event listener for when the server sends a message and
* the message type is one of the types in types
*
* @return Message -- The first message in the incoming messages queue
* @param listener:Function -- The function to fire when a message of types is received
* @param types:[string] (OPTIONAL) -- Only fire the listener when the message type is in this array
*
* This will .shift() the incomingMessages queue and return the value.
* This allows the API to handle the messages from the server so the
* main game code can access the messages as it needs to.
* TODO: Maybe a timeout will be needed? Pass in a function and a MS count.
*/
setMessageListener: function(listener, types) {
this.eventTypes = types;
this.socket.onmessage = function(message) {
var data = JSON.parse(message.data);
if(this.eventTypes) {
if(this.eventTypes.indexOf(data.command) !== -1) { // if contains
listener(data);
}
} else {
listener(data);
}
}
this.eventTypes = types;
console.log(this.eventTypes);
},

/**
* Adds types to the types to listen for in the message event listener
*
* Although the function is very simple, the name make is clear what is
* happening.
* @param types:[string] -- The types to add
*/
addEventTypes: function(types) {
this.eventTypes = this.eventTypes.concat(types);
console.log(this.eventTypes);
},

/**
* Removes the message event listener
*/
getMessage: function() {
return this.incomingMessages.shift();
removeMessageListener: function() {
this.socket.onmessage = null;
}
};
})(Function("return this")());