[Regression] Fix psycopg2 version install

.changes/unreleased/Fixes-20240605-202614.yaml

@@ -0,0 +1,7 @@
+kind: Fixes
+body: Default to psycopg2-binary and allow overriding to psycopg2 via DBT_PSYCOPG2_NAME
+  (restores previous behavior)
+time: 2024-06-05T20:26:14.801254-04:00
+custom:
+  Author: mikealfare
+  Issue: "96"

.github/workflows/integration-tests.yml

@@ -102,24 +102,60 @@ jobs:
 
   psycopg2-check:
     name: "Test psycopg2 build version"
-    runs-on: ${{ matrix.scenario.platform }}
+    runs-on: ${{ matrix.platform }}
     strategy:
       fail-fast: false
       matrix:
-        scenario:
-          - {platform: ubuntu-latest, psycopg2-name: psycopg2}
-          - {platform: macos-12, psycopg2-name: psycopg2-binary}
+        platform:
+          - ubuntu-24.04
+          - macos-12
     steps:
       - name: "Check out repository"
         uses: actions/checkout@v4
 
-      - name: "Test psycopg2 name"
+      - name: "Test psycopg2 name - default"
         run: |
-          python -m pip install .
-          PSYCOPG2_PIP_ENTRY=$(pip list | grep "psycopg2 " || pip list | grep psycopg2-binary)
+          pip install --upgrade --force-reinstall .
+          PSYCOPG2_PIP_ENTRY=$(hatch run pip list | grep "psycopg2 " || hatch run pip list | grep psycopg2-binary)
+
+          echo $PSYCOPG2_PIP_ENTRY
+          PSYCOPG2_NAME="${PSYCOPG2_PIP_ENTRY%% *}"
+          echo $PSYCOPG2_NAME
+
+          if [[ "$PSYCOPG2_NAME" != "$PSYCOPG2_EXPECTED_NAME" ]]; then
+            exit 1
+          fi
+        env:
+          PSYCOPG2_EXPECTED_NAME: psycopg2-binary
+
+      - name: "Test psycopg2 name - invalid override"
+        run: |
+          pip install --upgrade --force-reinstall .
+          PSYCOPG2_PIP_ENTRY=$(hatch run pip list | grep "psycopg2 " || hatch run pip list | grep psycopg2-binary)
+
           echo $PSYCOPG2_PIP_ENTRY
           PSYCOPG2_NAME="${PSYCOPG2_PIP_ENTRY%% *}"
           echo $PSYCOPG2_NAME
-          if [[ "${PSYCOPG2_NAME}" != "${{ matrix.scenario.psycopg2-name }}" ]]; then
+
+          if [[ "$PSYCOPG2_NAME" != "$PSYCOPG2_EXPECTED_NAME" ]]; then
             exit 1
           fi
+        env:
+          DBT_PSYCOPG2_NAME: rubber-baby-buggy-bumpers
+          PSYCOPG2_EXPECTED_NAME: psycopg2-binary
+
+      - name: "Test psycopg2 name - override"
+        run: |
+          pip install --upgrade --force-reinstall .
+          PSYCOPG2_PIP_ENTRY=$(hatch run pip list | grep "psycopg2 " || hatch run pip list | grep psycopg2-binary)
+
+          echo $PSYCOPG2_PIP_ENTRY
+          PSYCOPG2_NAME="${PSYCOPG2_PIP_ENTRY%% *}"
+          echo $PSYCOPG2_NAME
+
+          if [[ "$PSYCOPG2_NAME" != "$PSYCOPG2_EXPECTED_NAME" ]]; then
+            exit 1
+          fi
+        env:
+          DBT_PSYCOPG2_NAME: psycopg2
+          PSYCOPG2_EXPECTED_NAME: psycopg2

.gitignore

@@ -161,3 +161,9 @@ cython_debug/
 
 # testing artifacts
 /logs
+
+# MacOS
+.DS_Store
+
+# vscode
+.vscode/

hatch_hooks.py

@@ -0,0 +1,30 @@
+import os
+
+from hatchling.builders.hooks.plugin.interface import BuildHookInterface
+from hatchling.plugin import hookimpl
+
+
+class Psycopg2NoBinary(BuildHookInterface):
+    """
+    Custom build hook to install psycopg2 instead of psycopg2-binary based on the presence of `DBT_PSYCOPG2_NAME`.
+    This is necessary as psycopg2-binary is better for local development, but psycopg2 is better for production.
+    """
+
+    PLUGIN_NAME = "psycopg2"
+
+    def initialize(self, version, build_data) -> None:
+        print(build_data)
+        if os.getenv("DBT_PSYCOPG2_NAME", "") == "psycopg2":
+            psycopg2_binary_pinned = [
+                package
+                for package in build_data["dependencies"]
+                if package.startswith("psycopg2-binary")
+            ].pop()
+            build_data["dependencies"].pop(psycopg2_binary_pinned)
+            psycopg2_pinned = psycopg2_binary_pinned.replace("-binary", "")
+            build_data["dependencies"].append(psycopg2_pinned)
+
+
+@hookimpl
+def hatch_register_build_hook():
+    return Psycopg2NoBinary

pyproject.toml

@@ -23,10 +23,7 @@ classifiers = [
     "Programming Language :: Python :: 3.11",
 ]
 dependencies = [
-    # install `psycopg2` on linux (assumed production)
-    'psycopg2>=2.9,<3.0; platform_system == "Linux"',
-    # install `psycopg2-binary` on macos/windows (assumed development)
-    'psycopg2-binary>=2.9,<3.0; platform_system != "Linux"',
+    "psycopg2-binary>=2.9,<3.0",
     "dbt-adapters>=0.1.0a1,<2.0",
     # add dbt-core to ensure backwards compatibility of installation, this is not a functional dependency
     "dbt-core>=1.8.0a1",
@@ -46,6 +43,9 @@ Changelog = "https://github.com/dbt-labs/dbt-postgres/blob/main/CHANGELOG.md"
 requires = ["hatchling"]
 build-backend = "hatchling.build"
 
+[tool.hatch.build.hooks.custom]
+path = "./hatch_hooks.py"
+
 [tool.hatch.build.targets.sdist]
 include = ["dbt"]