Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
Expand Up @@ -298,3 +298,6 @@ GH_APP_SLUG=superset-app

# Read-only support account lookup (apps/api /api/support/lookup); unset = endpoint off
SUPPORT_LOOKUP_TOKEN=

# Server-only domain routing opt-in; only literal true enables evaluation.
DOMAIN_MOVE_ENABLED=
3 changes: 3 additions & 0 deletions .env.local.example
Original file line number Diff line number Diff line change
Expand Up @@ -272,3 +272,6 @@ SANDBOX_GATE_ORIGIN=http://127.0.0.1:8790
# means no sandbox is ever provisioned here to report anything.
SENTRY_DSN_SANDBOX=
GH_APP_SLUG=superset-app

# Server-only domain routing opt-in; only literal true enables evaluation.
DOMAIN_MOVE_ENABLED=false
3 changes: 3 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,9 @@ jobs:
- name: Check out code
uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1

- name: Test Paradev deployment guards
run: python3 -B scripts/deploy-paradev-staging/guard_test.py

- name: Setup Bun
id: setup-bun
uses: oven-sh/setup-bun@0c5077e51419868618aeaa5fe8019c62421857d6 # v2.2.0
Expand Down
52 changes: 44 additions & 8 deletions .github/workflows/deploy-paradev-staging.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@ name: Deploy Paradev Staging

on:
workflow_dispatch:
inputs:
mode:
description: Stage aliases or prepare final artifacts without routing changes
type: choice
required: true
default: stage
options:
- stage
- prepare-final

permissions:
contents: read
Expand All @@ -25,6 +34,7 @@ jobs:
timeout-minutes: 30
environment: production
env:
DEPLOY_MODE: ${{ inputs.mode }}
VERCEL_PARADEV_API_PROJECT_ID: ${{ vars.VERCEL_PARADEV_API_PROJECT_ID }}
VERCEL_PARADEV_WEB_PROJECT_ID: ${{ vars.VERCEL_PARADEV_WEB_PROJECT_ID }}

Expand Down Expand Up @@ -69,6 +79,11 @@ jobs:
if not condition:
sys.exit(message)

MODE = os.environ["DEPLOY_MODE"]
require(MODE in ("stage", "prepare-final"), "Unknown deployment mode")
require(sys.argv[1] in ("check", "alias", "report"), "Unknown guard command")
require(sys.argv[1] != "alias" or MODE == "stage", "Final preparation cannot assign aliases")

