@finos/legend-application-studio 28.4.4 → 28.5.0

package/src/components/editor/side-bar/ProjectOverview.tsx

@@ -37,6 +37,7 @@ import {
   ModalFooter,
   MenuContentItem,
   MenuContent,
+  PanelFormBooleanField,
 } from '@finos/legend-art';
 import { PROJECT_OVERVIEW_ACTIVITY_MODE } from '../../../stores/editor/sidebar-state/ProjectOverviewState.js';
 import {
@@ -52,10 +53,24 @@ import {
   NewVersionType,
   WorkspaceType,
   areWorkspacesEquivalent,
+  Review,
+  ReviewState,
+  Patch,
 } from '@finos/legend-server-sdlc';
 import { useEditorStore } from '../EditorStoreProvider.js';
 import { useApplicationStore } from '@finos/legend-application';
 import { useLegendStudioApplicationStore } from '../../LegendStudioFrameworkProvider.js';
+import {
+  ActionState,
+  assertErrorThrown,
+  guaranteeNonNullable,
+  LogEvent,
+} from '@finos/legend-shared';
+import type { VersionOption } from '../editor-group/project-configuration-editor/ProjectDependencyEditor.js';
+import { DocumentationLink } from '@finos/legend-lego/application';
+import { LEGEND_STUDIO_DOCUMENTATION_KEY } from '../../../__lib__/LegendStudioDocumentation.js';
+import type { PatchOption } from '../../workspace-setup/CreateWorkspaceModal.js';
+import { LEGEND_STUDIO_APP_EVENT } from '../../../__lib__/LegendStudioEvent.js';
 
 const ShareProjectModal = observer(
   (props: { open: boolean; closeModal: () => void }) => {
@@ -180,10 +195,10 @@ const WorkspaceViewer = observer((props: { workspace: Workspace }) => {
   const { workspace } = props;
   const editorStore = useEditorStore();
   const applicationStore = useApplicationStore();
-  const isActive = areWorkspacesEquivalent(
-    editorStore.sdlcState.activeWorkspace,
-    workspace,
-  );
+  const isActive =
+    areWorkspacesEquivalent(editorStore.sdlcState.activeWorkspace, workspace) &&
+    workspace.source ===
+      editorStore.sdlcState.activePatch?.patchReleaseVersionId.id;
   const [isSelectedFromContextMenu, setIsSelectedFromContextMenu] =
     useState(false);
   const onContextMenuOpen = (): void => setIsSelectedFromContextMenu(true);
@@ -210,6 +225,7 @@ const WorkspaceViewer = observer((props: { workspace: Workspace }) => {
             applicationStore.navigationService.navigator.generateAddress(
               generateEditorRoute(
                 workspace.projectId,
+                editorStore.sdlcState.activePatch?.patchReleaseVersionId.id,
                 workspace.workspaceId,
                 workspace.workspaceType,
               ),
@@ -226,9 +242,14 @@ const WorkspaceViewer = observer((props: { workspace: Workspace }) => {
               <UserIcon />
             )}
           </div>
-          <div className="project-overview__item__link__content__name">
+          <div className="project-overview__item__link__content__name project-overview__workspace__viewer__label">
             {workspace.workspaceId}
           </div>
+          {workspace.source && (
+            <div className="project-overview__workspace__viewer__source">
+              {`patch/${workspace.source}`}
+            </div>
+          )}
         </div>
       </button>
     </ContextMenu>
@@ -276,7 +297,7 @@ const WorkspacesViewer = observer(() => {
         >
           {workspaces.map((workspace) => (
             <WorkspaceViewer
-              key={`${workspace.workspaceType}.${workspace.workspaceId}`}
+              key={`${workspace.workspaceType}.${workspace.workspaceId}.${workspace.source}`}
               workspace={workspace}
             />
           ))}
@@ -324,7 +345,11 @@ const ReleaseEditor = observer(() => {
     flowResult(projectOverviewState.fetchLatestProjectVersion()).catch(
       applicationStore.alertUnhandledError,
     );
-  }, [applicationStore, projectOverviewState]);
+  }, [
+    applicationStore,
+    editorStore.sdlcState.activePatch,
+    projectOverviewState,
+  ]);
 
   return (
     <div className="panel side-bar__panel project-overview__panel project-overview__release">
@@ -337,7 +362,11 @@ const ReleaseEditor = observer(() => {
       </div>
       <div className="panel__content project-overview__release__panel__content project-overview__release__content">
         <PanelLoadingIndicator isLoading={isDispatchingAction} />
-        <div className="project-overview__release__editor">
+        <div
+          className={clsx(
+            'project-overview__release__editor project-overview__release__editor__project',
+          )}
+        >
           <textarea
             className="project-overview__release__editor__input input--dark"
             spellCheck={false}
@@ -483,6 +512,306 @@ const ReleaseEditor = observer(() => {
   );
 });
 
+const PatchEditor = observer(() => {
+  const editorStore = useEditorStore();
+  const applicationStore = useLegendStudioApplicationStore();
+  const projectOverviewState = editorStore.projectOverviewState;
+  const [versionOptions] = useState<VersionOption[]>(
+    editorStore.sdlcState.projectVersions.map((v) => ({
+      label: v.id.id,
+      value: v.id.id,
+    })),
+  );
+  const [selectedVersionOption, setSelectedVersionOption] =
+    useState<VersionOption | null>(null);
+  const patches = projectOverviewState.patches;
+  const [selectedPatchOption, setSelectedPatchOption] =
+    useState<PatchOption | null>(null);
+  const [workspaceName, setWorkspaceName] = useState<string>('');
+  const [isGroupWorkspace, setIsGroupWorkspace] = useState<boolean>(true);
+  const [committedReviews, setCommittedReviews] = useState<Review[]>([]);
+  const [fetchSelectedPatchCommittedReviews] = useState(ActionState.create());
+  const onPatchOptionChange = async (
+    val: PatchOption | null,
+  ): Promise<void> => {
+    if (
+      (val !== null || selectedPatchOption !== null) &&
+      (!val || !selectedPatchOption || val.value !== selectedPatchOption.value)
+    ) {
+      setSelectedPatchOption(val);
+      fetchSelectedPatchCommittedReviews.inProgress();
+      try {
+        if (val && val.value instanceof Patch) {
+          const reviews = await editorStore.sdlcServerClient.getReviews(
+            projectOverviewState.sdlcState.activeProject.projectId,
+            val.value.patchReleaseVersionId.id,
+            {
+              state: ReviewState.COMMITTED,
+            },
+          );
+          setCommittedReviews(
+            reviews.map((v) => Review.serialization.fromJson(v)),
+          );
+        } else {
+          setCommittedReviews([]);
+        }
+      } catch (error) {
+        assertErrorThrown(error);
+        editorStore.applicationStore.logService.error(
+          LogEvent.create(LEGEND_STUDIO_APP_EVENT.SDLC_MANAGER_FAILURE),
+          error,
+        );
+      } finally {
+        fetchSelectedPatchCommittedReviews.reset();
+      }
+    } else {
+      setCommittedReviews([]);
+    }
+  };
+  const onVersionOptionChange = (val: VersionOption | null): void => {
+    if (
+      (val !== null || selectedVersionOption !== null) &&
+      (!val ||
+        !selectedVersionOption ||
+        val.value !== selectedVersionOption.value)
+    ) {
+      setSelectedVersionOption(val);
+    }
+  };
+  const createPatch = (): void => {
+    if (selectedVersionOption) {
+      flowResult(
+        projectOverviewState.createPatch(
+          selectedVersionOption.value,
+          workspaceName,
+          isGroupWorkspace ? WorkspaceType.GROUP : WorkspaceType.USER,
+        ),
+      ).catch(applicationStore.alertUnhandledError);
+    }
+  };
+  const toggleGroupWorkspace = (): void => {
+    setIsGroupWorkspace(!isGroupWorkspace);
+  };
+  const changeWorkspaceName: React.ChangeEventHandler<HTMLInputElement> = (
+    event,
+  ) => setWorkspaceName(event.target.value);
+  const isDispatchingAction =
+    projectOverviewState.isFetchingLatestVersion ||
+    projectOverviewState.isFetchingCurrentProjectRevision ||
+    projectOverviewState.isCreatingVersion;
+  const { latestProjectVersion, currentProjectRevision } = projectOverviewState;
+  const createPatchRelease = applicationStore.guardUnhandledError(() =>
+    flowResult(
+      projectOverviewState.createPatchVersion(
+        guaranteeNonNullable(selectedPatchOption).label,
+      ),
+    ),
+  );
+  const isCurrentProjectVersionLatest =
+    Boolean(latestProjectVersion) &&
+    latestProjectVersion?.revisionId === currentProjectRevision?.id;
+  const canCreateVersion =
+    !isCurrentProjectVersionLatest &&
+    !isDispatchingAction &&
+    editorStore.sdlcServerClient.features.canCreateVersion;
+  const patchBlurb = `Releasing above mentioned version would delete the upstream branch created for doing this patch release. By doing so you won't be access any of the branches created for development for doing this patch release`;
+
+  useEffect(() => {
+    flowResult(projectOverviewState.fetchPatches()).catch(
+      applicationStore.alertUnhandledError,
+    );
+  }, [
+    applicationStore.alertUnhandledError,
+    applicationStore.notificationService,
+    editorStore.sdlcServerClient,
+    editorStore.sdlcState.activeProject.projectId,
+
+    projectOverviewState,
+  ]);
+
+  return (
+    <div className="panel side-bar__panel project-overview__panel project-overview__patch">
+      <div className="panel__header">
+        <div className="panel__header__title">
+          <div className="panel__header__title__content">
+            Create Patch
+            <DocumentationLink
+              className="project-overview__patch__documentation"
+              documentationKey={LEGEND_STUDIO_DOCUMENTATION_KEY.CREATE_PATCH}
+            />
+          </div>
+        </div>
+      </div>
+      <div className="panel__content project-overview__panel__content">
+        <div
+          className={clsx('project-overview__patch__create', {
+            'project-overview__patch__create--progress':
+              projectOverviewState.createPatchState.isInProgress,
+          })}
+        >
+          <PanelLoadingIndicator
+            isLoading={projectOverviewState.createPatchState.isInProgress}
+          />
+          <div className="project-overview__patch__content__progress-msg">
+            {projectOverviewState.createPatchState.message}
+          </div>
+          <div className="panel__content__form">
+            <div className="panel__content__form__section">
+              <div className="panel__content__form__section__header__label">
+                Source Version
+              </div>
+              <CustomSelectorInput
+                className="project-overview__patch__source__version__selector"
+                options={versionOptions}
+                onChange={onVersionOptionChange}
+                value={selectedVersionOption}
+                placeholder={'Select source version'}
+                isClearable={true}
+                escapeClearsValue={true}
+                darkMode={true}
+              />
+            </div>
+          </div>
+          <div className="panel__content__form">
+            <div className="panel__content__form__section">
+              <div className="panel__content__form__section__header__label">
+                Workspace Name
+              </div>
+              <input
+                className="panel__content__form__section__input"
+                title="Workspace Name"
+                spellCheck={false}
+                value={workspaceName}
+                placeholder="Workspace Name"
+                onChange={changeWorkspaceName}
+              />
+            </div>
+          </div>
+          <div className="panel__content__form__section project-overview__patch__workspace__type__button">
+            <PanelFormBooleanField
+              name="Group Workspace"
+              prompt="Group workspaces can be accessed by all users in the project"
+              value={isGroupWorkspace}
+              isReadOnly={false}
+              update={toggleGroupWorkspace}
+            />
+          </div>
+          <div className="panel__content__form__section__list__new-item__add">
+            <button
+              disabled={
+                projectOverviewState.createPatchState.isInProgress ||
+                !editorStore.sdlcServerClient.features.canCreateVersion ||
+                !selectedVersionOption
+              }
+              onClick={(): void => createPatch()}
+              className="panel__content__form__section__list__new-item__add-btn btn btn--dark project-overview__patch__create__button"
+            >
+              Create
+            </button>
+          </div>
+        </div>
+        <div className="project-overview__patch__release">
+          <div className="panel__header">
+            <div className="panel__header__title">
+              <div className="panel__header__title__content">Release Patch</div>
+            </div>
+          </div>
+          <div className="project-overview__patch__release">
+            <PanelLoadingIndicator isLoading={isDispatchingAction} />
+            <>
+              <div className="panel__content__form">
+                <div className="panel__content__form__section">
+                  <div className="panel__content__form__section__header__label">
+                    Patch
+                  </div>
+                  <CustomSelectorInput
+                    className="project-overview__patch__source__version__selector"
+                    options={patches.map((p) => ({
+                      label: p.patchReleaseVersionId.id,
+                      value: p,
+                    }))}
+                    onChange={onPatchOptionChange}
+                    value={selectedPatchOption}
+                    placeholder={'Select patch you want to release'}
+                    isClearable={true}
+                    escapeClearsValue={true}
+                    darkMode={true}
+                  />
+                </div>
+              </div>
+              <div className="project-overview__patch__release__content">
+                {patchBlurb}
+              </div>
+              <div className="panel__content__form__section__list__new-item__add">
+                <button
+                  className="panel__content__form__section__list__new-item__add-btn btn btn--dark project-overview__patch__release__button"
+                  onClick={createPatchRelease}
+                  disabled={!canCreateVersion && !selectedPatchOption}
+                  title={'Create a patch release'}
+                >
+                  Release
+                </button>
+              </div>
+            </>
+          </div>
+        </div>
+
+        <div className="project-overview__release__info">
+          <div className="panel project-overview__release__info__reviews">
+            <div className="panel__header">
+              <div className="panel__header__title">
+                <div className="panel__header__title__content">
+                  COMMITTED REVIEWS
+                </div>
+                <div
+                  className="side-bar__panel__title__info"
+                  title="All committed reviews in the patch since it got created"
+                >
+                  <InfoCircleIcon />
+                </div>
+              </div>
+              <div
+                className="side-bar__panel__header__changes-count"
+                data-testid={
+                  LEGEND_STUDIO_TEST_ID.SIDEBAR_PANEL_HEADER__CHANGES_COUNT
+                }
+              >
+                {committedReviews.length}
+              </div>
+            </div>
+            <PanelContent>
+              {committedReviews.map((review) => (
+                <button
+                  key={review.id}
+                  className="side-bar__panel__item workspace-updater__review__link"
+                  tabIndex={-1}
+                  onClick={(): void =>
+                    applicationStore.navigationService.navigator.visitAddress(
+                      applicationStore.navigationService.navigator.generateAddress(
+                        generateReviewRoute(review.projectId, review.id),
+                      ),
+                    )
+                  }
+                  title="See review"
+                >
+                  <div className="workspace-updater__review">
+                    <span className="workspace-updater__review__name">
+                      {review.title}
+                    </span>
+                    <span className="workspace-updater__review__info">
+                      {review.author.name}
+                    </span>
+                  </div>
+                </button>
+              ))}
+            </PanelContent>
+          </div>
+        </div>
+      </div>
+    </div>
+  );
+});
+
 const VersionsViewer = observer(() => {
   const editorStore = useEditorStore();
   const applicationStore = useLegendStudioApplicationStore();
@@ -815,6 +1144,7 @@ export const ProjectOverviewActivityBar = observer(() => {
     },
     { mode: PROJECT_OVERVIEW_ACTIVITY_MODE.VERSIONS, title: 'Versions' },
     { mode: PROJECT_OVERVIEW_ACTIVITY_MODE.WORKSPACES, title: 'Workspaces' },
+    { mode: PROJECT_OVERVIEW_ACTIVITY_MODE.PATCH, title: 'Patch' },
   ]
     .filter((activity): activity is ProjectOverviewActivityDisplay =>
       Boolean(activity),
@@ -876,6 +1206,8 @@ export const ProjectOverview = observer(() => {
         return <VersionsViewer />;
       case PROJECT_OVERVIEW_ACTIVITY_MODE.WORKSPACES:
         return <WorkspacesViewer />;
+      case PROJECT_OVERVIEW_ACTIVITY_MODE.PATCH:
+        return <PatchEditor />;
       default:
         return null;
     }

package/src/components/project-view/ProjectViewer.tsx

@@ -115,7 +115,7 @@ const ProjectViewerStatusBar = observer(() => {
                 onClick={(): void =>
                   applicationStore.navigationService.navigator.visitAddress(
                     applicationStore.navigationService.navigator.generateAddress(
-                      generateSetupRoute(projectId),
+                      generateSetupRoute(projectId, undefined),
                     ),
                   )
                 }

package/src/components/workspace-review/WorkspaceReview.tsx

@@ -87,7 +87,7 @@ const WorkspaceReviewStatusBar = observer(() => {
             onClick={(): void =>
               applicationStore.navigationService.navigator.visitAddress(
                 applicationStore.navigationService.navigator.generateAddress(
-                  generateSetupRoute(reviewStore.projectId),
+                  generateSetupRoute(reviewStore.projectId, undefined),
                 ),
               )
             }

package/src/components/workspace-setup/CreateWorkspaceModal.tsx

@@ -25,14 +25,23 @@ import {
   PanelDivider,
   PanelForm,
   PanelFormBooleanField,
+  CustomSelectorInput,
 } from '@finos/legend-art';
 import { flowResult } from 'mobx';
-import { type Project, WorkspaceType } from '@finos/legend-server-sdlc';
+import { type Project, WorkspaceType, Patch } from '@finos/legend-server-sdlc';
 import { useApplicationStore } from '@finos/legend-application';
 import { LEGEND_STUDIO_DOCUMENTATION_KEY } from '../../__lib__/LegendStudioDocumentation.js';
-import { useWorkspaceSetupStore } from './WorkspaceSetup.js';
+import {
+  DEFAULT_WORKSPACE_SOURCE,
+  useWorkspaceSetupStore,
+} from './WorkspaceSetup.js';
 import { DocumentationLink } from '@finos/legend-lego/application';
 
+export interface PatchOption {
+  label: string;
+  value: Patch | string;
+}
+
 export const CreateWorkspaceModal = observer(
   (props: { selectedProject: Project }) => {
     const { selectedProject } = props;
@@ -41,6 +50,35 @@ export const CreateWorkspaceModal = observer(
     const workspaceNameInputRef = useRef<HTMLInputElement>(null);
     const [workspaceName, setWorkspaceName] = useState('');
     const [isGroupWorkspace, setIsGroupWorkspace] = useState<boolean>(true);
+    const [patchOptions] = useState<PatchOption[]>(
+      [
+        {
+          label: DEFAULT_WORKSPACE_SOURCE,
+          value: DEFAULT_WORKSPACE_SOURCE,
+        } as PatchOption,
+      ].concat(
+        setupStore.patches.map((p) => ({
+          label: `patch/${p.patchReleaseVersionId.id}`,
+          value: p,
+        })),
+      ),
+    );
+    const [selectedPatchOption, setSelectedPatchOption] =
+      useState<PatchOption | null>({
+        label: DEFAULT_WORKSPACE_SOURCE,
+        value: DEFAULT_WORKSPACE_SOURCE,
+      });
+
+    const onPatchOptionChange = (val: PatchOption | null): void => {
+      if (
+        (val !== null || selectedPatchOption !== null) &&
+        (!val ||
+          !selectedPatchOption ||
+          val.value !== selectedPatchOption.value)
+      ) {
+        setSelectedPatchOption(val);
+      }
+    };
 
     const workspaceAlreadyExists = Boolean(
       setupStore.workspaces.find(
@@ -49,7 +87,12 @@ export const CreateWorkspaceModal = observer(
           ((workspace.workspaceType === WorkspaceType.GROUP &&
             isGroupWorkspace) ||
             (workspace.workspaceType === WorkspaceType.USER &&
-              !isGroupWorkspace)),
+              !isGroupWorkspace)) &&
+          ((!workspace.source &&
+            !(selectedPatchOption?.value instanceof Patch)) ||
+            (selectedPatchOption?.value instanceof Patch &&
+              workspace.source ===
+                selectedPatchOption.value.patchReleaseVersionId.id)),
       ),
     );
     const createWorkspace = (): void => {
@@ -60,6 +103,9 @@ export const CreateWorkspaceModal = observer(
         flowResult(
           setupStore.createWorkspace(
             selectedProject.projectId,
+            selectedPatchOption?.value instanceof Patch
+              ? selectedPatchOption.value.patchReleaseVersionId.id
+              : undefined,
             workspaceName,
             isGroupWorkspace ? WorkspaceType.GROUP : WorkspaceType.USER,
           ),
@@ -130,7 +176,20 @@ export const CreateWorkspaceModal = observer(
                     : ''
                 }
               />
-
+              <div className="workspace-setup__create-workspace-modal__form__workspace--source">
+                <div className="workspace-setup__create-workspace-modal__form__workspace--source__label">
+                  Workspace Source
+                </div>
+                <CustomSelectorInput
+                  className="workspace-setup__create-workspace-modal__form__workspace--source__selector"
+                  options={patchOptions}
+                  onChange={onPatchOptionChange}
+                  value={selectedPatchOption}
+                  isClearable={true}
+                  escapeClearsValue={true}
+                  darkMode={true}
+                />
+              </div>
               <PanelFormBooleanField
                 name="Group Workspace"
                 prompt="Group workspaces can be accessed by all users in the project"

package/src/components/workspace-setup/WorkspaceSelectorUtils.tsx

@@ -33,13 +33,20 @@ export const formatWorkspaceOptionLabel = (
   option: WorkspaceOption,
 ): React.ReactNode => (
   <div className="workspace-selector__option">
-    <div className="workspace-selector__option__icon">
-      {option.value.workspaceType === WorkspaceType.GROUP ? (
-        <UsersIcon />
-      ) : (
-        <UserIcon />
+    <div className="workspace-selector__option__label">
+      <div className="workspace-selector__option__icon">
+        {option.value.workspaceType === WorkspaceType.GROUP ? (
+          <UsersIcon />
+        ) : (
+          <UserIcon />
+        )}
+      </div>
+      <div className="workspace-selector__option__name">{option.label}</div>
+    </div>
+    <div className="workspace-selector__option__source">
+      {option.value.source && (
+        <div className="workspace-selector__option__source__patch">{`patch/${option.value.source}`}</div>
       )}
     </div>
-    <div className="workspace-selector__option__name">{option.label}</div>
   </div>
 );

package/src/components/workspace-setup/WorkspaceSetup.tsx

@@ -62,6 +62,8 @@ const WorkspaceSetupStoreContext = createContext<
   WorkspaceSetupStore | undefined
 >(undefined);
 
+export const DEFAULT_WORKSPACE_SOURCE = 'HEAD';
+
 const WorkspaceSetupStoreProvider: React.FC<{
   children: React.ReactNode;
 }> = ({ children }) => {
@@ -175,6 +177,7 @@ export const WorkspaceSetup = withWorkspaceSetupStore(
         applicationStore.navigationService.navigator.goToLocation(
           generateEditorRoute(
             setupStore.currentProject.projectId,
+            setupStore.currentWorkspace.source,
             setupStore.currentWorkspace.workspaceId,
             setupStore.currentWorkspace.workspaceType,
           ),

package/src/stores/LegendStudioApplicationPlugin.ts

@@ -331,5 +331,5 @@ export interface DSL_LegendStudioApplicationPlugin_Extension
    * Get a string of the Pure grammar element name for auto-folding the element
    * (e.g. Diagram, or Text)
    */
-  getAutoFoldingCandidateToken?(): string[];
+  getExtraGrammarTextEditorAutoFoldingElementCreatorKeywords?(): string[];
 }