Test: src/graphql/types/Advertisement/updatedAt.ts #3137
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: NishantSinghhhhh <nishantsingh_230137@aitpune.edu.in>
Signed-off-by: NishantSinghhhhh <nishantsingh_230137@aitpune.edu.in>
Signed-off-by: NishantSinghhhhh <nishantsingh_230137@aitpune.edu.in>
…-api into develop-postgres
Signed-off-by: NishantSinghhhhh <nishantsingh_230137@aitpune.edu.in>
WalkthroughThis pull request introduces a new type declaration in the GraphQL context to enhance type safety through an explicit authentication token payload that includes a user’s id. Additionally, it implements a comprehensive test suite for the Changes
Sequence Diagram(s)sequenceDiagram
participant Client as Test Harness
participant Resolver as resolveUpdatedAt Function
participant DB as Database (Mock)
Client->>Resolver: Invoke resolveUpdatedAt with Advertisement, args, ctx
Resolver->>DB: Query user roles and organization memberships
alt User is authenticated and an administrator
DB-->>Resolver: Return admin privileges data
Resolver-->>Client: Return updatedAt value
else User is unauthenticated or lacks privileges
DB-->>Resolver: Return insufficient access data
Resolver-->>Client: Throw error ("unauthenticated"/"unauthorized_action")
end
Assessment against linked issues
Possibly related issues
Suggested reviewers
✨ Finishing Touches
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
Our Pull Request Approval ProcessThanks for contributing! Testing Your CodeRemember, your PRs won't be reviewed until these criteria are met:
Our policies make our code better. ReviewersDo not assign reviewers. Our Queue Monitors will review your PR and assign them.
Reviewing Your CodeYour reviewer(s) will have the following roles:
CONTRIBUTING.mdRead our CONTRIBUTING.md file. Most importantly:
Other
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (2)
src/graphql/context.ts(1 hunks)test/graphql/types/Advertisement/updatedAt.test.ts(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Analyse Code With CodeQL (typescript)
🔇 Additional comments (6)
src/graphql/context.ts (1)
15-18: LGTM! Well-structured type declaration.The
ExplicitAuthenticationTokenPayloadtype properly enforces type safety for authentication tokens by explicitly picking the user id from the users table.test/graphql/types/Advertisement/updatedAt.test.ts (5)
9-48: LGTM! Well-structured test setup with proper type definitions.The test setup includes:
- Clear interface definitions
- Proper table schema mock
- Type-safe test context
168-203: LGTM! Comprehensive authentication test coverage.Tests properly verify:
- Unauthenticated access rejection
- System administrator access
- Organization administrator access
205-238: LGTM! Thorough authorization test coverage.Tests properly verify access denial for:
- Non-administrator users
- Users without organization membership
316-351: LGTM! Comprehensive error handling test coverage.Tests properly verify:
- Missing user data handling
- Database connection errors
- Empty role string handling
240-314: LGTM! Excellent database query test coverage.Tests thoroughly verify:
- Correct query structure
- Multiple organization membership handling
- Role case sensitivity
Consider adding a test for SQL injection prevention.
✅ Verification successful
SQL Injection Concern Review
The repository’s scan did not reveal any problematic SQL injection patterns in the production query logic—the only matches were in a SQL dump and a README file. The existing tests effectively verify the intended database query structure and edge cases. While adding explicit SQL injection prevention tests could further bolster security, the current state of the tests appears sound.🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Check for potential SQL injection vulnerabilities in database queries rg -l "SELECT|INSERT|UPDATE|DELETE" | xargs rg -l "\\$\\{|\\$\\(|\\+.*\\+|\\|\\||&&"Length of output: 119
Comment on lines
+49
to
+123
| async function resolveUpdatedAt( | ||
| parent: Advertisement, | ||
| _args: unknown, | ||
| ctx: TestContext, | ||
| ): Promise<Date | null> { | ||
| if (!ctx.currentClient.isAuthenticated) { | ||
| throw new TalawaGraphQLError({ | ||
| extensions: { code: "unauthenticated" }, | ||
| }); | ||
| } | ||
|
|
||
| if (!parent.organizationId) { | ||
| throw new TalawaGraphQLError({ | ||
| extensions: { | ||
| code: "invalid_arguments", | ||
| issues: [ | ||
| { | ||
| argumentPath: ["organizationId"], | ||
| message: "Organization ID cannot be null", | ||
| }, | ||
| ], | ||
| }, | ||
| }); | ||
| } | ||
|
|
||
| const currentUserId = ctx.currentClient.user.id; | ||
|
|
||
| try { | ||
| const currentUser = await ctx.drizzleClient.query.usersTable.findFirst({ | ||
| columns: { role: true }, | ||
| with: { | ||
| organizationMembershipsWhereMember: { | ||
| columns: { role: true }, | ||
| where: () => | ||
| eq( | ||
| organizationMembershipsTable.organizationId, | ||
| parent.organizationId, | ||
| ), | ||
| }, | ||
| }, | ||
| where: () => eq(usersTable.id, currentUserId), | ||
| }); | ||
|
|
||
| if (!currentUser) { | ||
| throw new TalawaGraphQLError({ | ||
| extensions: { code: "unauthenticated" }, | ||
| }); | ||
| } | ||
| if (currentUser.role === "administrator") { | ||
| return parent.updatedAt; | ||
| } | ||
|
|
||
| // Check if user has admin rights in any of their organization memberships | ||
| const hasOrgAdminRights = | ||
| currentUser.organizationMembershipsWhereMember.some( | ||
| (membership: OrganizationMembership) => | ||
| membership.role === "administrator" && | ||
| membership.organizationId === parent.organizationId, | ||
| ); | ||
|
|
||
| if (!hasOrgAdminRights) { | ||
| throw new TalawaGraphQLError({ | ||
| extensions: { code: "unauthorized_action" }, | ||
| }); | ||
| } | ||
|
|
||
| return parent.updatedAt; | ||
| } catch (error) { | ||
| if (error instanceof TalawaGraphQLError) { | ||
| throw error; | ||
| } | ||
|
|
||
| throw new Error("Database connection error"); | ||
| } | ||
| } |
There was a problem hiding this comment.
🧹 Nitpick (assertive)
LGTM! Well-implemented resolver with comprehensive access control.
The implementation correctly handles:
- Authentication checks
- Organization validation
- Role-based access control
- Error handling with specific error codes
However, consider adding logging for security-related events.
if (!ctx.currentClient.isAuthenticated) {
+ ctx.log.warn('Unauthenticated access attempt to advertisement updatedAt field');
throw new TalawaGraphQLError({
extensions: { code: "unauthenticated" },
});
}📝 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
| async function resolveUpdatedAt( | |
| parent: Advertisement, | |
| _args: unknown, | |
| ctx: TestContext, | |
| ): Promise<Date | null> { | |
| if (!ctx.currentClient.isAuthenticated) { | |
| throw new TalawaGraphQLError({ | |
| extensions: { code: "unauthenticated" }, | |
| }); | |
| } | |
| if (!parent.organizationId) { | |
| throw new TalawaGraphQLError({ | |
| extensions: { | |
| code: "invalid_arguments", | |
| issues: [ | |
| { | |
| argumentPath: ["organizationId"], | |
| message: "Organization ID cannot be null", | |
| }, | |
| ], | |
| }, | |
| }); | |
| } | |
| const currentUserId = ctx.currentClient.user.id; | |
| try { | |
| const currentUser = await ctx.drizzleClient.query.usersTable.findFirst({ | |
| columns: { role: true }, | |
| with: { | |
| organizationMembershipsWhereMember: { | |
| columns: { role: true }, | |
| where: () => | |
| eq( | |
| organizationMembershipsTable.organizationId, | |
| parent.organizationId, | |
| ), | |
| }, | |
| }, | |
| where: () => eq(usersTable.id, currentUserId), | |
| }); | |
| if (!currentUser) { | |
| throw new TalawaGraphQLError({ | |
| extensions: { code: "unauthenticated" }, | |
| }); | |
| } | |
| if (currentUser.role === "administrator") { | |
| return parent.updatedAt; | |
| } | |
| // Check if user has admin rights in any of their organization memberships | |
| const hasOrgAdminRights = | |
| currentUser.organizationMembershipsWhereMember.some( | |
| (membership: OrganizationMembership) => | |
| membership.role === "administrator" && | |
| membership.organizationId === parent.organizationId, | |
| ); | |
| if (!hasOrgAdminRights) { | |
| throw new TalawaGraphQLError({ | |
| extensions: { code: "unauthorized_action" }, | |
| }); | |
| } | |
| return parent.updatedAt; | |
| } catch (error) { | |
| if (error instanceof TalawaGraphQLError) { | |
| throw error; | |
| } | |
| throw new Error("Database connection error"); | |
| } | |
| } | |
| async function resolveUpdatedAt( | |
| parent: Advertisement, | |
| _args: unknown, | |
| ctx: TestContext, | |
| ): Promise<Date | null> { | |
| if (!ctx.currentClient.isAuthenticated) { | |
| ctx.log.warn('Unauthenticated access attempt to advertisement updatedAt field'); | |
| throw new TalawaGraphQLError({ | |
| extensions: { code: "unauthenticated" }, | |
| }); | |
| } | |
| if (!parent.organizationId) { | |
| throw new TalawaGraphQLError({ | |
| extensions: { | |
| code: "invalid_arguments", | |
| issues: [ | |
| { | |
| argumentPath: ["organizationId"], | |
| message: "Organization ID cannot be null", | |
| }, | |
| ], | |
| }, | |
| }); | |
| } | |
| const currentUserId = ctx.currentClient.user.id; | |
| try { | |
| const currentUser = await ctx.drizzleClient.query.usersTable.findFirst({ | |
| columns: { role: true }, | |
| with: { | |
| organizationMembershipsWhereMember: { | |
| columns: { role: true }, | |
| where: () => | |
| eq( | |
| organizationMembershipsTable.organizationId, | |
| parent.organizationId, | |
| ), | |
| }, | |
| }, | |
| where: () => eq(usersTable.id, currentUserId), | |
| }); | |
| if (!currentUser) { | |
| throw new TalawaGraphQLError({ | |
| extensions: { code: "unauthenticated" }, | |
| }); | |
| } | |
| if (currentUser.role === "administrator") { | |
| return parent.updatedAt; | |
| } | |
| // Check if user has admin rights in any of their organization memberships | |
| const hasOrgAdminRights = | |
| currentUser.organizationMembershipsWhereMember.some( | |
| (membership: OrganizationMembership) => | |
| membership.role === "administrator" && | |
| membership.organizationId === parent.organizationId, | |
| ); | |
| if (!hasOrgAdminRights) { | |
| throw new TalawaGraphQLError({ | |
| extensions: { code: "unauthorized_action" }, | |
| }); | |
| } | |
| return parent.updatedAt; | |
| } catch (error) { | |
| if (error instanceof TalawaGraphQLError) { | |
| throw error; | |
| } | |
| throw new Error("Database connection error"); | |
| } | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What kind of change does this PR introduce?
Feature: Adds functionality to resolve the updatedAt field in an advertisement.
Issue Number:
Fixes: #3087
Snapshots/Videos:
Screencast from 2025-02-03 00-38-21.webm
If relevant, did you update the documentation?
Summary
This PR introduces logic for resolving the updatedAt field in advertisements. It ensures that only authenticated users with the correct roles (administrator or organization administrator) can access the field. The change involves the following key checks:
Authentication Check: If the user is not logged in, an unauthenticated error is thrown.
Role-based Access: If the user is an organization administrator or system administrator, access is granted to the updatedAt field.
Database Query Logic: A series of database queries checks the user’s role and membership in the specified organization to ensure appropriate access.
Error Handling: Comprehensive error handling is implemented for missing or invalid data and database connection errors.
This PR also adds several test cases to validate the functionality, ensuring that unauthorized users cannot access the field and that proper database queries are executed.
Does this PR introduce a breaking change?
No.
Checklist
CodeRabbit AI Review
I have reviewed and addressed all critical issues flagged by CodeRabbit AI
I have implemented or provided justification for each non-critical suggestion
I have documented my reasoning in the PR comments where CodeRabbit AI suggestions were not implemented
Test Coverage
I have written tests for all new changes/features
I have verified that test coverage meets or exceeds 95%
I have run the test suite locally and all tests pass
Other information
The test suite includes multiple scenarios such as verifying authentication, role validation, handling missing or incorrect data, and ensuring correct database queries are being executed.
Have you read the contributing guide?
Yes.
Summary by CodeRabbit
New Features
Tests