Skip to content

Conversation

defsanmith
Copy link
Contributor

@defsanmith defsanmith commented Jun 9, 2025

Add Chat Limits Feature

Closes #1952

This PR introduces a comprehensive chat limits feature that allows typebot owners to configure limits per day/week/month/total for their typebots. Once the configured limit is reached, new chat sessions are blocked and users see a "bot closed" message. This feature helps manage resource usage and provides better control over typebot interactions.

image

Changes Made

1. Schema Updates

File: /packages/settings/src/schemas.ts

  • Added chatLimitsSchema with validation for chat limits configuration
  • Includes isEnabled, limit, and limitType fields
  • Supports validation for limit >= 0 (where 0 means unlimited)

2. Constants Updates

File: /packages/settings/src/constants.ts

  • Added default chat limits settings in defaultSettings
  • Configured with sensible defaults (disabled by default)

3. UI Component Implementation

File: /apps/builder/src/features/settings/components/GeneralSettingsForm.tsx

  • Added chat limits configuration section in general settings
  • Includes toggle for enabling/disabling chat limits
  • Number input for setting the limit value
  • Dropdown for selecting limit type (daily/weekly/monthly/total)
  • Proper form validation and state management

4. Translation Support

File: /apps/builder/src/i18n/en.json

  • Added comprehensive translations for chat limits UI
  • Includes labels for all form fields and descriptions
  • User-friendly messaging for limit types and configurations

5. Backend Logic Implementation

File: /packages/bot-engine/src/startSession.ts

  • Implemented chat limits checking logic in session startup
  • Supports all limit types: daily, weekly, monthly, and total
  • Properly handles edge cases (limit = 0 as unlimited, undefined limits)
  • Integrates with existing bot closed messaging system
  • Uses efficient date-based querying for time-bounded limits

7. Database Query Support

File: /packages/bot-engine/src/queries/countResults.ts

  • Added optimized query function for counting results
  • Supports optional date filtering for time-based limits
  • Excludes archived results from counts
  • Efficient database querying with proper indexing

8. Comprehensive Test Coverage

File: /apps/viewer/src/test/chatLimits.spec.ts

  • Complete test suite following Playwright patterns used in codebase
  • Uses createTypebots() helper function for consistent test setup
  • Uses parseDefaultGroupWithBlock() for proper typebot structure
  • Comprehensive test coverage for all scenarios:
    • Disabled chat limits (should allow unlimited chats)
    • Daily limits (with proper date boundary testing)
    • Weekly limits (with week calculation verification)
    • Monthly limits (with month boundary testing)
    • Total limits (cumulative across all time)
    • Edge cases (limit = 0, undefined limit, archived results)
    • Custom bot closed messages
  • Verifies proper bot closure behavior when limits are exceeded

Copy link

vercel bot commented Jun 9, 2025

@defsanmith is attempting to deploy a commit to the Typebot Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

coderabbitai bot commented Jun 9, 2025

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • 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 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.

@defsanmith
Copy link
Contributor Author

@baptisteArno

Please note that these changes do not change the isClosed state of the Typebot to true, allowing it to accept responses after the specified period.

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.

Add the option to configure the chats limit per month until which the bots will be closed
1 participant