for kind, project_id, *_ in TARGETS:
require(os.environ.get(f"VERCEL_PARADEV_{kind}_PROJECT_ID") == project_id,
f"Missing or incorrect {kind} project variable; refusing deployment")
Expand Down Expand Up @@ -96,6 +111,8 @@ jobs:
require(project["id"] == project_id and project["name"] == name
and project["accountId"] == os.environ["VERCEL_ORG_ID"]
and project["rootDirectory"] == root, f"Unexpected project identity for {kind}")
if MODE == "prepare-final":
return None
domain = request(f"/v9/projects/{project_id}/domains/{host}")
require(domain["name"] == host and domain.get("verified") is True
and not domain.get("redirect") and not domain.get("gitBranch")
Expand All @@ -109,7 +126,7 @@ jobs:
for target in TARGETS:
check_target(target)

if sys.argv[1] == "alias":
if sys.argv[1] in ("alias", "report"):
deployments = []
for target in TARGETS:
kind, project_id, name, host, root = target
Expand All @@ -122,6 +139,13 @@ jobs:
require(deployment["projectId"] == project_id and deployment["readyState"] == "READY"
and deployment["target"] == "production", f"Unexpected deployment for {kind}")
deployments.append(deployment["id"])
if sys.argv[1] == "report":
with open(os.environ["GITHUB_STEP_SUMMARY"], "a") as summary:
summary.write(f"{kind}: {deployment['id']} {url}\n\n")
if sys.argv[1] == "report":
with open(os.environ["GITHUB_STEP_SUMMARY"], "a") as summary:
summary.write(f"Commit: {os.environ['GITHUB_SHA']}\n")
sys.exit(0)
for target, deployment_id in zip(TARGETS, deployments):
alias = check_target(target)
host = target[3]
Expand Down Expand Up @@ -153,13 +177,14 @@ jobs:
VERCEL_PROJECT_ID: ${{ vars.VERCEL_PARADEV_API_PROJECT_ID }}
DATABASE_URL: ${{ secrets.DATABASE_URL }}
DATABASE_URL_UNPOOLED: ${{ secrets.DATABASE_URL_UNPOOLED }}
BROWSER_API_URL: https://api.stage.paradev.com
DOMAIN_MOVE_ENABLED: "false"
BROWSER_API_URL: ${{ inputs.mode == 'prepare-final' && 'https://api.paradev.com' || 'https://api.stage.paradev.com' }}
NEXT_PUBLIC_API_URL: https://api.superset.sh
NEXT_PUBLIC_WEB_URL: https://app.stage.paradev.com
NEXT_PUBLIC_WEB_URL: ${{ inputs.mode == 'prepare-final' && 'https://app.paradev.com' || 'https://app.stage.paradev.com' }}
NEXT_PUBLIC_MARKETING_URL: https://paradev.com
NEXT_PUBLIC_ROOT_DOMAIN: ${{ secrets.NEXT_PUBLIC_ROOT_DOMAIN }}
NEXT_PUBLIC_ADMIN_URL: ${{ secrets.NEXT_PUBLIC_ADMIN_URL }}
NEXT_PUBLIC_COOKIE_DOMAIN: stage.paradev.com
NEXT_PUBLIC_COOKIE_DOMAIN: ${{ inputs.mode == 'prepare-final' && 'paradev.com' || 'stage.paradev.com' }}
BETTER_AUTH_SECRET: ${{ secrets.BETTER_AUTH_SECRET }}
CLOUDFLARE_ACCOUNT_ID: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
R2_ACCESS_KEY_ID: ${{ secrets.R2_ACCESS_KEY_ID }}
Expand Down Expand Up @@ -275,6 +300,7 @@ jobs:
--env TEMPORAL_NAMESPACE=$TEMPORAL_NAMESPACE \
--env TEMPORAL_API_KEY=$TEMPORAL_API_KEY \
--env CLOUDFLARE_BROWSER_RENDERING_TOKEN=$CLOUDFLARE_BROWSER_RENDERING_TOKEN \
--env DOMAIN_MOVE_ENABLED="$DOMAIN_MOVE_ENABLED" \
--env BROWSER_API_URL="$BROWSER_API_URL" \
--env NEXT_PUBLIC_API_URL=$NEXT_PUBLIC_API_URL \
--env NEXT_PUBLIC_WEB_URL=$NEXT_PUBLIC_WEB_URL \
Expand Down Expand Up @@ -365,9 +391,10 @@ jobs:
VERCEL_PROJECT_ID: ${{ vars.VERCEL_PARADEV_WEB_PROJECT_ID }}
DATABASE_URL: ${{ secrets.DATABASE_URL }}
DATABASE_URL_UNPOOLED: ${{ secrets.DATABASE_URL_UNPOOLED }}
BROWSER_API_URL: https://api.stage.paradev.com
NEXT_PUBLIC_API_URL: https://api.stage.paradev.com
NEXT_PUBLIC_WEB_URL: https://app.stage.paradev.com
DOMAIN_MOVE_ENABLED: "false"
BROWSER_API_URL: ${{ inputs.mode == 'prepare-final' && 'https://api.paradev.com' || 'https://api.stage.paradev.com' }}
NEXT_PUBLIC_API_URL: ${{ inputs.mode == 'prepare-final' && 'https://api.paradev.com' || 'https://api.stage.paradev.com' }}
NEXT_PUBLIC_WEB_URL: ${{ inputs.mode == 'prepare-final' && 'https://app.paradev.com' || 'https://app.stage.paradev.com' }}
NEXT_PUBLIC_MARKETING_URL: https://paradev.com
NEXT_PUBLIC_ROOT_DOMAIN: ${{ secrets.NEXT_PUBLIC_ROOT_DOMAIN }}
NEXT_PUBLIC_ADMIN_URL: ${{ secrets.NEXT_PUBLIC_ADMIN_URL }}
Expand All @@ -378,7 +405,7 @@ jobs:
MEDIA_URL: ${{ secrets.MEDIA_URL }}
STATIC_URL: ${{ secrets.STATIC_URL }}
BETTER_AUTH_SECRET: ${{ secrets.BETTER_AUTH_SECRET }}
NEXT_PUBLIC_COOKIE_DOMAIN: stage.paradev.com
NEXT_PUBLIC_COOKIE_DOMAIN: ${{ inputs.mode == 'prepare-final' && 'paradev.com' || 'stage.paradev.com' }}
NEXT_PUBLIC_POSTHOG_KEY: ${{ secrets.NEXT_PUBLIC_POSTHOG_KEY }}
NEXT_PUBLIC_POSTHOG_HOST: ${{ secrets.NEXT_PUBLIC_POSTHOG_HOST }}
NEXT_PUBLIC_SENTRY_DSN_WEB: ${{ secrets.NEXT_PUBLIC_SENTRY_DSN_WEB }}
Expand Down Expand Up @@ -412,6 +439,7 @@ jobs:
--env DATABASE_URL=$DATABASE_URL \
--env DATABASE_URL_UNPOOLED=$DATABASE_URL_UNPOOLED \
--env BETTER_AUTH_SECRET=$BETTER_AUTH_SECRET \
--env DOMAIN_MOVE_ENABLED="$DOMAIN_MOVE_ENABLED" \
--env BROWSER_API_URL="$BROWSER_API_URL" \
--env NEXT_PUBLIC_API_URL=$NEXT_PUBLIC_API_URL \
--env NEXT_PUBLIC_WEB_URL=$NEXT_PUBLIC_WEB_URL \
Expand Down Expand Up @@ -444,7 +472,15 @@ jobs:
--env SERVER_ANTHROPIC_API_KEY=$SERVER_ANTHROPIC_API_KEY > "$RUNNER_TEMP/paradev-web-url"

- name: Assign only staging aliases after both deployments succeed
if: inputs.mode == 'stage'
env:
VERCEL_TOKEN: ${{ secrets.VERCEL_TOKEN }}
VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }}
run: python3 "$RUNNER_TEMP/paradev-staging-guard.py" alias

