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

feat: ingestion limits - add toggle feature #6430

Merged
merged 1 commit into from
Nov 15, 2024

Conversation

YounixM
Copy link
Member

@YounixM YounixM commented Nov 12, 2024

https://signoz-team.slack.com/archives/C02C7P6KE06/p1731427069496209?thread_ts=1731409354.155829&cid=C02C7P6KE06


Important

Add toggle feature for enabling/disabling daily and per-second ingestion limits with UI and data structure updates.

  • Behavior:
    • Added toggle feature for daily and per-second limits in MultiIngestionSettings.tsx using Switch component.
    • If no limits are set, the edit view closes without saving.
  • Data Handling:
    • Updated LimitProps, AddLimitProps, and UpdateLimitProps in types.ts to include enabled boolean for day and second limits.
    • Modified handleAddLimit and handleUpdateLimit functions to handle the new toggle state.
  • UI Changes:
    • Updated styles in IngestionSettings.styles.scss to accommodate new toggle layout.
    • Added visual indication for "NO LIMIT" state in the UI.

This description was created by Ellipsis for 6f09478. It will automatically update as commits are pushed.

@github-actions github-actions bot added docs required enhancement New feature or request labels Nov 12, 2024
Copy link

Build Error! No Linked Issue found. Please link an issue or mention it in the body using #<issue_id>

1 similar comment
Copy link

Build Error! No Linked Issue found. Please link an issue or mention it in the body using #<issue_id>

Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

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

👍 Looks good to me! Reviewed everything up to 6f09478 in 1 minute and 39 seconds

More details
  • Looked at 449 lines of code in 3 files
  • Skipped 0 files when reviewing.
  • Skipped posting 9 drafted comments based on config settings.
1. frontend/src/container/IngestionSettings/MultiIngestionSettings.tsx:428
  • Draft comment:
    Consider refactoring the repeated logic for setting payload.config in handleAddLimit and handleUpdateLimit functions to improve code readability and maintainability.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The code in MultiIngestionSettings.tsx has a repeated logic for setting the payload.config object in both handleAddLimit and handleUpdateLimit functions. This can be refactored to improve code readability and maintainability.
2. frontend/src/container/IngestionSettings/MultiIngestionSettings.tsx:477
  • Draft comment:
    Consider refactoring the repeated logic for checking undefined limits and setting payload.config in handleAddLimit and handleUpdateLimit functions to avoid code duplication.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The handleAddLimit and handleUpdateLimit functions in MultiIngestionSettings.tsx have similar logic for checking undefined limits and setting the payload. This can be refactored to avoid code duplication.
3. frontend/src/container/IngestionSettings/MultiIngestionSettings.tsx:522
  • Draft comment:
    The logic for setting the enabled property based on the presence of size is repeated. Consider extracting this logic into a utility function for better code reuse.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    In MultiIngestionSettings.tsx, the enableEditLimitMode function sets the enabled property based on the presence of size. This logic is repeated in multiple places and can be extracted into a utility function for better code reuse.
4. frontend/src/container/IngestionSettings/MultiIngestionSettings.tsx:434
  • Draft comment:
    Ensure that the input values for dailyLimit and secondsLimit are validated before conversion to prevent unexpected behavior.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    In MultiIngestionSettings.tsx, the handleAddLimit and handleUpdateLimit functions use gbToBytes conversion. This conversion logic is correct, but ensure that the input values are validated to prevent unexpected behavior.
5. frontend/src/container/IngestionSettings/MultiIngestionSettings.tsx:484
  • Draft comment:
    Ensure that the input values for dailyLimit and secondsLimit are validated before conversion to prevent unexpected behavior.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    In MultiIngestionSettings.tsx, the handleAddLimit and handleUpdateLimit functions use gbToBytes conversion. This conversion logic is correct, but ensure that the input values are validated to prevent unexpected behavior.
6. frontend/src/container/IngestionSettings/MultiIngestionSettings.tsx:446
  • Draft comment:
    Ensure that the input values for dailyLimit and secondsLimit are validated before conversion to prevent unexpected behavior.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    In MultiIngestionSettings.tsx, the handleAddLimit and handleUpdateLimit functions use gbToBytes conversion. This conversion logic is correct, but ensure that the input values are validated to prevent unexpected behavior.
7. frontend/src/container/IngestionSettings/MultiIngestionSettings.tsx:495
  • Draft comment:
    Ensure that the input values for dailyLimit and secondsLimit are validated before conversion to prevent unexpected behavior.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    In MultiIngestionSettings.tsx, the handleAddLimit and handleUpdateLimit functions use gbToBytes conversion. This conversion logic is correct, but ensure that the input values are validated to prevent unexpected behavior.
8. frontend/src/container/IngestionSettings/IngestionSettings.styles.scss:390
  • Draft comment:
    Use design tokens or predefined color constants instead of hardcoding color values like var(--bg-forest-400) to maintain consistency in design and theming. This is also applicable to other instances in the file.
  • Reason this comment was not posted:
    Decided after close inspection that this draft comment was likely wrong and/or not actionable:
    The code uses var(--bg-forest-400), which appears to be a CSS variable. CSS variables are often used as design tokens or predefined constants. The comment seems to misunderstand the use of CSS variables as design tokens. The file consistently uses CSS variables, indicating that var(--bg-forest-400) is likely a predefined constant.
    I might be missing the context of whether var(--bg-forest-400) is indeed a predefined constant or a hardcoded value. However, given the consistent use of CSS variables, it's reasonable to assume it is predefined.
    The consistent use of CSS variables throughout the file supports the assumption that var(--bg-forest-400) is a predefined constant, making the comment unnecessary.
    The comment should be deleted because var(--bg-forest-400) is likely a predefined color constant, and the comment misunderstands the use of CSS variables as design tokens.
9. frontend/src/container/IngestionSettings/MultiIngestionSettings.tsx:408
  • Draft comment:
    This function duplicates the functionality of hideDeleteScheduleModal in PlannedDowntimeDeleteModal.tsx. Consider refactoring to use a common utility function.

  • function hideDeleteScheduleModal (PlannedDowntimeDeleteModal.tsx)

  • Reason this comment was not posted:
    Decided after close inspection that this draft comment was likely wrong and/or not actionable:
    The comment points out a potential code duplication, but the functions are very simple and specific to their respective components. Creating a utility function for such a simple operation might not be justified. The comment does not provide strong evidence that a refactor is necessary or beneficial.
    The comment assumes that a utility function is needed without considering the context of each component. The functions are simple and context-specific, so a utility function might not be appropriate.
    While the functions are simple, if there are many such functions across the codebase, a utility function could improve maintainability. However, this specific instance does not provide enough evidence for such a need.
    The comment should be deleted as it suggests an unnecessary refactor for a simple and context-specific function.

Workflow ID: wflow_F0b28CcNrIk6du86


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

Copy link
Collaborator

@ahmadshaheer ahmadshaheer left a comment

Choose a reason for hiding this comment

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

Reviewed the code. it looks good. just a minor comment. please feel free to make the changes in another PR if merging this PR is urgent. I wasn't able to check the UI locally, as the ingestion keys API throws "Unauthorized" error when I visit Ingestion settings.

@YounixM YounixM enabled auto-merge (squash) November 14, 2024 06:43
@YounixM YounixM force-pushed the feat/ingestion-limits-add-toggle-feature branch from 6f09478 to b6baeca Compare November 14, 2024 06:43
@YounixM YounixM merged commit 504bc0d into develop Nov 15, 2024
16 of 18 checks passed
@YounixM YounixM deleted the feat/ingestion-limits-add-toggle-feature branch November 15, 2024 08:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants