Skip to content

Update nestjs.mdx #472

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update nestjs.mdx #472

wants to merge 1 commit into from

Conversation

lsmith77
Copy link

@lsmith77 lsmith77 commented Jul 3, 2025

@default(auth().id) does not seem to be supported by prisma

also made author and authorId optonal to align with the zModel code further down

Summary by CodeRabbit

  • Documentation
    • Updated documentation to reflect that posts can now exist without an associated author or author ID.

`@default(auth().id)` does not seem to be supported by prisma

also made author and authorId optonal to align with the zModel code further down
Copy link

vercel bot commented Jul 3, 2025

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

Name Status Preview Comments Updated (UTC)
zenstack-new-site ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 3, 2025 7:56am

Copy link
Contributor

coderabbitai bot commented Jul 3, 2025

Walkthrough

The changes update the Post model in the Prisma schema to make the author relation and authorId field optional instead of required. Documentation in the NestJS quick start guide is also updated to reflect these schema changes, allowing posts without an associated author.

Changes

File(s) Change Summary
docs/quick-start/nestjs.mdx Updated documentation to reflect optional author and authorId in Post.
prisma/schema.prisma Changed Post.author and Post.authorId fields from required to optional.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API
    participant Database

    Client->>API: Create Post (may omit author/authorId)
    API->>Database: Insert Post (authorId can be null)
    Database-->>API: Post created (authorId may be null)
    API-->>Client: Post creation response
Loading

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cf7e449 and d5c910a.

📒 Files selected for processing (1)
  • docs/quick-start/nestjs.mdx (1 hunks)
🔇 Additional comments (1)
docs/quick-start/nestjs.mdx (1)

72-74: Derive authorId from the authenticated user instead of client input

The current createDraft controller still takes authorId in the request body, which trusts the client and weakens ownership enforcement. Instead, fetch the user ID from the server-side context (set by your AuthInterceptor) and pass that to Prisma.

• File: docs/quick-start/nestjs.mdx around line 134 (in the createDraft example)

Suggested update:

- async createDraft(@Body() postData: { title: string; authorId: number }) {
-   return this.prismaService.post.create({
-     data: { ...postData },
-   });
+ async createDraft(@Body() postData: { title: string }) {
+   const user = this.cls.get('auth'); // already stored by AuthInterceptor
+   return this.prismaService.post.create({
+     data: {
+       title: postData.title,
+       authorId: user?.id,
+     },
+   });
 }

This change preserves the nullable authorId schema, avoids trusting client input, and keeps ownership checks intact.

Likely an incorrect or invalid review comment.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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 explain this code block.
    • @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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

@lsmith77
Copy link
Author

lsmith77 commented Jul 3, 2025

BTW in the Nest.js world it would be common to use calls like these:

nest g service prisma
nest g interceptor auth

Which would result in slightly different paths

import { PrismaService } from './prisma/prisma.service';
import { AuthInterceptor } from './auth/auth.interceptor';

if you think it makes sense to add these CLI commands to the docs, I am happy to do this in another PR.

Sign up for free to 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.

1 participant