PromucFlow_constructor/app/client/src/sagas/CommunityTemplatesSagas.tsx

118 lines
3.8 KiB
TypeScript
Raw Normal View History

feat: community templates UI (#27302) ## Description Community templates UI changes. Allow user to publish app to community portal #### PR fixes following issue(s) Fixes #26343 > 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
2023-09-25 06:27:23 +00:00
import type { ReduxAction } from "@appsmith/constants/ReduxActionConstants";
import {
ReduxActionErrorTypes,
ReduxActionTypes,
} from "@appsmith/constants/ReduxActionConstants";
import { isAirgapped } from "@appsmith/utils/airgapHelpers";
import { all, call, put, select, takeEvery } from "redux-saga/effects";
import { validateResponse, type ErrorActionPayload } from "./ErrorSagas";
import {
COMMUNITY_TEMPLATES,
createMessage,
} from "@appsmith/constants/messages";
import { toast } from "design-system";
import type {
PublishCommunityTemplateRequest,
PublishCommunityTemplateResponse,
} from "api/TemplatesApi";
import TemplatesAPI from "api/TemplatesApi";
import { getCurrentWorkspaceId } from "@appsmith/selectors/workspaceSelectors";
import { getCurrentApplicationId } from "selectors/editorSelectors";
import type { UpdateUserRequest } from "@appsmith/api/UserApi";
import UserApi from "@appsmith/api/UserApi";
import type { PublishCommunityTemplatePayload } from "actions/communityTemplateActions";
import type { ApiResponse } from "api/ApiResponses";
const isAirgappedInstance = isAirgapped();
function* updateUserDetails(payload: PublishCommunityTemplatePayload) {
if (!payload.shouldUpdateEmail && !payload.shouldUpdateName) return;
const request: UpdateUserRequest = {};
payload.shouldUpdateEmail && (request.email = payload.authorEmail);
payload.shouldUpdateName && (request.name = payload.authorName);
const response: ApiResponse = yield call(UserApi.updateUser, request);
const isValidResponse: boolean = yield validateResponse(response);
if (isValidResponse) {
yield put({
type: ReduxActionTypes.UPDATE_USER_DETAILS_SUCCESS,
payload: response.data,
});
}
}
function* handleFailure(error: unknown) {
const payload: ErrorActionPayload = {
show: true,
error: {
message:
(error as any).message ??
createMessage(COMMUNITY_TEMPLATES.publishFormPage.publishedFailedError),
},
};
yield put({
type: ReduxActionErrorTypes.PUBLISH_APP_AS_COMMUNITY_TEMPLATE_ERROR,
payload,
});
}
function* publishCommunityTemplateSaga(
action: ReduxAction<PublishCommunityTemplatePayload>,
) {
try {
yield call(updateUserDetails, action.payload);
} catch (error) {}
try {
const applicationId: string = yield select(getCurrentApplicationId);
const workspaceId: string = yield select(getCurrentWorkspaceId);
const requestObj: PublishCommunityTemplateRequest = {
applicationId,
workspaceId,
...action.payload,
};
if ("authorName" in requestObj) delete requestObj.authorName;
if ("shouldUpdateEmail" in requestObj) delete requestObj.shouldUpdateEmail;
if ("shouldUpdateName" in requestObj) delete requestObj.shouldUpdateName;
const response: PublishCommunityTemplateResponse = yield call(
TemplatesAPI.publishCommunityTemplate,
requestObj,
);
const isValid: boolean = yield validateResponse(response);
if (isValid) {
toast.show(`Template published to community`, {
kind: "success",
});
yield put({
type: ReduxActionTypes.PUBLISH_APP_AS_COMMUNITY_TEMPLATE_SUCCESS,
payload: response,
});
yield put({
type: ReduxActionTypes.CURRENT_APPLICATION_COMMUNITY_TEMPLATE_STATUS_UPDATE,
payload: {
isCommunityTemplate: response.data.isCommunityTemplate,
isPublic: response.data.isPublic,
forkingEnabled: response.data.forkingEnabled,
},
});
} else {
yield handleFailure(response);
}
} catch (error) {
yield handleFailure(error);
}
}
export default function* watchActionSagas() {
if (!isAirgappedInstance)
yield all([
takeEvery(
ReduxActionTypes.PUBLISH_APP_AS_COMMUNITY_TEMPLATE_INIT,
publishCommunityTemplateSaga,
),
]);
}