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: added format fallback to date input in ui package #2736

Merged
merged 2 commits into from
Sep 30, 2024

Conversation

chesterkmr
Copy link
Collaborator

@chesterkmr chesterkmr commented Sep 30, 2024

Summary by CodeRabbit

  • New Features

    • Introduced a fallback date format for the date input component to enhance usability.
  • Bug Fixes

    • Improved error handling in the DatePickerInput component, ensuring only valid date formats are serialized and exceptions during input are managed gracefully.
  • Chores

    • Updated dependencies across multiple packages to maintain compatibility and stability, including updates to @ballerine/ui, @ballerine/config, and others.

Copy link

changeset-bot bot commented Sep 30, 2024

⚠️ No Changeset found

Latest commit: 5851aa1

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

Copy link
Contributor

coderabbitai bot commented Sep 30, 2024

Walkthrough

The pull request focuses on updating dependencies across various packages within the Ballerine ecosystem. Key updates include version increments for the @ballerine/ui package and related libraries, ensuring compatibility and maintaining functionality. The changes span multiple components, reflecting ongoing maintenance efforts across the kyb-app, react-pdf-toolkit, and ui packages, with no significant alterations to functionality or exported entities.

Changes

File Path Change Summary
apps/kyb-app/CHANGELOG.md Updated changelog reflecting dependency updates from version 0.3.0 to 0.3.59, focusing on @ballerine/ui.
apps/kyb-app/package.json Version updated from 0.3.58 to 0.3.59; @ballerine/ui dependency updated from 0.5.33 to 0.5.34.
packages/react-pdf-toolkit/CHANGELOG.md Changelog updated for version 1.2.34, highlighting dependency updates, including @ballerine/ui.
packages/react-pdf-toolkit/package.json Version updated from 1.2.33 to 1.2.34; @ballerine/ui dependency updated from 0.5.33 to 0.5.34; @ballerine/config updated from 1.1.17 to 1.1.18.
packages/ui/CHANGELOG.md Changelog updated for version 0.5.34, introducing a fallback date format for the date input component.
packages/ui/package.json Version updated from 0.5.33 to 0.5.34; no other changes made.
services/workflows-service/prisma/data-migrations Changed subproject commit identifier; no functional changes noted.

Possibly related PRs

Suggested reviewers

  • alonp99
  • tomer-shvadron

Poem

🐇 In the garden of code, we hop and play,
Dependencies updated, hip-hip-hooray!
With DatePicker's charm, we handle with care,
Valid dates now dance in the fresh spring air.
So let’s celebrate with a joyful cheer,
For every small change brings us all near! 🌼


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 5d7134f and 5851aa1.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (3)
  • apps/kyb-app/CHANGELOG.md (1 hunks)
  • packages/react-pdf-toolkit/CHANGELOG.md (1 hunks)
  • packages/ui/CHANGELOG.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
  • apps/kyb-app/CHANGELOG.md
  • packages/react-pdf-toolkit/CHANGELOG.md
  • packages/ui/CHANGELOG.md

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.

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

🧹 Outside diff range and nitpick comments (4)
packages/react-pdf-toolkit/CHANGELOG.md (1)

3-8: LGTM! Consider adding more details to the changelog entry.

The changelog entry for version 1.2.34 is correct and follows the conventional format. The patch version increment is appropriate for a dependency update.

Consider adding a brief description of any notable changes or features introduced by the @ballerine/ui@0.5.34 update. This can help users understand the impact of the update more easily.

For example:

## 1.2.34

### Patch Changes

- Updated dependencies
  - @ballerine/ui@0.5.34
    - Brief description of notable changes in @ballerine/ui@0.5.34 (if any)
packages/ui/CHANGELOG.md (1)

3-7: LGTM! Consider adding more detail to the changelog entry.

The new changelog entry for version 0.5.34 accurately reflects the change mentioned in the PR title. It's correctly marked as a patch change, which is appropriate for this type of enhancement.

To provide more context for users, consider expanding the changelog entry slightly. For example:

- Added fallback date format to date input
+ Added fallback date format to date input, improving robustness when handling various date formats

This additional detail helps users understand the impact and benefit of the change.

apps/kyb-app/CHANGELOG.md (1)

Line range hint 1-24: Consider enhancing the changelog with more detailed descriptions.

While the changelog is consistently maintained with version updates, it would be more informative to include brief descriptions of notable changes, new features, or bug fixes in each version. This would help users and developers better understand the impact of each update.

For example, you could add a brief note like:

## 0.3.59

### Patch Changes

- Updated dependencies
  - @ballerine/ui@0.5.34
    - Improved date input validation in UI components

This level of detail helps track the evolution of the project more effectively.

packages/ui/src/components/molecules/inputs/DatePickerInput/DatePickerInput.tsx (1)

65-67: Consider using a consistent logging mechanism instead of console.warn

Using console.warn directly may not align with the application's logging strategy. Consider utilizing a centralized logging utility or error handling mechanism to maintain consistency across the codebase.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between df66c39 and 5d7134f.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (8)
  • apps/kyb-app/CHANGELOG.md (1 hunks)
  • apps/kyb-app/package.json (2 hunks)
  • packages/react-pdf-toolkit/CHANGELOG.md (1 hunks)
  • packages/react-pdf-toolkit/package.json (2 hunks)
  • packages/ui/CHANGELOG.md (1 hunks)
  • packages/ui/package.json (1 hunks)
  • packages/ui/src/components/molecules/inputs/DatePickerInput/DatePickerInput.tsx (1 hunks)
  • services/workflows-service/prisma/data-migrations (1 hunks)
✅ Files skipped from review due to trivial changes (3)
  • apps/kyb-app/package.json
  • packages/ui/package.json
  • services/workflows-service/prisma/data-migrations
🔇 Additional comments (3)
packages/react-pdf-toolkit/package.json (1)

4-4: LGTM! Version updates look good.

The version bump for the package and the update of the @ballerine/ui dependency are consistent and follow semantic versioning principles. These changes align with the coordinated update across multiple packages in the Ballerine ecosystem.

Please ensure the following:

  1. Update the changelog if not already done, documenting any new features or changes introduced in this version.
  2. Verify the compatibility of the updated @ballerine/ui package (v0.5.34) with this package to ensure no breaking changes were introduced.

You can use the following script to check if there's a CHANGELOG.md file and if it mentions the new version:

Also applies to: 30-30

apps/kyb-app/CHANGELOG.md (1)

3-8: LGTM! Changelog updated with the latest version.

The changelog has been correctly updated with version 0.3.59, which includes an update to the @ballerine/ui dependency to version 0.5.34. This change is consistent with the project's versioning practices.

packages/ui/src/components/molecules/inputs/DatePickerInput/DatePickerInput.tsx (1)

62-72: Robust date serialization with fallback implemented

The addition of validation in serializeValue improves robustness by checking if the formatted date is valid using dayjs(date).isValid(). If the format is invalid, it gracefully falls back to ISO format, ensuring the serialization process doesn't break.

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.

2 participants