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 { ReduxAction } from "@appsmith/constants/ReduxActionConstants";
|
|
|
|
|
import { ReduxActionTypes } from "@appsmith/constants/ReduxActionConstants";
|
|
|
|
|
import type { EventLocation } from "utils/AnalyticsUtil";
|
|
|
|
|
import type { SlashCommandPayload } from "entities/Action";
|
2019-11-25 09:15:11 +00:00
|
|
|
|
2020-07-06 05:38:39 +00:00
|
|
|
export const changeApi = (
|
|
|
|
|
id: string,
|
2021-05-04 13:08:20 +00:00
|
|
|
isSaas: boolean,
|
2020-07-06 05:38:39 +00:00
|
|
|
newApi?: boolean,
|
2021-05-04 13:08:20 +00:00
|
|
|
): ReduxAction<{ id: string; isSaas: boolean; newApi?: boolean }> => {
|
2019-11-25 09:15:11 +00:00
|
|
|
return {
|
|
|
|
|
type: ReduxActionTypes.API_PANE_CHANGE_API,
|
2021-05-04 13:08:20 +00:00
|
|
|
payload: { id, isSaas, newApi },
|
2019-11-25 09:15:11 +00:00
|
|
|
};
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
export const initApiPane = (urlId?: string): ReduxAction<{ id?: string }> => {
|
|
|
|
|
return {
|
|
|
|
|
type: ReduxActionTypes.INIT_API_PANE,
|
|
|
|
|
payload: { id: urlId },
|
|
|
|
|
};
|
|
|
|
|
};
|
2020-04-20 08:26:19 +00:00
|
|
|
|
2020-04-28 10:47:59 +00:00
|
|
|
export const setCurrentCategory = (
|
|
|
|
|
category: string,
|
|
|
|
|
): ReduxAction<{ category: string }> => {
|
|
|
|
|
return {
|
|
|
|
|
type: ReduxActionTypes.SET_CURRENT_CATEGORY,
|
|
|
|
|
payload: { category },
|
|
|
|
|
};
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
export const setLastUsedEditorPage = (
|
|
|
|
|
path: string,
|
|
|
|
|
): ReduxAction<{ path: string }> => {
|
|
|
|
|
return {
|
|
|
|
|
type: ReduxActionTypes.SET_LAST_USED_EDITOR_PAGE,
|
|
|
|
|
payload: { path },
|
|
|
|
|
};
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
export const setLastSelectedPage = (
|
|
|
|
|
selectedPageId: string,
|
|
|
|
|
): ReduxAction<{ selectedPageId: string }> => {
|
|
|
|
|
return {
|
|
|
|
|
type: ReduxActionTypes.SET_LAST_SELECTED_PAGE_PAGE,
|
|
|
|
|
payload: { selectedPageId },
|
|
|
|
|
};
|
|
|
|
|
};
|
|
|
|
|
|
2020-04-20 08:26:19 +00:00
|
|
|
export const createNewApiAction = (
|
|
|
|
|
pageId: string,
|
2020-10-06 15:10:21 +00:00
|
|
|
from: EventLocation,
|
2022-09-09 15:59:47 +00:00
|
|
|
apiType?: string,
|
|
|
|
|
): ReduxAction<{ pageId: string; from: EventLocation; apiType?: string }> => ({
|
2020-04-20 08:26:19 +00:00
|
|
|
type: ReduxActionTypes.CREATE_NEW_API_ACTION,
|
2022-09-09 15:59:47 +00:00
|
|
|
payload: { pageId, from, apiType },
|
2020-04-20 08:26:19 +00:00
|
|
|
});
|
2020-05-07 07:56:37 +00:00
|
|
|
|
Feature/entity browse (#220)
# New Feature: Entity Explorer
- Entities are actions (apis and queries), datasources, pages, and widgets
- With this new feature, all entities in the application will be available
to view in the new entity explorer sidebar
- All existing application features from the api sidebar, query sidebar, datasource sidebar and pages sidebar
now are avialable on the entity explorer sidebar
- Users are now able to quickly switch to any entity in the application from the entity explorer sidebar.
- Users can also search all entities in the application from the new sidebar. Use cmd + f or ctrl + f to focus on the search input
- Users can rename entities from the new sidebar
- Users can also perform contextual actions on these entities like set a page as home page, copy/move actions, delete entity, etc from the context menu available alongside the entities in the sidebar
- Users can view the properties of the entities in the sidebar, as well as copy bindings to use in the application.
2020-08-10 08:52:45 +00:00
|
|
|
export const createNewQueryAction = (
|
|
|
|
|
pageId: string,
|
2020-10-06 15:10:21 +00:00
|
|
|
from: EventLocation,
|
2022-01-29 07:26:19 +00:00
|
|
|
datasourceId: string,
|
|
|
|
|
): ReduxAction<{
|
|
|
|
|
pageId: string;
|
|
|
|
|
from: EventLocation;
|
|
|
|
|
datasourceId: string;
|
|
|
|
|
}> => ({
|
2020-05-28 10:12:02 +00:00
|
|
|
type: ReduxActionTypes.CREATE_NEW_QUERY_ACTION,
|
2022-01-29 07:26:19 +00:00
|
|
|
payload: { pageId, from, datasourceId },
|
2020-05-28 10:12:02 +00:00
|
|
|
});
|
2021-03-01 14:57:15 +00:00
|
|
|
|
|
|
|
|
export const updateBodyContentType = (
|
feat: Support body in GET API requests (#7127)
* WIP
* Refactoring HTTP Method & Content Type to be objects instead of arrays
TODO:
1. Set the default content-type for Get request to "None". Currently, it's raw
2. For None content-type, don't send the body field in the API request
* Almost working implementation for the None type
Currently, the body still gets sent in non-GET requests even if the None tab is selected.
* Adding object.freeze to prevent any modifications to HTTP_METHOD_ENUM
* WIP: Using enum & const for ts autocomplete
* working implementation for NONE type, apiContentType prop added to API actions
* WIP
* Refactoring HTTP Method & Content Type to be objects instead of arrays
TODO:
1. Set the default content-type for Get request to "None". Currently, it's raw
2. For None content-type, don't send the body field in the API request
* Almost working implementation for the None type
Currently, the body still gets sent in non-GET requests even if the None tab is selected.
* Adding object.freeze to prevent any modifications to HTTP_METHOD_ENUM
* WIP: Using enum & const for ts autocomplete
* working implementation for NONE type, apiContentType prop added to API actions
* adds apiContentType to actionConfiguration.formData object
* Handling apiContentType property in Rest API formData
* change apiContentType when user types content-type value and switches http method
* makes api editor as similar as possible to postman, project postman.
* Correcting the import in ApiEditorConstants
* Resolved all merge conflicts
* replay DSL functtionality
* removes unneccessary files from worker
* Fixes type declarations, naming e.t.c.
* fix server side merge conflicts
* fix client side merge conflicts
* fix failing cypress tests
Co-authored-by: Irongade <adeoluayangade@yahoo.com>
Co-authored-by: Ayangade Adeoluwa <37867493+Irongade@users.noreply.github.com>
2022-02-15 11:13:48 +00:00
|
|
|
title: string,
|
2021-03-01 14:57:15 +00:00
|
|
|
apiId: string,
|
feat: Support body in GET API requests (#7127)
* WIP
* Refactoring HTTP Method & Content Type to be objects instead of arrays
TODO:
1. Set the default content-type for Get request to "None". Currently, it's raw
2. For None content-type, don't send the body field in the API request
* Almost working implementation for the None type
Currently, the body still gets sent in non-GET requests even if the None tab is selected.
* Adding object.freeze to prevent any modifications to HTTP_METHOD_ENUM
* WIP: Using enum & const for ts autocomplete
* working implementation for NONE type, apiContentType prop added to API actions
* WIP
* Refactoring HTTP Method & Content Type to be objects instead of arrays
TODO:
1. Set the default content-type for Get request to "None". Currently, it's raw
2. For None content-type, don't send the body field in the API request
* Almost working implementation for the None type
Currently, the body still gets sent in non-GET requests even if the None tab is selected.
* Adding object.freeze to prevent any modifications to HTTP_METHOD_ENUM
* WIP: Using enum & const for ts autocomplete
* working implementation for NONE type, apiContentType prop added to API actions
* adds apiContentType to actionConfiguration.formData object
* Handling apiContentType property in Rest API formData
* change apiContentType when user types content-type value and switches http method
* makes api editor as similar as possible to postman, project postman.
* Correcting the import in ApiEditorConstants
* Resolved all merge conflicts
* replay DSL functtionality
* removes unneccessary files from worker
* Fixes type declarations, naming e.t.c.
* fix server side merge conflicts
* fix client side merge conflicts
* fix failing cypress tests
Co-authored-by: Irongade <adeoluayangade@yahoo.com>
Co-authored-by: Ayangade Adeoluwa <37867493+Irongade@users.noreply.github.com>
2022-02-15 11:13:48 +00:00
|
|
|
): ReduxAction<{ title: string; apiId: string }> => ({
|
2021-03-01 14:57:15 +00:00
|
|
|
type: ReduxActionTypes.UPDATE_API_ACTION_BODY_CONTENT_TYPE,
|
|
|
|
|
payload: { title, apiId },
|
|
|
|
|
});
|
2021-07-07 03:46:16 +00:00
|
|
|
|
|
|
|
|
export const redirectToNewIntegrations = (
|
|
|
|
|
pageId: string,
|
2021-07-29 08:13:10 +00:00
|
|
|
params?: any,
|
2021-10-18 14:03:44 +00:00
|
|
|
): ReduxAction<{
|
|
|
|
|
pageId: string;
|
|
|
|
|
params: any;
|
|
|
|
|
}> => ({
|
2021-07-07 03:46:16 +00:00
|
|
|
type: ReduxActionTypes.REDIRECT_TO_NEW_INTEGRATIONS,
|
2022-03-25 10:43:26 +00:00
|
|
|
payload: { pageId, params },
|
2021-07-07 03:46:16 +00:00
|
|
|
});
|
2021-09-22 16:59:47 +00:00
|
|
|
|
|
|
|
|
export const executeCommandAction = (payload: SlashCommandPayload) => ({
|
|
|
|
|
type: ReduxActionTypes.EXECUTE_COMMAND,
|
|
|
|
|
payload: payload,
|
|
|
|
|
});
|
2022-10-17 15:16:38 +00:00
|
|
|
|
|
|
|
|
export const setApiPaneConfigSelectedTabIndex: (
|
|
|
|
|
payload: number,
|
|
|
|
|
) => ReduxAction<{ selectedTabIndex: number }> = (payload: number) => ({
|
|
|
|
|
type: ReduxActionTypes.SET_API_PANE_CONFIG_SELECTED_TAB,
|
|
|
|
|
payload: { selectedTabIndex: payload },
|
|
|
|
|
});
|
|
|
|
|
|
2022-11-25 03:47:00 +00:00
|
|
|
export const setApiRightPaneSelectedTab: (
|
|
|
|
|
payload: number,
|
|
|
|
|
) => ReduxAction<{ selectedTab: number }> = (payload: number) => ({
|
|
|
|
|
type: ReduxActionTypes.SET_API_RIGHT_PANE_SELECTED_TAB,
|
|
|
|
|
payload: { selectedTab: payload },
|
|
|
|
|
});
|