- name: Record final artifacts for routing approval
if: inputs.mode == 'prepare-final'
env:
VERCEL_TOKEN: ${{ secrets.VERCEL_TOKEN }}
VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }}
run: python3 "$RUNNER_TEMP/paradev-staging-guard.py" report
4 changes: 4 additions & 0 deletions .github/workflows/deploy-preview.yml
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,7 @@ jobs:
NEXT_PUBLIC_SENTRY_DSN_API: ${{ secrets.NEXT_PUBLIC_SENTRY_DSN_API }}
NEXT_PUBLIC_SENTRY_ENVIRONMENT: ${{ secrets.NEXT_PUBLIC_SENTRY_ENVIRONMENT }}
NEXT_PUBLIC_POSTHOG_KEY: ${{ secrets.NEXT_PUBLIC_POSTHOG_KEY }}
DOMAIN_MOVE_ENABLED: ${{ secrets.DOMAIN_MOVE_ENABLED }}
NEXT_PUBLIC_POSTHOG_HOST: ${{ secrets.NEXT_PUBLIC_POSTHOG_HOST }}
POSTHOG_API_KEY: ${{ secrets.POSTHOG_API_KEY }}
PLUGIN_CLIENT_METADATA_BASE_URL: ${{ secrets.PLUGIN_CLIENT_METADATA_BASE_URL }}
Expand Down Expand Up @@ -279,6 +280,7 @@ jobs:
--env NEXT_PUBLIC_SENTRY_DSN_API=$NEXT_PUBLIC_SENTRY_DSN_API \
--env NEXT_PUBLIC_SENTRY_ENVIRONMENT=$NEXT_PUBLIC_SENTRY_ENVIRONMENT \
--env NEXT_PUBLIC_POSTHOG_KEY=$NEXT_PUBLIC_POSTHOG_KEY \
--env DOMAIN_MOVE_ENABLED="$DOMAIN_MOVE_ENABLED" \
--env NEXT_PUBLIC_POSTHOG_HOST=$NEXT_PUBLIC_POSTHOG_HOST \
--env POSTHOG_API_KEY=$POSTHOG_API_KEY \
--env PLUGIN_CLIENT_METADATA_BASE_URL="$PLUGIN_CLIENT_METADATA_BASE_URL" \
Expand Down Expand Up @@ -416,6 +418,7 @@ jobs:
BETTER_AUTH_SECRET: ${{ secrets.BETTER_AUTH_SECRET }}
NEXT_PUBLIC_COOKIE_DOMAIN: ${{ contains(github.event.pull_request.labels.*.name, 'domain-preview') && format('pr-{0}.paradev.com', github.event.pull_request.number) || secrets.NEXT_PUBLIC_COOKIE_DOMAIN }}
NEXT_PUBLIC_POSTHOG_KEY: ${{ secrets.NEXT_PUBLIC_POSTHOG_KEY }}
DOMAIN_MOVE_ENABLED: ${{ secrets.DOMAIN_MOVE_ENABLED }}
NEXT_PUBLIC_POSTHOG_HOST: ${{ secrets.NEXT_PUBLIC_POSTHOG_HOST }}
NEXT_PUBLIC_SENTRY_DSN_WEB: ${{ secrets.NEXT_PUBLIC_SENTRY_DSN_WEB }}
NEXT_PUBLIC_SENTRY_ENVIRONMENT: ${{ secrets.NEXT_PUBLIC_SENTRY_ENVIRONMENT }}
Expand Down Expand Up @@ -455,6 +458,7 @@ jobs:
--env STATIC_URL=$STATIC_URL \
--env NEXT_PUBLIC_COOKIE_DOMAIN=$NEXT_PUBLIC_COOKIE_DOMAIN \
--env NEXT_PUBLIC_POSTHOG_KEY=$NEXT_PUBLIC_POSTHOG_KEY \
--env DOMAIN_MOVE_ENABLED="$DOMAIN_MOVE_ENABLED" \
--env NEXT_PUBLIC_POSTHOG_HOST=$NEXT_PUBLIC_POSTHOG_HOST \
--env NEXT_PUBLIC_SENTRY_DSN_WEB=$NEXT_PUBLIC_SENTRY_DSN_WEB \
--env NEXT_PUBLIC_SENTRY_ENVIRONMENT=$NEXT_PUBLIC_SENTRY_ENVIRONMENT \
Expand Down
115 changes: 115 additions & 0 deletions apps/api/src/app/api/auth/desktop/connect/desktopConnect.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
import { expect, mock, test } from "bun:test";
import { desktopConnect } from "./desktopConnect";

