Migrate driver adapters to prisma/prisma

.github/workflows/query-engine-driver-adapters.yml

@@ -49,6 +49,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
 
       - name: 'Setup Node.js'
         uses: actions/setup-node@v3
@@ -72,6 +74,15 @@ jobs:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
 
+      - name: Extract Branch Name
+        id: extract-branch
+        run: |
+          branch="$(git show -s --format=%s | grep -o "DRIVER_ADAPTERS_BRANCH=[^ ]*" | cut -f2 -d=)"
+          if [ -n $branch ]; then
+            echo "Using $branch branch of driver adapters"
+            echo "DRIVER_ADAPTERS_BRANCH=$branch" >> "$GITHUB_ENV"
+          fi
+
       - run: make ${{ matrix.adapter.setup_task }}
 
       - uses: dtolnay/rust-toolchain@stable

.gitignore

@@ -46,3 +46,6 @@ dmmf.json
 graph.dot
 
 prisma-schema-wasm/nodejs
+
+# This symlink looks orphan here, but it comes from prisma/prisma where driver adapters reference a file in their parent directory
+tsconfig.build.adapter.json

Makefile

@@ -2,6 +2,7 @@ CONFIG_PATH = ./query-engine/connector-test-kit-rs/test-configs
 CONFIG_FILE = .test_config
 SCHEMA_EXAMPLES_PATH = ./query-engine/example_schemas
 DEV_SCHEMA_FILE = dev_datamodel.prisma
