Fix just argument splitting on pass-through recipes with complex args (…

…#4961)

* Fix just argument splitting on pass-through recipes with complex arguments

* Use bash instead of sh for consistent behaviour in just recipes and other scripts

* Simplify render-release-drafter recipes

* Fix recreate

* Try another fix for render-release-drafter

* Fix catalog/test

* Fix generate-docs and lint recipe

.vale/justfile

@@ -14,7 +14,7 @@ IGNORE_FILES_PATTERN := ".pnpm|changelogs|projects/proposals|node_modules|.?venv
 # of the current working directory. If a custom separator is specified, newlines are
 # replaced with this separator before outputting the file list.
 _files separator="\n":
-    #! /usr/bin/env sh
+    #! /usr/bin/env bash
     files=$(
         find "$PWD/.." -type f \( -name "*.md" -o -name "*.mdx" \) \
             | grep -vE "{{ IGNORE_FILES_PATTERN }}"

api/justfile

@@ -45,12 +45,14 @@ install *args:
 ######
 
 # Bring up services specific to the API profile
+[positional-arguments]
 up *flags:
-    env COMPOSE_PROFILES="api" just ../up {{ flags }}
+    env COMPOSE_PROFILES="api" just ../up "$@"
 
 # Bring up services specific to the API profile, in addition to the API server
+[positional-arguments]
 up-extra *flags:
-    env COMPOSE_PROFILES="api,api_extra" just ../up {{ flags }}
+    env COMPOSE_PROFILES="api,api_extra" just ../up "$@"
 
 # Wait for all profile services to be up
 wait-up: up
@@ -103,12 +105,14 @@ pgcli db_user_pass="deploy" db_name="openledger": up
 #########################
 
 # Run Django administrative commands locally
-dj-local +args="":
-    pdm run python manage.py {{ args }}
+[positional-arguments]
+dj-local *args:
+    pdm run python manage.py "$@"
 
 # Run Django administrative commands inside the Docker container
-dj +args="": wait-up
-    env DC_USER="{{ env_var_or_default("DC_USER", "opener") }}" just ../exec web python manage.py {{ args }}
+[positional-arguments]
+dj *args: wait-up
+    env DC_USER="{{ env_var_or_default("DC_USER", "opener") }}" just ../exec web python manage.py "$@"
 
 # Get IPython shell inside the Docker container
 ipython:
@@ -152,12 +156,14 @@ generate-docs doc="media-props" fail_on_diff="true":
 #########
 
 # Run API tests inside the Docker container
+[positional-arguments]
 test *args: wait-up
-    env DC_USER="opener" just ../exec web pytest {{ args }}
+    env DC_USER="opener" just ../exec web pytest "$@"
 
 # Run API tests locally
+[positional-arguments]
 test-local *args:
-    pdm run pytest {{ args }}
+    pdm run pytest "$@"
 
 # Run smoke test for the API docs
 doc-test: wait-up

automations/js/justfile

@@ -10,8 +10,10 @@ NO_COLOR := "\\033[0m"
     just --list --unsorted
 
 # Run a script
+[positional-arguments]
 run script *args:
-    pnpm --filter automations exec node src/{{ script }} {{ args }}
+    #! /usr/bin/env bash
+    pnpm --filter automations exec node src/{{ script }} "${@:2}"
 
 #################
 # Weekly report #
@@ -25,21 +27,14 @@ report:
 # Render #
 ##########
 
+_render slug name:
+    just run render-jinja.js \
+        templates/release-drafter.yml.jinja \
+        .github/release-drafter-{{ slug }}.yml \
+        '{"app": "{{ name }}"}'
+
 render-release-drafter:
-    #! /usr/bin/env sh
-    render_release_drafter() {
-        slug=$1
-        name=$2
-        just run render-jinja.js \
-            templates/release-drafter.yml.jinja \
-            .github/release-drafter-$slug.yml \
-            "'{ \"app\": \"$name\" }'"
-    }
-    render_release_drafter api API
-    render_release_drafter ingestion_server "Ingestion Server"
-    render_release_drafter frontend Frontend
-    render_release_drafter catalog Catalog
-
-# Render all templates (shortcut for easy iteration)
-render-templates:
-    just render-release-drafter
+    just _render api API
+    just _render ingestion_server "Ingestion Server"
+    just _render frontend Frontend
+    just _render catalog Catalog

automations/python/justfile

@@ -11,9 +11,11 @@ NO_COLOR := "\\033[0m"
 
 
 # Install dependencies
+[positional-arguments]
 install *args:
-    pdm install {{ args }}
+    pdm install "$@"
 
 # Run a script
+[positional-arguments]
 run script *args:
-    pdm run {{ script }} {{ args }}
+    pdm run "$@"

catalog/justfile

@@ -56,12 +56,14 @@ install *args: check-py-version
 ######
 
 # Bring up services specific to the catalog profile
+[positional-arguments]
 up *flags:
-    env COMPOSE_PROFILES="catalog" just ../up {{ flags }}
+    env COMPOSE_PROFILES="catalog" just ../up "$@"
 
 # Bring up services specific to the catalog profile, except Airflow
+[positional-arguments]
 up-deps *flags:
-    env COMPOSE_PROFILES="catalog_dependencies" just ../up {{ flags }}
+    env COMPOSE_PROFILES="catalog_dependencies" just ../up "$@"
 
 # Load sample data into upstream DB
 init: up
@@ -82,11 +84,12 @@ shell:
     env DC_USER="airflow" just ../exec {{ SERVICE }} /bin/bash
 
 # Launch an IPython shell in a new container under `SERVICE`
+[positional-arguments]
 ipython *args: up-deps
     env DC_USER="airflow" just ../run \
         --workdir /opt/airflow/catalog/dags \
         {{ SERVICE }} \
-        bash -c \'ipython {{ args }}\'
+        bash -c "ipython ${@:2}"
 
 # Launch a `pgcli` shell in the PostgreSQL container
 pgcli db_user_pass="deploy" db_name="openledger": up
@@ -97,30 +100,32 @@ pgcli db_user_pass="deploy" db_name="openledger": up
 #########
 
 # Run a command in a test container under `SERVICE`
-_mount-test command: up-deps
+[positional-arguments]
+_mount-test *command: up-deps
     env DC_USER="airflow" just ../run \
         -e AIRFLOW_VAR_INGESTION_LIMIT=1000000 \
         -w /opt/airflow/catalog \
-        --volume \'{{ justfile_directory() }}/../docker\':/opt/airflow/docker/ \
+        --volume {{ justfile_directory() }}/../docker:/opt/airflow/docker/ \
         {{ SERVICE }} \
-        {{ command }}
+        "$@"
 
 # Launch a Bash shell in a test container under `SERVICE`
 # Run pytest with `--pdb` to workaround xdist breaking pdb.set_trace()
 test-session:
     just _mount-test bash
 
 # Run pytest in a test container under `SERVICE`
+[positional-arguments]
 test *args:
-    just _mount-test "bash -c \'pytest {{ args }}\'"
+    just _mount-test bash -c "pytest $@"
 
 #############
 # Utilities #
 #############
 
 # Generate the documentation (either "dag" or "media-props")
 generate-docs doc="dag" fail_on_diff="false":
-    #!/bin/bash
+    #! /usr/bin/env bash
     set -e
     if [ "{{ doc }}" == "dag" ]; then
         SCRIPT_PATH="catalog/utilities/dag_doc_gen/dag_doc_generation.py"
@@ -136,18 +141,20 @@ generate-docs doc="dag" fail_on_diff="false":
         echo "Invalid documentation type specified, use \`dag\` or \`media-props\`. Exiting."
         exit 1
     fi
+
     GENERATED_ABS_PATH="/opt/airflow/catalog/${GENERATED_REL_PATH}"
     just ../run \
       --volume {{ justfile_directory() }}/../docker:/opt/airflow/docker/ \
       -e PYTHONPATH=/opt/airflow/catalog:/opt/airflow/catalog/dags \
       {{ SERVICE }} \
-      "bash -c 'python $SCRIPT_PATH && chmod 666 $GENERATED_ABS_PATH'"
+      bash -c "python $SCRIPT_PATH && chmod 666 $GENERATED_ABS_PATH"
+
     TEMP="documentation/meta/temp"
-    mv ../catalog/$GENERATED_REL_PATH ../$TEMP.md
+    mv ../catalog/"$GENERATED_REL_PATH" ../"$TEMP".md
     echo "Moved the generated file to ../$TEMP.md"
     echo -n "Running linting..."
     # Linting step afterwards is necessary since the generated output differs greatly from what prettier expects
-    just ../lint prettier $TEMP.md &>/dev/null || true
+    just ../lint prettier "$TEMP".md &>/dev/null || true
     echo "Linting done!"
 
     echo -n "Replacing linted md <hr> '---' with '----' required by sphinx..."

docker/cache/justfile

@@ -14,8 +14,9 @@ NO_COLOR := "\\033[0m"
 #######
 
 # Open the Redis CLI as an interactive REPL
+[positional-arguments]
 cli *args:
-    just ../../exec cache redis-cli {{ args }}
+    just ../../exec cache redis-cli "$@"
 
 # Delete all data cached in Redis
 flushall:

documentation/justfile

@@ -72,8 +72,9 @@ live port="50230": clean
     pdm run sphinx-autobuild -b html . _serve/ --port {{ port }}
 
 # Compile the documentation into a static site
+[positional-arguments]
 build *args: clean
-    pdm run sphinx-build {{ args }} -b html . _build/
+    pdm run sphinx-build "$@" -b html . _build/
 
 # Serve the compiled docs using a simple HTTP server
 serve port="50231":

frontend/bin/playwright.sh

@@ -1,4 +1,4 @@
-#! /usr/bin/env sh
+#! /usr/bin/env bash
 set -e
 
 version() {

frontend/justfile

@@ -55,8 +55,9 @@ run-img tag="openverse-frontend:local":
 ######
 
 # Bring up services specific to the frontend profile
+[positional-arguments]
 up *flags:
-    env COMPOSE_PROFILES="frontend" just ../up {{ flags }}
+    env COMPOSE_PROFILES="frontend" just ../up "$@"
 
 # Wait for all profile services to be up
 wait-up: up
@@ -67,8 +68,9 @@ init: wait-up
     cd .. && ./setup_plausible.sh
 
 # Run a package.json script via pnpm
+[positional-arguments]
 run *args:
-    pnpm run {{ args }}
+    pnpm run "$@"
 
 # Generate the specified kind of documentation
 generate-docs doc="media-props" fail_on_diff="true":

indexer_worker/justfile

@@ -33,8 +33,9 @@ install *args="--dev":
 ######
 
 # Bring up services specific to the indexer worker profile
+[positional-arguments]
 up *flags:
-    env COMPOSE_PROFILES="catalog_indexer_worker" just ../up {{ flags }}
+    env COMPOSE_PROFILES="catalog_indexer_worker" just ../up "$@"
 
 wait-up: up
     just wait
@@ -77,9 +78,12 @@ curl-post data host="localhost:50281":
 # Tests #
 #########
 
+# Run indexer worker tests in the container
+[positional-arguments]
 test *args: wait-up
-    just ../exec catalog_indexer_worker pytest {{ args }}
+    just ../exec catalog_indexer_worker pytest "$@"
 
 # Run indexer-worker tests locally
+[positional-arguments]
 test-local *args:
-    pdm run pytest {{ args }}
+    pdm run pytest "$@"