Skip to content

Fix onboarding conversation rules#846

Merged
elie222 merged 1 commit intomainfrom
fix/onboarding-conversation-rules
Oct 14, 2025
Merged

Fix onboarding conversation rules#846
elie222 merged 1 commit intomainfrom
fix/onboarding-conversation-rules

Conversation

@elie222
Copy link
Owner

@elie222 elie222 commented Oct 14, 2025

Summary by CodeRabbit

  • New Features

    • Onboarding now automatically creates or removes conversation-level rules—FYI, Awaiting Reply, and Actioned—based on your To Reply configuration, mirroring existing system rule behavior. This ensures consistent triage states and a smoother first-time setup experience.
  • Chores

    • Version updated to v2.16.5.

@vercel
Copy link

vercel bot commented Oct 14, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Updated (UTC)
inbox-zero Ready Ready Preview Oct 14, 2025 5:33pm

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 14, 2025

Walkthrough

Adds onboarding logic in apps/web/utils/actions/rule.ts to create or delete three conversation-level rules (FYI, AWAITING_REPLY, ACTIONED) based on the TO_REPLY system rule configuration. Also bumps version.txt from v2.16.4 to v2.16.5.

Changes

Cohort / File(s) Summary
Onboarding rule logic
apps/web/utils/actions/rule.ts
Introduces onboarding handling to mirror systemRules processing for TO_REPLY by creating/deleting conversation-specific rules: FYI, AWAITING_REPLY, ACTIONED, using existing isSet/config checks.
Version bump
version.txt
Updates version string from v2.16.4 to v2.16.5.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor User as Onboarding Trigger
  participant RuleActions as rule.ts (Onboarding)
  participant Config as SystemRules Config
  participant RuleSvc as Rule Service
  participant DB as Database

  User->>RuleActions: Start onboarding
  RuleActions->>Config: Read TO_REPLY config
  alt TO_REPLY is set
    loop For each of [FYI, AWAITING_REPLY, ACTIONED]
      RuleActions->>RuleSvc: createOrEnsure(ruleType)
      RuleSvc->>DB: upsert rule
      DB-->>RuleSvc: ok
      RuleSvc-->>RuleActions: ensured
    end
  else TO_REPLY not set
    loop For each of [FYI, AWAITING_REPLY, ACTIONED]
      RuleActions->>RuleSvc: deleteIfExists(ruleType)
      RuleSvc->>DB: delete rule
      DB-->>RuleSvc: ok
      RuleSvc-->>RuleActions: deleted
    end
  end
  RuleActions-->>User: Onboarding rules processed
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Poem

A nibble of logic, a hop through the queue,
Three little rules now follow TO_REPLY’s cue.
FYI whispers, Awaiting taps a paw,
Actioned bows neatly—code without flaw.
Version bumped lightly, thump-thump—hooray!
A rabbit signs off: ship it today. 🐇✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title succinctly communicates that the PR addresses corrections to the onboarding logic for conversation-specific rules. It directly references conversation rules, matching the added logic for FYI, AWAITING_REPLY, and ACTIONED onboarding rules in rule.ts. The phrasing is clear, concise, and focused on the main change without extraneous details.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix/onboarding-conversation-rules

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

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@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 (1)
apps/web/utils/actions/rule.ts (1)

470-483: Approve implementation with suggestions for cache invalidation.

The conversation rules logic correctly ties FYI, AWAITING_REPLY, and ACTIONED rules to the TO_REPLY configuration, which makes sense from a product perspective—conversation state tracking is only needed when replying is enabled.

Consider adding revalidatePath calls after the onboarding completes to ensure the UI reflects the newly created rules:

  await Promise.allSettled(promises);
+
+ revalidatePath(prefixPath(emailAccountId, "/assistant"));
+ revalidatePath(prefixPath(emailAccountId, "/automation"));

Additionally, the conversation rules loop is nearly identical to the system rules loop (lines 451-468). As an optional improvement, consider extracting a helper function to reduce duplication:

function processRulesByConfig(
  ruleTypes: SystemType[],
  getConfig: (type: SystemType) => CategoryConfig | undefined,
  emailAccountId: string
) {
  for (const type of ruleTypes) {
    const config = getConfig(type);
    if (config && isSet(config.action)) {
      createRule(type);
    } else {
      deleteRule(type, emailAccountId);
    }
  }
}

// Usage:
processRulesByConfig(systemRules, (type) => systemCategoryMap.get(type), emailAccountId);
processRulesByConfig(conversationRules, () => systemCategoryMap.get(SystemType.TO_REPLY), emailAccountId);
📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0a43794 and 5b92664.

