PromucFlow_constructor/app/client/src/sagas/LintingSagas.ts
Hetu Nandu c155a511f1
chore: Separate files for Redux Types (#38559)
Co-authored-by: Diljit <diljit@appsmith.com>
2025-01-10 10:21:54 +05:30

144 lines
4.7 KiB
TypeScript

import { setLintingErrors } from "actions/lintingActions";
import type { ReduxAction } from "actions/ReduxActionTypes";
import { ReduxActionTypes } from "ee/constants/ReduxActionConstants";
import { APP_MODE } from "entities/App";
import { call, put, select, takeEvery } from "redux-saga/effects";
import { getAppMode } from "ee/selectors/entitiesSelector";
import type { JSLibrary } from "workers/common/JSLibrary";
import { logLatestLintPropertyErrors } from "./PostLintingSagas";
import { getAppsmithConfigs } from "ee/configs";
import type { AppState } from "ee/reducers";
import type { LintError } from "utils/DynamicBindingUtils";
import { get, set, uniq } from "lodash";
import type { LintErrorsStore } from "reducers/lintingReducers/lintErrorsReducers";
import type { TJSPropertiesState } from "workers/Evaluation/JSObject/jsPropertiesState";
import type {
LintTreeRequestPayload,
LintTreeResponse,
LintTreeSagaRequestData,
} from "plugins/Linting/types";
import type { getUnevaluatedDataTree } from "selectors/dataTreeSelectors";
import { getEntityNameAndPropertyPath } from "ee/workers/Evaluation/evaluationUtils";
import { Linter } from "plugins/Linting/Linter";
import log from "loglevel";
import { getFixedTimeDifference } from "workers/common/DataTreeEvaluator/utils";
import { selectFeatureFlags } from "ee/selectors/featureFlagsSelectors";
const APPSMITH_CONFIGS = getAppsmithConfigs();
export const lintWorker = new Linter();
function* updateLintGlobals(
action: ReduxAction<{ add?: boolean; libs: JSLibrary[] }>,
) {
const appMode: APP_MODE = yield select(getAppMode);
const isEditorMode = appMode === APP_MODE.EDIT;
if (!isEditorMode) return;
yield call(lintWorker.updateJSLibraryGlobals, action.payload);
}
function* updateOldJSCollectionLintErrors(
lintedJSPaths: string[],
errors: LintErrorsStore,
jsObjectsState: TJSPropertiesState,
) {
const jsEntities = uniq(
lintedJSPaths.map((path) => getEntityNameAndPropertyPath(path).entityName),
);
const updatedJSCollectionLintErrors: LintErrorsStore = {};
for (const jsObjectName of jsEntities) {
const jsObjectBodyPath = `["${jsObjectName}.body"]`;
const oldJsBodyLintErrors: LintError[] = yield select((state: AppState) =>
get(state.linting.errors, jsObjectBodyPath, []),
);
const newJSBodyLintErrors = get(
errors,
jsObjectBodyPath,
[] as LintError[],
);
const jsObjectState = get(jsObjectsState, jsObjectName, {});
const jsObjectProperties = Object.keys(jsObjectState).map(
(propertyName) => `${jsObjectName}.${propertyName}`,
);
const filteredOldJsObjectBodyLintErrors = oldJsBodyLintErrors.filter(
(lintError) =>
lintError.originalPath &&
jsObjectProperties.includes(lintError.originalPath) &&
!lintedJSPaths.includes(lintError.originalPath),
);
const updatedLintErrors = [
...filteredOldJsObjectBodyLintErrors,
...newJSBodyLintErrors,
];
set(updatedJSCollectionLintErrors, jsObjectBodyPath, updatedLintErrors);
}
return updatedJSCollectionLintErrors;
}
export function* lintTreeSaga(payload: LintTreeSagaRequestData) {
const { configTree, forceLinting, unevalTree } = payload;
const lintTreeRequestData: LintTreeRequestPayload = {
unevalTree,
configTree,
cloudHosting: !!APPSMITH_CONFIGS.cloudHosting,
forceLinting,
};
const { errors, jsPropertiesState, lintedJSPaths }: LintTreeResponse =
yield call(lintWorker.lintTree, lintTreeRequestData);
const updatedOldJSCollectionLintErrors: LintErrorsStore =
yield updateOldJSCollectionLintErrors(
lintedJSPaths,
errors,
jsPropertiesState,
);
const updatedErrors = { ...errors, ...updatedOldJSCollectionLintErrors };
yield put(setLintingErrors(updatedErrors));
yield call(logLatestLintPropertyErrors, {
errors,
dataTree: unevalTree,
configTree,
});
}
export function* initiateLinting(
unEvalAndConfigTree: ReturnType<typeof getUnevaluatedDataTree>,
forceLinting: boolean,
) {
const lintingStartTime = performance.now();
const { configTree, unEvalTree: unevalTree } = unEvalAndConfigTree;
yield call(lintTreeSaga, {
unevalTree,
configTree,
forceLinting,
});
log.debug({
lintTime: getFixedTimeDifference(performance.now(), lintingStartTime),
});
}
export default function* lintTreeSagaWatcher() {
yield takeEvery(ReduxActionTypes.UPDATE_LINT_GLOBALS, updateLintGlobals);
yield takeEvery(ReduxActionTypes.LINT_SETUP, setupSaga);
}
// TODO: Fix this the next time the file is edited
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export function* setupSaga(): any {
const featureFlags = yield select(selectFeatureFlags);
yield call(lintWorker.setup, featureFlags);
}