Skip to content

fix(controllers): allow decline join request to remove outdated records #1630

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

Merged
merged 3 commits into from
May 23, 2025

Conversation

rhahao
Copy link
Member

@rhahao rhahao commented May 23, 2025

No description provided.

Copy link

coderabbitai bot commented May 23, 2025

Walkthrough

The deployment workflows in GitHub Actions were updated to replace Heroku with Koyeb for service deployment and redeployment. Additionally, the congregation administration controller's user removal logic was changed to use congregation-specific removal instead of global deletion, and a join request deletion function no longer checks for user existence before declining the request.

Changes

File(s) Change Summary
.github/workflows/deploy.yml, .github/workflows/redeploy.yml Switched deployment and redeployment workflows from Heroku to Koyeb by replacing Heroku CLI/actions with Koyeb CLI and commands.
src/v3/controllers/congregation_admin_controller.ts Changed user removal to congregation-specific logic and removed explicit user existence check in join request deletion.

Sequence Diagram(s)

sequenceDiagram
    participant Admin as Congregation Admin
    participant Controller as congregation_admin_controller.ts
    participant User as User Instance
    participant Congregation as Congregation

    Admin->>Controller: congregationDeleteUser(userId)
    Controller->>User: removeCongregation()
    User-->>Controller: (User removed from congregation)
    Controller-->>Admin: Success/Failure response
Loading
sequenceDiagram
    participant Admin as Congregation Admin
    participant Controller as congregation_admin_controller.ts
    participant Congregation as Congregation

    Admin->>Controller: deleteJoinRequest(userId)
    Controller->>Congregation: declineJoinRequest(userId)
    Congregation-->>Controller: (Join request declined)
    Controller-->>Admin: Success/Failure response
Loading
sequenceDiagram
    participant GitHubActions
    participant KoyebCLI
    participant KoyebService

    GitHubActions->>KoyebCLI: Install and authenticate with API token
    GitHubActions->>KoyebCLI: Redeploy service (service name from secrets)
    KoyebCLI->>KoyebService: Trigger redeployment
    KoyebService-->>KoyebCLI: Deployment status
    KoyebCLI-->>GitHubActions: Deployment result
Loading

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

npm warn config production Use --omit=dev instead.
npm error Exit handler never called!
npm error This is an error with npm itself. Please report this error at:
npm error https://github.com/npm/cli/issues
npm error A complete log of this run can be found in: /.npm/_logs/2025-05-23T09_56_25_918Z-debug-0.log

✨ Finishing Touches
  • 📝 Generate Docstrings

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:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • 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 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.

Copy link

Copy link

@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

🧹 Nitpick comments (2)
.github/workflows/deploy.yml (1)

42-48: Fix typo in step name and consider environment variable naming consistency.

There's a typo in the step name "Deploy API to Koeyb" - it should be "Deploy API to Koyeb". Additionally, the environment variable names use "KOEYB" instead of "KOYEB", which is inconsistent with the actual service name.

Apply this diff to fix the typo:

-      - name: Deploy API to Koeyb
+      - name: Deploy API to Koyeb

Consider whether the environment variable names should be updated to use "KOYEB" for consistency, or if "KOEYB" is intentionally used to match existing secret names.

.github/workflows/redeploy.yml (1)

22-28: Fix typo in step name and maintain consistency with deploy.yml.

Same issue as in the deploy workflow - there's a typo in "Deploy API to Koeyb" which should be "Deploy API to Koyeb". The environment variable naming should also be consistent across both workflows.

Apply this diff to fix the typo:

-      - name: Deploy API to Koeyb
+      - name: Deploy API to Koyeb

Ensure the environment variable naming is consistent with the deploy.yml workflow.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between afa64d7 and 319036f.

📒 Files selected for processing (3)
  • .github/workflows/deploy.yml (2 hunks)
  • .github/workflows/redeploy.yml (1 hunks)
  • src/v3/controllers/congregation_admin_controller.ts (1 hunks)
🔇 Additional comments (2)
src/v3/controllers/congregation_admin_controller.ts (2)

729-729: Excellent scope refinement for user removal.

This change properly scopes the user removal to congregation-specific removal rather than global deletion. This is more appropriate for congregation admin functionality and prevents admins from accidentally deleting user accounts entirely.


913-915:

✅ Verification successful

Verify error handling in downstream join request decline logic.

The removal of the user existence check aligns with the PR objective to "allow decline join request to remove outdated records." This enables cleanup of orphaned join requests where the user account may have been deleted but join requests remain.

Please verify that the cong.declineJoinRequest(userId) method handles cases where the user doesn't exist gracefully, and that no unhandled errors will be thrown downstream.


🏁 Script executed:

#!/bin/bash
# Description: Check the implementation of declineJoinRequest method to verify error handling
# Expected: Method should handle non-existent users gracefully

# Search for the declineJoinRequest method implementation
ast-grep --pattern $'declineJoinRequest($userId) {
  $$$
}'

# Also search for any error handling patterns in join request methods
rg -A 10 "declineJoinRequest|decline.*join.*request" --type ts

Length of output: 2028


DeclineJoinRequest handles missing users gracefully

I reviewed the implementation in src/v3/classes/Congregation.ts:

  • The declineJoinRequest(user) method filters this.join_requests to remove any record matching the given user ID, regardless of whether that user still exists.
  • It also drops any stale requests whose record.user is no longer found in UsersList.list.
  • The updated list is then saved via setCongJoinRequests and assigned back to this.join_requests.

Because it merely filters and persists the array, no errors are thrown if the passed-in userId doesn’t exist. No additional error handling is required here.

@rhahao rhahao merged commit 1f913a4 into sws2apps:main May 23, 2025
12 checks passed
@rhahao
Copy link
Member Author

rhahao commented May 23, 2025

🎉 This PR is included in version 3.25.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

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

Successfully merging this pull request may close these issues.

1 participant