feat: support multiple versions of the pg-graphql extension (#1761)

* feat(pg_graphql): build multiple versions of the pg_graphql extension

Build multiple versions of the pg_graphql extension on different PostgreSQL versions.
Add test for the extensions and their upgrade on PostgreSQL 15 and 17.

* feat(cargo-pgrx): build extensions with specified Rust version

This change allows developers to target specific Rust versions for
building extensions. It implements support for building cargo extensions
and `cargo-pgrx` using the specified Rust version.

* Build pg_graphql 1.4.2 using pgrx 0.10.2

* Build pg_graphql 1.4.1 using pgrx 0.10.2

* Build pg_graphql 1.2.3 using pgrx 0.9.7

* Build pg_graphql 1.2.2 using pgrx 0.9.5

* Build pg_graphql 1.2.0 using pgx 0.7.1

* Build pg_graphql 1.1.0 using pgx 0.6.1

* Refactoring and build pg_graphql 1.0.2 using pgx 0.6.1

* chore: add release suffix for testing

* fix: conditional for using this linking only with macos

* fix: bindgen

* fix: apply bindgen fix for aarch64 to versions up to 1.5.1

The issue we face when building pg_graphql on aarch64 is:

`Invalid or unknown abi 16 for function "_ZGVnN4vv_atan2f"`

It has been fixed in bindgen 0.11.3.

* chore: use default nixos test to test pg_graphql extension

* fix(pg_graphql): migration script from 1.5.1-mergeless to 1.5.4

Add special case handling for 1.5.1-mergeless to 1.5.4 upgrade path.
Also replace CREATE FUNCTION with CREATE OR REPLACE FUNCTION to prevent conflicts
in migration scripts and the same for event triggers.

* fix: do not apply bindgen fix for version 1.5.4

pg_graphql 1.5.4 uses pgrx 0.11.3 which fixed the ABI issues on aarch64-linux.

* feat: run pg_regress tests during build

We don't recompile the extension using pgx with dev/debug symbols, but
we do run the pg_regress tests to ensure everything is working
correctly.

* chore: bump to release

---------

Co-authored-by: Sam Rose <[email protected]>

Author: 2 people

ansible/vars.yml

@@ -10,9 +10,9 @@ postgres_major:
 
 # Full version strings for each major version
 postgres_release:
-  postgresorioledb-17: 17.5.1.034-orioledb
-  postgres17: 17.6.1.013
-  postgres15: 15.14.1.013
+  postgresorioledb-17: "17.5.1.035-orioledb"
+  postgres17: "17.6.1.014"
+  postgres15: "15.14.1.014"
 
 # Non Postgres Extensions
 pgbouncer_release: 1.24.1

nix/cargo-pgrx/buildPgrxExtension.nix

@@ -53,6 +53,10 @@
   buildFeatures ? [ ],
   cargoBuildFlags ? [ ],
   postgresql,
+  # enable override to generate bindings using bindgenHook.
+  # Some older versions of cargo-pgrx use a bindgenHook that is not compatible with the
+  # current clang version present in stdenv
+  bindgenHook ? rustPlatform.bindgenHook,
   # cargo-pgrx calls rustfmt on generated bindings, this is not strictly necessary, so we avoid the
   # dependency here. Set to false and provide rustfmt in nativeBuildInputs, if you need it, e.g.
   # if you include the generated code in the output via postInstall.
@@ -87,12 +91,14 @@ let
     pushd "${buildAndTestSubdir}"
   '';
   maybeLeaveBuildAndTestSubdir = lib.optionalString (buildAndTestSubdir != null) "popd";
+  pgrxBinaryName = if builtins.compareVersions "0.7.4" cargo-pgrx.version >= 0 then "pgx" else "pgrx";
 
   pgrxPostgresMajor = lib.versions.major postgresql.version;
   preBuildAndTest = ''
     export PGRX_HOME=$(mktemp -d)
+    export PGX_HOME=$PGRX_HOME
     export PGDATA="$PGRX_HOME/data-${pgrxPostgresMajor}/"
-    cargo-pgrx pgrx init "--pg${pgrxPostgresMajor}" ${lib.getDev postgresql}/bin/pg_config
+    cargo-${pgrxBinaryName} ${pgrxBinaryName} init "--pg${pgrxPostgresMajor}" ${lib.getDev postgresql}/bin/pg_config
 
     # unix sockets work in sandbox, too.
     export PGHOST="$(mktemp -d)"
@@ -127,7 +133,7 @@ let
         cargo-pgrx
         postgresql
         pkg-config
-        rustPlatform.bindgenHook
+        bindgenHook
       ]
       ++ lib.optionals useFakeRustfmt [ fakeRustfmt ];
 
