plane/apps/app/pages/[workspaceSlug]/projects/[projectId]/settings/features.tsx

import React from "react";

import { useRouter } from "next/router";

import useSWR, { mutate } from "swr";

// services
import projectService from "services/project.service";
import trackEventServices, { MiscellaneousEventType } from "services/track-event.service";
// layouts
import { ProjectAuthorizationWrapper } from "layouts/auth-layout";
// hooks
import useToast from "hooks/use-toast";
import useUserAuth from "hooks/use-user-auth";
// components
import { SettingsHeader } from "components/project";
// ui
import { SecondaryButton, ToggleSwitch } from "components/ui";
import { BreadcrumbItem, Breadcrumbs } from "components/breadcrumbs";
// icons
import { ContrastIcon, PeopleGroupIcon, ViewListIcon, InboxIcon } from "components/icons";
import { DocumentTextIcon } from "@heroicons/react/24/outline";
// types
import { IFavoriteProject, IProject } from "types";
import type { NextPage } from "next";
// fetch-keys
import { FAVORITE_PROJECTS_LIST, PROJECTS_LIST, PROJECT_DETAILS } from "constants/fetch-keys";

const featuresList = [
  {
    title: "Cycles",
    description:
      "Cycles are enabled for all the projects in this workspace. Access them from the sidebar.",
    icon: <ContrastIcon color="#3f76ff" width={28} height={28} className="flex-shrink-0" />,
    property: "cycle_view",
  },
  {
    title: "Modules",
    description:
      "Modules are enabled for all the projects in this workspace. Access it from the sidebar.",
    icon: <PeopleGroupIcon color="#ff6b00" width={28} height={28} className="flex-shrink-0" />,
    property: "module_view",
  },
  {
    title: "Views",
    description:
      "Views are enabled for all the projects in this workspace. Access it from the sidebar.",
    icon: <ViewListIcon color="#05c3ff" width={28} height={28} className="flex-shrink-0" />,
    property: "issue_views_view",
  },
  {
    title: "Pages",
    description:
      "Pages are enabled for all the projects in this workspace. Access it from the sidebar.",
    icon: <DocumentTextIcon color="#fcbe1d" width={28} height={28} className="flex-shrink-0" />,
    property: "page_view",
  },
  {
    title: "Inbox",
    description:
      "Inbox are enabled for all the projects in this workspace. Access it from the issues views page.",
    icon: <InboxIcon color="#fcbe1d" width={24} height={24} className="flex-shrink-0" />,
    property: "inbox_view",
  },
];

const getEventType = (feature: string, toggle: boolean): MiscellaneousEventType => {
  switch (feature) {
    case "Cycles":
      return toggle ? "TOGGLE_CYCLE_ON" : "TOGGLE_CYCLE_OFF";
    case "Modules":
      return toggle ? "TOGGLE_MODULE_ON" : "TOGGLE_MODULE_OFF";
    case "Views":
      return toggle ? "TOGGLE_VIEW_ON" : "TOGGLE_VIEW_OFF";
    case "Pages":
      return toggle ? "TOGGLE_PAGES_ON" : "TOGGLE_PAGES_OFF";
    case "Inbox":
      return toggle ? "TOGGLE_INBOX_ON" : "TOGGLE_INBOX_OFF";
    default:
      throw new Error("Invalid feature");
  }
};

const FeaturesSettings: NextPage = () => {
  const router = useRouter();
  const { workspaceSlug, projectId } = router.query;

  const { user } = useUserAuth();

  const { setToastAlert } = useToast();

  const { data: projectDetails } = useSWR(
    workspaceSlug && projectId ? PROJECT_DETAILS(projectId as string) : null,
    workspaceSlug && projectId
      ? () => projectService.getProject(workspaceSlug as string, projectId as string)
      : null
  );

  const handleSubmit = async (formData: Partial<IProject>) => {
    if (!workspaceSlug || !projectId || !projectDetails) return;

    if (projectDetails.is_favorite)
      mutate<IFavoriteProject[]>(
        FAVORITE_PROJECTS_LIST(workspaceSlug.toString()),
        (prevData) =>
          prevData?.map((p) => {
            if (p.project === projectId)
              return {
                ...p,
                project_detail: {
                  ...p.project_detail,
                  ...formData,
                },
              };

            return p;
          }),
        false
      );

    mutate<IProject[]>(
      PROJECTS_LIST(workspaceSlug.toString()),
      (prevData) =>
        prevData?.map((p) => {
          if (p.id === projectId)
            return {
              ...p,
              ...formData,
            };

          return p;
        }),
      false
    );

    mutate<IProject>(
      PROJECT_DETAILS(projectId as string),
      (prevData) => ({ ...(prevData as IProject), ...formData }),
      false
    );

    setToastAlert({
      type: "success",
      title: "Success!",
      message: "Project feature updated successfully.",
    });

    await projectService
      .updateProject(workspaceSlug as string, projectId as string, formData, user)
      .then(() => {
        mutate(
          projectDetails.is_favorite
            ? FAVORITE_PROJECTS_LIST(workspaceSlug.toString())
            : PROJECTS_LIST(workspaceSlug.toString())
        );
        mutate(PROJECT_DETAILS(projectId as string));
      })
      .catch((err) => {
        setToastAlert({
          type: "error",
          title: "Error!",
          message: "Project feature could not be updated. Please try again.",
        });
      });
  };

  return (
    <ProjectAuthorizationWrapper
      breadcrumbs={
        <Breadcrumbs>
          <BreadcrumbItem
            title={`${projectDetails?.name ?? "Project"}`}
            link={`/${workspaceSlug}/projects/${projectDetails?.id}/issues`}
          />
          <BreadcrumbItem title="Features Settings" />
        </Breadcrumbs>
      }
    >
      <div className="p-8">
        <SettingsHeader />
        <section className="space-y-5">
          <h3 className="text-2xl font-semibold">Features</h3>
          <div className="space-y-5">
            {featuresList.map((feature) => (
              <div
                key={feature.property}
                className="flex items-center justify-between gap-x-8 gap-y-2 rounded-[10px] border border-brand-base bg-brand-base p-5"
              >
                <div className="flex items-start gap-3">
                  {feature.icon}
                  <div>
                    <h4 className="text-lg font-semibold">{feature.title}</h4>
                    <p className="text-sm text-brand-secondary">{feature.description}</p>
                  </div>
                </div>
                <ToggleSwitch
                  value={projectDetails?.[feature.property as keyof IProject]}
                  onChange={() => {
                    trackEventServices.trackMiscellaneousEvent(
                      {
                        workspaceId: (projectDetails?.workspace as any)?.id,
                        workspaceSlug,
                        projectId,
                        projectIdentifier: projectDetails?.identifier,
                        projectName: projectDetails?.name,
                      },
                      getEventType(
                        feature.title,
                        !projectDetails?.[feature.property as keyof IProject]
                      ),
                      user
                    );
                    handleSubmit({
                      [feature.property]: !projectDetails?.[feature.property as keyof IProject],
                    });
                  }}
                  size="lg"
                />
              </div>
            ))}
          </div>
          <div className="flex items-center gap-2">
            <a href="https://plane.so/" target="_blank" rel="noreferrer">
              <SecondaryButton outline>Plane is open-source, view Roadmap</SecondaryButton>
            </a>
            <a href="https://github.com/makeplane/plane" target="_blank" rel="noreferrer">
              <SecondaryButton outline>Star us on GitHub</SecondaryButton>
            </a>
          </div>
        </section>
      </div>
    </ProjectAuthorizationWrapper>
  );
};

export default FeaturesSettings;