PromucFlow_constructor/app/client/src/entities/Engine/index.ts

111 lines
3.7 KiB
TypeScript
Raw Normal View History

import { fetchApplication } from "actions/applicationActions";
import { setAppMode, updateAppStore } from "actions/pageActions";
import {
ApplicationPayload,
ReduxActionErrorTypes,
ReduxActionTypes,
} from "@appsmith/constants/ReduxActionConstants";
import { getPersistentAppStore } from "constants/AppConstants";
import { APP_MODE } from "entities/App";
import log from "loglevel";
import { call, put, select } from "redux-saga/effects";
import { failFastApiCalls } from "sagas/InitSagas";
import { getDefaultPageId } from "sagas/selectors";
import { getCurrentApplication } from "selectors/applicationSelectors";
import history from "utils/history";
import URLRedirect from "entities/URLRedirect/index";
import URLGeneratorFactory from "entities/URLRedirect/factory";
import { updateBranchLocally } from "actions/gitSyncActions";
fix: Fetch app's current branch from redux store (#20601) ## Description ### Cause of issue Appsmith's persistent data is stored in the browser's localStorage under a key generated using the `applicationId` and `branch name`. When fetching the store's value on page load, if the branch's name is not present in the URL string, its value defaults to an emptyString. ### Solution Default value of `branch name` should be the current git branch. Fixes #15692 ## Type of change - Bug fix (non-breaking change which fixes an issue) ## How Has This Been Tested? manual ### Test Plan Cypress covers test case ### 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: - [ ] Test plan has been approved by relevant developers - [ ] Test plan has been peer reviewed by QA - [x] Cypress test cases have been added and approved by either SDET or manual QA - [ ] Organized project review call with relevant stakeholders after Round 1/2 of QA - [x] Added Test Plan Approved label after reveiwing all Cypress test
2023-02-15 10:21:33 +00:00
import { getCurrentGitBranch } from "selectors/gitSyncSelectors";
export type AppEnginePayload = {
applicationId?: string;
pageId?: string;
branch?: string;
mode: APP_MODE;
};
export interface IAppEngine {
setupEngine(payload: AppEnginePayload): any;
loadAppData(payload: AppEnginePayload): any;
loadAppURL(pageId: string, pageIdInUrl?: string): any;
loadAppEntities(toLoadPageId: string, applicationId: string): any;
loadGit(applicationId: string): any;
completeChore(): any;
}
export class AppEngineApiError extends Error {}
export class PageNotFoundError extends AppEngineApiError {}
export class ActionsNotFoundError extends AppEngineApiError {}
export class PluginsNotFoundError extends AppEngineApiError {}
export class PluginFormConfigsNotFoundError extends AppEngineApiError {}
export default abstract class AppEngine {
private _mode: APP_MODE;
constructor(mode: APP_MODE) {
this._mode = mode;
this._urlRedirect = null;
}
private _urlRedirect: URLRedirect | null;
abstract loadAppEntities(toLoadPageId: string, applicationId: string): any;
abstract loadGit(applicationId: string): any;
abstract startPerformanceTracking(): any;
abstract stopPerformanceTracking(): any;
abstract completeChore(): any;
*loadAppData(payload: AppEnginePayload) {
const { applicationId, branch, pageId } = payload;
const apiCalls: boolean = yield failFastApiCalls(
[fetchApplication({ applicationId, pageId, mode: this._mode })],
[
ReduxActionTypes.FETCH_APPLICATION_SUCCESS,
ReduxActionTypes.FETCH_PAGE_LIST_SUCCESS,
],
[
ReduxActionErrorTypes.FETCH_APPLICATION_ERROR,
ReduxActionErrorTypes.FETCH_PAGE_LIST_ERROR,
],
);
if (!apiCalls)
throw new PageNotFoundError(`Cannot find page with id: ${pageId}`);
const application: ApplicationPayload = yield select(getCurrentApplication);
fix: Fetch app's current branch from redux store (#20601) ## Description ### Cause of issue Appsmith's persistent data is stored in the browser's localStorage under a key generated using the `applicationId` and `branch name`. When fetching the store's value on page load, if the branch's name is not present in the URL string, its value defaults to an emptyString. ### Solution Default value of `branch name` should be the current git branch. Fixes #15692 ## Type of change - Bug fix (non-breaking change which fixes an issue) ## How Has This Been Tested? manual ### Test Plan Cypress covers test case ### 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: - [ ] Test plan has been approved by relevant developers - [ ] Test plan has been peer reviewed by QA - [x] Cypress test cases have been added and approved by either SDET or manual QA - [ ] Organized project review call with relevant stakeholders after Round 1/2 of QA - [x] Added Test Plan Approved label after reveiwing all Cypress test
2023-02-15 10:21:33 +00:00
const currentGitBranch: ReturnType<typeof getCurrentGitBranch> = yield select(
getCurrentGitBranch,
);
yield put(
updateAppStore(
getPersistentAppStore(application.id, branch || currentGitBranch),
),
);
const toLoadPageId: string = pageId || (yield select(getDefaultPageId));
this._urlRedirect = URLGeneratorFactory.create(
application.applicationVersion,
this._mode,
);
return { toLoadPageId, applicationId: application.id };
}
*setupEngine(payload: AppEnginePayload): any {
const { branch } = payload;
yield put(updateBranchLocally(branch || ""));
yield put(setAppMode(this._mode));
yield put({ type: ReduxActionTypes.START_EVALUATION });
}
*loadAppURL(pageId: string, pageIdInUrl?: string) {
try {
if (!this._urlRedirect) return;
const newURL: string = yield call(
this._urlRedirect.generateRedirectURL.bind(this),
pageId,
pageIdInUrl,
);
if (!newURL) return;
history.replace(newURL);
} catch (e) {
log.error(e);
}
}
}