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 { AppState } from "@appsmith/reducers";
|
2022-12-20 15:10:18 +00:00
|
|
|
import { redirectAuthorizationCode } from "actions/datasourceActions";
|
2023-05-19 18:37:06 +00:00
|
|
|
import type { CalloutKind } from "design-system";
|
|
|
|
|
import { Callout } from "design-system";
|
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 { Datasource } from "entities/Datasource";
|
2023-04-21 11:03:39 +00:00
|
|
|
import { ActionType } from "entities/Datasource";
|
2022-12-20 15:10:18 +00:00
|
|
|
import React from "react";
|
|
|
|
|
import { useDispatch, useSelector } from "react-redux";
|
|
|
|
|
import { getPluginTypeFromDatasourceId } from "selectors/entitiesSelector";
|
|
|
|
|
import styled from "styled-components";
|
2023-04-21 11:03:39 +00:00
|
|
|
import {
|
|
|
|
|
setGlobalSearchQuery,
|
|
|
|
|
toggleShowGlobalSearchModal,
|
|
|
|
|
} from "actions/globalSearchActions";
|
|
|
|
|
import AnalyticsUtil from "utils/AnalyticsUtil";
|
|
|
|
|
import {
|
|
|
|
|
GOOGLE_SHEETS_AUTHORIZE_DATASOURCE,
|
|
|
|
|
GOOGLE_SHEETS_LEARN_MORE,
|
2023-05-24 09:16:14 +00:00
|
|
|
createMessage,
|
2023-04-26 07:18:16 +00:00
|
|
|
} from "@appsmith/constants/messages";
|
2022-12-20 15:10:18 +00:00
|
|
|
|
2023-05-29 05:40:41 +00:00
|
|
|
const StyledAuthMessage = styled.div<{ isInViewMode: boolean }>`
|
feat: gsheet disable new query when no files selected (#21912)
## Description
This PR adds:
- When gsheet datasource is created with "Selected Sheets" Modality, and
if user fails to select any files from file picker
- we should disable new query creation
- we should show error message banner on datasource review page
**How to test:**
- Create google sheet datasource, break the authorisation flow, check
review page, error message like "Data source is not authorized, please
authorize to continue." would be shown.
- Edit datasource, complete the authorisation but do not pick any files
from file picker, error message like "Datasource does not have access to
any files, please authorize google sheets to use this data source" would
be shown
Fixes #20290
Media
> A video or a GIF is preferred. when using Loom, don’t embed because it
looks like it’s a GIF. instead, just link to the video
## Type of change
> Please delete options that are not relevant.
- New feature (non-breaking change which adds functionality)
## How Has This Been Tested?
- Manual
### 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
- [x] I have performed a self-review of my own code
- [x] 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
- [x] 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: “sneha122” <“sneha@appsmith.com”>
2023-04-06 14:12:34 +00:00
|
|
|
width: fit-content;
|
2023-05-29 05:40:41 +00:00
|
|
|
${(props) =>
|
|
|
|
|
!props.isInViewMode &&
|
|
|
|
|
`margin-top: var(--ads-v2-spaces-5);margin-bottom: var(--ads-v2-spaces-4);`}
|
2022-12-20 15:10:18 +00:00
|
|
|
`;
|
|
|
|
|
|
|
|
|
|
type AuthMessageProps = {
|
|
|
|
|
// We can handle for other action types as well eg. save, delete etc.
|
2023-04-21 11:03:39 +00:00
|
|
|
actionType?: string;
|
2022-12-20 15:10:18 +00:00
|
|
|
datasource: Datasource;
|
|
|
|
|
description: string;
|
|
|
|
|
pageId?: string;
|
|
|
|
|
style?: any;
|
2023-05-19 18:37:06 +00:00
|
|
|
calloutType?: CalloutKind;
|
2023-05-29 05:40:41 +00:00
|
|
|
isInViewMode?: boolean;
|
2022-12-20 15:10:18 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
export default function AuthMessage(props: AuthMessageProps) {
|
2023-04-21 11:03:39 +00:00
|
|
|
const {
|
|
|
|
|
actionType,
|
2023-05-19 18:37:06 +00:00
|
|
|
calloutType = "error",
|
2023-04-21 11:03:39 +00:00
|
|
|
datasource,
|
|
|
|
|
description,
|
|
|
|
|
pageId,
|
|
|
|
|
style = {},
|
2023-05-29 05:40:41 +00:00
|
|
|
isInViewMode = false,
|
2023-04-21 11:03:39 +00:00
|
|
|
} = props;
|
2022-12-20 15:10:18 +00:00
|
|
|
const dispatch = useDispatch();
|
|
|
|
|
const pluginType = useSelector((state: AppState) =>
|
|
|
|
|
getPluginTypeFromDatasourceId(state, datasource.id),
|
|
|
|
|
);
|
2023-05-19 18:37:06 +00:00
|
|
|
const handleOauthAuthorization: any = (e: React.MouseEvent) => {
|
|
|
|
|
e.preventDefault();
|
2022-12-20 15:10:18 +00:00
|
|
|
if (!pluginType || !pageId) return;
|
|
|
|
|
dispatch(redirectAuthorizationCode(pageId, datasource.id, pluginType));
|
|
|
|
|
};
|
2023-04-21 11:03:39 +00:00
|
|
|
const handleDocumentationClick: any = (e: React.MouseEvent) => {
|
|
|
|
|
e.stopPropagation();
|
2023-05-19 18:37:06 +00:00
|
|
|
e.preventDefault();
|
2023-04-21 11:03:39 +00:00
|
|
|
const query = "Google Sheets";
|
|
|
|
|
dispatch(setGlobalSearchQuery(query));
|
|
|
|
|
dispatch(toggleShowGlobalSearchModal());
|
|
|
|
|
AnalyticsUtil.logEvent("OPEN_OMNIBAR", {
|
|
|
|
|
source: "DATASOURCE_DOCUMENTATION_CLICK",
|
|
|
|
|
query,
|
|
|
|
|
});
|
|
|
|
|
};
|
|
|
|
|
|
2022-12-20 15:10:18 +00:00
|
|
|
return (
|
2023-05-29 05:40:41 +00:00
|
|
|
<StyledAuthMessage isInViewMode={isInViewMode} style={style}>
|
2023-05-19 18:37:06 +00:00
|
|
|
<Callout
|
|
|
|
|
kind={calloutType}
|
|
|
|
|
links={
|
|
|
|
|
actionType === ActionType.AUTHORIZE
|
|
|
|
|
? [
|
|
|
|
|
{
|
|
|
|
|
children: createMessage(GOOGLE_SHEETS_AUTHORIZE_DATASOURCE),
|
|
|
|
|
onClick: handleOauthAuthorization,
|
|
|
|
|
},
|
|
|
|
|
]
|
|
|
|
|
: actionType === ActionType.DOCUMENTATION
|
|
|
|
|
? [
|
|
|
|
|
{
|
|
|
|
|
children: createMessage(GOOGLE_SHEETS_LEARN_MORE),
|
|
|
|
|
onClick: handleDocumentationClick,
|
|
|
|
|
},
|
|
|
|
|
]
|
|
|
|
|
: undefined
|
|
|
|
|
}
|
|
|
|
|
>
|
|
|
|
|
{description}
|
|
|
|
|
</Callout>
|
2022-12-20 15:10:18 +00:00
|
|
|
</StyledAuthMessage>
|
|
|
|
|
);
|
|
|
|
|
}
|