Skip to content
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

chore: added all selected columns to the groupBy function #1054

Merged

Conversation

JohnAllenTech
Copy link
Contributor

✨ Codu Pull Request 💻

Fixes #1053

Pull Request details

Seems like a new thing in drizzle? Didnt try to revert versions just fixed it in place.

Any Breaking changes

  • Potentially. I will need help to test this. Seems to work locally but need a second set of eyes before Id be confident to merge

Associated Screenshots

image

@JohnAllenTech JohnAllenTech requested a review from a team as a code owner October 2, 2024 23:49
Copy link

vercel bot commented Oct 2, 2024

@JohnAllenTech is attempting to deploy a commit to the Codú Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented Oct 2, 2024

Walkthrough

The changes in the pull request focus on enhancing the post management system within the postRouter. Key modifications include an updated groupBy clause in the published query, clarified return values for mutation procedures, consistent error handling for unauthorized access, improved transaction management for likes and bookmarks, and retained input validation schemas. These updates aim to provide a more robust and clear interaction model for users managing posts.

Changes

Files Change Summary
server/api/router/post.ts - Updated groupBy clause in the published query to include additional fields.
- Clarified return values for like and bookmark mutation procedures.
- Consistent error handling for unauthorized access across mutation procedures.
- Implemented transaction management in like and bookmark procedures.
- Retained input validation schemas for post management operations.

Assessment against linked issues

Objective Addressed Explanation
Ensure Post.slug is included in the GROUP BY clause (1053)
Articles page should work after seeding DB (1053) The article page is still not functioning correctly.

Possibly related PRs

Suggested labels

hacktoberfest-accepted, hacktoberfest

Suggested reviewers

  • NiallJoeMaher

🐇 In the garden, I hop and play,
With posts and likes, brightening the day.
Transactions smooth, errors kept at bay,
Oh, what joy in the code we lay!
Hopping through changes, come what may! 🌼


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 909133c and 389acab.

⛔ Files ignored due to path filters (2)
  • package-lock.json is excluded by !**/package-lock.json, !**/*.json
  • package.json is excluded by !**/*.json
📒 Files selected for processing (1)
  • server/api/router/post.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • server/api/router/post.ts

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:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • 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 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 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 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 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.

@JohnAllenTech JohnAllenTech force-pushed the fix/broken-article-query branch from 3dd0af0 to 909133c Compare October 2, 2024 23:51
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between add6fea and 909133c.

📒 Files selected for processing (1)
  • server/api/router/post.ts (1 hunks)

Comment on lines +351 to +361
.groupBy(
post.id,
post.slug,
post.title,
post.excerpt,
post.published,
post.readTimeMins,
post.likes,
bookmarked.id,
user.id,
)
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

⚠️ Potential issue

Avoid grouping by all selected columns; consider query refactoring

Including all selected columns in the groupBy clause may lead to performance issues and isn't always necessary. This approach can cause inefficient queries and might not return the desired results. Since the joins with post_tag and tag tables may introduce duplicate posts due to posts having multiple tags, consider using DISTINCT to retrieve unique posts or refactoring the query to eliminate duplicates without grouping.

Apply this diff to use distinct instead of groupBy:

             .where(
               and(
                 isNotNull(post.published),
                 lte(post.published, new Date().toISOString()),
                 tagFilter ? eq(tag.title, tagFilter.toUpperCase()) : undefined,
                 cursor ? paginationMapping[sort].cursor : undefined,
               ),
             )
+            .distinctOn([post.id])
-            .groupBy(
-              post.id,
-              post.slug,
-              post.title,
-              post.excerpt,
-              post.published,
-              post.readTimeMins,
-              post.likes,
-              bookmarked.id,
-              user.id,
-            )
             .limit(limit + 1)
             .orderBy(paginationMapping[sort].orderBy);

Alternatively, you can restructure the query to fetch tags separately or use aggregate functions if necessary.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
.groupBy(
post.id,
post.slug,
post.title,
post.excerpt,
post.published,
post.readTimeMins,
post.likes,
bookmarked.id,
user.id,
)
.where(
and(
isNotNull(post.published),
lte(post.published, new Date().toISOString()),
tagFilter ? eq(tag.title, tagFilter.toUpperCase()) : undefined,
cursor ? paginationMapping[sort].cursor : undefined,
),
)
.distinctOn([post.id])
.limit(limit + 1)
.orderBy(paginationMapping[sort].orderBy);

@NiallJoeMaher
Copy link
Contributor

Should we bump drizzle to the latest version to see what it breaks in this too (that's coming in a PR anyway 😂 )

@JohnAllenTech
Copy link
Contributor Author

Should we bump drizzle to the latest version to see what it breaks in this too (that's coming in a PR anyway 😂 )

Will do

@JohnAllenTech
Copy link
Contributor Author

@NiallJoeMaher bumped the dependency and everything is still working.

Copy link
Contributor

@NiallJoeMaher NiallJoeMaher left a comment

Choose a reason for hiding this comment

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

🌮

Copy link

vercel bot commented Oct 4, 2024

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

Name Status Preview Comments Updated (UTC)
codu ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 4, 2024 6:53am

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Articles page not working after seeding DB
2 participants