Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduce size limit to activity attributes on ingestion #2737

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

epipav
Copy link
Collaborator

@epipav epipav commented Jan 2, 2025

Changes proposed ✍️

What

copilot:summary

copilot:poem

Why

How

copilot:walkthrough

Checklist ✅

  • Label appropriately with Feature, Improvement, or Bug.
  • Add screenshots to the PR description for relevant FE changes
  • New backend functionality has been unit-tested.
  • API documentation has been updated (if necessary) (see docs on API documentation).
  • Quality standards are met.

Summary by CodeRabbit

  • Bug Fixes
    • Implemented size validation for large objects to prevent potential processing issues
    • Added safeguard to limit object size to 2000 bytes in data transformation process

Copy link

coderabbitai bot commented Jan 2, 2025

Walkthrough

The pull request introduces a modification to the objectToBytes function in the ilp.ts file. The new implementation adds a size check mechanism that prevents returning objects larger than 2000 bytes. If the stringified object exceeds this limit, the function will return an empty JSON object string. This change aims to manage potential data size issues during object processing, maintaining the existing function's core logic while adding a protective size constraint.

Changes

File Change Summary
services/libs/data-access-layer/src/activities/ilp.ts Added size check in objectToBytes function to limit JSON object size to 2000 bytes

Poem

🐰 In bytes we trust, with limits so neat
A rabbit's code, now trim and fleet
Two thousand bytes, our boundary line
Large objects shrink, everything's fine
Data dancing, compact and bright! 🔍


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

@epipav epipav changed the title Reduce auto_flush_rows to 5k Introduce size limit to activity attributes Jan 3, 2025
@epipav epipav marked this pull request as ready for review January 3, 2025 12:52
@epipav epipav changed the title Introduce size limit to activity attributes Introduce size limit to activity attributes on ingestion Jan 3, 2025
Copy link

@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)
services/libs/data-access-layer/src/activities/ilp.ts (1)

219-221: Evaluate returning partial data rather than an empty object.

Returning an empty JSON object may result in loss of data that could be valuable. Truncating or partially storing the object could strike a balance between size constraints and data retention.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 730fcbb and f079e76.

📒 Files selected for processing (1)
  • services/libs/data-access-layer/src/activities/ilp.ts (1 hunks)
🔇 Additional comments (1)
services/libs/data-access-layer/src/activities/ilp.ts (1)

216-217: Consider robust error handling when stringifying.

In rare cases, stringification may fail if the object contains circular references. It might be safer to wrap JSON.stringify in a try/catch or skip such problematic data.

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