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-3176] chore: workspace view loading state improvement #6423

Merged
merged 1 commit into from
Jan 17, 2025

Conversation

anmolsinghbhatia
Copy link
Collaborator

@anmolsinghbhatia anmolsinghbhatia commented Jan 17, 2025

Description

This PR includes improvement for workspace view loading.

Type of Change

  • Improvement (change that would cause existing functionality to not work as expected)

References

[WEB-3176]

Summary by CodeRabbit

Release Notes

  • New Features

    • Enhanced loading state management for global view and issue layouts
    • Added dynamic loading indicators during data fetching
  • Improvements

    • Improved user experience with more granular loading controls
    • Implemented conditional rendering based on loading states

The updates provide a more responsive interface by introducing loading state tracking and display mechanisms across global view and issue-related components.

Copy link

makeplane bot commented Jan 17, 2025

Pull Request Linked with Plane Issues

Comment Automatically Generated by Plane

1 similar comment
Copy link

makeplane bot commented Jan 17, 2025

Pull Request Linked with Plane Issues

Comment Automatically Generated by Plane

Copy link
Contributor

coderabbitai bot commented Jan 17, 2025

Walkthrough

The pull request introduces loading state management across multiple components in the workspace views and issues layout. A new isLoading state is added to the GlobalViewIssuesPage component, which can be toggled using a toggleLoading function. This loading state is then propagated to child components like GlobalViewsAppliedFiltersRoot and AllIssueLayoutRoot, enabling more dynamic rendering with loading indicators during data fetching processes.

Changes

File Change Summary
web/app/[workspaceSlug]/(projects)/workspace-views/[globalViewId]/page.tsx Added isLoading state and toggleLoading handler; Updated component prop signatures
web/core/components/issues/issue-layouts/filters/applied-filters/roots/global-view-root.tsx Added optional isLoading prop to render Loader conditionally
web/core/components/issues/issue-layouts/roots/all-issue-layout-root.tsx Updated props to include isLoading and toggleLoading; Renamed loading state variables; Modified rendering conditions

Sequence Diagram

sequenceDiagram
    participant Page as GlobalViewIssuesPage
    participant Filters as GlobalViewsAppliedFiltersRoot
    participant Layout as AllIssueLayoutRoot

    Page->>Page: Initialize isLoading(false)
    Page->>Filters: Pass isLoading
    Page->>Layout: Pass isLoading, toggleLoading
    Layout-->>Page: Toggle loading state
    alt Loading
        Filters->>Filters: Render Loader
        Layout->>Layout: Show Loading Indicator
    else Not Loading
        Filters->>Filters: Render Applied Filters
        Layout->>Layout: Render Normal Content
    end
Loading

Possibly related PRs

Suggested labels

🌟enhancement

Suggested reviewers

  • sriramveeraghanta
  • SatishGandham
  • rahulramesha

Poem

🐰 Loading state, a rabbit's delight,
Spinning wheels that dance so bright
Components flow with graceful ease
Rendering magic that surely please
A loading dance of code so neat! 🌈


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

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 comments (1)
web/core/components/issues/issue-layouts/roots/all-issue-layout-root.tsx (1)

Line range hint 107-124: Potential race condition in loading state management

The loading state toggle doesn't account for error cases, which could leave the UI in a perpetual loading state if the fetch fails.

Consider wrapping the loading state management in a try-finally block:

  const { isLoading: issuesLoading } = useSWR(
    workspaceSlug && globalViewId ? `WORKSPACE_GLOBAL_VIEW_ISSUES_${workspaceSlug}_${globalViewId}` : null,
    async () => {
      if (workspaceSlug && globalViewId) {
        clear();
        toggleLoading(true);
+       try {
          await fetchFilters(workspaceSlug.toString(), globalViewId.toString());
          await fetchIssues(
            workspaceSlug.toString(),
            globalViewId.toString(),
            groupedIssueIds ? "mutation" : "init-loader",
            {
              canGroup: false,
              perPageCount: 100,
            }
          );
          routerFilterParams();
+       } finally {
          toggleLoading(false);
+       }
      }
    },
    { revalidateIfStale: false, revalidateOnFocus: false }
  );