const base = "https://api.superset.sh/api/auth/desktop/connect";
const options = () => ({
webUrl: "https://app.superset.sh",
enabled: "true",
lookup: mock(async () => true),
signInSocial: mock(async (_input: unknown) =>
Response.json(
{ url: "https://accounts.example/oauth" },
{ headers: { "set-cookie": "old-state=issued; Secure" } },
),
),
});

test("validation errors happen before routing or OAuth", async () => {
for (const [query, error] of [
["", "Missing provider or state"],
["?provider=google", "Missing provider or state"],
["?provider=other&state=x", "Invalid provider"],
["?provider=github&state=x&protocol=https", "Invalid protocol"],
]) {
const dependencies = options();
const response = await desktopConnect(
new Request(base + query),
dependencies,
);
expect(response.status).toBe(400);
expect(await response.text()).toBe(error);
expect(dependencies.lookup).not.toHaveBeenCalled();
expect(dependencies.signInSocial).not.toHaveBeenCalled();
expect(response.headers.get("set-cookie")).toBeNull();
}
});

test("moves both providers and protocol variants before issuing old OAuth state, preserving raw query", async () => {
for (const provider of ["google", "github"]) {
for (const protocol of [
"superset",
"superset-dev",
"superset-my-worktree2",
"Superset",
]) {
const query = `?provider=${provider}&state=a%2Fb+c&state=duplicate&protocol=${protocol}&local_callback=http%3A%2F%2F127.0.0.1%3A3456%2Fauth%2Fcallback`;
const dependencies = options();
const response = await desktopConnect(
new Request(base + query),
dependencies,
);
expect(response.status).toBe(307);
expect(response.headers.get("location")).toBe(
`https://api.paradev.com/api/auth/desktop/connect${query}`,
);
expect(response.headers.get("cache-control")).toBe("private, no-store");
expect(response.headers.get("set-cookie")).not.toContain("old-state");
expect(dependencies.signInSocial).not.toHaveBeenCalled();
}
}
});

test("gate off retains existing OAuth response and loopback validation without lookup or rollout cookie", async () => {
for (const callback of [
"http://localhost:3456/auth/callback",
"https://evil.test/auth/callback",
"garbage",
]) {
const dependencies = { ...options(), enabled: "false" };
const response = await desktopConnect(
new Request(
`${base}?provider=google&state=test&local_callback=${encodeURIComponent(callback)}`,
),
dependencies,
);
expect(response.headers.get("location")).toBe(
"https://accounts.example/oauth",
);
expect(response.headers.getSetCookie()).toEqual([
"old-state=issued; Secure",
]);
expect(dependencies.lookup).not.toHaveBeenCalled();
const input = dependencies.signInSocial.mock.calls[0]?.[0] as {
body: { callbackURL: string };
};
const target = new URL(input.body.callbackURL);
expect(target.searchParams.get("desktop_state")).toBe("test");
expect(target.searchParams.get("desktop_local_callback")).toBe(
callback.startsWith("http://localhost") ? callback : null,
);
}
});

test("final, stage, preview and non-GET requests retain existing OAuth path", async () => {
for (const origin of [
"https://api.paradev.com",
"https://api.stage.paradev.com",
"https://api.pr-1.paradev.com",
]) {
const dependencies = options();
await desktopConnect(
new Request(
`${origin}/api/auth/desktop/connect?provider=github&state=test`,
),
dependencies,
);
expect(dependencies.lookup).not.toHaveBeenCalled();
expect(dependencies.signInSocial).toHaveBeenCalledTimes(1);
}
const dependencies = options();
await desktopConnect(
new Request(`${base}?provider=google&state=test`, { method: "HEAD" }),
dependencies,
);
expect(dependencies.lookup).not.toHaveBeenCalled();
});
Loading
Loading