chore: speed up CI

.github/workflows/main.yml

@@ -11,50 +11,73 @@ jobs:
         pg-version: ['12', '13', '14', '15', '16', '17']
 
     steps:
-      - uses: actions/checkout@v1
-      - uses: cachix/install-nix-action@v18
+      - uses: actions/checkout@v4
+
+      - name: Install Nix
+        uses: cachix/install-nix-action@v30
+
+      - name: Use Cachix Cache
+        uses: cachix/cachix-action@v10
         with:
-          nix_path: nixpkgs=channel:nixos-unstable
+          name: nxpg
+          authToken: ${{ secrets.CACHIX_AUTH_TOKEN }}
+
+      - name: Build
+        run: nix-shell --run "nxpg -v ${{ matrix.pg-version }} build"
 
       - name: Run tests
-        run: nix-shell --run "net-with-nginx net-with-pg-${{ matrix.pg-version }} python -m pytest -vv"
+        run: nix-shell --run "nxpg -v ${{ matrix.pg-version }} test"
 
-      #- name: Check C files are formatted
-        #run: nix-shell --run "net-check-format"
+  # solve https://github.com/supabase/pg_net/pull/178#issuecomment-2722690110
+  #test-on-macos:
+    #runs-on: macos-15
 
-  test-on-macos:
-    runs-on: macos-13
+    #strategy:
+      #matrix:
+        #pg-version: ['15']
 
-    strategy:
-      matrix:
-        pg-version: ['17']
+    #steps:
+      #- uses: actions/checkout@v4
 
-    steps:
-    - uses: actions/checkout@v4
-    - uses: cachix/install-nix-action@v30
-      with:
-        nix_path: nixpkgs=channel:nixos-unstable
-    - name: Run tests
-      run: nix-shell --run "net-with-nginx net-with-pg-${{ matrix.pg-version }} python -m pytest -vv"
+      #- name: Install Nix
+        #uses: cachix/install-nix-action@v30
+        #with:
+          #nix_path: nixpkgs=channel:nixos-unstable
+
+      #- name: Use Cachix Cache
+        #uses: cachix/cachix-action@v10
+        #with:
+          #name: nxpg
+          #authToken: ${{ secrets.CACHIX_AUTH_TOKEN }}
+
+      #- name: Build
+        #run: nix-shell --run "nxpg -v ${{ matrix.pg-version }} build"
+
+      #- name: Run tests
+        #run: nix-shell --run "nxpg -v ${{ matrix.pg-version }} test"
 
   coverage:
 
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
-        pg-version: ['16']
+        pg-version: ['17']
 
     steps:
       - uses: actions/checkout@v4
+
+      - name: Install Nix
+        uses: cachix/install-nix-action@v30
+
+      - name: Use Cachix Cache
+        uses: cachix/cachix-action@v10
         with:
-          submodules: true
-      - uses: cachix/install-nix-action@v18
-        with:
-          nix_path: nixpkgs=channel:nixos-unstable
+          name: nxpg
+          authToken: ${{ secrets.CACHIX_AUTH_TOKEN }}
 
-      - name: Run coverage
-        run: nix-shell --run "net-with-nginx net-with-pg-${{ matrix.pg-version }} nxpg-coverage"
+      - name: Coverage
+        run: nix-shell --run "nxpg -v ${{ matrix.pg-version }} coverage"
 
       - name: Send coverage to Coveralls
         uses: coverallsapp/[email protected]

Makefile

@@ -1,3 +1,6 @@
+SRC_DIR = src
+BUILD_DIR ?= build
+
 # the `-Wno`s quiet C90 warnings
 PG_CFLAGS = -std=c11 -Wextra -Wall -Werror \
 	-Wno-declaration-after-statement \
@@ -19,22 +22,36 @@ REGRESS = $(patsubst test/sql/%.sql,%,$(TESTS))
 REGRESS_OPTS = --use-existing --inputdir=test
 
 MODULE_big = $(EXTENSION)
