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

feat: ajusts quary to make it the same as allProjects query #1754

Merged
merged 2 commits into from
Aug 23, 2024

Conversation

Reshzera
Copy link
Contributor

@Reshzera Reshzera commented Aug 7, 2024

Summary by CodeRabbit

  • New Features
    • Enhanced project filtering to include only active and listed projects, improving result accuracy.
  • Bug Fixes
    • Improved security of project queries to prevent SQL injection vulnerabilities.

@Reshzera Reshzera requested a review from RamRamez August 7, 2024 18:01
Copy link
Contributor

coderabbitai bot commented Aug 7, 2024

Walkthrough

The recent change refines the query logic in the totalProjectsPerDate function by adding a condition to filter projects based on both their reviewStatus and statusId. This ensures only active and listed projects are included in the results. Additionally, the implementation of parameterized queries enhances security and improves code readability.

Changes

Files Change Summary
src/repositories/projectRepository.ts Enhanced the totalProjectsPerDate function to filter projects by both reviewStatus and statusId to include only active, listed projects. Improved SQL injection prevention with parameterized queries.

Poem

In a meadow bright, where the projects play,
A rabbit hops in to brighten the day.
With statuses checked, both active and clear,
Now our queries are safer, let’s cheer and revere!
Hopping with joy, we celebrate this win,
For better code makes all the rabbits grin! 🐰✨


Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a0c6242 and 3eae98b.

Files selected for processing (1)
  • src/repositories/projectRepository.ts (2 hunks)
Additional comments not posted (2)
src/repositories/projectRepository.ts (2)

442-444: LGTM! Use of parameterized queries is approved.

The use of parameterized queries for reviewStatus enhances security and readability.


442-444: LGTM! Use of parameterized queries is approved.

The use of parameterized queries for reviewStatus enhances security and readability.


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>.
    • 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 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 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.

@Reshzera
Copy link
Contributor Author

Reshzera commented Aug 7, 2024

@kkatusic kkatusic self-requested a review August 7, 2024 19:35
Copy link
Collaborator

@kkatusic kkatusic left a comment

Choose a reason for hiding this comment

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

LGTM ;), thc @Reshzera

@@ -437,7 +437,10 @@ export const totalProjectsPerDate = async (
}

if (onlyListed) {
query.andWhere(`project."reviewStatus" = 'Listed'`);
query.andWhere(
`project.statusId = ${ProjStatus.active} AND project.reviewStatus = :reviewStatus`,
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think it's not a good idea to add statusId condition inside onlyListed condition, because those are separate conditions

Copy link
Collaborator

Choose a reason for hiding this comment

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

@RamRamez he can move it outside, but what if this statusId is only related to listed projects? I just asking, want to know :)

Copy link
Collaborator

Choose a reason for hiding this comment

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

@kkatusic I checked and we have some listed projects with status other than active, so we should check them separately. I asked Mitch in the issue for clarification.

Copy link
Collaborator

Choose a reason for hiding this comment

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

thx

Copy link
Contributor Author

@Reshzera Reshzera Aug 22, 2024

Choose a reason for hiding this comment

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

@RamRamez I just fixed the error could you please take a look again

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: 0

Outside diff range, codebase verification and nitpick comments (1)
src/repositories/projectRepository.ts (1)

427-428: Use Parameterized Queries for statusId

The current implementation uses a non-parameterized query for statusId, which could lead to security vulnerabilities. It is recommended to use parameterized queries to prevent potential SQL injection attacks.

  • Consider changing project.statusId = ${ProjStatus.active} to a parameterized query format.
Analysis chain

Verify the placement of the statusId condition.

The addition of the statusId condition aligns with the PR objectives. However, ensure that this condition is correctly placed in the query logic, as there were concerns about its placement in previous reviews.

Run the following script to verify the placement of the statusId condition:

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the placement of the `statusId` condition in the query logic.

# Test: Search for the usage of `statusId` in the codebase. Expect: Correct placement in query logic.
rg --type typescript -A 5 $'statusId'

Length of output: 71


Script:

#!/bin/bash
# Description: Verify the placement of the `statusId` condition in the query logic.

# Test: Search for the usage of `statusId` in the codebase. Expect: Correct placement in query logic.
rg --type ts -A 5 $'statusId'

Length of output: 81383

@Reshzera Reshzera requested a review from RamRamez August 22, 2024 21:15
Copy link
Collaborator

@RamRamez RamRamez left a comment

Choose a reason for hiding this comment

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

Thanks @Reshzera

@Reshzera Reshzera merged commit 0210f4c into staging Aug 23, 2024
5 checks passed
@Reshzera Reshzera deleted the feat/issue-analytics-dashboard-34 branch August 23, 2024 17:22
@coderabbitai coderabbitai bot mentioned this pull request Dec 9, 2024
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.

3 participants