2023-02-21 13:38:16 +00:00
|
|
|
import { all, call, put, select, takeLeading } from "redux-saga/effects";
|
2025-01-10 04:51:54 +00:00
|
|
|
import type { ReduxAction } from "actions/ReduxActionTypes";
|
2024-08-06 14:52:22 +00:00
|
|
|
import { ReduxActionTypes } from "ee/constants/ReduxActionConstants";
|
2022-10-17 15:16:38 +00:00
|
|
|
import { snipingModeBindToSelector } from "selectors/editorSelectors";
|
2024-08-06 14:52:22 +00:00
|
|
|
import type { ActionData } from "ee/reducers/entityReducers/actionsReducer";
|
|
|
|
|
import { getCanvasWidgets } from "ee/selectors/entitiesSelector";
|
2021-07-26 16:44:10 +00:00
|
|
|
import {
|
2023-07-26 05:38:11 +00:00
|
|
|
batchUpdateWidgetDynamicProperty,
|
|
|
|
|
batchUpdateWidgetProperty,
|
2022-04-12 10:50:01 +00:00
|
|
|
} from "actions/controlActions";
|
2024-08-06 14:52:22 +00:00
|
|
|
import AnalyticsUtil from "ee/utils/AnalyticsUtil";
|
2021-09-09 15:10:22 +00:00
|
|
|
|
2021-09-07 04:45:13 +00:00
|
|
|
import {
|
|
|
|
|
SNIPING_NOT_SUPPORTED,
|
|
|
|
|
SNIPING_SELECT_WIDGET_AGAIN,
|
2024-08-06 14:52:22 +00:00
|
|
|
} from "ee/constants/messages";
|
2021-07-26 16:44:10 +00:00
|
|
|
|
2023-09-06 12:15:04 +00:00
|
|
|
import WidgetFactory from "WidgetProvider/factory";
|
chore: upgrade to prettier v2 + enforce import types (#21013)Co-authored-by: Satish Gandham <hello@satishgandham.com> Co-authored-by: Satish Gandham <satish.iitg@gmail.com>
## Description
This PR upgrades Prettier to v2 + enforces TypeScript’s [`import
type`](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-8.html#type-only-imports-and-export)
syntax where applicable. It’s submitted as a separate PR so we can merge
it easily.
As a part of this PR, we reformat the codebase heavily:
- add `import type` everywhere where it’s required, and
- re-format the code to account for Prettier 2’s breaking changes:
https://prettier.io/blog/2020/03/21/2.0.0.html#breaking-changes
This PR is submitted against `release` to make sure all new code by team
members will adhere to new formatting standards, and we’ll have fewer
conflicts when merging `bundle-optimizations` into `release`. (I’ll
merge `release` back into `bundle-optimizations` once this PR is
merged.)
### Why is this needed?
This PR is needed because, for the Lodash optimization from
https://github.com/appsmithorg/appsmith/commit/7cbb12af886621256224be0c93e6a465dd710ad3,
we need to use `import type`. Otherwise, `babel-plugin-lodash` complains
that `LoDashStatic` is not a lodash function.
However, just using `import type` in the current codebase will give you
this:
<img width="962" alt="Screenshot 2023-03-08 at 17 45 59"
src="https://user-images.githubusercontent.com/2953267/223775744-407afa0c-e8b9-44a1-90f9-b879348da57f.png">
That’s because Prettier 1 can’t parse `import type` at all. To parse it,
we need to upgrade to Prettier 2.
### Why enforce `import type`?
Apart from just enabling `import type` support, this PR enforces
specifying `import type` everywhere it’s needed. (Developers will get
immediate TypeScript and ESLint errors when they forget to do so.)
I’m doing this because I believe `import type` improves DX and makes
refactorings easier.
Let’s say you had a few imports like below. Can you tell which of these
imports will increase the bundle size? (Tip: it’s not all of them!)
```ts
// app/client/src/workers/Linting/utils.ts
import { Position } from "codemirror";
import { LintError as JSHintError, LintOptions } from "jshint";
import { get, isEmpty, isNumber, keys, last, set } from "lodash";
```
It’s pretty hard, right?
What about now?
```ts
// app/client/src/workers/Linting/utils.ts
import type { Position } from "codemirror";
import type { LintError as JSHintError, LintOptions } from "jshint";
import { get, isEmpty, isNumber, keys, last, set } from "lodash";
```
Now, it’s clear that only `lodash` will be bundled.
This helps developers to see which imports are problematic, but it
_also_ helps with refactorings. Now, if you want to see where
`codemirror` is bundled, you can just grep for `import \{.*\} from
"codemirror"` – and you won’t get any type-only imports.
This also helps (some) bundlers. Upon transpiling, TypeScript erases
type-only imports completely. In some environment (not ours), this makes
the bundle smaller, as the bundler doesn’t need to bundle type-only
imports anymore.
## Type of change
- Chore (housekeeping or task changes that don't impact user perception)
## How Has This Been Tested?
This was tested to not break the build.
### 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
- [x] 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
- [x] 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
- [ ] 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
- [ ] Added Test Plan Approved label after reveiwing all Cypress test
---------
Co-authored-by: Satish Gandham <hello@satishgandham.com>
Co-authored-by: Satish Gandham <satish.iitg@gmail.com>
2023-03-16 11:41:47 +00:00
|
|
|
import type { CanvasWidgetsReduxState } from "reducers/entityReducers/canvasWidgetsReducer";
|
2022-10-17 15:16:38 +00:00
|
|
|
import { setSnipingMode } from "actions/propertyPaneActions";
|
2023-02-21 13:38:16 +00:00
|
|
|
import { selectWidgetInitAction } from "actions/widgetSelectionActions";
|
|
|
|
|
import { SelectionRequestType } from "sagas/WidgetSelectUtils";
|
2024-08-09 14:20:29 +00:00
|
|
|
import { toast } from "@appsmith/ads";
|
2023-09-06 12:15:04 +00:00
|
|
|
import type { PropertyUpdates } from "WidgetProvider/constants";
|
2024-08-06 14:52:22 +00:00
|
|
|
import type { ModuleInstance } from "ee/constants/ModuleInstanceConstants";
|
|
|
|
|
import { getModuleInstanceById } from "ee/selectors/moduleInstanceSelectors";
|
2021-09-09 15:10:22 +00:00
|
|
|
|
2021-07-26 16:44:10 +00:00
|
|
|
export function* bindDataToWidgetSaga(
|
|
|
|
|
action: ReduxAction<{
|
|
|
|
|
widgetId: string;
|
2023-09-08 07:42:48 +00:00
|
|
|
bindingQuery?: string;
|
2021-07-26 16:44:10 +00:00
|
|
|
}>,
|
|
|
|
|
) {
|
2022-10-17 15:16:38 +00:00
|
|
|
const queryId: string = yield select(snipingModeBindToSelector);
|
2022-06-21 13:57:34 +00:00
|
|
|
const currentAction: ActionData | undefined = yield select((state) =>
|
2021-07-26 16:44:10 +00:00
|
|
|
state.entities.actions.find(
|
|
|
|
|
(action: ActionData) => action.config.id === queryId,
|
|
|
|
|
),
|
|
|
|
|
);
|
2024-07-23 11:06:22 +00:00
|
|
|
const currentModuleInstance: ModuleInstance | undefined = yield select(
|
|
|
|
|
getModuleInstanceById,
|
|
|
|
|
queryId,
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
const actionName =
|
|
|
|
|
currentAction?.config.name || currentModuleInstance?.name || "";
|
|
|
|
|
|
2022-06-21 13:57:34 +00:00
|
|
|
const widgetState: CanvasWidgetsReduxState = yield select(getCanvasWidgets);
|
|
|
|
|
const selectedWidget = widgetState[action.payload.widgetId];
|
2021-07-26 16:44:10 +00:00
|
|
|
|
2021-09-07 04:45:13 +00:00
|
|
|
if (!selectedWidget || !selectedWidget.type) {
|
2023-05-19 18:37:06 +00:00
|
|
|
toast.show(SNIPING_SELECT_WIDGET_AGAIN(), {
|
|
|
|
|
kind: "warning",
|
2021-09-07 04:45:13 +00:00
|
|
|
});
|
2024-09-18 16:35:28 +00:00
|
|
|
|
2021-09-07 04:45:13 +00:00
|
|
|
return;
|
|
|
|
|
}
|
2024-09-18 16:35:28 +00:00
|
|
|
|
2021-09-09 13:19:39 +00:00
|
|
|
const { widgetId } = action.payload;
|
2023-07-26 05:38:11 +00:00
|
|
|
|
2021-07-26 16:44:10 +00:00
|
|
|
let isValidProperty = true;
|
2024-09-18 16:35:28 +00:00
|
|
|
|
2022-06-21 13:57:34 +00:00
|
|
|
// Pranav has an Open PR for this file so just returning for now
|
2024-07-23 11:06:22 +00:00
|
|
|
if (!actionName) return;
|
2024-09-18 16:35:28 +00:00
|
|
|
|
2023-07-26 05:38:11 +00:00
|
|
|
const { getSnipingModeUpdates } = WidgetFactory.getWidgetMethods(
|
|
|
|
|
selectedWidget.type,
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
let updates: Array<PropertyUpdates> = [];
|
|
|
|
|
|
2024-07-23 11:06:22 +00:00
|
|
|
const oneClickBindingQuery = `{{${actionName}.data}}`;
|
2023-09-08 07:42:48 +00:00
|
|
|
|
|
|
|
|
const bindingQuery = action.payload.bindingQuery
|
2024-07-23 11:06:22 +00:00
|
|
|
? `{{${actionName}.${action.payload.bindingQuery}}}`
|
2023-09-08 07:42:48 +00:00
|
|
|
: oneClickBindingQuery;
|
|
|
|
|
let isDynamicPropertyPath = true;
|
|
|
|
|
|
|
|
|
|
if (bindingQuery === oneClickBindingQuery) {
|
|
|
|
|
isDynamicPropertyPath = false;
|
|
|
|
|
}
|
|
|
|
|
|
2023-07-26 05:38:11 +00:00
|
|
|
if (getSnipingModeUpdates) {
|
|
|
|
|
updates = getSnipingModeUpdates?.({
|
2023-09-08 07:42:48 +00:00
|
|
|
data: bindingQuery,
|
2024-07-23 11:06:22 +00:00
|
|
|
run: `{{${actionName}.run()}}`,
|
2023-09-08 07:42:48 +00:00
|
|
|
isDynamicPropertyPath,
|
2023-07-26 05:38:11 +00:00
|
|
|
});
|
|
|
|
|
|
|
|
|
|
AnalyticsUtil.logEvent("WIDGET_SELECTED_VIA_SNIPING_MODE", {
|
|
|
|
|
widgetType: selectedWidget.type,
|
2024-07-23 11:06:22 +00:00
|
|
|
actionName: actionName,
|
2023-07-26 05:38:11 +00:00
|
|
|
apiId: queryId,
|
|
|
|
|
propertyPath: updates?.map((update) => update.propertyPath).toString(),
|
|
|
|
|
propertyValue: updates?.map((update) => update.propertyPath).toString(),
|
|
|
|
|
});
|
|
|
|
|
} else {
|
|
|
|
|
isValidProperty = false;
|
2021-07-26 16:44:10 +00:00
|
|
|
}
|
2023-07-26 05:38:11 +00:00
|
|
|
|
|
|
|
|
if (queryId && isValidProperty && updates.length > 0) {
|
|
|
|
|
const updatesMap: Record<string, string> = updates?.reduce(
|
|
|
|
|
(acc: Record<string, string>, update) => {
|
|
|
|
|
acc[update.propertyPath] = update.propertyValue as string;
|
2024-09-18 16:35:28 +00:00
|
|
|
|
2023-07-26 05:38:11 +00:00
|
|
|
return acc;
|
|
|
|
|
},
|
|
|
|
|
{},
|
2021-07-26 16:44:10 +00:00
|
|
|
);
|
2023-07-26 05:38:11 +00:00
|
|
|
|
|
|
|
|
const batchUpdateArray = updates.map((update) => {
|
|
|
|
|
return {
|
|
|
|
|
propertyPath: update.propertyPath,
|
|
|
|
|
isDynamic: !!update.isDynamicPropertyPath,
|
|
|
|
|
skipValidation: true, // Since we are coming up with the dynamic string, we can skip validation
|
|
|
|
|
};
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
// set the property path to dynamic, i.e. enable JS mode
|
|
|
|
|
yield put(batchUpdateWidgetDynamicProperty(widgetId, batchUpdateArray));
|
|
|
|
|
yield put(batchUpdateWidgetProperty(widgetId, { modify: updatesMap }));
|
2022-10-17 15:16:38 +00:00
|
|
|
yield call(resetSnipingModeSaga);
|
2023-02-21 13:38:16 +00:00
|
|
|
yield put(selectWidgetInitAction(SelectionRequestType.One, [widgetId]));
|
2021-07-26 16:44:10 +00:00
|
|
|
} else {
|
|
|
|
|
queryId &&
|
2023-05-19 18:37:06 +00:00
|
|
|
toast.show(SNIPING_NOT_SUPPORTED(), {
|
|
|
|
|
kind: "warning",
|
2021-07-26 16:44:10 +00:00
|
|
|
});
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
function* resetSnipingModeSaga() {
|
2022-10-17 15:16:38 +00:00
|
|
|
yield put(
|
|
|
|
|
setSnipingMode({
|
|
|
|
|
isActive: false,
|
|
|
|
|
bindTo: undefined,
|
|
|
|
|
}),
|
|
|
|
|
);
|
2021-07-26 16:44:10 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
export default function* snipingModeSagas() {
|
|
|
|
|
yield all([
|
|
|
|
|
takeLeading(ReduxActionTypes.BIND_DATA_TO_WIDGET, bindDataToWidgetSaga),
|
|
|
|
|
takeLeading(ReduxActionTypes.RESET_SNIPING_MODE, resetSnipingModeSaga),
|
|
|
|
|
]);
|
|
|
|
|
}
|