2023-01-13 18:49:21 +00:00
|
|
|
import log from "loglevel";
|
2020-11-30 07:23:05 +00:00
|
|
|
import React, { useState } from "react";
|
2023-01-13 18:49:21 +00:00
|
|
|
import styled from "styled-components";
|
|
|
|
|
import { Wrapper, Status } from "@googlemaps/react-wrapper";
|
|
|
|
|
|
2021-03-15 12:17:56 +00:00
|
|
|
import { StyledInputGroup } from "./StyledControls";
|
2022-06-03 05:07:02 +00:00
|
|
|
import { isDynamicValue } from "utils/DynamicBindingUtils";
|
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 { ControlData, ControlProps } from "./BaseControl";
|
|
|
|
|
import BaseControl from "./BaseControl";
|
2020-08-07 06:22:36 +00:00
|
|
|
|
2023-01-13 18:49:21 +00:00
|
|
|
const MapStatusText = styled.span`
|
|
|
|
|
font-size: 14px;
|
|
|
|
|
`;
|
2020-11-24 08:43:45 +00:00
|
|
|
|
2023-01-13 18:49:21 +00:00
|
|
|
const renderMapStatus = (status: Status) => {
|
|
|
|
|
switch (status) {
|
|
|
|
|
case Status.LOADING:
|
|
|
|
|
return <MapStatusText>Loading...</MapStatusText>;
|
|
|
|
|
case Status.FAILURE:
|
|
|
|
|
return <MapStatusText>Error in the component</MapStatusText>;
|
|
|
|
|
case Status.SUCCESS:
|
|
|
|
|
return <MapStatusText>Component loaded....</MapStatusText>;
|
|
|
|
|
}
|
|
|
|
|
};
|
|
|
|
|
class LocationSearchControl extends BaseControl<ControlProps> {
|
2020-11-30 07:23:05 +00:00
|
|
|
clearLocation = () => {
|
|
|
|
|
this.updateProperty(this.props.propertyName, {
|
|
|
|
|
lat: -34.397,
|
|
|
|
|
long: 150.644,
|
|
|
|
|
title: "",
|
|
|
|
|
});
|
2020-11-24 08:43:45 +00:00
|
|
|
};
|
|
|
|
|
|
2023-01-13 18:49:21 +00:00
|
|
|
onLocationSelection = (ref: any) => {
|
2021-02-24 15:29:12 +00:00
|
|
|
try {
|
|
|
|
|
// For some places, the length is zero
|
2023-01-13 18:49:21 +00:00
|
|
|
const places = ref.getPlaces();
|
2021-02-24 15:29:12 +00:00
|
|
|
const location = places[0].geometry.location;
|
|
|
|
|
const title = places[0].formatted_address;
|
|
|
|
|
const lat = location.lat();
|
|
|
|
|
const long = location.lng();
|
|
|
|
|
const value = { lat, long, title };
|
2022-07-14 05:00:30 +00:00
|
|
|
this.updateProperty(this.props.propertyName, value, true);
|
2021-02-24 15:29:12 +00:00
|
|
|
} catch (e) {
|
2023-01-13 18:49:21 +00:00
|
|
|
if (ref && ref.getPlaces)
|
|
|
|
|
log.debug("Error selecting location:", ref.getPlaces());
|
2021-02-24 15:29:12 +00:00
|
|
|
else {
|
|
|
|
|
log.debug("Error selecting location - searchBox not found");
|
|
|
|
|
}
|
|
|
|
|
}
|
2020-11-24 08:43:45 +00:00
|
|
|
};
|
|
|
|
|
|
2023-01-13 18:49:21 +00:00
|
|
|
onSearchBoxMounted = (ref: any) => {
|
|
|
|
|
if (window) {
|
|
|
|
|
const searchBox = new window.google.maps.places.SearchBox(ref);
|
|
|
|
|
searchBox.addListener("places_changed", () => {
|
|
|
|
|
this.onLocationSelection(searchBox);
|
|
|
|
|
});
|
|
|
|
|
}
|
2020-04-15 11:42:11 +00:00
|
|
|
};
|
2020-11-24 08:43:45 +00:00
|
|
|
|
2020-04-15 11:42:11 +00:00
|
|
|
render() {
|
|
|
|
|
return (
|
2023-01-13 18:49:21 +00:00
|
|
|
<Wrapper
|
2023-02-07 09:23:15 +00:00
|
|
|
apiKey={this.props.widgetProperties.googleMapsApiKey}
|
2023-01-13 18:49:21 +00:00
|
|
|
libraries={["geometry", "drawing", "places"]}
|
|
|
|
|
render={renderMapStatus}
|
|
|
|
|
>
|
|
|
|
|
<MapScriptWrapper
|
|
|
|
|
clearLocation={this.clearLocation}
|
|
|
|
|
onSearchBoxMounted={this.onSearchBoxMounted}
|
|
|
|
|
propertyValue={this.props.propertyValue}
|
|
|
|
|
/>
|
|
|
|
|
</Wrapper>
|
2020-04-15 11:42:11 +00:00
|
|
|
);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
static getControlType() {
|
|
|
|
|
return "LOCATION_SEARCH";
|
|
|
|
|
}
|
2022-06-03 05:07:02 +00:00
|
|
|
|
|
|
|
|
static canDisplayValueInUI(config: ControlData, value: any): boolean {
|
|
|
|
|
return !isDynamicValue(value);
|
|
|
|
|
}
|
2020-04-15 11:42:11 +00:00
|
|
|
}
|
|
|
|
|
|
2020-11-30 07:23:05 +00:00
|
|
|
interface MapScriptWrapperProps {
|
2023-01-13 18:49:21 +00:00
|
|
|
onSearchBoxMounted: (ref: any) => void;
|
2020-11-30 07:23:05 +00:00
|
|
|
clearLocation: () => void;
|
|
|
|
|
propertyValue: any;
|
|
|
|
|
}
|
|
|
|
|
|
2021-04-28 10:28:39 +00:00
|
|
|
function MapScriptWrapper(props: MapScriptWrapperProps) {
|
2020-11-30 07:23:05 +00:00
|
|
|
const [title, setTitle] = useState("");
|
2021-01-19 07:29:15 +00:00
|
|
|
|
2020-11-30 07:23:05 +00:00
|
|
|
return (
|
|
|
|
|
<div data-standalone-searchbox="">
|
2023-01-13 18:49:21 +00:00
|
|
|
<StyledInputGroup
|
|
|
|
|
dataType="text"
|
|
|
|
|
defaultValue={title || props.propertyValue?.title}
|
|
|
|
|
onChange={(value: string) => {
|
|
|
|
|
if (value === "") {
|
|
|
|
|
props.clearLocation();
|
|
|
|
|
}
|
|
|
|
|
setTitle(value);
|
|
|
|
|
}}
|
|
|
|
|
placeholder="Enter location"
|
|
|
|
|
ref={props.onSearchBoxMounted}
|
|
|
|
|
tabIndex={-1}
|
|
|
|
|
/>
|
2020-11-30 07:23:05 +00:00
|
|
|
</div>
|
|
|
|
|
);
|
2021-04-28 10:28:39 +00:00
|
|
|
}
|
2020-11-30 07:23:05 +00:00
|
|
|
|
2020-04-15 11:42:11 +00:00
|
|
|
export default LocationSearchControl;
|