chore: introduce minimal flake.nix (#336)

* feat: do not supress callback exceptions raised from calling callbacks

* fix: add explicit clauses for ConnectionClosedOK in send and heartbeat

* fix: change import order

* fix: apply ruff format

* feat: introduce flake.nix leveraging pyproject.nix

introduce flake.nix configuration leveraging the already existing
information in pyproject.toml, by using pyproject.nix to parse it and
generate the correct derivation. this way, any updates to
pyproject.toml should automatically be reflected in the flake
configuration, with low additional maintaining overhead required.

the only time when this may come as a problem is due to dependabot
constantly upgrading the packages to versions that do not exist yet in
nixpkgs. it may be required to force dependabot to also update the
nixpkgs version declared in the flake for it to not also break (or at
least to upgrade less often)

* chore: make `flake.nix` aware of dev dependencies, including ruff and pre-commit

by adding `dependency-groups`, `pyproject.nix` can now parse the
dependency groups and add these to the project, by passing `groups =
["dev"]` when calling the renderer.

special care was needed in order to expose `ruff` and `pre-commit` to
the toplevel of the environment. by default, it will treat them as
python dependencies and hide them in the python wrapper. by using
`groupBy`, we split the dependency list in "python" dependencies and
top level ones, such that they can be exposed.

sadly, these toplevel packages are not exposed in `python.pkgs` so we
must manually override them in a case by case basis.

* chore: refactor `dependencies-for`

* feat: add nix develop CI job

ensure that `nix develop` works on CI

* fix: change job name to be more compatible with the other actions

* feat: setup infra and run `python -m pytest` to run tests in nix setup action

do not rely on poetry to run tests, we'd like to not rely on it from
within the nix environment

* fix: do not rely on `npx` as its not on nix develop

use manual `supabase start` command instead

* fix: add `--command` typo

* chore: change name of nix develop command part

* feat: add coverage information and upload it to coveralls

* chore: run nix setup tests in both ubuntu and macos

* chore: undo macos latest as it apparently does not work

for some reason, `supabase start` does not seem to work on
`macos-latest` host in CI

* chore: switch from pylsp + mypy to pyright (basepyright)

it seems that pyright is better and faster than mypy in most if not
all cases, and the only reason I wasn't using it before is because it
was not working with eglot's default config.

* feat: add `basedpyright` to `pyproject.toml` instead of flake.nix only

this makes it available to all users, preparing for including it into
the standard CI later on

* fix: change back to python-lsp-server with pylsp-mypy

Author: o-santi

.github/workflows/ci.yml

@@ -43,6 +43,28 @@ jobs:
           flag-name: run-${{ join(matrix.*, '-') }}
           parallel: true
 
+  ensure_nix_setup_works:
+    name: Test / OS ubuntu-latest / nix develop
+    runs-on: ubuntu-latest
+    steps:
+      - name: Install nix
+        uses: cachix/install-nix-action@v31
+        with:
+          github_access_token: ${{ secrets.GITHUB_TOKEN }}
+      - name: Clone Repository
+        uses: actions/checkout@v4
+      - name: Start Supabase local development setup
+        run: nix develop --command supabase start --workdir infra -x studio,mailpit,edge-runtime,logflare,vector,supavisor,imgproxy,storage-api
+      - name: Run python tests through nix
+        run: nix develop --command python -m pytest --cov=realtime --cov-report=xml --cov-report=html -vv
+      - name: Upload coverage to Coveralls
+        uses: coverallsapp/github-action@v2
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          flag-name: run-ubuntu-latest-nix-develop
+          parallel: true
+
+
   finish_tests:
     needs: test
     name: Upload tests coveralls results

flake.lock

@@ -0,0 +1,56 @@
+{
+  description = "realtime-py: a Realtime python client.";
+
+  inputs = {
+    nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
+    pyproject-nix = {
+      url = "github:pyproject-nix/pyproject.nix";
+      inputs.nixpkgs.follows = "nixpkgs";
+    };
+  };
+
+  outputs = { nixpkgs, pyproject-nix, ... }: let
+    for-all-systems = f:
+      nixpkgs.lib.genAttrs [
+        "x86_64-linux"
+        "aarch64-darwin"
+        "aarch64-linux"
+        "x86_64-darwin"
+      ] (system: f nixpkgs.legacyPackages.${system});
+    project = pyproject-nix.lib.project.loadPyproject {
+      projectRoot = ./.;
+    };
+    dev-tools = pkgs: [
+      pkgs.supabase-cli
+    ];
+    dependencies-for = pkgs: let
+      # override to add top-level packages in nixpkgs as
+      # python3.pkgs packages, so that the renderers can find them
+      python = pkgs.python3.override {
+        packageOverrides = self: super: {
+          ruff = self.toPythonModule pkgs.ruff;
+          pre-commit = self.toPythonModule pkgs.pre-commit;
+          basedpyright = self.toPythonModule pkgs.basedpyright;
+        };
+      };
+      all-dependencies = project.renderers.withPackages {
+        inherit python;
+        groups = [ "dev" ];
+      };
+      dependencies = builtins.groupBy (pkg: if python.pkgs.hasPythonModule pkg then "python" else "toplevel") (all-dependencies python);
+    in {
+      python-env = python.buildEnv.override {
+        extraLibs = dependencies.python or [];
+      };
+      toplevel = dependencies.toplevel or [];
+    };
+  in {
+    devShells = for-all-systems (pkgs: let
+      inherit (dependencies-for pkgs) python-env toplevel;
+    in {
+      default = pkgs.mkShell {
+        packages = [ python-env ] ++ (dev-tools pkgs) ++ toplevel;
+      };
+    });
+  };
+}