0.0.5

.github/workflows/elixir.yml

@@ -0,0 +1,94 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Build and test
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types: [opened, synchronize, reopened]
+  workflow_dispatch:
+
+# Sets the ENV `MIX_ENV` to `test` for running tests
+env:
+  MIX_ENV: test
+  ELIXIR_VER: '1.17.1'
+  OTP_VER: '27.0'
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Build and test
+
+    # Set up a Postgres DB service. By default, Phoenix applications
+    # use Postgres. This creates a database for running tests.
+    # Additional services can be defined here if required.
+    services:
+      db:
+        image: postgres:15
+        ports: ['5432:5432']
+        env:
+          POSTGRES_DB: teiserver_test
+          POSTGRES_USER: teiserver_test
+          POSTGRES_PASSWORD: 123456789
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+    steps:
+    # Step: Setup Elixir + Erlang image as the base.
+    - name: Set up Elixir
+      uses: erlef/setup-beam@v1
+      with:
+        otp-version: ${{ env.OTP_VER }}
+        elixir-version: ${{ env.ELIXIR_VER }}
+
+    # Step: Check out the code.
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    # Step: Define how to cache deps. Restores existing cache if present.
+    - name: Cache deps
+      id: cache-deps
+      uses: actions/cache@v4
+      env:
+        cache-name: cache-elixir-deps
+      with:
+        path: deps
+        key: ${{ runner.os }}-mix-${{ env.cache-name }}-${{ hashFiles('**/mix.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-mix-${{ env.cache-name }}-
+
+    # Step: Define how to cache the `_build` directory. After the first run,
+    # this speeds up tests runs a lot. This includes not re-compiling our
+    # project's downloaded deps every run.
+    - name: Cache compiled build
+      id: cache-build
+      uses: actions/cache@v4
+      env:
+        cache-name: cache-compiled-build
+      with:
+        path: _build
+        key: ${{ runner.os }}-mix-${{ env.cache-name }}-${{ hashFiles('**/mix.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-mix-${{ env.cache-name }}-
+
+    # Step: Download project dependencies. If unchanged, uses
+    # the cached version.
+    - name: Install dependencies
+      run: mix deps.get
+
+    # Step: Execute the tests.
+    - name: Run tests
+      env:
+        DATABASE_URL: postgres://teiserver_test:123456789@localhost/teiserver_test
+      run: mix test.ci

.gitignore

@@ -33,5 +33,7 @@ teiserver-*.tar
 .elixir_ls/*
 .idea
 
+mix.lock
+
 # Notes I put in for myself I don't want on github
 /zignore

.tool-versions

@@ -1,2 +1,2 @@
-erlang 26.2
-elixir 1.15.7-otp-26
+erlang 27.0
+elixir 1.17.1-otp-27

CHANGELOG.md

@@ -1,3 +1,21 @@
+## v0.0.5
+- Swapped to Elixir 1.17
+- Swapped `team_colour` for `player_colour`
+- Refactored the client update process
+- Added messaging around match start/end
+- Added User and Server runtime settings
+- Added Telemetry events
+- Added rate limiting of login attempts
+- Added more options for connecting clients (currently just `bot?`)
+- Added support for guest accounts
+- Added caching for some db calls
+- Added `player_count` as a property to matches
+- Added concept of user choices to represent pre-game choices made by users (e.g. in-game faction)
+- Removed clustering code so it can be handled by the application using Teiserver as a library
+- Moved everything from `Teiserver.Api` to `Teiserver`
+- Dropped Timex
+- Swapped string error messages to atom error messages
+
 ## v0.0.4
 - Added `Lobby`, `LobbySummary`, `MatchType`, `Match`, `MatchMembership`, `MatchSettingType`, `MatchSetting` schemas, libs and queries
 - Added pubsub events for clients connecting, disconnecting and process destruction

README.md

@@ -9,9 +9,11 @@
   <a href="https://hexdocs.pm/teiserver"><img alt="Hex Docs" src="http://img.shields.io/badge/hex.pm-docs-green.svg?style=flat"></a>
   &nbsp;
   <a href="https://opensource.org/licenses/Apache-2.0"><img alt="Apache 2 License" src="https://img.shields.io/hexpm/l/teiserver"></a>
+  &nbsp;
+  <a href="https://github.com/Teifion/teiserver/actions/workflows/elixir.yml/badge.svg?branch=0.0.5"><img alt="Tests" src="https://github.com/Teifion/teiserver/actions/workflows/elixir.yml/badge.svg?branch=0.0.5"></a>  
 </p>
 
-_Note: This README is for the unreleased master branch, please reference the
+_Note: This README is for the unreleased main branch, please reference the
 [official documentation on hexdocs][hexdoc] for the latest stable release._
 
 [hexdoc]: https://hexdocs.pm/teiserver/Teiserver.html
@@ -20,7 +22,6 @@ _Note: This README is for the unreleased master branch, please reference the
 - User connectivity
 - User to User communications
 - Lobby system (planned)
-- Telemetry/Event logging (planned)
 - Community management tools (planned)
 - Steam integration (planned)
 
@@ -29,7 +30,7 @@ First add to your dependencies in `mix.exs`.
 ```elixir
 def deps do
   [
-    {:teiserver, "~> 0.0.3"}
+    {:teiserver, "~> 0.0.5"}
   ]
 end
 ```
@@ -56,9 +57,8 @@ defmodule MyApp.Repo.Migrations.AddTeiserverTables do
 end
 ```
 
-Add this to your Application supervision tree:
-```elixir
-children = [
-  {Teiserver, Application.get_env(:my_app, Teiserver)}
-]
+Finally, update your config to link the repo:
+```
+config :teiserver,
+  repo: MyApp.Repo
 ```

config/config.exs

@@ -13,14 +13,12 @@ config :teiserver, Teiserver.Test.Repo,
   priv: "test/support/postgres",
   url:
     System.get_env("DATABASE_URL") ||
-      "postgres://teiserver_test:123456789@localhost/teiserver_test"
+      "postgres://teiserver_test:postgres@localhost/teiserver_test"
 
 config :teiserver,
   # Overridden by application
   client_destroy_timeout_seconds: 300,
   lobby_join_method: :simple,
-  teiserver_clustering: true,
-  teiserver_clustering_post_join_functions: [],
 
   # User defaults
   default_behaviour_score: 10_000,

config/test.exs

@@ -3,12 +3,5 @@ import Config
 # This makes anything in our tests involving user passwords (creating or logging in) much faster
 config :argon2_elixir, t_cost: 1, m_cost: 8
 
-config :teiserver, Teiserver.Test.Repo,
-  database: "teiserver_test",
-  username: "postgres",
-  password: "postgres",
-  hostname: "localhost"
-
 config :teiserver,
-  repo: Teiserver.Test.Repo,
-  teiserver_clustering: false
+  repo: Teiserver.Test.Repo

coveralls.json

@@ -1,6 +1,9 @@
 {
   "skip_files": [
     "^test/.*",
+    "lib/teiserver.ex",
+    "lib/teiserver/contexts/telemetry.ex",
+    "lib/teiserver/migrations/*",
     "lib/teiserver/helpers/file_macros.ex",
     "lib/teiserver/game/servers/lobby_id_server.ex"
   ],

documentation/development/features.md

@@ -9,6 +9,7 @@
 ## Connections
 ### Clients
 - Tracking
+- Login attempt rate limiting
 
 ## Communication
 - Room messages

documentation/development/roadmap.md

@@ -6,11 +6,11 @@ This is not a rigid document, it is (especially at this stage) liable to change.
 * `v0.0.2` - Client features (Connections)
 * `v0.0.3` - Chat and Messaging (Communication)
 * `v0.0.4` - Lobbies (Lobby and Game)
-* `v0.0.5` - Logging and Event telemetry (Telemetry and Logging)
+* `v0.0.5` - Site and User Settings, plus internal Telemetry (Settings, Telemetry)
 * `v0.0.6` - Player relationships (Account and Community)
 * `v0.0.7` - Moderation (Moderation and Account)
 * `v0.0.8` - Parties (Community)
-* `v0.0.9` - Site and User Settings (Settings)
+* `v0.0.9` - tbd
 * `v0.1` - Stability, tests and better examples on how to use it
 
 At v0.1 I want the server to be in a state where developers can start to make use of it.
@@ -41,12 +41,6 @@ At v0.1 I want the server to be in a state where developers can start to make us
   - Site settings
   - User settings
 
-- Telemetry
-  - In game events
-  - Server events
-  - Lobby events
-  - User events
-
 ## Planned/intended features
 - Administration
   - Moderation

documentation/development/telemetry.md

@@ -0,0 +1,2 @@
+# Events
+Teiserver emits the following events:

documentation/guides/config.md

@@ -33,13 +33,6 @@ The `social_score` given to users registered using `Teiserver.Account.UserLib.re
 ## default_min_user_password_length - Default: 6
 The minimum length for a user password.
 
-# Clustering
-## `teiserver_clustering` - Default: true
-When enabled Teiserver will attempt to handle the clustering of nodes using a database table. Turning it off will mean this behaves like any other application and you can either not cluster it or use things like `libcluster` as you desire. See `Teiserver.System.ClusterManager` for more details.
-
-## `teiserver_clustering_post_join_functions` - Default: []
-When teiserver_clustering is enabled, this will be a list of functions called by the genserver handling the join once it has joined the cluster. See `Teiserver.System.ClusterManager` for more details.
-
 # Function overrides
 Teiserver implements some defaults you may want to overwrite.
 
@@ -50,22 +43,23 @@ Allows you to overwrite `Teiserver.Game.MatchTypeLib.default_calculate_match_typ
 Allows you to overwrite `Teiserver.Account.User.default_calculate_user_permissions/1`. This is used to generate the list of permissions held by a user. By default it mirrors their groups.
 
 ## `fn_lobby_name_acceptor`
-A function used to determine if a lobby name is acceptable. Defaults to `Teiserver.Game.LobbyLib.default_lobby_name_acceptable/1` which always returns true.
+A function used to determine if a lobby name is acceptable. Defaults to `Teiserver.Game.LobbyLib.default_lobby_name_acceptable?/1` which always returns true.
 
 ## `fn_user_name_acceptor`
-A function used to determine if a lobby name is acceptable. Defaults to `Teiserver.Account.UserLib.default_user_name_acceptable/1` which always returns true.
+A function used to determine if a lobby name is acceptable. Defaults to `Teiserver.Account.UserLib.default_user_name_acceptable?/1` which always returns true.
 
 ## `fn_uuid_generator`
 The function used to generate UUIDs. Defaults to `&Ecto.UUID.generate/0`.
 
+# Function extensions
+Teiserver has a number of functions which you will likely want to extend.
 
 # Complete example config
 ```elixir
 config :teiserver,
   repo: HelloWorldServer.Repo,
   client_destroy_timeout_seconds: 300,
   lobby_join_method: :simple,
-  teiserver_clustering: true,
 
   # Users
   default_behaviour_score: 10_000,

documentation/guides/hello_world.md

@@ -116,20 +116,18 @@ end
 ```
 
 ## Data in
-Place in `lib/hellow_world_server/tcp_in.ex`, this will handle all the commands coming in.
+Place in `lib/hello_world_server/tcp_in.ex`, this will handle all the commands coming in.
 ```elixir
 defmodule HelloWorldServer.TcpIn do
-  alias Teiserver.Api
-
   def data_in("ping" <> _data, state) do
     {state, "pong"}
   end
 
   def data_in("login " <> data, state) do
     [name, password] = String.split(data, " ")
-    case Api.maybe_authenticate_user(name, password) do
+    case Teiserver.maybe_authenticate_user_by_name(name, password) do
       {:ok, user} ->
-        Api.connect_user(user)
+        Teiserver.connect_user(user)
         {%{state | user_id: user.id}, "You are now logged in as '#{user.name}'"}
       {:error, :no_user} ->
         {state, "Login failed (no user)"}
@@ -145,7 +143,7 @@ defmodule HelloWorldServer.TcpIn do
     # this will do for the purposes of this example
     email = to_string(:rand.uniform())
 
-    case Api.register_user(name, email, password) do
+    case Teiserver.register_user(name, email, password) do
       {:ok, _user} ->
         {state, "User created, you can now login with 'login name password'"}
       {:error, _} ->
@@ -192,7 +190,7 @@ end
 ```
 
 ## Data out
-Place in `lib/hellow_world_server/tcp_out.ex`, this will handle sending data back to our users.
+Place in `lib/hello_world_server/tcp_out.ex`, this will handle sending data back to our users.
 ```elixir
 defmodule HelloWorldServer.TcpOut do
   def data_out(msg, state) do

documentation/guides/installation.md

@@ -6,7 +6,7 @@ First add to your dependencies in `mix.exs`.
 ```elixir
 def deps do
   [
-    {:teiserver, "~> 0.0.4"}
+    {:teiserver, "~> 0.0.5"}
   ]
 end
 ```

documentation/guides/match_lifecycle.md

@@ -1,8 +1,6 @@
 # Match lifecycle
 The main purpose of Teiserver is to facilitate running a game; as a result the Lobby and Match systems are one of the core features and have a lot of customisation and flexibility.
 
-In every case where the `Game` context is used there is a similar or identical function in `Api`.
-
 ### Overview
 There are multiple stages to a match taking place, they will typically follow the below diagram.
 ```mermaid
@@ -36,7 +34,7 @@ To remove a client from a lobby you will need to call `Teiserver.Game.remove_cli
 - The lobby state will be updated to remove this user from the member, spectator and player lists as appropriate
 
 ### Client updates
-Typically a client will update via `Teiserver.Connections.update_client/2` but if you want to update the lobby details of a client you should use `Teiserver.Connections.update_client_in_lobby/2`.
+Typically a client will update via `Teiserver.Connections.update_client/3` but if you want to update the lobby details of a client you should use `Teiserver.Connections.update_client_in_lobby/3`.
 
 The standard `update_client` only contacts the ClientServer to update values but with the `update_client_in_lobby` function the ClientServer will check with the LobbyServer before updating any details to ensure it is allowed to.
 
@@ -48,21 +46,21 @@ The standard `update_client` only contacts the ClientServer to update values but
 Lobbies have a key `:game_settings` which holds key-value map of the settings chosen for the upcoming match. These can be changed at any time prior to the match starting.
 
 ## Match start
-When the match is started and the users move into playing the game itself (which does not take place on the middleware server) a call needs to be made to `Api` or `Game` `start_match/1` (delegated to `Teiserver.Game.MatchLib.start_match/1`).
+When the match is started and the users move into playing the game itself (which does not take place on the middleware server) a call needs to be made to `Teiserver` or `Game` `start_match/1` (delegated to `Teiserver.Game.MatchLib.start_match/1`).
 
 This will update the previously added Match object with the relevant information from the Lobby. It will create `Teiserver.Game.MatchMembership` objects for each player, create the relevant `Teiserver.Game.MatchSetting` objects (along with types) and update the Lobby to show the match as ongoing.
 
 ## Playing the game
 While the game is ongoing the server is not directly involved except for anything the host wishes to relay to the server such as public chat or game telemetry events.
 
 ## Match end
-At the conclusion of the match players should be returned to the lobby interface and the `Api` or `Game` `end_match/2` (delegated to `Teiserver.Game.MatchLib.end_match/2`) should be called.
+At the conclusion of the match players should be returned to the lobby interface, you end it with and the `Teiserver` or `Game` `end_match/2` (delegated to `Teiserver.Game.MatchLib.end_match/2`) should be called.
 
 This will update both the Match object and MatchMembership objects with the relevant data.
 
 ## Post game
 ### Close
-In some cases you will want the lobby to close in which case `Api` or `Game` `close_lobby/1` (delegated to `Teiserver.Game.LobbyLib.close_lobby/1`) should be called. This will remove everybody from the lobby and stop the lobby process.
+In some cases you will want the lobby to close in which case `Teiserver` or `Game` `close_lobby/1` (delegated to `Teiserver.Game.LobbyLib.close_lobby/1`) should be called. This will remove everybody from the lobby and stop the lobby process.
 
 ### Cycle
-If you wish to keep the lobby in existence you should call `Api` or `Game` `cycle_lobby/1` (delegated to `Teiserver.Game.LobbyLib.cycle_lobby/1`) which will create a new empty Match object for the new upcoming match.
+If you wish to keep the lobby in existence you should call `Teiserver` or `Game` `cycle_lobby/1` (delegated to `Teiserver.Game.LobbyLib.cycle_lobby/1`) which will create a new empty Match object for the new upcoming match.