make release-notes script executable and update justfile (#115)

* make release-notes.py file executable

* update justfile

* wip: fix benchmarks

* wip: fix benchmarks

* wip: fix benchmarks

* wip: fix benchmarks

* wip: fix benchmarks

* wip: fix benchmarks

* wip: fix benchmarks - add double quotes around the connection string

* wip: fix benchmarks - update start.sh

Author: pranshi06

.github/workflows/benchmarks.yaml

@@ -27,7 +27,7 @@ jobs:
 
       - name: Build the Docker image 🔨
         run: |
-          docker load < $(nix build --no-link --print-out-paths '.#docker')
+          docker load --input="$(nix build --no-link --print-out-paths '.#docker')"
 
       - name: Start dependencies ▶️
         run: |
@@ -39,11 +39,14 @@ jobs:
           cd benchmarks/component
           for benchmark in $(ls benchmarks); do
             echo "Starting agent..."
-            docker compose up --wait agent
+            docker compose up --wait agent || {
+              docker compose logs agent
+              exit 1
+            }
             echo "Running ${benchmark}..."
             docker compose run --rm benchmark run "/benchmarks/$benchmark"
             echo "Saving metrics for ${benchmark}..."
-            ./metrics.sh localhost:8100 ${benchmark}
+            ./metrics.sh localhost:8080 ${benchmark}
             echo "Stopping agent..."
             docker compose down agent
           done

benchmarks/component/benchmarks/select-by-pk.js

@@ -3,7 +3,7 @@ import http from "k6/http";
 import { newSummaryHandler } from "../common.js";
 
 const testid = "select-by-pk";
-const agentSocket = __ENV.AGENT_SOCKET || "localhost:8100";
+const agentSocket = __ENV.AGENT_SOCKET || "localhost:8080";
 const url = `http://${agentSocket}/query`;
 const data = {
   collection: "Album",

benchmarks/component/benchmarks/select-variables.js

@@ -3,7 +3,7 @@ import http from "k6/http";
 import { newSummaryHandler } from "../common.js";
 
 const testid = "select-variables";
-const agentSocket = __ENV.AGENT_SOCKET || "localhost:8100";
+const agentSocket = __ENV.AGENT_SOCKET || "localhost:8080";
 const url = `http://${agentSocket}/query`;
 const data = {
   collection: "Album",

benchmarks/component/benchmarks/select-where.js

@@ -3,7 +3,7 @@ import http from "k6/http";
 import { newSummaryHandler } from "../common.js";
 
 const testid = "select-where";
-const agentSocket = __ENV.AGENT_SOCKET || "localhost:8100";
+const agentSocket = __ENV.AGENT_SOCKET || "localhost:8080";
 const url = `http://${agentSocket}/query`;
 const data = {
   collection: "Album",

benchmarks/component/benchmarks/select.js

@@ -3,7 +3,7 @@ import http from "k6/http";
 import { newSummaryHandler } from "../common.js";
 
 const testid = "select";
-const agentSocket = __ENV.AGENT_SOCKET || "localhost:8100";
+const agentSocket = __ENV.AGENT_SOCKET || "localhost:8080";
 const url = `http://${agentSocket}/query`;
 const data = {
   collection: "Album",

benchmarks/component/docker-compose.yaml

@@ -6,7 +6,7 @@ services:
   benchmark:
     image: grafana/k6
     environment:
-      AGENT_SOCKET: "agent:8100"
+      AGENT_SOCKET: "agent:8080"
       OUTPUT_DIRECTORY: "/home/k6/output"
       K6_OUT: "experimental-prometheus-rw"
       K6_PROMETHEUS_RW_SERVER_URL: "http://prometheus:9090/api/v1/write"
@@ -59,16 +59,16 @@ services:
       - serve
     init: true
     ports:
-      - "8100:8100"
+      - "8080:8080"
     environment:
-      CONFIGURATION_FILE: "/deployment.json"
+      CONNECTION_URI: "Driver={ODBC Driver 19 for SQL Server};Server=127.0.0.1,1433;Database=Chinook;Uid=sa;Pwd=Password!;TrustServerCertificate=True"
       # we don't care about traces right now, and the benchmarks flood the batch buffer
       OTEL_TRACES_SAMPLER: "always_off"
-      PORT: 8100
+      PORT: 8080
     volumes:
       - type: bind
         source: ../../static
-        target: /deployment.json
+        target: /etc/connector
         read_only: true
     healthcheck:
       test:

benchmarks/component/metrics.sh

@@ -4,7 +4,7 @@ set -e
 set -u
 set -o pipefail
 
-# given an address like `localhost:8100`, call metrics endpoint and extract
+# given an address like `localhost:8080`, call metrics endpoint and extract
 # useful things like the time our agent spends doing work that isn't query execution or
 # waiting for connections
 

benchmarks/component/run.sh

@@ -48,4 +48,4 @@ export K6_PROMETHEUS_RW_TREND_AS_NATIVE_HISTOGRAM="true"
 k6 run "./benchmarks/$BENCHMARK" "$@"
 
 info 'Printing metrics'
-curl -fsS http://localhost:8100/metrics
+curl -fsS http://localhost:8080/metrics

benchmarks/component/start.sh

@@ -26,34 +26,17 @@ info 'Starting the dependencies'
 docker compose up --wait sqlserver grafana
 SQLSERVER_SOCKET="$(docker compose port sqlserver 1433 | cut -f2 -d":")"
 
-info 'Generating the deployment configuration'
-mkdir -p generated
-cargo run -p ndc-sqlserver --quiet --release -- configuration serve &
-AGENT_PID=$!
-echo "$AGENT_PID" > ./agent.pid
-../../scripts/wait-until --timeout=30 --report -- cargo run -p ndc-sqlserver --quiet -- check-health --port=9100
-if ! kill -0 "$AGENT_PID"; then
-  echo >&2 'The agent stopped abruptly. Take a look at agent.log for details.'
-  exit 1
-fi
-
-SQLSERVER_CONNECTION_STRING="DRIVER={ODBC Driver 18 for SQL Server};SERVER=127.0.0.1,${SQLSERVER_SOCKET};Uid=SA;Database=Chinook;Pwd=Password!"
-
-../../scripts/new-configuration.sh localhost:9100 "${SQLSERVER_CONNECTION_STRING}" \
-  > ./generated/deployment.json
-kill "$AGENT_PID" && wait "$AGENT_PID" || :
-rm -f ./agent.pid
-
 info 'Starting the agent'
-if nc -z localhost 8100; then
-  echo >&2 'ERROR: There is already an agent running on port 8100.'
+if nc -z localhost 8080; then
+  echo >&2 'ERROR: There is already an agent running on port 8080.'
   exit 1
 fi
 
+CONNECTION_URI="DRIVER={ODBC Driver 18 for SQL Server};SERVER=127.0.0.1,${SQLSERVER_SOCKET};Uid=SA;Database=Chinook;Pwd=Password!"
 OTEL_EXPORTER_OTLP_TRACES_ENDPOINT='http://localhost:4317' \
-  OTEL_SERVICE_NAME='ndc-sqlserver' \
+OTEL_SERVICE_NAME='ndc-sqlserver' \
   cargo run -p ndc-sqlserver --quiet --release -- \
-    serve --configuration=./generated/deployment.json \
+    serve --configuration='../../static' \
   >& agent.log &
 AGENT_PID=$!
 echo "$AGENT_PID" > ./agent.pid

debugging.md

@@ -33,7 +33,7 @@ Using host libthread_db library "/lib64/libthread_db.so.1".
 [New Thread 0x7ffff753f6c0 (LWP 143305)]
 ...
 [New Thread 0x7ffff57306c0 (LWP 143320)]
-Starting server on 0.0.0.0:8100
+Starting server on 0.0.0.0:8080
 
 ```
 
@@ -43,7 +43,7 @@ For example, running a test:
 ```sh
 curl -H "Content-Type: application/json" \
   --data "@crates/ndc-sqlserver/tests/goldenfiles/dup_array_relationship.json" \
-  http://localhost:8100/query
+  http://localhost:8080/query
 ```
 
 Then we can go back to our GDB window:

justfile

@@ -3,8 +3,9 @@ set shell := ["bash", "-c"]
 CONNECTOR_IMAGE_NAME := "ghcr.io/hasura/sqlserver-agent-rs"
 CONNECTOR_IMAGE_TAG := "dev"
 CONNECTOR_IMAGE := CONNECTOR_IMAGE_NAME + ":" + CONNECTOR_IMAGE_TAG
-CHINOOK_DEPLOYMENT := "static/configuration.json"
-SQLSERVER_CONNECTION_STRING := "DRIVER={ODBC Driver 18 for SQL Server};SERVER=127.0.0.1,64003;Uid=SA;Database=Chinook;Pwd=Password!;TrustServerCertificate=true"
+CHINOOK_DEPLOYMENT := "static/"
+SQLSERVER_CONNECTION_STRING := "DRIVER={ODBC Driver 19 for SQL Server};SERVER=127.0.0.1,64003;Uid=SA;Database=Chinook;Pwd=Password!;TrustServerCertificate=true"
+SQLSERVER_BROKEN_QUERIES_NDC_METADATA := "static/broken-queries-ndc-metadata"
 
 # check everything
 check: format-check find-unused-dependencies build lint test
@@ -46,7 +47,9 @@ dev-config: start-dependencies
 # re-generate the deployment configuration file
 generate-chinook-configuration: build start-dependencies
   ./scripts/archive-old-deployment.sh '{{CHINOOK_DEPLOYMENT}}'
-  ./scripts/generate-chinook-configuration.sh 'ndc-sqlserver' '{{SQLSERVER_CONNECTION_STRING}}' '{{CHINOOK_DEPLOYMENT}}'
+
+  CONNECTION_URI='{{SQLSERVER_CONNECTION_STRING}}' cargo run --bin ndc-sqlserver-cli -- --context='{{CHINOOK_DEPLOYMENT}}new_configuration/' initialize
+  CONNECTION_URI='{{SQLSERVER_CONNECTION_STRING}}' cargo run --bin ndc-sqlserver-cli -- --context='{{CHINOOK_DEPLOYMENT}}new_configuration/' update
 
 test-introspection:
   #!/bin/bash

metrics/grafana/dashboards/ndc-sqlserver.json

@@ -470,7 +470,7 @@
           {
             "matcher": {
               "id": "byName",
-              "options": "{instance=\"host.docker.internal:8100\", job=\"ndc-sqlserver\", le=\"0.005\"}"
+              "options": "{instance=\"host.docker.internal:8080\", job=\"ndc-sqlserver\", le=\"0.005\"}"
             },
             "properties": [
               {

metrics/prometheus/prometheus.yml

@@ -27,4 +27,4 @@ scrape_configs:
     scheme: http
     static_configs:
       - targets:
-          - host.docker.internal:8100
+          - host.docker.internal:8080

nix/docker.nix

@@ -20,7 +20,7 @@ let
       Env = [
         ''HASURA_CONFIGURATION_DIRECTORY=/etc/connector''
       ];
-      ExposedPorts = { "8100/tcp" = { }; };
+      ExposedPorts = { "8080/tcp" = { }; };
     } // extraConfig;
   }
   // lib.optionalAttrs (tag != null) {

readme.md

@@ -68,7 +68,7 @@ just run
    ```
    curl -H "Content-Type: application/json" \
      --data "@crates/ndc-sqlserver/tests/goldenfiles/select_where_variable.json" \
-    http://localhost:8100/query \
+    http://localhost:8080/query \
     | jq
    ```
 

scripts/archive-old-deployment.sh

@@ -14,8 +14,23 @@ SNAPSHOT_DIR="$(realpath ${CURRENT_DIR}/../static/deployment-snapshots)"
 # create snapshot dir if does not exist
 mkdir -p "$SNAPSHOT_DIR"
 
-# create filename from hash of contents
-NEW_FILENAME="$(sha256sum "${CHINOOK_DEPLOYMENT}" | cut -f1 -d' ').json"
+if [ -f ${CHINOOK_DEPLOYMENT}new_configuration/configuration.json ]; then
+    # create filename from hash of contents
+    NEW_DIRECTORY="$(sha256sum "${CHINOOK_DEPLOYMENT}new_configuration/configuration.json" | cut -f1 -d' ')"
+
+    mkdir -p "${SNAPSHOT_DIR}/${NEW_DIRECTORY}"
+
+    # copy current deployment to new filename
+    cp -r "${CHINOOK_DEPLOYMENT}new_configuration"* "${SNAPSHOT_DIR}/${NEW_DIRECTORY}"
+
+    rm -r "${CHINOOK_DEPLOYMENT}new_configuration"
+else
+    # create filename from hash of contents
+    NEW_DIRECTORY="$(sha256sum "${CHINOOK_DEPLOYMENT}configuration.json" | cut -f1 -d' ')"
+
+    mkdir -p "${SNAPSHOT_DIR}/${NEW_DIRECTORY}"
+
+    # copy current deployment to new filename
+    cp -r "${CHINOOK_DEPLOYMENT}configuration.json"* "${SNAPSHOT_DIR}/${NEW_DIRECTORY}"
+fi
 
-# copy current deployment to new filename
-cp "${CHINOOK_DEPLOYMENT}" "${SNAPSHOT_DIR}/${NEW_FILENAME}"

scripts/release-notes.py

@@ -3,7 +3,7 @@
     "definition": {
       "name": "db",
       "url": {
-        "singleUrl": "http://localhost:8100"
+        "singleUrl": "http://localhost:8080"
       },
       "schema": {
         "scalar_types": {