Maintenance 202604 (#25)

* add more edge case tests, increase consistency, add migrate notification, update packages

* optimize argument naming, fix typo, performance update for queries

* log access requests

* combine decorate db calls, return authoritative DB state

* update and fix tests, refactor decompose variant

* add backend caching option

* use only ocaml-setup dune cache

* updates from lint-fmt and lint-opam

* remove base and ppx_fields_conv dependency

* explicit version

* update dependency

* update discussions

* add lower bound

Author: mabiede

.github/workflows/ci.yml

@@ -9,13 +9,10 @@ on:
 jobs:
   build:
     name: Build and test
-
     runs-on: ubuntu-latest
-
     env:
       MYSQL_DATABASE: test
       MYSQL_ROOT_PASSWORD: password
-
     services:
       database:
         image: mariadb:10.6
@@ -24,74 +21,102 @@ jobs:
           MYSQL_ROOT_PASSWORD: ${{ env.MYSQL_ROOT_PASSWORD }}
         ports: ['3306:3306']
         options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3
-
     strategy:
       fail-fast: false
       matrix:
         ocaml-compiler:
-          - 4.14
-          - 5.2
-          - 5.3
+          - "4.14.3"
+          - "5.2.1"
+          - "5.3.0"
 
     steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-
-      - name: Retrieve opam cache
-        uses: actions/cache@v4
-        if: runner.os != 'Windows'
-        id: cache-opam
-        with:
-          path: ~/.opam
-          key: v1-${{ runner.os }}-opam-${{ matrix.ocaml-compiler }}-${{ hashFiles('*.opam.locked') }}
+      - name: Checkout repository
+        uses: actions/checkout@v6
 
-      - name: Use OCaml ${{ matrix.ocaml-version }}
+      - name: Use OCaml ${{ matrix.ocaml-compiler }}
         uses: ocaml/setup-ocaml@v3
         with:
           ocaml-compiler: ${{ matrix.ocaml-compiler }}
           dune-cache: true
-          opam-pin: true
 
       - name: Install system dependencies
         run: sudo apt-get update -y && sudo apt-get install -y libmariadb-dev
 
       - name: Install dependencies
         run: opam install --deps-only --with-test --with-doc -y .
 
-      - name: Recover from an Opam broken state
-        if: steps.cache-opam.outputs.cache-hit == 'true'
-        run: |
-          opam install -y dune
-          opam upgrade --fixup
-
       - name: Build
-        run: |
-          make build
-
-      - name: Check formatting
-        run: |
-          opam install -y ocamlformat
-          make format
+        run: make build
 
       - name: Run tests
         env:
           DATABASE_URL: mariadb://root:${{ env.MYSQL_ROOT_PASSWORD }}@127.0.0.1:3306/${{ env.MYSQL_DATABASE }}
         run: make test
 
-      - name: Build documentation
-        run: |
-          make doc
+      - uses: actions/upload-artifact@v6
+        if: failure()
+        with:
+          name: tests-${{ matrix.ocaml-compiler }}
+          path: _build/default/test/_build/_tests/
+
+      - name: Notify about failure
+        if: failure()
+        uses: ./.github/actions/notify-failure
+        with:
+          webhook: ${{ secrets.ECON_TEAMS_WEBHOOK }}
 
-      - uses: actions/upload-artifact@v4
+  lint-doc:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout tree
+        uses: actions/checkout@v6
+      - name: Install system dependencies
+        run: sudo apt-get update -y && sudo apt-get install -y libmariadb-dev
+      - name: Set-up OCaml
+        uses: ocaml/setup-ocaml@v3
         with:
-          name: documentation-${{ matrix.ocaml-compiler }}
+          ocaml-compiler: 5.3.0
+          opam-pin: true
+          dune-cache: true
+      - uses: ocaml/setup-ocaml/lint-doc@v3
+      - uses: actions/upload-artifact@v6
+        with:
+          name: documentation
           path: _build/default/_doc/_html
 
-      - uses: actions/upload-artifact@v4
+      - name: Notify about failure
         if: failure()
+        uses: ./.github/actions/notify-failure
         with:
-          name: tests-${{ matrix.ocaml-compiler }}
-          path: _build/default/test/_build/_tests/
+          webhook: ${{ secrets.ECON_TEAMS_WEBHOOK }}
+
+  lint-fmt:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout tree
+        uses: actions/checkout@v6
+      - name: Set-up OCaml
+        uses: ocaml/setup-ocaml@v3
+        with:
+          ocaml-compiler: 5.3.0
+      - uses: ocaml/setup-ocaml/lint-fmt@v3
+
+      - name: Notify about failure
+        if: failure()
+        uses: ./.github/actions/notify-failure
+        with:
+          webhook: ${{ secrets.ECON_TEAMS_WEBHOOK }}
+
+  lint-opam:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout tree
+        uses: actions/checkout@v6
+      - name: Set-up OCaml
+        uses: ocaml/setup-ocaml@v3
+        with:
+          ocaml-compiler: 5.3.0
+      - uses: ocaml/setup-ocaml/lint-opam@v3
 
       - name: Notify about failure
         if: failure()
@@ -102,17 +127,20 @@ jobs:
   deploy-doc:
     name: Deploy documentation
     runs-on: ubuntu-latest
-    needs: [build]
+    needs: [lint-doc]
     if: github.ref == 'refs/heads/main'
     environment:
       name: github-pages
       url: ${{ steps.deploy-doc.outputs.page_url }}
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
 
-      - name: Download all workflow run artifacts
-        uses: actions/download-artifact@v4
+      - name: Download documentation artifact
+        uses: actions/download-artifact@v8
+        with:
+          name: documentation
+          path: documentation
 
       - name: Deploy odoc to GitHub Pages
         uses: peaceiris/actions-gh-pages@v4
@@ -132,7 +160,7 @@ jobs:
     if: github.ref_type == 'tag'
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
 
       - name: Extract version changelog
         run: sed -nr "/^## .?v?${GITHUB_REF_NAME}/,/^## /p" CHANGELOG.md | sed '1d;2d;$d' > changes.md

.ocamlformat

@@ -1,3 +1,4 @@
+version = 0.29.0
 profile = janestreet
 parse-docstrings = true
 wrap-comments = true

Makefile

@@ -6,8 +6,7 @@ all:
 
 .PHONY: deps
 deps: ## Install development dependencies
-	opam install -y dune-release ocamlformat ocaml-lsp-server
-	opam install --deps-only --with-test --with-doc -y .
+	opam install --deps-only --with-test --with-doc --with-dev-setup -y .
 
 .PHONY: lock
 lock: ## Generate a lock file

README.md

@@ -70,7 +70,7 @@ Example usage:
 
 ## Development
 
-A guide how to setup the project with devcontainers can be found [here](./.devcontainer/README.md).
+A guide how to setup the project with devcontainers can be found in [this README](./.devcontainer/README.md).
 
 ### Commands
 

backend/database_pools.ml

@@ -48,7 +48,9 @@ module Make (Config : ConfigSig) = struct
       ; connection : connection [@opaque]
       ; n_retries : int
       }
