added assignUserTag and removeUserTag mutations #3438
Conversation
WalkthroughThis pull request refactors the GraphQL schema by removing the legacy membership and blocking mutations and introducing new mutations and types for managing user tags. It adds mutations such as Changes
Sequence Diagram(s)sequenceDiagram
participant C as Client
participant G as GraphQL Resolver (assignUserTag)
participant Auth as Authentication Module
participant DB as Database
C->>G: Call assignUserTag(input)
G->>Auth: Verify authentication
Auth-->>G: Return authentication status
G->>G: Validate input (using Zod)
G->>DB: Query for tag and user
DB-->>G: Return tag and user records
G->>DB: Insert tag assignment record
DB-->>G: Confirmation of insertion
G-->>C: Return tag object
sequenceDiagram
participant C as Client
participant G as GraphQL Resolver (removeFromUserTags)
participant DB as Database
C->>G: Call removeFromUserTags(input)
G->>G: Validate input (currentTagId & selectedTagIds)
G->>DB: Fetch tag by currentTagId
DB-->>G: Return tag or null if not found
G->>DB: Delete assignments for selectedTagIds
DB-->>G: Return deletion confirmation
G-->>C: Return processed tag or null on failure
Possibly related issues
Possibly related PRs
Suggested labels
Suggested reviewers
✨ Finishing Touches
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. 🪧 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: 31
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (9)
schema.graphql(4 hunks)src/drizzle/tables/tagAssignments.ts(1 hunks)src/drizzle/tables/users.ts(2 hunks)src/graphql/schema.graphql(1 hunks)src/graphql/types/Mutation/AddpeopleTag.ts(1 hunks)src/graphql/types/Mutation/assignToUserTag.ts(1 hunks)src/graphql/types/Mutation/index.ts(1 hunks)src/graphql/types/Mutation/removeFromUserTags.ts(1 hunks)src/index.ts(2 hunks)
🧰 Additional context used
🧠 Learnings (1)
src/graphql/types/Mutation/removeFromUserTags.ts (1)
Learnt from: meetulr
PR: PalisadoesFoundation/talawa-api#2616
File: src/resolvers/Mutation/removeFromUserTags.ts:136-152
Timestamp: 2025-04-10T12:10:06.081Z
Learning: Cycles cannot occur in the tag hierarchy in this project. Therefore, when traversing tags in functions like `removeFromUserTags` in `src/resolvers/Mutation/removeFromUserTags.ts`, infinite loops due to cyclic tag relationships are not a concern.
🧬 Code Graph Analysis (3)
src/graphql/types/Mutation/removeFromUserTags.ts (2)
src/graphql/builder.ts (1)
builder(10-20)src/drizzle/tables/tagAssignments.ts (1)
tagAssignmentsTable(16-64)
src/index.ts (2)
test/server.ts (1)
server(12-27)src/createServer.ts (1)
createServer(30-103)
src/graphql/types/Mutation/assignToUserTag.ts (4)
src/graphql/builder.ts (1)
builder(10-20)src/utilities/TalawaGraphQLError.ts (1)
TalawaGraphQLError(264-277)src/drizzle/tables/users.ts (1)
usersTable(60-217)src/drizzle/tables/tagAssignments.ts (1)
tagAssignmentsTable(16-64)
🪛 GitHub Actions: Pull request workflow
src/graphql/types/Mutation/index.ts
[error] 80-82: Formatter would have printed the following content: import "./AddpeopleTag"; import "./assignToUserTag"; import "./removeFromUserTags";
src/graphql/types/Mutation/removeFromUserTags.ts
[error] 3-3: 'TalawaGraphQLError' is declared but its value is never read.
[error] 15-15: 'validateTagActions' is declared but its value is never read.
[error] 28-28: Type '"Tag"' is not assignable to type 'TypeParam<ExtendDefaultTypes<{ Context: GraphQLContext; Scalars: CustomScalars; }>>'.
[error] 36-36: Type '(_parent: {}, args: { input: { currentTagId: string; selectedTagIds: string[]; }; }, ctx: ExplicitGraphQLContext & ImplicitMercuriusContext) => Promise<...>' is not assignable to type 'Resolver<{}, { input: { currentTagId: string; selectedTagIds: string[]; }; }, ExplicitGraphQLContext & ImplicitMercuriusContext, any, unknown>'.
[error] 45-45: Property 'equals' does not exist on type 'PgColumn<{ name: "id"; tableName: "tags"; dataType: "string"; columnType: "PgUUID"; data: string; driverParam: string; notNull: true; hasDefault: true; isPrimaryKey: true; isAutoincrement: false; hasRuntimeDefault: true; enumValues: undefined; baseColumn: never; identity: undefined; generated: undefined; }, {}, {}>'.
[error] 58-58: Property 'equals' does not exist on type 'PgColumn<{ name: "assignee_id"; tableName: "tag_assignments"; dataType: "string"; columnType: "PgUUID"; data: string; driverParam: string; notNull: true; hasDefault: false; isPrimaryKey: false; isAutoincrement: false; ... 4 more ...; generated: undefined; }, {}, {}>'.
src/index.ts
[error] 37-37: No overload matches this call.
[error] 43-43: Parameter 'options' implicitly has an 'any' type.
[error] 72-72: 'err' is of type 'unknown'.
[error] 73-73: 'err' is of type 'unknown'.
src/drizzle/tables/tagAssignments.ts
[error] 96-103: Formatter would have printed the following content: export const tagAssignmentsTableInsertSchema = createInsertSchema(tagAssignmentsTable, { assigneeId: (schema) => schema.uuid(), tagId: (schema) => schema.uuid(), creatorId: (schema) => schema.uuid().optional(), });
src/graphql/types/Mutation/AddpeopleTag.ts
[error] 9-12: Formatter would have printed the following content: const AddUserTagInputSchema = z.object({ tagId: z.string(), userId: z.string(), });
src/graphql/types/Mutation/assignToUserTag.ts
[error] 2-2: 'tagsTable' is declared but its value is never read.
[error] 4-4: 'eq' is declared but its value is never read.
[error] 51-51: Parameter 'fields' implicitly has an 'any' type.
[error] 51-51: Parameter 'operators' implicitly has an 'any' type.
[error] 110-110: Type '"not_found"' is not assignable to type '"invalid_arguments" | "arguments_associated_resources_not_found" | "forbidden_action" | "forbidden_action_on_arguments_associated_resources" | "unauthenticated" | "unauthorized_action" | "unauthorized_action_on_arguments_associated_resources" | "unauthorized_arguments" | "unexpected" | "too_many_requests"'.
[error] 123-123: Parameter 'user' implicitly has an 'any' type.
[error] 127-127: Parameter 'tx' implicitly has an 'any' type.
[error] 190-190: Type '"Tag"' is not assignable to type 'TypeParam<ExtendDefaultTypes<{ Context: GraphQLContext; Scalars: CustomScalars; }>>'.
🪛 Biome (1.9.4)
src/graphql/types/Mutation/removeFromUserTags.ts
[error] 15-15: Unexpected any. Specify a different type.
any disables many type checking rules. Its use should be avoided.
(lint/suspicious/noExplicitAny)
src/index.ts
[error] 43-49: This function expression can be turned into an arrow function.
Function expressions that don't use this can be turned into arrow functions.
Safe fix: Use an arrow function instead.
(lint/complexity/useArrowFunction)
src/graphql/types/Mutation/assignToUserTag.ts
[error] 26-26: Unexpected any. Specify a different type.
any disables many type checking rules. Its use should be avoided.
(lint/suspicious/noExplicitAny)
[error] 28-28: Unexpected any. Specify a different type.
any disables many type checking rules. Its use should be avoided.
(lint/suspicious/noExplicitAny)
[error] 65-65: Unexpected any. Specify a different type.
any disables many type checking rules. Its use should be avoided.
(lint/suspicious/noExplicitAny)
[error] 65-65: Unexpected any. Specify a different type.
any disables many type checking rules. Its use should be avoided.
(lint/suspicious/noExplicitAny)
[error] 103-103: Unexpected any. Specify a different type.
any disables many type checking rules. Its use should be avoided.
(lint/suspicious/noExplicitAny)
[error] 103-103: Unexpected any. Specify a different type.
any disables many type checking rules. Its use should be avoided.
(lint/suspicious/noExplicitAny)
[error] 119-119: Unexpected any. Specify a different type.
any disables many type checking rules. Its use should be avoided.
(lint/suspicious/noExplicitAny)
[error] 119-119: Unexpected any. Specify a different type.
any disables many type checking rules. Its use should be avoided.
(lint/suspicious/noExplicitAny)
[error] 144-144: Unexpected any. Specify a different type.
any disables many type checking rules. Its use should be avoided.
(lint/suspicious/noExplicitAny)
[error] 144-144: Unexpected any. Specify a different type.
any disables many type checking rules. Its use should be avoided.
(lint/suspicious/noExplicitAny)
[error] 180-180: Unexpected any. Specify a different type.
any disables many type checking rules. Its use should be avoided.
(lint/suspicious/noExplicitAny)
[error] 180-180: Unexpected any. Specify a different type.
any disables many type checking rules. Its use should be avoided.
(lint/suspicious/noExplicitAny)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Analyse Code With CodeQL (typescript)
🔇 Additional comments (7)
src/graphql/schema.graphql (3)
1-6: LGTM! The Tag type definition is well-structured.The Tag type includes essential fields for identification and organization relationships, which aligns with the requirements for user tag management.
8-14: Well-documented input type for tag operations.The
TagActionsInputtype is properly documented with clear descriptions for each field. Using non-nullable fields ensures the required data is always provided.
16-21: LGTM! The mutation definition looks good.The
removeFromUserTagsmutation is properly documented and requires the appropriate input type, maintaining consistency with the PR objectives.src/graphql/types/Mutation/assignToUserTag.ts (1)
126-159: Watch for possible collisions when creating placeholder users.The code creates placeholder users in a transaction if they do not exist. If there's a real user with the same email in the future, collisions could arise. Confirm that this behavior is intentional or consider generating unique placeholder emails.
🧰 Tools
🪛 Biome (1.9.4)
[error] 144-144: Unexpected any. Specify a different type.
any disables many type checking rules. Its use should be avoided.
(lint/suspicious/noExplicitAny)
[error] 144-144: Unexpected any. Specify a different type.
any disables many type checking rules. Its use should be avoided.
(lint/suspicious/noExplicitAny)
🪛 GitHub Actions: Pull request workflow
[error] 127-127: Parameter 'tx' implicitly has an 'any' type.
src/graphql/types/Mutation/AddpeopleTag.ts (2)
9-12: Address formatting per pipeline failure.The code formatter suggests a compact style for the schema definition. Please align with the recommended formatting to pass the pipeline check.
Below is the suggested formatting fix:
-const AddUserTagInputSchema = z.object({ - tagId: z.string(), - userId: z.string(), -}); +const AddUserTagInputSchema = z.object({ tagId: z.string(), userId: z.string() });🧰 Tools
🪛 GitHub Actions: Pull request workflow
[error] 9-12: Formatter would have printed the following content: const AddUserTagInputSchema = z.object({ tagId: z.string(), userId: z.string(), });
173-194: Good validation for existing assignments.The code effectively prevents duplicate assignments by checking
existingAssignment. This helps prevent data anomalies. Nice job!schema.graphql (1)
2411-2417: Functional synergy with the TS file.
AddUserTagInputmatches the input schema fromAddpeopleTag.ts. This consistency is good. Ensure references toassignUserTagin the resolvers reflect the correct type usage everywhere.
|
i am working on failing tests |
|
|
Apologies for the delay. I had exams recently, but I will address the failing tests as soon as possible. |
What kind of change does this PR introduce?
Feature: Added two new GraphQL mutations (
assignUserTagandremoveUserTag) to manage user tags from the frontend.Issue Number:
Fixes # #3398
Snapshots/Videos:
N/A
If relevant, did you update the documentation?
No
Summary
This PR implements the
ASSIGN_USER_TAGandREMOVE_USER_TAGGraphQL mutations in the backend. These mutations are required by theTagActionsfrontend component to assign or remove tags associated with users.Each mutation takes a
userIdand atagIdas input, performs necessary validations (e.g., verifying user and tag existence), updates the database, and returns the updated tag information.This solves the issue where the frontend TagActions modal would error due to the missing backend support.
Does this PR introduce a breaking change?
No
Checklist
CodeRabbit AI Review
Test Coverage
Other information
Have you read the contributing guide?
Yes
Summary by CodeRabbit
New Features
Chores