Skip to content

Allow piping as OR#475

Merged
elie222 merged 1 commit intomainfrom
feat/pipe-or
Jun 3, 2025
Merged

Allow piping as OR#475
elie222 merged 1 commit intomainfrom
feat/pipe-or

Conversation

@elie222
Copy link
Owner

@elie222 elie222 commented Jun 3, 2025

Summary by CodeRabbit

  • New Features
    • Enhanced rule matching to support OR logic with the pipe (|) symbol in the FROM and TO fields, allowing multiple email addresses or domains to be matched by a single rule.
  • Bug Fixes
    • Pipe symbols in SUBJECT and BODY fields are now treated as literal characters, ensuring accurate rule matching.
  • Documentation
    • Updated guidance to clarify the behavior of the pipe symbol in rule conditions.
  • Tests
    • Added comprehensive test cases to verify correct handling of pipe symbols and complex matching scenarios.
  • Chores
    • Updated version number to v1.3.3.

@vercel
Copy link

vercel bot commented Jun 3, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
inbox-zero ✅ Ready (Inspect) Visit Preview Jun 3, 2025 11:11pm

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jun 3, 2025

Walkthrough

The changes refine the pattern-matching logic for email rule conditions, updating both implementation and documentation to clarify that the pipe (|) character acts as an OR operator only in the from and to fields. Comprehensive new tests were added, and the version number was incremented.

Changes

File(s) Change Summary
apps/web/utils/ai/assistant/chat.ts Updated documentation to specify pipe (`
apps/web/utils/ai/choose-rule/match-rules.ts Modified matchesStaticRule and helper to support pipe-as-OR only for from/to fields.
apps/web/utils/ai/choose-rule/match-rules.test.ts Added extensive tests for pipe handling in patterns, covering both positive and negative scenarios.
version.txt Updated version from v1.3.2 to v1.3.3.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant matchesStaticRule
    participant safeRegexTest

    User->>matchesStaticRule: Call with rule and message
    alt Field is from or to
        matchesStaticRule->>safeRegexTest: allowPipeAsOr = true
        safeRegexTest->>safeRegexTest: Split pattern by '|'
        loop For each pattern part
            safeRegexTest->>safeRegexTest: Escape, convert wildcards, test match
            alt Match found
                safeRegexTest-->>matchesStaticRule: Return true
            end
        end
        safeRegexTest-->>matchesStaticRule: Return false if no match
    else Field is subject or body
        matchesStaticRule->>safeRegexTest: allowPipeAsOr = false
        safeRegexTest->>safeRegexTest: Treat pattern as literal (no split)
        safeRegexTest-->>matchesStaticRule: Return match result
    end
    matchesStaticRule-->>User: Return overall match (true/false)
Loading

Possibly related PRs

  • Adjust static matching #473: Improves wildcard and special character handling in patterns, which is related to the pattern-matching logic but does not introduce pipe-as-OR logic or differentiate fields for pipe usage.

Poem

A pipe in the subject? It’s just a plain line,
But in from and to, it’s an OR—how divine!
New tests now abound,
And clarity’s found,
With v1.3.3, our rules intertwine.
— 🐇

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.

apps/web/utils/ai/choose-rule/match-rules.test.ts

Oops! Something went wrong! :(

ESLint: 9.28.0

ESLint couldn't find an eslint.config.(js|mjs|cjs) file.

From ESLint v9.0.0, the default configuration file is now eslint.config.js.
If you are using a .eslintrc.* file, please follow the migration guide
to update your configuration file to the new format:

https://eslint.org/docs/latest/use/configure/migration-guide

If you still have problems after following the migration guide, please stop by
https://eslint.org/chat/help to chat with the team.

apps/web/utils/ai/assistant/chat.ts

Oops! Something went wrong! :(

ESLint: 9.28.0

ESLint couldn't find an eslint.config.(js|mjs|cjs) file.

From ESLint v9.0.0, the default configuration file is now eslint.config.js.
If you are using a .eslintrc.* file, please follow the migration guide
to update your configuration file to the new format:

https://eslint.org/docs/latest/use/configure/migration-guide

If you still have problems after following the migration guide, please stop by
https://eslint.org/chat/help to chat with the team.

apps/web/utils/ai/choose-rule/match-rules.ts

Oops! Something went wrong! :(

ESLint: 9.28.0

ESLint couldn't find an eslint.config.(js|mjs|cjs) file.

From ESLint v9.0.0, the default configuration file is now eslint.config.js.
If you are using a .eslintrc.* file, please follow the migration guide
to update your configuration file to the new format:

https://eslint.org/docs/latest/use/configure/migration-guide

If you still have problems after following the migration guide, please stop by
https://eslint.org/chat/help to chat with the team.


📜 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 babeaec and 6907b1e.

📒 Files selected for processing (4)
  • apps/web/utils/ai/assistant/chat.ts (1 hunks)
  • apps/web/utils/ai/choose-rule/match-rules.test.ts (1 hunks)
  • apps/web/utils/ai/choose-rule/match-rules.ts (1 hunks)
  • version.txt (1 hunks)
🔇 Additional comments (5)
version.txt (1)

1-1: LGTM!

Appropriate version increment for the new pipe OR functionality.

apps/web/utils/ai/assistant/chat.ts (1)

220-222: LGTM!

Clear documentation that accurately describes the new pipe OR functionality. The distinction between email address fields (FROM/TO) using OR logic and content fields (SUBJECT) using literal matching is well explained.

apps/web/utils/ai/choose-rule/match-rules.test.ts (1)

247-484: Excellent comprehensive test coverage!

The test suite thoroughly covers all aspects of the new pipe OR functionality:

  • ✅ Basic OR logic in FROM and TO fields
  • ✅ Wildcards combined with pipe patterns
  • ✅ Literal pipe treatment in SUBJECT and BODY fields
  • ✅ Edge cases (empty patterns, leading/trailing pipes)
  • ✅ Mixed condition scenarios
  • ✅ Complex email patterns with special characters

This level of test coverage ensures the feature works correctly and helps prevent regressions.

apps/web/utils/ai/choose-rule/match-rules.ts (2)

275-305: Well-implemented pipe OR functionality!

The safeRegexTest enhancement is cleanly designed:

  • ✅ Clean separation with allowPipeAsOr parameter
  • ✅ Proper regex escaping prevents injection attacks
  • ✅ Maintains existing wildcard support (*.*)
  • ✅ Robust error handling for invalid patterns
  • ✅ Efficient pattern splitting and testing logic

The implementation correctly handles edge cases like empty patterns between pipes and maintains backward compatibility.


307-316: Correct application of pipe OR logic!

Perfect implementation of the documented behavior:

  • ✅ FROM and TO fields use allowPipeAsOr=true for OR logic
  • ✅ SUBJECT and BODY fields use allowPipeAsOr=false for literal matching
  • ✅ Maintains existing AND logic between different field types

This aligns exactly with the documentation update and test cases.

✨ 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

@cursor cursor bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ BugBot reviewed your changes and found no bugs!


BugBot free trial expires on June 9, 2025
You have used $0.00 of your $50.00 spend limit so far. Manage your spend limit in the Cursor dashboard.

Was this report helpful? Give feedback by reacting with 👍 or 👎

@elie222 elie222 merged commit f337521 into main Jun 3, 2025
7 checks passed
@elie222 elie222 deleted the feat/pipe-or branch June 3, 2025 23:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant