Skip to content

fix: Client-side exception occurs when adding a filter to rate limit logs table with no data#2542

Merged
chronark merged 17 commits intounkeyed:mainfrom
RajuGangitla:main
Oct 29, 2024
Merged

fix: Client-side exception occurs when adding a filter to rate limit logs table with no data#2542
chronark merged 17 commits intounkeyed:mainfrom
RajuGangitla:main

Conversation

@RajuGangitla
Copy link
Contributor

@RajuGangitla RajuGangitla commented Oct 23, 2024

What does this PR do?

This pr will add a default value to the filters state

Fixes #2388

Actually this is working fine in local it didnt throw any client side exception but in production its throwing a error

so based on the error undefined is not iterable
i give default value empty array

Summary by CodeRabbit

  • New Features

    • The ArrayInput component now initializes the selected prop with a default empty array, enhancing usability and preventing runtime errors.
  • Bug Fixes

    • Improved handling of undefined selected prop to ensure smoother functionality.

@changeset-bot
Copy link

changeset-bot bot commented Oct 23, 2024

⚠️ No Changeset found

Latest commit: 68b98f5

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel
Copy link

vercel bot commented Oct 23, 2024

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

Name Status Preview Comments Updated (UTC)
engineering ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 23, 2024 5:36am

@vercel
Copy link

vercel bot commented Oct 23, 2024

@RajuGangitla is attempting to deploy a commit to the Unkey Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 23, 2024

📝 Walkthrough

Walkthrough

The changes made in the ArrayInput component involve updating the component's signature to set a default value for the selected prop. This modification initializes selected as an empty array when it is not provided, addressing potential runtime errors related to undefined values. Other functionalities, such as event handling and rendering, remain unchanged.

Changes

File Path Change Summary
apps/dashboard/components/array-input.tsx Updated ArrayInput component to set default value for selected prop to an empty array.

Assessment against linked issues

Objective Addressed Explanation
Ensure the filter input handles empty logs gracefully (Issue #2388)
Prevent client-side exceptions when no data is present (Issue #2388)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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

@github-actions github-actions bot added 🕹️ 150 points Bug Something isn't working labels Oct 23, 2024
@github-actions
Copy link
Contributor

github-actions bot commented Oct 23, 2024

Thank you for following the naming conventions for pull request titles! 🙏

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: 1

🧹 Outside diff range and nitpick comments (1)
apps/dashboard/components/array-input.tsx (1)

Line range hint 21-40: Consider adding input validation and limits for rate limit filters.

While the component handles basic input scenarios, consider adding these safeguards for the rate limit logs use case:

  1. Maximum number of filters to prevent performance issues
  2. Input validation for filter format/values
  3. Clear feedback when validation fails

Example improvements:

type Props = {
  // ... existing props
  maxItems?: number;
  validate?: (value: string) => boolean;
  onValidationError?: (error: string) => void;
};

This would allow the rate limit logs table to:

  • Limit the number of concurrent filters
  • Validate filter syntax
  • Show meaningful error messages
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between b456ac0 and 68b98f5.

📒 Files selected for processing (1)
  • apps/dashboard/components/array-input.tsx (1 hunks)
🧰 Additional context used
🔇 Additional comments (1)
apps/dashboard/components/array-input.tsx (1)

17-17: Verify the fix resolves the rate limit logs table issue.

The default value for selected should prevent the "undefined is not iterable" error. The implementation looks correct.

Let's verify all usages of ArrayInput to ensure they handle empty states correctly:

✅ Verification successful

Let me check the actual implementation in those files to verify how ArrayInput is being used.


Based on the analysis of the files, I can now generate the final response:

The fix is properly implemented and used correctly throughout the rate limit logs.

The verification shows that:

  • In filters.tsx, ArrayInput receives identifier which is initialized using parseAsArrayOf(parseAsString).withDefault([]), ensuring it's never undefined
  • In logs/filter.tsx, ArrayInput is used via the FilterRow component which receives selected from state variables (identifier, country, ipAddress) that are all initialized with .withDefault([])
  • All usages properly handle the empty state by using array state management with default empty arrays
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for ArrayInput usage in rate limit logs related files
rg -l "ArrayInput" | rg -i "rate.*limit|log"

# Check for any direct selected prop assignments without default values
ast-grep --pattern 'selected={$_}'

Length of output: 209


Script:

#!/bin/bash
# Check the content of the files that use ArrayInput in rate limit context
cat apps/dashboard/app/\(app\)/ratelimits/[namespaceId]/filters.tsx apps/dashboard/app/\(app\)/ratelimits/[namespaceId]/logs/filter.tsx

# Also search for any ArrayInput props pattern to see how selected is passed
ast-grep --pattern '<ArrayInput $$$selected={$_}$$$/>'

Length of output: 13029

};

export const ArrayInput: React.FC<Props> = ({ title, placeholder, selected, setSelected }) => {
export const ArrayInput: React.FC<Props> = ({ title, placeholder, selected = [], setSelected }) => {
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Consider making the selected prop optional in the Props type.

While adding a default value for selected fixes the "undefined is not iterable" error, there's a slight inconsistency in the type definition. The selected prop is marked as required in the Props type but has a default value in the component signature.

Consider updating the Props type to match the runtime behavior:

type Props = {
  title?: string;
  placeholder?: string;
-  selected: string[];
+  selected?: string[];
  setSelected: (v: string[]) => void;
};
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
export const ArrayInput: React.FC<Props> = ({ title, placeholder, selected = [], setSelected }) => {
type Props = {
title?: string;
placeholder?: string;
selected?: string[];
setSelected: (v: string[]) => void;
};

@chronark chronark merged commit 34af636 into unkeyed:main Oct 29, 2024
@oss-gg
Copy link

oss-gg bot commented Oct 29, 2024

Awarding RajuGangitla: 150 points 🕹️ Well done! Check out your new contribution on oss.gg/RajuGangitla

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Client-side exception occurs when adding a filter to rate limit logs table with no data

2 participants