Try sqwauk (#4032)

Conrad Irwin created 2 years ago

It'd be nice to automatically get warned if you're about to do a
backward incompatible migration mistakenly, and sqauwk does exactly
that.

Release Notes:

- (Added|Fixed|Improved) ...
([#<public_issue_number_if_exists>](https://github.com/zed-industries/community/issues/<public_issue_number_if_exists>)).

Change summary

.github/actions/check_style/action.yml | 30 ++++++++++++++++-----------
script/squawk                          | 27 +++++++++++++++++++++++++
2 files changed, 45 insertions(+), 12 deletions(-)

Detailed changes

.github/actions/check_style/action.yml

@@ -2,16 +2,22 @@ name: "Check formatting"
 description: "Checks code formatting use cargo fmt"
 
 runs:
-    using: "composite"
-    steps:
-        - name: cargo fmt
-          shell: bash -euxo pipefail {0}
-          run: cargo fmt --all -- --check
+  using: "composite"
+  steps:
+    - name: cargo fmt
+      shell: bash -euxo pipefail {0}
+      run: cargo fmt --all -- --check
 
-        - name: cargo clippy
-          shell: bash -euxo pipefail {0}
-          # clippy.toml is not currently supporting specifying allowed lints
-          # so specify those here, and disable the rest until Zed's workspace
-          # will have more fixes & suppression for the standard lint set
-          run: |
-              cargo clippy --workspace --all-features --all-targets -- -A clippy::all -D clippy::dbg_macro -D clippy::todo
+    - name: cargo clippy
+      shell: bash -euxo pipefail {0}
+      # clippy.toml is not currently supporting specifying allowed lints
+      # so specify those here, and disable the rest until Zed's workspace
+      # will have more fixes & suppression for the standard lint set
+      run: |
+        cargo clippy --workspace --all-features --all-targets -- -A clippy::all -D clippy::dbg_macro -D clippy::todo
+
+    - name: Find modified migrations
+      shell: bash -euxo pipefail {0}
+      run: |
+        export SQUAWK_GITHUB_TOKEN=${{ github.token }}
+        . ./script/squawk

script/squawk

@@ -0,0 +1,27 @@
+#!/usr/bin/env bash
+
+# Squawk is a linter for database migrations. It helps identify dangerous patterns, and suggests alternatives.
+# Squawk flagging an error does not mean that you need to take a different approach, but it does indicate you need to think about what you're doing.
+# See also: https://squawkhq.com
+
+set -e
+
+SQUAWK_VERSION=0.26.0
+SQUAWK_BIN="./target/squawk-$SQUAWK_VERSION"
+SQUAWK_ARGS="--assume-in-transaction"
+
+
+if  [ ! -f "$SQUAWK_BIN" ]; then
+  curl -L -o "$SQUAWK_BIN" "https://github.com/sbdchd/squawk/releases/download/v$SQUAWK_VERSION/squawk-darwin-x86_64"
+  chmod +x "$SQUAWK_BIN"
+fi
+
+if [ -n "$SQUAWK_GITHUB_TOKEN" ]; then
+    export SQUAWK_GITHUB_REPO_OWNER=$(echo $GITHUB_REPOSITORY | awk -F/ '{print $1}')
+    export SQUAWK_GITHUB_REPO_NAME=$(echo $GITHUB_REPOSITORY | awk -F/ '{print $2}')
+    export SQUAWK_GITHUB_PR_NUMBER=$(echo $GITHUB_REF | awk 'BEGIN { FS = "/" } ; { print $3 }')
+
+    $SQUAWK_BIN $SQUAWK_ARGS upload-to-github $(git diff --name-only origin/$GITHUB_BASE_REF...origin/$GITHUB_HEAD_REF 'crates/collab/migrations/*.sql')
+else
+    $SQUAWK_BIN $SQUAWK_ARGS $(git ls-files --others crates/collab/migrations/*.sql) $(git diff --name-only main crates/collab/migrations/*.sql)
+fi