feat: included ets_store and postgres_store

Author: Max Hill

.github/workflows/publish.yml

@@ -9,6 +9,20 @@ on:
 jobs:
   test:
     runs-on: ubuntu-latest
+    services:
+      postgres:
+        image: postgres # Docker Hub image
+        env:
+          POSTGRES_PASSWORD: mySuperSecretPassword!
+        # Set health checks to wait until postgres has started
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          # Maps tcp port 5432 on service container to the host
+          - 5432:5432
     steps:
       - uses: actions/checkout@v4
       - uses: erlef/setup-beam@v1

.github/workflows/test.yml

@@ -10,14 +10,25 @@ on:
 jobs:
   test:
     runs-on: ubuntu-latest
+    services:
+      postgres:
+        image: postgres # Docker Hub image
+        env:
+          POSTGRES_PASSWORD: "mySuperSecretPassword!"
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
     steps:
       - uses: actions/checkout@v4
       - uses: erlef/setup-beam@v1
         with:
           otp-version: "26.0.2"
           gleam-version: "1.4.1"
           rebar3-version: "3"
-          # elixir-version: "1.15.4"
       - run: gleam deps download
       - run: gleam test
       - run: gleam format --check src test

README.md

@@ -152,29 +152,28 @@ which may become a bottleneck under heavy loads.
 ```gleam
 import wisp_kv_sessions/actor_store
 
-use session_store <- result.map(actor_store.try_create_session_store())
+use session_store <- result.map(actor_store.new())
 
 // ...
 ```
 See `./example/src/app.gleam` for full example
 
 ### postgress_store
