mirror of
https://github.com/stack-auth/stack.git
synced 2026-06-27 21:01:03 +08:00
Some checks failed
all-good: Did all the other checks pass? / all-good (push) Has been cancelled
Ensure Prisma migrations are in sync with the schema / check_prisma_migrations (22.x) (push) Has been cancelled
DB migration compat / Check if migrations changed (push) Has been cancelled
Docker Server Build and Push / Docker Build and Push Server (push) Has been cancelled
Docker Server Build and Run / docker (push) Has been cancelled
Runs E2E API Tests (Local Emulator) / E2E Tests (Local Emulator, Node ${{ matrix.node-version }}) (22.x) (push) Has been cancelled
Runs E2E API Tests / E2E Tests (Node ${{ matrix.node-version }}, Freestyle ${{ matrix.freestyle-mode }}) (mock, 22.x) (push) Has been cancelled
Runs E2E API Tests / E2E Tests (Node ${{ matrix.node-version }}, Freestyle ${{ matrix.freestyle-mode }}) (prod, 22.x) (push) Has been cancelled
Runs E2E API Tests with custom port prefix / build (22.x) (push) Has been cancelled
Runs E2E Fallback Tests / E2E Fallback Tests (Node ${{ matrix.node-version }}) (22.x) (push) Has been cancelled
Lint & build / lint_and_build (24) (push) Has been cancelled
TOC Generator / TOC Generator (push) Has been cancelled
DB migration compat / Back-compat — Current branch migrations with ${{ needs.check-migrations-changed.outputs.base_branch }} branch code (push) Has been cancelled
DB migration compat / Forward-compat — Current branch code with ${{ needs.check-migrations-changed.outputs.base_branch }} branch migrations (push) Has been cancelled
DB migration compat / No migration changes (skipped) (push) Has been cancelled
## Summary
**Stacked on #1468** (`docs/hexclave-rename-plan` — the plan doc). Diff
vs that base = the actual PR 1 code.
This is **PR 1 of the Hexclave rebrand: the invisible compatibility
layer**. Everything is additive. Old SDKs, old wire identifiers, and old
env var names keep working unchanged. The backend dual-accepts and
dual-emits; new SDK code emits `x-hexclave-*` headers and the
`hexclave_` Bearer prefix; cookies dual-write; env vars dual-read across
every category. **No user-visible rebranding lands here** — that's PR 2.
See [`RENAME-TO-HEXCLAVE.md`](./RENAME-TO-HEXCLAVE.md) → *"PR 1
implementation guide"* for the full per-work-area spec, file pointers,
and chosen approach.
## What's implemented (all 14 PR-1 work-areas)
- **SDK export aliases** — `Hexclave*` aliases for the user-facing
`Stack*` exports added in `packages/template`; codegen propagates them
to `@stackframe/{js,stack,react,tanstack-start}`. React-only aliases
correctly excluded from `@stackframe/js`. (`e60550a2`)
- **JWT issuer dual-accept** — `decodeAccessToken` accepts both
`api.stack-auth.com` and `api.hexclave.com` issuers. Signing unchanged.
(`fc781def`)
- **Request-header dual-accept** — backend + dashboard proxies normalize
`x-hexclave-*` → `x-stack-*` at the existing empty proxy hook (so
`smart-request.tsx` and every route schema keep working unchanged); CORS
allowlists extended via a derive-once helper. (`2a056eac`)
- **MCP `ask_hexclave`** — registered alongside `ask_stack_auth` via a
shared helper; `ask_stack_auth` behavior byte-identical. (`30ffd604`)
- **Dev-tool** — DOM ids + header emit switched.
`window.HexclaveDevTool` exposed alongside `window.StackDevTool`.
(`32131ea7`)
- **The big consolidated commit** (`7fed864a`):
- **Env vars** — central `getEnvVariable` prefix-transform (HEXCLAVE
first, STACK fallback); dashboard + template client env files dual-read;
`turbo.json` globalEnv; `NEXT_PUBLIC_STACK_PORT_PREFIX` renamed outright
across ~82 files including docker.
- **Cookies** — dual-write/dual-read auth (`stack-access`/`-refresh-*`
and custom-domain variants), OAuth-state
(`stack-oauth-{inner,outer}-*`), and low-risk cookies (`stack-is-https`,
`stack-last-seen-changelog-version`). Bypass sites patched (backend
OAuth callback, dashboard remote-dev auth route, impersonation snippets,
snapshot serializer).
- **Bearer prefix** — SDK token parser accepts both `stackauth_` and
`hexclave_`; emits `hexclave_`. Discovery correction: this is purely
SDK-internal — the backend never parses it.
- **Response headers** — backend dual-emits
`x-hexclave-{request-id,actual-status,known-error}`; SDKs dual-read (new
first, stack fallback).
- **SDK request-header emit switch** —
`client/server/admin-interface.ts` + dashboard `api-headers.ts` +
`internal-project-headers.ts` + `feedback-form.tsx` switched to
`x-hexclave-*`. Plus `stack_response_mode` query param.
- **Storage keys** — dev-tool / cli-auth / oauth-button / docs keys
renamed (straight); `stack:session-replay:v1` dual-read so in-progress
recordings survive SDK upgrades; `stack_mfa_attempt_code` dual-read.
- **Query params** — cross-domain params dual-emit/dual-accept via
shared helpers; backend `oauth/authorize` accepts
`hexclave_response_mode` and `stack_response_mode`; `stack-init-id`
renamed.
- **`Symbol.for`** — app-internals symbol gets a parallel
`Symbol.for("Hexclave--app-internals")` getter on each attach site (no
read-site churn — old symbol still attached). 3 file-private symbols
renamed outright.
- **Config discovery** — prefer `hexclave.config.ts`, fall back to
`stack.config.ts` at every discovery site (CLI / dashboard / backend /
local-emulator); `init` writes the new filename; CLI credentials path
migrates.
- **Internal renames** — `StackAssertionError`,
`StackClient/Server/AdminInterface` renamed outright (no alias, per the
"internal-only → rename" rule). ~264 files touched.
- **Review-pass fixes** (`21217fbe`) — three real bugs found by parallel
review agents and fixed:
- `snapshot-serializer.ts` was interpolating the whole
`keyedCookieNamePrefixes` array (`${arr}`) — adding a second prefix
would have corrupted **every** OAuth-cookie snapshot, not just new ones.
- **Docker port-prefix producer/consumer mismatch** —
`entrypoint.sh`/`run-emulator.sh`/cloud-init `user-data` were still
producing `NEXT_PUBLIC_STACK_PORT_PREFIX` while the dashboard sentinel +
consumers had been renamed; silent self-host regression (custom port
prefix would be ignored).
- **Missing `hexclave-oauth-inner-*` dual-write** in the OAuth authorize
route — callback's fallback masked it but the dual-write was specified
by the plan.
- Plus: `mcp.test.ts` tool-list assertions updated to include
`ask_hexclave`; two dashboard header-emit sites switched to
`x-hexclave-*` for consistency.
- **E2E snapshot serializer follow-up** (`4b16cc5d`) —
`x-hexclave-request-id` added to the hidden-headers list (mirroring
`x-stack-request-id` treatment), and 2 sample inline snapshots
regenerated in `projects.test.ts` to include the new dual-emitted
headers.
## Verification
- **`pnpm typecheck`** — clean (the fresh-worktree `@/.source` / Prisma
codegen gap in `stack-docs` is pre-existing and unrelated).
- **`pnpm lint`** — 29/29 packages green.
- **`pnpm exec turbo run build --filter=./packages/*`** — 13/13 packages
build (including `@stackframe/stack-cli` once the dashboard standalone
is present).
- **Live E2E** against a running backend on `cl/hexclave-pr1`:
- `pnpm test run
apps/e2e/tests/backend/endpoints/api/v1/internal/mcp.test.ts` — **6/6
pass** (verifies the new `ask_hexclave` tool — the hand-written inline
snapshot matched actual MCP server output).
- `pnpm test run
apps/e2e/tests/backend/endpoints/api/v1/internal/projects.test.ts` —
**11/11 pass** (verifies wire dual-accept + dual-emit end-to-end; the
snapshot serializer fix was found and applied during this check).
A four-agent parallel **review pass** also audited the full diff for
logic/runtime bugs across the work-areas (wire headers + JWT, cookies +
bearer + symbols, env vars, query params + config + MCP + aliases). All
in-slice review verdicts were ✓ except the three bugs listed above,
which are now fixed.
## Known follow-ups (out of scope for this PR)
- **E2E snapshots across the rest of the suite** — backend now
dual-emits `x-hexclave-{known-error,actual-status}` alongside
`x-stack-*`, which legitimately appears in inline snapshots throughout
`apps/e2e`. Two were regenerated here as a sample; the rest should regen
with `vitest -u` in CI.
- **Docker shell env vars beyond `PORT_PREFIX`** — `entrypoint.sh` still
reads `STACK_*` env vars directly (the JS-side `getEnvVariable`
transform doesn't help the shell). JS consumers dual-read so it works in
practice; full shell-level dual-read is a deeper self-host follow-up.
- **`@stackframe/stack-cli` build ordering** — pre-existing; needs
`build:rde-standalone` first. Not affected by this PR.
## Test plan
- [ ] CI runs full e2e suite (with `vitest -u` to absorb dual-emit
snapshot deltas, then committed back)
- [ ] Spot-check: an old SDK build (emitting only `x-stack-*`) still
authenticates against the new backend
- [ ] Spot-check: a new SDK (emitting `x-hexclave-*` / `Bearer
hexclave_*`) still authenticates against an old backend during deploy
ordering
- [ ] Manual: `npx @stackframe/stack-cli@latest init` (new onboarding
entrypoint) generates `hexclave.config.ts`
- [ ] Manual: existing `stack.config.ts`-only project still resolves (no
migration required)
---------
Co-authored-by: bilal <bilal@stack-auth.com>
922 lines
28 KiB
TypeScript
922 lines
28 KiB
TypeScript
import { it } from "../../../../helpers";
|
|
import { Auth, InternalApiKey, Project, Team, Webhook, bumpEmailAddress, niceBackendFetch } from "../../../backend-helpers";
|
|
|
|
|
|
it("is not allowed to list all the teams in a project on the client", async ({ expect }) => {
|
|
await Auth.fastSignUp();
|
|
const response = await niceBackendFetch("/api/v1/teams", { accessType: "client" });
|
|
expect(response).toMatchInlineSnapshot(`
|
|
NiceResponse {
|
|
"status": 403,
|
|
"body": "Client can only list teams for their own user. user_id must be either \\"me\\" or the ID of the current user",
|
|
"headers": Headers { <some fields may have been hidden> },
|
|
}
|
|
`);
|
|
});
|
|
|
|
it("lists all the teams in a project with server access", async ({ expect }) => {
|
|
await Auth.fastSignUp();
|
|
const response = await niceBackendFetch("/api/v1/teams", { accessType: "server" });
|
|
expect(response).toMatchObject({
|
|
status: 200,
|
|
body: {
|
|
items: expect.any(Array),
|
|
is_paginated: false,
|
|
},
|
|
headers: expect.anything(),
|
|
});
|
|
});
|
|
|
|
it("lists all the teams the current user has on the client", async ({ expect }) => {
|
|
await Project.createAndSwitch();
|
|
const { userId } = await Auth.fastSignUp();
|
|
const response1 = await niceBackendFetch("/api/v1/teams?user_id=me", { accessType: "client" });
|
|
expect(response1).toMatchInlineSnapshot(`
|
|
NiceResponse {
|
|
"status": 200,
|
|
"body": {
|
|
"is_paginated": false,
|
|
"items": [],
|
|
},
|
|
"headers": Headers { <some fields may have been hidden> },
|
|
}
|
|
`);
|
|
|
|
const response2 = await niceBackendFetch(`/api/v1/teams?user_id=${userId}`, { accessType: "client" });
|
|
expect(response2).toMatchInlineSnapshot(`
|
|
NiceResponse {
|
|
"status": 200,
|
|
"body": {
|
|
"is_paginated": false,
|
|
"items": [],
|
|
},
|
|
"headers": Headers { <some fields may have been hidden> },
|
|
}
|
|
`);
|
|
});
|
|
|
|
it("lists all the teams the current user has on the server", async ({ expect }) => {
|
|
await Project.createAndSwitch();
|
|
const { userId } = await Auth.fastSignUp();
|
|
const response1 = await niceBackendFetch("/api/v1/teams?user_id=me", { accessType: "server" });
|
|
expect(response1).toMatchInlineSnapshot(`
|
|
NiceResponse {
|
|
"status": 200,
|
|
"body": {
|
|
"is_paginated": false,
|
|
"items": [],
|
|
},
|
|
"headers": Headers { <some fields may have been hidden> },
|
|
}
|
|
`);
|
|
|
|
const response2 = await niceBackendFetch(`/api/v1/teams?user_id=${userId}`, { accessType: "server" });
|
|
expect(response2).toMatchInlineSnapshot(`
|
|
NiceResponse {
|
|
"status": 200,
|
|
"body": {
|
|
"is_paginated": false,
|
|
"items": [],
|
|
},
|
|
"headers": Headers { <some fields may have been hidden> },
|
|
}
|
|
`);
|
|
});
|
|
|
|
it("paginates teams across two pages without duplicates or skips", async ({ expect }) => {
|
|
await Project.createAndSwitch();
|
|
|
|
// Create 5 teams. Use a stable, ordered display name so we can assert the
|
|
// sequence after pagination.
|
|
const teamCount = 5;
|
|
for (let i = 0; i < teamCount; i++) {
|
|
const createResponse = await niceBackendFetch("/api/v1/teams", {
|
|
accessType: "server",
|
|
method: "POST",
|
|
body: { display_name: `Pagination team ${i.toString().padStart(2, "0")}` },
|
|
});
|
|
expect(createResponse.status).toBe(201);
|
|
}
|
|
|
|
const limit = 3;
|
|
const page1 = await niceBackendFetch(`/api/v1/teams?limit=${limit}`, { accessType: "server" });
|
|
expect(page1.status).toBe(200);
|
|
expect(page1.body.is_paginated).toBe(true);
|
|
expect(page1.body.items).toHaveLength(limit);
|
|
const cursor = page1.body.pagination?.next_cursor;
|
|
expect(cursor).toEqual(expect.any(String));
|
|
|
|
// Cursor should be the id of the last item we received, not a peek-ahead.
|
|
expect(cursor).toBe(page1.body.items[limit - 1].id);
|
|
|
|
const page2 = await niceBackendFetch(`/api/v1/teams?limit=${limit}&cursor=${encodeURIComponent(cursor)}`, { accessType: "server" });
|
|
expect(page2.status).toBe(200);
|
|
expect(page2.body.items.length).toBe(teamCount - limit);
|
|
|
|
const page1Ids = new Set(page1.body.items.map((t: any) => t.id));
|
|
const page2Ids = page2.body.items.map((t: any) => t.id);
|
|
for (const id of page2Ids) {
|
|
expect(page1Ids.has(id)).toBe(false); // no duplicates across pages
|
|
}
|
|
expect(page1.body.items.length + page2.body.items.length).toBe(teamCount); // no skips
|
|
expect(page2.body.pagination?.next_cursor ?? null).toBeNull();
|
|
});
|
|
|
|
it("creates a team on the client", async ({ expect }) => {
|
|
await Auth.fastSignUp();
|
|
await Team.createWithCurrentAsCreator();
|
|
});
|
|
|
|
it("does not allow creating a team when not signed in", async ({ expect }) => {
|
|
const { userId } = await Auth.fastSignUp();
|
|
await Auth.signOut();
|
|
const response = await niceBackendFetch("/api/v1/teams", {
|
|
accessType: "client",
|
|
method: "POST",
|
|
body: {
|
|
display_name: "New Team",
|
|
creator_user_id: userId,
|
|
},
|
|
});
|
|
expect(response).toMatchInlineSnapshot(`
|
|
NiceResponse {
|
|
"status": 401,
|
|
"body": {
|
|
"code": "USER_AUTHENTICATION_REQUIRED",
|
|
"error": "User authentication required for this endpoint.",
|
|
},
|
|
"headers": Headers {
|
|
"x-stack-known-error": "USER_AUTHENTICATION_REQUIRED",
|
|
<some fields may have been hidden>,
|
|
},
|
|
}
|
|
`);
|
|
});
|
|
|
|
it("does not allow creating teams on the client for a different creator", async ({ expect }) => {
|
|
await Project.createAndSwitch({ config: { client_team_creation_enabled: true } });
|
|
const { userId: userId1 } = await Auth.fastSignUp();
|
|
await Auth.fastSignUp();
|
|
const response = await niceBackendFetch("/api/v1/teams", {
|
|
accessType: "client",
|
|
method: "POST",
|
|
body: {
|
|
display_name: "New Team",
|
|
creator_user_id: userId1,
|
|
},
|
|
});
|
|
expect(response).toMatchInlineSnapshot(`
|
|
NiceResponse {
|
|
"status": 403,
|
|
"body": "You cannot create a team as a user that is not yourself. Make sure you set the creator_user_id to 'me'.",
|
|
"headers": Headers { <some fields may have been hidden> },
|
|
}
|
|
`);
|
|
});
|
|
|
|
it("creates a team on the server", async ({ expect }) => {
|
|
await Auth.fastSignUp();
|
|
await Team.createWithCurrentAsCreator({ accessType: "server" });
|
|
});
|
|
|
|
it("creates a team on the server without a creator", async ({ expect }) => {
|
|
await Auth.fastSignUp();
|
|
await Team.create({ accessType: "server" });
|
|
});
|
|
|
|
it("creates a team with a specific creator user id", async ({ expect }) => {
|
|
const { userId } = await Auth.fastSignUp();
|
|
await Team.create({ accessType: "server", creatorUserId: userId });
|
|
});
|
|
|
|
it("does not create a team when the creator user id does not exist", async ({ expect }) => {
|
|
await Auth.fastSignUp();
|
|
const response = await niceBackendFetch("/api/v1/teams", {
|
|
accessType: "server",
|
|
method: "POST",
|
|
body: {
|
|
display_name: "New Team",
|
|
creator_user_id: "12345678-1234-4234-9234-123456789012",
|
|
},
|
|
});
|
|
expect(response).toMatchInlineSnapshot(`
|
|
NiceResponse {
|
|
"status": 404,
|
|
"body": {
|
|
"code": "USER_NOT_FOUND",
|
|
"error": "User not found.",
|
|
},
|
|
"headers": Headers {
|
|
"x-stack-known-error": "USER_NOT_FOUND",
|
|
<some fields may have been hidden>,
|
|
},
|
|
}
|
|
`);
|
|
});
|
|
|
|
it("gets a specific team on the client", async ({ expect }) => {
|
|
await Auth.fastSignUp();
|
|
const { createTeamResponse: response, teamId } = await Team.createWithCurrentAsCreator();
|
|
expect(response).toMatchInlineSnapshot(`
|
|
NiceResponse {
|
|
"status": 201,
|
|
"body": {
|
|
"client_metadata": null,
|
|
"client_read_only_metadata": null,
|
|
"created_at_millis": <stripped field 'created_at_millis'>,
|
|
"display_name": "New Team",
|
|
"id": "<stripped UUID>",
|
|
"profile_image_url": null,
|
|
"server_metadata": null,
|
|
},
|
|
"headers": Headers { <some fields may have been hidden> },
|
|
}
|
|
`);
|
|
|
|
const response2 = await niceBackendFetch(`/api/v1/teams/${teamId}`, { accessType: "client" });
|
|
expect(response2).toMatchInlineSnapshot(`
|
|
NiceResponse {
|
|
"status": 200,
|
|
"body": {
|
|
"client_metadata": null,
|
|
"client_read_only_metadata": null,
|
|
"display_name": "New Team",
|
|
"id": "<stripped UUID>",
|
|
"profile_image_url": null,
|
|
},
|
|
"headers": Headers { <some fields may have been hidden> },
|
|
}
|
|
`);
|
|
});
|
|
|
|
it("gets a specific team that the user is not part of on the client", async ({ expect }) => {
|
|
await Auth.fastSignUp();
|
|
const { createTeamResponse: response, teamId } = await Team.createWithCurrentAsCreator();
|
|
|
|
await Auth.fastSignUp();
|
|
|
|
const response2 = await niceBackendFetch(`/api/v1/teams/${teamId}`, { accessType: "client" });
|
|
expect(response2).toMatchInlineSnapshot(`
|
|
NiceResponse {
|
|
"status": 404,
|
|
"body": {
|
|
"code": "TEAM_MEMBERSHIP_NOT_FOUND",
|
|
"details": {
|
|
"team_id": "<stripped UUID>",
|
|
"user_id": "<stripped UUID>",
|
|
},
|
|
"error": "User <stripped UUID> is not found in team <stripped UUID>.",
|
|
},
|
|
"headers": Headers {
|
|
"x-stack-known-error": "TEAM_MEMBERSHIP_NOT_FOUND",
|
|
<some fields may have been hidden>,
|
|
},
|
|
}
|
|
`);
|
|
});
|
|
|
|
it("gets a team that the user is not part of on the server", async ({ expect }) => {
|
|
await Auth.fastSignUp();
|
|
const { teamId } = await Team.createWithCurrentAsCreator();
|
|
|
|
await Auth.fastSignUp();
|
|
const { createTeamResponse: response } = await Team.createWithCurrentAsCreator();
|
|
expect(response).toMatchInlineSnapshot(`
|
|
NiceResponse {
|
|
"status": 201,
|
|
"body": {
|
|
"client_metadata": null,
|
|
"client_read_only_metadata": null,
|
|
"created_at_millis": <stripped field 'created_at_millis'>,
|
|
"display_name": "New Team",
|
|
"id": "<stripped UUID>",
|
|
"profile_image_url": null,
|
|
"server_metadata": null,
|
|
},
|
|
"headers": Headers { <some fields may have been hidden> },
|
|
}
|
|
`);
|
|
|
|
const response3 = await niceBackendFetch(`/api/v1/teams/${teamId}`, { accessType: "server" });
|
|
expect(response3).toMatchInlineSnapshot(`
|
|
NiceResponse {
|
|
"status": 200,
|
|
"body": {
|
|
"client_metadata": null,
|
|
"client_read_only_metadata": null,
|
|
"created_at_millis": <stripped field 'created_at_millis'>,
|
|
"display_name": "New Team",
|
|
"id": "<stripped UUID>",
|
|
"profile_image_url": null,
|
|
"server_metadata": null,
|
|
},
|
|
"headers": Headers { <some fields may have been hidden> },
|
|
}
|
|
`);
|
|
});
|
|
|
|
it("should not be allowed to get a team that the user is not part of on the client", async ({ expect }) => {
|
|
await Auth.fastSignUp();
|
|
const { teamId } = await Team.createWithCurrentAsCreator();
|
|
|
|
await Auth.fastSignUp();
|
|
const { createTeamResponse: response } = await Team.createWithCurrentAsCreator();
|
|
expect(response).toMatchInlineSnapshot(`
|
|
NiceResponse {
|
|
"status": 201,
|
|
"body": {
|
|
"client_metadata": null,
|
|
"client_read_only_metadata": null,
|
|
"created_at_millis": <stripped field 'created_at_millis'>,
|
|
"display_name": "New Team",
|
|
"id": "<stripped UUID>",
|
|
"profile_image_url": null,
|
|
"server_metadata": null,
|
|
},
|
|
"headers": Headers { <some fields may have been hidden> },
|
|
}
|
|
`);
|
|
|
|
const response3 = await niceBackendFetch(`/api/v1/teams/${teamId}`, { accessType: "client" });
|
|
expect(response3).toMatchInlineSnapshot(`
|
|
NiceResponse {
|
|
"status": 404,
|
|
"body": {
|
|
"code": "TEAM_MEMBERSHIP_NOT_FOUND",
|
|
"details": {
|
|
"team_id": "<stripped UUID>",
|
|
"user_id": "<stripped UUID>",
|
|
},
|
|
"error": "User <stripped UUID> is not found in team <stripped UUID>.",
|
|
},
|
|
"headers": Headers {
|
|
"x-stack-known-error": "TEAM_MEMBERSHIP_NOT_FOUND",
|
|
<some fields may have been hidden>,
|
|
},
|
|
}
|
|
`);
|
|
});
|
|
|
|
it("updates a team on the client", async ({ expect }) => {
|
|
const { userId } = await Auth.fastSignUp();
|
|
const { teamId } = await Team.createWithCurrentAsCreator();
|
|
|
|
// grant permission to update a team
|
|
await niceBackendFetch(`/api/v1/team-permissions/${teamId}/${userId}/$update_team`, {
|
|
accessType: "server",
|
|
method: "POST",
|
|
body: {},
|
|
});
|
|
|
|
// Has permission to update a team
|
|
const response2 = await niceBackendFetch(`/api/v1/teams/${teamId}`, {
|
|
accessType: "client",
|
|
method: "PATCH",
|
|
body: {
|
|
display_name: "My Updated Team",
|
|
},
|
|
});
|
|
expect(response2).toMatchInlineSnapshot(`
|
|
NiceResponse {
|
|
"status": 200,
|
|
"body": {
|
|
"client_metadata": null,
|
|
"client_read_only_metadata": null,
|
|
"display_name": "My Updated Team",
|
|
"id": "<stripped UUID>",
|
|
"profile_image_url": null,
|
|
},
|
|
"headers": Headers { <some fields may have been hidden> },
|
|
}
|
|
`);
|
|
});
|
|
|
|
it("can set a team's display name to the empty string", async ({ expect }) => {
|
|
const { userId } = await Auth.fastSignUp();
|
|
const { teamId } = await Team.createWithCurrentAsCreator();
|
|
|
|
// grant permission to update a team
|
|
await niceBackendFetch(`/api/v1/team-permissions/${teamId}/${userId}/$update_team`, {
|
|
accessType: "server",
|
|
method: "POST",
|
|
body: {},
|
|
});
|
|
|
|
// Has permission to update a team
|
|
const response2 = await niceBackendFetch(`/api/v1/teams/${teamId}`, {
|
|
accessType: "client",
|
|
method: "PATCH",
|
|
body: {
|
|
display_name: "",
|
|
},
|
|
});
|
|
expect(response2).toMatchInlineSnapshot(`
|
|
NiceResponse {
|
|
"status": 200,
|
|
"body": {
|
|
"client_metadata": null,
|
|
"client_read_only_metadata": null,
|
|
"display_name": "",
|
|
"id": "<stripped UUID>",
|
|
"profile_image_url": null,
|
|
},
|
|
"headers": Headers { <some fields may have been hidden> },
|
|
}
|
|
`);
|
|
});
|
|
|
|
it("updates team client metadata on the client", async ({ expect }) => {
|
|
const { userId } = await Auth.fastSignUp();
|
|
const { teamId } = await Team.createWithCurrentAsCreator();
|
|
|
|
// grant permission to update a team
|
|
await niceBackendFetch(`/api/v1/team-permissions/${teamId}/${userId}/$update_team`, {
|
|
accessType: "server",
|
|
method: "POST",
|
|
body: {},
|
|
});
|
|
|
|
// Has permission to update a team
|
|
const response2 = await niceBackendFetch(`/api/v1/teams/${teamId}`, {
|
|
accessType: "client",
|
|
method: "PATCH",
|
|
body: {
|
|
client_metadata: {
|
|
test: "test-value"
|
|
},
|
|
},
|
|
});
|
|
expect(response2).toMatchInlineSnapshot(`
|
|
NiceResponse {
|
|
"status": 200,
|
|
"body": {
|
|
"client_metadata": { "test": "test-value" },
|
|
"client_read_only_metadata": null,
|
|
"display_name": "New Team",
|
|
"id": "<stripped UUID>",
|
|
"profile_image_url": null,
|
|
},
|
|
"headers": Headers { <some fields may have been hidden> },
|
|
}
|
|
`);
|
|
});
|
|
|
|
it("should not be able to update team client read only metadata on the client", async ({ expect }) => {
|
|
const { userId } = await Auth.fastSignUp();
|
|
const { teamId } = await Team.createWithCurrentAsCreator();
|
|
|
|
// grant permission to update a team
|
|
await niceBackendFetch(`/api/v1/team-permissions/${teamId}/${userId}/$update_team`, {
|
|
accessType: "server",
|
|
method: "POST",
|
|
body: {},
|
|
});
|
|
|
|
// Has permission to update a team
|
|
const response2 = await niceBackendFetch(`/api/v1/teams/${teamId}`, {
|
|
accessType: "client",
|
|
method: "PATCH",
|
|
body: {
|
|
client_read_only_metadata: {
|
|
test: "test-value"
|
|
},
|
|
},
|
|
});
|
|
expect(response2).toMatchInlineSnapshot(`
|
|
NiceResponse {
|
|
"status": 400,
|
|
"body": {
|
|
"code": "SCHEMA_ERROR",
|
|
"details": {
|
|
"message": deindent\`
|
|
Request validation failed on PATCH /api/v1/teams/<stripped UUID>:
|
|
- body contains unknown properties: client_read_only_metadata
|
|
\`,
|
|
},
|
|
"error": deindent\`
|
|
Request validation failed on PATCH /api/v1/teams/<stripped UUID>:
|
|
- body contains unknown properties: client_read_only_metadata
|
|
\`,
|
|
},
|
|
"headers": Headers {
|
|
"x-stack-known-error": "SCHEMA_ERROR",
|
|
<some fields may have been hidden>,
|
|
},
|
|
}
|
|
`);
|
|
});
|
|
|
|
it("should not update a team without permission on the client", async ({ expect }) => {
|
|
const { userId } = await Auth.fastSignUp();
|
|
const { teamId } = await Team.create();
|
|
|
|
// add user to the team
|
|
await Team.addMember(teamId, userId);
|
|
|
|
// Does not have permission to update a team
|
|
const response1 = await niceBackendFetch(`/api/v1/teams/${teamId}`, {
|
|
accessType: "client",
|
|
method: "PATCH",
|
|
body: {
|
|
display_name: "My Updated Team",
|
|
},
|
|
});
|
|
expect(response1).toMatchInlineSnapshot(`
|
|
NiceResponse {
|
|
"status": 401,
|
|
"body": {
|
|
"code": "TEAM_PERMISSION_REQUIRED",
|
|
"details": {
|
|
"permission_id": "$update_team",
|
|
"team_id": "<stripped UUID>",
|
|
"user_id": "<stripped UUID>",
|
|
},
|
|
"error": "User <stripped UUID> does not have permission $update_team in team <stripped UUID>.",
|
|
},
|
|
"headers": Headers {
|
|
"x-stack-known-error": "TEAM_PERMISSION_REQUIRED",
|
|
<some fields may have been hidden>,
|
|
},
|
|
}
|
|
`);
|
|
});
|
|
|
|
it("updates a team on the server", async ({ expect }) => {
|
|
await Project.createAndSwitch();
|
|
await Auth.fastSignUp();
|
|
const { teamId } = await Team.createWithCurrentAsCreator({ accessType: "server" });
|
|
|
|
const response1 = await niceBackendFetch(`/api/v1/teams/${teamId}`, {
|
|
accessType: "server",
|
|
method: "PATCH",
|
|
body: {
|
|
display_name: "My Updated Team",
|
|
profile_image_url: "data:image/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==",
|
|
server_metadata: {
|
|
"test": "test-value"
|
|
},
|
|
},
|
|
});
|
|
expect(response1).toMatchInlineSnapshot(`
|
|
NiceResponse {
|
|
"status": 200,
|
|
"body": {
|
|
"client_metadata": null,
|
|
"client_read_only_metadata": null,
|
|
"created_at_millis": <stripped field 'created_at_millis'>,
|
|
"display_name": "My Updated Team",
|
|
"id": "<stripped UUID>",
|
|
"profile_image_url": "http://localhost:<$NEXT_PUBLIC_HEXCLAVE_PORT_PREFIX>21/stack-storage/team-profile-images/<stripped UUID>.gif",
|
|
"server_metadata": { "test": "test-value" },
|
|
},
|
|
"headers": Headers { <some fields may have been hidden> },
|
|
}
|
|
`);
|
|
|
|
const response2 = await niceBackendFetch("/api/v1/teams?user_id=me", { accessType: "server" });
|
|
expect(response2).toMatchInlineSnapshot(`
|
|
NiceResponse {
|
|
"status": 200,
|
|
"body": {
|
|
"is_paginated": false,
|
|
"items": [
|
|
{
|
|
"client_metadata": null,
|
|
"client_read_only_metadata": null,
|
|
"created_at_millis": <stripped field 'created_at_millis'>,
|
|
"display_name": "My Updated Team",
|
|
"id": "<stripped UUID>",
|
|
"profile_image_url": "http://localhost:<$NEXT_PUBLIC_HEXCLAVE_PORT_PREFIX>21/stack-storage/team-profile-images/<stripped UUID>.gif",
|
|
"server_metadata": { "test": "test-value" },
|
|
},
|
|
],
|
|
},
|
|
"headers": Headers { <some fields may have been hidden> },
|
|
}
|
|
`);
|
|
});
|
|
|
|
it("updates team client read only metadata on the server", async ({ expect }) => {
|
|
await Auth.fastSignUp();
|
|
const { teamId } = await Team.createWithCurrentAsCreator({ accessType: "server" });
|
|
|
|
const response1 = await niceBackendFetch(`/api/v1/teams/${teamId}`, {
|
|
accessType: "server",
|
|
method: "PATCH",
|
|
body: {
|
|
client_read_only_metadata: {
|
|
test: "test-value"
|
|
},
|
|
},
|
|
});
|
|
expect(response1).toMatchInlineSnapshot(`
|
|
NiceResponse {
|
|
"status": 200,
|
|
"body": {
|
|
"client_metadata": null,
|
|
"client_read_only_metadata": { "test": "test-value" },
|
|
"created_at_millis": <stripped field 'created_at_millis'>,
|
|
"display_name": "New Team",
|
|
"id": "<stripped UUID>",
|
|
"profile_image_url": null,
|
|
"server_metadata": null,
|
|
},
|
|
"headers": Headers { <some fields may have been hidden> },
|
|
}
|
|
`);
|
|
|
|
// check on the client
|
|
const response2 = await niceBackendFetch(`/api/v1/teams/${teamId}`, { accessType: "client" });
|
|
expect(response2).toMatchInlineSnapshot(`
|
|
NiceResponse {
|
|
"status": 200,
|
|
"body": {
|
|
"client_metadata": null,
|
|
"client_read_only_metadata": { "test": "test-value" },
|
|
"display_name": "New Team",
|
|
"id": "<stripped UUID>",
|
|
"profile_image_url": null,
|
|
},
|
|
"headers": Headers { <some fields may have been hidden> },
|
|
}
|
|
`);
|
|
});
|
|
|
|
it("deletes a team on the client", async ({ expect }) => {
|
|
const { userId } = await Auth.fastSignUp();
|
|
const { teamId } = await Team.createWithCurrentAsCreator();
|
|
|
|
// grant permission to delete a team
|
|
await niceBackendFetch(`/api/v1/team-permissions/${teamId}/${userId}/$delete_team`, {
|
|
accessType: "server",
|
|
method: "POST",
|
|
body: {},
|
|
});
|
|
|
|
// Has permission to delete a team
|
|
const response2 = await niceBackendFetch(`/api/v1/teams/${teamId}`, {
|
|
accessType: "client",
|
|
method: "DELETE",
|
|
body: {
|
|
display_name: "My Updated Team",
|
|
},
|
|
});
|
|
expect(response2).toMatchInlineSnapshot(`
|
|
NiceResponse {
|
|
"status": 200,
|
|
"body": { "success": true },
|
|
"headers": Headers { <some fields may have been hidden> },
|
|
}
|
|
`);
|
|
});
|
|
|
|
it("should not delete a team without permission on the client", async ({ expect }) => {
|
|
const { userId } = await Auth.fastSignUp();
|
|
const { teamId } = await Team.create();
|
|
|
|
// add user to the team
|
|
await Team.addMember(teamId, userId);
|
|
|
|
// Does not have permission to delete a team
|
|
const response1 = await niceBackendFetch(`/api/v1/teams/${teamId}`, {
|
|
accessType: "client",
|
|
method: "DELETE",
|
|
body: {
|
|
display_name: "My Updated Team",
|
|
},
|
|
});
|
|
expect(response1).toMatchInlineSnapshot(`
|
|
NiceResponse {
|
|
"status": 401,
|
|
"body": {
|
|
"code": "TEAM_PERMISSION_REQUIRED",
|
|
"details": {
|
|
"permission_id": "$delete_team",
|
|
"team_id": "<stripped UUID>",
|
|
"user_id": "<stripped UUID>",
|
|
},
|
|
"error": "User <stripped UUID> does not have permission $delete_team in team <stripped UUID>.",
|
|
},
|
|
"headers": Headers {
|
|
"x-stack-known-error": "TEAM_PERMISSION_REQUIRED",
|
|
<some fields may have been hidden>,
|
|
},
|
|
}
|
|
`);
|
|
});
|
|
|
|
it("deletes a team on the server", async ({ expect }) => {
|
|
await Project.createAndSwitch();
|
|
await Auth.fastSignUp();
|
|
const { teamId } = await Team.createWithCurrentAsCreator({ accessType: "server" });
|
|
|
|
const response1 = await niceBackendFetch(`/api/v1/teams/${teamId}`, {
|
|
accessType: "server",
|
|
method: "DELETE",
|
|
body: {},
|
|
});
|
|
expect(response1).toMatchInlineSnapshot(`
|
|
NiceResponse {
|
|
"status": 200,
|
|
"body": { "success": true },
|
|
"headers": Headers { <some fields may have been hidden> },
|
|
}
|
|
`);
|
|
|
|
const response2 = await niceBackendFetch("/api/v1/teams?user_id=me", { accessType: "server" });
|
|
expect(response2).toMatchInlineSnapshot(`
|
|
NiceResponse {
|
|
"status": 200,
|
|
"body": {
|
|
"is_paginated": false,
|
|
"items": [],
|
|
},
|
|
"headers": Headers { <some fields may have been hidden> },
|
|
}
|
|
`);
|
|
});
|
|
|
|
it("enables create team on sign up", async ({ expect }) => {
|
|
const { adminAccessToken } = await Project.createAndGetAdminToken();
|
|
const response = await niceBackendFetch("/api/v1/internal/projects/current", {
|
|
accessType: "admin",
|
|
method: "PATCH",
|
|
body: {
|
|
config: {
|
|
create_team_on_sign_up: true,
|
|
magic_link_enabled: true,
|
|
}
|
|
},
|
|
headers: {
|
|
"x-stack-admin-access-token": adminAccessToken,
|
|
},
|
|
});
|
|
|
|
expect(response.body.config.create_team_on_sign_up).toBe(true);
|
|
|
|
await InternalApiKey.createAndSetProjectKeys(adminAccessToken);
|
|
|
|
await bumpEmailAddress();
|
|
await Auth.Otp.signIn();
|
|
|
|
const response2 = await niceBackendFetch("/api/v1/teams?user_id=me", { accessType: "server" });
|
|
expect(response2).toMatchInlineSnapshot(`
|
|
NiceResponse {
|
|
"status": 200,
|
|
"body": {
|
|
"is_paginated": false,
|
|
"items": [
|
|
{
|
|
"client_metadata": null,
|
|
"client_read_only_metadata": null,
|
|
"created_at_millis": <stripped field 'created_at_millis'>,
|
|
"display_name": "mailbox-1--<stripped UUID>@stack-generated.example.com's Team",
|
|
"id": "<stripped UUID>",
|
|
"profile_image_url": null,
|
|
"server_metadata": null,
|
|
},
|
|
],
|
|
},
|
|
"headers": Headers { <some fields may have been hidden> },
|
|
}
|
|
`);
|
|
});
|
|
|
|
it("should trigger team webhook when a team is created", async ({ expect }) => {
|
|
const { projectId, svixToken, endpointId } = await Webhook.createProjectWithEndpoint();
|
|
|
|
const createTeamResponse = await niceBackendFetch("/api/v1/teams", {
|
|
method: "POST",
|
|
accessType: "server",
|
|
body: {
|
|
display_name: "Test Team"
|
|
}
|
|
});
|
|
expect(createTeamResponse).toMatchInlineSnapshot(`
|
|
NiceResponse {
|
|
"status": 201,
|
|
"body": {
|
|
"client_metadata": null,
|
|
"client_read_only_metadata": null,
|
|
"created_at_millis": <stripped field 'created_at_millis'>,
|
|
"display_name": "Test Team",
|
|
"id": "<stripped UUID>",
|
|
"profile_image_url": null,
|
|
"server_metadata": null,
|
|
},
|
|
"headers": Headers { <some fields may have been hidden> },
|
|
}
|
|
`);
|
|
|
|
const attemptResponse = await Webhook.findWebhookAttempt(projectId, endpointId, svixToken, event => true);
|
|
|
|
expect(attemptResponse).toMatchInlineSnapshot(`
|
|
{
|
|
"channels": null,
|
|
"eventId": null,
|
|
"eventType": "team.created",
|
|
"id": "<stripped svix message id>",
|
|
"payload": {
|
|
"data": {
|
|
"client_metadata": null,
|
|
"client_read_only_metadata": null,
|
|
"created_at_millis": <stripped field 'created_at_millis'>,
|
|
"display_name": "Test Team",
|
|
"id": "<stripped UUID>",
|
|
"profile_image_url": null,
|
|
"server_metadata": null,
|
|
},
|
|
"type": "team.created",
|
|
},
|
|
"timestamp": <stripped field 'timestamp'>,
|
|
}
|
|
`);
|
|
});
|
|
|
|
it("should trigger team webhook when a team is updated", async ({ expect }) => {
|
|
const { projectId, svixToken, endpointId } = await Webhook.createProjectWithEndpoint();
|
|
|
|
const createTeamResponse = await niceBackendFetch("/api/v1/teams", {
|
|
method: "POST",
|
|
accessType: "server",
|
|
body: {
|
|
display_name: "Test Team"
|
|
}
|
|
});
|
|
|
|
expect(createTeamResponse.status).toBe(201);
|
|
const teamId = createTeamResponse.body.id;
|
|
|
|
const updateTeamResponse = await niceBackendFetch(`/api/v1/teams/${teamId}`, {
|
|
method: "PATCH",
|
|
accessType: "server",
|
|
body: {
|
|
display_name: "Updated Team Name"
|
|
}
|
|
});
|
|
|
|
expect(updateTeamResponse.status).toBe(200);
|
|
|
|
const teamUpdatedEvent = await Webhook.findWebhookAttempt(projectId, endpointId, svixToken, event => event.eventType === "team.updated");
|
|
|
|
expect(teamUpdatedEvent).toMatchInlineSnapshot(`
|
|
{
|
|
"channels": null,
|
|
"eventId": null,
|
|
"eventType": "team.updated",
|
|
"id": "<stripped svix message id>",
|
|
"payload": {
|
|
"data": {
|
|
"client_metadata": null,
|
|
"client_read_only_metadata": null,
|
|
"created_at_millis": <stripped field 'created_at_millis'>,
|
|
"display_name": "Updated Team Name",
|
|
"id": "<stripped UUID>",
|
|
"profile_image_url": null,
|
|
"server_metadata": null,
|
|
},
|
|
"type": "team.updated",
|
|
},
|
|
"timestamp": <stripped field 'timestamp'>,
|
|
}
|
|
`);
|
|
});
|
|
|
|
it("should trigger team webhook when a team is deleted", async ({ expect }) => {
|
|
const { projectId, svixToken, endpointId } = await Webhook.createProjectWithEndpoint();
|
|
|
|
const createTeamResponse = await niceBackendFetch("/api/v1/teams", {
|
|
method: "POST",
|
|
accessType: "server",
|
|
body: {
|
|
display_name: "Test Team"
|
|
}
|
|
});
|
|
|
|
expect(createTeamResponse.status).toBe(201);
|
|
const teamId = createTeamResponse.body.id;
|
|
|
|
const deleteTeamResponse = await niceBackendFetch(`/api/v1/teams/${teamId}`, {
|
|
method: "DELETE",
|
|
accessType: "server"
|
|
});
|
|
|
|
expect(deleteTeamResponse.status).toBe(200);
|
|
|
|
const teamDeletedEvent = await Webhook.findWebhookAttempt(projectId, endpointId, svixToken, event => event.eventType === "team.deleted");
|
|
|
|
expect(teamDeletedEvent).toMatchInlineSnapshot(`
|
|
{
|
|
"channels": null,
|
|
"eventId": null,
|
|
"eventType": "team.deleted",
|
|
"id": "<stripped svix message id>",
|
|
"payload": {
|
|
"data": { "id": "<stripped UUID>" },
|
|
"type": "team.deleted",
|
|
},
|
|
"timestamp": <stripped field 'timestamp'>,
|
|
}
|
|
`);
|
|
});
|