@@ -138,9 +144,10 @@ let
       ${preBuildAndTest}
       ${maybeEnterBuildAndTestSubdir}
 
-      PGRX_BUILD_FLAGS="--frozen -j $NIX_BUILD_CORES ${builtins.concatStringsSep " " cargoBuildFlags}" \
+      export PGRX_BUILD_FLAGS="--frozen -j $NIX_BUILD_CORES ${builtins.concatStringsSep " " cargoBuildFlags}"
+      export PGX_BUILD_FLAGS="$PGRX_BUILD_FLAGS"
       ${lib.optionalString stdenv.hostPlatform.isDarwin ''RUSTFLAGS="''${RUSTFLAGS:+''${RUSTFLAGS} }-Clink-args=-Wl,-undefined,dynamic_lookup"''} \
-      cargo pgrx package \
+      cargo ${pgrxBinaryName} package \
         --pg-config ${lib.getDev postgresql}/bin/pg_config \
         ${maybeDebugFlag} \
         --features "${builtins.concatStringsSep " " buildFeatures}" \
@@ -160,7 +167,7 @@ let
 
       ${maybeEnterBuildAndTestSubdir}
 
-      cargo-pgrx pgrx stop all
+      cargo-${pgrxBinaryName} ${pgrxBinaryName} stop all
 
       mv $out/${postgresql}/* $out
       mv $out/${postgresql.lib}/* $out

nix/cargo-pgrx/default.nix

@@ -20,13 +20,16 @@ let
       hash,
       cargoHash,
     }:
+    let
+      pname = if builtins.compareVersions "0.7.4" version >= 0 then "cargo-pgx" else "cargo-pgrx";
+    in
     rustPlatform.buildRustPackage rec {
       # rust-overlay uses 'cargo-auditable' wrapper for 'cargo' command, but it
       # is using older version 0.18.1 of 'cargo_metadata' which doesn't support
       # rust edition 2024, so we disable the 'cargo-auditable' just for now.
       # ref: https://github.com/oxalica/rust-overlay/issues/153
       auditable = false;
-      pname = "cargo-pgrx";
+      inherit pname;
       inherit version;
       src = fetchCrate { inherit version pname hash; };
       inherit cargoHash;

nix/cargo-pgrx/versions.json

@@ -1,4 +1,44 @@
 {
+  "0.6.1": {
+    "hash": "sha256-O4eHVbJBudybsPab+zr2eXnfheREMqLAHAKm2GDbfrs=",
+    "rust": {
+      "1.82.0": {
+        "cargoHash": "sha256-MucGrA3qXgJOcT2LMNmoNOhQi8QA3LuqgZEHKycLCCo="
+      }
+    }
+  },
+  "0.7.1": {
+    "hash": "sha256-t/gdlrBeP6KFkBFJiZUa8KKVJVYMf6753vQGKJdytss=",
+    "rust": {
+      "1.82.0": {
+        "cargoHash": "sha256-muce9wT4LAJmfNLWWEShARnpZgglXe/KrfxlitmGgXk="
+      }
+    }
+  },
+  "0.9.5": {
+    "hash": "sha256-GpXQUOBuojAqPXyRR+k8AVW2XzBbn6V0+2dhP4w4Vs8=",
+    "rust": {
+      "1.70.0": {
+        "cargoHash": "sha256-YbwGh3tbt8W9/VOu11fTWO9fRMUlrwJnG4wxUHuyX10="
+      }
+    }
+  },
+  "0.9.7": {
+    "hash": "sha256-uDBq7tUZ9f8h5nlRFR1mv4+Ty1OFtAk5P7OTNQPI1gI=",
+    "rust": {
+      "1.70.0": {
+        "cargoHash": "sha256-YTkjqMNF+cz5XtELh7+l8KwvRoVKQP7t98nkJwkW218="
+      }
+    }
+  },
+  "0.10.2": {
+    "hash": "sha256-FqjfbJmSy5UCpPPPk4bkEyvQCnaH9zYtkI7txgIn+ls=",
+    "rust": {
+      "1.70.0": {
+        "cargoHash": "sha256-syZ3cQq8qDHBLvqmNDGoxeK6zXHJ47Jwkw3uhaXNCzI="
+      }
+    }
+  },
   "0.11.2": {
     "hash": "sha256-8NlpMDFaltTIA8G4JioYm8LaPJ2RGKH5o6sd6lBHmmM=",
     "rust": {
@@ -57,5 +97,4 @@
       }
     }
   }
-
 }