BilalG1 bf1f165a51 User getter error (#956) ... <!-- Make sure you've read the CONTRIBUTING.md guidelines: https://github.com/stack-auth/stack-auth/blob/dev/CONTRIBUTING.md --> <!-- RECURSEML_SUMMARY:START --> ## High-level PR Summary This PR adds a developer-friendly error guard to prevent a common mistake where developers try to destructure the user object from `getUser()` or `useUser()` calls (e.g., `const { user } = await app.getUser()`), when the method already returns the user object directly. The fix implements a property getter that throws a helpful error message, attaches it to all user objects (client-side `CurrentUser`, server-side `ServerUser`, and `ServerTeamUser`), and includes E2E tests to verify the behavior. Additionally, it fixes a typo in the Convex example and addresses seed script execution issues. ⏱️ Estimated Review Time: 5-15 minutes <details> <summary>💡 Review Order Suggestion</summary> | Order | File Path | |-------|-----------| | 1 | `packages/template/src/lib/stack-app/users/index.ts` | | 2 | `packages/template/src/lib/stack-app/apps/implementations/client-app-impl.ts` | | 3 | `packages/template/src/lib/stack-app/apps/implementations/server-app-impl.ts` | | 4 | `apps/e2e/tests/js/app.test.ts` | | 5 | `examples/convex/convex/myFunctions.ts` | | 6 | `apps/backend/prisma/seed.ts` | | 7 | `.github/workflows/check-prisma-migrations.yaml` | </details> <details> <summary>⚠️ Inconsistent Changes Detected</summary> | File Path | Warning | |-----------|---------| | `.github/workflows/check-prisma-migrations.yaml` | Adds database cleanup step for auto-migration metadata in CI workflow, which appears unrelated to the main purpose of adding a user getter error guard | | `apps/backend/prisma/seed.ts` | Restructures the seed script execution logic and removes the main module check handler, which seems unrelated to the user getter error fix | </details> [](https://discord.gg/n3SsVDAW6U) [ <!-- RECURSEML_SUMMARY:END --> <!-- ELLIPSIS_HIDDEN --> ---- > [!IMPORTANT] > Adds a guard to prevent destructuring of `user` objects and includes a test to verify the error message. > > - **Behavior**: > - Adds `attachUserDestructureGuard` function in `users/index.ts` to throw an error when attempting to destructure `user`. > - Updates `getUser()` in `client-app-impl.ts` and `server-app-impl.ts` to use `attachUserDestructureGuard`. > - Adds test in `app.test.ts` to verify error message when destructuring `user`. > - **Misc**: > - Fixes string concatenation error in `myFunctions.ts`. > - Adds step in `check-prisma-migrations.yaml` to remove auto-migration metadata. > > <sup>This description was created by </sup>[<img alt="Ellipsis" src="https://img.shields.io/badge/Ellipsis-blue?color=175173">](https://www.ellipsis.dev?ref=stack-auth%2Fstack-auth&utm_source=github&utm_medium=referral)<sup> for 9be5c8a0e2. You can [customize](https://app.ellipsis.dev/stack-auth/settings/summaries) this summary. It will automatically update as commits are pushed.</sup> <!-- ELLIPSIS_HIDDEN --> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Bug Fixes** * Added a protective guard that prevents destructuring the user from current user objects on both client and server, displaying a clear, actionable error with guidance to use supported access methods. Valid usage is unaffected; no API changes. * **Tests** * Introduced end-to-end tests verifying the new error message and behavior across sign-up, sign-in, and current user retrieval on client and server. <!-- end of auto-generated comment: release notes by coderabbit.ai -->		2025-10-15 15:20:34 -07:00
..
tests	User getter error (#956)	2025-10-15 15:20:34 -07:00
.env	Auto migration (#526)	2025-07-24 02:38:37 +02:00
.env.development	Auto migration (#526)	2025-07-24 02:38:37 +02:00
.eslintrc.cjs	tsup for stack-shared (#647)	2025-04-28 21:26:52 -07:00
CHANGELOG.md	chore: update package versions	2025-10-15 10:56:40 -07:00
LICENSE	Create users & auth endpoints in backend (#85)	2024-07-01 22:42:08 -07:00
package.json	chore: update package versions	2025-10-15 10:56:40 -07:00
tsconfig.json	In-source unit tests (#429)	2025-02-14 11:47:52 -08:00
vitest.config.ts	Endpoints branching (#659)	2025-04-30 15:39:47 -07:00