-SRC = $(wildcard src/*.c)
-OBJS = $(patsubst src/%.c, src/%.o, $(SRC))
+SRC = $(wildcard $(SRC_DIR)/*.c)
+OBJS = $(patsubst $(SRC_DIR)/%.c, $(BUILD_DIR)/%.o, $(SRC))
 
 PG_CONFIG = pg_config
 SHLIB_LINK = -lcurl
 
 # Find <curl/curl.h> from system headers
 PG_CPPFLAGS := $(CPPFLAGS) -DEXTVERSION=\"$(EXTVERSION)\"
 
-all: $(EXTENSION)--$(EXTVERSION).sql $(EXTENSION).control
+build: $(BUILD_DIR)/$(EXTENSION).so $(BUILD_DIR)/$(EXTENSION)--$(EXTVERSION).sql $(BUILD_DIR)/$(EXTENSION).control
+
+$(BUILD_DIR)/.gitignore:
+	mkdir -p $(BUILD_DIR)
+	echo "*" > $(BUILD_DIR)/.gitignore
+
+$(BUILD_DIR)/%.o: $(SRC_DIR)/%.c $(BUILD_DIR)/.gitignore
+	$(CC) $(CPPFLAGS) $(CFLAGS) -c $< -o $@
 
-$(EXTENSION)--$(EXTVERSION).sql: sql/$(EXTENSION).sql
+$(BUILD_DIR)/$(EXTENSION)--$(EXTVERSION).sql: sql/$(EXTENSION).sql
 	cp $< $@
 
-$(EXTENSION).control:
-	sed "s/@PG_NET_VERSION@/$(EXTVERSION)/g" $(EXTENSION).control.in > $(EXTENSION).control
+$(BUILD_DIR)/$(EXTENSION).control:
+	sed "s/@PG_NET_VERSION@/$(EXTVERSION)/g" $(EXTENSION).control.in > $@
+
+$(BUILD_DIR)/$(EXTENSION).so: $(EXTENSION).so
+	mv $? $@
 
 PGXS := $(shell $(PG_CONFIG) --pgxs)
 include $(PGXS)
+
+.PHONY: test
+test:
+	net-with-nginx python -m pytest -vv

docs/contributing.md

@@ -3,21 +3,24 @@ pg_net is OSS. PR and issues are welcome.
 
 ## Development
 
-[Nix](https://nixos.org/download.html) is required to set up the environment.
+[Nix](https://nixos.org/download.html) is required to set up the environment and [Cachix](https://docs.cachix.org/installation) for cache usage.
+
 
 ### Testing
 
 For testing locally, execute:
 
 ```bash
+$ cachix use nxpg
+
 # might take a while in downloading all the dependencies
 $ nix-shell
 
 # test on pg 12
-$ net-with-pg-12 python -m pytest -vv
+$ nxpg -v 12 test
 
 # test on pg 13
-$ net-with-pg-13 python -m pytest -vv
+$ nxpg -v 13 test
 ```
 
 ### Debugging

nix/nxpg.nix

@@ -1,141 +1,11 @@
-{ stdenv, lib, makeWrapper, fetchurl, writeShellScriptBin, findutils, entr, callPackage, lcov, pidFileName, gnused, python3 } :
+{ fetchFromGitHub } :
 let
-  prefix = "nxpg";
-  ourPg = callPackage ./postgresql {
-    inherit lib;
-    inherit stdenv;
-    inherit fetchurl;
-    inherit makeWrapper;
-    inherit callPackage;
+  nxpg = fetchFromGitHub {
+    owner  = "steve-chavez";
+    repo   = "nxpg";
+    rev    = "v1.1";
+    sha256 = "sha256-R0Z2vDjFtkrFgetL1L/N1iWN0Bh+TWBZ7VZLDARJ3pY=";
   };
-  supportedPgs = [
-    ourPg.postgresql_17
-    ourPg.postgresql_16
-    ourPg.postgresql_15
-    ourPg.postgresql_14
-    ourPg.postgresql_13
-    ourPg.postgresql_12
-  ];
-  build =
-    writeShellScriptBin "${prefix}-build" ''
-      set -euo pipefail
-
-      make clean
-      make
-    '';
-  buildCov =
-    writeShellScriptBin "${prefix}-build-cov" ''
-      set -euo pipefail
-
-      make clean
-      make COVERAGE=1
-    '';
-  test =
-    writeShellScriptBin "${prefix}-test" ''
-      set -euo pipefail
-
-      ${python3}/bin/python -m pytest -vv "$@"
-    '';
-  cov =
-    writeShellScriptBin "${prefix}-coverage" ''
-      set -euo pipefail
-
-      info_file="coverage.info"
-      out_dir="coverage_html"
-
-      ${python3}/bin/python -m pytest -vv "$@"
-
-      ${lcov}/bin/lcov --capture --directory . --output-file "$info_file"
-
-      # remove postgres headers on the nix store, otherwise they show on the output
-      ${lcov}/bin/lcov --remove "$info_file" '/nix/*' --output-file "$info_file" || true
-
-      ${lcov}/bin/lcov --list coverage.info
-      ${lcov}/bin/genhtml "$info_file" --output-directory "$out_dir"
-
-      echo "${prefix}-coverage: To see the results, visit file://$(pwd)/$out_dir/index.html on your browser"
-    '';
-  watch =
-    writeShellScriptBin "${prefix}-watch" ''
-      set -euo pipefail
-
-      ${findutils}/bin/find . -type f \( -name '*.c' -o -name '*.h' \) | ${entr}/bin/entr -dr "$@"
-    '';
-
-  tmpDb =
-    writeShellScriptBin "${prefix}-tmp" ''
-      set -euo pipefail
-
-      export tmpdir="$(mktemp -d)"
-
-      export PGDATA="$tmpdir"
-      export PGHOST="$tmpdir"
-      export PGUSER=postgres
-      export PGDATABASE=postgres
-
-      trap 'pg_ctl stop -m i && rm -rf "$tmpdir" && rm ${pidFileName}' sigint sigterm exit
-
-      PGTZ=UTC initdb --no-locale --encoding=UTF8 --nosync -U "$PGUSER"
-
-      # pg versions older than 16 don't support adding "-c" to initdb to add these options
-      # so we just modify the resulting postgresql.conf to avoid an error
-      echo "dynamic_library_path='\$libdir:$(pwd)'" >> $PGDATA/postgresql.conf
-      echo "extension_control_path='\$system:$(pwd)'" >> $PGDATA/postgresql.conf
-
-      options="-F -c listen_addresses=\"\" -c log_min_messages=\"''${LOG_MIN_MESSAGES:-INFO}\" -k $PGDATA"
-
-      ext_options="-c shared_preload_libraries=\"pg_net\""
-
-      pg_ctl start -o "$options" -o "$ext_options"
-
-      psql -v ON_ERROR_STOP=1 -c "create database pre_existing" -d postgres
-
-      psql -v ON_ERROR_STOP=1 -c "create role pre_existing nosuperuser login" -d postgres
-
-      psql -v ON_ERROR_STOP=1 -c "create extension pg_net" -d postgres
-
-      psql -t -c "\o ${pidFileName}" -c "select pid from pg_stat_activity where backend_type ilike '%pg_net%'"
-
-      ${gnused}/bin/sed '/^''$/d;s/[[:blank:]]//g' -i ${pidFileName}
-
-      psql -f ${./bench.sql}
-
-      "$@"
-    '';
-    allPgPaths = map (pg:
-      let
-        ver = builtins.head (builtins.splitVersion pg.version);
-        script = ''
-          set -euo pipefail
-
-          export PATH=${pg}/bin:"$PATH"
-
-          "$@"
-        '';
-      in
-      writeShellScriptBin "${prefix}-${ver}" script
-    ) supportedPgs;
-
-    netWith = map (pg:
-        let
-          ver = builtins.head (builtins.splitVersion pg.version);
-          script = ''
-            set -euo pipefail
-            export PATH=${pg}/bin:"$PATH"
-            ${buildCov}/bin/${prefix}-build-cov
-            ${tmpDb}/bin/${prefix}-tmp "$@"
-          '';
-        in
-        writeShellScriptBin "net-with-pg-${ver}" script
-    ) supportedPgs;
+  script = import nxpg;
 in
-[
-  build
-  buildCov
-  test
-  cov
-  watch
-  tmpDb
-  allPgPaths
-  netWith
-]
+script