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

[WEB-2341] feat: Add display filters and display properties to create/update view dialog #5451

Merged
merged 2 commits into from
Aug 30, 2024

Conversation

rahulramesha
Copy link
Contributor

@rahulramesha rahulramesha commented Aug 28, 2024

This PR add the display filters and properties to create/update view dialog

Screen.Recording.2024-08-28.at.4.36.45.PM.mov

Summary by CodeRabbit

  • New Features

    • Enhanced ProjectViewForm and WorkspaceViewForm components with improved display filter management.
    • Introduced a hierarchical structure for managing display filters and properties, allowing for a more integrated user interaction.
    • Added a new DisplayFiltersSelection component for better handling of filter updates.
  • Bug Fixes

    • Improved responsiveness and organization of form components, enhancing user experience.

Copy link
Contributor

coderabbitai bot commented Aug 28, 2024

Walkthrough

The changes introduce enhancements to the ProjectViewForm and WorkspaceViewForm components, focusing on the management of display filters and properties. New types for display filter options and properties are imported, and the form structures are updated to facilitate more organized interactions. The rendering logic is refined to improve user experience through better integration of filter and property controls.

Changes

Files Change Summary
web/core/components/views/form.tsx Added types for display properties and filters, updated defaultValues for display_filters, and refactored rendering logic for improved organization.
web/core/components/workspace/views/form.tsx Introduced new functionality for display filters with nested controllers for display_filters and display_properties, enhancing interaction capabilities.

Poem

Hop along, let's celebrate,
With filters fresh and changes great!
Forms now dance in harmony,
Properties and filters, oh so free!
A joyful leap, a happy cheer,
For clearer paths, we hold so dear! 🐇✨


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

Outside diff range, codebase verification and nitpick comments (1)
web/core/components/workspace/views/form.tsx (1)

Line range hint 158-222: Ensure thorough testing of the new display filter functionality.

Given the complexity and importance of the new display filter functionality, it's crucial to ensure that all interactions and edge cases are thoroughly tested to prevent issues in production.

Would you like assistance in setting up comprehensive tests for this functionality?

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 0cce39e and 8751392.

Files selected for processing (2)
  • web/core/components/views/form.tsx (3 hunks)
  • web/core/components/workspace/views/form.tsx (3 hunks)
Additional comments not posted (4)
web/core/components/workspace/views/form.tsx (2)

7-7: Approved import changes.

The new types IIssueDisplayFilterOptions and IIssueDisplayProperties are essential for the added functionality regarding display filters and properties.


11-11: Approved component import changes.

The import of the DisplayFiltersSelection component aligns with the new functionality for managing display filters.

web/core/components/views/form.tsx (2)

8-8: Approved import changes.

The new types IIssueDisplayProperties and IIssueDisplayFilterOptions are essential for the added functionality regarding display filters and properties.


37-37: Approved update to defaultValues.

The addition of the group_by property to display_filters in defaultValues enhances the structure for managing filter states. Ensure this new property integrates smoothly with existing data structures and workflows.

Verify the integration of the group_by property with existing data structures:

Comment on lines +191 to +222
{/* display filters dropdown */}
<Controller
control={control}
name="display_filters"
render={({ field: { onChange: onDisplayFiltersChange, value: displayFilters } }) => (
<Controller
control={control}
name="display_properties"
render={({ field: { onChange: onDisplayPropertiesChange, value: displayProperties } }) => (
<FiltersDropdown title="Display">
<DisplayFiltersSelection
layoutDisplayFiltersOptions={ISSUE_DISPLAY_FILTERS_BY_LAYOUT.my_issues.spreadsheet}
displayFilters={displayFilters ?? {}}
handleDisplayFiltersUpdate={(updatedDisplayFilter: Partial<IIssueDisplayFilterOptions>) => {
onDisplayFiltersChange({
...displayFilters,
...updatedDisplayFilter,
});
}}
displayProperties={displayProperties ?? {}}
handleDisplayPropertiesUpdate={(updatedDisplayProperties: Partial<IIssueDisplayProperties>) => {
onDisplayPropertiesChange({
...displayProperties,
...updatedDisplayProperties,
});
}}
/>
</FiltersDropdown>
)}
/>
)}
/>
Copy link
Contributor

