doc: add Lucia Auth doc - #323

Merged
ymc9 merged 9 commits into
mainfrom
jiasheng
Jul 12, 2024
Merged

doc: add Lucia Auth doc#323
ymc9 merged 9 commits into
mainfrom
jiasheng

Conversation

@jiashengguo

@jiashengguojiashengguo commented Jul 9, 2024

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Documentation
    • Updated authentication guide with detailed instructions for integrating ZenStack with Lucia Auth.

@vercel

vercelBot commented Jul 9, 2024

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for Git ↗︎

NameStatusPreviewCommentsUpdated (UTC)
zenstack-new-site✅ Ready (Inspect)Visit Preview💬 Add feedbackJul 12, 2024 5:27pm

@coderabbitai

coderabbitaiBot commented Jul 9, 2024

Copy link
Copy Markdown
Contributor

Warning

Rate limit exceeded

@ymc9 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 25 minutes and 3 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 66ef8cf and 454753c.

Walkthrough

The updates to lucia.md transform placeholder text into comprehensive guidance on integrating ZenStack with Lucia Auth. This includes detailed instructions on data model requirements, implementing a Prisma adapter, request validation, creating an enhanced Prisma client, and exposing more user data. These enhancements significantly improve the guide's clarity and practicality for developers.

Changes

FilesChange Summary
docs/guides/authentication/lucia.mdTransitioned from placeholder text to detailed integration instructions for ZenStack with Lucia Auth.
.../lib/auth.tsAdded data models, Prisma adapter initialization, request validation, and user data exposure functions and interfaces.
.../lib/db.tsIntroduced an enhanced Prisma client creation.

Sequence Diagram(s)

sequenceDiagram
actor Developer
participant docs/guides/authentication/lucia.md as Lucia Guide
participant lib/auth.ts as auth.ts
participant lib/db.ts as db.ts
participant PrismaClient
participant PrismaAdapter
Developer ->> Lucia Guide: Read integration instructions
Lucia Guide ->> auth.ts: Update for Prisma Adapter and user data exposure
Lucia Guide ->> db.ts: Enhance Prisma client creation
auth.ts ->> PrismaClient: Import Prisma Client
auth.ts ->> PrismaAdapter: Initialize Prisma Adapter
auth.ts ->> auth.ts: Define request validation and user data exposure functions
db.ts ->> PrismaClient: Import Prisma Client
db.ts ->> db.ts: Define enhanced Prisma client function
Loading

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?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 4

Outside diff range and nitpick comments (1)
docs/guides/authentication/lucia.md (1)

15-15: Consider rephrasing to avoid repetition.

The phrase "needs to" is used repetitively. Consider rephrasing to add variety.

- So, your ZModel definition needs to include these two models.+ Therefore, your ZModel definition should include these two models.
Tools
LanguageTool

[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...js). ## Data Model Requirement Lucia needs to store your users and sessions in the da...

(REP_NEED_TO_VB)