🧹 Nitpick comments (5)
web/app/[workspaceSlug]/(projects)/workspace-views/[globalViewId]/page.tsx (2)

20-21: Consider initializing loading state to true

Since data fetching starts immediately, initializing isLoading to true would prevent a flash of unloaded content.

- const [isLoading, setIsLoading] = useState(false);
+ const [isLoading, setIsLoading] = useState(true);

27-28: Props drilling could be improved with React Context

The loading state is being passed down through multiple levels of components. Consider using React Context for better state management if this pattern expands further.

Also applies to: 35-38

web/core/components/issues/issue-layouts/roots/all-issue-layout-root.tsx (1)

Line range hint 178-191: Improve loading state condition readability

The loading condition is complex and could be simplified for better maintainability.

- if (!isLoading && !globalViewsLoading && !issuesLoading && !viewDetails && !isDefaultView) {
+ const isLoadingComplete = !isLoading && !globalViewsLoading && !issuesLoading;
+ const isViewInvalid = !viewDetails && !isDefaultView;
+ if (isLoadingComplete && isViewInvalid) {
web/core/components/issues/issue-layouts/filters/applied-filters/roots/global-view-root.tsx (2)

158-164: Extract loader dimensions to constants

The hardcoded loader dimensions could be moved to constants for better maintainability.

+ const LOADER_DIMENSIONS = {
+   SMALL: { height: "36px", width: "100px" },
+   MEDIUM: { height: "36px", width: "150px" },
+   LARGE: { height: "36px", width: "300px" },
+ };

  {isLoading ? (
    <Loader className="flex flex-wrap items-stretch gap-2 bg-custom-background-100 truncate my-auto">
-     <Loader.Item height="36px" width="150px" />
-     <Loader.Item height="36px" width="100px" />
-     <Loader.Item height="36px" width="300px" />
+     <Loader.Item {...LOADER_DIMENSIONS.MEDIUM} />
+     <Loader.Item {...LOADER_DIMENSIONS.SMALL} />
+     <Loader.Item {...LOADER_DIMENSIONS.LARGE} />
    </Loader>
  ) : (

165-173: Consider adding a fade transition

The abrupt switch between loader and content could be smoothed out with a transition.

+ const fadeTransitionClass = "transition-opacity duration-200";

  {isLoading ? (
-   <Loader className="flex flex-wrap items-stretch gap-2 bg-custom-background-100 truncate my-auto">
+   <Loader className={`flex flex-wrap items-stretch gap-2 bg-custom-background-100 truncate my-auto ${fadeTransitionClass}`}>
      ...
    </Loader>
  ) : (
    <AppliedFiltersList
-     labels={workspaceLabels ?? undefined}
+     className={fadeTransitionClass}
+     labels={workspaceLabels ?? undefined}
      ...
    />
  )}
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 26a9b7f and 39071ca.

📒 Files selected for processing (3)
  • web/app/[workspaceSlug]/(projects)/workspace-views/[globalViewId]/page.tsx (2 hunks)
  • web/core/components/issues/issue-layouts/filters/applied-filters/roots/global-view-root.tsx (3 hunks)
  • web/core/components/issues/issue-layouts/roots/all-issue-layout-root.tsx (6 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: lint-web
  • GitHub Check: Analyze (javascript)
  • GitHub Check: Analyze (python)

@pushya22 pushya22 merged commit 13cc8b0 into preview Jan 17, 2025
12 of 14 checks passed
@pushya22 pushya22 deleted the chore-workspace-view-loading-state branch January 17, 2025 14:20
@coderabbitai coderabbitai bot mentioned this pull request Jan 17, 2025
6 tasks
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.

3 participants