⚠ This page is served via a proxy. Original site: https://github.com
This service does not collect credentials or authentication data.
Skip to content

feat: test pg_upgrade compatibility with older extension versions #1897

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jfroche wants to merge 4 commits into
base: develop
Choose a base branch
from
+548 −72
Open

feat: test pg_upgrade compatibility with older extension versions #1897

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
27270a3
feat: test pg_upgrade compatibility with older extension versions
jfroche Nov 6, 2025
e4af182
fix(pg_graphql): include unsupported versions as SQL-only for pg_upgr…
jfroche Nov 6, 2025
303ee4a
fix(pg_jsonschema): include unsupported versions as SQL-only for pg_u…
jfroche Nov 6, 2025
423dd3d
fix(pg_stat_monitor): exclude v1.0 from pg_upgrade compatibility tests
yvan-sraka Nov 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 48 additions & 3 deletions nix/ext/pg_graphql/default.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ let

preCheck = ''
export PGRX_HOME="$(mktemp -d)"
export PG_VERSION="${lib.versions.major postgresql.version}"
export PG_VERSION="${pgVersion}"
export NIX_PGLIBDIR="$PGRX_HOME/$PG_VERSION/lib"
export PATH="$PGRX_HOME/$PG_VERSION/bin:$PATH"
${lib.getExe rsync} --chmod=ugo+w -a ${postgresql}/ ${postgresql.lib}/ "$PGRX_HOME/$PG_VERSION/"
Expand Down Expand Up @@ -119,19 +119,64 @@ let
}
);
allVersions = (builtins.fromJSON (builtins.readFile ../versions.json)).pg_graphql;
pgVersion = lib.versions.major postgresql.version;
supportedVersions = lib.filterAttrs (
_: value: builtins.elem (lib.versions.major postgresql.version) value.postgresql
_: value: builtins.elem pgVersion value.postgresql
) allVersions;
versions = lib.naturalSort (lib.attrNames supportedVersions);
latestVersion = lib.last versions;
numberOfVersions = builtins.length versions;
packages = builtins.attrValues (
lib.mapAttrs (name: value: build name value.hash value.rust value.pgrx) supportedVersions
);
buildUnsupported =
# Build SQL-only packages for unsupported versions needed by pg_upgrade.
# When upgrading PostgreSQL, pg_upgrade requires old extension versions to exist
# even if they can't compile against the new PostgreSQL version.
version: hash: _rustVersion: _pgrxVersion:
stdenv.mkDerivation {
inherit pname version;
src = fetchFromGitHub {
owner = "supabase";
repo = pname;
rev = "v${version}";
inherit hash;
};
phases = [ "installPhase" ];
installPhase = ''
mkdir -p $out/share/postgresql/extension
for file in $src/sql/*.sql; do
filename=$(basename "$file")
if [[ "$filename" != "load_sql_config.sql" && "$filename" != "load_sql_context.sql" ]]; then
cat "$file"
echo ";"
fi
done > $out/share/postgresql/extension/${pname}--${version}.sql
'';
meta = with lib; {
description = "GraphQL support for PostreSQL";
homepage = "https://github.com/supabase/${pname}";
license = licenses.postgresql;
inherit (postgresql.meta) platforms;
};
};
unsupportedVersions = lib.filterAttrs (
_: value: !builtins.elem pgVersion value.postgresql
) allVersions;
unsupportedPackages =
if pgVersion == 15 then
[ ]
else
# Include SQL-only packages for PG15 extension versions incompatible with current PG
builtins.attrValues (
lib.mapAttrs (
name: value: buildUnsupported name value.hash value.rust value.pgrx
) unsupportedVersions
);
in
(buildEnv {
name = pname;
paths = packages;
paths = packages ++ unsupportedPackages;
pathsToLink = [
"/lib"
"/share/postgresql/extension"
Expand Down
21 changes: 12 additions & 9 deletions nix/ext/pg_jsonschema/default.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,9 @@ let

preCheck = ''
export PGRX_HOME=$(mktemp -d)
export NIX_PGLIBDIR=$PGRX_HOME/${lib.versions.major postgresql.version}/lib
${lib.getExe pkgs.rsync} --chmod=ugo+w -a ${postgresql}/ ${postgresql.lib}/ $PGRX_HOME/${lib.versions.major postgresql.version}/
cargo pgrx init --pg${lib.versions.major postgresql.version} $PGRX_HOME/${lib.versions.major postgresql.version}/bin/pg_config
export NIX_PGLIBDIR=$PGRX_HOME/${pgVersion}/lib
${lib.getExe pkgs.rsync} --chmod=ugo+w -a ${postgresql}/ ${postgresql.lib}/ $PGRX_HOME/${pgVersion}/
cargo pgrx init --pg${pgVersion} $PGRX_HOME/${pgVersion}/bin/pg_config
'';

# Tests are disabled for specific versions because pgrx tests require
Expand All @@ -92,12 +92,8 @@ let
"0.3.3"
]);

preBuild = ''
echo "Processing git tags..."
echo '${builtins.concatStringsSep "," previousVersions}' | sed 's/,/\n/g' > git_tags.txt
'';

postInstall = ''
find $out
mv $out/lib/${pname}${postgresql.dlSuffix} $out/lib/${pname}-${version}${postgresql.dlSuffix}

create_control_files() {
Expand Down Expand Up @@ -126,15 +122,18 @@ let
};
};
allVersions = (builtins.fromJSON (builtins.readFile ../versions.json)).pg_jsonschema;
pgVersion = lib.versions.major postgresql.version;
supportedVersions = lib.filterAttrs (
_: value: builtins.elem (lib.versions.major postgresql.version) value.postgresql
_: value: builtins.elem pgVersion value.postgresql
) allVersions;
versions = lib.naturalSort (lib.attrNames supportedVersions);
latestVersion = lib.last versions;
numberOfVersions = builtins.length versions;
packages = builtins.attrValues (
lib.mapAttrs (name: value: build name value.hash value.rust value.pgrx) supportedVersions
);
unsupportedVersionsItems = lib.filterAttrs (_: value: value.postgresql == [ "15" ]) allVersions;
unsupportedVersions = if pgVersion == "17" then lib.attrNames unsupportedVersionsItems else [ ];
in
(pkgs.buildEnv {
name = pname;
Expand All @@ -151,6 +150,10 @@ in
}"
)

for v in ${lib.concatStringsSep " " unsupportedVersions}; do
cp $out/share/postgresql/extension/${pname}--${lib.head versions}.sql $out/share/postgresql/extension/${pname}--$v.sql
done

create_sql_files() {
PREVIOUS_VERSION=""
while IFS= read -r i; do
Expand Down
11 changes: 8 additions & 3 deletions nix/ext/pg_stat_monitor.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,16 @@ let
) allVersions;

# Derived version information
versions = lib.naturalSort (lib.attrNames supportedVersions);
latestVersion = lib.last versions;
allVersionsList = lib.naturalSort (lib.attrNames supportedVersions);
versions = builtins.filter (v: (allVersions.${v}.pgUpgradeCompatible or true)) allVersionsList;
latestVersion = lib.last allVersionsList;
numberOfVersions = builtins.length versions;
# Filter to only build pg_upgrade compatible versions
pgUpgradeCompatibleVersions = lib.filterAttrs (
name: _: allVersions.${name}.pgUpgradeCompatible or true
) supportedVersions;
packages = builtins.attrValues (
lib.mapAttrs (name: value: build name value.hash value.revision) supportedVersions
lib.mapAttrs (name: value: build name value.hash value.revision) pgUpgradeCompatibleVersions
Comment on lines +20 to +29
Copy link

@coderabbitai coderabbitai bot Jan 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

Derive latestVersion from the pg_upgrade-compatible set.

latestVersion currently comes from allVersionsList (supported), while packages are built from pgUpgradeCompatibleVersions. If the newest supported version is marked pgUpgradeCompatible = false, no derivation will generate the default control file/symlink, and the post-build file-count check will fail. Consider sourcing latestVersion from the compatible list to keep build outputs consistent.

🛠️ Proposed fix 
-  latestVersion = lib.last allVersionsList;
+  latestVersion = lib.last versions;
🤖 Prompt for AI Agents 
In `@nix/ext/pg_stat_monitor.nix` around lines 20 - 29, latestVersion is computed
from allVersionsList but packages are built from pgUpgradeCompatibleVersions,
causing a mismatch if the newest supported version is not pgUpgradeCompatible;
change the latestVersion definition to derive from the pgUpgradeCompatible set
(e.g. use lib.last on the attrNames of pgUpgradeCompatibleVersions or on a
sorted list of pgUpgradeCompatible version keys) so latestVersion and packages
come from the same pg_upgrade-compatible collection (update the latestVersion
variable to reference pgUpgradeCompatibleVersions instead of allVersionsList).

);

# Build function for individual versions
Expand Down
38 changes: 32 additions & 6 deletions nix/ext/tests/default.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,9 +142,6 @@ let
};
testScript =
{ nodes, ... }:
let
pg17-configuration = "${nodes.server.system.build.toplevel}/specialisation/postgresql17";
in
''
from pathlib import Path
versions = {
Expand All @@ -153,7 +150,9 @@ let
}
extension_name = "${pname}"
support_upgrade = True
pg17_configuration = "${pg17-configuration}"
system = "${nodes.server.system.build.toplevel}"
pg15_configuration = system
pg17_configuration = f"{system}/specialisation/postgresql17"
ext_has_background_worker = ${
if (installedExtension "15") ? hasBackgroundWorker then "True" else "False"
}
Expand Down Expand Up @@ -209,6 +208,33 @@ let

with subtest("Check pg_regress with postgresql 17 after installing the last version"):
test.check_pg_regress(Path("${psql_17}/lib/pgxs/src/test/regress/pg_regress"), "17", pg_regress_test_name)

with subtest("Test pg_upgrade from postgresql 15 to 17 with older extension version"):
# Test that all extension versions from postgresql 15 can be upgraded to postgresql 17 using pg_upgrade
for version in versions["15"]:
server.systemctl("stop postgresql.service")
server.succeed("rm -fr /var/lib/postgresql/update_extensions.sql /var/lib/postgresql/17")
server.succeed(
f"{pg15_configuration}/bin/switch-to-configuration test >&2"
)
test.drop_extension()
test.install_extension(version)
server.succeed(
f"{pg17_configuration}/bin/switch-to-configuration test >&2"
)
has_update_script = server.succeed(
"test -f /var/lib/postgresql/update_extensions.sql && echo 'yes' || echo 'no'"
).strip() == "yes"
if has_update_script:
# Run the extension update script generated during the upgrade
test.run_sql_file("/var/lib/postgresql/update_extensions.sql")
# If there was an update script, the last version should be installed
test.assert_version_matches(versions["17"][-1])
else:
# Otherwise, the version should match the version from postgresql 15
test.assert_version_matches(version)

test.check_pg_regress(Path("${psql_17}/lib/pgxs/src/test/regress/pg_regress"), "17", pg_regress_test_name)
'';
};
in
Expand All @@ -232,10 +258,10 @@ builtins.listToAttrs (
"pg_hashids"
"pg_jsonschema"
"pg_net"
"pg_stat_monitor"
"pg_partman"
"pg_tle"
"pgaudit"
"pg_partman"
"postgis"
"vector"
"wal2json"
"wrappers"
Expand Down
2 changes: 1 addition & 1 deletion nix/ext/tests/lib.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ def run_sql_file(self, file: str) -> str:
).strip()

def drop_extension(self):
self.run_sql(f"DROP EXTENSION IF EXISTS {self.extension_name};")
self.run_sql(f"DROP EXTENSION IF EXISTS {self.extension_name} CASCADE;")

def install_extension(self, version: str):
if self.schema != "public":
Expand Down
Loading
Loading