mirror of
https://github.com/makeplane/plane
synced 2024-06-14 14:31:34 +00:00
53367a6bc4
* new toast setup * chore: new toast implementation. * chore: move toast component to ui package. * chore: replace `setToast` with `setPromiseToast` in required places for better UX. * chore: code cleanup. * chore: update theme. * fix: theme switching issue. * chore: remove toast from issue update operations. * chore: add promise toast for add/ remove issue to cycle/ module and remove local spinners. --------- Co-authored-by: rahulramesha <rahulramesham@gmail.com>
399 lines
14 KiB
TypeScript
399 lines
14 KiB
TypeScript
import { FC, useEffect, useState, useMemo } from "react";
|
|
import { useRouter } from "next/router";
|
|
import { observer } from "mobx-react-lite";
|
|
// hooks
|
|
import { useEventTracker, useIssueDetail, useIssues, useUser } from "hooks/store";
|
|
// ui
|
|
import { TOAST_TYPE, setPromiseToast, setToast } from "@plane/ui";
|
|
// components
|
|
import { IssueView } from "components/issues";
|
|
// types
|
|
import { TIssue } from "@plane/types";
|
|
// constants
|
|
import { EUserProjectRoles } from "constants/project";
|
|
import { EIssuesStoreType } from "constants/issue";
|
|
import { ISSUE_UPDATED, ISSUE_DELETED, ISSUE_ARCHIVED, ISSUE_RESTORED } from "constants/event-tracker";
|
|
|
|
interface IIssuePeekOverview {
|
|
is_archived?: boolean;
|
|
is_draft?: boolean;
|
|
}
|
|
|
|
export type TIssuePeekOperations = {
|
|
fetch: (workspaceSlug: string, projectId: string, issueId: string) => Promise<void>;
|
|
update: (workspaceSlug: string, projectId: string, issueId: string, data: Partial<TIssue>) => Promise<void>;
|
|
remove: (workspaceSlug: string, projectId: string, issueId: string) => Promise<void>;
|
|
archive: (workspaceSlug: string, projectId: string, issueId: string) => Promise<void>;
|
|
restore: (workspaceSlug: string, projectId: string, issueId: string) => Promise<void>;
|
|
addIssueToCycle: (workspaceSlug: string, projectId: string, cycleId: string, issueIds: string[]) => Promise<void>;
|
|
removeIssueFromCycle: (workspaceSlug: string, projectId: string, cycleId: string, issueId: string) => Promise<void>;
|
|
addModulesToIssue?: (workspaceSlug: string, projectId: string, issueId: string, moduleIds: string[]) => Promise<void>;
|
|
removeIssueFromModule?: (
|
|
workspaceSlug: string,
|
|
projectId: string,
|
|
moduleId: string,
|
|
issueId: string
|
|
) => Promise<void>;
|
|
removeModulesFromIssue?: (
|
|
workspaceSlug: string,
|
|
projectId: string,
|
|
issueId: string,
|
|
moduleIds: string[]
|
|
) => Promise<void>;
|
|
};
|
|
|
|
export const IssuePeekOverview: FC<IIssuePeekOverview> = observer((props) => {
|
|
const { is_archived = false, is_draft = false } = props;
|
|
// router
|
|
const router = useRouter();
|
|
const {
|
|
membership: { currentWorkspaceAllProjectsRole },
|
|
} = useUser();
|
|
const {
|
|
issues: { restoreIssue },
|
|
} = useIssues(EIssuesStoreType.ARCHIVED);
|
|
const {
|
|
peekIssue,
|
|
updateIssue,
|
|
removeIssue,
|
|
archiveIssue,
|
|
issue: { getIssueById, fetchIssue },
|
|
} = useIssueDetail();
|
|
const { addIssueToCycle, removeIssueFromCycle, addModulesToIssue, removeIssueFromModule, removeModulesFromIssue } =
|
|
useIssueDetail();
|
|
const { captureIssueEvent } = useEventTracker();
|
|
// state
|
|
const [loader, setLoader] = useState(false);
|
|
|
|
const issueOperations: TIssuePeekOperations = useMemo(
|
|
() => ({
|
|
fetch: async (workspaceSlug: string, projectId: string, issueId: string) => {
|
|
try {
|
|
await fetchIssue(
|
|
workspaceSlug,
|
|
projectId,
|
|
issueId,
|
|
is_archived ? "ARCHIVED" : is_draft ? "DRAFT" : "DEFAULT"
|
|
);
|
|
} catch (error) {
|
|
console.error("Error fetching the parent issue");
|
|
}
|
|
},
|
|
update: async (workspaceSlug: string, projectId: string, issueId: string, data: Partial<TIssue>) => {
|
|
await updateIssue(workspaceSlug, projectId, issueId, data)
|
|
.then(() => {
|
|
captureIssueEvent({
|
|
eventName: ISSUE_UPDATED,
|
|
payload: { ...data, issueId, state: "SUCCESS", element: "Issue peek-overview" },
|
|
updates: {
|
|
changed_property: Object.keys(data).join(","),
|
|
change_details: Object.values(data).join(","),
|
|
},
|
|
path: router.asPath,
|
|
});
|
|
})
|
|
.catch(() => {
|
|
captureIssueEvent({
|
|
eventName: ISSUE_UPDATED,
|
|
payload: { state: "FAILED", element: "Issue peek-overview" },
|
|
path: router.asPath,
|
|
});
|
|
setToast({
|
|
title: "Issue update failed",
|
|
type: TOAST_TYPE.ERROR,
|
|
message: "Issue update failed",
|
|
});
|
|
});
|
|
},
|
|
remove: async (workspaceSlug: string, projectId: string, issueId: string) => {
|
|
try {
|
|
removeIssue(workspaceSlug, projectId, issueId);
|
|
setToast({
|
|
title: "Issue deleted successfully",
|
|
type: TOAST_TYPE.SUCCESS,
|
|
message: "Issue deleted successfully",
|
|
});
|
|
captureIssueEvent({
|
|
eventName: ISSUE_DELETED,
|
|
payload: { id: issueId, state: "SUCCESS", element: "Issue peek-overview" },
|
|
path: router.asPath,
|
|
});
|
|
} catch (error) {
|
|
setToast({
|
|
title: "Issue delete failed",
|
|
type: TOAST_TYPE.ERROR,
|
|
message: "Issue delete failed",
|
|
});
|
|
captureIssueEvent({
|
|
eventName: ISSUE_DELETED,
|
|
payload: { id: issueId, state: "FAILED", element: "Issue peek-overview" },
|
|
path: router.asPath,
|
|
});
|
|
}
|
|
},
|
|
archive: async (workspaceSlug: string, projectId: string, issueId: string) => {
|
|
try {
|
|
await archiveIssue(workspaceSlug, projectId, issueId);
|
|
setToast({
|
|
type: TOAST_TYPE.SUCCESS,
|
|
title: "Success!",
|
|
message: "Issue archived successfully.",
|
|
});
|
|
captureIssueEvent({
|
|
eventName: ISSUE_ARCHIVED,
|
|
payload: { id: issueId, state: "SUCCESS", element: "Issue peek-overview" },
|
|
path: router.asPath,
|
|
});
|
|
} catch (error) {
|
|
setToast({
|
|
type: TOAST_TYPE.ERROR,
|
|
title: "Error!",
|
|
message: "Issue could not be archived. Please try again.",
|
|
});
|
|
captureIssueEvent({
|
|
eventName: ISSUE_ARCHIVED,
|
|
payload: { id: issueId, state: "FAILED", element: "Issue peek-overview" },
|
|
path: router.asPath,
|
|
});
|
|
}
|
|
},
|
|
restore: async (workspaceSlug: string, projectId: string, issueId: string) => {
|
|
try {
|
|
await restoreIssue(workspaceSlug, projectId, issueId);
|
|
setToast({
|
|
type: TOAST_TYPE.SUCCESS,
|
|
title: "Success!",
|
|
message: "Issue restored successfully.",
|
|
});
|
|
captureIssueEvent({
|
|
eventName: ISSUE_RESTORED,
|
|
payload: { id: issueId, state: "SUCCESS", element: "Issue peek-overview" },
|
|
path: router.asPath,
|
|
});
|
|
} catch (error) {
|
|
setToast({
|
|
type: TOAST_TYPE.ERROR,
|
|
title: "Error!",
|
|
message: "Issue could not be restored. Please try again.",
|
|
});
|
|
captureIssueEvent({
|
|
eventName: ISSUE_RESTORED,
|
|
payload: { id: issueId, state: "FAILED", element: "Issue peek-overview" },
|
|
path: router.asPath,
|
|
});
|
|
}
|
|
},
|
|
addIssueToCycle: async (workspaceSlug: string, projectId: string, cycleId: string, issueIds: string[]) => {
|
|
try {
|
|
const addToCyclePromise = addIssueToCycle(workspaceSlug, projectId, cycleId, issueIds);
|
|
setPromiseToast(addToCyclePromise, {
|
|
loading: "Adding cycle to issue...",
|
|
success: {
|
|
title: "Success!",
|
|
message: () => "Cycle added to issue successfully",
|
|
},
|
|
error: {
|
|
title: "Error!",
|
|
message: () => "Cycle add to issue failed",
|
|
},
|
|
});
|
|
await addToCyclePromise;
|
|
captureIssueEvent({
|
|
eventName: ISSUE_UPDATED,
|
|
payload: { ...issueIds, state: "SUCCESS", element: "Issue peek-overview" },
|
|
updates: {
|
|
changed_property: "cycle_id",
|
|
change_details: cycleId,
|
|
},
|
|
path: router.asPath,
|
|
});
|
|
} catch (error) {
|
|
captureIssueEvent({
|
|
eventName: ISSUE_UPDATED,
|
|
payload: { state: "FAILED", element: "Issue peek-overview" },
|
|
updates: {
|
|
changed_property: "cycle_id",
|
|
change_details: cycleId,
|
|
},
|
|
path: router.asPath,
|
|
});
|
|
}
|
|
},
|
|
removeIssueFromCycle: async (workspaceSlug: string, projectId: string, cycleId: string, issueId: string) => {
|
|
try {
|
|
const removeFromCyclePromise = removeIssueFromCycle(workspaceSlug, projectId, cycleId, issueId);
|
|
setPromiseToast(removeFromCyclePromise, {
|
|
loading: "Removing cycle from issue...",
|
|
success: {
|
|
title: "Success!",
|
|
message: () => "Cycle removed from issue successfully",
|
|
},
|
|
error: {
|
|
title: "Error!",
|
|
message: () => "Cycle remove from issue failed",
|
|
},
|
|
});
|
|
const response = await removeFromCyclePromise;
|
|
captureIssueEvent({
|
|
eventName: ISSUE_UPDATED,
|
|
payload: { ...response, state: "SUCCESS", element: "Issue peek-overview" },
|
|
updates: {
|
|
changed_property: "cycle_id",
|
|
change_details: "",
|
|
},
|
|
path: router.asPath,
|
|
});
|
|
} catch (error) {
|
|
captureIssueEvent({
|
|
eventName: ISSUE_UPDATED,
|
|
payload: { state: "FAILED", element: "Issue peek-overview" },
|
|
updates: {
|
|
changed_property: "cycle_id",
|
|
change_details: "",
|
|
},
|
|
path: router.asPath,
|
|
});
|
|
}
|
|
},
|
|
addModulesToIssue: async (workspaceSlug: string, projectId: string, issueId: string, moduleIds: string[]) => {
|
|
try {
|
|
const addToModulePromise = addModulesToIssue(workspaceSlug, projectId, issueId, moduleIds);
|
|
setPromiseToast(addToModulePromise, {
|
|
loading: "Adding module to issue...",
|
|
success: {
|
|
title: "Success!",
|
|
message: () => "Module added to issue successfully",
|
|
},
|
|
error: {
|
|
title: "Error!",
|
|
message: () => "Module add to issue failed",
|
|
},
|
|
});
|
|
const response = await addToModulePromise;
|
|
captureIssueEvent({
|
|
eventName: ISSUE_UPDATED,
|
|
payload: { ...response, state: "SUCCESS", element: "Issue peek-overview" },
|
|
updates: {
|
|
changed_property: "module_id",
|
|
change_details: moduleIds,
|
|
},
|
|
path: router.asPath,
|
|
});
|
|
} catch (error) {
|
|
captureIssueEvent({
|
|
eventName: ISSUE_UPDATED,
|
|
payload: { id: issueId, state: "FAILED", element: "Issue peek-overview" },
|
|
updates: {
|
|
changed_property: "module_id",
|
|
change_details: moduleIds,
|
|
},
|
|
path: router.asPath,
|
|
});
|
|
}
|
|
},
|
|
removeIssueFromModule: async (workspaceSlug: string, projectId: string, moduleId: string, issueId: string) => {
|
|
try {
|
|
const removeFromModulePromise = removeIssueFromModule(workspaceSlug, projectId, moduleId, issueId);
|
|
setPromiseToast(removeFromModulePromise, {
|
|
loading: "Removing module from issue...",
|
|
success: {
|
|
title: "Success!",
|
|
message: () => "Module removed from issue successfully",
|
|
},
|
|
error: {
|
|
title: "Error!",
|
|
message: () => "Module remove from issue failed",
|
|
},
|
|
});
|
|
await removeFromModulePromise;
|
|
captureIssueEvent({
|
|
eventName: ISSUE_UPDATED,
|
|
payload: { id: issueId, state: "SUCCESS", element: "Issue peek-overview" },
|
|
updates: {
|
|
changed_property: "module_id",
|
|
change_details: "",
|
|
},
|
|
path: router.asPath,
|
|
});
|
|
} catch (error) {
|
|
captureIssueEvent({
|
|
eventName: ISSUE_UPDATED,
|
|
payload: { id: issueId, state: "FAILED", element: "Issue peek-overview" },
|
|
updates: {
|
|
changed_property: "module_id",
|
|
change_details: "",
|
|
},
|
|
path: router.asPath,
|
|
});
|
|
}
|
|
},
|
|
removeModulesFromIssue: async (
|
|
workspaceSlug: string,
|
|
projectId: string,
|
|
issueId: string,
|
|
moduleIds: string[]
|
|
) => {
|
|
const removeModulesFromIssuePromise = removeModulesFromIssue(workspaceSlug, projectId, issueId, moduleIds);
|
|
setPromiseToast(removeModulesFromIssuePromise, {
|
|
loading: "Removing module from issue...",
|
|
success: {
|
|
title: "Success!",
|
|
message: () => "Module removed from issue successfully",
|
|
},
|
|
error: {
|
|
title: "Error!",
|
|
message: () => "Module remove from issue failed",
|
|
},
|
|
});
|
|
await removeModulesFromIssuePromise;
|
|
},
|
|
}),
|
|
[
|
|
is_archived,
|
|
is_draft,
|
|
fetchIssue,
|
|
updateIssue,
|
|
removeIssue,
|
|
archiveIssue,
|
|
restoreIssue,
|
|
addIssueToCycle,
|
|
removeIssueFromCycle,
|
|
addModulesToIssue,
|
|
removeIssueFromModule,
|
|
removeModulesFromIssue,
|
|
captureIssueEvent,
|
|
router.asPath,
|
|
]
|
|
);
|
|
|
|
useEffect(() => {
|
|
if (peekIssue) {
|
|
setLoader(true);
|
|
issueOperations.fetch(peekIssue.workspaceSlug, peekIssue.projectId, peekIssue.issueId).finally(() => {
|
|
setLoader(false);
|
|
});
|
|
}
|
|
}, [peekIssue, issueOperations]);
|
|
|
|
if (!peekIssue?.workspaceSlug || !peekIssue?.projectId || !peekIssue?.issueId) return <></>;
|
|
|
|
const issue = getIssueById(peekIssue.issueId) || undefined;
|
|
|
|
const currentProjectRole = currentWorkspaceAllProjectsRole?.[peekIssue?.projectId];
|
|
// Check if issue is editable, based on user role
|
|
const is_editable = !!currentProjectRole && currentProjectRole >= EUserProjectRoles.MEMBER;
|
|
const isLoading = !issue || loader ? true : false;
|
|
|
|
return (
|
|
<IssueView
|
|
workspaceSlug={peekIssue.workspaceSlug}
|
|
projectId={peekIssue.projectId}
|
|
issueId={peekIssue.issueId}
|
|
isLoading={isLoading}
|
|
is_archived={is_archived}
|
|
disabled={!is_editable}
|
|
issueOperations={issueOperations}
|
|
/>
|
|
);
|
|
});
|