Make marking completions as registered not to crash if a completion has been deleted before the marking has succeeded

[nygrenh]

Summary by CodeRabbit

• Bug Fixes
  • Updated query to retrieve course module completions, now including soft-deleted records to prevent potential retrieval process interruptions.

[coderabbitai]

Walkthrough

The pull request modifies the SQL query for retrieving course module completions by removing the deleted_at IS NULL condition. This change allows fetching all course module completions, including soft-deleted records. The modification is implemented in both the SQL query JSON configuration and the Rust source code for the get_by_ids function, ensuring that the retrieval process can handle completions that might have been deleted before being retrieved from the study registry.

Changes

File	Change Summary
services/headless-lms/models/.sqlx/query-*.json	Updated query hash and removed deleted_at IS NULL condition
services/headless-lms/models/src/course_module_completions.rs	Modified get_by_ids function to retrieve completions without filtering deleted records

Sequence Diagram

sequenceDiagram
    participant Client
    participant GetByIdsFunction
    participant Database
    
    Client->>GetByIdsFunction: Request completions by IDs
    GetByIdsFunction->>Database: Query with ALL record IDs
    Database-->>GetByIdsFunction: Return records (including deleted)
    GetByIdsFunction-->>Client: Return course module completions

Loading

Possibly related PRs

• Pass either an empty string or timestamp to mailchimp graduated field #1358: Changes to SQL queries related to course completion status
• Mailchimp syncer checks if user has completed course #1365: Modifications to SQL queries involving user marketing consents and course completions
• Peer review queue changes #1375: SQL query changes for peer review entries

Suggested labels

headless-lms

Poem

🐰 A Rabbit's Query Tale 🔍

Soft-deleted records, once hidden from sight,
Now emerge from the database's light
No NULL condition to hold them at bay
All completions can now have their say!
A query transformed, with wisdom so neat

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 660bdf4 and ac44676.

📒 Files selected for processing (2)

• services/headless-lms/models/.sqlx/query-d33b4857d2fddb3611d4ad17ea527321c55f43c5c1d3aadc646876b41b1beb01.json (2 hunks)
• services/headless-lms/models/src/course_module_completions.rs (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (3)

• GitHub Check: headless_lms
• GitHub Check: build-and-deploy
• GitHub Check: build

🔇 Additional comments (2)

services/headless-lms/models/src/course_module_completions.rs (1)

Line range hint 161-174: Implementation looks good and aligns with PR objectives.

The function deliberately omits the deleted_at IS NULL condition to handle soft-deleted completions, which aligns with the goal of preventing crashes when marking completions as registered.

Let's verify that this change doesn't introduce unintended side effects by checking the usage of this function:

✅ Verification successful

Implementation is correct and well-designed for handling race conditions

The deliberate omission of deleted_at IS NULL in get_by_ids is a safety measure to prevent crashes during the study registry registration flow, specifically when a completion might be deleted between retrieval and registration. The function is only used in this controlled context and its behavior is explicitly documented.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check where get_by_ids is used and how the results are handled

# Find direct function calls
echo "Direct function calls:"
rg "get_by_ids\(" -A 5

# Find potential places where soft-deleted completions might cause issues
echo -e "\nPotential risk areas:"
rg "deleted_at IS NULL.*course_module_completion" -A 5

Length of output: 8865

---

Script:

#!/bin/bash
# Description: Find relevant implementations and usages

# Find get_all_by_user_id implementation
echo "get_all_by_user_id implementation:"
ast-grep --pattern 'pub async fn get_all_by_user_id($$$) {
  $$$
}'

# Find code related to marking completions as registered
echo -e "\nCode related to marking completions as registered:"
rg -i "mark.*registered|register.*completion" -A 5

# Find other functions handling soft-deleted completions
echo -e "\nOther functions handling soft-deleted completions:"
rg "deleted_at|soft.*delet" -A 5 services/headless-lms/models/src/course_module_completions.rs

Length of output: 74764

services/headless-lms/models/.sqlx/query-d33b4857d2fddb3611d4ad17ea527321c55f43c5c1d3aadc646876b41b1beb01.json (1)

3-3: SQL query changes look good.

The query metadata correctly reflects the changes made to the get_by_ids function, with the deleted_at IS NULL condition removed and the hash updated accordingly.

Also applies to: 121-121

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 generate docstrings to generate docstrings for this PR. (Beta)
• @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.