Block editing if someone else is editing the app

lowcoder-org · FalkWolsky · Sep 20, 2024 · Sep 9, 2024 · Sep 9, 2024 · Sep 16, 2024
commit 8470a4226957c292cc7eb51d67d52830a27127b1
diff --git a/client/packages/lowcoder/src/api/applicationApi.ts b/client/packages/lowcoder/src/api/applicationApi.ts
@@ -9,6 +9,7 @@ import {
   PublishApplicationPayload,
   RecycleApplicationPayload,
   RestoreApplicationPayload,
+  SetAppEditingStatePayload,
   UpdateAppPermissionPayload,
 } from "redux/reduxActions/applicationActions";
 import { ApiResponse, GenericApiResponse } from "./apiResponses";
@@ -96,7 +97,7 @@ class ApplicationApi extends Api {
   static publicToAllURL = (applicationId: string) => `/applications/${applicationId}/public-to-all`;
   static publicToMarketplaceURL = (applicationId: string) => `/applications/${applicationId}/public-to-marketplace`;
   static getMarketplaceAppURL = (applicationId: string) => `/applications/${applicationId}/view_marketplace`;
-
+  static setAppEditingStateURL = (applicationId: string) => `/applications/editState/${applicationId}`;
 
   static fetchHomeData(request: HomeDataPayload): AxiosPromise<HomeDataResponse> {
     return Api.get(ApplicationApi.fetchHomeDataURL, request);
@@ -232,6 +233,13 @@ class ApplicationApi extends Api {
   static getMarketplaceApp(appId: string) {
     return Api.get(ApplicationApi.getMarketplaceAppURL(appId));
   }
+
+  static setAppEditingState(request: SetAppEditingStatePayload): AxiosPromise<ApplicationResp> {
+    const { applicationId, editingFinished } = request;
+    return Api.put(ApplicationApi.setAppEditingStateURL(applicationId), {
+      editingFinished,
+    });
+  }
 }
 
 export default ApplicationApi;
diff --git a/client/packages/lowcoder/src/constants/applicationConstants.ts b/client/packages/lowcoder/src/constants/applicationConstants.ts
@@ -91,6 +91,7 @@ export interface ApplicationMeta {
   folder: false;
   isLocalMarketplace?: boolean;
   applicationStatus: "NORMAL" | "RECYCLED" | "DELETED";
+  editingUserId: string | null;
 }
 
 export interface FolderMeta {

diff --git a/client/packages/lowcoder/src/constants/reduxActionConstants.ts b/client/packages/lowcoder/src/constants/reduxActionConstants.ts
@@ -144,6 +144,7 @@ export const ReduxActionTypes = {
   FETCH_ALL_MODULES_SUCCESS: "FETCH_ALL_MODULES_SUCCESS",
   FETCH_ALL_MARKETPLACE_APPS: "FETCH_ALL_MARKETPLACE_APPS",
   FETCH_ALL_MARKETPLACE_APPS_SUCCESS: "FETCH_ALL_MARKETPLACE_APPS_SUCCESS",
+  SET_APP_EDITING_STATE: "SET_APP_EDITING_STATE",
 
   /* user profile */
   SET_USER_PROFILE_SETTING_MODAL_VISIBLE: "SET_USER_PROFILE_SETTING_MODAL_VISIBLE",

diff --git a/client/packages/lowcoder/src/pages/common/header.tsx b/client/packages/lowcoder/src/pages/common/header.tsx
@@ -9,7 +9,7 @@ import {
   AUTH_LOGIN_URL,
   preview,
 } from "constants/routesURL";
-import { User } from "constants/userConstants";
+import { CurrentUser, User } from "constants/userConstants";
 import {
   CommonTextLabel,
   CustomModal,
@@ -56,6 +56,8 @@ import { EditorContext } from "../../comps/editorState";
 import Tooltip from "antd/es/tooltip";
 import { LockOutlined, ExclamationCircleOutlined } from '@ant-design/icons';
 import Avatar from 'antd/es/avatar';
+import UserApi from "@lowcoder-ee/api/userApi";
+import { validateResponse } from "@lowcoder-ee/api/apiUtils";
 
 
 const StyledLink = styled.a`
@@ -343,12 +345,26 @@ export default function Header(props: HeaderProps) {
   const [editName, setEditName] = useState(false);
   const [editing, setEditing] = useState(false);
   const [permissionDialogVisible, setPermissionDialogVisible] = useState(false);
+  const [editingUser, setEditingUser] = useState<CurrentUser>();
 
   const isModule = appType === AppTypeEnum.Module;
+  const blockEditing = useMemo(
+    () => user.id !== application?.editingUserId,
+    [application?.editingUserId]
+  );
 
-  // Raheel: Todo - get concurrent editing state by API
-  // maybe via editorState.getConcurrentAppEditingState(); as a new function?
-  const [concurrentAppEditingState, setConcurrentAppEditingState] = useState(true);
+  useEffect(() => {
+    if(blockEditing && application && Boolean(application?.editingUserId)) {
+      UserApi.getUserDetail(application.editingUserId!)
+        .then(resp => {
+          if (validateResponse(resp)) {
+            console.log(resp.data.data);
+            setEditingUser(resp.data.data);
+          }
+        });
+    }
+  }, [blockEditing]);
+  console.log(user.id, application?.editingUserId);
 
   const editorModeOptions = [
     {
@@ -491,7 +507,7 @@ export default function Header(props: HeaderProps) {
     ) : (
       <>
         {/* Display a hint about who is editing the app */}
-        {concurrentAppEditingState && (
+        {blockEditing && (
           <Tooltip
             title="Changes will not be saved while another user is editing this app."
             color="red"
@@ -500,7 +516,8 @@ export default function Header(props: HeaderProps) {
             <EditingNoticeWrapper>
               <Avatar size="small" src={user.avatarUrl} />
               <EditingHintText>
-                {`${user.username} is currently editing this app.`}
+                {/* {`${user.username} is currently editing this app.`} */}
+                {`${editingUser?.name || 'Someone'} is currently editing this app`}
               </EditingHintText>
               <WarningIcon />
             </EditingNoticeWrapper>
@@ -534,7 +551,7 @@ export default function Header(props: HeaderProps) {
             <DropdownMenuStyled
               style={{ minWidth: "110px", borderRadius: "4px" }}
               onClick={(e) => {
-                if (concurrentAppEditingState) return; // Prevent clicks if the app is being edited by someone else
+                if (blockEditing) return; // Prevent clicks if the app is being edited by someone else
                 if (e.key === "deploy") {
                   dispatch(publishApplication({ applicationId }));
                 } else if (e.key === "snapshot") {
@@ -546,31 +563,31 @@ export default function Header(props: HeaderProps) {
                   key: "deploy",
                   label: (
                     <div style={{ display: 'flex', alignItems: 'center' }}>
-                      {concurrentAppEditingState && <LockOutlined style={{ marginRight: '8px' }} />}
-                      <CommonTextLabel style= {{color: concurrentAppEditingState ? "#ccc" : "#222"}}>
+                      {blockEditing && <LockOutlined style={{ marginRight: '8px' }} />}
+                      <CommonTextLabel style= {{color: blockEditing ? "#ccc" : "#222"}}>
                         {trans("header.deploy")}
                       </CommonTextLabel>
                     </div>
                   ),
-                  disabled: concurrentAppEditingState,
+                  disabled: blockEditing,
                 },
                 {
                   key: "snapshot",
                   label: (
                     <div style={{ display: 'flex', alignItems: 'center' }}>
-                      {concurrentAppEditingState && <LockOutlined style={{ marginRight: '8px' }} />}
-                      <CommonTextLabel style= {{color: concurrentAppEditingState ? "#ccc" : "#222"}}>
+                      {blockEditing && <LockOutlined style={{ marginRight: '8px' }} />}
+                      <CommonTextLabel style= {{color: blockEditing ? "#ccc" : "#222"}}>
                         {trans("header.snapshot")}
                       </CommonTextLabel>
                     </div>
                   ),
-                  disabled: concurrentAppEditingState,
+                  disabled: blockEditing,
                 },
               ]}
             />
           )}
         >
-          <PackUpBtn buttonType="primary" disabled={concurrentAppEditingState}>
+          <PackUpBtn buttonType="primary" disabled={blockEditing}>
             <PackUpIcon />
           </PackUpBtn>
         </Dropdown>
@@ -583,7 +600,8 @@ export default function Header(props: HeaderProps) {
     showAppSnapshot,
     applicationId,
     permissionDialogVisible,
-    concurrentAppEditingState, // Include the state in the dependency array
+    blockEditing, // Include the state in the dependency array
+    editingUser?.name,
   ]);
 
   return (

diff --git a/client/packages/lowcoder/src/redux/reduxActions/applicationActions.ts b/client/packages/lowcoder/src/redux/reduxActions/applicationActions.ts
@@ -134,6 +134,12 @@ export type FetchAppInfoPayload = {
   onSuccess?: (info: AppSummaryInfo) => void;
   onError?: (error: string) => void;
 };
+
+export type SetAppEditingStatePayload = {
+  applicationId: string;
+  editingFinished: boolean;
+};
+
 export const fetchApplicationInfo = (payload: FetchAppInfoPayload) => ({
   type: ReduxActionTypes.FETCH_APPLICATION_DETAIL,
   payload: payload,
@@ -170,3 +176,8 @@ export const deleteAppPermission = (payload: DeleteAppPermissionPayload) => ({
   type: ReduxActionTypes.DELETE_APP_PERMISSION,
   payload: payload,
 });
+
+export const setAppEditingState = (payload: SetAppEditingStatePayload) => ({
+  type: ReduxActionTypes.SET_APP_EDITING_STATE,
+  payload: payload,
+});
diff --git a/client/packages/lowcoder/src/redux/sagas/applicationSagas.ts b/client/packages/lowcoder/src/redux/sagas/applicationSagas.ts
@@ -22,6 +22,7 @@ import {
   PublishApplicationPayload,
   RecycleApplicationPayload,
   RestoreApplicationPayload,
+  SetAppEditingStatePayload,
   UpdateApplicationPayload,
   UpdateAppMetaPayload,
   UpdateAppPermissionPayload,
@@ -391,6 +392,17 @@ function* fetchAllMarketplaceAppsSaga() {
   }
 }
 
+function* setAppEditingStateSaga(action: ReduxAction<SetAppEditingStatePayload>) {
+  try {
+    yield call(
+      ApplicationApi.setAppEditingState,
+      action.payload
+    ); 
+  } catch (error) {
+    log.debug("set app editing state: ", error);
+  }
+}
+
 export default function* applicationSagas() {
   yield all([
     takeLatest(ReduxActionTypes.FETCH_HOME_DATA, fetchHomeDataSaga),
@@ -416,5 +428,6 @@ export default function* applicationSagas() {
       ReduxActionTypes.FETCH_ALL_MARKETPLACE_APPS,
       fetchAllMarketplaceAppsSaga,
     ),
+    takeLatest(ReduxActionTypes.SET_APP_EDITING_STATE, setAppEditingStateSaga),
   ]);
 }