+DRIVER_ADAPTERS_BRANCH ?= main
 
 LIBRARY_EXT := $(shell                            \
     case "$$(uname -s)" in                        \
@@ -44,7 +45,13 @@ release:
 #################
 
 test-qe:
+ifndef DRIVER_ADAPTER
 	cargo test --package query-engine-tests
+else
+	@echo "Executing query engine tests with $(DRIVER_ADAPTER) driver adapter"; \
+	# Add your actual command for the "test-driver-adapter" task here
+	$(MAKE) test-driver-adapter-$(DRIVER_ADAPTER);
+endif
 
 test-qe-verbose:
 	cargo test --package query-engine-tests -- --nocapture
@@ -80,6 +87,10 @@ dev-sqlite:
 dev-libsql-sqlite: build-qe-napi build-connector-kit-js
 	cp $(CONFIG_PATH)/libsql-sqlite $(CONFIG_FILE)
 
+test-libsql-sqlite: dev-libsql-sqlite test-qe-st
+
+test-driver-adapter-libsql: test-libsql-sqlite
+
 start-postgres9:
 	docker compose -f docker-compose.yml up --wait -d --remove-orphans postgres9
 
@@ -115,12 +126,20 @@ start-pg-postgres13: build-qe-napi build-connector-kit-js start-postgres13
 dev-pg-postgres13: start-pg-postgres13
 	cp $(CONFIG_PATH)/pg-postgres13 $(CONFIG_FILE)
 
+test-pg-postgres13: dev-pg-postgres13 test-qe-st
+
+test-driver-adapter-pg: test-pg-postgres13
+
 start-neon-postgres13: build-qe-napi build-connector-kit-js
 	docker compose -f docker-compose.yml up --wait -d --remove-orphans neon-postgres13
 
 dev-neon-ws-postgres13: start-neon-postgres13
 	cp $(CONFIG_PATH)/neon-ws-postgres13 $(CONFIG_FILE)
 
+test-neon-ws-postgres13: dev-neon-ws-postgres13 test-qe-st
+
+test-driver-adapter-neon: test-neon-ws-postgres13
+
 start-postgres14:
 	docker compose -f docker-compose.yml up --wait -d --remove-orphans postgres14
 
@@ -255,15 +274,48 @@ start-planetscale-vitess8: build-qe-napi build-connector-kit-js
 dev-planetscale-vitess8: start-planetscale-vitess8
 	cp $(CONFIG_PATH)/planetscale-vitess8 $(CONFIG_FILE)
 
+test-planetscale-vitess8: dev-planetscale-vitess8 test-qe-st
+
+test-driver-adapter-planetscale: test-planetscale-vitess8
+
 ######################
 # Local dev commands #
 ######################
 
 build-qe-napi:
 	cargo build --package query-engine-node-api
 
-build-connector-kit-js:
-	cd query-engine/driver-adapters/js && pnpm i && pnpm build
+build-connector-kit-js: build-driver-adapters symlink-driver-adapters
+	cd query-engine/driver-adapters/connector-test-kit-executor && pnpm i && pnpm build
+
+build-driver-adapters: ensure-prisma-present
+	@echo "Building driver adapters..."
+	@cd ../prisma && pnpm --filter "*adapter*" i && pnpm --filter "*adapter*" build
+	@echo "Driver adapters build completed.";
+
+symlink-driver-adapters: ensure-prisma-present
+	@echo "Creating symbolic links for driver adapters..."
+	@for dir in $(wildcard $(realpath ../prisma)/packages/*adapter*); do \
+        if [ -d "$$dir" ]; then \
+            dir_name=$$(basename "$$dir"); \
+            ln -sfn "$$dir" "$(realpath .)/query-engine/driver-adapters/$$dir_name"; \
+            echo "Created symbolic link for $$dir_name"; \
+        fi; \
+	done;
+	@ln -sfn "../prisma/tsconfig.build.adapter.json" "./tsconfig.build.adapter.json"; \
+	echo "Symbolic links creation completed.";
+
+ensure-prisma-present:
+	@if [ -d ../prisma ]; then \
+		cd "$(realpath ../prisma)" && git fetch origin main; \
+		LOCAL_CHANGES=$$(git diff --name-only HEAD origin/main -- 'packages/*adapter*'); \
+		if [ -n "$$LOCAL_CHANGES" ]; then \
+		  echo "⚠️ ../prisma diverges from prisma/prisma main branch. Test results might diverge from those in CI ⚠️ "; \
+		fi \
+	else \
+		echo "git clone --depth=1 https://github.com/prisma/prisma.git --branch=$(DRIVER_ADAPTERS_BRANCH) ../prisma"; \
+		git clone --depth=1 https://github.com/prisma/prisma.git --branch=$(DRIVER_ADAPTERS_BRANCH) "../prisma" && echo "Prisma repository has been cloned to ../prisma"; \
+	fi;
 
 # Quick schema validation of whatever you have in the dev_datamodel.prisma file.
 validate:

README.md

@@ -203,6 +203,7 @@ integration tests.
   - Alternatively: Load the defined environment in `./.envrc` manually in your shell.
 
 **Setup:**
+
 There are helper `make` commands to set up a test environment for a specific
 database connector you want to test. The commands set up a container (if needed)
 and write the `.test_config` file, which is picked up by the integration
@@ -234,6 +235,21 @@ Other variables may or may not be useful.
 
 Run `cargo test` in the repository root.
 
+#### Testing driver adapters
+
+Driver adapters are a feature to run queries through javascript drivers from rust. An adapter for a certain driver is 
+provided by the prisma client and then use by rust code. If you want to run query engine tests through driver adapters:
+
+- `DRIVER_ADAPTER=$adapter make qe-test`
+
+Where `$adapter` is one of `pg`, `neon`, or `planetscale` or `libsql` (the driver adapters currently supported)
+
+This make task hides the underlying complexity of spawning the right docker containers, pulling driver adapters code 
+from prisma/prisma, building them, and build a test runner to use them. 
+
+When pulling the driver adapters code, make will ensure you have a clone of prisma/prisma in the same directory as 
+prisma-engines. If you don't, it will clone it for you.
+
 ## Parallel rust-analyzer builds
 
 When rust-analzyer runs `cargo check` it will lock the build directory and stop any cargo commands from running until it has completed. This makes the build process feel a lot longer. It is possible to avoid this by setting a different build path for

query-engine/connector-test-kit-rs/README.md

@@ -66,8 +66,9 @@ If you choose to set up the databases yourself, please note that the connection
 
 #### Running tests through driver adapters
 
-The query engine is able to delegate query execution to javascript through [driver adapters](query-engine/driver-adapters/js/README.md).
-This means that instead of drivers being implemented in Rust, it's a layer of adapters over NodeJs drivers the code that actually communicates with the databases. 
+The query engine is able to delegate query execution to javascript through driver adapters.
+This means that instead of drivers being implemented in Rust, it's a layer of adapters over NodeJs
+drivers the code that actually communicates with the databases. See [`adapter-*` packages in prisma/prisma](https://github.com/prisma/prisma/tree/main/packages)
 
 To run tests through a driver adapters, you should also configure the following environment variables:
 
@@ -78,7 +79,7 @@ To run tests through a driver adapters, you should also configure the following
 Example:
 
 ```shell
-export EXTERNAL_TEST_EXECUTOR="$WORKSPACE_ROOT/query-engine/driver-adapters/js/connector-test-kit-executor/script/start_node.sh"
+export EXTERNAL_TEST_EXECUTOR="$WORKSPACE_ROOT/query-engine/driver-adapters/connector-test-kit-executor/script/start_node.sh"
 export DRIVER_ADAPTER=neon
 export DRIVER_ADAPTER_CONFIG ='{ "proxyUrl": "127.0.0.1:5488/v1" }'
 ````

query-engine/connector-test-kit-rs/query-tests-setup/src/config.rs

@@ -159,7 +159,7 @@ impl TestConfig {
     /// and the workspace_root is set, then use the default external test executor.
     fn fill_defaults(&mut self) {
         const DEFAULT_TEST_EXECUTOR: &str =
-            "query-engine/driver-adapters/js/connector-test-kit-executor/script/start_node.sh";
+            "query-engine/driver-adapters/connector-test-kit-executor/script/start_node.sh";
 
         if self
             .external_test_executor

query-engine/driver-adapters/.gitignore

@@ -0,0 +1,3 @@
+node_modules
+adapter-*
+driver-adapter-utils

query-engine/driver-adapters/connector-test-kit-executor/.gitignore

@@ -0,0 +1,3 @@
+node_modules
+pnpm-debug.log
+dist/

query-engine/driver-adapters/js/connector-test-kit-executor/package.json → query-engine/driver-adapters/connector-test-kit-executor/package.json

@@ -1,6 +1,10 @@
 {
+  "engines": {
+    "node": ">=16.13",
+    "pnpm": ">=8.6.6 <9"
+  },
   "name": "connector-test-kit-executor",
-  "version": "5.4.0",
+  "version": "0.0.1",
   "description": "",
   "main": "dist/index.js",
   "private": true,
@@ -16,13 +20,19 @@
     "@libsql/client": "0.3.5",
     "@neondatabase/serverless": "^0.6.0",
     "@planetscale/database": "1.11.0",
-    "@prisma/adapter-libsql": "workspace:*",
-    "@prisma/adapter-neon": "workspace:*",
-    "@prisma/adapter-pg": "workspace:*",
-    "@prisma/adapter-planetscale": "workspace:*",
-    "@prisma/driver-adapter-utils": "workspace:*",
+    "@prisma/adapter-libsql": "../adapter-libsql",
+    "@prisma/adapter-neon": "../adapter-neon",
+    "@prisma/adapter-pg": "../adapter-pg",
+    "@prisma/adapter-planetscale": "../adapter-planetscale",
+    "@prisma/driver-adapter-utils": "../driver-adapter-utils",
     "@types/pg": "^8.10.2",
     "pg": "^8.11.3",
     "undici": "^5.26.2"
+  },
+  "devDependencies": {
+    "@types/node": "^20.5.1",
+    "tsup": "^7.2.0",
+    "tsx": "^3.12.7",
+    "typescript": "^5.1.6"
   }
-}
+}