-    [@@deriving fields]
+
+    let database_label { database_label; _ } = database_label
+    let connection { connection; _ } = connection
 
     let create ?(required = false) database_label database_url =
       { database_label
@@ -149,8 +151,8 @@ module Make (Config : ConfigSig) = struct
       Cache.remove name |> Lwt.return
   ;;
 
-  let initialize ?(additinal_pools : (string * string) list = []) () : unit =
-    Config.database :: additinal_pools
+  let initialize ?(additional_pools : (string * string) list = []) () : unit =
+    Config.database :: additional_pools
     |> CCList.filter (fst %> Cache.find_opt %> CCOption.is_none)
     |> CCList.iter (CCFun.uncurry (Pool.create ~required:true) %> Cache.replace)
   ;;
@@ -286,7 +288,8 @@ module Make (Config : ConfigSig) = struct
       Connection.rollback ()
       |> Lwt_result.map
            (CCFun.tap (fun _ ->
-              Logs.debug (fun m -> m "Successfully rolled back transaction")))
+              Logs.debug ~src (fun m ->
+                m "Successfully rolled back transaction")))
       |> raise_caqti_error label
     in
     Lwt.fail error

backend/database_pools_sig.ml

@@ -1,5 +1,5 @@
 module type Sig = sig
-  val initialize : ?additinal_pools:(string * string) list -> unit -> unit
+  val initialize : ?additional_pools:(string * string) list -> unit -> unit
 
   val fetch_pool
     :  ?ctx:(string * string) list

backend/dune

@@ -2,7 +2,6 @@
  (public_name guardian.backend)
  (name Guardian_backend)
  (libraries
-  base
   caqti
   caqti-driver-mariadb
   caqti-lwt
@@ -11,6 +10,7 @@
   containers-data
   guardian
   logs
+  lru
   lwt
   uri)
  (preprocess
@@ -21,5 +21,4 @@
    ppx_deriving.make
    ppx_deriving.ord
    ppx_deriving.show
-   ppx_fields_conv
    ppx_string)))