2021-03-04 05:24:47 +00:00
|
|
|
import React, { lazy, Suspense } from "react";
|
2021-08-26 09:58:43 +00:00
|
|
|
|
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 { WidgetProps, WidgetState } from "widgets/BaseWidget";
|
|
|
|
|
import BaseWidget from "widgets/BaseWidget";
|
2021-03-04 05:24:47 +00:00
|
|
|
import Skeleton from "components/utils/Skeleton";
|
2021-09-09 15:10:22 +00:00
|
|
|
import { retryPromise } from "utils/AppsmithUtils";
|
|
|
|
|
import { EventType } from "constants/AppsmithActionConstants/ActionConstants";
|
2022-09-29 05:24:49 +00:00
|
|
|
import { contentConfig, styleConfig } from "./propertyConfig";
|
2023-07-28 13:29:16 +00:00
|
|
|
import type { ChartSelectedDataPoint } from "../constants";
|
2021-09-09 15:10:22 +00:00
|
|
|
|
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 { WidgetType } from "constants/WidgetConstants";
|
|
|
|
|
import type { ChartComponentProps } from "../component";
|
2022-08-12 12:10:17 +00:00
|
|
|
import { Colors } from "constants/Colors";
|
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 { Stylesheet } from "entities/AppTheming";
|
2023-04-14 06:27:49 +00:00
|
|
|
import { DefaultAutocompleteDefinitions } from "widgets/WidgetUtils";
|
|
|
|
|
import type { AutocompletionDefinitions } from "widgets/constants";
|
2023-07-28 13:29:16 +00:00
|
|
|
import { ChartErrorComponent } from "../component/ChartErrorComponent";
|
|
|
|
|
import { syntaxErrorsFromProps } from "./SyntaxErrorsEvaluation";
|
|
|
|
|
import { EmptyChartData } from "../component/EmptyChartData";
|
2021-03-04 05:24:47 +00:00
|
|
|
|
|
|
|
|
const ChartComponent = lazy(() =>
|
2023-05-11 05:26:03 +00:00
|
|
|
retryPromise(() => import(/* webpackChunkName: "charts" */ "../component")),
|
2021-03-04 05:24:47 +00:00
|
|
|
);
|
|
|
|
|
|
2023-07-28 13:29:16 +00:00
|
|
|
export const emptyChartData = (props: ChartWidgetProps) => {
|
|
|
|
|
if (props.chartType == "CUSTOM_FUSION_CHART") {
|
|
|
|
|
if (!props.customFusionChartConfig) {
|
|
|
|
|
return true;
|
|
|
|
|
} else {
|
|
|
|
|
return Object.keys(props.customFusionChartConfig).length == 0;
|
|
|
|
|
}
|
|
|
|
|
} else {
|
|
|
|
|
for (const seriesID in props.chartData) {
|
2023-08-09 15:19:00 +00:00
|
|
|
if (props.chartData[seriesID].data?.length > 0) {
|
2023-07-28 13:29:16 +00:00
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
return true;
|
|
|
|
|
}
|
|
|
|
|
};
|
|
|
|
|
|
2021-03-04 05:24:47 +00:00
|
|
|
class ChartWidget extends BaseWidget<ChartWidgetProps, WidgetState> {
|
2023-04-14 06:27:49 +00:00
|
|
|
static getAutocompleteDefinitions(): AutocompletionDefinitions {
|
|
|
|
|
return {
|
|
|
|
|
"!doc":
|
|
|
|
|
"Chart widget is used to view the graphical representation of your data. Chart is the go-to widget for your data visualisation needs.",
|
|
|
|
|
"!url": "https://docs.appsmith.com/widget-reference/chart",
|
|
|
|
|
isVisible: DefaultAutocompleteDefinitions.isVisible,
|
|
|
|
|
chartData: {
|
|
|
|
|
seriesName: "string",
|
|
|
|
|
data: "[$__chartDataPoint__$]",
|
|
|
|
|
},
|
|
|
|
|
xAxisName: "string",
|
|
|
|
|
yAxisName: "string",
|
|
|
|
|
selectedDataPoint: "$__chartDataPoint__$",
|
|
|
|
|
};
|
|
|
|
|
}
|
|
|
|
|
|
2021-06-18 07:42:57 +00:00
|
|
|
static getMetaPropertiesMap(): Record<string, any> {
|
2021-03-04 05:24:47 +00:00
|
|
|
return {
|
|
|
|
|
selectedDataPoint: undefined,
|
|
|
|
|
};
|
|
|
|
|
}
|
|
|
|
|
|
2022-08-09 13:05:36 +00:00
|
|
|
static getPropertyPaneContentConfig() {
|
|
|
|
|
return contentConfig;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
static getPropertyPaneStyleConfig() {
|
|
|
|
|
return styleConfig;
|
|
|
|
|
}
|
|
|
|
|
|
2022-11-28 04:44:31 +00:00
|
|
|
static getStylesheetConfig(): Stylesheet {
|
|
|
|
|
return {
|
|
|
|
|
borderRadius: "{{appsmith.theme.borderRadius.appBorderRadius}}",
|
|
|
|
|
boxShadow: "{{appsmith.theme.boxShadow.appBoxShadow}}",
|
|
|
|
|
accentColor: "{{appsmith.theme.colors.primaryColor}}",
|
|
|
|
|
fontFamily: "{{appsmith.theme.fontFamily.appFont}}",
|
|
|
|
|
};
|
|
|
|
|
}
|
|
|
|
|
|
2021-08-18 07:11:07 +00:00
|
|
|
onDataPointClick = (selectedDataPoint: ChartSelectedDataPoint) => {
|
2021-03-04 05:24:47 +00:00
|
|
|
this.props.updateWidgetMetaProperty(
|
|
|
|
|
"selectedDataPoint",
|
|
|
|
|
selectedDataPoint,
|
|
|
|
|
{
|
2021-04-23 13:50:55 +00:00
|
|
|
triggerPropertyName: "onDataPointClick",
|
2021-03-04 05:24:47 +00:00
|
|
|
dynamicString: this.props.onDataPointClick,
|
|
|
|
|
event: {
|
|
|
|
|
type: EventType.ON_DATA_POINT_CLICK,
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
);
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
getPageView() {
|
2023-07-28 13:29:16 +00:00
|
|
|
const errors = syntaxErrorsFromProps(this.props);
|
|
|
|
|
|
|
|
|
|
if (errors.length == 0) {
|
|
|
|
|
if (emptyChartData(this.props)) {
|
|
|
|
|
return <EmptyChartData />;
|
|
|
|
|
} else {
|
|
|
|
|
return (
|
|
|
|
|
<Suspense fallback={<Skeleton />}>
|
|
|
|
|
<ChartComponent
|
|
|
|
|
allowScroll={this.props.allowScroll}
|
|
|
|
|
borderRadius={this.props.borderRadius}
|
|
|
|
|
bottomRow={this.props.bottomRow}
|
|
|
|
|
boxShadow={this.props.boxShadow}
|
|
|
|
|
chartData={this.props.chartData}
|
|
|
|
|
chartName={this.props.chartName}
|
|
|
|
|
chartType={this.props.chartType}
|
|
|
|
|
customFusionChartConfig={this.props.customFusionChartConfig}
|
|
|
|
|
dimensions={this.getComponentDimensions()}
|
|
|
|
|
fontFamily={this.props.fontFamily ?? "Nunito Sans"}
|
|
|
|
|
hasOnDataPointClick={Boolean(this.props.onDataPointClick)}
|
|
|
|
|
isLoading={this.props.isLoading}
|
|
|
|
|
isVisible={this.props.isVisible}
|
|
|
|
|
key={this.props.widgetId}
|
|
|
|
|
labelOrientation={this.props.labelOrientation}
|
|
|
|
|
leftColumn={this.props.leftColumn}
|
|
|
|
|
onDataPointClick={this.onDataPointClick}
|
|
|
|
|
primaryColor={this.props.accentColor ?? Colors.ROYAL_BLUE_2}
|
|
|
|
|
rightColumn={this.props.rightColumn}
|
|
|
|
|
setAdaptiveYMin={this.props.setAdaptiveYMin}
|
2023-08-14 13:54:05 +00:00
|
|
|
showDataPointLabel={this.props.showDataPointLabel}
|
2023-07-28 13:29:16 +00:00
|
|
|
topRow={this.props.topRow}
|
|
|
|
|
widgetId={this.props.widgetId}
|
|
|
|
|
xAxisName={this.props.xAxisName}
|
|
|
|
|
yAxisName={this.props.yAxisName}
|
|
|
|
|
/>
|
|
|
|
|
</Suspense>
|
|
|
|
|
);
|
|
|
|
|
}
|
|
|
|
|
} else {
|
|
|
|
|
return <ChartErrorComponent error={errors[0]} />;
|
|
|
|
|
}
|
2021-03-04 05:24:47 +00:00
|
|
|
}
|
|
|
|
|
|
2021-09-09 15:10:22 +00:00
|
|
|
static getWidgetType(): WidgetType {
|
2021-03-04 05:24:47 +00:00
|
|
|
return "CHART_WIDGET";
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2021-08-26 09:58:43 +00:00
|
|
|
type ChartComponentPartialProps = Omit<ChartComponentProps, "onDataPointClick">;
|
|
|
|
|
export interface ChartWidgetProps
|
|
|
|
|
extends WidgetProps,
|
|
|
|
|
ChartComponentPartialProps {
|
2021-03-04 05:24:47 +00:00
|
|
|
onDataPointClick?: string;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
export default ChartWidget;
|