2020-04-28 06:52:53 +00:00
|
|
|
import * as React from "react";
|
2021-12-27 12:04:45 +00:00
|
|
|
import { useState } from "react";
|
2020-04-28 06:52:53 +00:00
|
|
|
import styled from "styled-components";
|
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 { ControlProps } from "./BaseControl";
|
|
|
|
|
import BaseControl from "./BaseControl";
|
|
|
|
|
import type { ControlType } from "constants/PropertyControlConstants";
|
2024-08-08 12:55:00 +00:00
|
|
|
import type { SetProgress } from "@appsmith/ads-old";
|
|
|
|
|
import { FilePickerV2, FileType } from "@appsmith/ads-old";
|
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 { WrappedFieldInputProps, WrappedFieldMetaProps } from "redux-form";
|
|
|
|
|
import { Field } from "redux-form";
|
2021-12-27 12:04:45 +00:00
|
|
|
import { useEffect, useCallback } from "react";
|
2021-12-07 09:45:18 +00:00
|
|
|
import { replayHighlightClass } from "globalStyles/portals";
|
2023-05-19 18:37:06 +00:00
|
|
|
import { Button, Modal, ModalBody, ModalContent } from "design-system";
|
2020-04-28 06:52:53 +00:00
|
|
|
|
|
|
|
|
const StyledDiv = styled.div`
|
|
|
|
|
flex: 1;
|
2023-05-19 18:37:06 +00:00
|
|
|
border: 1px solid var(--ads-v2-color-border);
|
2020-04-28 06:52:53 +00:00
|
|
|
border-right: none;
|
|
|
|
|
padding: 6px 12px;
|
|
|
|
|
font-size: 14px;
|
2022-09-09 15:59:47 +00:00
|
|
|
white-space: nowrap;
|
|
|
|
|
text-overflow: ellipsis;
|
|
|
|
|
overflow: hidden;
|
2023-05-19 18:37:06 +00:00
|
|
|
border-radius: var(--ads-v2-border-radius) 0 0 var(--ads-v2-border-radius);
|
2020-04-28 06:52:53 +00:00
|
|
|
`;
|
|
|
|
|
|
2021-12-27 12:04:45 +00:00
|
|
|
const FilePickerWrapper = styled.div`
|
|
|
|
|
width: 100%;
|
|
|
|
|
display: flex;
|
|
|
|
|
align-items: center;
|
|
|
|
|
justify-content: center;
|
|
|
|
|
`;
|
2020-04-28 06:52:53 +00:00
|
|
|
|
2023-05-19 18:37:06 +00:00
|
|
|
const FilePickerContainer = styled.div`
|
|
|
|
|
flex-direction: row;
|
|
|
|
|
display: flex;
|
|
|
|
|
width: 270px;
|
|
|
|
|
.btn-select {
|
|
|
|
|
border-radius: 0 var(--ads-v2-border-radius) var(--ads-v2-border-radius) 0 !important;
|
|
|
|
|
}
|
|
|
|
|
`;
|
2021-12-27 12:04:45 +00:00
|
|
|
type RenderFilePickerProps = FilePickerControlProps & {
|
|
|
|
|
input?: WrappedFieldInputProps;
|
|
|
|
|
meta?: WrappedFieldMetaProps;
|
2022-01-06 14:39:21 +00:00
|
|
|
disabled?: boolean;
|
2024-07-31 15:41:28 +00:00
|
|
|
// TODO: Fix this the next time the file is edited
|
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
2021-12-27 12:04:45 +00:00
|
|
|
onChange: (event: any) => void;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
function RenderFilePicker(props: RenderFilePickerProps) {
|
|
|
|
|
const [isOpen, setIsOpen] = useState(false);
|
|
|
|
|
const [appFileToBeUploaded, setAppFileToBeUploaded] = useState<{
|
|
|
|
|
file: File;
|
|
|
|
|
setProgress: SetProgress;
|
|
|
|
|
} | null>(null);
|
|
|
|
|
|
2023-05-19 18:37:06 +00:00
|
|
|
// const changeOpenState = (state: boolean) => setIsOpen(state);
|
2021-12-27 12:04:45 +00:00
|
|
|
const FileUploader = useCallback(
|
|
|
|
|
async (file: File, setProgress: SetProgress) => {
|
|
|
|
|
if (!!file) {
|
|
|
|
|
setAppFileToBeUploaded({
|
|
|
|
|
file,
|
|
|
|
|
setProgress,
|
|
|
|
|
});
|
|
|
|
|
} else {
|
|
|
|
|
setAppFileToBeUploaded(null);
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
[],
|
|
|
|
|
);
|
2020-04-28 06:52:53 +00:00
|
|
|
|
2021-12-27 12:04:45 +00:00
|
|
|
const onRemoveFile = useCallback(() => setAppFileToBeUploaded(null), []);
|
2020-04-28 06:52:53 +00:00
|
|
|
|
2021-12-27 12:04:45 +00:00
|
|
|
useEffect(() => {
|
|
|
|
|
if (appFileToBeUploaded?.file) {
|
2020-04-28 06:52:53 +00:00
|
|
|
const reader = new FileReader();
|
2021-12-27 12:04:45 +00:00
|
|
|
reader.readAsDataURL(appFileToBeUploaded?.file);
|
2020-04-28 06:52:53 +00:00
|
|
|
reader.onloadend = () => {
|
|
|
|
|
const base64data = reader.result;
|
2021-12-27 12:04:45 +00:00
|
|
|
props.input?.onChange({
|
|
|
|
|
name: appFileToBeUploaded?.file.name,
|
2020-04-28 06:52:53 +00:00
|
|
|
base64Content: base64data,
|
|
|
|
|
});
|
|
|
|
|
};
|
2021-12-27 12:04:45 +00:00
|
|
|
}
|
|
|
|
|
}, [appFileToBeUploaded]);
|
2020-04-28 06:52:53 +00:00
|
|
|
|
2021-12-27 12:04:45 +00:00
|
|
|
return (
|
|
|
|
|
<>
|
2023-05-19 18:37:06 +00:00
|
|
|
<FilePickerContainer className={replayHighlightClass}>
|
2022-09-09 15:59:47 +00:00
|
|
|
<StyledDiv title={props?.input?.value?.name}>
|
|
|
|
|
{props?.input?.value?.name}
|
|
|
|
|
</StyledDiv>
|
2023-05-19 18:37:06 +00:00
|
|
|
<Button
|
|
|
|
|
className="btn-select"
|
2022-01-06 14:39:21 +00:00
|
|
|
disabled={props.disabled}
|
2023-05-19 18:37:06 +00:00
|
|
|
kind="secondary"
|
2020-04-28 06:52:53 +00:00
|
|
|
onClick={() => {
|
2021-12-27 12:04:45 +00:00
|
|
|
setIsOpen(true);
|
2020-04-28 06:52:53 +00:00
|
|
|
}}
|
2023-05-19 18:37:06 +00:00
|
|
|
size="md"
|
|
|
|
|
>
|
|
|
|
|
Select
|
|
|
|
|
</Button>
|
|
|
|
|
</FilePickerContainer>
|
2021-12-27 12:04:45 +00:00
|
|
|
{isOpen ? (
|
2023-05-19 18:37:06 +00:00
|
|
|
<Modal
|
|
|
|
|
onOpenChange={() => {
|
|
|
|
|
setIsOpen(false);
|
|
|
|
|
}}
|
|
|
|
|
open={isOpen}
|
2021-12-27 12:04:45 +00:00
|
|
|
>
|
2023-05-19 18:37:06 +00:00
|
|
|
<ModalContent style={{ width: "640px" }}>
|
|
|
|
|
<ModalBody>
|
|
|
|
|
<FilePickerWrapper>
|
|
|
|
|
<FilePickerV2
|
|
|
|
|
delayedUpload
|
|
|
|
|
fileType={FileType.ANY}
|
|
|
|
|
fileUploader={FileUploader}
|
|
|
|
|
onFileRemoved={onRemoveFile}
|
|
|
|
|
/>
|
|
|
|
|
</FilePickerWrapper>
|
|
|
|
|
</ModalBody>
|
|
|
|
|
</ModalContent>
|
|
|
|
|
</Modal>
|
2021-12-27 12:04:45 +00:00
|
|
|
) : null}
|
|
|
|
|
</>
|
|
|
|
|
);
|
2020-04-28 06:52:53 +00:00
|
|
|
}
|
|
|
|
|
class FilePickerControl extends BaseControl<FilePickerControlProps> {
|
|
|
|
|
constructor(props: FilePickerControlProps) {
|
|
|
|
|
super(props);
|
|
|
|
|
this.state = {
|
|
|
|
|
isOpen: false,
|
|
|
|
|
};
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
render() {
|
2022-01-06 14:39:21 +00:00
|
|
|
const { configProperty, disabled } = this.props;
|
|
|
|
|
return (
|
|
|
|
|
<Field
|
|
|
|
|
component={RenderFilePicker}
|
|
|
|
|
disabled={disabled}
|
|
|
|
|
name={configProperty}
|
|
|
|
|
/>
|
|
|
|
|
);
|
2020-04-28 06:52:53 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
getControlType(): ControlType {
|
|
|
|
|
return "FILE_PICKER";
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
export interface FilePickerComponentState {
|
|
|
|
|
isOpen: boolean;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
export type FilePickerControlProps = ControlProps;
|
|
|
|
|
|
|
|
|
|
export default FilePickerControl;
|