mirror of
https://github.com/stack-auth/stack.git
synced 2026-06-13 21:01:21 +08:00
2055d98dea
<img width="1920" height="969" alt="Screenshot 2026-02-04 at 9 47 16 AM"
src="https://github.com/user-attachments/assets/d7d0cd04-0051-4fc4-b857-e6f87ee97a59"
/>
**This PR revolves around the following components**
1. Sequencer - sequences the updates in the internal db
2. Poller - polls for the latest updates to sync with the external db
3. Outgoing Request Handler - essentially a trigger that can make http
requests based on a change in the internal db
4. Sync Engine - syncs with the latest changes from the internal db to
the external db
**What has been done**
- Added a global sequence id for ProjectUser, ContactChannel and
DeletedRow.
- Added the deletedRow table to keep track of the rows that were deleted
across ProjectUser and ContactChannel.
- Added the OutgoingRequest table to keep track of the outgoing requests
- Added function for the sequencer to call to sequence updates
- Added a sequencer that sequences all the changes in the internal db
every 50 ms
- Added a poller that polls for the latest changes in the internal db
every 50 ms, and adds to a queue
- Added a Vercel cron that calls sequencer and poller every minute
- Added a queue that fulfills the outgoing requests by making http calls
(for external db sync, it calls the sync engine endpoint)
- Added a sync engine that uses the defined sql mapping query in the
user's schema to pull in the changes for the user, and sync them with
the external db
- Added tests to test out each functionality
**How to review this PR:**
1. Review the migrations (sequence id, deletedRow, triggers, backlog
sync) (all files created under the migrations folder)
2. Review sequencer
3. Review poller
4. Review the changes in schema
5. Review sync-engine (the function, and it's helper file)
6. Review the schema changes, and query mappings
7. Review the tests (basic, advanced and race, along with the helper
file)
8. Review the changes made in Dockerfile to support local testing using
the postgres docker
<!-- CURSOR_SUMMARY -->
---
> [!NOTE]
> Introduces a cron-driven external DB sync pipeline with global
sequencing, internal poller and webhook sync engine, new DB
tables/functions, config schema/mappings, and comprehensive e2e tests.
>
> - **Database (Prisma/Migrations)**:
> - Add global sequence (`global_seq_id`) and
`sequenceId`/`shouldUpdateSequenceId` to `ProjectUser`,
`ContactChannel`, `DeletedRow` with partial indexes.
> - Create `DeletedRow` (capture deletes) and `OutgoingRequest` (queue)
tables; add unique/indexes.
> - Add triggers/functions: `log_deleted_row`,
`reset_sequence_id_on_update`, `backfill_null_sequence_ids`,
`enqueue_tenant_sync`.
> - **Backend/API**:
> - New internal routes: `GET
/api/latest/internal/external-db-sync/sequencer`, `GET /poller`, `POST
/sync-engine` (Upstash-verified) for sync orchestration.
> - Add cron wiring: `vercel.json` schedules and local
`scripts/run-cron-jobs.ts`; start in dev via `dev` script.
> - Tweak route handler (remove noisy logging) without behavior change.
> - **Sync Engine**:
> - Implement `src/lib/external-db-sync.ts` to read tenant mappings and
upsert to external Postgres (schema bootstrap, param checks,
sequencing).
> - Add default mappings `DEFAULT_DB_SYNC_MAPPINGS` and config schema
`dbSync.externalDatabases` in shared config.
> - **Testing/Infra**:
> - Add extensive e2e tests (basics, advanced, race conditions) for
sequencing, idempotency, deletes, pagination, multi-mapping, and
permissions.
> - Docker compose: add `external-db-test` Postgres for tests; e2e deps
for `pg` types.
>
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
3f2a8efcfb. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **New Features**
* External PostgreSQL sync: automatic, batched replication with
mappings, resume/idempotency, and on-demand enqueueing.
* **Admin UI**
* Real-time External DB Sync dashboard and status API showing
per-mapping backlog, sequencer/poller/sync-engine telemetry, and fusebox
controls.
* **Tests**
* Large e2e suite: basic, advanced, race, high-volume tests and test
utilities for external DB sync.
* **Chores**
* DB migrations, CI/workflow updates, background cron runner and
local/dev test support.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
---------
Co-authored-by: Konsti Wohlwend <n2d4xc@gmail.com>
Co-authored-by: Bilal Godil <bg2002@gmail.com>
179 lines
6.3 KiB
YAML
179 lines
6.3 KiB
YAML
name: Runs E2E API Tests
|
|
|
|
on:
|
|
push:
|
|
branches:
|
|
- main
|
|
- dev
|
|
pull_request:
|
|
|
|
concurrency:
|
|
group: ${{ github.workflow }}-${{ github.ref }}
|
|
cancel-in-progress: ${{ github.ref != 'refs/heads/main' && github.ref != 'refs/heads/dev' }}
|
|
|
|
jobs:
|
|
build:
|
|
name: E2E Tests (Node ${{ matrix.node-version }}, Freestyle ${{ matrix.freestyle-mode }})
|
|
runs-on: ubicloud-standard-8
|
|
env:
|
|
NODE_ENV: test
|
|
STACK_ENABLE_HARDCODED_PASSKEY_CHALLENGE_FOR_TESTING: yes
|
|
STACK_DATABASE_CONNECTION_STRING: "postgres://postgres:PASSWORD-PLACEHOLDER--uqfEC1hmmv@localhost:8128/stackframe"
|
|
STACK_FORCE_EXTERNAL_DB_SYNC: "true"
|
|
STACK_EXTERNAL_DB_SYNC_MAX_DURATION_MS: "20000"
|
|
STACK_EXTERNAL_DB_SYNC_DIRECT: "false"
|
|
|
|
strategy:
|
|
matrix:
|
|
node-version: [22.x]
|
|
freestyle-mode: [mock, prod]
|
|
|
|
steps:
|
|
- uses: actions/checkout@v6
|
|
|
|
- name: Setup Node.js ${{ matrix.node-version }}
|
|
uses: actions/setup-node@v6
|
|
with:
|
|
node-version: ${{ matrix.node-version }}
|
|
|
|
- name: Setup pnpm
|
|
uses: pnpm/action-setup@v4
|
|
|
|
# Even just starting the Docker Compose as a daemon is slow because we have to download and build the images
|
|
# so, we run it in the background
|
|
- name: Start Docker Compose in background
|
|
uses: JarvusInnovations/background-action@v1.0.7
|
|
with:
|
|
run: docker compose -f docker/dependencies/docker.compose.yaml up --pull always -d &
|
|
# we don't need to wait on anything, just need to start the daemon
|
|
wait-on: /dev/null
|
|
tail: true
|
|
wait-for: 3s
|
|
log-output-if: true
|
|
|
|
- name: Install dependencies
|
|
run: pnpm install --frozen-lockfile
|
|
|
|
- name: Create .env.test.local file for apps/backend
|
|
run: cp apps/backend/.env.development apps/backend/.env.test.local
|
|
|
|
- name: Override Freestyle API key for prod mode
|
|
if: matrix.freestyle-mode == 'prod'
|
|
run: |
|
|
echo "STACK_FREESTYLE_API_KEY=${{ secrets.STACK_FREESTYLE_REAL_API_KEY }}" >> apps/backend/.env.test.local
|
|
|
|
- name: Create .env.test.local file for apps/dashboard
|
|
run: cp apps/dashboard/.env.development apps/dashboard/.env.test.local
|
|
|
|
- name: Create .env.test.local file for apps/e2e
|
|
run: cp apps/e2e/.env.development apps/e2e/.env.test.local
|
|
|
|
- name: Create .env.test.local file for docs
|
|
run: cp docs/.env.development docs/.env.test.local
|
|
|
|
- name: Create .env.test.local file for examples/cjs-test
|
|
run: cp examples/cjs-test/.env.development examples/cjs-test/.env.test.local
|
|
|
|
- name: Create .env.test.local file for examples/demo
|
|
run: cp examples/demo/.env.development examples/demo/.env.test.local
|
|
|
|
- name: Create .env.test.local file for examples/docs-examples
|
|
run: cp examples/docs-examples/.env.development examples/docs-examples/.env.test.local
|
|
|
|
- name: Create .env.test.local file for examples/e-commerce
|
|
run: cp examples/e-commerce/.env.development examples/e-commerce/.env.test.local
|
|
|
|
- name: Create .env.test.local file for examples/middleware
|
|
run: cp examples/middleware/.env.development examples/middleware/.env.test.local
|
|
|
|
- name: Create .env.test.local file for examples/supabase
|
|
run: cp examples/supabase/.env.development examples/supabase/.env.test.local
|
|
|
|
- name: Create .env.test.local file for examples/convex
|
|
run: cp examples/convex/.env.development examples/convex/.env.test.local
|
|
|
|
- name: Build
|
|
run: pnpm build
|
|
|
|
- name: Wait on Postgres
|
|
run: pnpm run wait-until-postgres-is-ready:pg_isready
|
|
|
|
- name: Wait on Inbucket
|
|
run: pnpx wait-on tcp:localhost:8129
|
|
|
|
- name: Wait on Svix
|
|
run: pnpx wait-on tcp:localhost:8113
|
|
|
|
- name: Wait on QStash
|
|
run: pnpx wait-on tcp:localhost:8125
|
|
|
|
- name: Initialize database
|
|
run: pnpm run db:init
|
|
|
|
- name: Start stack-backend in background
|
|
uses: JarvusInnovations/background-action@v1.0.7
|
|
with:
|
|
run: pnpm run start:backend --log-order=stream &
|
|
wait-on: |
|
|
http://localhost:8102
|
|
tail: true
|
|
wait-for: 30s
|
|
log-output-if: true
|
|
- name: Start stack-dashboard in background
|
|
uses: JarvusInnovations/background-action@v1.0.7
|
|
with:
|
|
run: pnpm run start:dashboard --log-order=stream &
|
|
wait-on: |
|
|
http://localhost:8101
|
|
tail: true
|
|
wait-for: 30s
|
|
log-output-if: true
|
|
- name: Start mock-oauth-server in background
|
|
uses: JarvusInnovations/background-action@v1.0.7
|
|
with:
|
|
run: pnpm run start:mock-oauth-server --log-order=stream &
|
|
wait-on: |
|
|
http://localhost:8102
|
|
tail: true
|
|
wait-for: 30s
|
|
log-output-if: true
|
|
- name: Start run-email-queue in background
|
|
uses: JarvusInnovations/background-action@v1.0.7
|
|
with:
|
|
run: pnpm -C apps/backend run run-email-queue --log-order=stream &
|
|
wait-on: |
|
|
http://localhost:8102
|
|
tail: true
|
|
wait-for: 30s
|
|
log-output-if: true
|
|
- name: Start run-cron-jobs in background
|
|
uses: JarvusInnovations/background-action@v1.0.7
|
|
with:
|
|
run: pnpm -C apps/backend run run-cron-jobs:test --log-order=stream &
|
|
wait-on: |
|
|
http://localhost:8102
|
|
tail: true
|
|
wait-for: 30s
|
|
log-output-if: true
|
|
|
|
- name: Wait 10 seconds
|
|
run: sleep 10
|
|
|
|
- name: Run tests
|
|
run: pnpm test run ${{ matrix.freestyle-mode == 'prod' && '--min-workers=1 --max-workers=1' || '' }}
|
|
|
|
- name: Run tests again (attempt 1)
|
|
if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/dev'
|
|
run: pnpm test run ${{ matrix.freestyle-mode == 'prod' && '--min-workers=1 --max-workers=1' || '' }}
|
|
|
|
- name: Run tests again (attempt 2)
|
|
if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/dev'
|
|
run: pnpm test run ${{ matrix.freestyle-mode == 'prod' && '--min-workers=1 --max-workers=1' || '' }}
|
|
|
|
- name: Verify data integrity
|
|
run: pnpm run verify-data-integrity --no-bail
|
|
|
|
- name: Print Docker Compose logs
|
|
if: always()
|
|
run: docker compose -f docker/dependencies/docker.compose.yaml logs
|