PromucFlow_constructor/app/client/src/ce/sagas/WorkspaceSagas.ts
Ankit Srivastava a45dcfa61f
feat: Homepage experience v2 changes (#29282)
> Pull Request Template
>
> Use this template to quickly create a well written pull request.
Delete all quotes before creating the pull request.
>
## Description
> Add a TL;DR when description is extra long (helps content team)
>
> Please include a summary of the changes and which issue has been
fixed. Please also include relevant motivation
> and context. List any dependencies that are required for this change
>
> Links to Notion, Figma or any other documents that might be relevant
to the PR
>
>
#### PR fixes following issue(s)
Fixes # (issue number)
> if no issue exists, please create an issue and ask the maintainers
about this first
>
>
#### Media
> A video or a GIF is preferred. when using Loom, don’t embed because it
looks like it’s a GIF. instead, just link to the video
>
>
#### Type of change
> Please delete options that are not relevant.
- Bug fix (non-breaking change which fixes an issue)
- New feature (non-breaking change which adds functionality)
- Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- Chore (housekeeping or task changes that don't impact user perception)
- This change requires a documentation update
>
>
>
## Testing
>
#### How Has This Been Tested?
> Please describe the tests that you ran to verify your changes. Also
list any relevant details for your test configuration.
> Delete anything that is not relevant
- [ ] Manual
- [ ] JUnit
- [ ] Jest
- [ ] Cypress
>
>
#### Test Plan
> Add Testsmith test cases links that relate to this PR
>
>
#### Issues raised during DP testing
> Link issues raised during DP testing for better visiblity and tracking
(copy link from comments dropped on this PR)
>
>
>
## Checklist:
#### Dev activity
- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] PR is being merged under a feature flag


#### QA activity:
- [ ] [Speedbreak
features](https://github.com/appsmithorg/TestSmith/wiki/Guidelines-for-test-plans#speedbreakers-)
have been covered
- [ ] Test plan covers all impacted features and [areas of
interest](https://github.com/appsmithorg/TestSmith/wiki/Guidelines-for-test-plans#areas-of-interest-)
- [ ] Test plan has been peer reviewed by project stakeholders and other
QA members
- [ ] Manually tested functionality on DP
- [ ] We had an implementation alignment call with stakeholders post QA
Round 2
- [ ] Cypress test cases have been added and approved by SDET/manual QA
- [ ] Added `Test Plan Approved` label after Cypress tests were reviewed
- [ ] Added `Test Plan Approved` label after JUnit tests were reviewed


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **New Features**
    - Added new workspace search functionality in the search bar.
    - Introduced a help button for user assistance.
- Implemented new UI components for workspace selection and management.
    - Enhanced application card with edit permission checks.
- Integrated workspace actions for creating and fetching workspaces
directly from the UI.

- **Improvements**
    - Improved workspace and application fetching logic.
    - Enhanced Global Search with updated import paths and logic.
- Refined the layout and styling of the applications page and sub-header
components.
- Optimized workspace-related sagas and reducers for better performance
and maintainability.

- **Bug Fixes**
- Fixed tooltip functionality in "Reconnect Datasources" within
templates.
    - Corrected test logic for forking templates and applications.
    - Updated Cypress test commands for consistency and reliability.
- Addressed issues with application URL test cases and workspace import
logic.

- **Documentation**
- Updated messages and constants related to workspace and application UI
elements for clearer user communication.

- **Chores**
- Cleaned up unused code and simplified selectors across various
components and tests.
- Refactored application and workspace selectors for improved code
organization.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Dipyaman Biswas <dipyaman@appsmith.com>
Co-authored-by: Abhijeet <abhi.nagarnaik@gmail.com>
Co-authored-by: Nidhi <nidhi@appsmith.com>
Co-authored-by: Goutham Pratapa <goutham@appsmith.com>
Co-authored-by: Ankita Kinger <ankita@appsmith.com>
Co-authored-by: albinAppsmith <87797149+albinAppsmith@users.noreply.github.com>
Co-authored-by: Shrikant Sharat Kandula <shrikant@appsmith.com>
Co-authored-by: Nayan <nayan@appsmith.com>
Co-authored-by: Rishabh Rathod <rishabh.rathod@appsmith.com>
2024-01-25 19:11:48 +05:30

434 lines
12 KiB
TypeScript

import { call, put, select } from "redux-saga/effects";
import type {
ReduxAction,
ReduxActionWithPromise,
} from "@appsmith/constants/ReduxActionConstants";
import {
ReduxActionTypes,
ReduxActionErrorTypes,
} from "@appsmith/constants/ReduxActionConstants";
import {
validateResponse,
callAPI,
getResponseErrorMessage,
} from "sagas/ErrorSagas";
import type {
SaveWorkspaceRequest,
FetchWorkspaceRequest,
FetchWorkspaceResponse,
CreateWorkspaceRequest,
FetchAllUsersResponse,
FetchAllUsersRequest,
FetchAllRolesResponse,
DeleteWorkspaceUserRequest,
ChangeUserRoleRequest,
FetchAllRolesRequest,
SaveWorkspaceLogo,
FetchWorkspacesResponse,
} from "@appsmith/api/WorkspaceApi";
import WorkspaceApi from "@appsmith/api/WorkspaceApi";
import type { ApiResponse } from "api/ApiResponses";
import { getFetchedWorkspaces } from "@appsmith/selectors/workspaceSelectors";
import { getCurrentUser } from "selectors/usersSelectors";
import type { Workspace } from "@appsmith/constants/workspaceConstants";
import history from "utils/history";
import { APPLICATIONS_URL } from "constants/routes";
import log from "loglevel";
import type { User } from "constants/userConstants";
import {
createMessage,
DELETE_WORKSPACE_SUCCESSFUL,
} from "@appsmith/constants/messages";
import { toast } from "design-system";
import { resetSearchEntity } from "@appsmith/actions/workspaceActions";
import { failFastApiCalls } from "sagas/InitSagas";
import { getWorkspaceEntitiesActions } from "@appsmith/utils/workspaceHelpers";
import type { SearchApiResponse } from "@appsmith/types/ApiResponseTypes";
import SearchApi from "api/SearchApi";
export function* fetchAllWorkspacesSaga(
action?: ReduxAction<{ workspaceId?: string; fetchEntities: boolean }>,
) {
try {
const response: FetchWorkspacesResponse = yield call(
WorkspaceApi.fetchAllWorkspaces,
);
const isValidResponse: boolean = yield validateResponse(response);
if (isValidResponse) {
const workspaces: Workspace[] = response.data;
yield put({
type: ReduxActionTypes.FETCH_ALL_WORKSPACES_SUCCESS,
payload: workspaces,
});
if (action?.payload?.workspaceId || action?.payload?.fetchEntities) {
yield call(fetchEntitiesOfWorkspaceSaga, action);
}
}
} catch (error) {
yield put({
type: ReduxActionErrorTypes.FETCH_USER_APPLICATIONS_WORKSPACES_ERROR,
payload: {
error,
},
});
}
}
export function* fetchEntitiesOfWorkspaceSaga(
action?: ReduxAction<{ workspaceId?: string }>,
) {
try {
const allWorkspaces: Workspace[] = yield select(getFetchedWorkspaces);
const workspaceId = action?.payload?.workspaceId || allWorkspaces[0]?.id;
const activeWorkspace = allWorkspaces.find(
(workspace) => workspace.id === workspaceId,
);
const { errorActions, initActions, successActions } =
getWorkspaceEntitiesActions(workspaceId);
yield put({
type: ReduxActionTypes.SET_CURRENT_WORKSPACE,
payload: { ...activeWorkspace },
});
if (workspaceId) {
yield call(failFastApiCalls, initActions, successActions, errorActions);
}
} catch (error) {
yield put({
type: ReduxActionErrorTypes.FETCH_WORKSPACE_ENTITIES_ERROR,
payload: {
error,
},
});
}
}
export function* fetchWorkspaceSaga(
action: ReduxAction<FetchWorkspaceRequest>,
) {
try {
const request: FetchWorkspaceRequest = action.payload;
const response: FetchWorkspaceResponse = yield call(
WorkspaceApi.fetchWorkspace,
request,
);
const isValidResponse: boolean = yield request.skipValidation ||
validateResponse(response);
if (isValidResponse && response) {
yield put({
type: ReduxActionTypes.FETCH_WORKSPACE_SUCCESS,
payload: response.data || {},
});
}
} catch (error) {
yield put({
type: ReduxActionErrorTypes.FETCH_WORKSPACE_ERROR,
payload: {
error,
},
});
}
}
export function* fetchAllUsersSaga(action: ReduxAction<FetchAllUsersRequest>) {
try {
const request: FetchAllUsersRequest = action.payload;
const response: FetchAllUsersResponse = yield call(
WorkspaceApi.fetchAllUsers,
request,
);
const isValidResponse: boolean = yield validateResponse(response);
if (isValidResponse) {
const users = response.data.map((user) => ({
...user,
isDeleting: false,
isChangingRole: false,
}));
yield put({
type: ReduxActionTypes.FETCH_ALL_USERS_SUCCESS,
payload: users,
});
yield put({
type: ReduxActionTypes.GET_ALL_USERS_OF_WORKSPACE_SUCCESS,
payload: users,
});
}
} catch (error) {
yield put({
type: ReduxActionErrorTypes.FETCH_ALL_USERS_ERROR,
payload: {
error,
},
});
}
}
export function* changeWorkspaceUserRoleSaga(
action: ReduxAction<ChangeUserRoleRequest>,
) {
try {
const request: ChangeUserRoleRequest = action.payload;
const response: ApiResponse = yield call(
WorkspaceApi.changeWorkspaceUserRole,
request,
);
const isValidResponse: boolean = yield validateResponse(response);
if (isValidResponse) {
yield put({
type: ReduxActionTypes.CHANGE_WORKSPACE_USER_ROLE_SUCCESS,
payload: response.data,
});
}
} catch (error) {
yield put({
type: ReduxActionErrorTypes.CHANGE_WORKSPACE_USER_ROLE_ERROR,
payload: {
error,
},
});
}
}
export function* deleteWorkspaceUserSaga(
action: ReduxAction<DeleteWorkspaceUserRequest>,
) {
try {
const request: DeleteWorkspaceUserRequest = action.payload;
const response: ApiResponse = yield call(
WorkspaceApi.deleteWorkspaceUser,
request,
);
const isValidResponse: boolean = yield validateResponse(response);
if (isValidResponse) {
const currentUser: User | undefined = yield select(getCurrentUser);
if (currentUser?.username == action.payload.username) {
history.replace(APPLICATIONS_URL);
} else {
yield put({
type: ReduxActionTypes.DELETE_WORKSPACE_USER_SUCCESS,
payload: {
username: action.payload.username,
},
});
}
//@ts-expect-error: response is of type unknown
toast.show(`${response.data.username} has been removed successfully`, {
kind: "success",
});
}
} catch (error) {
yield put({
type: ReduxActionErrorTypes.DELETE_WORKSPACE_USER_ERROR,
payload: {
error,
},
});
}
}
export function* fetchAllRolesSaga(action: ReduxAction<FetchAllRolesRequest>) {
try {
const request: FetchAllRolesRequest = action.payload;
const response: FetchAllRolesResponse = yield call(
WorkspaceApi.fetchAllRoles,
request,
);
const isValidResponse: boolean = yield validateResponse(response);
if (isValidResponse) {
yield put({
type: ReduxActionTypes.FETCH_ALL_ROLES_SUCCESS,
payload: response.data,
});
}
} catch (error) {
yield put({
type: ReduxActionErrorTypes.FETCH_ALL_ROLES_ERROR,
});
}
}
export function* saveWorkspaceSaga(action: ReduxAction<SaveWorkspaceRequest>) {
try {
const request: SaveWorkspaceRequest = action.payload;
const response: ApiResponse = yield call(
WorkspaceApi.saveWorkspace,
request,
);
const isValidResponse: boolean = yield validateResponse(response);
if (isValidResponse) {
yield put({
type: ReduxActionTypes.SAVE_WORKSPACE_SUCCESS,
payload: request,
});
}
} catch (error) {
yield put({
type: ReduxActionErrorTypes.SAVE_WORKSPACE_ERROR,
payload: {
error: (error as Error).message,
},
});
}
}
export function* deleteWorkspaceSaga(action: ReduxAction<string>) {
try {
yield put({
type: ReduxActionTypes.SAVING_WORKSPACE_INFO,
});
const workspaceId: string = action.payload;
const response: ApiResponse = yield call(
WorkspaceApi.deleteWorkspace,
workspaceId,
);
const isValidResponse: boolean = yield validateResponse(response);
if (isValidResponse) {
yield put({
type: ReduxActionTypes.DELETE_WORKSPACE_SUCCESS,
payload: workspaceId,
});
toast.show(createMessage(DELETE_WORKSPACE_SUCCESSFUL), {
kind: "success",
});
history.push("/applications");
}
} catch (error) {
yield put({
type: ReduxActionErrorTypes.DELETE_WORKSPACE_ERROR,
payload: {
error: (error as Error).message,
},
});
}
}
export function* createWorkspaceSaga(
action: ReduxActionWithPromise<CreateWorkspaceRequest>,
) {
const { name, reject, resolve } = action.payload;
try {
const request: CreateWorkspaceRequest = { name };
const response: ApiResponse = yield callAPI(
WorkspaceApi.createWorkspace,
request,
);
const isValidResponse: boolean = yield validateResponse(response);
if (!isValidResponse) {
const errorMessage: string | undefined =
yield getResponseErrorMessage(response);
yield call(reject, { _error: errorMessage });
} else {
yield put({
type: ReduxActionTypes.CREATE_WORKSPACE_SUCCESS,
payload: response.data,
});
yield call(resolve);
}
// get created workspace in focus
// @ts-expect-error: response is of type unknown
const workspaceId = response.data.id;
history.push(`${window.location.pathname}?workspaceId=${workspaceId}`);
} catch (error) {
yield call(reject, { _error: (error as Error).message });
yield put({
type: ReduxActionErrorTypes.CREATE_WORKSPACE_ERROR,
payload: {
error,
},
});
}
}
export function* uploadWorkspaceLogoSaga(
action: ReduxAction<SaveWorkspaceLogo>,
) {
try {
const request = action.payload;
const response: ApiResponse = yield call(
WorkspaceApi.saveWorkspaceLogo,
request,
);
const isValidResponse: boolean = yield validateResponse(response);
if (isValidResponse) {
const allWorkspaces: Workspace[] = yield select(getFetchedWorkspaces);
const currentWorkspace = allWorkspaces.filter(
(el: Workspace) => el.id === request.id,
);
if (currentWorkspace.length > 0) {
yield put({
type: ReduxActionTypes.SAVE_WORKSPACE_SUCCESS,
payload: {
id: currentWorkspace[0].id,
// @ts-expect-error: response is of type unknown
logoUrl: response.data.logoUrl,
},
});
toast.show("Logo uploaded successfully", {
kind: "success",
});
}
}
} catch (error) {
log.error("Error occured while uploading the logo", error);
}
}
export function* deleteWorkspaceLogoSaga(action: ReduxAction<{ id: string }>) {
try {
const request = action.payload;
const response: ApiResponse = yield call(
WorkspaceApi.deleteWorkspaceLogo,
request,
);
const isValidResponse: boolean = yield validateResponse(response);
if (isValidResponse) {
const allWorkspaces: Workspace[] = yield select(getFetchedWorkspaces);
const currentWorkspace = allWorkspaces.filter(
(el: Workspace) => el.id === request.id,
);
if (currentWorkspace.length > 0) {
yield put({
type: ReduxActionTypes.SAVE_WORKSPACE_SUCCESS,
payload: {
id: currentWorkspace[0].id,
// @ts-expect-error: response is of type unknown
logoUrl: response.data.logoUrl,
},
});
toast.show("Logo removed successfully", {
kind: "success",
});
}
}
} catch (error) {
log.error("Error occured while removing the logo", error);
}
}
export function* searchWorkspaceEntitiesSaga(action: ReduxAction<any>) {
if (!action?.payload || !action?.payload?.trim()) {
yield put(resetSearchEntity());
return;
}
try {
const response: SearchApiResponse = yield call(
SearchApi.searchAllEntities,
{ keyword: action.payload },
);
const isValidResponse: boolean = yield validateResponse(response);
if (isValidResponse) {
yield put({
type: ReduxActionTypes.SEARCH_WORKSPACE_ENTITIES_SUCCESS,
payload: response.data,
});
}
} catch (error) {
yield put({
type: ReduxActionErrorTypes.SEARCH_WORKSPACE_ENTITIES_ERROR,
payload: {
error,
},
});
}
}