📒 Files selected for processing (2)
  • apps/web/utils/actions/rule.ts (1 hunks)
  • version.txt (1 hunks)
🧰 Additional context used
📓 Path-based instructions (10)
!{.cursor/rules/*.mdc}

📄 CodeRabbit inference engine (.cursor/rules/cursor-rules.mdc)

Never place rule files in the project root, in subdirectories outside .cursor/rules, or in any other location

Files:

  • version.txt
  • apps/web/utils/actions/rule.ts
!pages/_document.{js,jsx,ts,tsx}

📄 CodeRabbit inference engine (.cursor/rules/ultracite.mdc)

!pages/_document.{js,jsx,ts,tsx}: Don't import next/document outside of pages/_document.jsx in Next.js projects.
Don't import next/document outside of pages/_document.jsx in Next.js projects.

Files:

  • version.txt
  • apps/web/utils/actions/rule.ts
apps/web/**/*.{ts,tsx}

📄 CodeRabbit inference engine (apps/web/CLAUDE.md)

apps/web/**/*.{ts,tsx}: Use TypeScript with strict null checks
Path aliases: Use @/ for imports from project root
Use proper error handling with try/catch blocks
Format code with Prettier
Leverage TypeScript inference for better DX

Files:

  • apps/web/utils/actions/rule.ts
apps/web/utils/actions/**/*.ts

📄 CodeRabbit inference engine (apps/web/CLAUDE.md)

apps/web/utils/actions/**/*.ts: Use server actions for all mutations (create/update/delete operations)
next-safe-action provides centralized error handling
Use Zod schemas for validation on both client and server
Use revalidatePath in server actions for cache invalidation

apps/web/utils/actions/**/*.ts: Use server actions (with next-safe-action) for all mutations (create/update/delete operations); do NOT use POST API routes for mutations.
Use revalidatePath in server actions to invalidate cache after mutations.

Files:

  • apps/web/utils/actions/rule.ts
**/*.ts

📄 CodeRabbit inference engine (.cursor/rules/form-handling.mdc)

**/*.ts: The same validation should be done in the server action too
Define validation schemas using Zod

Files:

  • apps/web/utils/actions/rule.ts
**/*.{ts,tsx}

📄 CodeRabbit inference engine (.cursor/rules/logging.mdc)

**/*.{ts,tsx}: Use createScopedLogger for logging in backend TypeScript files
Typically add the logger initialization at the top of the file when using createScopedLogger
Only use .with() on a logger instance within a specific function, not for a global logger

Import Prisma in the project using import prisma from "@/utils/prisma";

**/*.{ts,tsx}: Don't use TypeScript enums.
Don't use TypeScript const enum.
Don't use the TypeScript directive @ts-ignore.
Don't use primitive type aliases or misleading types.
Don't use empty type parameters in type aliases and interfaces.
Don't use any or unknown as type constraints.
Don't use implicit any type on variable declarations.
Don't let variables evolve into any type through reassignments.
Don't use non-null assertions with the ! postfix operator.
Don't misuse the non-null assertion operator (!) in TypeScript files.
Don't use user-defined types.
Use as const instead of literal types and type annotations.
Use export type for types.
Use import type for types.
Don't declare empty interfaces.
Don't merge interfaces and classes unsafely.
Don't use overload signatures that aren't next to each other.
Use the namespace keyword instead of the module keyword to declare TypeScript namespaces.
Don't use TypeScript namespaces.
Don't export imported variables.
Don't add type annotations to variables, parameters, and class properties that are initialized with literal expressions.
Don't use parameter properties in class constructors.
Use either T[] or Array consistently.
Initialize each enum member value explicitly.
Make sure all enum members are literal values.

Files:

  • apps/web/utils/actions/rule.ts
apps/web/utils/actions/*.ts

📄 CodeRabbit inference engine (.cursor/rules/server-actions.mdc)

apps/web/utils/actions/*.ts: Implement all server actions using the next-safe-action library for type safety, input validation, context management, and error handling. Refer to apps/web/utils/actions/safe-action.ts for client definitions (actionClient, actionClientUser, adminActionClient).
Use actionClientUser when only authenticated user context (userId) is needed.
Use actionClient when both authenticated user context and a specific emailAccountId are needed. The emailAccountId must be bound when calling the action from the client.
Use adminActionClient for actions restricted to admin users.
Access necessary context (like userId, emailAccountId, etc.) provided by the safe action client via the ctx object in the .action() handler.
Server Actions are strictly for mutations (operations that change data, e.g., creating, updating, deleting). Do NOT use Server Actions for data fetching (GET operations). For data fetching, use dedicated GET API Routes combined with SWR Hooks.
Use SafeError for expected/handled errors within actions if needed. next-safe-action provides centralized error handling.
Use the .metadata({ name: "actionName" }) method to provide a meaningful name for monitoring. Sentry instrumentation is automatically applied via withServerActionInstrumentation within the safe action clients.
If an action modifies data displayed elsewhere, use revalidatePath or revalidateTag from next/cache within the action handler as needed.

Server action files must start with use server

Files:

  • apps/web/utils/actions/rule.ts
apps/web/utils/**

📄 CodeRabbit inference engine (.cursor/rules/project-structure.mdc)

Create utility functions in utils/ folder for reusable logic

Files:

  • apps/web/utils/actions/rule.ts
apps/web/utils/**/*.ts

📄 CodeRabbit inference engine (.cursor/rules/project-structure.mdc)

apps/web/utils/**/*.ts: Use lodash utilities for common operations (arrays, objects, strings)
Import specific lodash functions to minimize bundle size

Files:

  • apps/web/utils/actions/rule.ts
**/*.{js,jsx,ts,tsx}

📄 CodeRabbit inference engine (.cursor/rules/ultracite.mdc)

**/*.{js,jsx,ts,tsx}: Don't use elements in Next.js projects.
Don't use elements in Next.js projects.
Don't use namespace imports.
Don't access namespace imports dynamically.
Don't use global eval().
Don't use console.
Don't use debugger.
Don't use var.
Don't use with statements in non-strict contexts.
Don't use the arguments object.
Don't use consecutive spaces in regular expression literals.
Don't use the comma operator.
Don't use unnecessary boolean casts.
Don't use unnecessary callbacks with flatMap.
Use for...of statements instead of Array.forEach.
Don't create classes that only have static members (like a static namespace).
Don't use this and super in static contexts.
Don't use unnecessary catch clauses.
Don't use unnecessary constructors.
Don't use unnecessary continue statements.
Don't export empty modules that don't change anything.
Don't use unnecessary escape sequences in regular expression literals.
Don't use unnecessary labels.
Don't use unnecessary nested block statements.
Don't rename imports, exports, and destructured assignments to the same name.
Don't use unnecessary string or template literal concatenation.
Don't use String.raw in template literals when there are no escape sequences.
Don't use useless case statements in switch statements.
Don't use ternary operators when simpler alternatives exist.
Don't use useless this aliasing.
Don't initialize variables to undefined.
Don't use the void operators (they're not familiar).
Use arrow functions instead of function expressions.
Use Date.now() to get milliseconds since the Unix Epoch.
Use .flatMap() instead of map().flat() when possible.
Use literal property access instead of computed property access.
Don't use parseInt() or Number.parseInt() when binary, octal, or hexadecimal literals work.
Use concise optional chaining instead of chained logical expressions.
Use regular expression literals instead of the RegExp constructor when possible.
Don't use number literal object member names th...

