[SPIKE] Implement WebSockets

[Marcamillian]

Aim

Set up a basic WebSocket implementation that can be built upon to create the way we update clients of the gameState.

Steps

• There is a tutorial here
  • This tutorial uses the gorilla implementation that we are avoiding (Due to issue seen when running Gorilla/mux)
  • Alternative package - golang developed one here

Acceptance Criteria

• A websocket connection created between client & server
• Triggered server events send messages back the client

[Marcamillian]

When deciding what websocket package to use there were several options

• ❌github.com/gorilla/websocket
  • As we has issues using gorilla/mux I decided against this
• ❌ golang.org/x/net/websocket
  • In the README.md they suggested using a more maintained package nhooyr.io/websocket
  • Published: 8th Jan 2024
  • Imported by: 5594
  • This post here (from 2016) suggests against using this package in favour of gorilla
• ✅ nhooyr.io/websocket
  • Published: 25th Oct 2023
  • Imported by: 820
  • Seems to be the suggested version
  • Github
    • 3.3k stars

[Marcamillian]

Progress

Got the Websocket running

• The websocket is running at /ws/echo
• A static page served at /static/websocketDemo.html
  • Creates a connection to the websocket endpoint
  • An input sends a message to the websocket
  • The server responds

Improvements

• Connecting through POSTMAN doesn't work at the moment - gets a 403 error
  • Likely need to adjust the origin settings on the server and set an Origin header in the request detailed here
• Handle sessions - to allow for reconnection after a disconnect
  • This could be a package or building something myself

[Marcamillian]

Progress

Looking into implementing nhooyr.io/weboscket

There is a chat example detailed here

[Marcamillian]

Progress

I haven't had a huge amount of time to spend on development in the last few weeks (due to being consumed with job applications)

Stuff I have been working on locally is

• Trying out different websocket libraries
  • gorilla/websocket
  • golang.org/x/net/websocket
  • github.com/lxzan/gws
  • github.com/lxzan/gws
• Generally echo servers work well
  • I'm missing something when trying to implement the chat examples
  • getting the 403 errors mentioned before

Routes forward

• A suggestion of using Server Side Events - Youtube tutorial here
• Guide from Anthony GG in this tutorial

[Marcamillian]

Feature implemented and Merged in MR #6