-The postgres_store uses a [gleam/pgo](https://hexdocs.pm/gleam_pgo/gleam/pgo.html) 
-connection to store the session information in postgres.
-
-```sh
-gleam add wisp_kv_sessions_postgres_store
-```
+Also included is the postgres_store, that allows you to use postgres as 
+the storage implementation
 
 ```gleam
 import wisp_kv_sessions/postgres_store
 
-let db = pgo.connect(pgo.default_config())
+let db = 
+  pog.default_config()
+  |> pog.connect()
+
 // Migrate
 use _ <- result.try(postgres_store.migrate_up(conn))
 
 // Setup session_store
-use session_store <- result.map(postgres_store.try_create_session_store(conn))
+use session_store <- result.map(postgres_store.new(conn))
 
 //...
 ```
@@ -187,15 +186,11 @@ The ets_store uses [Erlang Term Storage](https://www.erlang.org/doc/apps/stdlib/
 and [carpenter](https://hexdocs.pm/carpenter/) to store session information.
 *This will NOT be persistant after restarts*. But is a good option for caching.
 
-```sh
-gleam add wisp_kv_sessions_ets_store
-```
-
 ```gleam
 import wisp_kv_sessions/ets_store
 
 // Setup session_store
-use session_store <- result.map(postgres_store.try_create_session_store(conn))
+use session_store <- result.map(ets_store.new(conn))
 
 //...
 ```

gleam.toml

@@ -21,6 +21,8 @@ gleam_crypto = ">= 1.3.0 and < 2.0.0"
 gleam_otp = ">= 0.10.0 and < 1.0.0"
 gleam_erlang = ">= 0.25.0 and < 1.0.0"
 gleam_http = ">= 3.6.0 and < 4.0.0"
+pog = ">= 1.0.0 and < 2.0.0"
+carpenter = ">= 0.3.1 and < 1.0.0"
 
 [dev-dependencies]
 gleeunit = ">= 1.0.0 and < 2.0.0"

justfile

@@ -1,3 +1,35 @@
+#!/usr/bin/env just --justfile
+# SETTINGS
+# set dotenv-load := true
+export DB_PASSWORD:="mySuperSecretPassword!" # Remember to update the DATABASE_URL
+export DB_PORT:="6433" # Remember to update the DATABASE_URL
+export DB_TAG:="wisp_kv_sessions"
+export DB_HOST:="127.0.0.1"
+export DB_USER:="postgres"
+export DB_NAME:="postgres"
+# export DATABASE_URL :="postgres://postgres:mySuperSecretPassword!@localhost:6433/postgres?sslmode=disable"
 
-watch-test:
+watch_test:
+    @just db_run &>/dev/null&
+    @just wait-for-db
     watchexec --restart --verbose --clear --wrap-process=session --stop-signal SIGTERM --exts gleam --watch ./ -- "gleam test"
+
+test:
+    @just db_run &>/dev/null&
+    @just wait-for-db
+    gleam test
+
+
+# DB
+db_run:
+    docker run \
+     --rm \
+     -p $DB_PORT:5432 \
+     -e POSTGRES_PASSWORD=$DB_PASSWORD \
+     -e POSTGRES_USER=$DB_USER \
+     --name $DB_TAG \
+     postgres
+
+wait-for-db:
+    until PGPASSWORD="$DB_PASSWORD" psql -h "$DB_HOST" -U "$DB_USER" -p "$DB_PORT" -c '\q' 2>/dev/null; do echo "Waiting for database..."; sleep 2; done; echo "Database is up!"
+

manifest.toml

@@ -2,7 +2,9 @@
 # You typically do not need to edit this file
 
 packages = [
+  { name = "backoff", version = "1.1.6", build_tools = ["rebar3"], requirements = [], otp_app = "backoff", source = "hex", outer_checksum = "CF0CFFF8995FB20562F822E5CC47D8CCF664C5ECDC26A684CBE85C225F9D7C39" },
   { name = "birl", version = "1.7.1", build_tools = ["gleam"], requirements = ["gleam_stdlib", "ranger"], otp_app = "birl", source = "hex", outer_checksum = "5C66647D62BCB11FE327E7A6024907C4A17954EF22865FE0940B54A852446D01" },
+  { name = "carpenter", version = "0.3.1", build_tools = ["gleam"], requirements = ["gleam_erlang", "gleam_stdlib"], otp_app = "carpenter", source = "hex", outer_checksum = "7F5AF15A315CF32E8EDD0700BC1E6711618F8049AFE66DFCE82D1161B33F7F1B" },
   { name = "exception", version = "2.0.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "exception", source = "hex", outer_checksum = "F5580D584F16A20B7FCDCABF9E9BE9A2C1F6AC4F9176FA6DD0B63E3B20D450AA" },
   { name = "filepath", version = "1.0.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "filepath", source = "hex", outer_checksum = "EFB6FF65C98B2A16378ABC3EE2B14124168C0CE5201553DE652E2644DCFDB594" },
   { name = "gleam_crypto", version = "1.3.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleam_crypto", source = "hex", outer_checksum = "ADD058DEDE8F0341F1ADE3AAC492A224F15700829D9A3A3F9ADF370F875C51B7" },
@@ -18,6 +20,10 @@ packages = [
   { name = "logging", version = "1.3.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "logging", source = "hex", outer_checksum = "1098FBF10B54B44C2C7FDF0B01C1253CAFACDACABEFB4B0D027803246753E06D" },
   { name = "marceau", version = "1.2.0", build_tools = ["gleam"], requirements = [], otp_app = "marceau", source = "hex", outer_checksum = "5188D643C181EE350D8A20A3BDBD63AF7B6C505DE333CFBE05EF642ADD88A59B" },
   { name = "mist", version = "1.2.0", build_tools = ["gleam"], requirements = ["birl", "gleam_erlang", "gleam_http", "gleam_otp", "gleam_stdlib", "glisten", "gramps", "hpack_erl", "logging"], otp_app = "mist", source = "hex", outer_checksum = "109B4D64E68C104CC23BB3CC5441ECD479DD7444889DA01113B75C6AF0F0E17B" },
+  { name = "opentelemetry_api", version = "1.4.0", build_tools = ["rebar3", "mix"], requirements = [], otp_app = "opentelemetry_api", source = "hex", outer_checksum = "3DFBBFAA2C2ED3121C5C483162836C4F9027DEF469C41578AF5EF32589FCFC58" },
+  { name = "pg_types", version = "0.4.0", build_tools = ["rebar3"], requirements = [], otp_app = "pg_types", source = "hex", outer_checksum = "B02EFA785CAECECF9702C681C80A9CA12A39F9161A846CE17B01FB20AEEED7EB" },
+  { name = "pgo", version = "0.14.0", build_tools = ["rebar3"], requirements = ["backoff", "opentelemetry_api", "pg_types"], otp_app = "pgo", source = "hex", outer_checksum = "71016C22599936E042DC0012EE4589D24C71427D266292F775EBF201D97DF9C9" },
+  { name = "pog", version = "1.0.0", build_tools = ["gleam"], requirements = ["gleam_stdlib", "pgo"], otp_app = "pog", source = "hex", outer_checksum = "00D57120936AFBF486BE357C472E483C1F0CA507FF9C3668075E87C733CA53F8" },
   { name = "ranger", version = "1.2.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "ranger", source = "hex", outer_checksum = "1566C272B1D141B3BBA38B25CB761EF56E312E79EC0E2DFD4D3C19FB0CC1F98C" },
   { name = "simplifile", version = "2.0.1", build_tools = ["gleam"], requirements = ["filepath", "gleam_stdlib"], otp_app = "simplifile", source = "hex", outer_checksum = "5FFEBD0CAB39BDD343C3E1CCA6438B2848847DC170BA2386DF9D7064F34DF000" },
   { name = "thoas", version = "1.2.1", build_tools = ["rebar3"], requirements = [], otp_app = "thoas", source = "hex", outer_checksum = "E38697EDFFD6E91BD12CEA41B155115282630075C2A727E7A6B2947F5408B86A" },
@@ -26,11 +32,13 @@ packages = [
 
 [requirements]
 birl = { version = ">= 1.7.1 and < 2.0.0" }
+carpenter = { version = ">= 0.3.1 and < 1.0.0" }
 gleam_crypto = { version = ">= 1.3.0 and < 2.0.0" }
 gleam_erlang = { version = ">= 0.25.0 and < 1.0.0" }
 gleam_http = { version = ">= 3.6.0 and < 4.0.0" }
 gleam_json = { version = ">= 1.0.1 and < 2.0.0" }
 gleam_otp = { version = ">= 0.10.0 and < 1.0.0" }
 gleam_stdlib = { version = ">= 0.34.0 and < 2.0.0" }
 gleeunit = { version = ">= 1.0.0 and < 2.0.0" }
+pog = { version = ">= 1.0.0 and < 2.0.0" }
 wisp = { version = ">= 0.16.0" }

src/wisp_kv_sessions.gleam

@@ -111,7 +111,7 @@ pub fn set(
   let json_data = encoder(data)
   let new_session =
     session.builder_from(session)
-    |> session.set_key_value(key, json_data)
+    |> session.with_entry(key, json_data)
     |> session.build
   use _ <- result.map(save_session(config, new_session))
   data

src/wisp_kv_sessions/actor_store.gleam

@@ -24,7 +24,7 @@ type Message(element) {
 type Db =
   dict.Dict(session.SessionId, session.Session)
 
-pub fn try_create_session_store() {
+pub fn new() {
   use db <- result.map(
     actor.start(dict.new(), handle_message)
     |> result.replace_error(session.DbSetupError),

src/wisp_kv_sessions/ets_store.gleam

@@ -0,0 +1,62 @@
+import carpenter/table
+import gleam/list
+import gleam/option
+import wisp_kv_sessions/session
+import wisp_kv_sessions/session_config
+
+pub fn new(table_name) {
+  let db = new_table(table_name)
+  session_config.SessionStore(
+    get_session: get_session(db),
+    save_session: save_session(db),
+    delete_session: delete_session(db),
+  )
+}
+
+pub fn new_table(table_name) -> table.Set(String, session.Session) {
+  // Set up and configure an ETS table
+  let assert Ok(table) =
+    table.build(table_name)
+    |> table.privacy(table.Private)
+    |> table.write_concurrency(table.AutoWriteConcurrency)
+    |> table.read_concurrency(True)
+    |> table.decentralized_counters(True)
+    |> table.compression(False)
+    |> table.set
+
+  table
+}
+
+fn get_session(db) {
+  fn(session_id: session.SessionId) {
+    let res =
+      db
+      |> table.lookup(session.id_to_string(session_id))
+      |> list.first
+
+    case res {
+      Ok(tup) -> {
+        Ok(option.Some(tup.1))
+      }
+      Error(_) -> {
+        Ok(option.None)
+      }
+    }
+  }
+}
+
+fn save_session(db) {
+  fn(new_session: session.Session) {
+    db
+    |> table.insert([#(session.id_to_string(new_session.id), new_session)])
+    Ok(new_session)
+  }
+}
+
+fn delete_session(db) {
+  fn(session_id: session.SessionId) {
+    db
+    |> table.delete(session.id_to_string(session_id))
+    Ok(Nil)
+  }
+}