diff --git a/.agents/skills/self-hosted-release/SKILL.md b/.agents/skills/self-hosted-release/SKILL.md new file mode 100644 index 0000000000..989b8f4c1a --- /dev/null +++ b/.agents/skills/self-hosted-release/SKILL.md @@ -0,0 +1,139 @@ +--- +name: self-hosted-release +description: Enforce Appwrite self-hosted release readiness checks. Use when validating a self-hosted RC or final release, running fresh Docker Compose install tests, testing realistic e2e workflows, discovering the previous stable release baseline, upgrading seeded data from the previous self-hosted release, verifying migrations, compatibility filters, release metadata, installer behavior, or deciding whether a self-hosted release is safe to publish. +compatibility: Requires an Appwrite server repository checkout, Docker Compose, network access to fetch tags/images, and the normal Appwrite test environment. +--- + +# Self-Hosted Release + +## Purpose + +Use this skill as a release gate for Appwrite self-hosted RCs and final releases. Do not treat container health or metadata review as enough. A release is not ready until a fresh self-hosted stack works with realistic workflows and an upgrade from the previous stable self-hosted release preserves seeded data through migrations. + +## Release Context + +1. Confirm the current branch and target version: + - Check the branch name, `app/init/constants.php`, release notes, Docker image tags, and the user's stated target. + - If those disagree, stop and resolve the target version before validating. +2. Determine the previous stable self-hosted baseline automatically: + - Prefer remote tags so stale local tags do not mislead the gate. + - Use stable semver tags lower than the target version; ignore RC, beta, alpha, dev, and other prerelease tags. + - Pick the highest stable version lower than the target as the upgrade and compatibility baseline. + - Only ask the user for a baseline if no stable lower tag can be discovered or the target version is ambiguous. +3. Record the target version, target commit SHA, previous stable baseline, database adapter(s), Compose profile(s), and any release-specific risks before starting validation. + +Useful commands: + +```sh +git rev-parse --abbrev-ref HEAD +git rev-parse HEAD +rg -n "APP_VERSION_STABLE|APP_CACHE_BUSTER" app/init/constants.php +git ls-remote --tags origin "refs/tags/*" +``` + +## Fresh Install Gate + +Build and run the target release with the local Docker Compose stack, then test it like a real self-hosted install. + +1. Start from a clean stack and build the target: + +```sh +docker compose down -v +docker compose up -d --force-recreate --build --wait +docker compose exec -T appwrite vars +curl -fsS http://localhost/v1/health/version +``` + +2. Inspect runtime health before running tests: + - Check `docker compose ps` and `docker compose logs` for crash loops, missing env vars, failed mounts, worker failures, executor/runtime failures, migration errors, queue errors, and warnings that indicate broken self-hosted wiring. + - Verify required services are reachable through the public HTTP surface, not only from inside containers. + - If a route is advertised by specs, docs, install templates, or release notes, verify the route actually exists and returns the expected auth/validation behavior. + +3. Run the Appwrite test suite inside Docker: + +```sh +docker compose exec -T appwrite test /usr/src/code/tests/unit +docker compose exec -T appwrite test /usr/src/code/tests/e2e/General +docker compose exec -T appwrite sh -lc 'vendor/bin/paratest --processes "$(nproc)" /usr/src/code/tests/e2e/Services --exclude-group abuseEnabled --exclude-group screenshots' +``` + +When validating a risky release, broaden the matrix with the same database adapters and modes CI uses. At minimum, cover the default self-hosted adapter and every adapter touched by migrations, storage, query behavior, relationships, or installer changes. + +4. Exercise realistic workflows with real-ish data: + - Create console users, projects, API keys, platforms, webhooks, teams, memberships, and sessions. + - Create databases/tables/columns/indexes/relationships and rows with varied permissions, sizes, types, pagination, filters, and updates. + - Create storage buckets and files, then read, update, preview/download, and delete them through public APIs. + - Create and execute functions/sites when compute, runtimes, builds, domains, or executor behavior changed. + - Exercise messaging, realtime, domains, auth providers, abuse/rate-limit behavior, and background workers when they are in scope. + - Use public APIs and SDK-like calls wherever practical; direct database inspection is only supporting evidence. + +Block the release for any missing env var, broken container dependency, failing public route, unexpected 5xx, queue/worker failure, test failure, or workflow that only works with unrealistic empty data. + +## Upgrade Gate + +Validate upgrade from the previous stable self-hosted release to the target release using the same persisted volumes and configuration. + +1. Install the previous stable baseline: + - Use the discovered baseline tag/image, not a hardcoded version. + - Start with the documented self-hosted install path and a clean volume set. + - Confirm `/v1/health/version` reports the baseline version. + +2. Seed broad, realistic data on the baseline before upgrading: + - Include multiple projects, users, teams, memberships, API keys, sessions/tokens, databases/tables/rows, attributes, indexes, relationships, permissions, buckets, files, functions/sites, executions, webhooks, messaging/realtime resources, domains, and project settings as applicable. + - Include edge-shaped data that migrations commonly break: empty values, long strings, arrays, enums, relationships, large files, many rows, deleted/disabled resources, and mixed permissions. + - Capture enough IDs and API calls to verify the same resources after upgrade. + +3. Upgrade the baseline stack to the target release: + - Reuse the same volumes and configuration. + - Replace the Appwrite image/tag with the target release build. + - Run the documented upgrade path and required migration command(s). + - Capture logs for appwrite, workers, databases, redis, executor, and proxy services during the first boot. + +4. Verify migration behavior: + - Migration completes without fatal errors, partial failures, or skipped projects. + - Running the migration again is safe and idempotent. + - A failed or interrupted migration can be retried without data loss when that scenario is relevant to the changed migration. + - Existing volumes can be reused after restart. + +5. Verify seeded data after upgrade through public APIs: + - Fetch and mutate seeded projects, users, teams, permissions, rows, files, functions/sites, executions, domains, webhooks, messaging/realtime resources, and settings. + - Confirm indexes, relationships, file contents, execution history, auth/session behavior, and background worker side effects still work. + - Run focused e2e tests against the upgraded stack for every service touched by migration, compatibility, installer, or public API changes. + +Block the release for migration failure, non-idempotency, data loss, changed permissions, broken reads/writes on upgraded data, failed workers/queues after upgrade, or any behavior that only works on fresh installs. + +## Metadata And Compatibility Gate + +Review release metadata after the runtime gates, not instead of them: + +- `app/init/constants.php`: `APP_VERSION_STABLE` is the target version and `APP_CACHE_BUSTER` is incremented. +- `docker-compose.yml` and `app/views/install/compose.phtml`: Appwrite and console image tags are correct for the target release. +- `README.md` and `README-CN.md`: self-hosted install snippets use the target release. +- `src/Appwrite/Migration/Migration.php`: the target version maps to the correct migration class. +- `CHANGES.md`: the target version has user-facing notes for notable changes, fixes, migrations, compatibility notes, and self-hosted operator impact. +- Generated/public outputs are refreshed when API specs, SDKs, install templates, Docker Compose output, or metadata-driven docs changed. + +For public API changes, compare against the previous stable baseline: + +- Look for renamed/removed fields, new required inputs, enum changes, response model changes, status-code changes, route behavior changes, permission changes, and SDK-visible serialization changes. +- Request filters live in `src/Appwrite/Utopia/Request/Filters/V*.php`. +- Response filters live in `src/Appwrite/Utopia/Response/Filters/V*.php`. +- Filters must be registered in `app/controllers/general.php` for the correct `x-appwrite-response-format` boundary. +- Every compatibility filter needs focused unit coverage under `tests/unit/Utopia/Request/Filters` or `tests/unit/Utopia/Response/Filters`. +- Add service e2e coverage with `x-appwrite-response-format` when behavior depends on routing, auth, persistence, validation, or serialization. + +Block the release when a public breaking change lacks a compatibility filter and tests, unless the release owner explicitly accepts the break and documents it in release notes. + +## Release Decision + +Do not approve an RC or final self-hosted release until all gates pass: + +- Fresh install stack builds, starts, and survives realistic workflows. +- Full relevant tests pass inside Docker. +- No missing env vars, broken mounts, failed workers, broken routes, or unexplained runtime errors remain. +- Previous stable release is installed, seeded with broad data, upgraded to the target, migrated, restarted, and verified through public APIs. +- Migrations are complete, idempotent, retryable where relevant, and preserve seeded data. +- Compatibility filters and tests cover unintended public breaking changes. +- Version constants, image tags, install snippets, migration mapping, generated outputs, and changelog are current. + +For every RC/final validation, produce a short release evidence summary with: target version, commit SHA, previous stable baseline, tested database adapters and modes, fresh install scenarios, upgrade scenarios, seeded data categories, test commands and results, blockers found, fixes applied, and remaining owner-approved risks. diff --git a/.agents/skills/self-hosted-release/agents/openai.yaml b/.agents/skills/self-hosted-release/agents/openai.yaml new file mode 100644 index 0000000000..821102bce0 --- /dev/null +++ b/.agents/skills/self-hosted-release/agents/openai.yaml @@ -0,0 +1,4 @@ +interface: + display_name: "Self-Hosted Release" + short_description: "Validate Appwrite self-hosted release gates" + default_prompt: "Use $self-hosted-release to validate a fresh install and upgrade path for an Appwrite self-hosted release." diff --git a/.env b/.env index 9c7e6923b8..900c0e78c5 100644 --- a/.env +++ b/.env @@ -1,45 +1,40 @@ _APP_ENV=development _APP_EDITION=self-hosted _APP_LOCALE=en +_APP_OPENSSL_KEY_V1=your-secret-key +_APP_RULES_FORMAT=md5 +_APP_SYSTEM_RESPONSE_FORMAT= +_APP_TRUSTED_HEADERS=x-forwarded-for +_APP_POOL_ADAPTER=stack _APP_WORKER_PER_CORE=6 +_APP_WORKERS_NUM=1 +_APP_WORKER_MAX_COROUTINES=1 +_APP_WORKER_SCREENSHOTS_ROUTER=http://appwrite +_APP_REALTIME_TAIL_RATE=50 _APP_COMPRESSION_ENABLED=enabled _APP_COMPRESSION_MIN_SIZE_BYTES=1024 -_APP_CONSOLE_WHITELIST_ROOT=disabled -_APP_CONSOLE_WHITELIST_EMAILS= -_APP_CONSOLE_SESSION_ALERTS=enabled -_APP_CONSOLE_WHITELIST_IPS= -_APP_CONSOLE_COUNTRIES_DENYLIST=AQ -_APP_CONSOLE_HOSTNAMES=localhost,appwrite.io,*.appwrite.io -_APP_CONSOLE_SCHEMA=appwriteio -_APP_MIGRATION_HOST=appwrite -_APP_SYSTEM_EMAIL_NAME=Appwrite -_APP_SYSTEM_EMAIL_ADDRESS=noreply@appwrite.io -_APP_SYSTEM_TEAM_EMAIL=team@appwrite.io -_APP_EMAIL_SECURITY=security@appwrite.io -_APP_EMAIL_CERTIFICATES=certificates@appwrite.io -_APP_SYSTEM_RESPONSE_FORMAT= -_APP_CUSTOM_DOMAIN_DENY_LIST= -_APP_OPTIONS_ABUSE=disabled -_APP_OPTIONS_ROUTER_PROTECTION=disabled -_APP_OPTIONS_FORCE_HTTPS=disabled -_APP_OPTIONS_ROUTER_FORCE_HTTPS=disabled -_APP_OPENSSL_KEY_V1=your-secret-key -_APP_DNS=172.16.238.100 # CoreDNS _APP_DOMAIN=appwrite.test -_APP_CONSOLE_DOMAIN=localhost -_APP_CONSOLE_TRUSTED_PROJECTS=trusted-project,another-trusted-project _APP_DOMAIN_FUNCTIONS=functions.localhost _APP_DOMAIN_SITES=sites.localhost,rebranded.localhost -_APP_DOMAIN_TARGET_CNAME=cname.localhost _APP_DOMAIN_TARGET_A=203.0.0.1 _APP_DOMAIN_TARGET_AAAA=::1 _APP_DOMAIN_TARGET_CAA=digicert.com -_APP_RULES_FORMAT=md5 -_APP_REDIS_HOST=redis -_APP_REDIS_PORT=6379 -_APP_REDIS_PASS= -_APP_REDIS_USER= -COMPOSE_PROFILES=mariadb,mongodb,postgresql +_APP_DOMAIN_TARGET_CNAME=cname.localhost +_APP_CUSTOM_DOMAIN_DENY_LIST= +_APP_DNS=172.16.238.100 +_APP_OPTIONS_FORCE_HTTPS=disabled +_APP_OPTIONS_ROUTER_FORCE_HTTPS=disabled +_APP_OPTIONS_ROUTER_PROTECTION=disabled +_APP_OPTIONS_ABUSE=disabled +_APP_CONSOLE_DOMAIN=localhost +_APP_CONSOLE_HOSTNAMES=localhost,appwrite.io,*.appwrite.io +_APP_CONSOLE_SCHEMA=appwriteio +_APP_CONSOLE_SESSION_ALERTS=enabled +_APP_CONSOLE_TRUSTED_PROJECTS=trusted-project,another-trusted-project +_APP_CONSOLE_COUNTRIES_DENYLIST=AQ +_APP_CONSOLE_WHITELIST_EMAILS= +_APP_CONSOLE_WHITELIST_IPS= +_APP_CONSOLE_WHITELIST_ROOT=disabled _APP_DB_ADAPTER=mongodb _APP_DB_HOST=mongodb _APP_DB_PORT=27017 @@ -47,18 +42,27 @@ _APP_DB_SCHEMA=appwrite _APP_DB_USER=user _APP_DB_PASS=password _APP_DB_ROOT_PASS=rootsecretpassword -_APP_DATABASE_SHARED_TABLES= _APP_DATABASE_SHARED_NAMESPACE= +_APP_DATABASE_SHARED_TABLES= _APP_DB_ADAPTER_DOCUMENTSDB=mongodb _APP_DB_HOST_DOCUMENTSDB=mongodb _APP_DB_PORT_DOCUMENTSDB=27017 _APP_DB_ADAPTER_VECTORSDB=postgresql _APP_DB_HOST_VECTORSDB=postgresql _APP_DB_PORT_VECTORSDB=5432 -_APP_EMBEDDING_MODELS=nomic-embed-text +_APP_REDIS_HOST=redis +_APP_REDIS_PORT=6379 +_APP_REDIS_USER= +_APP_REDIS_PASS= _APP_EMBEDDING_ENDPOINT='http://appwrite-embedding:3000/embed' +_APP_EMBEDDING_MODELS=nomic-embed-text _APP_EMBEDDING_TIMEOUT=30000 _APP_STORAGE_DEVICE=Local +_APP_STORAGE_LIMIT=30000000 +_APP_STORAGE_PREVIEW_LIMIT=20000000 +_APP_STORAGE_ANTIVIRUS=disabled +_APP_STORAGE_ANTIVIRUS_HOST=clamav +_APP_STORAGE_ANTIVIRUS_PORT=3310 _APP_STORAGE_S3_ACCESS_KEY= _APP_STORAGE_S3_SECRET= _APP_STORAGE_S3_REGION=us-east-1 @@ -80,9 +84,11 @@ _APP_STORAGE_WASABI_ACCESS_KEY= _APP_STORAGE_WASABI_SECRET= _APP_STORAGE_WASABI_REGION=eu-central-1 _APP_STORAGE_WASABI_BUCKET= -_APP_STORAGE_ANTIVIRUS=disabled -_APP_STORAGE_ANTIVIRUS_HOST=clamav -_APP_STORAGE_ANTIVIRUS_PORT=3310 +_APP_SYSTEM_EMAIL_NAME=Appwrite +_APP_SYSTEM_EMAIL_ADDRESS=noreply@appwrite.io +_APP_SYSTEM_TEAM_EMAIL=team@appwrite.io +_APP_EMAIL_SECURITY=security@appwrite.io +_APP_EMAIL_CERTIFICATES=certificates@appwrite.io _APP_SMTP_HOST=maildev _APP_SMTP_PORT=1025 _APP_SMTP_SECURE= @@ -91,67 +97,56 @@ _APP_SMTP_PASSWORD=password _APP_SMS_PROVIDER=sms://username:password@mock _APP_SMS_FROM=+123456789 _APP_SMS_PROJECTS_DENY_LIST= -_APP_STORAGE_LIMIT=30000000 -_APP_STORAGE_PREVIEW_LIMIT=20000000 +_APP_MESSAGE_EMAIL_TEST_DSN= +_APP_MESSAGE_PUSH_TEST_DSN= +_APP_MESSAGE_SMS_TEST_DSN= _APP_COMPUTE_SIZE_LIMIT=30000000 -_APP_FUNCTIONS_TIMEOUT=900 -_APP_SITES_TIMEOUT=30 _APP_COMPUTE_BUILD_TIMEOUT=900 _APP_COMPUTE_CPUS=8 _APP_COMPUTE_MEMORY=8192 _APP_COMPUTE_INACTIVE_THRESHOLD=600 _APP_COMPUTE_MAINTENANCE_INTERVAL=600 _APP_COMPUTE_RUNTIMES_NETWORK=runtimes -_APP_EXECUTOR_SECRET=your-secret-key -_APP_EXECUTOR_HOST=http://exc1/v1 -_APP_BROWSER_HOST=http://appwrite-browser:3000/v1 _APP_FUNCTIONS_RUNTIMES=node-22 +_APP_FUNCTIONS_TIMEOUT=900 +_APP_FUNCTIONS_CREATION_ABUSE_LIMIT=5000 _APP_SITES_RUNTIMES=static-1,node-22 +_APP_SITES_TIMEOUT=30 +_APP_EXECUTOR_HOST=http://exc1/v1 +_APP_EXECUTOR_SECRET=your-secret-key +_APP_EXECUTOR_IMAGES=openruntimes/node:v5-22,openruntimes/static:v5-1 +_APP_BROWSER_HOST=http://appwrite-browser:3000/v1 +_APP_DOCKER_HUB_USERNAME= +_APP_DOCKER_HUB_PASSWORD= _APP_MAINTENANCE_INTERVAL=86400 _APP_MAINTENANCE_START_TIME=12:00 -_APP_MAINTENANCE_RETENTION_CACHE=2592000 -_APP_MAINTENANCE_RETENTION_EXECUTION=1209600 _APP_MAINTENANCE_RETENTION_ABUSE=86400 _APP_MAINTENANCE_RETENTION_AUDIT=1209600 _APP_MAINTENANCE_RETENTION_AUDIT_CONSOLE=15778800 -_APP_USAGE_AGGREGATION_INTERVAL=30 -_APP_STATS_RESOURCES_INTERVAL=30 -_APP_MAINTENANCE_RETENTION_USAGE_HOURLY=8640000 +_APP_MAINTENANCE_RETENTION_CACHE=2592000 +_APP_MAINTENANCE_RETENTION_EXECUTION=1209600 _APP_MAINTENANCE_RETENTION_SCHEDULES=86400 -_APP_INTERVAL_DOMAIN_VERIFICATION=120 +_APP_MAINTENANCE_RETENTION_USAGE_HOURLY=8640000 _APP_INTERVAL_CLEANUP_STALE_EXECUTIONS=300 +_APP_INTERVAL_DOMAIN_VERIFICATION=120 +_APP_USAGE_AGGREGATION_INTERVAL=30 _APP_USAGE_STATS=enabled -_APP_LOGGING_CONFIG= -_APP_LOGGING_CONFIG_REALTIME= +_APP_STATS_RESOURCES_INTERVAL=30 _APP_GRAPHQL_INTROSPECTION=enabled _APP_GRAPHQL_MAX_BATCH_SIZE=10 _APP_GRAPHQL_MAX_COMPLEXITY=250 _APP_GRAPHQL_MAX_DEPTH=4 -_APP_DOCKER_HUB_USERNAME= -_APP_DOCKER_HUB_PASSWORD= -_APP_VCS_GITHUB_APP_NAME= -_APP_VCS_GITHUB_PRIVATE_KEY=disabled -_APP_VCS_GITHUB_APP_ID= -_APP_VCS_GITHUB_CLIENT_ID= -_APP_VCS_GITHUB_CLIENT_SECRET= -_APP_VCS_GITHUB_WEBHOOK_SECRET= +_APP_ASSISTANT_OPENAI_API_KEY= +_APP_LOGGING_CONFIG= +_APP_LOGGING_CONFIG_REALTIME= +_APP_MIGRATION_HOST=appwrite _APP_MIGRATIONS_FIREBASE_CLIENT_ID= _APP_MIGRATIONS_FIREBASE_CLIENT_SECRET= -_APP_ASSISTANT_OPENAI_API_KEY= -_APP_MESSAGE_SMS_TEST_DSN= -_APP_MESSAGE_EMAIL_TEST_DSN= -_APP_MESSAGE_PUSH_TEST_DSN= -_APP_WEBHOOK_MAX_FAILED_ATTEMPTS=10 _APP_PROJECT_REGIONS=default -_APP_FUNCTIONS_CREATION_ABUSE_LIMIT=5000 -_APP_STATS_USAGE_DUAL_WRITING_DBS=database_db_main -_APP_TRUSTED_HEADERS=x-forwarded-for -_APP_POOL_ADAPTER=stack -_APP_WORKER_SCREENSHOTS_ROUTER=http://appwrite -_TESTS_OAUTH2_GITHUB_CLIENT_ID= -_TESTS_OAUTH2_GITHUB_CLIENT_SECRET= - -_APP_WORKERS_NUM=1 -_APP_WORKER_MAX_COROUTINES=1 - -_APP_REALTIME_TAIL_RATE=50 \ No newline at end of file +_APP_VCS_GITHUB_APP_ID= +_APP_VCS_GITHUB_APP_NAME= +_APP_VCS_GITHUB_CLIENT_ID= +_APP_VCS_GITHUB_CLIENT_SECRET= +_APP_VCS_GITHUB_PRIVATE_KEY=disabled +_APP_VCS_GITHUB_WEBHOOK_SECRET= +_APP_WEBHOOK_MAX_FAILED_ATTEMPTS=10 diff --git a/README-CN.md b/README-CN.md index 212b5bb08d..8920e47aec 100644 --- a/README-CN.md +++ b/README-CN.md @@ -161,6 +161,8 @@ docker run -it --rm ` | | [PHP 快速开始](https://appwrite.io/docs/quick-starts/php) | | | [Kotlin 快速开始](https://appwrite.io/docs/quick-starts/kotlin) | | | [Swift 快速开始](https://appwrite.io/docs/quick-starts/swift) | +| | [Go 快速开始](https://appwrite.io/docs/quick-starts/go) | +| | [Rust 快速开始](https://appwrite.io/docs/quick-starts/rust) | ### 软件服务 @@ -185,20 +187,22 @@ docker run -it --rm ` - :white_check_mark:   [Web](https://github.com/appwrite/sdk-for-web) (由 Appwrite 团队维护) - :white_check_mark:   [Flutter](https://github.com/appwrite/sdk-for-flutter) (由 Appwrite 团队维护) -- :white_check_mark:   [Apple](https://github.com/appwrite/sdk-for-apple) - **公测** (由 Appwrite 团队维护) +- :white_check_mark:   [Apple](https://github.com/appwrite/sdk-for-apple) (由 Appwrite 团队维护) - :white_check_mark:   [Android](https://github.com/appwrite/sdk-for-android) (由 Appwrite 团队维护) +- :white_check_mark:   [React Native](https://github.com/appwrite/sdk-for-react-native) - **公测** (由 Appwrite 团队维护) #### 服务器 -- :white_check_mark:   [NodeJS](https://github.com/appwrite/sdk-for-node) (由 Appwrite 团队维护) -- :white_check_mark:   [PHP](https://github.com/appwrite/sdk-for-php) (由 Appwrite 团队维护) -- :white_check_mark:   [Dart](https://github.com/appwrite/sdk-for-dart) - (由 Appwrite 团队维护) -- :white_check_mark:   [Deno](https://github.com/appwrite/sdk-for-deno) - **公测** (由 Appwrite 团队维护) -- :white_check_mark:   [Ruby](https://github.com/appwrite/sdk-for-ruby) (由 Appwrite 团队维护) +- :white_check_mark:   [Node.js](https://github.com/appwrite/sdk-for-node) (由 Appwrite 团队维护) - :white_check_mark:   [Python](https://github.com/appwrite/sdk-for-python) (由 Appwrite 团队维护) -- :white_check_mark:   [Kotlin](https://github.com/appwrite/sdk-for-kotlin) - **公测** (由 Appwrite 团队维护) -- :white_check_mark:   [Apple](https://github.com/appwrite/sdk-for-apple) - **公测** (由 Appwrite 团队维护) -- :white_check_mark:   [.NET](https://github.com/appwrite/sdk-for-dotnet) - **公测** (由 Appwrite 团队维护) +- :white_check_mark:   [Dart](https://github.com/appwrite/sdk-for-dart) (由 Appwrite 团队维护) +- :white_check_mark:   [PHP](https://github.com/appwrite/sdk-for-php) (由 Appwrite 团队维护) +- :white_check_mark:   [Ruby](https://github.com/appwrite/sdk-for-ruby) (由 Appwrite 团队维护) +- :white_check_mark:   [.NET](https://github.com/appwrite/sdk-for-dotnet) (由 Appwrite 团队维护) +- :white_check_mark:   [Go](https://github.com/appwrite/sdk-for-go) (由 Appwrite 团队维护) +- :white_check_mark:   [Swift](https://github.com/appwrite/sdk-for-swift) (由 Appwrite 团队维护) +- :white_check_mark:   [Kotlin](https://github.com/appwrite/sdk-for-kotlin) (由 Appwrite 团队维护) +- :white_check_mark:   [Rust](https://github.com/appwrite/sdk-for-rust) (由 Appwrite 团队维护) #### 开发者社区 diff --git a/README.md b/README.md index 88d527f060..8bcad82564 100644 --- a/README.md +++ b/README.md @@ -166,6 +166,8 @@ Getting started with Appwrite is as easy as creating a new project, choosing you | | [Quick start for PHP](https://appwrite.io/docs/quick-starts/php) | | | [Quick start for Kotlin](https://appwrite.io/docs/quick-starts/kotlin) | | | [Quick start for Swift](https://appwrite.io/docs/quick-starts/swift) | +| | [Quick start for Go](https://appwrite.io/docs/quick-starts/go) | +| | [Quick start for Rust](https://appwrite.io/docs/quick-starts/rust) | ### SDKs @@ -181,15 +183,16 @@ Below is a list of currently supported platforms and languages. If you would lik #### Server -- :white_check_mark:   [NodeJS](https://github.com/appwrite/sdk-for-node) -- :white_check_mark:   [PHP](https://github.com/appwrite/sdk-for-php) -- :white_check_mark:   [Dart](https://github.com/appwrite/sdk-for-dart) -- :white_check_mark:   [Deno](https://github.com/appwrite/sdk-for-deno) -- :white_check_mark:   [Ruby](https://github.com/appwrite/sdk-for-ruby) +- :white_check_mark:   [Node.js](https://github.com/appwrite/sdk-for-node) - :white_check_mark:   [Python](https://github.com/appwrite/sdk-for-python) -- :white_check_mark:   [Kotlin](https://github.com/appwrite/sdk-for-kotlin) -- :white_check_mark:   [Swift](https://github.com/appwrite/sdk-for-swift) +- :white_check_mark:   [Dart](https://github.com/appwrite/sdk-for-dart) +- :white_check_mark:   [PHP](https://github.com/appwrite/sdk-for-php) +- :white_check_mark:   [Ruby](https://github.com/appwrite/sdk-for-ruby) - :white_check_mark:   [.NET](https://github.com/appwrite/sdk-for-dotnet) +- :white_check_mark:   [Go](https://github.com/appwrite/sdk-for-go) +- :white_check_mark:   [Swift](https://github.com/appwrite/sdk-for-swift) +- :white_check_mark:   [Kotlin](https://github.com/appwrite/sdk-for-kotlin) +- :white_check_mark:   [Rust](https://github.com/appwrite/sdk-for-rust) Looking for more SDKs? - Help us by contributing a pull request to our [SDK Generator](https://github.com/appwrite/sdk-generator)! diff --git a/app/controllers/api/account.php b/app/controllers/api/account.php index 5ecae9c635..36ff0256a2 100644 --- a/app/controllers/api/account.php +++ b/app/controllers/api/account.php @@ -447,13 +447,13 @@ Http::get('/v1/account') contentType: ContentType::JSON )) ->inject('response') - ->inject('user') - ->action(function (Response $response, Document $user) { - if ($user->isEmpty()) { + ->inject('targetUser') + ->action(function (Response $response, User $targetUser) { + if ($targetUser->isEmpty()) { throw new Exception(Exception::USER_NOT_FOUND); } - $response->dynamic($user, Response::MODEL_ACCOUNT); + $response->dynamic($targetUser, Response::MODEL_ACCOUNT); }); Http::delete('/v1/account') @@ -476,20 +476,20 @@ Http::delete('/v1/account') ], contentType: ContentType::NONE )) - ->inject('user') + ->inject('targetUser') ->inject('project') ->inject('response') ->inject('dbForProject') ->inject('queueForEvents') ->inject('publisherForDeletes') ->inject('authorization') - ->action(function (Document $user, Document $project, Response $response, Database $dbForProject, Event $queueForEvents, DeletePublisher $publisherForDeletes, Authorization $authorization) { - if ($user->isEmpty()) { + ->action(function (User $targetUser, Document $project, Response $response, Database $dbForProject, Event $queueForEvents, DeletePublisher $publisherForDeletes, Authorization $authorization) { + if ($targetUser->isEmpty()) { throw new Exception(Exception::USER_NOT_FOUND); } if ($project->getId() === 'console') { - $memberships = $user->getAttribute('memberships', []); + $memberships = $targetUser->getAttribute('memberships', []); foreach ($memberships as $membership) { if (!$membership->getAttribute('confirm', false)) { continue; @@ -505,17 +505,17 @@ Http::delete('/v1/account') } } - $dbForProject->deleteDocument('users', $user->getId()); + $dbForProject->deleteDocument('users', $targetUser->getId()); $publisherForDeletes->enqueue(new DeleteMessage( project: $project, type: DELETE_TYPE_DOCUMENT, - document: $user, + document: $targetUser, )); $queueForEvents - ->setParam('userId', $user->getId()) - ->setPayload($response->output($user, Response::MODEL_USER)); + ->setParam('userId', $targetUser->getId()) + ->setPayload($response->output($targetUser, Response::MODEL_USER)); $response->noContent(); }); diff --git a/app/controllers/shared/api.php b/app/controllers/shared/api.php index 4b5f7170ff..30377334d0 100644 --- a/app/controllers/shared/api.php +++ b/app/controllers/shared/api.php @@ -99,7 +99,9 @@ Http::init() ->inject('team') ->inject('apiKey') ->inject('authorization') - ->action(function (Route $route, Request $request, Database $dbForPlatform, Database $dbForProject, AuditContext $auditContext, Document $project, User $user, ?Document $session, array $servers, string $mode, Document $team, ?Key $apiKey, Authorization $authorization) { + ->inject('impersonatorUser') + ->inject('targetUser') + ->action(function (Route $route, Request $request, Database $dbForPlatform, Database $dbForProject, AuditContext $auditContext, Document $project, User $user, ?Document $session, array $servers, string $mode, Document $team, ?Key $apiKey, Authorization $authorization, Document $impersonatorUser, User $targetUser) { /** * Handle user authentication and session validation. @@ -353,7 +355,7 @@ Http::init() !$user->isEmpty() && ( $user->getAttribute('impersonator', false) - || $user->getAttribute('impersonatorUserId') + || !$impersonatorUser->isEmpty() ) ) { $scopes[] = 'users.read'; @@ -361,10 +363,16 @@ Http::init() } $authorization->addRole($role); - foreach ($user->getRoles($authorization) as $authRole) { + $rolesSource = $impersonatorUser->isEmpty() ? $user : $targetUser; + foreach ($rolesSource->getRoles($authorization) as $authRole) { $authorization->addRole($authRole); } + if (!$impersonatorUser->isEmpty() && !$targetUser->isEmpty()) { + $dbForProject->setMetadata('user', $targetUser->getId()); + $dbForPlatform->setMetadata('user', $targetUser->getId()); + } + /** * We disable authorization checks above to ensure other endpoints (list teams, members, etc.) will continue working. * But, for actions on resources (sites, functions, etc.) in a non-console project, we explicitly check @@ -391,11 +399,10 @@ Http::init() } if (! empty($user->getId())) { - $impersonatorUserId = $user->getAttribute('impersonatorUserId'); $accessedAt = $user->getAttribute('accessedAt', 0); // Skip updating accessedAt for impersonated requests so we don't attribute activity to the target user. - if (! $impersonatorUserId && DateTime::formatTz(DateTime::addSeconds(new \DateTime(), -APP_USER_ACCESS)) > $accessedAt) { + if ($impersonatorUser->isEmpty() && DateTime::formatTz(DateTime::addSeconds(new \DateTime(), -APP_USER_ACCESS)) > $accessedAt) { $user->setAttribute('accessedAt', DateTime::now()); if ($project->getId() !== 'console' && $mode !== APP_MODE_ADMIN) { @@ -410,6 +417,8 @@ Http::init() } } + $rolesSource = $impersonatorUser->isEmpty() ? $user : $targetUser; + // Steps 7-9: Access Control - Method, Namespace and Scope Validation $method = $route->getLabel('sdk', false); @@ -425,7 +434,7 @@ Http::init() if ( array_key_exists($namespace, $project->getAttribute('services', [])) && ! $project->getAttribute('services', [])[$namespace] - && ! ($user->isPrivileged($authorization->getRoles()) || $user->isKey($authorization->getRoles())) + && ! ($rolesSource->isPrivileged($authorization->getRoles()) || $rolesSource->isKey($authorization->getRoles())) ) { throw new Exception(Exception::GENERAL_SERVICE_DISABLED); } @@ -435,7 +444,7 @@ Http::init() if ( array_key_exists('rest', $project->getAttribute('apis', [])) && ! $project->getAttribute('apis', [])['rest'] - && ! ($user->isPrivileged($authorization->getRoles()) || $user->isKey($authorization->getRoles())) + && ! ($rolesSource->isPrivileged($authorization->getRoles()) || $rolesSource->isKey($authorization->getRoles())) ) { throw new AppwriteException(AppwriteException::GENERAL_API_DISABLED); } @@ -447,20 +456,20 @@ Http::init() } // Step 10: Check if user is blocked - if ($user->getAttribute('status') === false) { // Account is blocked + if ($rolesSource->getAttribute('status') === false) { // Account is blocked throw new Exception(Exception::USER_BLOCKED); } // Step 11: Verify password status - if ($user->getAttribute('reset')) { + if ($rolesSource->getAttribute('reset')) { throw new Exception(Exception::USER_PASSWORD_RESET_REQUIRED); } // Step 12: Validate MFA requirements - $mfaEnabled = $user->getAttribute('mfa', false); - $hasVerifiedEmail = $user->getAttribute('emailVerification', false); - $hasVerifiedPhone = $user->getAttribute('phoneVerification', false); - $hasVerifiedAuthenticator = TOTP::getAuthenticatorFromUser($user)?->getAttribute('verified') ?? false; + $mfaEnabled = $rolesSource->getAttribute('mfa', false); + $hasVerifiedEmail = $rolesSource->getAttribute('emailVerification', false); + $hasVerifiedPhone = $rolesSource->getAttribute('phoneVerification', false); + $hasVerifiedAuthenticator = TOTP::getAuthenticatorFromUser($rolesSource)?->getAttribute('verified') ?? false; $hasMoreFactors = $hasVerifiedEmail || $hasVerifiedPhone || $hasVerifiedAuthenticator; $minimumFactors = ($mfaEnabled && $hasMoreFactors) ? 2 : 1; @@ -566,10 +575,13 @@ Http::init() ->inject('platform') ->inject('authorization') ->inject('cacheControlForStorage') - ->action(function (Route $route, Request $request, Response $response, Document $project, User $user, Event $queueForEvents, AuditContext $auditContext, Context $usage, FunctionPublisher $publisherForFunctions, Database $dbForProject, Document $resourceToken, string $mode, ?Key $apiKey, array $plan, Telemetry $telemetry, array $platform, Authorization $authorization, callable $cacheControlForStorage) { + ->inject('impersonatorUser') + ->inject('targetUser') + ->action(function (Route $route, Request $request, Response $response, Document $project, User $user, Event $queueForEvents, AuditContext $auditContext, Context $usage, FunctionPublisher $publisherForFunctions, Database $dbForProject, Document $resourceToken, string $mode, ?Key $apiKey, array $plan, Telemetry $telemetry, array $platform, Authorization $authorization, callable $cacheControlForStorage, Document $impersonatorUser, User $targetUser) { - $response->setUser($user); - $request->setUser($user); + $response->setUser($targetUser); + $response->setImpersonatorUser($impersonatorUser); + $request->setUser($targetUser); $path = $route->getPath(); $databaseType = match (true) { @@ -588,7 +600,7 @@ Http::init() $queueForEvents ->setEvent($route->getLabel('event', '')) ->setProject($project) - ->setUser($user); + ->setUser($targetUser); $auditContext->mode = $mode; $auditContext->userAgent = $request->getUserAgent(''); @@ -596,24 +608,27 @@ Http::init() $auditContext->hostname = $request->getHostname(); $auditContext->event = $route->getLabel('audits.event', ''); $auditContext->project = $project; + $auditContext->impersonatorUser = $impersonatorUser->isEmpty() ? null : $impersonatorUser; - /* If a session exists, use the user associated with the session */ - if (! $user->isEmpty()) { - $userClone = clone $user; + /* If a session exists, use the target user (impersonated target or actor) for audit */ + if (! $targetUser->isEmpty()) { + $userClone = clone $targetUser; // $user doesn't support `type` and can cause unintended effects. - if (empty($user->getAttribute('type'))) { + if (empty($targetUser->getAttribute('type'))) { $userClone->setAttribute('type', $mode === APP_MODE_ADMIN ? ACTOR_TYPE_ADMIN : ACTOR_TYPE_USER); } $auditContext->user = $userClone; } + $rolesSource = $impersonatorUser->isEmpty() ? $user : $targetUser; + $useCache = $route->getLabel('cache', false); $storageCacheOperationsCounter = $telemetry->createCounter('storage.cache.operations.load'); if ($useCache) { $roles = $authorization->getRoles(); - $isAppUser = $user->isKey($roles); + $isAppUser = $rolesSource->isKey($roles); $isImageTransformation = $route->getPath() === '/v1/storage/buckets/:bucketId/files/:fileId/preview'; - $isDisabled = isset($plan['imageTransformations']) && $plan['imageTransformations'] === -1 && ! $user->isPrivileged($roles); + $isDisabled = isset($plan['imageTransformations']) && $plan['imageTransformations'] === -1 && ! $rolesSource->isPrivileged($roles); $key = $request->cacheIdentifier(); Span::add('storage.cache.key', $key); @@ -903,24 +918,25 @@ Http::shutdown() ->inject('response') ->inject('project') ->inject('user') + ->inject('targetUser') ->inject('auditContext') ->inject('publisherForAudits') ->inject('mode') - ->action(function (Route $route, array $params, Request $request, Response $response, Document $project, User $user, AuditContext $auditContext, Audit $publisherForAudits, string $mode) use ($parseLabel) { + ->action(function (Route $route, array $params, Request $request, Response $response, Document $project, User $user, User $targetUser, AuditContext $auditContext, Audit $publisherForAudits, string $mode) use ($parseLabel) { $responsePayload = $response->getPayload(); $pattern = $route->getLabel('audits.resource', null); if (! empty($pattern)) { - $resource = $parseLabel($pattern, $responsePayload, $params, $user, $project); + $resource = $parseLabel($pattern, $responsePayload, $params, $targetUser, $project); if (! empty($resource) && $resource !== $pattern) { $auditContext->resource = $resource; } } - if (! $user->isEmpty()) { - $userClone = clone $user; + if (! $targetUser->isEmpty()) { + $userClone = clone $targetUser; // $user doesn't support `type` and can cause unintended effects. - if (empty($user->getAttribute('type'))) { + if (empty($targetUser->getAttribute('type'))) { $userClone->setAttribute('type', $mode === APP_MODE_ADMIN ? ACTOR_TYPE_ADMIN : ACTOR_TYPE_USER); } $auditContext->user = $userClone; diff --git a/app/init/realtime/connection.php b/app/init/realtime/connection.php index 571b5dfc77..2a0b97bfdd 100644 --- a/app/init/realtime/connection.php +++ b/app/init/realtime/connection.php @@ -327,42 +327,76 @@ return function (Container $container): void { } } + $dbForPlatform->setMetadata('user', $user->getId()); + $dbForProject->setMetadata('user', $user->getId()); + + return $user; + }, ['request', 'project', 'console', 'authorization']); + + $container->set('impersonatorUser', function (Request $request, Document $project, Document $user, Authorization $authorization) use ($getMode, $getDbForPlatform, $getDbForProject) { + if ($user->isEmpty() || !$user->getAttribute('impersonator', false)) { + return new Document(); + } + // Query params mirror the header fallback pattern used by ?project= and ?devKey=, // allowing Console to embed impersonation in direct file/image URLs where headers cannot be set. $impersonateUserId = $request->getHeaderLine('x-appwrite-impersonate-user-id', (string)($request->getParam('impersonateuserid', '') ?: $request->getParam('impersonateUserId', ''))); $impersonateEmail = $request->getHeaderLine('x-appwrite-impersonate-user-email', (string)($request->getParam('impersonateemail', '') ?: $request->getParam('impersonateEmail', ''))); $impersonatePhone = $request->getHeaderLine('x-appwrite-impersonate-user-phone', (string)($request->getParam('impersonatephone', '') ?: $request->getParam('impersonatePhone', ''))); - if (!$user->isEmpty() && $user->getAttribute('impersonator', false)) { - $userDb = ($mode === APP_MODE_ADMIN || $project->getId() === 'console') ? $dbForPlatform : $dbForProject; - $targetUser = null; - - if (!empty($impersonateUserId)) { - $targetUser = $authorization->skip(fn () => $userDb->getDocument('users', $impersonateUserId)); - } elseif (!empty($impersonateEmail)) { - $targetUser = $authorization->skip(fn () => $userDb->findOne('users', [ - Query::equal('email', [\strtolower($impersonateEmail)]), - ])); - } elseif (!empty($impersonatePhone)) { - $targetUser = $authorization->skip(fn () => $userDb->findOne('users', [ - Query::equal('phone', [$impersonatePhone]), - ])); - } - - if ($targetUser !== null && !$targetUser->isEmpty()) { - $impersonator = clone $user; - $user = clone $targetUser; - $user->setAttribute('impersonatorUserId', $impersonator->getId()); - $user->setAttribute('impersonatorUserInternalId', $impersonator->getSequence()); - $user->setAttribute('impersonatorUserName', $impersonator->getAttribute('name', '')); - $user->setAttribute('impersonatorUserEmail', $impersonator->getAttribute('email', '')); - $user->setAttribute('impersonatorAccessedAt', $impersonator->getAttribute('accessedAt', 0)); - } + if (empty($impersonateUserId) && empty($impersonateEmail) && empty($impersonatePhone)) { + return new Document(); } - $dbForPlatform->setMetadata('user', $user->getId()); - $dbForProject->setMetadata('user', $user->getId()); + $mode = $getMode($request, $project); + $dbForPlatform = $getDbForPlatform($authorization); + $dbForProject = $getDbForProject($project, $authorization); + $userDb = ($mode === APP_MODE_ADMIN || $project->getId() === 'console') ? $dbForPlatform : $dbForProject; + + $targetUser = null; + if (!empty($impersonateUserId)) { + $targetUser = $authorization->skip(fn () => $userDb->getDocument('users', $impersonateUserId)); + } elseif (!empty($impersonateEmail)) { + $targetUser = $authorization->skip(fn () => $userDb->findOne('users', [Query::equal('email', [\strtolower($impersonateEmail)])])); + } elseif (!empty($impersonatePhone)) { + $targetUser = $authorization->skip(fn () => $userDb->findOne('users', [Query::equal('phone', [$impersonatePhone])])); + } + + if ($targetUser === null || $targetUser->isEmpty()) { + return new Document(); + } + + return new Document([ + '$id' => $user->getId(), + '$sequence' => $user->getSequence(), + 'name' => $user->getAttribute('name', ''), + 'email' => $user->getAttribute('email', ''), + 'type' => $user->getAttribute('type', $mode === APP_MODE_ADMIN ? ACTOR_TYPE_ADMIN : ACTOR_TYPE_USER), + ]); + }, ['request', 'project', 'user', 'authorization']); + + $container->set('targetUser', function (Request $request, Document $project, Document $user, Document $impersonatorUser, Authorization $authorization) use ($getMode, $getDbForPlatform, $getDbForProject) { + if ($impersonatorUser->isEmpty()) { + return $user; + } + + $impersonateUserId = $request->getHeaderLine('x-appwrite-impersonate-user-id', (string)($request->getParam('impersonateuserid', '') ?: $request->getParam('impersonateUserId', ''))); + $impersonateEmail = $request->getHeaderLine('x-appwrite-impersonate-user-email', (string)($request->getParam('impersonateemail', '') ?: $request->getParam('impersonateEmail', ''))); + $impersonatePhone = $request->getHeaderLine('x-appwrite-impersonate-user-phone', (string)($request->getParam('impersonatephone', '') ?: $request->getParam('impersonatePhone', ''))); + + $mode = $getMode($request, $project); + $dbForPlatform = $getDbForPlatform($authorization); + $dbForProject = $getDbForProject($project, $authorization); + $userDb = ($mode === APP_MODE_ADMIN || $project->getId() === 'console') ? $dbForPlatform : $dbForProject; + + if (!empty($impersonateUserId)) { + return $authorization->skip(fn () => $userDb->getDocument('users', $impersonateUserId)); + } elseif (!empty($impersonateEmail)) { + return $authorization->skip(fn () => $userDb->findOne('users', [Query::equal('email', [\strtolower($impersonateEmail)])])); + } elseif (!empty($impersonatePhone)) { + return $authorization->skip(fn () => $userDb->findOne('users', [Query::equal('phone', [$impersonatePhone])])); + } return $user; - }, ['request', 'project', 'console', 'authorization']); + }, ['request', 'project', 'user', 'impersonatorUser', 'authorization']); }; diff --git a/app/init/resources/request.php b/app/init/resources/request.php index 958f1a211a..ded4f735a6 100644 --- a/app/init/resources/request.php +++ b/app/init/resources/request.php @@ -110,6 +110,66 @@ return function (Container $context): void { $context->set('queueForRealtime', fn () => new Realtime(), []); $context->set('usage', fn () => new UsageContext(), []); $context->set('auditContext', fn () => new AuditContext(), []); + + $context->set('impersonatorUser', function (string $mode, Document $project, Document $user, Request $request, Database $dbForProject, Database $dbForPlatform) { + if ($user->isEmpty() || !$user->getAttribute('impersonator', false)) { + return new Document(); + } + + // Query params mirror the header fallback pattern used by ?project= and ?devKey=, + // allowing Console to embed impersonation in direct file/image URLs where headers cannot be set. + $impersonateUserId = $request->getHeaderLine('x-appwrite-impersonate-user-id', (string)($request->getParam('impersonateuserid', '') ?: $request->getParam('impersonateUserId', ''))); + $impersonateEmail = $request->getHeaderLine('x-appwrite-impersonate-user-email', (string)($request->getParam('impersonateemail', '') ?: $request->getParam('impersonateEmail', ''))); + $impersonatePhone = $request->getHeaderLine('x-appwrite-impersonate-user-phone', (string)($request->getParam('impersonatephone', '') ?: $request->getParam('impersonatePhone', ''))); + + if (empty($impersonateUserId) && empty($impersonateEmail) && empty($impersonatePhone)) { + return new Document(); + } + + $userDb = (APP_MODE_ADMIN === $mode || $project->getId() === 'console') ? $dbForPlatform : $dbForProject; + $targetUser = null; + if (!empty($impersonateUserId)) { + $targetUser = $userDb->getAuthorization()->skip(fn () => $userDb->getDocument('users', $impersonateUserId)); + } elseif (!empty($impersonateEmail)) { + $targetUser = $userDb->getAuthorization()->skip(fn () => $userDb->findOne('users', [Query::equal('email', [\strtolower($impersonateEmail)])])); + } elseif (!empty($impersonatePhone)) { + $targetUser = $userDb->getAuthorization()->skip(fn () => $userDb->findOne('users', [Query::equal('phone', [$impersonatePhone])])); + } + + if ($targetUser === null || $targetUser->isEmpty()) { + return new Document(); + } + + return new Document([ + '$id' => $user->getId(), + '$sequence' => $user->getSequence(), + 'name' => $user->getAttribute('name', ''), + 'email' => $user->getAttribute('email', ''), + 'type' => $user->getAttribute('type', $mode === APP_MODE_ADMIN ? ACTOR_TYPE_ADMIN : ACTOR_TYPE_USER), + ]); + }, ['mode', 'project', 'user', 'request', 'dbForProject', 'dbForPlatform']); + + $context->set('targetUser', function (Document $user, Document $impersonatorUser, string $mode, Document $project, Request $request, Database $dbForProject, Database $dbForPlatform) { + if ($impersonatorUser->isEmpty()) { + return $user; + } + + $impersonateUserId = $request->getHeaderLine('x-appwrite-impersonate-user-id', (string)($request->getParam('impersonateuserid', '') ?: $request->getParam('impersonateUserId', ''))); + $impersonateEmail = $request->getHeaderLine('x-appwrite-impersonate-user-email', (string)($request->getParam('impersonateemail', '') ?: $request->getParam('impersonateEmail', ''))); + $impersonatePhone = $request->getHeaderLine('x-appwrite-impersonate-user-phone', (string)($request->getParam('impersonatephone', '') ?: $request->getParam('impersonatePhone', ''))); + + $userDb = (APP_MODE_ADMIN === $mode || $project->getId() === 'console') ? $dbForPlatform : $dbForProject; + if (!empty($impersonateUserId)) { + return $userDb->getAuthorization()->skip(fn () => $userDb->getDocument('users', $impersonateUserId)); + } elseif (!empty($impersonateEmail)) { + return $userDb->getAuthorization()->skip(fn () => $userDb->findOne('users', [Query::equal('email', [\strtolower($impersonateEmail)])])); + } elseif (!empty($impersonatePhone)) { + return $userDb->getAuthorization()->skip(fn () => $userDb->findOne('users', [Query::equal('phone', [$impersonatePhone])])); + } + + return $user; + }, ['user', 'impersonatorUser', 'mode', 'project', 'request', 'dbForProject', 'dbForPlatform']); + $context->set('publisherForFunctions', fn (Publisher $publisher) => new FunctionPublisher( $publisher, new Queue(System::getEnv('_APP_FUNCTIONS_QUEUE_NAME', Event::FUNCTIONS_QUEUE_NAME), 'utopia-queue', Event::FUNCTIONS_QUEUE_TTL) @@ -488,33 +548,6 @@ return function (Container $context): void { } } - // Impersonation: if current user has impersonator capability and headers/params are set, act as another user - // Query params mirror the header fallback pattern used by ?project= and ?devKey=, - // allowing Console to embed impersonation in direct file/image URLs where headers cannot be set. - $impersonateUserId = $request->getHeaderLine('x-appwrite-impersonate-user-id', (string)($request->getParam('impersonateuserid', '') ?: $request->getParam('impersonateUserId', ''))); - $impersonateEmail = $request->getHeaderLine('x-appwrite-impersonate-user-email', (string)($request->getParam('impersonateemail', '') ?: $request->getParam('impersonateEmail', ''))); - $impersonatePhone = $request->getHeaderLine('x-appwrite-impersonate-user-phone', (string)($request->getParam('impersonatephone', '') ?: $request->getParam('impersonatePhone', ''))); - if (!$user->isEmpty() && $user->getAttribute('impersonator', false)) { - $userDb = (APP_MODE_ADMIN === $mode || $project->getId() === 'console') ? $dbForPlatform : $dbForProject; - $targetUser = null; - if (!empty($impersonateUserId)) { - $targetUser = $userDb->getAuthorization()->skip(fn () => $userDb->getDocument('users', $impersonateUserId)); - } elseif (!empty($impersonateEmail)) { - $targetUser = $userDb->getAuthorization()->skip(fn () => $userDb->findOne('users', [Query::equal('email', [\strtolower($impersonateEmail)])])); - } elseif (!empty($impersonatePhone)) { - $targetUser = $userDb->getAuthorization()->skip(fn () => $userDb->findOne('users', [Query::equal('phone', [$impersonatePhone])])); - } - if ($targetUser !== null && !$targetUser->isEmpty()) { - $impersonator = clone $user; - $user = clone $targetUser; - $user->setAttribute('impersonatorUserId', $impersonator->getId()); - $user->setAttribute('impersonatorUserInternalId', $impersonator->getSequence()); - $user->setAttribute('impersonatorUserName', $impersonator->getAttribute('name', '')); - $user->setAttribute('impersonatorUserEmail', $impersonator->getAttribute('email', '')); - $user->setAttribute('impersonatorAccessedAt', $impersonator->getAttribute('accessedAt', 0)); - } - } - $dbForProject->setMetadata('user', $user->getId()); $dbForPlatform->setMetadata('user', $user->getId()); diff --git a/app/realtime.php b/app/realtime.php index b2b7e5fa46..88cb7404d4 100644 --- a/app/realtime.php +++ b/app/realtime.php @@ -686,6 +686,7 @@ $server->onWorkerStart(function (int $workerId) use ($server, $register, $stats, foreach (\array_keys($connections) as $connection) { $subscriptionsBefore = \count($realtime->getSubscriptionMetadata($connection)); $authorization = $realtime->connections[$connection]['authorization'] ?? null; + $impersonatedUserId = $realtime->connections[$connection]['impersonatedUserId'] ?? null; $previousUserId = $realtime->connections[$connection]['userId'] ?? ''; $meta = $realtime->getSubscriptionMetadata($connection); @@ -720,6 +721,7 @@ $server->onWorkerStart(function (int $workerId) use ($server, $register, $stats, } if ($authorization !== null && isset($realtime->connections[$connection])) { $realtime->connections[$connection]['authorization'] = $authorization; + $realtime->connections[$connection]['impersonatedUserId'] = $impersonatedUserId; } $subscriptionsAfter = \count($realtime->getSubscriptionMetadata($connection)); @@ -908,14 +910,21 @@ $server->onOpen(function (int $connection, SwooleRequest $request) use ($server, $timelimit = $connectionContainer->get('timelimit'); $user = $connectionContainer->get('user'); /** @var User $user */ + $impersonatorUser = $connectionContainer->get('impersonatorUser'); /** @var Document $impersonatorUser */ + $targetUser = $connectionContainer->get('targetUser'); /** @var User $targetUser */ + if (!$impersonatorUser->isEmpty()) { + getConsoleDB()->setMetadata('user', $targetUser->getId()); + getProjectDB($project)->setMetadata('user', $targetUser->getId()); + } $logUser = $user; $apis = $project->getAttribute('apis', []); // Websocket is what to check, but realtime is checked too for backwards compatibility $websocketEnabled = $apis['websocket'] ?? $apis['realtime'] ?? true; + $effectiveUser = $impersonatorUser->isEmpty() ? $user : $targetUser; if ( !$websocketEnabled - && !($user->isPrivileged($authorization->getRoles()) || $user->isKey($authorization->getRoles())) + && !($effectiveUser->isPrivileged($authorization->getRoles()) || $effectiveUser->isKey($authorization->getRoles())) ) { throw new AppwriteException(AppwriteException::GENERAL_API_DISABLED); } @@ -958,9 +967,9 @@ $server->onOpen(function (int $connection, SwooleRequest $request) use ($server, throw new Exception(Exception::REALTIME_POLICY_VIOLATION, $originValidator->getDescription()); } - $roles = $user->getRoles($authorization); + $roles = $targetUser->getRoles($authorization); - $channels = Realtime::convertChannels($request->getQuery('channels', []), $user->getId()); + $channels = Realtime::convertChannels($request->getQuery('channels', []), $targetUser->getId()); $channelCount = \count($channels); $updateStats = static function (string $projectId, ?string $teamId) use ($register, $stats): void { @@ -985,7 +994,7 @@ $server->onOpen(function (int $connection, SwooleRequest $request) use ($server, */ if (empty($channels)) { // in case of message based 'subscribe' channels will be empty at first and only projectId and roles will be available - $sanitizedUser = empty($user->getId()) ? null : $response->output($user, Response::MODEL_ACCOUNT); + $sanitizedUser = empty($targetUser->getId()) ? null : $response->output($targetUser, Response::MODEL_ACCOUNT); $connectedPayloadJson = json_encode([ 'type' => 'connected', 'data' => [ @@ -995,8 +1004,9 @@ $server->onOpen(function (int $connection, SwooleRequest $request) use ($server, ] ]); - $realtime->subscribe($project->getId(), $connection, '', $roles, [], [], $user->getId()); + $realtime->subscribe($project->getId(), $connection, '', $roles, [], [], $targetUser->getId()); $realtime->connections[$connection]['authorization'] = $authorization; + $realtime->connections[$connection]['impersonatedUserId'] = $impersonatorUser->isEmpty() ? null : $targetUser->getId(); $updateStats($project->getId(), $project->getAttribute('teamId')); $server->send([$connection], $connectedPayloadJson); $outboundBytes += \strlen($connectedPayloadJson); @@ -1020,7 +1030,7 @@ $server->onOpen(function (int $connection, SwooleRequest $request) use ($server, throw new Exception(Exception::REALTIME_POLICY_VIOLATION, $e->getMessage()); } - $sanitizedUser = empty($user->getId()) ? null : $response->output($user, Response::MODEL_ACCOUNT); + $sanitizedUser = empty($targetUser->getId()) ? null : $response->output($targetUser, Response::MODEL_ACCOUNT); $mapping = []; foreach ($subscriptions as $index => $subscription) { @@ -1033,13 +1043,14 @@ $server->onOpen(function (int $connection, SwooleRequest $request) use ($server, $roles, $subscription['channels'], $subscription['queries'], - $user->getId() + $targetUser->getId() ); $mapping[$index] = $subscriptionId; } $realtime->connections[$connection]['authorization'] = $authorization; + $realtime->connections[$connection]['impersonatedUserId'] = $impersonatorUser->isEmpty() ? null : $targetUser->getId(); $updateStats($project->getId(), $project->getAttribute('teamId')); $subscriptionCount = \count($subscriptions); @@ -1164,8 +1175,13 @@ $server->onMessage(function (int $connection, string $message) use ($container, $authorization->addRole($role); } + $impersonatedUserId = $realtime->connections[$connection]['impersonatedUserId'] ?? null; + $database = getConsoleDB(); $database->setAuthorization($authorization); + if ($impersonatedUserId !== null) { + $database->setMetadata('user', $impersonatedUserId); + } if (!empty($projectId) && $projectId !== 'console') { // Negative-cache race: if any prior code path queried projects:$projectId @@ -1186,6 +1202,9 @@ $server->onMessage(function (int $connection, string $message) use ($container, $database = getProjectDB($project); $database->setAuthorization($authorization); + if ($impersonatedUserId !== null) { + $database->setMetadata('user', $impersonatedUserId); + } } else { $project = null; } diff --git a/app/views/install/compose.phtml b/app/views/install/compose.phtml index d04baa5e11..7170439c1e 100644 --- a/app/views/install/compose.phtml +++ b/app/views/install/compose.phtml @@ -14,7 +14,7 @@ $image = $this->getParam('image', ''); $enableAssistant = $this->getParam('enableAssistant', false); $executorImages = $this->getParam('executorImages', ''); $dbService = $this->getParam('database', 'mongodb'); -$allowedDbServices = ['mariadb', 'mongodb']; +$allowedDbServices = ['mariadb', 'mongodb', 'postgresql']; if (!\in_array($dbService, $allowedDbServices, true)) { $dbService = 'mongodb'; } @@ -194,7 +194,7 @@ $hostPath = rtrim($this->getParam('hostPath', ''), '/'); appwrite-console: <<: *x-logging container_name: appwrite-console - image: /console:7.8.26 + image: /console:8.7.5 restart: unless-stopped networks: - appwrite @@ -1003,7 +1003,7 @@ $hostPath = rtrim($this->getParam('hostPath', ''), '/'); environment: - OPR_EXECUTOR_CONNECTION_STORAGE=local://localhost - OPR_EXECUTOR_CONNECTION_BUILD_CACHE_STORAGE= - - OPR_EXECUTOR_IMAGES= + - OPR_EXECUTOR_IMAGES= - OPR_EXECUTOR_INACTIVE_TRESHOLD=$_APP_COMPUTE_INACTIVE_THRESHOLD - OPR_EXECUTOR_MAINTENANCE_INTERVAL=$_APP_COMPUTE_MAINTENANCE_INTERVAL - OPR_EXECUTOR_NETWORK=$_APP_COMPUTE_RUNTIMES_NETWORK @@ -1126,7 +1126,7 @@ $hostPath = rtrim($this->getParam('hostPath', ''), '/'); exec mongod --replSet rs0 --bind_ip_all --auth --keyFile "$$KEYFILE_PATH" healthcheck: test: | - mongosh -u root -p "$$MONGO_INITDB_ROOT_PASSWORD" --authenticationDatabase admin --quiet --eval "rs.status().ok" | grep -q 1 + mongosh -u root -p "$$MONGO_INITDB_ROOT_PASSWORD" --authenticationDatabase admin --quiet --eval "const hello = db.adminCommand({hello: 1}); if (!hello.isWritablePrimary) { quit(1); }" interval: 10s timeout: 10s retries: 10 diff --git a/app/views/install/installer.phtml b/app/views/install/installer.phtml index d33838c8c6..d5e4383f48 100644 --- a/app/views/install/installer.phtml +++ b/app/views/install/installer.phtml @@ -1,16 +1,16 @@ getBodyDataset().lockedDatabase || ''; const getEnabledDatabases = () => { const raw = getBodyDataset().enabledDatabases; - if (!raw) return ['mongodb', 'mariadb', 'postgresql']; - try { return JSON.parse(raw); } catch (e) { return ['mongodb', 'mariadb', 'postgresql']; } + if (!raw) return ['mongodb', 'mariadb']; + try { return JSON.parse(raw); } catch (e) { return ['mongodb', 'mariadb']; } }; const STEP_IDS = Object.freeze({ diff --git a/app/views/install/installer/js/steps.js b/app/views/install/installer/js/steps.js index b34389b561..d5ee3dcb60 100644 --- a/app/views/install/installer/js/steps.js +++ b/app/views/install/installer/js/steps.js @@ -432,11 +432,11 @@ const secretKey = root?.querySelector('#secret-key'); const secretValue = secretKey?.value.trim() || ''; if (!secretKey || !secretValue) { - setFieldError?.(secretKey, 'Please enter or generate a secret API key'); + setFieldError?.(secretKey, 'Please enter or generate a secret key'); return false; } if (secretValue.length > 64) { - setFieldError?.(secretKey, 'Secret API key must be 1-64 characters'); + setFieldError?.(secretKey, 'Secret key must be 1-64 characters'); return false; } } diff --git a/app/views/install/installer/templates/steps/step-1.phtml b/app/views/install/installer/templates/steps/step-1.phtml index 8f4a726158..e7d356745b 100644 --- a/app/views/install/installer/templates/steps/step-1.phtml +++ b/app/views/install/installer/templates/steps/step-1.phtml @@ -1,13 +1,13 @@
- +
-
Secret API key
+
Secret key
diff --git a/docker-compose.override.yml b/docker-compose.override.yml index 29182f01d2..05e31ece94 100644 --- a/docker-compose.override.yml +++ b/docker-compose.override.yml @@ -16,7 +16,8 @@ services: ME_CONFIG_BASICAUTH_USERNAME: ${_APP_DB_USER} ME_CONFIG_BASICAUTH_PASSWORD: ${_APP_DB_PASS} depends_on: - - mongodb + mongodb: + condition: service_healthy adminer: image: adminer diff --git a/docker-compose.yml b/docker-compose.yml index 13677d2ac1..edeb936faa 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -255,7 +255,7 @@ services: appwrite-console: <<: *x-logging container_name: appwrite-console - image: appwrite/console:8 + image: appwrite/console:8.7.5 restart: unless-stopped networks: - appwrite @@ -1254,7 +1254,6 @@ services: restart: unless-stopped networks: - appwrite - - runtimes volumes: - /var/run/docker.sock:/var/run/docker.sock - appwrite-builds:/storage/builds:rw @@ -1266,7 +1265,7 @@ services: environment: - OPR_EXECUTOR_CONNECTION_STORAGE=local://localhost - OPR_EXECUTOR_CONNECTION_BUILD_CACHE_STORAGE= - - OPR_EXECUTOR_IMAGE_PULL=enabled + - OPR_EXECUTOR_IMAGES=$_APP_EXECUTOR_IMAGES - OPR_EXECUTOR_INACTIVE_TRESHOLD=$_APP_COMPUTE_INACTIVE_THRESHOLD - OPR_EXECUTOR_MAINTENANCE_INTERVAL=$_APP_COMPUTE_MAINTENANCE_INTERVAL - OPR_EXECUTOR_NETWORK=$_APP_COMPUTE_RUNTIMES_NETWORK @@ -1353,13 +1352,20 @@ services: healthcheck: test: | bash -c " - if mongosh -u root -p ${_APP_DB_ROOT_PASS} --authenticationDatabase admin --quiet --eval 'rs.status().ok' 2>/dev/null | grep -q 1; then - exit 0 - else - mongosh -u root -p ${_APP_DB_ROOT_PASS} --authenticationDatabase admin --quiet --eval \" - rs.initiate({_id: 'rs0', members: [{_id: 0, host: 'appwrite-mongodb:27017'}]}) - \" 2>/dev/null || exit 1 - fi + mongosh -u root -p ${_APP_DB_ROOT_PASS} --authenticationDatabase admin --quiet --eval \" + try { + const hello = db.adminCommand({hello: 1}); + if (hello.isWritablePrimary) { + quit(0); + } + } catch (e) {} + + try { + rs.initiate({_id: 'rs0', members: [{_id: 0, host: 'appwrite-mongodb:27017'}]}); + } catch (e) {} + + quit(1); + \" 2>/dev/null " interval: 10s timeout: 10s diff --git a/src/Appwrite/Event/Context/Audit.php b/src/Appwrite/Event/Context/Audit.php index 1d41890476..cb2eab2a1a 100644 --- a/src/Appwrite/Event/Context/Audit.php +++ b/src/Appwrite/Event/Context/Audit.php @@ -9,6 +9,7 @@ class Audit public function __construct( public ?Document $project = null, public ?Document $user = null, + public ?Document $impersonatorUser = null, public string $mode = '', public string $userAgent = '', public string $ip = '', @@ -23,6 +24,7 @@ class Audit { return $this->project === null && $this->user === null + && $this->impersonatorUser === null && $this->mode === '' && $this->userAgent === '' && $this->ip === '' diff --git a/src/Appwrite/Event/Message/Audit.php b/src/Appwrite/Event/Message/Audit.php index ae5831c3b9..20cac964cb 100644 --- a/src/Appwrite/Event/Message/Audit.php +++ b/src/Appwrite/Event/Message/Audit.php @@ -12,6 +12,7 @@ final class Audit extends Base public readonly array $payload, public readonly Document $project = new Document(), public readonly Document $user = new Document(), + public readonly Document $impersonatorUser = new Document(), public readonly string $resource = '', public readonly string $mode = '', public readonly string $ip = '', @@ -29,6 +30,7 @@ final class Audit extends Base 'database' => $this->project->getAttribute('database', ''), ], 'user' => $this->user->getArrayCopy(), + 'impersonatorUser' => $this->impersonatorUser->getArrayCopy(), 'payload' => $this->payload, 'resource' => $this->resource, 'mode' => $this->mode, @@ -46,6 +48,7 @@ final class Audit extends Base payload: $data['payload'] ?? [], project: new Document($data['project'] ?? []), user: new Document($data['user'] ?? []), + impersonatorUser: new Document($data['impersonatorUser'] ?? []), resource: $data['resource'] ?? '', mode: $data['mode'] ?? '', ip: $data['ip'] ?? '', @@ -61,6 +64,7 @@ final class Audit extends Base payload: $context->payload, project: $context->project ?? new Document(), user: $context->user ?? new Document(), + impersonatorUser: $context->impersonatorUser ?? new Document(), resource: $context->resource, mode: $context->mode, ip: $context->ip, diff --git a/src/Appwrite/Platform/Modules/Teams/Http/Memberships/Status/Update.php b/src/Appwrite/Platform/Modules/Teams/Http/Memberships/Status/Update.php index 67f019e9af..45706ad2a1 100644 --- a/src/Appwrite/Platform/Modules/Teams/Http/Memberships/Status/Update.php +++ b/src/Appwrite/Platform/Modules/Teams/Http/Memberships/Status/Update.php @@ -67,7 +67,7 @@ class Update extends Action ->param('secret', '', new Text(256), 'Secret key.') ->inject('request') ->inject('response') - ->inject('user') + ->inject('targetUser') ->inject('dbForProject') ->inject('authorization') ->inject('project') @@ -80,7 +80,7 @@ class Update extends Action ->callback($this->action(...)); } - public function action(string $teamId, string $membershipId, string $userId, string $secret, Request $request, Response $response, Document $user, Database $dbForProject, Authorization $authorization, $project, Reader $geodb, Event $queueForEvents, Store $store, Token $proofForToken, bool $domainVerification, ?string $cookieDomain) + public function action(string $teamId, string $membershipId, string $userId, string $secret, Request $request, Response $response, Document $targetUser, Database $dbForProject, Authorization $authorization, $project, Reader $geodb, Event $queueForEvents, Store $store, Token $proofForToken, bool $domainVerification, ?string $cookieDomain) { $protocol = $request->getProtocol(); @@ -105,16 +105,16 @@ class Update extends Action } if ($userId !== $membership->getAttribute('userId')) { - throw new Exception(Exception::TEAM_INVITE_MISMATCH, 'Invite does not belong to current user (' . $user->getAttribute('email') . ')'); + throw new Exception(Exception::TEAM_INVITE_MISMATCH, 'Invite does not belong to current user (' . $targetUser->getAttribute('email') . ')'); } - $hasSession = !$user->isEmpty(); + $hasSession = !$targetUser->isEmpty(); if (!$hasSession) { - $user->setAttributes($dbForProject->getDocument('users', $userId)->getArrayCopy()); // Get user + $targetUser->setAttributes($dbForProject->getDocument('users', $userId)->getArrayCopy()); // Get user } - if ($membership->getAttribute('userInternalId') !== $user->getSequence()) { - throw new Exception(Exception::TEAM_INVITE_MISMATCH, 'Invite does not belong to current user (' . $user->getAttribute('email') . ')'); + if ($membership->getAttribute('userInternalId') !== $targetUser->getSequence()) { + throw new Exception(Exception::TEAM_INVITE_MISMATCH, 'Invite does not belong to current user (' . $targetUser->getAttribute('email') . ')'); } if ($membership->getAttribute('confirm') === true) { @@ -126,11 +126,12 @@ class Update extends Action ->setAttribute('confirm', true) ; - $authorization->skip(fn () => $dbForProject->updateDocument('users', $user->getId(), $user->setAttribute('emailVerification', true))); + $targetUser->setAttribute('emailVerification', true); + $authorization->skip(fn () => $dbForProject->updateDocument('users', $targetUser->getId(), new Document(['emailVerification' => true]))); // Create session for the user if not logged in if (!$hasSession) { - $authorization->addRole(Role::user($user->getId())->toString()); + $authorization->addRole(Role::user($targetUser->getId())->toString()); $detector = new Detector($request->getUserAgent('UNKNOWN')); $record = $geodb->get($request->getIP()); @@ -140,14 +141,14 @@ class Update extends Action $session = new Document(array_merge([ '$id' => ID::unique(), '$permissions' => [ - Permission::read(Role::user($user->getId())), - Permission::update(Role::user($user->getId())), - Permission::delete(Role::user($user->getId())), + Permission::read(Role::user($targetUser->getId())), + Permission::update(Role::user($targetUser->getId())), + Permission::delete(Role::user($targetUser->getId())), ], - 'userId' => $user->getId(), - 'userInternalId' => $user->getSequence(), + 'userId' => $targetUser->getId(), + 'userInternalId' => $targetUser->getSequence(), 'provider' => SESSION_PROVIDER_EMAIL, - 'providerUid' => $user->getAttribute('email'), + 'providerUid' => $targetUser->getAttribute('email'), 'secret' => $proofForToken->hash($secret), // One way hash encryption to protect DB leak 'userAgent' => $request->getUserAgent('UNKNOWN'), 'ip' => $request->getIP(), @@ -161,7 +162,7 @@ class Update extends Action $authorization->addRole(Role::user($userId)->toString()); $encoded = $store - ->setProperty('id', $user->getId()) + ->setProperty('id', $targetUser->getId()) ->setProperty('secret', $secret) ->encode(); @@ -194,12 +195,12 @@ class Update extends Action $membership = $dbForProject->updateDocument('memberships', $membership->getId(), new Document(['joined' => $membership->getAttribute('joined'), 'confirm' => true])); - $dbForProject->purgeCachedDocument('users', $user->getId()); + $dbForProject->purgeCachedDocument('users', $targetUser->getId()); $authorization->skip(fn () => $dbForProject->increaseDocumentAttribute('teams', $team->getId(), 'total', 1)); $queueForEvents - ->setParam('userId', $user->getId()) + ->setParam('userId', $targetUser->getId()) ->setParam('teamId', $team->getId()) ->setParam('membershipId', $membership->getId()) ; @@ -207,8 +208,8 @@ class Update extends Action $response->dynamic( $membership ->setAttribute('teamName', $team->getAttribute('name')) - ->setAttribute('userName', $user->getAttribute('name')) - ->setAttribute('userEmail', $user->getAttribute('email')), + ->setAttribute('userName', $targetUser->getAttribute('name')) + ->setAttribute('userEmail', $targetUser->getAttribute('email')), Response::MODEL_MEMBERSHIP ); } diff --git a/src/Appwrite/Platform/Tasks/Install.php b/src/Appwrite/Platform/Tasks/Install.php index 75f3c5bf18..8c9b86dedb 100644 --- a/src/Appwrite/Platform/Tasks/Install.php +++ b/src/Appwrite/Platform/Tasks/Install.php @@ -57,7 +57,7 @@ class Install extends Action ->param('image', 'appwrite', new Text(0), 'Main appwrite docker image', true) ->param('interactive', 'Y', new Text(1), 'Run an interactive session', true) ->param('no-start', false, new Boolean(true), 'Run an interactive session', true) - ->param('database', 'mongodb', new WhiteList(['mongodb', 'mariadb', 'postgresql']), 'Database to use (mongodb|mariadb|postgresql)', true) + ->param('database', 'mongodb', new WhiteList(['mongodb', 'mariadb']), 'Database to use (mongodb|mariadb)', true) ->callback($this->action(...)); } @@ -102,6 +102,8 @@ class Install extends Action $envFileExists = file_exists($this->path . '/' . $this->getEnvFileName()); $existingInstallation = $data !== '' || $envFileExists; + $existingDatabase = null; + if ($existingInstallation) { $time = \time(); $composeFileName = $this->getComposeFileName(); @@ -171,7 +173,6 @@ class Install extends Action // Detect database type from existing installation. // 1.9.0+ installs have _APP_DB_ADAPTER; pre-1.9.0 installs // can be detected by the DB service name or _APP_DB_HOST. - $existingDatabase = null; foreach ($compose->getServices() as $service) { $svcEnv = $service->getEnvironment()->list(); if (isset($svcEnv['_APP_DB_ADAPTER'])) { @@ -200,7 +201,8 @@ class Install extends Action $installerConfig = $this->readInstallerConfig(); $enabledDatabases = $installerConfig['enabledDatabases'] ?? ['mongodb', 'mariadb']; - if (!in_array($database, $enabledDatabases, true)) { + $isExistingDatabase = $isUpgrade && $existingDatabase !== null && $database === $existingDatabase; + if (!in_array($database, $enabledDatabases, true) && !$isExistingDatabase) { Console::error("Database '{$database}' is not available. Available options: " . implode(', ', $enabledDatabases)); Console::exit(1); } @@ -332,6 +334,9 @@ class Install extends Action $installerConfig = $this->readInstallerConfig(); $enabledDatabases = $installerConfig['enabledDatabases'] ?? ['mongodb', 'mariadb']; + if ($isUpgrade && $lockedDatabase !== null && !in_array($lockedDatabase, $enabledDatabases, true)) { + $enabledDatabases[] = $lockedDatabase; + } $this->setInstallerConfig([ 'defaultHttpPort' => $defaultHttpPort, diff --git a/src/Appwrite/Platform/Workers/Audits.php b/src/Appwrite/Platform/Workers/Audits.php index 6c45aa63f3..27d2629ce6 100644 --- a/src/Appwrite/Platform/Workers/Audits.php +++ b/src/Appwrite/Platform/Workers/Audits.php @@ -74,19 +74,14 @@ class Audits extends Action $userAgent = $auditMessage->userAgent; $ip = $auditMessage->ip; $user = $auditMessage->user; + $impersonatorUser = $auditMessage->impersonatorUser; - $impersonatorUserId = $user->getAttribute('impersonatorUserId'); - $actorUserId = $impersonatorUserId ?: $user->getId(); - $actorUserInternalId = $impersonatorUserId - ? $user->getAttribute('impersonatorUserInternalId') - : $user->getSequence(); - $actorUserName = $impersonatorUserId - ? $user->getAttribute('impersonatorUserName', '') - : $user->getAttribute('name', ''); - $actorUserEmail = $impersonatorUserId - ? $user->getAttribute('impersonatorUserEmail', '') - : $user->getAttribute('email', ''); - $userType = $user->getAttribute('type', ACTOR_TYPE_USER); + $isImpersonated = !$impersonatorUser->isEmpty(); + $actorUserId = $isImpersonated ? $impersonatorUser->getId() : $user->getId(); + $actorUserInternalId = $isImpersonated ? $impersonatorUser->getSequence() : $user->getSequence(); + $actorUserName = $isImpersonated ? $impersonatorUser->getAttribute('name', '') : $user->getAttribute('name', ''); + $actorUserEmail = $isImpersonated ? $impersonatorUser->getAttribute('email', '') : $user->getAttribute('email', ''); + $userType = $isImpersonated ? $impersonatorUser->getAttribute('type', ACTOR_TYPE_USER) : $user->getAttribute('type', ACTOR_TYPE_USER); // Create event data $eventData = [ @@ -106,7 +101,7 @@ class Audits extends Action 'time' => date("Y-m-d H:i:s", $message->getTimestamp()), ]; - if (!empty($impersonatorUserId)) { + if ($isImpersonated) { $eventData['data']['data'] = \is_array($auditPayload) ? \array_merge($auditPayload, [ 'impersonatedUserId' => $user->getId(), diff --git a/src/Appwrite/Realtime/Message/Handlers/Authentication.php b/src/Appwrite/Realtime/Message/Handlers/Authentication.php index 9065e586d3..cf46f7ccb7 100644 --- a/src/Appwrite/Realtime/Message/Handlers/Authentication.php +++ b/src/Appwrite/Realtime/Message/Handlers/Authentication.php @@ -69,7 +69,12 @@ class Authentication extends Action $roles = $user->getRoles($database->getAuthorization()); $authorization = $realtime->connections[$connectionId]['authorization'] ?? null; + $impersonatedUserId = $realtime->connections[$connectionId]['impersonatedUserId'] ?? null; $projectId = $realtime->connections[$connectionId]['projectId'] ?? null; + + if ($impersonatedUserId !== null) { + throw new Exception(Exception::REALTIME_MESSAGE_FORMAT_INVALID, 'Cannot re-authenticate on an impersonated connection.'); + } // Capture the pre-auth userId before unsubscribe() clears the connection entry, // so we can rebind any account channels that were stored under it. $previousUserId = $realtime->connections[$connectionId]['userId'] ?? ''; @@ -102,6 +107,7 @@ class Authentication extends Action if ($authorization !== null) { $realtime->connections[$connectionId]['authorization'] = $authorization; + $realtime->connections[$connectionId]['impersonatedUserId'] = $impersonatedUserId; } $subscriptionsAfter = \count($realtime->getSubscriptionMetadata($connectionId)); diff --git a/src/Appwrite/Utopia/Response.php b/src/Appwrite/Utopia/Response.php index d6b57990a4..45d0b5dc25 100644 --- a/src/Appwrite/Utopia/Response.php +++ b/src/Appwrite/Utopia/Response.php @@ -471,6 +471,16 @@ class Response extends SwooleResponse */ public function dynamic(Document $document, string $model): void { + if ( + $this->impersonatorUser !== null + && $model === self::MODEL_ACCOUNT + && $this->user !== null + && $document->getId() === $this->user->getId() + ) { + $document = clone $document; + $document->setAttribute('impersonatorUserId', $this->impersonatorUser->getId()); + } + $output = $this->output(clone $document, $model); $output = $this->applyFilters($output, $model, raw: clone $document); @@ -775,6 +785,7 @@ class Response extends SwooleResponse private ?Authorization $authorization = null; private ?DBUser $user = null; + private ?Document $impersonatorUser = null; public function setAuthorization(Authorization $authorization): void { @@ -785,4 +796,14 @@ class Response extends SwooleResponse { $this->user = $user; } + + public function setImpersonatorUser(Document $impersonatorUser): void + { + $this->impersonatorUser = $impersonatorUser->isEmpty() ? null : $impersonatorUser; + } + + public function getImpersonatorUser(): ?Document + { + return $this->impersonatorUser; + } } diff --git a/src/Appwrite/Utopia/Response/Model/Account.php b/src/Appwrite/Utopia/Response/Model/Account.php index fb03bdb155..769284d714 100644 --- a/src/Appwrite/Utopia/Response/Model/Account.php +++ b/src/Appwrite/Utopia/Response/Model/Account.php @@ -155,7 +155,7 @@ class Account extends Model 'type' => self::TYPE_STRING, 'description' => 'ID of the original actor performing the impersonation. Present only when the current request is impersonating another user. Internal audit logs attribute the action to this user, while the impersonated target is recorded only in internal audit payload data.', 'required' => false, - 'default' => '', + 'default' => null, 'example' => '5e5ea5c16897e', ]) ; diff --git a/src/Appwrite/Utopia/Response/Model/User.php b/src/Appwrite/Utopia/Response/Model/User.php index f255519bfd..da1f7fe5fc 100644 --- a/src/Appwrite/Utopia/Response/Model/User.php +++ b/src/Appwrite/Utopia/Response/Model/User.php @@ -185,7 +185,7 @@ class User extends Model 'type' => self::TYPE_STRING, 'description' => 'ID of the original actor performing the impersonation. Present only when the current request is impersonating another user. Internal audit logs attribute the action to this user, while the impersonated target is recorded only in internal audit payload data.', 'required' => false, - 'default' => '', + 'default' => null, 'example' => '5e5ea5c16897e', ]) ; diff --git a/tests/e2e/General/UsageTest.php b/tests/e2e/General/UsageTest.php index dde1346991..217991c58f 100644 --- a/tests/e2e/General/UsageTest.php +++ b/tests/e2e/General/UsageTest.php @@ -1466,8 +1466,6 @@ final class UsageTest extends Scope $collectionsTotal = $data['vectordbCollectionsTotal']; $documentsTotal = $data['vectordbDocumentsTotal']; - $this->assertProjectRequestsAtLeastGlobal(); - // Project-wide scalars: vectorsdbDatabasesTotal counts ONLY VectorsDB instances // (not relational databases), vectorsdbDocumentsTotal is the sum of all vector // documents across this project. Both are produced exclusively by