Skip to content

[WEB-2568] chore: minor improvements for issue activity component. #5725

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.

Sign up for GitHub

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

Merged
pushya22 merged 1 commit into from
Sep 30, 2024
Merged

[WEB-2568] chore: minor improvements for issue activity component. #5725

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions web/ce/components/issues/issue-details/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
export * from "./issue-identifier";
export * from "./issue-properties-activity";
export * from "./issue-type-switcher";
export * from "./issue-type-activity";
8 changes: 8 additions & 0 deletions web/ce/components/issues/issue-details/issue-type-activity.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
"use client";

import { FC } from "react";
import { observer } from "mobx-react";

export type TIssueTypeActivity = { activityId: string; showIssue?: boolean; ends: "top" | "bottom" | undefined };

export const IssueTypeActivity: FC<TIssueTypeActivity> = observer(() => <></>);
Copy link
Contributor

@coderabbitai coderabbitai bot Sep 30, 2024

Choose a reason for hiding this comment

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

💡 Codebase verification

IssueTypeActivity is used but has an empty implementation.

The IssueTypeActivity component is currently rendered in activity-list.tsx but returns an empty fragment. This may lead to missing functionality or unexpected UI behavior.

  • File: web/ce/components/issues/issue-details/issue-type-activity.tsx
  • File: web/core/components/issues/issue-detail/issue-activity/activity/activity-list.tsx

Consider implementing the component's functionality or removing it if it's not required.

🔗 Analysis chain

Component structure is correct, but implementation is missing.

The IssueTypeActivity component is correctly declared as a functional component with proper typing and MobX observer wrapper. However, the component currently renders an empty fragment.

Is this intentional, or is the implementation missing? If it's a work in progress, consider adding a TODO comment to indicate what needs to be implemented.

export const IssueTypeActivity: FC<TIssueTypeActivity> = observer(() => {
  // TODO: Implement issue type activity rendering
  return <></>;
});

To verify if this component is used elsewhere in the codebase, run the following script:

This will help determine if the component is already being used, which might indicate that the implementation is indeed missing and should be prioritized.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for usage of IssueTypeActivity component

# Test: Search for IssueTypeActivity usage
rg --type typescript --type tsx 'IssueTypeActivity'

Length of output: 86

Script:

#!/bin/bash
# Description: Check for usage of IssueTypeActivity component

# Test: Search for IssueTypeActivity usage
rg --type ts --type tsx 'IssueTypeActivity'

Length of output: 71

Script:

#!/bin/bash
# Description: Check for usage of IssueTypeActivity component

# Test: Search for IssueTypeActivity usage in .ts and .tsx files
rg 'IssueTypeActivity' --glob '*.ts' --glob '*.tsx'

Length of output: 679

6 changes: 5 additions & 1 deletion web/core/components/issues/issue-detail/issue-activity/activity/activity-list.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@ import { FC } from "react";
import { observer } from "mobx-react";
// hooks
import { useIssueDetail } from "@/hooks/store";
// components
// plane web components
import { IssueTypeActivity } from "@/plane-web/components/issues/issue-details";
// local components
import {
IssueDefaultActivity,
IssueNameActivity,
Expand Down Expand Up @@ -77,6 +79,8 @@ export const IssueActivityItem: FC<TIssueActivityItem> = observer((props) => {
return <IssueArchivedAtActivity {...componentDefaultProps} />;
case "inbox":
return <IssueInboxActivity {...componentDefaultProps} />;
case "type":
return <IssueTypeActivity {...componentDefaultProps} />;
default:
return <></>;
}
Expand Down
1 change: 1 addition & 0 deletions web/ee/components/issues/issue-details/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
export * from "./issue-identifier";
export * from "./issue-properties-activity";
export * from "./issue-type-switcher";
export * from "./issue-type-activity";
Copy link
Contributor

@coderabbitai coderabbitai bot Sep 30, 2024

Choose a reason for hiding this comment

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

💡 Codebase verification

IssueTypeActivity Component is Currently Incomplete

The IssueTypeActivity component exported in web/ee/components/issues/issue-details/index.ts is currently implemented as an empty fragment but is being imported and used in web/core/components/issues/issue-detail/issue-activity/activity/activity-list.tsx. This incomplete implementation may lead to missing functionality or unexpected behavior in the application.

  • File with Incomplete Implementation:

    • web/ee/components/issues/issue-details/issue-type-activity.tsx

  • File Utilizing the Component:

    • web/core/components/issues/issue-detail/issue-activity/activity/activity-list.tsx

Please ensure that IssueTypeActivity is properly implemented to fulfill its intended functionality.

🔗 Analysis chain

LGTM! Additional context would be helpful.

The new export is correctly implemented and aligns with the PR objectives for minor improvements to the issue activity component. The syntax is consistent with other exports in this file.

To ensure this change doesn't introduce any unintended side effects, could you provide more information about the issue-type-activity module? Specifically:

  1. What functionality does this module provide?
  2. How does it contribute to the improvements mentioned in the PR objectives?

This context will help in understanding the full impact of this change. You can run the following script to view the contents of the issue-type-activity file:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: View contents of the issue-type-activity file

# Test: Display the contents of the issue-type-activity.ts file
cat $(fd -t f "issue-type-activity.ts" | head -n 1)

Length of output: 393

Script:

#!/bin/bash
# Description: Find usages of IssueTypeActivity component in the codebase

rg 'IssueTypeActivity' --type=typescript

Length of output: 75

Script:

#!/bin/bash
# Description: Find usages of IssueTypeActivity component in the codebase

rg 'IssueTypeActivity' --glob '**/*.{ts,tsx}'

Length of output: 673

1 change: 1 addition & 0 deletions web/ee/components/issues/issue-details/issue-type-activity.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export * from "ce/components/issues/issue-details";