chore: add build targets to nix flake (coder#13186)

kylecarbs · code-asher · web-flow · commit 3e3118794f1e · 2024-05-06T18:21:20.000-04:00
* chore: add build targets to nix flake

Enables `nix build github:coder/coder#main`!

* Fix all packages

* Add back pnpm

* Update flake.nix

Co-authored-by: Asher &lt;ash@coder.com&gt;

* Remove yarn

* fmt

---------

Co-authored-by: Asher &lt;ash@coder.com&gt;
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -37,6 +37,7 @@ jobs:
       k8s: ${{ steps.filter.outputs.k8s }}
       ci: ${{ steps.filter.outputs.ci }}
       db: ${{ steps.filter.outputs.db }}
+      gomod: ${{ steps.filter.outputs.gomod }}
       offlinedocs-only: ${{ steps.filter.outputs.offlinedocs_count == steps.filter.outputs.all_count }}
       offlinedocs: ${{ steps.filter.outputs.offlinedocs }}
     steps:
@@ -90,6 +91,9 @@ jobs:
               - "scaletest/**"
               - "tailnet/**"
               - "testutil/**"
+            gomod:
+              - "go.mod"
+              - "go.sum"
             ts:
               - "site/**"
               - "Makefile"
@@ -108,6 +112,25 @@ jobs:
         run: |
           echo "${{ toJSON(steps.filter )}}"
 
+  update-flake:
+    needs: changes
+    if: needs.changes.outputs.gomod == 'true'
+    runs-on: ${{ github.repository_owner == 'coder' && 'buildjet-8vcpu-ubuntu-2204' || 'ubuntu-latest' }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
+
+      - name: Setup Go
+        uses: ./.github/actions/setup-go
+
+      - name: Update Nix Flake SRI Hash
+        run: ./scripts/update-flake.sh
+
+      - name: Ensure No Changes
+        run: git diff --exit-code
+
   lint:
     needs: changes
     if: needs.changes.outputs.offlinedocs-only == 'false' || needs.changes.outputs.ci == 'true' || github.ref == 'refs/heads/main'
diff --git a/flake.lock b/flake.lock
diff --git a/flake.nix b/flake.nix
@@ -4,25 +4,29 @@
   inputs = {
     nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
     flake-utils.url = "github:numtide/flake-utils";
+    pnpm2nix.url = "github:nzbr/pnpm2nix-nzbr";
     drpc.url = "github:storj/drpc/v0.0.33";
   };
 
-  outputs = { self, nixpkgs, flake-utils, drpc }:
+  outputs = { self, nixpkgs, flake-utils, drpc, pnpm2nix }:
     flake-utils.lib.eachDefaultSystem (system:
       let
         # Workaround for: terraform has an unfree license (‘bsl11’), refusing to evaluate.
         pkgs = import nixpkgs { inherit system; config.allowUnfree = true; };
-        formatter = pkgs.nixpkgs-fmt;
         nodejs = pkgs.nodejs-18_x;
-        yarn = pkgs.yarn.override { inherit nodejs; };
         # Check in https://search.nixos.org/packages to find new packages.
         # Use `nix --extra-experimental-features nix-command --extra-experimental-features flakes flake update`
         # to update the lock file if packages are out-of-date.
 
         # From https://nixos.wiki/wiki/Google_Cloud_SDK
-        gdk = pkgs.google-cloud-sdk.withExtraComponents ([pkgs.google-cloud-sdk.components.gke-gcloud-auth-plugin]);
+        gdk = pkgs.google-cloud-sdk.withExtraComponents ([ pkgs.google-cloud-sdk.components.gke-gcloud-auth-plugin ]);
 
+        # The minimal set of packages to build Coder.
         devShellPackages = with pkgs; [
+          # google-chrome is not available on OSX
+          (if pkgs.stdenv.hostPlatform.isDarwin then null else google-chrome)
+          # strace is not available on OSX
+          (if pkgs.stdenv.hostPlatform.isDarwin then null else strace)
           bat
           cairo
           curl
@@ -31,24 +35,20 @@
           gcc
           gdk
           getopt
-          git
           gh
+          git
           gnumake
           gnused
           go_1_21
           go-migrate
           golangci-lint
-          # google-chrome is not available on OSX
-          (if pkgs.stdenv.hostPlatform.isDarwin then null else google-chrome)
           gopls
           gotestsum
           jq
           kubectl
           kubectx
           kubernetes-helm
           less
-          # Needed for many LD system libs!
-          util-linux
           mockgen
           nfpm
           nodejs
@@ -67,34 +67,84 @@
           shellcheck
           shfmt
           sqlc
-          # strace is not available on OSX
-          (if pkgs.stdenv.hostPlatform.isDarwin then null else strace)
           terraform
           typos
+          # Needed for many LD system libs!
+          util-linux
           vim
           wget
-          yarn
           yq-go
           zip
           zsh
           zstd
         ];
 
-        allPackages = pkgs.buildEnv {
-          name = "all-packages";
-          paths = devShellPackages;
+        # buildSite packages the site directory.
+        buildSite = pnpm2nix.packages.${system}.mkPnpmPackage {
+          src = ./site/.;
+          # Required for the `canvas` package!
+          extraBuildInputs = with pkgs; [ pkgs.cairo pkgs.pango pkgs.pixman ];
+          installInPlace = true;
+          distDir = "out";
         };
+
+        version = "v0.0.0-nix-${self.shortRev or self.dirtyShortRev}";
+
+        # To make faster subsequent builds, you could extract the `.zst`
+        # slim bundle into it's own derivation.
+        buildFat = osArch:
+          pkgs.buildGo121Module {
+            name = "coder-${osArch}";
+            # Updated with ./scripts/update-flake.nix`.
+            # This should be updated whenever go.mod changes!
+            vendorHash = "sha256-pTRr85MtdlsI0iYGAwLAQ3QvtrDR8rDOynYx8FDaRy0=";
+            proxyVendor = true;
+            src = ./.;
+            nativeBuildInputs = with pkgs; [ getopt openssl zstd ];
+            preBuild = ''
+              # Replaces /usr/bin/env with an absolute path to the interpreter.
+              patchShebangs ./scripts
+            '';
+            buildPhase = ''
+              runHook preBuild
+
+              # Unpack the site contents.
+              mkdir -p ./site/out
+              cp -r ${buildSite.out}/* ./site/out
+
+              # Build and copy the binary!
+              export CODER_FORCE_VERSION=${version}
+              make -j build/coder_${osArch}
+            '';
+            installPhase = ''
+              mkdir -p $out/bin
+              cp -r ./build/coder_${osArch} $out/bin/coder
+            '';
+          };
       in
       {
-        defaultPackage = formatter; # or replace it with your desired default package.
         devShell = pkgs.mkShell {
-        buildInputs = devShellPackages;
-        shellHook = ''
-          export PLAYWRIGHT_BROWSERS_PATH=${pkgs.playwright-driver.browsers}
-          export PLAYWRIGHT_SKIP_VALIDATE_HOST_REQUIREMENTS=true
-        '';
+          buildInputs = devShellPackages;
+          shellHook = ''
+            export PLAYWRIGHT_BROWSERS_PATH=${pkgs.playwright-driver.browsers}
+            export PLAYWRIGHT_SKIP_VALIDATE_HOST_REQUIREMENTS=true
+          '';
+        };
+        packages = {
+          all = pkgs.buildEnv {
+            name = "all-packages";
+            paths = devShellPackages;
+          };
+          site = buildSite;
+
+          # Copying `OS_ARCHES` from the Makefile.
+          linux_amd64 = buildFat "linux_amd64";
+          linux_arm64 = buildFat "linux_arm64";
+          darwin_amd64 = buildFat "darwin_amd64";
+          darwin_arm64 = buildFat "darwin_arm64";
+          windows_amd64 = buildFat "windows_amd64.exe";
+          windows_arm64 = buildFat "windows_arm64.exe";
         };
-        packages.all = allPackages;
       }
     );
 }
diff --git a/scripts/lib.sh b/scripts/lib.sh
@@ -43,6 +43,9 @@ SCRIPT="${BASH_SOURCE[1]:-${BASH_SOURCE[0]}}"
 SCRIPT_DIR="$(realpath "$(dirname "$SCRIPT")")"
 
 function project_root {
+	# Nix sets $src in derivations!
+	[[ -n "${src:-}" ]] && echo "$src" && return
+
 	# Try to use `git rev-parse --show-toplevel` to find the project root.
 	# If this directory is not a git repository, this command will fail.
 	git rev-parse --show-toplevel 2>/dev/null && return
diff --git a/scripts/update-flake.sh b/scripts/update-flake.sh
@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+# Updates SRI hashes for flake.nix.
+
+set -eu
+
+cd "$(dirname "${BASH_SOURCE[0]}")/.."
+
+OUT=$(mktemp -d -t nar-hash-XXXXXX)
+
+echo "Downloading Go modules..."
+GOPATH="$OUT" go mod download
+echo "Calculating SRI hash..."
+HASH=$(go run tailscale.com/cmd/nardump --sri "$OUT/pkg/mod/cache/download")
+sudo rm -rf "$OUT"
+
+sed -i "s/\(vendorHash = \"\)[^\"]*/\1${HASH}/" ./flake.nix
diff --git a/site/package.json b/site/package.json
@@ -184,6 +184,6 @@
   },
   "engines": {
     "npm": ">=9.0.0 <10.0.0",
-    "node": ">=18.0.0 <19.0.0"
+    "node": ">=18.0.0 <21.0.0"
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -184,6 +184,6 @@`
`184`	`184`	`},`
`185`	`185`	`"engines": {`
`186`	`186`	`"npm": ">=9.0.0 <10.0.0",`
`187`		`- "node": ">=18.0.0 <19.0.0"`
	`187`	`+ "node": ">=18.0.0 <21.0.0"`
`188`	`188`	`}`
`189`	`189`	`}`