[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...he database. So, your ZModel definition needs to include these two models. Here is the s...

(REP_NEED_TO_VB)

Comment threaddocs/guides/authentication/lucia.md Outdated
Comment threaddocs/guides/authentication/lucia.md
Comment threaddocs/guides/authentication/lucia.md
Comment threaddocs/guides/authentication/lucia.md
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Comment threaddocs/guides/authentication/lucia.md Outdated

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

Outside diff range, codebase verification and nitpick comments (5)
docs/guides/authentication/lucia.md (5)

54-84: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-export const validateRequest = cache(- async (): Promise<{ user: User; session: Session } | { user: null; session: null }> => {- const sessionId = cookies().get(lucia.sessionCookieName)?.value ?? null;- if (!sessionId) {- return {- user: null,- session: null- };- }-- const result = await lucia.validateSession(sessionId);- // next.js throws when you attempt to set cookie when rendering page- try {- if (result.session && result.session.fresh) {- const sessionCookie = lucia.createSessionCookie(result.session.id);- cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);- }- if (!result.session) {- const sessionCookie = lucia.createBlankSessionCookie();- cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);- }- } catch {}- return result;- }-);+export const validateRequest = cache(+ async (): Promise<{ user: User; session: Session } | { user: null; session: null }> => {+ const sessionId = cookies().get(lucia.sessionCookieName)?.value ?? null;+ if (!sessionId) {+ return {+ user: null,+ session: null+ };+ }++ const result = await lucia.validateSession(sessionId);+ // next.js throws when you attempt to set cookie when rendering page+ try {+ if (result.session && result.session.fresh) {+ const sessionCookie = lucia.createSessionCookie(result.session.id);+ cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);+ }+ if (!result.session) {+ const sessionCookie = lucia.createBlankSessionCookie();+ cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);+ }+ } catch {}+ return result;+ }+);

86-94: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-	const { user } = await validateRequest();--	if (!user) {- return redirect("/login");-	}+ const { user } = await validateRequest();++ if (!user) {+ return redirect("/login");+ }
Tools
Markdownlint

89-89: Column: 1
Hard tabs

(MD010, no-hard-tabs)


91-91: Column: 1
Hard tabs

(MD010, no-hard-tabs)


92-92: Column: 1
Hard tabs

(MD010, no-hard-tabs)


93-93: Column: 1
Hard tabs

(MD010, no-hard-tabs)


117-140: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-declare module "lucia" {-	interface Register {- Lucia: typeof lucia;- DatabaseUserAttributes: DatabaseUserAttributes-	}-}--interface DatabaseUserAttributes {- userName: string;-}--export const lucia = new Lucia(adapter, {-	getUserAttributes: (attributes) => {- return {- userName: attributes.userName- };-	}+declare module "lucia" {+ interface Register {+ Lucia: typeof lucia;+ DatabaseUserAttributes: DatabaseUserAttributes+ }+}++interface DatabaseUserAttributes {+ userName: string;+}++export const lucia = new Lucia(adapter, {+ getUserAttributes: (attributes) => {+ return {+ userName: attributes.userName+ };+ }
});

142-153: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-export default async function Page() {-	const { user } = await validateRequest();	-	return (- <>- <h1>Hi, {user.userName}!</h1>- <p>Your user ID is {user.id}.</p>- </>-	);+export default async function Page() {+ const { user } = await validateRequest();	+ return (+ <>+ <h1>Hi, {user.userName}!</h1>+ <p>Your user ID is {user.id}.</p>+ </>+ );
}
Tools
Markdownlint

146-146: Column: 44
Hard tabs

(MD010, no-hard-tabs)


15-15: Vary the phrasing for better readability.

The phrasing "needs to" is repeated in nearby sentences. Consider rephrasing to add variety.

- Lucia needs to store your users and sessions in the database. So, your ZModel definition needs to include these two models.+ Lucia requires storing your users and sessions in the database. Thus, your ZModel definition should include these two models.
Tools
LanguageTool

[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...js). ## Data model requirement Lucia needs to store your users and sessions in the da...

(REP_NEED_TO_VB)


[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...he database. So, your ZModel definition needs to include these two models. Here is the s...

(REP_NEED_TO_VB)

Comment threaddocs/guides/authentication/lucia.md Outdated
Comment threaddocs/guides/authentication/lucia.md
jiashengguoand others added 2 commits July 12, 2024 15:28
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 4

Outside diff range, codebase verification and nitpick comments (1)
docs/guides/authentication/lucia.md (1)

15-15: Consider rephrasing to avoid repetition.

The sentence "Lucia needs to store your users and sessions in the database" is repetitive. Consider rephrasing for variety.

- Lucia needs to store your users and sessions in the database. So, your ZModel definition needs to include these two models.+ To store users and sessions in the database, your ZModel definition must include these two models.
Tools
LanguageTool

[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...js). ## Data model requirement Lucia needs to store your users and sessions in the da...

(REP_NEED_TO_VB)


[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...he database. So, your ZModel definition needs to include these two models. Here is the s...

(REP_NEED_TO_VB)

Comment threaddocs/guides/authentication/lucia.md
Comment threaddocs/guides/authentication/lucia.md Outdated
Comment threaddocs/guides/authentication/lucia.md
Comment threaddocs/guides/authentication/lucia.md

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (5)
docs/guides/authentication/lucia.md (5)

58-82: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-export const validateRequest = cache(- async (): Promise<{ user: User; session: Session } | { user: null; session: null }> => {- const sessionId = cookies().get(lucia.sessionCookieName)?.value ?? null;- if (!sessionId) {- return {- user: null,- session: null- };- }-- const result = await lucia.validateSession(sessionId);- // next.js throws when you attempt to set cookie when rendering page- try {- if (result.session && result.session.fresh) {- const sessionCookie = lucia.createSessionCookie(result.session.id);- cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);- }- if (!result.session) {- const sessionCookie = lucia.createBlankSessionCookie();- cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);- }- } catch {}- return result;- }-);+export const validateRequest = cache(+ async (): Promise<{ user: User; session: Session } | { user: null; session: null }> => {+ const sessionId = cookies().get(lucia.sessionCookieName)?.value ?? null;+ if (!sessionId) {+ return {+ user: null,+ session: null+ };+ }+ const result = await lucia.validateSession(sessionId);+ // next.js throws when you attempt to set cookie when rendering page+ try {+ if (result.session && result.session.fresh) {+ const sessionCookie = lucia.createSessionCookie(result.session.id);+ cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);+ }+ if (!result.session) {+ const sessionCookie = lucia.createBlankSessionCookie();+ cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);+ }+ } catch {}+ return result;+ }+);

101-113: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-export async function getEnhancedPrisma(): Promise<PrismaClient> {- const { user } = await validateRequest();- // create a wrapper of Prisma client that enforces access policy,- // data validation, and @password, @omit behaviors- return enhance(prisma, { user: {id: user?.id!}});+export async function getEnhancedPrisma(): Promise<PrismaClient> {+ const { user } = await validateRequest();+ // create a wrapper of Prisma client that enforces access policy,+ // data validation, and @password, @omit behaviors+ return enhance(prisma, { user: {id: user?.id!}});
}

121-138: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-declare module "lucia" {- interface Register {- Lucia: typeof lucia;- DatabaseUserAttributes: DatabaseUserAttributes- }-}--interface DatabaseUserAttributes {- userName: string;-}--export const lucia = new Lucia(adapter, {- getUserAttributes: (attributes) => {- return {- userName: attributes.userName- };- }+declare module "lucia" {+ interface Register {+ Lucia: typeof lucia;+ DatabaseUserAttributes: DatabaseUserAttributes+ }+}++interface DatabaseUserAttributes {+ userName: string;+}++export const lucia = new Lucia(adapter, {+ getUserAttributes: (attributes) => {+ return {+ userName: attributes.userName+ };+ }
});

7-7: Ensure consistent casing for all titles.

The title "Integrating With Lucia" should use consistent casing.

-# Integrating With Lucia+# Integrating with Lucia

144-151: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-export default async function Page() {- const { user } = await validateRequest();	- return (- <>- <h1>Hi, {user.userName}!</h1>- <p>Your user ID is {user.id}.</p>- </>- );+export default async function Page() {+ const { user } = await validateRequest();	+ return (+ <>+ <h1>Hi, {user.userName}!</h1>+ <p>Your user ID is {user.id}.</p>+ </>+ );
}
Tools
Markdownlint

145-145: Column: 44
Hard tabs

(MD010, no-hard-tabs)

@ymc9
ymc9 merged commit 88c6a57 into mainJul 12, 2024
@ymc9
ymc9 deleted the jiasheng branch July 12, 2024 17:26
@coderabbitaicoderabbitaiBot mentioned this pull request Nov 4, 2024
@coderabbitaicoderabbitaiBot mentioned this pull request Nov 24, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@jiashengguo@ymc9
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

doc: add Lucia Auth doc - #323

Merged
ymc9 merged 9 commits into
mainfrom
jiasheng
Jul 12, 2024
Merged

doc: add Lucia Auth doc#323
ymc9 merged 9 commits into
mainfrom
jiasheng

Conversation

@jiashengguo

@jiashengguojiashengguo commented Jul 9, 2024

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Documentation
    • Updated authentication guide with detailed instructions for integrating ZenStack with Lucia Auth.

@vercel

vercelBot commented Jul 9, 2024

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for Git ↗︎

NameStatusPreviewCommentsUpdated (UTC)
zenstack-new-site✅ Ready (Inspect)Visit Preview💬 Add feedbackJul 12, 2024 5:27pm

@coderabbitai

coderabbitaiBot commented Jul 9, 2024

Copy link
Copy Markdown
Contributor

Warning

Rate limit exceeded

@ymc9 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 25 minutes and 3 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 66ef8cf and 454753c.

Walkthrough

The updates to lucia.md transform placeholder text into comprehensive guidance on integrating ZenStack with Lucia Auth. This includes detailed instructions on data model requirements, implementing a Prisma adapter, request validation, creating an enhanced Prisma client, and exposing more user data. These enhancements significantly improve the guide's clarity and practicality for developers.

Changes

FilesChange Summary
docs/guides/authentication/lucia.mdTransitioned from placeholder text to detailed integration instructions for ZenStack with Lucia Auth.
.../lib/auth.tsAdded data models, Prisma adapter initialization, request validation, and user data exposure functions and interfaces.
.../lib/db.tsIntroduced an enhanced Prisma client creation.

Sequence Diagram(s)

sequenceDiagram
actor Developer
participant docs/guides/authentication/lucia.md as Lucia Guide
participant lib/auth.ts as auth.ts
participant lib/db.ts as db.ts
participant PrismaClient
participant PrismaAdapter
Developer ->> Lucia Guide: Read integration instructions
Lucia Guide ->> auth.ts: Update for Prisma Adapter and user data exposure
Lucia Guide ->> db.ts: Enhance Prisma client creation
auth.ts ->> PrismaClient: Import Prisma Client
auth.ts ->> PrismaAdapter: Initialize Prisma Adapter
auth.ts ->> auth.ts: Define request validation and user data exposure functions
db.ts ->> PrismaClient: Import Prisma Client
db.ts ->> db.ts: Define enhanced Prisma client function
Loading

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?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 4

Outside diff range and nitpick comments (1)
docs/guides/authentication/lucia.md (1)

15-15: Consider rephrasing to avoid repetition.

The phrase "needs to" is used repetitively. Consider rephrasing to add variety.

- So, your ZModel definition needs to include these two models.+ Therefore, your ZModel definition should include these two models.
Tools
LanguageTool

[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...js). ## Data Model Requirement Lucia needs to store your users and sessions in the da...

(REP_NEED_TO_VB)


[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...he database. So, your ZModel definition needs to include these two models. Here is the s...

(REP_NEED_TO_VB)

Comment threaddocs/guides/authentication/lucia.md Outdated
Comment threaddocs/guides/authentication/lucia.md
Comment threaddocs/guides/authentication/lucia.md
Comment threaddocs/guides/authentication/lucia.md
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Comment threaddocs/guides/authentication/lucia.md Outdated

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

Outside diff range, codebase verification and nitpick comments (5)
docs/guides/authentication/lucia.md (5)

54-84: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-export const validateRequest = cache(- async (): Promise<{ user: User; session: Session } | { user: null; session: null }> => {- const sessionId = cookies().get(lucia.sessionCookieName)?.value ?? null;- if (!sessionId) {- return {- user: null,- session: null- };- }-- const result = await lucia.validateSession(sessionId);- // next.js throws when you attempt to set cookie when rendering page- try {- if (result.session && result.session.fresh) {- const sessionCookie = lucia.createSessionCookie(result.session.id);- cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);- }- if (!result.session) {- const sessionCookie = lucia.createBlankSessionCookie();- cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);- }- } catch {}- return result;- }-);+export const validateRequest = cache(+ async (): Promise<{ user: User; session: Session } | { user: null; session: null }> => {+ const sessionId = cookies().get(lucia.sessionCookieName)?.value ?? null;+ if (!sessionId) {+ return {+ user: null,+ session: null+ };+ }++ const result = await lucia.validateSession(sessionId);+ // next.js throws when you attempt to set cookie when rendering page+ try {+ if (result.session && result.session.fresh) {+ const sessionCookie = lucia.createSessionCookie(result.session.id);+ cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);+ }+ if (!result.session) {+ const sessionCookie = lucia.createBlankSessionCookie();+ cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);+ }+ } catch {}+ return result;+ }+);

86-94: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-	const { user } = await validateRequest();--	if (!user) {- return redirect("/login");-	}+ const { user } = await validateRequest();++ if (!user) {+ return redirect("/login");+ }
Tools
Markdownlint

89-89: Column: 1
Hard tabs

(MD010, no-hard-tabs)


91-91: Column: 1
Hard tabs

(MD010, no-hard-tabs)


92-92: Column: 1
Hard tabs

(MD010, no-hard-tabs)


93-93: Column: 1
Hard tabs

(MD010, no-hard-tabs)


117-140: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-declare module "lucia" {-	interface Register {- Lucia: typeof lucia;- DatabaseUserAttributes: DatabaseUserAttributes-	}-}--interface DatabaseUserAttributes {- userName: string;-}--export const lucia = new Lucia(adapter, {-	getUserAttributes: (attributes) => {- return {- userName: attributes.userName- };-	}+declare module "lucia" {+ interface Register {+ Lucia: typeof lucia;+ DatabaseUserAttributes: DatabaseUserAttributes+ }+}++interface DatabaseUserAttributes {+ userName: string;+}++export const lucia = new Lucia(adapter, {+ getUserAttributes: (attributes) => {+ return {+ userName: attributes.userName+ };+ }
});

142-153: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-export default async function Page() {-	const { user } = await validateRequest();	-	return (- <>- <h1>Hi, {user.userName}!</h1>- <p>Your user ID is {user.id}.</p>- </>-	);+export default async function Page() {+ const { user } = await validateRequest();	+ return (+ <>+ <h1>Hi, {user.userName}!</h1>+ <p>Your user ID is {user.id}.</p>+ </>+ );
}
Tools
Markdownlint

146-146: Column: 44
Hard tabs

(MD010, no-hard-tabs)


15-15: Vary the phrasing for better readability.

The phrasing "needs to" is repeated in nearby sentences. Consider rephrasing to add variety.

- Lucia needs to store your users and sessions in the database. So, your ZModel definition needs to include these two models.+ Lucia requires storing your users and sessions in the database. Thus, your ZModel definition should include these two models.
Tools
LanguageTool

[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...js). ## Data model requirement Lucia needs to store your users and sessions in the da...

(REP_NEED_TO_VB)


[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...he database. So, your ZModel definition needs to include these two models. Here is the s...

(REP_NEED_TO_VB)

Comment threaddocs/guides/authentication/lucia.md Outdated
Comment threaddocs/guides/authentication/lucia.md
jiashengguoand others added 2 commits July 12, 2024 15:28
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 4

Outside diff range, codebase verification and nitpick comments (1)
docs/guides/authentication/lucia.md (1)

15-15: Consider rephrasing to avoid repetition.

The sentence "Lucia needs to store your users and sessions in the database" is repetitive. Consider rephrasing for variety.

- Lucia needs to store your users and sessions in the database. So, your ZModel definition needs to include these two models.+ To store users and sessions in the database, your ZModel definition must include these two models.
Tools
LanguageTool

[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...js). ## Data model requirement Lucia needs to store your users and sessions in the da...

(REP_NEED_TO_VB)


[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...he database. So, your ZModel definition needs to include these two models. Here is the s...

(REP_NEED_TO_VB)

Comment threaddocs/guides/authentication/lucia.md
Comment threaddocs/guides/authentication/lucia.md Outdated
Comment threaddocs/guides/authentication/lucia.md
Comment threaddocs/guides/authentication/lucia.md

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (5)
docs/guides/authentication/lucia.md (5)

58-82: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-export const validateRequest = cache(- async (): Promise<{ user: User; session: Session } | { user: null; session: null }> => {- const sessionId = cookies().get(lucia.sessionCookieName)?.value ?? null;- if (!sessionId) {- return {- user: null,- session: null- };- }-- const result = await lucia.validateSession(sessionId);- // next.js throws when you attempt to set cookie when rendering page- try {- if (result.session && result.session.fresh) {- const sessionCookie = lucia.createSessionCookie(result.session.id);- cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);- }- if (!result.session) {- const sessionCookie = lucia.createBlankSessionCookie();- cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);- }- } catch {}- return result;- }-);+export const validateRequest = cache(+ async (): Promise<{ user: User; session: Session } | { user: null; session: null }> => {+ const sessionId = cookies().get(lucia.sessionCookieName)?.value ?? null;+ if (!sessionId) {+ return {+ user: null,+ session: null+ };+ }+ const result = await lucia.validateSession(sessionId);+ // next.js throws when you attempt to set cookie when rendering page+ try {+ if (result.session && result.session.fresh) {+ const sessionCookie = lucia.createSessionCookie(result.session.id);+ cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);+ }+ if (!result.session) {+ const sessionCookie = lucia.createBlankSessionCookie();+ cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);+ }+ } catch {}+ return result;+ }+);

101-113: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-export async function getEnhancedPrisma(): Promise<PrismaClient> {- const { user } = await validateRequest();- // create a wrapper of Prisma client that enforces access policy,- // data validation, and @password, @omit behaviors- return enhance(prisma, { user: {id: user?.id!}});+export async function getEnhancedPrisma(): Promise<PrismaClient> {+ const { user } = await validateRequest();+ // create a wrapper of Prisma client that enforces access policy,+ // data validation, and @password, @omit behaviors+ return enhance(prisma, { user: {id: user?.id!}});
}

121-138: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-declare module "lucia" {- interface Register {- Lucia: typeof lucia;- DatabaseUserAttributes: DatabaseUserAttributes- }-}--interface DatabaseUserAttributes {- userName: string;-}--export const lucia = new Lucia(adapter, {- getUserAttributes: (attributes) => {- return {- userName: attributes.userName- };- }+declare module "lucia" {+ interface Register {+ Lucia: typeof lucia;+ DatabaseUserAttributes: DatabaseUserAttributes+ }+}++interface DatabaseUserAttributes {+ userName: string;+}++export const lucia = new Lucia(adapter, {+ getUserAttributes: (attributes) => {+ return {+ userName: attributes.userName+ };+ }
});

7-7: Ensure consistent casing for all titles.

The title "Integrating With Lucia" should use consistent casing.

-# Integrating With Lucia+# Integrating with Lucia

144-151: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-export default async function Page() {- const { user } = await validateRequest();	- return (- <>- <h1>Hi, {user.userName}!</h1>- <p>Your user ID is {user.id}.</p>- </>- );+export default async function Page() {+ const { user } = await validateRequest();	+ return (+ <>+ <h1>Hi, {user.userName}!</h1>+ <p>Your user ID is {user.id}.</p>+ </>+ );
}
Tools
Markdownlint

145-145: Column: 44
Hard tabs

(MD010, no-hard-tabs)

@ymc9
ymc9 merged commit 88c6a57 into mainJul 12, 2024
@ymc9
ymc9 deleted the jiasheng branch July 12, 2024 17:26
@coderabbitaicoderabbitaiBot mentioned this pull request Nov 4, 2024
@coderabbitaicoderabbitaiBot mentioned this pull request Nov 24, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@jiashengguo@ymc9
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

doc: add Lucia Auth doc - #323

Merged
ymc9 merged 9 commits into
mainfrom
jiasheng
Jul 12, 2024
Merged

doc: add Lucia Auth doc#323
ymc9 merged 9 commits into
mainfrom
jiasheng

Conversation

@jiashengguo

@jiashengguojiashengguo commented Jul 9, 2024

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Documentation
    • Updated authentication guide with detailed instructions for integrating ZenStack with Lucia Auth.

@vercel

vercelBot commented Jul 9, 2024

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for Git ↗︎

NameStatusPreviewCommentsUpdated (UTC)
zenstack-new-site✅ Ready (Inspect)Visit Preview💬 Add feedbackJul 12, 2024 5:27pm

@coderabbitai

coderabbitaiBot commented Jul 9, 2024

Copy link
Copy Markdown
Contributor

Warning

Rate limit exceeded

@ymc9 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 25 minutes and 3 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 66ef8cf and 454753c.

Walkthrough

The updates to lucia.md transform placeholder text into comprehensive guidance on integrating ZenStack with Lucia Auth. This includes detailed instructions on data model requirements, implementing a Prisma adapter, request validation, creating an enhanced Prisma client, and exposing more user data. These enhancements significantly improve the guide's clarity and practicality for developers.

Changes

FilesChange Summary
docs/guides/authentication/lucia.mdTransitioned from placeholder text to detailed integration instructions for ZenStack with Lucia Auth.
.../lib/auth.tsAdded data models, Prisma adapter initialization, request validation, and user data exposure functions and interfaces.
.../lib/db.tsIntroduced an enhanced Prisma client creation.

Sequence Diagram(s)

sequenceDiagram
actor Developer
participant docs/guides/authentication/lucia.md as Lucia Guide
participant lib/auth.ts as auth.ts
participant lib/db.ts as db.ts
participant PrismaClient
participant PrismaAdapter
Developer ->> Lucia Guide: Read integration instructions
Lucia Guide ->> auth.ts: Update for Prisma Adapter and user data exposure
Lucia Guide ->> db.ts: Enhance Prisma client creation
auth.ts ->> PrismaClient: Import Prisma Client
auth.ts ->> PrismaAdapter: Initialize Prisma Adapter
auth.ts ->> auth.ts: Define request validation and user data exposure functions
db.ts ->> PrismaClient: Import Prisma Client
db.ts ->> db.ts: Define enhanced Prisma client function
Loading

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?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 4

Outside diff range and nitpick comments (1)
docs/guides/authentication/lucia.md (1)

15-15: Consider rephrasing to avoid repetition.

The phrase "needs to" is used repetitively. Consider rephrasing to add variety.

- So, your ZModel definition needs to include these two models.+ Therefore, your ZModel definition should include these two models.
Tools
LanguageTool

[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...js). ## Data Model Requirement Lucia needs to store your users and sessions in the da...

(REP_NEED_TO_VB)


[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...he database. So, your ZModel definition needs to include these two models. Here is the s...

(REP_NEED_TO_VB)

Comment threaddocs/guides/authentication/lucia.md Outdated
Comment threaddocs/guides/authentication/lucia.md
Comment threaddocs/guides/authentication/lucia.md
Comment threaddocs/guides/authentication/lucia.md
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Comment threaddocs/guides/authentication/lucia.md Outdated

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

Outside diff range, codebase verification and nitpick comments (5)
docs/guides/authentication/lucia.md (5)

54-84: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-export const validateRequest = cache(- async (): Promise<{ user: User; session: Session } | { user: null; session: null }> => {- const sessionId = cookies().get(lucia.sessionCookieName)?.value ?? null;- if (!sessionId) {- return {- user: null,- session: null- };- }-- const result = await lucia.validateSession(sessionId);- // next.js throws when you attempt to set cookie when rendering page- try {- if (result.session && result.session.fresh) {- const sessionCookie = lucia.createSessionCookie(result.session.id);- cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);- }- if (!result.session) {- const sessionCookie = lucia.createBlankSessionCookie();- cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);- }- } catch {}- return result;- }-);+export const validateRequest = cache(+ async (): Promise<{ user: User; session: Session } | { user: null; session: null }> => {+ const sessionId = cookies().get(lucia.sessionCookieName)?.value ?? null;+ if (!sessionId) {+ return {+ user: null,+ session: null+ };+ }++ const result = await lucia.validateSession(sessionId);+ // next.js throws when you attempt to set cookie when rendering page+ try {+ if (result.session && result.session.fresh) {+ const sessionCookie = lucia.createSessionCookie(result.session.id);+ cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);+ }+ if (!result.session) {+ const sessionCookie = lucia.createBlankSessionCookie();+ cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);+ }+ } catch {}+ return result;+ }+);

86-94: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-	const { user } = await validateRequest();--	if (!user) {- return redirect("/login");-	}+ const { user } = await validateRequest();++ if (!user) {+ return redirect("/login");+ }
Tools
Markdownlint

89-89: Column: 1
Hard tabs

(MD010, no-hard-tabs)


91-91: Column: 1
Hard tabs

(MD010, no-hard-tabs)


92-92: Column: 1
Hard tabs

(MD010, no-hard-tabs)


93-93: Column: 1
Hard tabs

(MD010, no-hard-tabs)


117-140: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-declare module "lucia" {-	interface Register {- Lucia: typeof lucia;- DatabaseUserAttributes: DatabaseUserAttributes-	}-}--interface DatabaseUserAttributes {- userName: string;-}--export const lucia = new Lucia(adapter, {-	getUserAttributes: (attributes) => {- return {- userName: attributes.userName- };-	}+declare module "lucia" {+ interface Register {+ Lucia: typeof lucia;+ DatabaseUserAttributes: DatabaseUserAttributes+ }+}++interface DatabaseUserAttributes {+ userName: string;+}++export const lucia = new Lucia(adapter, {+ getUserAttributes: (attributes) => {+ return {+ userName: attributes.userName+ };+ }
});

142-153: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-export default async function Page() {-	const { user } = await validateRequest();	-	return (- <>- <h1>Hi, {user.userName}!</h1>- <p>Your user ID is {user.id}.</p>- </>-	);+export default async function Page() {+ const { user } = await validateRequest();	+ return (+ <>+ <h1>Hi, {user.userName}!</h1>+ <p>Your user ID is {user.id}.</p>+ </>+ );
}
Tools
Markdownlint

146-146: Column: 44
Hard tabs

(MD010, no-hard-tabs)


15-15: Vary the phrasing for better readability.

The phrasing "needs to" is repeated in nearby sentences. Consider rephrasing to add variety.

- Lucia needs to store your users and sessions in the database. So, your ZModel definition needs to include these two models.+ Lucia requires storing your users and sessions in the database. Thus, your ZModel definition should include these two models.
Tools
LanguageTool

[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...js). ## Data model requirement Lucia needs to store your users and sessions in the da...

(REP_NEED_TO_VB)


[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...he database. So, your ZModel definition needs to include these two models. Here is the s...

(REP_NEED_TO_VB)

Comment threaddocs/guides/authentication/lucia.md Outdated
Comment threaddocs/guides/authentication/lucia.md
jiashengguoand others added 2 commits July 12, 2024 15:28
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 4

Outside diff range, codebase verification and nitpick comments (1)
docs/guides/authentication/lucia.md (1)

15-15: Consider rephrasing to avoid repetition.

The sentence "Lucia needs to store your users and sessions in the database" is repetitive. Consider rephrasing for variety.

- Lucia needs to store your users and sessions in the database. So, your ZModel definition needs to include these two models.+ To store users and sessions in the database, your ZModel definition must include these two models.
Tools
LanguageTool

[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...js). ## Data model requirement Lucia needs to store your users and sessions in the da...

(REP_NEED_TO_VB)


[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...he database. So, your ZModel definition needs to include these two models. Here is the s...

(REP_NEED_TO_VB)

Comment threaddocs/guides/authentication/lucia.md
Comment threaddocs/guides/authentication/lucia.md Outdated
Comment threaddocs/guides/authentication/lucia.md
Comment threaddocs/guides/authentication/lucia.md

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (5)
docs/guides/authentication/lucia.md (5)

58-82: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-export const validateRequest = cache(- async (): Promise<{ user: User; session: Session } | { user: null; session: null }> => {- const sessionId = cookies().get(lucia.sessionCookieName)?.value ?? null;- if (!sessionId) {- return {- user: null,- session: null- };- }-- const result = await lucia.validateSession(sessionId);- // next.js throws when you attempt to set cookie when rendering page- try {- if (result.session && result.session.fresh) {- const sessionCookie = lucia.createSessionCookie(result.session.id);- cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);- }- if (!result.session) {- const sessionCookie = lucia.createBlankSessionCookie();- cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);- }- } catch {}- return result;- }-);+export const validateRequest = cache(+ async (): Promise<{ user: User; session: Session } | { user: null; session: null }> => {+ const sessionId = cookies().get(lucia.sessionCookieName)?.value ?? null;+ if (!sessionId) {+ return {+ user: null,+ session: null+ };+ }+ const result = await lucia.validateSession(sessionId);+ // next.js throws when you attempt to set cookie when rendering page+ try {+ if (result.session && result.session.fresh) {+ const sessionCookie = lucia.createSessionCookie(result.session.id);+ cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);+ }+ if (!result.session) {+ const sessionCookie = lucia.createBlankSessionCookie();+ cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);+ }+ } catch {}+ return result;+ }+);

101-113: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-export async function getEnhancedPrisma(): Promise<PrismaClient> {- const { user } = await validateRequest();- // create a wrapper of Prisma client that enforces access policy,- // data validation, and @password, @omit behaviors- return enhance(prisma, { user: {id: user?.id!}});+export async function getEnhancedPrisma(): Promise<PrismaClient> {+ const { user } = await validateRequest();+ // create a wrapper of Prisma client that enforces access policy,+ // data validation, and @password, @omit behaviors+ return enhance(prisma, { user: {id: user?.id!}});
}

121-138: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-declare module "lucia" {- interface Register {- Lucia: typeof lucia;- DatabaseUserAttributes: DatabaseUserAttributes- }-}--interface DatabaseUserAttributes {- userName: string;-}--export const lucia = new Lucia(adapter, {- getUserAttributes: (attributes) => {- return {- userName: attributes.userName- };- }+declare module "lucia" {+ interface Register {+ Lucia: typeof lucia;+ DatabaseUserAttributes: DatabaseUserAttributes+ }+}++interface DatabaseUserAttributes {+ userName: string;+}++export const lucia = new Lucia(adapter, {+ getUserAttributes: (attributes) => {+ return {+ userName: attributes.userName+ };+ }
});

7-7: Ensure consistent casing for all titles.

The title "Integrating With Lucia" should use consistent casing.

-# Integrating With Lucia+# Integrating with Lucia

144-151: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-export default async function Page() {- const { user } = await validateRequest();	- return (- <>- <h1>Hi, {user.userName}!</h1>- <p>Your user ID is {user.id}.</p>- </>- );+export default async function Page() {+ const { user } = await validateRequest();	+ return (+ <>+ <h1>Hi, {user.userName}!</h1>+ <p>Your user ID is {user.id}.</p>+ </>+ );
}
Tools
Markdownlint

145-145: Column: 44
Hard tabs

(MD010, no-hard-tabs)

@ymc9
ymc9 merged commit 88c6a57 into mainJul 12, 2024
@ymc9
ymc9 deleted the jiasheng branch July 12, 2024 17:26
@coderabbitaicoderabbitaiBot mentioned this pull request Nov 4, 2024
@coderabbitaicoderabbitaiBot mentioned this pull request Nov 24, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@jiashengguo@ymc9
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

doc: add Lucia Auth doc - #323

Merged
ymc9 merged 9 commits into
mainfrom
jiasheng
Jul 12, 2024
Merged

doc: add Lucia Auth doc#323
ymc9 merged 9 commits into
mainfrom
jiasheng

Conversation

@jiashengguo

@jiashengguojiashengguo commented Jul 9, 2024

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Documentation
    • Updated authentication guide with detailed instructions for integrating ZenStack with Lucia Auth.

@vercel

vercelBot commented Jul 9, 2024

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for Git ↗︎

NameStatusPreviewCommentsUpdated (UTC)
zenstack-new-site✅ Ready (Inspect)Visit Preview💬 Add feedbackJul 12, 2024 5:27pm

@coderabbitai

coderabbitaiBot commented Jul 9, 2024

Copy link
Copy Markdown
Contributor

Warning

Rate limit exceeded

@ymc9 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 25 minutes and 3 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 66ef8cf and 454753c.

Walkthrough

The updates to lucia.md transform placeholder text into comprehensive guidance on integrating ZenStack with Lucia Auth. This includes detailed instructions on data model requirements, implementing a Prisma adapter, request validation, creating an enhanced Prisma client, and exposing more user data. These enhancements significantly improve the guide's clarity and practicality for developers.

Changes

FilesChange Summary
docs/guides/authentication/lucia.mdTransitioned from placeholder text to detailed integration instructions for ZenStack with Lucia Auth.
.../lib/auth.tsAdded data models, Prisma adapter initialization, request validation, and user data exposure functions and interfaces.
.../lib/db.tsIntroduced an enhanced Prisma client creation.

Sequence Diagram(s)

sequenceDiagram
actor Developer
participant docs/guides/authentication/lucia.md as Lucia Guide
participant lib/auth.ts as auth.ts
participant lib/db.ts as db.ts
participant PrismaClient
participant PrismaAdapter
Developer ->> Lucia Guide: Read integration instructions
Lucia Guide ->> auth.ts: Update for Prisma Adapter and user data exposure
Lucia Guide ->> db.ts: Enhance Prisma client creation
auth.ts ->> PrismaClient: Import Prisma Client
auth.ts ->> PrismaAdapter: Initialize Prisma Adapter
auth.ts ->> auth.ts: Define request validation and user data exposure functions
db.ts ->> PrismaClient: Import Prisma Client
db.ts ->> db.ts: Define enhanced Prisma client function
Loading

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?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 4

Outside diff range and nitpick comments (1)
docs/guides/authentication/lucia.md (1)

15-15: Consider rephrasing to avoid repetition.

The phrase "needs to" is used repetitively. Consider rephrasing to add variety.

- So, your ZModel definition needs to include these two models.+ Therefore, your ZModel definition should include these two models.
Tools
LanguageTool

[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...js). ## Data Model Requirement Lucia needs to store your users and sessions in the da...

(REP_NEED_TO_VB)


[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...he database. So, your ZModel definition needs to include these two models. Here is the s...

(REP_NEED_TO_VB)

Comment threaddocs/guides/authentication/lucia.md Outdated
Comment threaddocs/guides/authentication/lucia.md
Comment threaddocs/guides/authentication/lucia.md
Comment threaddocs/guides/authentication/lucia.md
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Comment threaddocs/guides/authentication/lucia.md Outdated

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

Outside diff range, codebase verification and nitpick comments (5)
docs/guides/authentication/lucia.md (5)

54-84: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-export const validateRequest = cache(- async (): Promise<{ user: User; session: Session } | { user: null; session: null }> => {- const sessionId = cookies().get(lucia.sessionCookieName)?.value ?? null;- if (!sessionId) {- return {- user: null,- session: null- };- }-- const result = await lucia.validateSession(sessionId);- // next.js throws when you attempt to set cookie when rendering page- try {- if (result.session && result.session.fresh) {- const sessionCookie = lucia.createSessionCookie(result.session.id);- cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);- }- if (!result.session) {- const sessionCookie = lucia.createBlankSessionCookie();- cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);- }- } catch {}- return result;- }-);+export const validateRequest = cache(+ async (): Promise<{ user: User; session: Session } | { user: null; session: null }> => {+ const sessionId = cookies().get(lucia.sessionCookieName)?.value ?? null;+ if (!sessionId) {+ return {+ user: null,+ session: null+ };+ }++ const result = await lucia.validateSession(sessionId);+ // next.js throws when you attempt to set cookie when rendering page+ try {+ if (result.session && result.session.fresh) {+ const sessionCookie = lucia.createSessionCookie(result.session.id);+ cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);+ }+ if (!result.session) {+ const sessionCookie = lucia.createBlankSessionCookie();+ cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);+ }+ } catch {}+ return result;+ }+);

86-94: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-	const { user } = await validateRequest();--	if (!user) {- return redirect("/login");-	}+ const { user } = await validateRequest();++ if (!user) {+ return redirect("/login");+ }
Tools
Markdownlint

89-89: Column: 1
Hard tabs

(MD010, no-hard-tabs)


91-91: Column: 1
Hard tabs

(MD010, no-hard-tabs)


92-92: Column: 1
Hard tabs

(MD010, no-hard-tabs)


93-93: Column: 1
Hard tabs

(MD010, no-hard-tabs)


117-140: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-declare module "lucia" {-	interface Register {- Lucia: typeof lucia;- DatabaseUserAttributes: DatabaseUserAttributes-	}-}--interface DatabaseUserAttributes {- userName: string;-}--export const lucia = new Lucia(adapter, {-	getUserAttributes: (attributes) => {- return {- userName: attributes.userName- };-	}+declare module "lucia" {+ interface Register {+ Lucia: typeof lucia;+ DatabaseUserAttributes: DatabaseUserAttributes+ }+}++interface DatabaseUserAttributes {+ userName: string;+}++export const lucia = new Lucia(adapter, {+ getUserAttributes: (attributes) => {+ return {+ userName: attributes.userName+ };+ }
});

142-153: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-export default async function Page() {-	const { user } = await validateRequest();	-	return (- <>- <h1>Hi, {user.userName}!</h1>- <p>Your user ID is {user.id}.</p>- </>-	);+export default async function Page() {+ const { user } = await validateRequest();	+ return (+ <>+ <h1>Hi, {user.userName}!</h1>+ <p>Your user ID is {user.id}.</p>+ </>+ );
}
Tools
Markdownlint

146-146: Column: 44
Hard tabs

(MD010, no-hard-tabs)


15-15: Vary the phrasing for better readability.

The phrasing "needs to" is repeated in nearby sentences. Consider rephrasing to add variety.

- Lucia needs to store your users and sessions in the database. So, your ZModel definition needs to include these two models.+ Lucia requires storing your users and sessions in the database. Thus, your ZModel definition should include these two models.
Tools
LanguageTool

[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...js). ## Data model requirement Lucia needs to store your users and sessions in the da...

(REP_NEED_TO_VB)


[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...he database. So, your ZModel definition needs to include these two models. Here is the s...

(REP_NEED_TO_VB)

Comment threaddocs/guides/authentication/lucia.md Outdated
Comment threaddocs/guides/authentication/lucia.md
jiashengguoand others added 2 commits July 12, 2024 15:28
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 4

Outside diff range, codebase verification and nitpick comments (1)
docs/guides/authentication/lucia.md (1)

15-15: Consider rephrasing to avoid repetition.

The sentence "Lucia needs to store your users and sessions in the database" is repetitive. Consider rephrasing for variety.

- Lucia needs to store your users and sessions in the database. So, your ZModel definition needs to include these two models.+ To store users and sessions in the database, your ZModel definition must include these two models.
Tools
LanguageTool

[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...js). ## Data model requirement Lucia needs to store your users and sessions in the da...

(REP_NEED_TO_VB)


[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...he database. So, your ZModel definition needs to include these two models. Here is the s...

(REP_NEED_TO_VB)

Comment threaddocs/guides/authentication/lucia.md
Comment threaddocs/guides/authentication/lucia.md Outdated
Comment threaddocs/guides/authentication/lucia.md
Comment threaddocs/guides/authentication/lucia.md

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (5)
docs/guides/authentication/lucia.md (5)

58-82: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-export const validateRequest = cache(- async (): Promise<{ user: User; session: Session } | { user: null; session: null }> => {- const sessionId = cookies().get(lucia.sessionCookieName)?.value ?? null;- if (!sessionId) {- return {- user: null,- session: null- };- }-- const result = await lucia.validateSession(sessionId);- // next.js throws when you attempt to set cookie when rendering page- try {- if (result.session && result.session.fresh) {- const sessionCookie = lucia.createSessionCookie(result.session.id);- cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);- }- if (!result.session) {- const sessionCookie = lucia.createBlankSessionCookie();- cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);- }- } catch {}- return result;- }-);+export const validateRequest = cache(+ async (): Promise<{ user: User; session: Session } | { user: null; session: null }> => {+ const sessionId = cookies().get(lucia.sessionCookieName)?.value ?? null;+ if (!sessionId) {+ return {+ user: null,+ session: null+ };+ }+ const result = await lucia.validateSession(sessionId);+ // next.js throws when you attempt to set cookie when rendering page+ try {+ if (result.session && result.session.fresh) {+ const sessionCookie = lucia.createSessionCookie(result.session.id);+ cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);+ }+ if (!result.session) {+ const sessionCookie = lucia.createBlankSessionCookie();+ cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);+ }+ } catch {}+ return result;+ }+);

101-113: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-export async function getEnhancedPrisma(): Promise<PrismaClient> {- const { user } = await validateRequest();- // create a wrapper of Prisma client that enforces access policy,- // data validation, and @password, @omit behaviors- return enhance(prisma, { user: {id: user?.id!}});+export async function getEnhancedPrisma(): Promise<PrismaClient> {+ const { user } = await validateRequest();+ // create a wrapper of Prisma client that enforces access policy,+ // data validation, and @password, @omit behaviors+ return enhance(prisma, { user: {id: user?.id!}});
}

121-138: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-declare module "lucia" {- interface Register {- Lucia: typeof lucia;- DatabaseUserAttributes: DatabaseUserAttributes- }-}--interface DatabaseUserAttributes {- userName: string;-}--export const lucia = new Lucia(adapter, {- getUserAttributes: (attributes) => {- return {- userName: attributes.userName- };- }+declare module "lucia" {+ interface Register {+ Lucia: typeof lucia;+ DatabaseUserAttributes: DatabaseUserAttributes+ }+}++interface DatabaseUserAttributes {+ userName: string;+}++export const lucia = new Lucia(adapter, {+ getUserAttributes: (attributes) => {+ return {+ userName: attributes.userName+ };+ }
});

7-7: Ensure consistent casing for all titles.

The title "Integrating With Lucia" should use consistent casing.

-# Integrating With Lucia+# Integrating with Lucia

144-151: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-export default async function Page() {- const { user } = await validateRequest();	- return (- <>- <h1>Hi, {user.userName}!</h1>- <p>Your user ID is {user.id}.</p>- </>- );+export default async function Page() {+ const { user } = await validateRequest();	+ return (+ <>+ <h1>Hi, {user.userName}!</h1>+ <p>Your user ID is {user.id}.</p>+ </>+ );
}
Tools
Markdownlint

145-145: Column: 44
Hard tabs

(MD010, no-hard-tabs)

@ymc9
ymc9 merged commit 88c6a57 into mainJul 12, 2024
@ymc9
ymc9 deleted the jiasheng branch July 12, 2024 17:26
@coderabbitaicoderabbitaiBot mentioned this pull request Nov 4, 2024
@coderabbitaicoderabbitaiBot mentioned this pull request Nov 24, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@jiashengguo@ymc9
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

doc: add Lucia Auth doc - #323

Merged
ymc9 merged 9 commits into
mainfrom
jiasheng
Jul 12, 2024
Merged

doc: add Lucia Auth doc#323
ymc9 merged 9 commits into
mainfrom
jiasheng

Conversation

@jiashengguo

@jiashengguojiashengguo commented Jul 9, 2024

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Documentation
    • Updated authentication guide with detailed instructions for integrating ZenStack with Lucia Auth.

@vercel

vercelBot commented Jul 9, 2024

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for Git ↗︎

NameStatusPreviewCommentsUpdated (UTC)
zenstack-new-site✅ Ready (Inspect)Visit Preview💬 Add feedbackJul 12, 2024 5:27pm

@coderabbitai

coderabbitaiBot commented Jul 9, 2024

Copy link
Copy Markdown
Contributor

Warning

Rate limit exceeded

@ymc9 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 25 minutes and 3 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 66ef8cf and 454753c.

Walkthrough

The updates to lucia.md transform placeholder text into comprehensive guidance on integrating ZenStack with Lucia Auth. This includes detailed instructions on data model requirements, implementing a Prisma adapter, request validation, creating an enhanced Prisma client, and exposing more user data. These enhancements significantly improve the guide's clarity and practicality for developers.

Changes

FilesChange Summary
docs/guides/authentication/lucia.mdTransitioned from placeholder text to detailed integration instructions for ZenStack with Lucia Auth.
.../lib/auth.tsAdded data models, Prisma adapter initialization, request validation, and user data exposure functions and interfaces.
.../lib/db.tsIntroduced an enhanced Prisma client creation.

Sequence Diagram(s)

sequenceDiagram
actor Developer
participant docs/guides/authentication/lucia.md as Lucia Guide
participant lib/auth.ts as auth.ts
participant lib/db.ts as db.ts
participant PrismaClient
participant PrismaAdapter
Developer ->> Lucia Guide: Read integration instructions
Lucia Guide ->> auth.ts: Update for Prisma Adapter and user data exposure
Lucia Guide ->> db.ts: Enhance Prisma client creation
auth.ts ->> PrismaClient: Import Prisma Client
auth.ts ->> PrismaAdapter: Initialize Prisma Adapter
auth.ts ->> auth.ts: Define request validation and user data exposure functions
db.ts ->> PrismaClient: Import Prisma Client
db.ts ->> db.ts: Define enhanced Prisma client function
Loading

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?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 4

Outside diff range and nitpick comments (1)
docs/guides/authentication/lucia.md (1)

15-15: Consider rephrasing to avoid repetition.

The phrase "needs to" is used repetitively. Consider rephrasing to add variety.

- So, your ZModel definition needs to include these two models.+ Therefore, your ZModel definition should include these two models.
Tools
LanguageTool

[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...js). ## Data Model Requirement Lucia needs to store your users and sessions in the da...

(REP_NEED_TO_VB)


[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...he database. So, your ZModel definition needs to include these two models. Here is the s...

(REP_NEED_TO_VB)

Comment threaddocs/guides/authentication/lucia.md Outdated
Comment threaddocs/guides/authentication/lucia.md
Comment threaddocs/guides/authentication/lucia.md
Comment threaddocs/guides/authentication/lucia.md
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Comment threaddocs/guides/authentication/lucia.md Outdated

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

Outside diff range, codebase verification and nitpick comments (5)
docs/guides/authentication/lucia.md (5)

54-84: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-export const validateRequest = cache(- async (): Promise<{ user: User; session: Session } | { user: null; session: null }> => {- const sessionId = cookies().get(lucia.sessionCookieName)?.value ?? null;- if (!sessionId) {- return {- user: null,- session: null- };- }-- const result = await lucia.validateSession(sessionId);- // next.js throws when you attempt to set cookie when rendering page- try {- if (result.session && result.session.fresh) {- const sessionCookie = lucia.createSessionCookie(result.session.id);- cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);- }- if (!result.session) {- const sessionCookie = lucia.createBlankSessionCookie();- cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);- }- } catch {}- return result;- }-);+export const validateRequest = cache(+ async (): Promise<{ user: User; session: Session } | { user: null; session: null }> => {+ const sessionId = cookies().get(lucia.sessionCookieName)?.value ?? null;+ if (!sessionId) {+ return {+ user: null,+ session: null+ };+ }++ const result = await lucia.validateSession(sessionId);+ // next.js throws when you attempt to set cookie when rendering page+ try {+ if (result.session && result.session.fresh) {+ const sessionCookie = lucia.createSessionCookie(result.session.id);+ cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);+ }+ if (!result.session) {+ const sessionCookie = lucia.createBlankSessionCookie();+ cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);+ }+ } catch {}+ return result;+ }+);

86-94: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-	const { user } = await validateRequest();--	if (!user) {- return redirect("/login");-	}+ const { user } = await validateRequest();++ if (!user) {+ return redirect("/login");+ }
Tools
Markdownlint

89-89: Column: 1
Hard tabs

(MD010, no-hard-tabs)


91-91: Column: 1
Hard tabs

(MD010, no-hard-tabs)


92-92: Column: 1
Hard tabs

(MD010, no-hard-tabs)


93-93: Column: 1
Hard tabs

(MD010, no-hard-tabs)


117-140: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-declare module "lucia" {-	interface Register {- Lucia: typeof lucia;- DatabaseUserAttributes: DatabaseUserAttributes-	}-}--interface DatabaseUserAttributes {- userName: string;-}--export const lucia = new Lucia(adapter, {-	getUserAttributes: (attributes) => {- return {- userName: attributes.userName- };-	}+declare module "lucia" {+ interface Register {+ Lucia: typeof lucia;+ DatabaseUserAttributes: DatabaseUserAttributes+ }+}++interface DatabaseUserAttributes {+ userName: string;+}++export const lucia = new Lucia(adapter, {+ getUserAttributes: (attributes) => {+ return {+ userName: attributes.userName+ };+ }
});

142-153: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-export default async function Page() {-	const { user } = await validateRequest();	-	return (- <>- <h1>Hi, {user.userName}!</h1>- <p>Your user ID is {user.id}.</p>- </>-	);+export default async function Page() {+ const { user } = await validateRequest();	+ return (+ <>+ <h1>Hi, {user.userName}!</h1>+ <p>Your user ID is {user.id}.</p>+ </>+ );
}
Tools
Markdownlint

146-146: Column: 44
Hard tabs

(MD010, no-hard-tabs)


15-15: Vary the phrasing for better readability.

The phrasing "needs to" is repeated in nearby sentences. Consider rephrasing to add variety.

- Lucia needs to store your users and sessions in the database. So, your ZModel definition needs to include these two models.+ Lucia requires storing your users and sessions in the database. Thus, your ZModel definition should include these two models.
Tools
LanguageTool

[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...js). ## Data model requirement Lucia needs to store your users and sessions in the da...

(REP_NEED_TO_VB)


[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...he database. So, your ZModel definition needs to include these two models. Here is the s...

(REP_NEED_TO_VB)

Comment threaddocs/guides/authentication/lucia.md Outdated
Comment threaddocs/guides/authentication/lucia.md
jiashengguoand others added 2 commits July 12, 2024 15:28
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 4

Outside diff range, codebase verification and nitpick comments (1)
docs/guides/authentication/lucia.md (1)

15-15: Consider rephrasing to avoid repetition.

The sentence "Lucia needs to store your users and sessions in the database" is repetitive. Consider rephrasing for variety.

- Lucia needs to store your users and sessions in the database. So, your ZModel definition needs to include these two models.+ To store users and sessions in the database, your ZModel definition must include these two models.
Tools
LanguageTool

[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...js). ## Data model requirement Lucia needs to store your users and sessions in the da...

(REP_NEED_TO_VB)


[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...he database. So, your ZModel definition needs to include these two models. Here is the s...

(REP_NEED_TO_VB)

Comment threaddocs/guides/authentication/lucia.md
Comment threaddocs/guides/authentication/lucia.md Outdated
Comment threaddocs/guides/authentication/lucia.md
Comment threaddocs/guides/authentication/lucia.md

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (5)
docs/guides/authentication/lucia.md (5)

58-82: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-export const validateRequest = cache(- async (): Promise<{ user: User; session: Session } | { user: null; session: null }> => {- const sessionId = cookies().get(lucia.sessionCookieName)?.value ?? null;- if (!sessionId) {- return {- user: null,- session: null- };- }-- const result = await lucia.validateSession(sessionId);- // next.js throws when you attempt to set cookie when rendering page- try {- if (result.session && result.session.fresh) {- const sessionCookie = lucia.createSessionCookie(result.session.id);- cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);- }- if (!result.session) {- const sessionCookie = lucia.createBlankSessionCookie();- cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);- }- } catch {}- return result;- }-);+export const validateRequest = cache(+ async (): Promise<{ user: User; session: Session } | { user: null; session: null }> => {+ const sessionId = cookies().get(lucia.sessionCookieName)?.value ?? null;+ if (!sessionId) {+ return {+ user: null,+ session: null+ };+ }+ const result = await lucia.validateSession(sessionId);+ // next.js throws when you attempt to set cookie when rendering page+ try {+ if (result.session && result.session.fresh) {+ const sessionCookie = lucia.createSessionCookie(result.session.id);+ cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);+ }+ if (!result.session) {+ const sessionCookie = lucia.createBlankSessionCookie();+ cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);+ }+ } catch {}+ return result;+ }+);

101-113: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-export async function getEnhancedPrisma(): Promise<PrismaClient> {- const { user } = await validateRequest();- // create a wrapper of Prisma client that enforces access policy,- // data validation, and @password, @omit behaviors- return enhance(prisma, { user: {id: user?.id!}});+export async function getEnhancedPrisma(): Promise<PrismaClient> {+ const { user } = await validateRequest();+ // create a wrapper of Prisma client that enforces access policy,+ // data validation, and @password, @omit behaviors+ return enhance(prisma, { user: {id: user?.id!}});
}

121-138: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-declare module "lucia" {- interface Register {- Lucia: typeof lucia;- DatabaseUserAttributes: DatabaseUserAttributes- }-}--interface DatabaseUserAttributes {- userName: string;-}--export const lucia = new Lucia(adapter, {- getUserAttributes: (attributes) => {- return {- userName: attributes.userName- };- }+declare module "lucia" {+ interface Register {+ Lucia: typeof lucia;+ DatabaseUserAttributes: DatabaseUserAttributes+ }+}++interface DatabaseUserAttributes {+ userName: string;+}++export const lucia = new Lucia(adapter, {+ getUserAttributes: (attributes) => {+ return {+ userName: attributes.userName+ };+ }
});

7-7: Ensure consistent casing for all titles.

The title "Integrating With Lucia" should use consistent casing.

-# Integrating With Lucia+# Integrating with Lucia

144-151: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-export default async function Page() {- const { user } = await validateRequest();	- return (- <>- <h1>Hi, {user.userName}!</h1>- <p>Your user ID is {user.id}.</p>- </>- );+export default async function Page() {+ const { user } = await validateRequest();	+ return (+ <>+ <h1>Hi, {user.userName}!</h1>+ <p>Your user ID is {user.id}.</p>+ </>+ );
}
Tools
Markdownlint

145-145: Column: 44
Hard tabs

(MD010, no-hard-tabs)

@ymc9
ymc9 merged commit 88c6a57 into mainJul 12, 2024
@ymc9
ymc9 deleted the jiasheng branch July 12, 2024 17:26
@coderabbitaicoderabbitaiBot mentioned this pull request Nov 4, 2024
@coderabbitaicoderabbitaiBot mentioned this pull request Nov 24, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@jiashengguo@ymc9
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

doc: add Lucia Auth doc - #323

Merged
ymc9 merged 9 commits into
mainfrom
jiasheng
Jul 12, 2024
Merged

doc: add Lucia Auth doc#323
ymc9 merged 9 commits into
mainfrom
jiasheng

Conversation

@jiashengguo

@jiashengguojiashengguo commented Jul 9, 2024

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Documentation
    • Updated authentication guide with detailed instructions for integrating ZenStack with Lucia Auth.

@vercel

vercelBot commented Jul 9, 2024

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for Git ↗︎

NameStatusPreviewCommentsUpdated (UTC)
zenstack-new-site✅ Ready (Inspect)Visit Preview💬 Add feedbackJul 12, 2024 5:27pm

@coderabbitai

coderabbitaiBot commented Jul 9, 2024

Copy link
Copy Markdown
Contributor

Warning

Rate limit exceeded

@ymc9 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 25 minutes and 3 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 66ef8cf and 454753c.

Walkthrough

The updates to lucia.md transform placeholder text into comprehensive guidance on integrating ZenStack with Lucia Auth. This includes detailed instructions on data model requirements, implementing a Prisma adapter, request validation, creating an enhanced Prisma client, and exposing more user data. These enhancements significantly improve the guide's clarity and practicality for developers.

Changes

FilesChange Summary
docs/guides/authentication/lucia.mdTransitioned from placeholder text to detailed integration instructions for ZenStack with Lucia Auth.
.../lib/auth.tsAdded data models, Prisma adapter initialization, request validation, and user data exposure functions and interfaces.
.../lib/db.tsIntroduced an enhanced Prisma client creation.

Sequence Diagram(s)

sequenceDiagram
actor Developer
participant docs/guides/authentication/lucia.md as Lucia Guide
participant lib/auth.ts as auth.ts
participant lib/db.ts as db.ts
participant PrismaClient
participant PrismaAdapter
Developer ->> Lucia Guide: Read integration instructions
Lucia Guide ->> auth.ts: Update for Prisma Adapter and user data exposure
Lucia Guide ->> db.ts: Enhance Prisma client creation
auth.ts ->> PrismaClient: Import Prisma Client
auth.ts ->> PrismaAdapter: Initialize Prisma Adapter
auth.ts ->> auth.ts: Define request validation and user data exposure functions
db.ts ->> PrismaClient: Import Prisma Client
db.ts ->> db.ts: Define enhanced Prisma client function
Loading

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?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 4

Outside diff range and nitpick comments (1)
docs/guides/authentication/lucia.md (1)

15-15: Consider rephrasing to avoid repetition.

The phrase "needs to" is used repetitively. Consider rephrasing to add variety.

- So, your ZModel definition needs to include these two models.+ Therefore, your ZModel definition should include these two models.
Tools
LanguageTool

[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...js). ## Data Model Requirement Lucia needs to store your users and sessions in the da...

(REP_NEED_TO_VB)


[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...he database. So, your ZModel definition needs to include these two models. Here is the s...

(REP_NEED_TO_VB)

Comment threaddocs/guides/authentication/lucia.md Outdated
Comment threaddocs/guides/authentication/lucia.md
Comment threaddocs/guides/authentication/lucia.md
Comment threaddocs/guides/authentication/lucia.md
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Comment threaddocs/guides/authentication/lucia.md Outdated

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

Outside diff range, codebase verification and nitpick comments (5)
docs/guides/authentication/lucia.md (5)

54-84: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-export const validateRequest = cache(- async (): Promise<{ user: User; session: Session } | { user: null; session: null }> => {- const sessionId = cookies().get(lucia.sessionCookieName)?.value ?? null;- if (!sessionId) {- return {- user: null,- session: null- };- }-- const result = await lucia.validateSession(sessionId);- // next.js throws when you attempt to set cookie when rendering page- try {- if (result.session && result.session.fresh) {- const sessionCookie = lucia.createSessionCookie(result.session.id);- cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);- }- if (!result.session) {- const sessionCookie = lucia.createBlankSessionCookie();- cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);- }- } catch {}- return result;- }-);+export const validateRequest = cache(+ async (): Promise<{ user: User; session: Session } | { user: null; session: null }> => {+ const sessionId = cookies().get(lucia.sessionCookieName)?.value ?? null;+ if (!sessionId) {+ return {+ user: null,+ session: null+ };+ }++ const result = await lucia.validateSession(sessionId);+ // next.js throws when you attempt to set cookie when rendering page+ try {+ if (result.session && result.session.fresh) {+ const sessionCookie = lucia.createSessionCookie(result.session.id);+ cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);+ }+ if (!result.session) {+ const sessionCookie = lucia.createBlankSessionCookie();+ cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);+ }+ } catch {}+ return result;+ }+);

86-94: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-	const { user } = await validateRequest();--	if (!user) {- return redirect("/login");-	}+ const { user } = await validateRequest();++ if (!user) {+ return redirect("/login");+ }
Tools
Markdownlint

89-89: Column: 1
Hard tabs

(MD010, no-hard-tabs)


91-91: Column: 1
Hard tabs

(MD010, no-hard-tabs)


92-92: Column: 1
Hard tabs

(MD010, no-hard-tabs)


93-93: Column: 1
Hard tabs

(MD010, no-hard-tabs)


117-140: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-declare module "lucia" {-	interface Register {- Lucia: typeof lucia;- DatabaseUserAttributes: DatabaseUserAttributes-	}-}--interface DatabaseUserAttributes {- userName: string;-}--export const lucia = new Lucia(adapter, {-	getUserAttributes: (attributes) => {- return {- userName: attributes.userName- };-	}+declare module "lucia" {+ interface Register {+ Lucia: typeof lucia;+ DatabaseUserAttributes: DatabaseUserAttributes+ }+}++interface DatabaseUserAttributes {+ userName: string;+}++export const lucia = new Lucia(adapter, {+ getUserAttributes: (attributes) => {+ return {+ userName: attributes.userName+ };+ }
});

142-153: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-export default async function Page() {-	const { user } = await validateRequest();	-	return (- <>- <h1>Hi, {user.userName}!</h1>- <p>Your user ID is {user.id}.</p>- </>-	);+export default async function Page() {+ const { user } = await validateRequest();	+ return (+ <>+ <h1>Hi, {user.userName}!</h1>+ <p>Your user ID is {user.id}.</p>+ </>+ );
}
Tools
Markdownlint

146-146: Column: 44
Hard tabs

(MD010, no-hard-tabs)


15-15: Vary the phrasing for better readability.

The phrasing "needs to" is repeated in nearby sentences. Consider rephrasing to add variety.

- Lucia needs to store your users and sessions in the database. So, your ZModel definition needs to include these two models.+ Lucia requires storing your users and sessions in the database. Thus, your ZModel definition should include these two models.
Tools
LanguageTool

[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...js). ## Data model requirement Lucia needs to store your users and sessions in the da...

(REP_NEED_TO_VB)


[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...he database. So, your ZModel definition needs to include these two models. Here is the s...

(REP_NEED_TO_VB)

Comment threaddocs/guides/authentication/lucia.md Outdated
Comment threaddocs/guides/authentication/lucia.md
jiashengguoand others added 2 commits July 12, 2024 15:28
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 4

Outside diff range, codebase verification and nitpick comments (1)
docs/guides/authentication/lucia.md (1)

15-15: Consider rephrasing to avoid repetition.

The sentence "Lucia needs to store your users and sessions in the database" is repetitive. Consider rephrasing for variety.

- Lucia needs to store your users and sessions in the database. So, your ZModel definition needs to include these two models.+ To store users and sessions in the database, your ZModel definition must include these two models.
Tools
LanguageTool

[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...js). ## Data model requirement Lucia needs to store your users and sessions in the da...

(REP_NEED_TO_VB)


[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...he database. So, your ZModel definition needs to include these two models. Here is the s...

(REP_NEED_TO_VB)

Comment threaddocs/guides/authentication/lucia.md
Comment threaddocs/guides/authentication/lucia.md Outdated
Comment threaddocs/guides/authentication/lucia.md
Comment threaddocs/guides/authentication/lucia.md

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (5)
docs/guides/authentication/lucia.md (5)

58-82: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-export const validateRequest = cache(- async (): Promise<{ user: User; session: Session } | { user: null; session: null }> => {- const sessionId = cookies().get(lucia.sessionCookieName)?.value ?? null;- if (!sessionId) {- return {- user: null,- session: null- };- }-- const result = await lucia.validateSession(sessionId);- // next.js throws when you attempt to set cookie when rendering page- try {- if (result.session && result.session.fresh) {- const sessionCookie = lucia.createSessionCookie(result.session.id);- cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);- }- if (!result.session) {- const sessionCookie = lucia.createBlankSessionCookie();- cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);- }- } catch {}- return result;- }-);+export const validateRequest = cache(+ async (): Promise<{ user: User; session: Session } | { user: null; session: null }> => {+ const sessionId = cookies().get(lucia.sessionCookieName)?.value ?? null;+ if (!sessionId) {+ return {+ user: null,+ session: null+ };+ }+ const result = await lucia.validateSession(sessionId);+ // next.js throws when you attempt to set cookie when rendering page+ try {+ if (result.session && result.session.fresh) {+ const sessionCookie = lucia.createSessionCookie(result.session.id);+ cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);+ }+ if (!result.session) {+ const sessionCookie = lucia.createBlankSessionCookie();+ cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);+ }+ } catch {}+ return result;+ }+);

101-113: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-export async function getEnhancedPrisma(): Promise<PrismaClient> {- const { user } = await validateRequest();- // create a wrapper of Prisma client that enforces access policy,- // data validation, and @password, @omit behaviors- return enhance(prisma, { user: {id: user?.id!}});+export async function getEnhancedPrisma(): Promise<PrismaClient> {+ const { user } = await validateRequest();+ // create a wrapper of Prisma client that enforces access policy,+ // data validation, and @password, @omit behaviors+ return enhance(prisma, { user: {id: user?.id!}});
}

121-138: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-declare module "lucia" {- interface Register {- Lucia: typeof lucia;- DatabaseUserAttributes: DatabaseUserAttributes- }-}--interface DatabaseUserAttributes {- userName: string;-}--export const lucia = new Lucia(adapter, {- getUserAttributes: (attributes) => {- return {- userName: attributes.userName- };- }+declare module "lucia" {+ interface Register {+ Lucia: typeof lucia;+ DatabaseUserAttributes: DatabaseUserAttributes+ }+}++interface DatabaseUserAttributes {+ userName: string;+}++export const lucia = new Lucia(adapter, {+ getUserAttributes: (attributes) => {+ return {+ userName: attributes.userName+ };+ }
});

7-7: Ensure consistent casing for all titles.

The title "Integrating With Lucia" should use consistent casing.

-# Integrating With Lucia+# Integrating with Lucia

144-151: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-export default async function Page() {- const { user } = await validateRequest();	- return (- <>- <h1>Hi, {user.userName}!</h1>- <p>Your user ID is {user.id}.</p>- </>- );+export default async function Page() {+ const { user } = await validateRequest();	+ return (+ <>+ <h1>Hi, {user.userName}!</h1>+ <p>Your user ID is {user.id}.</p>+ </>+ );
}
Tools
Markdownlint

145-145: Column: 44
Hard tabs

(MD010, no-hard-tabs)

@ymc9
ymc9 merged commit 88c6a57 into mainJul 12, 2024
@ymc9
ymc9 deleted the jiasheng branch July 12, 2024 17:26
@coderabbitaicoderabbitaiBot mentioned this pull request Nov 4, 2024
@coderabbitaicoderabbitaiBot mentioned this pull request Nov 24, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@jiashengguo@ymc9
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

doc: add Lucia Auth doc - #323

Merged
ymc9 merged 9 commits into
mainfrom
jiasheng
Jul 12, 2024
Merged

doc: add Lucia Auth doc#323
ymc9 merged 9 commits into
mainfrom
jiasheng

Conversation

@jiashengguo

@jiashengguojiashengguo commented Jul 9, 2024

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Documentation
    • Updated authentication guide with detailed instructions for integrating ZenStack with Lucia Auth.

@vercel

vercelBot commented Jul 9, 2024

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for Git ↗︎

NameStatusPreviewCommentsUpdated (UTC)
zenstack-new-site✅ Ready (Inspect)Visit Preview💬 Add feedbackJul 12, 2024 5:27pm

@coderabbitai

coderabbitaiBot commented Jul 9, 2024

Copy link
Copy Markdown
Contributor

Warning

Rate limit exceeded

@ymc9 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 25 minutes and 3 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 66ef8cf and 454753c.

Walkthrough

The updates to lucia.md transform placeholder text into comprehensive guidance on integrating ZenStack with Lucia Auth. This includes detailed instructions on data model requirements, implementing a Prisma adapter, request validation, creating an enhanced Prisma client, and exposing more user data. These enhancements significantly improve the guide's clarity and practicality for developers.

Changes

FilesChange Summary
docs/guides/authentication/lucia.mdTransitioned from placeholder text to detailed integration instructions for ZenStack with Lucia Auth.
.../lib/auth.tsAdded data models, Prisma adapter initialization, request validation, and user data exposure functions and interfaces.
.../lib/db.tsIntroduced an enhanced Prisma client creation.

Sequence Diagram(s)

sequenceDiagram
actor Developer
participant docs/guides/authentication/lucia.md as Lucia Guide
participant lib/auth.ts as auth.ts
participant lib/db.ts as db.ts
participant PrismaClient
participant PrismaAdapter
Developer ->> Lucia Guide: Read integration instructions
Lucia Guide ->> auth.ts: Update for Prisma Adapter and user data exposure
Lucia Guide ->> db.ts: Enhance Prisma client creation
auth.ts ->> PrismaClient: Import Prisma Client
auth.ts ->> PrismaAdapter: Initialize Prisma Adapter
auth.ts ->> auth.ts: Define request validation and user data exposure functions
db.ts ->> PrismaClient: Import Prisma Client
db.ts ->> db.ts: Define enhanced Prisma client function
Loading

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?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 4

Outside diff range and nitpick comments (1)
docs/guides/authentication/lucia.md (1)

15-15: Consider rephrasing to avoid repetition.

The phrase "needs to" is used repetitively. Consider rephrasing to add variety.

- So, your ZModel definition needs to include these two models.+ Therefore, your ZModel definition should include these two models.
Tools
LanguageTool

[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...js). ## Data Model Requirement Lucia needs to store your users and sessions in the da...

(REP_NEED_TO_VB)


[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...he database. So, your ZModel definition needs to include these two models. Here is the s...

(REP_NEED_TO_VB)

Comment threaddocs/guides/authentication/lucia.md Outdated
Comment threaddocs/guides/authentication/lucia.md
Comment threaddocs/guides/authentication/lucia.md
Comment threaddocs/guides/authentication/lucia.md
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Comment threaddocs/guides/authentication/lucia.md Outdated

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

Outside diff range, codebase verification and nitpick comments (5)
docs/guides/authentication/lucia.md (5)

54-84: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-export const validateRequest = cache(- async (): Promise<{ user: User; session: Session } | { user: null; session: null }> => {- const sessionId = cookies().get(lucia.sessionCookieName)?.value ?? null;- if (!sessionId) {- return {- user: null,- session: null- };- }-- const result = await lucia.validateSession(sessionId);- // next.js throws when you attempt to set cookie when rendering page- try {- if (result.session && result.session.fresh) {- const sessionCookie = lucia.createSessionCookie(result.session.id);- cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);- }- if (!result.session) {- const sessionCookie = lucia.createBlankSessionCookie();- cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);- }- } catch {}- return result;- }-);+export const validateRequest = cache(+ async (): Promise<{ user: User; session: Session } | { user: null; session: null }> => {+ const sessionId = cookies().get(lucia.sessionCookieName)?.value ?? null;+ if (!sessionId) {+ return {+ user: null,+ session: null+ };+ }++ const result = await lucia.validateSession(sessionId);+ // next.js throws when you attempt to set cookie when rendering page+ try {+ if (result.session && result.session.fresh) {+ const sessionCookie = lucia.createSessionCookie(result.session.id);+ cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);+ }+ if (!result.session) {+ const sessionCookie = lucia.createBlankSessionCookie();+ cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);+ }+ } catch {}+ return result;+ }+);

86-94: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-	const { user } = await validateRequest();--	if (!user) {- return redirect("/login");-	}+ const { user } = await validateRequest();++ if (!user) {+ return redirect("/login");+ }
Tools
Markdownlint

89-89: Column: 1
Hard tabs

(MD010, no-hard-tabs)


91-91: Column: 1
Hard tabs

(MD010, no-hard-tabs)


92-92: Column: 1
Hard tabs

(MD010, no-hard-tabs)


93-93: Column: 1
Hard tabs

(MD010, no-hard-tabs)


117-140: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-declare module "lucia" {-	interface Register {- Lucia: typeof lucia;- DatabaseUserAttributes: DatabaseUserAttributes-	}-}--interface DatabaseUserAttributes {- userName: string;-}--export const lucia = new Lucia(adapter, {-	getUserAttributes: (attributes) => {- return {- userName: attributes.userName- };-	}+declare module "lucia" {+ interface Register {+ Lucia: typeof lucia;+ DatabaseUserAttributes: DatabaseUserAttributes+ }+}++interface DatabaseUserAttributes {+ userName: string;+}++export const lucia = new Lucia(adapter, {+ getUserAttributes: (attributes) => {+ return {+ userName: attributes.userName+ };+ }
});

142-153: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-export default async function Page() {-	const { user } = await validateRequest();	-	return (- <>- <h1>Hi, {user.userName}!</h1>- <p>Your user ID is {user.id}.</p>- </>-	);+export default async function Page() {+ const { user } = await validateRequest();	+ return (+ <>+ <h1>Hi, {user.userName}!</h1>+ <p>Your user ID is {user.id}.</p>+ </>+ );
}
Tools
Markdownlint

146-146: Column: 44
Hard tabs

(MD010, no-hard-tabs)


15-15: Vary the phrasing for better readability.

The phrasing "needs to" is repeated in nearby sentences. Consider rephrasing to add variety.

- Lucia needs to store your users and sessions in the database. So, your ZModel definition needs to include these two models.+ Lucia requires storing your users and sessions in the database. Thus, your ZModel definition should include these two models.
Tools
LanguageTool

[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...js). ## Data model requirement Lucia needs to store your users and sessions in the da...

(REP_NEED_TO_VB)


[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...he database. So, your ZModel definition needs to include these two models. Here is the s...

(REP_NEED_TO_VB)

Comment threaddocs/guides/authentication/lucia.md Outdated
Comment threaddocs/guides/authentication/lucia.md
jiashengguoand others added 2 commits July 12, 2024 15:28
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 4

Outside diff range, codebase verification and nitpick comments (1)
docs/guides/authentication/lucia.md (1)

15-15: Consider rephrasing to avoid repetition.

The sentence "Lucia needs to store your users and sessions in the database" is repetitive. Consider rephrasing for variety.

- Lucia needs to store your users and sessions in the database. So, your ZModel definition needs to include these two models.+ To store users and sessions in the database, your ZModel definition must include these two models.
Tools
LanguageTool

[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...js). ## Data model requirement Lucia needs to store your users and sessions in the da...

(REP_NEED_TO_VB)


[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...he database. So, your ZModel definition needs to include these two models. Here is the s...

(REP_NEED_TO_VB)

Comment threaddocs/guides/authentication/lucia.md
Comment threaddocs/guides/authentication/lucia.md Outdated
Comment threaddocs/guides/authentication/lucia.md
Comment threaddocs/guides/authentication/lucia.md

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (5)
docs/guides/authentication/lucia.md (5)

58-82: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-export const validateRequest = cache(- async (): Promise<{ user: User; session: Session } | { user: null; session: null }> => {- const sessionId = cookies().get(lucia.sessionCookieName)?.value ?? null;- if (!sessionId) {- return {- user: null,- session: null- };- }-- const result = await lucia.validateSession(sessionId);- // next.js throws when you attempt to set cookie when rendering page- try {- if (result.session && result.session.fresh) {- const sessionCookie = lucia.createSessionCookie(result.session.id);- cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);- }- if (!result.session) {- const sessionCookie = lucia.createBlankSessionCookie();- cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);- }- } catch {}- return result;- }-);+export const validateRequest = cache(+ async (): Promise<{ user: User; session: Session } | { user: null; session: null }> => {+ const sessionId = cookies().get(lucia.sessionCookieName)?.value ?? null;+ if (!sessionId) {+ return {+ user: null,+ session: null+ };+ }+ const result = await lucia.validateSession(sessionId);+ // next.js throws when you attempt to set cookie when rendering page+ try {+ if (result.session && result.session.fresh) {+ const sessionCookie = lucia.createSessionCookie(result.session.id);+ cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);+ }+ if (!result.session) {+ const sessionCookie = lucia.createBlankSessionCookie();+ cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);+ }+ } catch {}+ return result;+ }+);

101-113: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-export async function getEnhancedPrisma(): Promise<PrismaClient> {- const { user } = await validateRequest();- // create a wrapper of Prisma client that enforces access policy,- // data validation, and @password, @omit behaviors- return enhance(prisma, { user: {id: user?.id!}});+export async function getEnhancedPrisma(): Promise<PrismaClient> {+ const { user } = await validateRequest();+ // create a wrapper of Prisma client that enforces access policy,+ // data validation, and @password, @omit behaviors+ return enhance(prisma, { user: {id: user?.id!}});
}

121-138: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-declare module "lucia" {- interface Register {- Lucia: typeof lucia;- DatabaseUserAttributes: DatabaseUserAttributes- }-}--interface DatabaseUserAttributes {- userName: string;-}--export const lucia = new Lucia(adapter, {- getUserAttributes: (attributes) => {- return {- userName: attributes.userName- };- }+declare module "lucia" {+ interface Register {+ Lucia: typeof lucia;+ DatabaseUserAttributes: DatabaseUserAttributes+ }+}++interface DatabaseUserAttributes {+ userName: string;+}++export const lucia = new Lucia(adapter, {+ getUserAttributes: (attributes) => {+ return {+ userName: attributes.userName+ };+ }
});

7-7: Ensure consistent casing for all titles.

The title "Integrating With Lucia" should use consistent casing.

-# Integrating With Lucia+# Integrating with Lucia

144-151: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-export default async function Page() {- const { user } = await validateRequest();	- return (- <>- <h1>Hi, {user.userName}!</h1>- <p>Your user ID is {user.id}.</p>- </>- );+export default async function Page() {+ const { user } = await validateRequest();	+ return (+ <>+ <h1>Hi, {user.userName}!</h1>+ <p>Your user ID is {user.id}.</p>+ </>+ );
}
Tools
Markdownlint

145-145: Column: 44
Hard tabs

(MD010, no-hard-tabs)

@ymc9
ymc9 merged commit 88c6a57 into mainJul 12, 2024
@ymc9
ymc9 deleted the jiasheng branch July 12, 2024 17:26
@coderabbitaicoderabbitaiBot mentioned this pull request Nov 4, 2024
@coderabbitaicoderabbitaiBot mentioned this pull request Nov 24, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@jiashengguo@ymc9
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

doc: add Lucia Auth doc - #323

Merged
ymc9 merged 9 commits into
mainfrom
jiasheng
Jul 12, 2024
Merged

doc: add Lucia Auth doc#323
ymc9 merged 9 commits into
mainfrom
jiasheng

Conversation

@jiashengguo

@jiashengguojiashengguo commented Jul 9, 2024

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Documentation
    • Updated authentication guide with detailed instructions for integrating ZenStack with Lucia Auth.

@vercel

vercelBot commented Jul 9, 2024

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for Git ↗︎

NameStatusPreviewCommentsUpdated (UTC)
zenstack-new-site✅ Ready (Inspect)Visit Preview💬 Add feedbackJul 12, 2024 5:27pm

@coderabbitai

coderabbitaiBot commented Jul 9, 2024

Copy link
Copy Markdown
Contributor

Warning

Rate limit exceeded

@ymc9 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 25 minutes and 3 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 66ef8cf and 454753c.

Walkthrough

The updates to lucia.md transform placeholder text into comprehensive guidance on integrating ZenStack with Lucia Auth. This includes detailed instructions on data model requirements, implementing a Prisma adapter, request validation, creating an enhanced Prisma client, and exposing more user data. These enhancements significantly improve the guide's clarity and practicality for developers.

Changes

FilesChange Summary
docs/guides/authentication/lucia.mdTransitioned from placeholder text to detailed integration instructions for ZenStack with Lucia Auth.
.../lib/auth.tsAdded data models, Prisma adapter initialization, request validation, and user data exposure functions and interfaces.
.../lib/db.tsIntroduced an enhanced Prisma client creation.

Sequence Diagram(s)

sequenceDiagram
actor Developer
participant docs/guides/authentication/lucia.md as Lucia Guide
participant lib/auth.ts as auth.ts
participant lib/db.ts as db.ts
participant PrismaClient
participant PrismaAdapter
Developer ->> Lucia Guide: Read integration instructions
Lucia Guide ->> auth.ts: Update for Prisma Adapter and user data exposure
Lucia Guide ->> db.ts: Enhance Prisma client creation
auth.ts ->> PrismaClient: Import Prisma Client
auth.ts ->> PrismaAdapter: Initialize Prisma Adapter
auth.ts ->> auth.ts: Define request validation and user data exposure functions
db.ts ->> PrismaClient: Import Prisma Client
db.ts ->> db.ts: Define enhanced Prisma client function
Loading

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?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 4

Outside diff range and nitpick comments (1)
docs/guides/authentication/lucia.md (1)

15-15: Consider rephrasing to avoid repetition.

The phrase "needs to" is used repetitively. Consider rephrasing to add variety.

- So, your ZModel definition needs to include these two models.+ Therefore, your ZModel definition should include these two models.
Tools
LanguageTool

[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...js). ## Data Model Requirement Lucia needs to store your users and sessions in the da...

(REP_NEED_TO_VB)


[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...he database. So, your ZModel definition needs to include these two models. Here is the s...

(REP_NEED_TO_VB)

Comment threaddocs/guides/authentication/lucia.md Outdated
Comment threaddocs/guides/authentication/lucia.md
Comment threaddocs/guides/authentication/lucia.md
Comment threaddocs/guides/authentication/lucia.md
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Comment threaddocs/guides/authentication/lucia.md Outdated

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

Outside diff range, codebase verification and nitpick comments (5)
docs/guides/authentication/lucia.md (5)

54-84: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-export const validateRequest = cache(- async (): Promise<{ user: User; session: Session } | { user: null; session: null }> => {- const sessionId = cookies().get(lucia.sessionCookieName)?.value ?? null;- if (!sessionId) {- return {- user: null,- session: null- };- }-- const result = await lucia.validateSession(sessionId);- // next.js throws when you attempt to set cookie when rendering page- try {- if (result.session && result.session.fresh) {- const sessionCookie = lucia.createSessionCookie(result.session.id);- cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);- }- if (!result.session) {- const sessionCookie = lucia.createBlankSessionCookie();- cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);- }- } catch {}- return result;- }-);+export const validateRequest = cache(+ async (): Promise<{ user: User; session: Session } | { user: null; session: null }> => {+ const sessionId = cookies().get(lucia.sessionCookieName)?.value ?? null;+ if (!sessionId) {+ return {+ user: null,+ session: null+ };+ }++ const result = await lucia.validateSession(sessionId);+ // next.js throws when you attempt to set cookie when rendering page+ try {+ if (result.session && result.session.fresh) {+ const sessionCookie = lucia.createSessionCookie(result.session.id);+ cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);+ }+ if (!result.session) {+ const sessionCookie = lucia.createBlankSessionCookie();+ cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);+ }+ } catch {}+ return result;+ }+);

86-94: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-	const { user } = await validateRequest();--	if (!user) {- return redirect("/login");-	}+ const { user } = await validateRequest();++ if (!user) {+ return redirect("/login");+ }
Tools
Markdownlint

89-89: Column: 1
Hard tabs

(MD010, no-hard-tabs)


91-91: Column: 1
Hard tabs

(MD010, no-hard-tabs)


92-92: Column: 1
Hard tabs

(MD010, no-hard-tabs)


93-93: Column: 1
Hard tabs

(MD010, no-hard-tabs)


117-140: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-declare module "lucia" {-	interface Register {- Lucia: typeof lucia;- DatabaseUserAttributes: DatabaseUserAttributes-	}-}--interface DatabaseUserAttributes {- userName: string;-}--export const lucia = new Lucia(adapter, {-	getUserAttributes: (attributes) => {- return {- userName: attributes.userName- };-	}+declare module "lucia" {+ interface Register {+ Lucia: typeof lucia;+ DatabaseUserAttributes: DatabaseUserAttributes+ }+}++interface DatabaseUserAttributes {+ userName: string;+}++export const lucia = new Lucia(adapter, {+ getUserAttributes: (attributes) => {+ return {+ userName: attributes.userName+ };+ }
});

142-153: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-export default async function Page() {-	const { user } = await validateRequest();	-	return (- <>- <h1>Hi, {user.userName}!</h1>- <p>Your user ID is {user.id}.</p>- </>-	);+export default async function Page() {+ const { user } = await validateRequest();	+ return (+ <>+ <h1>Hi, {user.userName}!</h1>+ <p>Your user ID is {user.id}.</p>+ </>+ );
}
Tools
Markdownlint

146-146: Column: 44
Hard tabs

(MD010, no-hard-tabs)


15-15: Vary the phrasing for better readability.

The phrasing "needs to" is repeated in nearby sentences. Consider rephrasing to add variety.

- Lucia needs to store your users and sessions in the database. So, your ZModel definition needs to include these two models.+ Lucia requires storing your users and sessions in the database. Thus, your ZModel definition should include these two models.
Tools
LanguageTool

[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...js). ## Data model requirement Lucia needs to store your users and sessions in the da...

(REP_NEED_TO_VB)


[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...he database. So, your ZModel definition needs to include these two models. Here is the s...

(REP_NEED_TO_VB)

Comment threaddocs/guides/authentication/lucia.md Outdated
Comment threaddocs/guides/authentication/lucia.md
jiashengguoand others added 2 commits July 12, 2024 15:28
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 4

Outside diff range, codebase verification and nitpick comments (1)
docs/guides/authentication/lucia.md (1)

15-15: Consider rephrasing to avoid repetition.

The sentence "Lucia needs to store your users and sessions in the database" is repetitive. Consider rephrasing for variety.

- Lucia needs to store your users and sessions in the database. So, your ZModel definition needs to include these two models.+ To store users and sessions in the database, your ZModel definition must include these two models.
Tools
LanguageTool

[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...js). ## Data model requirement Lucia needs to store your users and sessions in the da...

(REP_NEED_TO_VB)


[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...he database. So, your ZModel definition needs to include these two models. Here is the s...

(REP_NEED_TO_VB)

Comment threaddocs/guides/authentication/lucia.md
Comment threaddocs/guides/authentication/lucia.md Outdated
Comment threaddocs/guides/authentication/lucia.md
Comment threaddocs/guides/authentication/lucia.md

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (5)
docs/guides/authentication/lucia.md (5)

58-82: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-export const validateRequest = cache(- async (): Promise<{ user: User; session: Session } | { user: null; session: null }> => {- const sessionId = cookies().get(lucia.sessionCookieName)?.value ?? null;- if (!sessionId) {- return {- user: null,- session: null- };- }-- const result = await lucia.validateSession(sessionId);- // next.js throws when you attempt to set cookie when rendering page- try {- if (result.session && result.session.fresh) {- const sessionCookie = lucia.createSessionCookie(result.session.id);- cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);- }- if (!result.session) {- const sessionCookie = lucia.createBlankSessionCookie();- cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);- }- } catch {}- return result;- }-);+export const validateRequest = cache(+ async (): Promise<{ user: User; session: Session } | { user: null; session: null }> => {+ const sessionId = cookies().get(lucia.sessionCookieName)?.value ?? null;+ if (!sessionId) {+ return {+ user: null,+ session: null+ };+ }+ const result = await lucia.validateSession(sessionId);+ // next.js throws when you attempt to set cookie when rendering page+ try {+ if (result.session && result.session.fresh) {+ const sessionCookie = lucia.createSessionCookie(result.session.id);+ cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);+ }+ if (!result.session) {+ const sessionCookie = lucia.createBlankSessionCookie();+ cookies().set(sessionCookie.name, sessionCookie.value, sessionCookie.attributes);+ }+ } catch {}+ return result;+ }+);

101-113: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-export async function getEnhancedPrisma(): Promise<PrismaClient> {- const { user } = await validateRequest();- // create a wrapper of Prisma client that enforces access policy,- // data validation, and @password, @omit behaviors- return enhance(prisma, { user: {id: user?.id!}});+export async function getEnhancedPrisma(): Promise<PrismaClient> {+ const { user } = await validateRequest();+ // create a wrapper of Prisma client that enforces access policy,+ // data validation, and @password, @omit behaviors+ return enhance(prisma, { user: {id: user?.id!}});
}

121-138: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-declare module "lucia" {- interface Register {- Lucia: typeof lucia;- DatabaseUserAttributes: DatabaseUserAttributes- }-}--interface DatabaseUserAttributes {- userName: string;-}--export const lucia = new Lucia(adapter, {- getUserAttributes: (attributes) => {- return {- userName: attributes.userName- };- }+declare module "lucia" {+ interface Register {+ Lucia: typeof lucia;+ DatabaseUserAttributes: DatabaseUserAttributes+ }+}++interface DatabaseUserAttributes {+ userName: string;+}++export const lucia = new Lucia(adapter, {+ getUserAttributes: (attributes) => {+ return {+ userName: attributes.userName+ };+ }
});

7-7: Ensure consistent casing for all titles.

The title "Integrating With Lucia" should use consistent casing.

-# Integrating With Lucia+# Integrating with Lucia

144-151: Replace hard tabs with spaces for consistency.

The code snippet contains hard tabs which should be replaced with spaces.

-export default async function Page() {- const { user } = await validateRequest();	- return (- <>- <h1>Hi, {user.userName}!</h1>- <p>Your user ID is {user.id}.</p>- </>- );+export default async function Page() {+ const { user } = await validateRequest();	+ return (+ <>+ <h1>Hi, {user.userName}!</h1>+ <p>Your user ID is {user.id}.</p>+ </>+ );
}
Tools
Markdownlint

145-145: Column: 44
Hard tabs

(MD010, no-hard-tabs)

@ymc9
ymc9 merged commit 88c6a57 into mainJul 12, 2024
@ymc9
ymc9 deleted the jiasheng branch July 12, 2024 17:26
@coderabbitaicoderabbitaiBot mentioned this pull request Nov 4, 2024
@coderabbitaicoderabbitaiBot mentioned this pull request Nov 24, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@jiashengguo@ymc9