mirror of
https://github.com/coder/coder.git
synced 2026-06-07 06:58:17 +00:00
Cian Johnston
b5360a9180
* https://github.com/coder/coder/pull/21493 * https://github.com/coder/coder/pull/21496 * https://github.com/coder/coder/pull/21530 NB these commits were originally authored by Blink on behalf of @dannykopping, so amended to reflect actual authorship. **Repro/Verification Steps:** * Created a Coder deployment with a non-public schema via Docker compose on v2.28.6: * Created a DB init script under `db-init/01-create-schema.sql` with the following: ```sql CREATE SCHEMA IF NOT EXISTS coder AUTHORIZATION coder; GRANT ALL PRIVILEGES ON SCHEMA coder TO coder; ALTER ROLE coder SET search_path TO coder; ``` * Mounted above inside the `postgres` container: ```diff volumes: - coder_data:/var/lib/postgresql/data + - ./db-init:/docker-entrypoint-initdb.d:ro ``` * Edited `CODER_PG_CONNECTION_URL` to update the search path: ```diff environment: - CODER_PG_CONNECTION_URL: "postgresql://${POSTGRES_USER:-username}:${POSTGRES_PASSWORD:-password}@database/${POSTGRES_DB:-coder}?sslmode=disable" + CODER_PG_CONNECTION_URL: "postgresql://${POSTGRES_USER:-username}:${POSTGRES_PASSWORD:-password}@database/${POSTGRES_DB:-coder}?sslmode=disable&search_path=coder" ``` * Brought up the deployment: ```shell CODER_VERSION=v2.28.6 CODER_ACCESS_URL=http://localhost:7080 POSTGRES_USER=coder POSTGRES_PASSWORD=coder docker compose up` ``` * Created user / template / workspace * Updated to `v2.29.1`: * ```shell CODER_VERSION=v2.29.1 CODER_ACCESS_URL=http://localhost:7080 POSTGRES_USER=coder POSTGRES_PASSWORD=coder docker compose up` ``` * Observed following error: ``` database-1 | 2026-01-21 15:07:17.629 UTC [102] ERROR: relation "public.workspace_agents" does not exist coder-1 | Encountered an error running "coder server", see "coder server --help" for more information database-1 | 2026-01-21 15:07:17.629 UTC [102] STATEMENT: CREATE INDEX IF NOT EXISTS workspace_agents_auth_instance_id_deleted_idx ON public.workspace_agents (auth_instance_id, deleted); coder-1 | error: connect to postgres: connect to postgres: migrate up: up: 2 errors occurred: coder-1 | * run statement: migration failed: relation "public.workspace_agents" does not exist in line 0: CREATE INDEX IF NOT EXISTS workspace_agents_auth_instance_id_deleted_idx ON public.workspace_agents (auth_instance_id, deleted); coder-1 | (details: pq: relation "public.workspace_agents" does not exist) coder-1 | * commit tx on unlock: pq: Could not complete operation in a failed transaction coder-1 exited with code 1 ``` * Built image locally: ```console $ make build/coder_$(./scripts/version.sh)_linux_amd64.tag ... ghcr.io/coder/coder:v2.29.1-devel-e8c482a98a67-amd64 ``` * Started with new image: ```shell CODER_VERSION=v2.29.1-devel-e8c482a98a67-amd64 CODER_ACCESS_URL=http://localhost:7080 POSTGRES_USER=coder POSTGRES_PASSWORD=coder docker compose up ``` * Observed migrations ran successfully and Coder came up successfully --------- Signed-off-by: Danny Kopping <danny@coder.com> Co-authored-by: Danny Kopping <danny@coder.com> Co-authored-by: blink-so[bot] <211532188+blink-so[bot]@users.noreply.github.com>
45 lines
1.1 KiB
Bash
Executable File
45 lines
1.1 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
|
|
# This script checks that SQL files do not hardcode the "public" schema;
|
|
# they should rely on search_path instead to support deployments using
|
|
# non-public schemas.
|
|
#
|
|
# Usage: check_pg_schema.sh <label> [files...]
|
|
# Example: check_pg_schema.sh "Migrations" file1.sql file2.sql
|
|
|
|
set -euo pipefail
|
|
# shellcheck source=scripts/lib.sh
|
|
source "$(dirname "${BASH_SOURCE[0]}")/lib.sh"
|
|
cdroot
|
|
|
|
if [[ $# -lt 1 ]]; then
|
|
error "Usage: check_pg_schema.sh <label> [files...]"
|
|
fi
|
|
|
|
label=$1
|
|
shift
|
|
|
|
# No files provided, nothing to check.
|
|
if [[ $# -eq 0 ]]; then
|
|
log "$label schema references OK (no files to check)"
|
|
exit 0
|
|
fi
|
|
|
|
files=("$@")
|
|
|
|
set +e
|
|
matches=$(grep -l 'public\.' "${files[@]}" 2>/dev/null)
|
|
set -e
|
|
|
|
if [[ -n "$matches" ]]; then
|
|
log "ERROR: $label must not hardcode the 'public' schema. Use unqualified table names instead."
|
|
echo "The following files contain 'public.' references:" >&2
|
|
while read -r file; do
|
|
echo " $file" >&2
|
|
grep -n 'public\.' "$file" | head -5 | sed 's/^/ /' >&2
|
|
done <<<"$matches"
|
|
exit 1
|
|
fi
|
|
|
|
log "$label schema references OK"
|