8000 docs: updating for packaging and package updating by samrose · Pull Request #1157 · supabase/postgres · GitHub
[go: up one dir, main page]
Skip to content

docs: updating for packaging and package updating #1157

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

Merged
merged 6 commits into from
Aug 27, 2024
Merged

docs: updating for packaging and package updating #1157

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
343ec0d
docs: updating for packaging and package updating
samrose Aug 22, 2024
90d07d8
Update nix/docs/adding-new-package.md
samrose Aug 23, 2024
c1eb33e
Update nix/docs/adding-new-package.md
samrose Aug 23, 2024
7d8d5bb
Update nix/docs/adding-new-package.md
samrose Aug 23, 2024
7dd2705
Update nix/docs/update-extension.md
samrose Aug 23, 2024
d1cf398
Update nix/docs/adding-new-package.md
samrose Aug 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
8000 Failed to load files.
Loading
Diff view
Diff view
160 changes: 160 additions & 0 deletions nix/docs/adding-new-package.md
View file
Open in desktop
8000
Original file line number Diff line number Diff line change
@@ -0,0 +1,160 @@
# Adding a new extension package


## Pre-packaging steps
1. Make sure you have nix installed [Nix installer](https://github.com/DeterminateSystems/nix-installer)
2. Create a branch off of `develop`


## C/C++ postgres extensions

If you are creating a C/C++ extension, the pattern found in https://github.com/supabase/postgres/blob/develop/nix/ext/pgvector.nix will work well.

```
{ lib, stdenv, fetchFromGitHub, postgresql }:

stdenv.mkDerivation rec {
pname = "pgvector";
version = "0.7.4";

buildInputs = [ postgresql ];

src = fetchFromGitHub {
owner = "pgvector";
repo = pname;
rev = "refs/tags/v${version}";
hash = "sha256-qwPaguQUdDHV8q6GDneLq5MuhVroPizpbqt7f08gKJI=";
};

installPhase = ''
mkdir -p $out/{lib,share/postgresql/extension}

cp *.so $out/lib
cp sql/*.sql $out/share/postgresql/extension
cp *.control $out/share/postgresql/extension
'';

meta = with lib; {
description = "Open-source vector similarity search for Postgres";
homepage = "https://github.com/${src.owner}/${src.repo}";
maintainers = with maintainers; [ olirice ];
platforms = postgresql.meta.platforms;
license = licenses.postgresql;
};
}
```

This uses `stdenv.mkDerivation` which is a general nix builder for C and C++ projects (and others). It can auto detect the Makefile, and attempt to use it. ***It's a good practice to not have steps in the Makefile of your project that try to deal with OS specific system paths, or make calls out to the internet, as Nix cannot use these steps to build your project.***

Your build should produce all of the sql and control files needed for the install phase.

1. Once you have created this file, you can add it to `nix/ext/<yourname>.nix` and edit `flake.nix` and add it to the `ourExtensions` list.
2. `git add .` as nix uses git to track changes
3. In your package file, temporarily empty the `hash = "sha256<...>=";` to `hash = "";` and save and `git add .`
4. Run `nix build .#psql_15/exts/<yourname>` to try to trigger a build, nix will print the calculated sha256 value that you can add back the the `hash` variable, save the file again, and re-run `nix build .#psql_15/exts/<yourname>`.
5. Add any needed migrations into the `supabase/postgres` migrations directory.
6. You can then run tests locally to verify that the update of the package succeeded.
7. Now it's ready for PR review!

## Extensions written in Rust that use `buildPgrxExtension` builder

Extensions like:

* https://github.com/supabase/postgres/blob/develop/nix/ext/wrappers/default.nix
* https://github.com/supabase/postgres/blob/develop/nix/ext/pg_graphql.nix
* https://github.com/supabase/postgres/blob/develop/nix/ext/pg_jsonschema.nix

Are written in Rust, built with `cargo`, and need to use https://github.com/pgcentralfoundation/pgrx to build the extension.

We in turn have a special nix package `builder` which is sourced from `nixpkgs` and called `buildPgrxExtension`

A simple example is found in `pg_jsonschema`


```
{ lib, stdenv, fetchFromGitHub, postgresql, buildPgrxExtension_0_11_3, cargo }:

buildPgrxExtension_0_11_3 rec {
pname = "pg_jsonschema";
version = "0.3.1";
inherit postgresql;

src = fetchFromGitHub {
owner = "supabase";
repo = pname;
rev = "v${version}";
hash = "sha256-YdKpOEiDIz60xE7C+EzpYjBcH0HabnDbtZl23CYls6g=";
};

nativeBuildInputs = [ cargo ];
buildInputs = [ postgresql ];
# update the following array when the pg_jsonschema version is updated
# required to ensure that extensions update scripts from previous versions are generated

previousVersions = ["0.3.0" "0.2.0" "0.1.4" "0.1.4" "0.1.2" "0.1.1" "0.1.0"];
CARGO="${cargo}/bin/cargo";
env = lib.optionalAttrs stdenv.isDarwin {
POSTGRES_LIB = "${postgresql}/lib";
RUSTFLAGS = "-C link-arg=-undefined -C link-arg=dynamic_lookup";
};
cargoHash = "sha256-VcS+efMDppofuFW2zNrhhsbC28By3lYekDFquHPta2g=";

# FIXME (aseipp): testsuite tries to write files into /nix/store; we'll have
# to fix this a bit later.
doCheck = false;

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

postInstall = ''
echo "Creating SQL files for previous versions..."
current_version="${version}"
sql_file="$out/share/postgresql/extension/pg_jsonschema--$current_version.sql"

if [ -f "$sql_file" ]; then
while read -r previous_version; do
if [ "$(printf '%s\n' "$previous_version" "$current_version" | sort -V | head -n1)" = "$previous_version" ] && [ "$previous_version" != "$current_version" ]; then
new_file="$out/share/postgresql/extension/pg_jsonschema--$previous_version--$current_version.sql"
echo "Creating $new_file"
cp "$sql_file" "$new_file"
fi
done < git_tags.txt
else
echo "Warning: $sql_file not found"
fi
rm git_tags.txt
'';


meta = with lib; {
description = "JSON Schema Validation for PostgreSQL";
homepage = "https://github.com/supabase/${pname}";
maintainers = with maintainers; [ samrose ];
platforms = postgresql.meta.platforms;
license = licenses.postgresql;
};
}
```

Here we have built support in our overlay to specify and pin the version of `buildPgrxExtension` to a specific version (in this case `buildPgrxExtension_0_11_3`). This is currently the only version we can support, but this can be extended in our overlay https://github.com/supabase/postgres/blob/develop/nix/overlays/cargo-pgrx-0-11-3.nix to support other versions.

A few things about `buildPgrxExtension_x`:

* It doesn't support `buildPhase`, `installPhase` and those are implemented directly in the builder already
* It mostly just allows `cargo build` to do it's thing, but you may need to set env vars for the build process as seen above
* It caclulates a special `cargoHash` that will be generated after the first in `src` is generated, when running `nix build .#psql_15/exts/<yourname>` to build the extension


## Post Nix derivation release steps


1. You can add and run tests as described in https://github.com/supabase/postgres/blob/develop/nix/docs/adding-tests.md
2. You may need to add tests to our test.yml gh action workflow as well.
3. You can add the package and name and version to `ansible/vars.yml` it is not necessary to add the sha256 hash here, as the package is already built and cached in our release process before these vars are ever run.
4. to check that all your files will land in the overall build correctly, you can run `nix profile install .#psql_15/bin` on your machine, and check in `~/.nix-profile/bin, ~/.nix-profile/lib, ~/.nix-profile/share/postgresql/*` and you should see your lib, .control and sql files there.
5. You can also run `nix run .#start-server 15` and in a new terminal window run `nix run .#star-client-and-migrate 15` and try to `CREATE EXTENSION <yourname>` and work with it there
6. Check that your extension works with the `pg_upgrade` process (TODO documentation forthcoming)
7. Now you are ready to PR the extension
8. From here, the release process should typically take care of the rest.
75 changes: 10 additions & 65 deletions nix/docs/update-extension.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,69 +1,14 @@
Extensions are managed in two places: upstream, and this repository. Therefore
there are two update strategies available.

## Updating extensions in this repository
# Update an existing nix extension

Assuming that you run `nix develop` to get a development shell, there is a tool
named `nix-update` that is available:

```
austin@GANON:~/work/nix-postgres$ which nix-update
/nix/store/2jyq6h0ln3f5vlgz2had80l2crdkjmdy-nix-update-0.19.2/bin/nix-update
```
1. Create a branch off of `develop`
2. For instance, if we were updating https://github.com/supabase/postgres/blob/develop/nix/ext/supautils.nix we would:
1. change the `version = "2.2.1";` to whatever our git tag release version is that we want to update to
2. temporarily empty the `hash = "sha256-wSUEG0at00TPAoHv6+NMzuUE8mfW6fnHH0MNxvBdUiE=";` to `hash = "";` and save `supautils.nix` and `git add .`
3. run `nix build .#psql_15/exts/supautils` or the name of the extension to update, nix will print the calculated sha256 value that you can add back the the `hash` variable, save the file again, and re-run nix build .#psql_15/exts/supautils.
4. Add any needed migrations into the `supabase/postgres` migrations directory
5. You can then run tests locally to verify that the update of the package succeeded.
6. Now it's ready for PR review.


Run something like this to update the extension `pg_foobar`:

```bash
nix-update --flake psql_15/exts/pg_foobar
git commit -asm "pg_foobar: update to latest release"
```

It doesn't matter if you use `psql_15` or `psql_16` here, because `nix-update`
will look at the _file_ that extension is defined in, in order to update the
source code.

## Updating extensions upstream

You can use the same tool, `nix-update`, to do this. If you're sitting in the
root of the nixpkgs repository, try this:

```
nix run nixpkgs#nix-update -- postgresqlPackages.pg_foobar
git commit -asm "pg_foobar: update to latest release"
```

Because the tool may not be in your shell by default, we use `nix run` to run it
for us.

The full list of available names to substitute for `pg_foobar` is available in
the file
[pkgs/servers/sql/postgresql/packages.nix](https://github.com/NixOS/nixpkgs/blob/master/pkgs/servers/sql/postgresql/packages.nix)

### Updating the Nixpkgs snapshot

Now that your change is merged upstream, you need to update the version of
`nixpkgs` used in this repository:

- Check the `nixpkgs-unstable` branch:
https://github.com/nixos/nixpkgs/tree/nixpkgs-unstable
- Wait until your commit is fast-forwarded and part of that branch
- Run `nix flake update`

## Release tags versus latest trunk

By default, `nix-update` will update an expression to the latest tagged release.
No extra arguments are necessary. You can specify an exact release tag using the
`--version=<xyz>` flag. Using the syntax `--version=branch` means "update to the
latest version on the default branch."

<!-- ## Example PRs

- https://github.com/supabase/nix-postgres/pull/9 updates `pg_net` to the latest
release
- https://github.com/supabase/nix-postgres/pull/7 updates `pg_hashids` to the
latest `trunk` tip
-->
## Other notes

See issue [#5](https://github.com/supabase/nix-postgres/issues/5) for more
information about extension management.
Loading
0