## 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>
386 lines
9.0 KiB
TypeScript
386 lines
9.0 KiB
TypeScript
import type {
|
|
ReduxAction,
|
|
ReduxActionWithCallbacks,
|
|
} from "@appsmith/constants/ReduxActionConstants";
|
|
import { ReduxActionTypes } from "@appsmith/constants/ReduxActionConstants";
|
|
import type { CreateDatasourceConfig } from "api/DatasourcesApi";
|
|
import type { Datasource } from "entities/Datasource";
|
|
import type { PluginType } from "entities/Action";
|
|
import type { executeDatasourceQueryRequest } from "api/DatasourcesApi";
|
|
import type { ResponseMeta } from "api/ApiResponses";
|
|
import { TEMP_DATASOURCE_ID } from "constants/Datasource";
|
|
|
|
export const createDatasourceFromForm = (
|
|
payload: CreateDatasourceConfig & Datasource,
|
|
onSuccess?: ReduxAction<unknown>,
|
|
onError?: ReduxAction<unknown>,
|
|
) => {
|
|
return {
|
|
type: ReduxActionTypes.CREATE_DATASOURCE_FROM_FORM_INIT,
|
|
payload,
|
|
onSuccess,
|
|
onError,
|
|
};
|
|
};
|
|
|
|
export const createTempDatasourceFromForm = (
|
|
payload: CreateDatasourceConfig | Datasource,
|
|
) => {
|
|
return {
|
|
type: ReduxActionTypes.CREATE_TEMP_DATASOURCE_FROM_FORM_SUCCESS,
|
|
payload,
|
|
};
|
|
};
|
|
|
|
export const updateDatasource = (
|
|
payload: Datasource,
|
|
onSuccess?: ReduxAction<unknown>,
|
|
onError?: ReduxAction<unknown>,
|
|
): ReduxActionWithCallbacks<Datasource, unknown, unknown> => {
|
|
return {
|
|
type: ReduxActionTypes.UPDATE_DATASOURCE_INIT,
|
|
payload,
|
|
onSuccess,
|
|
onError,
|
|
};
|
|
};
|
|
|
|
export type UpdateDatasourceSuccessAction = {
|
|
type: string;
|
|
payload: Datasource;
|
|
redirect: boolean;
|
|
queryParams?: Record<string, string>;
|
|
};
|
|
|
|
export type CreateDatasourceSuccessAction = {
|
|
type: string;
|
|
payload: Datasource;
|
|
isDBCreated: boolean;
|
|
redirect: boolean;
|
|
};
|
|
|
|
export const updateDatasourceSuccess = (
|
|
payload: Datasource,
|
|
redirect = true,
|
|
queryParams = {},
|
|
): UpdateDatasourceSuccessAction => ({
|
|
type: ReduxActionTypes.UPDATE_DATASOURCE_SUCCESS,
|
|
payload,
|
|
redirect,
|
|
queryParams,
|
|
});
|
|
|
|
export const createDatasourceSuccess = (
|
|
payload: Datasource,
|
|
isDBCreated = false,
|
|
redirect = false,
|
|
): CreateDatasourceSuccessAction => ({
|
|
type: ReduxActionTypes.CREATE_DATASOURCE_SUCCESS,
|
|
payload,
|
|
isDBCreated,
|
|
redirect,
|
|
});
|
|
|
|
export const redirectAuthorizationCode = (
|
|
pageId: string,
|
|
datasourceId: string,
|
|
pluginType: PluginType,
|
|
) => {
|
|
return {
|
|
type: ReduxActionTypes.REDIRECT_AUTHORIZATION_CODE,
|
|
payload: {
|
|
pageId,
|
|
datasourceId,
|
|
pluginType,
|
|
},
|
|
};
|
|
};
|
|
|
|
export const fetchDatasourceStructure = (id: string, ignoreCache?: boolean) => {
|
|
return {
|
|
type: ReduxActionTypes.FETCH_DATASOURCE_STRUCTURE_INIT,
|
|
payload: {
|
|
id,
|
|
ignoreCache,
|
|
},
|
|
};
|
|
};
|
|
|
|
export const expandDatasourceEntity = (id: string) => {
|
|
return {
|
|
type: ReduxActionTypes.EXPAND_DATASOURCE_ENTITY,
|
|
payload: id,
|
|
};
|
|
};
|
|
|
|
export const refreshDatasourceStructure = (id: string) => {
|
|
return {
|
|
type: ReduxActionTypes.REFRESH_DATASOURCE_STRUCTURE_INIT,
|
|
payload: {
|
|
id,
|
|
},
|
|
};
|
|
};
|
|
|
|
export const saveDatasourceName = (payload: { id: string; name: string }) => ({
|
|
type: ReduxActionTypes.SAVE_DATASOURCE_NAME,
|
|
payload: payload,
|
|
});
|
|
|
|
export const updateDatasourceName = (payload: {
|
|
id: string;
|
|
name: string;
|
|
}) => ({
|
|
type: ReduxActionTypes.UPDATE_DATASOURCE_NAME,
|
|
payload: payload,
|
|
});
|
|
|
|
export const changeDatasource = (payload: {
|
|
datasource?: Datasource;
|
|
shouldNotRedirect?: boolean;
|
|
}) => {
|
|
return {
|
|
type: ReduxActionTypes.CHANGE_DATASOURCE,
|
|
payload,
|
|
};
|
|
};
|
|
|
|
export const switchDatasource = (id: string, shouldNotRedirect: boolean) => {
|
|
return {
|
|
type: ReduxActionTypes.SWITCH_DATASOURCE,
|
|
payload: {
|
|
datasourceId: id,
|
|
shouldNotRedirect,
|
|
},
|
|
};
|
|
};
|
|
|
|
export const testDatasource = (payload: Partial<Datasource>) => {
|
|
return {
|
|
type: ReduxActionTypes.TEST_DATASOURCE_INIT,
|
|
payload,
|
|
};
|
|
};
|
|
|
|
export const deleteDatasource = (
|
|
payload: Partial<Datasource>,
|
|
onSuccess?: ReduxAction<unknown>,
|
|
onError?: ReduxAction<unknown>,
|
|
onSuccessCallback?: () => void,
|
|
): ReduxActionWithCallbacks<Partial<Datasource>, unknown, unknown> => {
|
|
return {
|
|
type: ReduxActionTypes.DELETE_DATASOURCE_INIT,
|
|
payload,
|
|
onSuccess,
|
|
onError,
|
|
onSuccessCallback,
|
|
};
|
|
};
|
|
|
|
export const setDatasourceViewMode = (payload: boolean) => {
|
|
return {
|
|
type: ReduxActionTypes.SET_DATASOURCE_EDITOR_MODE,
|
|
payload,
|
|
};
|
|
};
|
|
|
|
export const setAllDatasourceCollapsible = (payload: {
|
|
[key: string]: boolean;
|
|
}) => {
|
|
return {
|
|
type: ReduxActionTypes.SET_ALL_DATASOURCE_COLLAPSIBLE_STATE,
|
|
payload,
|
|
};
|
|
};
|
|
|
|
export const setDatasourceCollapsible = (key: string, isOpen: boolean) => {
|
|
return {
|
|
type: ReduxActionTypes.SET_DATASOURCE_COLLAPSIBLE_STATE,
|
|
payload: { key, isOpen },
|
|
};
|
|
};
|
|
|
|
export const fetchDatasources = (payload?: { workspaceId?: string }) => {
|
|
return {
|
|
type: ReduxActionTypes.FETCH_DATASOURCES_INIT,
|
|
payload,
|
|
};
|
|
};
|
|
|
|
export const fetchMockDatasources = () => {
|
|
return {
|
|
type: ReduxActionTypes.FETCH_MOCK_DATASOURCES_INIT,
|
|
};
|
|
};
|
|
|
|
export interface addMockRequest
|
|
extends ReduxAction<{
|
|
name: string;
|
|
workspaceId: string;
|
|
pluginId: string;
|
|
packageName: string;
|
|
isGeneratePageMode?: string;
|
|
}> {
|
|
extraParams?: any;
|
|
}
|
|
|
|
export const addMockDatasourceToWorkspace = (
|
|
name: string,
|
|
workspaceId: string,
|
|
pluginId: string,
|
|
packageName: string,
|
|
isGeneratePageMode?: string,
|
|
): addMockRequest => {
|
|
return {
|
|
type: ReduxActionTypes.ADD_MOCK_DATASOURCES_INIT,
|
|
payload: { name, packageName, pluginId, workspaceId },
|
|
extraParams: { isGeneratePageMode },
|
|
};
|
|
};
|
|
|
|
export const initDatasourcePane = (
|
|
pluginType: string,
|
|
urlId?: string,
|
|
): ReduxAction<{ pluginType: string; id?: string }> => {
|
|
return {
|
|
type: ReduxActionTypes.INIT_DATASOURCE_PANE,
|
|
payload: { id: urlId, pluginType },
|
|
};
|
|
};
|
|
|
|
export const storeAsDatasource = () => {
|
|
return {
|
|
type: ReduxActionTypes.STORE_AS_DATASOURCE_INIT,
|
|
};
|
|
};
|
|
|
|
export const getOAuthAccessToken = (datasourceId: string) => {
|
|
return {
|
|
type: ReduxActionTypes.GET_OAUTH_ACCESS_TOKEN,
|
|
payload: { datasourceId },
|
|
};
|
|
};
|
|
|
|
export type executeDatasourceQuerySuccessPayload<T> = {
|
|
responseMeta: ResponseMeta;
|
|
data: {
|
|
body: T;
|
|
trigger: T;
|
|
headers: Record<string, string[]>;
|
|
statusCode: string;
|
|
isExecutionSuccess: boolean;
|
|
};
|
|
};
|
|
type errorPayload = string;
|
|
|
|
export type executeDatasourceQueryReduxAction<T> = ReduxActionWithCallbacks<
|
|
executeDatasourceQueryRequest,
|
|
executeDatasourceQuerySuccessPayload<T>,
|
|
errorPayload
|
|
>;
|
|
|
|
export const executeDatasourceQuery = ({
|
|
onErrorCallback,
|
|
onSuccessCallback,
|
|
payload,
|
|
}: {
|
|
onErrorCallback?: (payload: errorPayload) => void;
|
|
onSuccessCallback?: (
|
|
payload: executeDatasourceQuerySuccessPayload<any>,
|
|
) => void;
|
|
payload: executeDatasourceQueryRequest;
|
|
}): executeDatasourceQueryReduxAction<any> => {
|
|
return {
|
|
type: ReduxActionTypes.EXECUTE_DATASOURCE_QUERY_INIT,
|
|
payload,
|
|
onErrorCallback,
|
|
onSuccessCallback,
|
|
};
|
|
};
|
|
|
|
export const setUnconfiguredDatasourcesDuringImport = (
|
|
payload?: Array<Datasource>,
|
|
) => ({
|
|
type: ReduxActionTypes.SET_UNCONFIGURED_DATASOURCES,
|
|
payload,
|
|
});
|
|
|
|
export const removeTempDatasource = () => {
|
|
return {
|
|
type: ReduxActionTypes.REMOVE_TEMP_DATASOURCE_SUCCESS,
|
|
};
|
|
};
|
|
|
|
export const deleteTempDSFromDraft = () => {
|
|
return {
|
|
type: ReduxActionTypes.DELETE_DATASOURCE_DRAFT,
|
|
payload: {
|
|
id: TEMP_DATASOURCE_ID,
|
|
},
|
|
};
|
|
};
|
|
|
|
export const toggleSaveActionFlag = (isDSSaved: boolean) => {
|
|
return {
|
|
type: ReduxActionTypes.SET_DATASOURCE_SAVE_ACTION_FLAG,
|
|
payload: {
|
|
isDSSaved: isDSSaved,
|
|
},
|
|
};
|
|
};
|
|
|
|
export const toggleSaveActionFromPopupFlag = (isDSSavedFromPopup: boolean) => {
|
|
return {
|
|
type: ReduxActionTypes.SET_DATASOURCE_SAVE_ACTION_FROM_POPUP_FLAG,
|
|
payload: {
|
|
isDSSavedFromPopup: isDSSavedFromPopup,
|
|
},
|
|
};
|
|
};
|
|
|
|
// This function stores the config property for key value pairs in
|
|
// datasource form which are initialized by default
|
|
export const setDefaultKeyValPairFlag = (defaultKeyValArrayConfig: string) => {
|
|
return {
|
|
type: ReduxActionTypes.SET_DATASOURCE_DEFAULT_KEY_VALUE_PAIR_SET,
|
|
payload: defaultKeyValArrayConfig,
|
|
};
|
|
};
|
|
|
|
// This function resets the config property stored in redux for key value pairs in
|
|
// datasource form which are initialized by default, once these key value pairs are initialized
|
|
// in the datasource config form, store needs to reset those values
|
|
export const resetDefaultKeyValPairFlag = () => {
|
|
return {
|
|
type: ReduxActionTypes.RESET_DATASOURCE_DEFAULT_KEY_VALUE_PAIR_SET,
|
|
payload: [],
|
|
};
|
|
};
|
|
|
|
export const initializeDatasourceFormDefaults = (pluginType: string) => {
|
|
return {
|
|
type: ReduxActionTypes.INITIALIZE_DATASOURCE_FORM_WITH_DEFAULTS,
|
|
payload: {
|
|
pluginType: pluginType,
|
|
},
|
|
};
|
|
};
|
|
|
|
// In case of access to specific sheets in google sheet datasource, this action
|
|
// is used for handling file picker callback, when user selects files/cancels the selection
|
|
// this callback action will be triggered
|
|
export const filePickerCallbackAction = (data: {
|
|
action: string;
|
|
datasourceId: string;
|
|
}) => {
|
|
return {
|
|
type: ReduxActionTypes.FILE_PICKER_CALLBACK_ACTION,
|
|
payload: data,
|
|
};
|
|
};
|
|
|
|
export default {
|
|
fetchDatasources,
|
|
initDatasourcePane,
|
|
};
|