Files:

  • apps/web/utils/actions/rule.ts
🧬 Code graph analysis (1)
apps/web/utils/actions/rule.ts (1)
apps/web/utils/rule/rule.ts (2)
  • createRule (190-252)
  • deleteRule (329-345)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: cubic · AI code reviewer
🔇 Additional comments (1)
version.txt (1)

1-1: LGTM!

Version bump aligns with the onboarding conversation rules enhancement.

Copy link
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

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

1 issue found across 2 files

Prompt for AI agents (all 1 issues)

Understand the root cause of the following 1 issues and fix them.


<file name="apps/web/utils/actions/rule.ts">

<violation number="1" location="apps/web/utils/actions/rule.ts:477">
Conversation-rule config lookup always fetches the TO_REPLY configuration, so FYI/AWAITING_REPLY/ACTIONED onboarding rules are created or removed based on the wrong category. Use the current type when querying systemCategoryMap.</violation>
</file>

React with 👍 or 👎 to teach cubic. Mention @cubic-dev-ai to give feedback, ask questions, or re-run the review.

@elie222 elie222 merged commit a3da37a into main Oct 14, 2025
17 checks passed
@coderabbitai coderabbitai bot mentioned this pull request Nov 13, 2025
@elie222 elie222 deleted the fix/onboarding-conversation-rules branch December 18, 2025 23:06
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