PromucFlow_constructor/app/client/src/sagas/SnipingModeSagas.ts
Ivan Akulov 424d2f6965
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
7cbb12af88,
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 17:11:47 +05:30

185 lines
6.2 KiB
TypeScript

import { all, call, put, select, takeLeading } from "redux-saga/effects";
import type { ReduxAction } from "@appsmith/constants/ReduxActionConstants";
import { ReduxActionTypes } from "@appsmith/constants/ReduxActionConstants";
import { snipingModeBindToSelector } from "selectors/editorSelectors";
import type { ActionData } from "reducers/entityReducers/actionsReducer";
import { getCanvasWidgets } from "selectors/entitiesSelector";
import {
setWidgetDynamicProperty,
updateWidgetPropertyRequest,
} from "actions/controlActions";
import { Toaster, Variant } from "design-system-old";
import AnalyticsUtil from "utils/AnalyticsUtil";
import {
SNIPING_NOT_SUPPORTED,
SNIPING_SELECT_WIDGET_AGAIN,
} from "@appsmith/constants/messages";
import WidgetFactory from "utils/WidgetFactory";
import type { CanvasWidgetsReduxState } from "reducers/entityReducers/canvasWidgetsReducer";
import { setSnipingMode } from "actions/propertyPaneActions";
import { selectWidgetInitAction } from "actions/widgetSelectionActions";
import { SelectionRequestType } from "sagas/WidgetSelectUtils";
const WidgetTypes = WidgetFactory.widgetTypes;
export function* bindDataToWidgetSaga(
action: ReduxAction<{
widgetId: string;
}>,
) {
const queryId: string = yield select(snipingModeBindToSelector);
const currentAction: ActionData | undefined = yield select((state) =>
state.entities.actions.find(
(action: ActionData) => action.config.id === queryId,
),
);
const widgetState: CanvasWidgetsReduxState = yield select(getCanvasWidgets);
const selectedWidget = widgetState[action.payload.widgetId];
if (!selectedWidget || !selectedWidget.type) {
Toaster.show({
text: SNIPING_SELECT_WIDGET_AGAIN(),
variant: Variant.warning,
});
return;
}
const { widgetId } = action.payload;
let propertyPath = "";
let propertyValue: any = "";
let isValidProperty = true;
// Pranav has an Open PR for this file so just returning for now
if (!currentAction) return;
switch (selectedWidget.type) {
case WidgetTypes.BUTTON_WIDGET:
case WidgetTypes.FORM_BUTTON_WIDGET:
propertyPath = "onClick";
propertyValue = `{{${currentAction.config.name}.run()}}`;
break;
case WidgetTypes.CHECKBOX_WIDGET:
propertyPath = "defaultCheckedState";
propertyValue = `{{${currentAction.config.name}.data}}`;
break;
case WidgetTypes.DATE_PICKER_WIDGET2:
propertyPath = "defaultDate";
propertyValue = `{{${currentAction.config.name}.data}}`;
break;
case WidgetTypes.FILE_PICKER_WIDGET:
propertyPath = "onFilesSelected";
propertyValue = `{{${currentAction.config.name}.run()}}`;
break;
case WidgetTypes.IFRAME_WIDGET:
propertyPath = "source";
propertyValue = `{{${currentAction.config.name}.data}}`;
break;
case WidgetTypes.INPUT_WIDGET:
propertyPath = "defaultText";
propertyValue = `{{${currentAction.config.name}.data}}`;
break;
case WidgetTypes.INPUT_WIDGET_V2:
propertyPath = "defaultText";
propertyValue = `{{${currentAction.config.name}.data}}`;
break;
case WidgetTypes.LIST_WIDGET:
propertyPath = "listData";
propertyValue = `{{${currentAction.config.name}.data}}`;
break;
case WidgetTypes.LIST_WIDGET_V2:
propertyPath = "listData";
propertyValue = `{{${currentAction.config.name}.data}}`;
break;
case WidgetTypes.MAP_WIDGET:
propertyPath = "defaultMarkers";
propertyValue = `{{${currentAction.config.name}.data}}`;
break;
case WidgetTypes.RADIO_GROUP_WIDGET:
propertyPath = "options";
propertyValue = `{{${currentAction.config.name}.data}}`;
break;
case WidgetTypes.RATE_WIDGET:
propertyPath = "onRateChanged";
propertyValue = `{{${currentAction.config.name}.run()}}`;
break;
case WidgetTypes.RICH_TEXT_EDITOR_WIDGET:
propertyPath = "defaultText";
propertyValue = `{{${currentAction.config.name}.data}}`;
break;
case WidgetTypes.DROP_DOWN_WIDGET:
propertyPath = "options";
propertyValue = `{{${currentAction.config.name}.data}}`;
break;
case WidgetTypes.SELECT_WIDGET:
propertyPath = "options";
propertyValue = `{{${currentAction.config.name}.data}}`;
break;
case WidgetTypes.SWITCH_WIDGET:
propertyPath = "defaultSwitchState";
propertyValue = `{{${currentAction.config.name}.data}}`;
break;
case WidgetTypes.TABLE_WIDGET:
propertyPath = "tableData";
propertyValue = `{{${currentAction.config.name}.data}}`;
break;
case WidgetTypes.TABLE_WIDGET_V2:
propertyPath = "tableData";
propertyValue = `{{${currentAction.config.name}.data}}`;
break;
case WidgetTypes.TEXT_WIDGET:
propertyPath = "text";
propertyValue = `{{${currentAction.config.name}.data}}`;
break;
case WidgetTypes.VIDEO_WIDGET:
propertyPath = "url";
propertyValue = `{{${currentAction.config.name}.data}}`;
break;
case WidgetTypes.JSON_FORM_WIDGET:
propertyPath = "sourceData";
propertyValue = `{{${currentAction.config.name}.data}}`;
break;
default:
isValidProperty = false;
break;
}
AnalyticsUtil.logEvent("WIDGET_SELECTED_VIA_SNIPING_MODE", {
widgetType: selectedWidget.type,
actionName: currentAction.config.name,
apiId: queryId,
propertyPath,
propertyValue,
});
if (queryId && isValidProperty) {
// set the property path to dynamic, i.e. enable JS mode
yield put(setWidgetDynamicProperty(widgetId, propertyPath, true));
yield put(
updateWidgetPropertyRequest(widgetId, propertyPath, propertyValue),
);
yield call(resetSnipingModeSaga);
yield put(selectWidgetInitAction(SelectionRequestType.One, [widgetId]));
} else {
queryId &&
Toaster.show({
text: SNIPING_NOT_SUPPORTED(),
variant: Variant.warning,
});
}
}
function* resetSnipingModeSaga() {
yield put(
setSnipingMode({
isActive: false,
bindTo: undefined,
}),
);
}
export default function* snipingModeSagas() {
yield all([
takeLeading(ReduxActionTypes.BIND_DATA_TO_WIDGET, bindDataToWidgetSaga),
takeLeading(ReduxActionTypes.RESET_SNIPING_MODE, resetSnipingModeSaga),
]);
}