Choose a reason for hiding this comment

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

Consider simplifying the nested controllers.

The nested Controller components for display_filters and display_properties introduce complexity. While necessary for the functionality, consider simplifying the structure if possible to enhance maintainability.

Comment on lines +227 to +305
name="display_filters"
render={({ field: { onChange: onDisplayFiltersChange, value: displayFilters } }) => (
<>
{/* layout dropdown */}
<LayoutDropDown
onChange={(selectedValue: EIssueLayoutTypes) =>
onDisplayFiltersChange({
...displayFilters,
layout: selectedValue,
})
}
value={displayFilters.layout}
/>

{/* filters dropdown */}
<Controller
control={control}
name="filters"
render={({ field: { onChange, value: filters } }) => (
<FiltersDropdown title="Filters" tabIndex={3}>
<FilterSelection
filters={filters ?? {}}
handleFiltersUpdate={(key, value) => {
const newValues = filters?.[key] ?? [];

if (Array.isArray(value)) {
value.forEach((val) => {
if (!newValues.includes(val)) newValues.push(val);
});
} else {
if (filters?.[key]?.includes(value)) newValues.splice(newValues.indexOf(value), 1);
else newValues.push(value);
}

if (Array.isArray(value)) {
value.forEach((val) => {
if (!newValues.includes(val)) newValues.push(val);
});
} else {
if (filters?.[key]?.includes(value)) newValues.splice(newValues.indexOf(value), 1);
else newValues.push(value);
}
onChange({
...filters,
[key]: newValues,
});
}}
layoutDisplayFiltersOptions={ISSUE_DISPLAY_FILTERS_BY_LAYOUT.issues[displayFilters.layout]}
labels={projectLabels ?? undefined}
memberIds={projectMemberIds ?? undefined}
states={projectStates}
cycleViewDisabled={!currentProjectDetails?.cycle_view}
moduleViewDisabled={!currentProjectDetails?.module_view}
/>
</FiltersDropdown>
)}
/>

onChange({
...filters,
[key]: newValues,
});
}}
layoutDisplayFiltersOptions={ISSUE_DISPLAY_FILTERS_BY_LAYOUT.issues.list}
labels={projectLabels ?? undefined}
memberIds={projectMemberIds ?? undefined}
states={projectStates}
cycleViewDisabled={!currentProjectDetails?.cycle_view}
moduleViewDisabled={!currentProjectDetails?.module_view}
{/* display filters dropdown */}
<Controller
control={control}
name="display_properties"
render={({ field: { onChange: onDisplayPropertiesChange, value: displayProperties } }) => (
<FiltersDropdown title="Display">
<DisplayFiltersSelection
layoutDisplayFiltersOptions={ISSUE_DISPLAY_FILTERS_BY_LAYOUT.issues[displayFilters.layout]}
displayFilters={displayFilters ?? {}}
handleDisplayFiltersUpdate={(updatedDisplayFilter: Partial<IIssueDisplayFilterOptions>) => {
onDisplayFiltersChange({
...displayFilters,
...updatedDisplayFilter,
});
}}
displayProperties={displayProperties ?? {}}
handleDisplayPropertiesUpdate={(
updatedDisplayProperties: Partial<IIssueDisplayProperties>
) => {
onDisplayPropertiesChange({
...displayProperties,
...updatedDisplayProperties,
});
}}
cycleViewDisabled={!currentProjectDetails?.cycle_view}
moduleViewDisabled={!currentProjectDetails?.module_view}
/>
</FiltersDropdown>
)}
Copy link
Contributor

Choose a reason for hiding this comment

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

Consider simplifying the nested controllers.

The nested Controller components for display_filters and display_properties introduce complexity. While necessary for the functionality, consider simplifying the structure if possible to enhance maintainability.

@pushya22 pushya22 merged commit 4598b1b into preview Aug 30, 2024
13 of 14 checks passed
@pushya22 pushya22 deleted the feat-view-display-filters branch August 30, 2024 13:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🌟enhancement New feature or request 🌐frontend
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants