fix(wren-ai-service): delete instructions

[cyyeh]

Summary by CodeRabbit

• Refactor
  • Updated our process to automatically apply a safe default when optional instructions aren’t provided. This enhancement improves system stability and consistency, ensuring a smoother and more reliable user experience during operations. Users may benefit from more predictable behavior without needing manual configuration.

[coderabbitai]

Walkthrough

The pull request updates the clean method in the Instructions class by changing the instructions parameter from a required list to an optional one with a default value of None. Within the method, the value is then normalized using instructions or [], ensuring that an empty list is used when no instructions are provided. The changes affect both the method’s signature and its call site.

Changes

File	Change Summary
wren-ai-service/.../instructions.py	Updated the clean method signature in the Instructions class to use Optional[List[Instruction]] = None for the instructions parameter, and modified the method call to use instructions or [].

Poem

I’m a rabbit with code so neat,
Hopping through changes, light on my feet.
Parameters now optional, logic refined,
No more worries of None to find.
Carrots and code, perfectly aligned! 🐇

---

📜 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 39a7bea and fb2c518.

📒 Files selected for processing (1)

• wren-ai-service/src/pipelines/indexing/instructions.py (1 hunks)

🧰 Additional context used

🧠 Learnings (1)

wren-ai-service/src/pipelines/indexing/instructions.py (1)

Learnt from: paopa
PR: Canner/WrenAI#1376
File: wren-ai-service/src/pipelines/indexing/instructions.py:100-107
Timestamp: 2025-03-27T09:01:59.977Z
Learning: The `InstructionsCleaner.run()` method in the instructions indexing pipeline only accepts `instruction_ids` and `project_id` parameters, and doesn't support a `delete_all` parameter for unconditional deletion.

🧬 Code Definitions (1)

wren-ai-service/src/pipelines/indexing/instructions.py (2)

wren-ai-service/src/web/v1/services/instructions.py (1)

• Instruction (17-22)

wren-ai-service/src/pipelines/indexing/sql_pairs.py (2)

• clean (125-136)
• clean (216-227)

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

• GitHub Check: pytest
• GitHub Check: pytest
• GitHub Check: Analyze (javascript-typescript)
• GitHub Check: Analyze (go)

🔇 Additional comments (2)

wren-ai-service/src/pipelines/indexing/instructions.py (2)

169-169: Approved: Making instructions optional improves API flexibility

This change allows the clean method to be called without providing an instructions list, which is especially useful when only the delete_all flag is needed to clear instructions. The type annotation correctly uses Optional to indicate this parameter is not required.

---

174-174: Approved: Using instructions or [] handles the None case properly

Good use of the or operator to provide a fallback empty list when instructions is None. This ensures the inner clean function always receives a list to work with, preventing potential errors when extracting instruction IDs.

✨ 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

• 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.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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.