2023-01-13 18:49:21 +00:00
|
|
|
import styled from "styled-components";
|
|
|
|
|
import React, { useCallback, useEffect, useRef, useState } from "react";
|
|
|
|
|
|
|
|
|
|
import Clusterer from "./Clusterer";
|
|
|
|
|
import SearchBox from "./SearchBox";
|
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 { MapComponentProps } from ".";
|
2023-01-13 18:49:21 +00:00
|
|
|
import PickMyLocation from "./PickMyLocation";
|
2023-02-07 08:51:19 +00:00
|
|
|
import Markers from "./Markers";
|
2023-01-13 18:49:21 +00:00
|
|
|
|
|
|
|
|
const Wrapper = styled.div`
|
|
|
|
|
position: relative;
|
2023-02-03 05:47:40 +00:00
|
|
|
height: 100%;
|
2023-04-07 13:51:35 +00:00
|
|
|
width: 100%;
|
2023-01-13 18:49:21 +00:00
|
|
|
`;
|
|
|
|
|
|
|
|
|
|
const StyledMap = styled.div<Pick<MapProps, "borderRadius" | "boxShadow">>`
|
|
|
|
|
width: 100%;
|
2023-02-07 08:51:19 +00:00
|
|
|
height: 100%;
|
2023-01-13 18:49:21 +00:00
|
|
|
box-shadow: ${(props) => props.boxShadow};
|
2023-02-07 08:51:19 +00:00
|
|
|
border-radius: ${(props) => props.borderRadius};
|
2023-01-13 18:49:21 +00:00
|
|
|
`;
|
|
|
|
|
|
|
|
|
|
type MapProps = {
|
|
|
|
|
children?: React.ReactNode;
|
|
|
|
|
} & Pick<
|
|
|
|
|
MapComponentProps,
|
|
|
|
|
| "updateCenter"
|
|
|
|
|
| "zoomLevel"
|
|
|
|
|
| "updateMarker"
|
|
|
|
|
| "selectMarker"
|
|
|
|
|
| "saveMarker"
|
|
|
|
|
| "markers"
|
|
|
|
|
| "center"
|
|
|
|
|
| "enableCreateMarker"
|
|
|
|
|
| "selectedMarker"
|
|
|
|
|
| "borderRadius"
|
|
|
|
|
| "boxShadow"
|
|
|
|
|
| "clickedMarkerCentered"
|
|
|
|
|
| "enableDrag"
|
2023-02-07 08:51:19 +00:00
|
|
|
| "allowClustering"
|
2023-01-13 18:49:21 +00:00
|
|
|
>;
|
|
|
|
|
|
|
|
|
|
const Map = (props: MapProps) => {
|
|
|
|
|
const {
|
2023-02-07 08:51:19 +00:00
|
|
|
allowClustering,
|
2023-01-13 18:49:21 +00:00
|
|
|
borderRadius,
|
|
|
|
|
boxShadow,
|
|
|
|
|
center,
|
|
|
|
|
children,
|
|
|
|
|
enableCreateMarker,
|
|
|
|
|
enableDrag,
|
|
|
|
|
markers,
|
|
|
|
|
saveMarker,
|
|
|
|
|
selectMarker,
|
|
|
|
|
updateCenter,
|
|
|
|
|
updateMarker,
|
|
|
|
|
zoomLevel,
|
|
|
|
|
} = props;
|
|
|
|
|
const [map, setMap] = useState<google.maps.Map>();
|
|
|
|
|
const mapRef = useRef<HTMLDivElement>(null);
|
|
|
|
|
|
|
|
|
|
// initialize the map instance
|
|
|
|
|
useEffect(() => {
|
|
|
|
|
if (!mapRef.current) return;
|
|
|
|
|
|
|
|
|
|
setMap(
|
|
|
|
|
new window.google.maps.Map(mapRef.current, {
|
|
|
|
|
streetViewControl: false,
|
|
|
|
|
mapTypeControl: false,
|
|
|
|
|
fullscreenControl: false,
|
|
|
|
|
}),
|
|
|
|
|
);
|
|
|
|
|
}, [mapRef]);
|
|
|
|
|
|
|
|
|
|
// set center if center is changed
|
|
|
|
|
useEffect(() => {
|
|
|
|
|
if (map) {
|
|
|
|
|
map.setCenter({ lat: center.lat, lng: center.long });
|
|
|
|
|
}
|
|
|
|
|
}, [center, map]);
|
|
|
|
|
|
|
|
|
|
// set zoom if zoomLevel is changed
|
|
|
|
|
useEffect(() => {
|
|
|
|
|
if (map) {
|
|
|
|
|
map.setZoom(Math.floor(zoomLevel / 5));
|
|
|
|
|
}
|
|
|
|
|
}, [zoomLevel, map]);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* on click map, add marker
|
|
|
|
|
*
|
|
|
|
|
* @param e
|
|
|
|
|
* @returns
|
|
|
|
|
*/
|
|
|
|
|
const onClickOnMap = useCallback(
|
|
|
|
|
(e: google.maps.MapMouseEvent) => {
|
|
|
|
|
if (!enableCreateMarker || !saveMarker) return;
|
|
|
|
|
|
|
|
|
|
// only save marker when lag and long are available
|
|
|
|
|
if (e.latLng?.lat() && e.latLng?.lng()) {
|
|
|
|
|
saveMarker(Number(e.latLng.lat()), Number(e.latLng.lng()));
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
[enableCreateMarker, saveMarker],
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
// NOTE: The event listeners require code to clear existing listeners
|
|
|
|
|
// when a handler passed as a prop has been updated.
|
|
|
|
|
React.useEffect(() => {
|
|
|
|
|
if (map) {
|
|
|
|
|
["click", "idle"].forEach((eventName) =>
|
|
|
|
|
google.maps.event.clearListeners(map, eventName),
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
map.addListener("click", onClickOnMap);
|
|
|
|
|
}
|
|
|
|
|
}, [map, onClickOnMap]);
|
|
|
|
|
|
2023-02-07 08:51:19 +00:00
|
|
|
const MarkersOrCluster = allowClustering ? Clusterer : Markers;
|
|
|
|
|
|
2023-01-13 18:49:21 +00:00
|
|
|
return (
|
2023-04-14 13:55:44 +00:00
|
|
|
<Wrapper onClick={(e) => e.stopPropagation()} onMouseLeave={enableDrag}>
|
2023-01-13 18:49:21 +00:00
|
|
|
<StyledMap
|
|
|
|
|
borderRadius={borderRadius}
|
|
|
|
|
boxShadow={boxShadow}
|
|
|
|
|
id="map"
|
|
|
|
|
ref={mapRef}
|
|
|
|
|
/>
|
2023-02-07 08:51:19 +00:00
|
|
|
{map && (
|
|
|
|
|
<MarkersOrCluster
|
|
|
|
|
key={`markers-${allowClustering ? "cluster" : "markers"}-${
|
|
|
|
|
markers?.length
|
|
|
|
|
}`}
|
|
|
|
|
map={map}
|
|
|
|
|
markers={markers}
|
|
|
|
|
selectMarker={selectMarker}
|
|
|
|
|
updateCenter={updateCenter}
|
|
|
|
|
updateMarker={updateMarker}
|
|
|
|
|
/>
|
|
|
|
|
)}
|
2023-01-13 18:49:21 +00:00
|
|
|
{React.Children.map(children, (child) => {
|
|
|
|
|
if (React.isValidElement(child)) {
|
|
|
|
|
return React.cloneElement(child as React.ReactElement<any>, {
|
|
|
|
|
map,
|
|
|
|
|
});
|
|
|
|
|
}
|
|
|
|
|
})}
|
|
|
|
|
</Wrapper>
|
|
|
|
|
);
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
Map.PickMyLocation = PickMyLocation;
|
|
|
|
|
Map.SearchBox = SearchBox;
|
|
|
|
|
|
|
|
|
|
export default Map;
|