blog: stack-auth multi-tenant app #402
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
WalkthroughThe changes introduce a new file, Changes
Possibly related PRs
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Outside diff range and nitpick comments (4)
blog/stackauth-multitenancy/index.mdx (4)
37-37: Fix grammar: Use "a team" instead of "an team"The article "an" should be used before words that start with a vowel sound. Since "team" starts with a consonant sound, use "a team" instead.
-Users can choose an team to be the current context. +Users can choose a team to be the current context.🧰 Tools
🪛 LanguageTool
[misspelling] ~37-~37: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’.
Context: ...Current context** Users can choose an team to be the current context. - **Da...(EN_A_VS_AN)
116-124: Consider adding indexes for better query performanceThe
Listmodel would benefit from indexes on frequently queried fields:
orgIdfor tenant filteringownerIdfor user filtering- Compound index on
(orgId, createdAt)for sorted queries within a tenantmodel List { id String @id @default(cuid()) createdAt DateTime @default(now()) title String private Boolean @default(false) orgId String? ownerId String todos Todo[] + + @@index([orgId]) + @@index([ownerId]) + @@index([orgId, createdAt]) }
127-134: Add audit fields to Todo modelFor better auditability, consider adding
createdAtandupdatedAttimestamps to theTodomodel.model Todo { id String @id @default(cuid()) + createdAt DateTime @default(now()) + updatedAt DateTime @updatedAt title String completedAt DateTime? list List @relation(fields: [listId], references: [id], onDelete: Cascade) listId String }
29-29: Consider standardizing "Todo" vs "To-do" usageWhile "To-do" is grammatically correct, "Todo" is a commonly accepted spelling in programming contexts. For consistency, consider choosing one style and using it throughout the document. If choosing "To-do", update all occurrences.
Also applies to: 46-47, 94-94, 229-229, 302-302
🧰 Tools
🪛 LanguageTool
[grammar] ~29-~29: It appears that a hyphen is missing in the noun “To-do” (= task) or did you mean the verb “to do”?
Context: ...The target application we'll build is a Todo List. Its core functionalities are simp...(TO_DO_HYPHEN)
[grammar] ~29-~29: It appears that a hyphen is missing in the plural noun “to-dos”?
Context: ...are simple: creating lists and managing todos within them. However, the focus will be...(TO_DO_HYPHEN)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
⛔ Files ignored due to path filters (4)
blog/stackauth-multitenancy/cover.pngis excluded by!**/*.png,!**/*.pngblog/stackauth-multitenancy/list-ui.gifis excluded by!**/*.gif,!**/*.gifblog/stackauth-multitenancy/team-management.pngis excluded by!**/*.png,!**/*.pngblog/stackauth-multitenancy/team-settings.pngis excluded by!**/*.png,!**/*.png
📒 Files selected for processing (1)
blog/stackauth-multitenancy/index.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
blog/stackauth-multitenancy/index.mdx
[grammar] ~29-~29: It appears that a hyphen is missing in the noun “To-do” (= task) or did you mean the verb “to do”?
Context: ...The target application we'll build is a Todo List. Its core functionalities are simp...
(TO_DO_HYPHEN)
[grammar] ~29-~29: It appears that a hyphen is missing in the plural noun “to-dos”?
Context: ...are simple: creating lists and managing todos within them. However, the focus will be...
(TO_DO_HYPHEN)
[misspelling] ~37-~37: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’.
Context: ...Current context** Users can choose an team to be the current context. - **Da...
(EN_A_VS_AN)
[grammar] ~46-~46: It appears that a hyphen is missing in the noun “to-do” (= task) or did you mean the verb “to do”?
Context: ...Regular members have full access to the todo lists they own. - Regular members can...
(TO_DO_HYPHEN)
[grammar] ~47-~47: It appears that a hyphen is missing in the noun “to-do” (= task) or did you mean the verb “to do”?
Context: ...lar members can view the other members' todo lists and manage their content, as long...
(TO_DO_HYPHEN)
[grammar] ~94-~94: It appears that a hyphen is missing in the noun “to-do” (= task) or did you mean the verb “to do”?
Context: ... StackAuth's side. We need to store the todo lists and items in our own database. In...
(TO_DO_HYPHEN)
[uncategorized] ~196-~196: If “ where” starts an indirect question, you do not need to put a comma before it.
Context: ...zzle is, as you may already be wondering, where the value of auth() comes from? At ru...
(NO_COMMA_BEFORE_INDIRECT_QUESTION)
[grammar] ~229-~229: It appears that a hyphen is missing in the noun “to-do” (= task) or did you mean the verb “to do”?
Context: ...ement. Here's the RSC that renders the todo lists for the current user (with stylin...
(TO_DO_HYPHEN)
[grammar] ~302-~302: It appears that a hyphen is missing in the noun “To-do” (= task) or did you mean the verb “to do”?
Context: ..." /> The components that manage Todo items are not shown for brevity, but th...
(TO_DO_HYPHEN)
[style] ~306-~306: ‘end result’ might be wordy. Consider a shorter alternative.
Context: ...tack's access control capabilities. The end result is a secure application with great flex...
(EN_WORDINESS_PREMIUM_END_RESULT)
| export default function CreateList() { | ||
| function onCreate() { | ||
| const title = prompt("Enter a title for your list"); | ||
| if (title) { | ||
| createList(title); | ||
| } | ||
| } | ||
|
|
||
| return ( | ||
| <button onClick={onCreate}> | ||
| Create a list | ||
| </button> | ||
| ); | ||
| } | ||
| ``` |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Replace prompt() with a proper modal dialog
Using the browser's prompt() provides a poor user experience. Consider using a proper modal dialog component instead.
Example implementation:
"use client";
import { useState } from 'react';
import { createList } from "~/app/actions";
export default function CreateList() {
const [isOpen, setIsOpen] = useState(false);
const [title, setTitle] = useState('');
async function handleSubmit(e: React.FormEvent) {
e.preventDefault();
try {
await createList(title);
setIsOpen(false);
setTitle('');
} catch (error) {
console.error(error);
// Show error message to user
}
}
return (
<>
<button onClick={() => setIsOpen(true)}>
Create a list
</button>
{isOpen && (
<dialog open>
<form onSubmit={handleSubmit}>
<h2>Create New List</h2>
<input
type="text"
value={title}
onChange={(e) => setTitle(e.target.value)}
placeholder="Enter list title"
required
/>
<div>
<button type="button" onClick={() => setIsOpen(false)}>
Cancel
</button>
<button type="submit">
Create
</button>
</div>
</form>
</dialog>
)}
</>
);
}| // deny anonymous access | ||
| @@deny('all', auth() == null) | ||
|
|
||
| // tenant segregation: deny access if the user's current org doesn't match | ||
| @@deny('all', auth().currentOrgId != orgId) | ||
|
|
||
| // owner/admin has full access | ||
| @@allow('all', auth().userId == ownerId || auth().currentOrgRole == 'org:admin') | ||
|
|
||
| // can be read by org members if not private | ||
| @@allow('read', !private) | ||
|
|
||
| // when create, owner must be set to current user | ||
| @@allow('create', ownerId == auth().userId) | ||
| } |
There was a problem hiding this comment.
Add validation for orgId during list creation
The current rules don't ensure that orgId matches the user's current team during creation. This could lead to data being created in the wrong tenant.
model List {
...
// deny anonymous access
@@deny('all', auth() == null)
// tenant segregation: deny access if the user's current org doesn't match
@@deny('all', auth().currentOrgId != orgId)
// owner/admin has full access
@@allow('all', auth().userId == ownerId || auth().currentOrgRole == 'org:admin')
// can be read by org members if not private
@@allow('read', !private)
// when create, owner must be set to current user
- @@allow('create', ownerId == auth().userId)
+ @@allow('create', ownerId == auth().userId && orgId == auth().currentOrgId)
}📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| // deny anonymous access | |
| @@deny('all', auth() == null) | |
| // tenant segregation: deny access if the user's current org doesn't match | |
| @@deny('all', auth().currentOrgId != orgId) | |
| // owner/admin has full access | |
| @@allow('all', auth().userId == ownerId || auth().currentOrgRole == 'org:admin') | |
| // can be read by org members if not private | |
| @@allow('read', !private) | |
| // when create, owner must be set to current user | |
| @@allow('create', ownerId == auth().userId) | |
| } | |
| // deny anonymous access | |
| @@deny('all', auth() == null) | |
| // tenant segregation: deny access if the user's current org doesn't match | |
| @@deny('all', auth().currentOrgId != orgId) | |
| // owner/admin has full access | |
| @@allow('all', auth().userId == ownerId || auth().currentOrgRole == 'org:admin') | |
| // can be read by org members if not private | |
| @@allow('read', !private) | |
| // when create, owner must be set to current user | |
| @@allow('create', ownerId == auth().userId && orgId == auth().currentOrgId) | |
| } |
| export async function createList(title: string) { | ||
| const db = await getUserDb(); | ||
| await db.list.create({ data: { title } }); | ||
| revalidatePath("/"); | ||
| } | ||
| ``` |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add error handling to createList action
The server action should handle potential errors and validate input.
export async function createList(title: string) {
+ if (!title?.trim()) {
+ throw new Error('Title is required');
+ }
const db = await getUserDb();
+ try {
await db.list.create({ data: { title } });
revalidatePath("/");
+ } catch (error) {
+ console.error('Failed to create list:', error);
+ throw new Error('Failed to create list');
+ }
}📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| export async function createList(title: string) { | |
| const db = await getUserDb(); | |
| await db.list.create({ data: { title } }); | |
| revalidatePath("/"); | |
| } | |
| ``` | |
| export async function createList(title: string) { | |
| if (!title?.trim()) { | |
| throw new Error('Title is required'); | |
| } | |
| const db = await getUserDb(); | |
| try { | |
| await db.list.create({ data: { title } }); | |
| revalidatePath("/"); | |
| } catch (error) { | |
| console.error('Failed to create list:', error); | |
| throw new Error('Failed to create list'); | |
| } | |
| } |
Summary by CodeRabbit