2023-05-19 18:37:06 +00:00
|
|
|
import React, { useEffect, useMemo, useRef, useState } from "react";
|
2021-10-04 15:34:37 +00:00
|
|
|
import { useSelector } from "react-redux";
|
2019-10-18 08:16:26 +00:00
|
|
|
import WidgetCard from "./WidgetCard";
|
2021-10-18 14:03:44 +00:00
|
|
|
import { getWidgetCards } from "selectors/editorSelectors";
|
2023-05-19 18:37:06 +00:00
|
|
|
import { SearchInput } from "design-system";
|
|
|
|
|
import { ENTITY_EXPLORER_SEARCH_ID } from "constants/Explorer";
|
2020-09-02 06:44:01 +00:00
|
|
|
import { debounce } from "lodash";
|
2022-02-11 18:08:46 +00:00
|
|
|
import {
|
|
|
|
|
createMessage,
|
|
|
|
|
WIDGET_SIDEBAR_CAPTION,
|
|
|
|
|
} from "@appsmith/constants/messages";
|
2022-06-17 03:12:47 +00:00
|
|
|
import Fuse from "fuse.js";
|
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 { WidgetCardProps } from "widgets/BaseWidget";
|
2023-06-21 09:40:33 +00:00
|
|
|
import AnalyticsUtil from "utils/AnalyticsUtil";
|
2020-09-02 06:44:01 +00:00
|
|
|
|
2022-05-20 05:02:13 +00:00
|
|
|
function WidgetSidebar({ isActive }: { isActive: boolean }) {
|
Feature/entity browse (#220)
# New Feature: Entity Explorer
- Entities are actions (apis and queries), datasources, pages, and widgets
- With this new feature, all entities in the application will be available
to view in the new entity explorer sidebar
- All existing application features from the api sidebar, query sidebar, datasource sidebar and pages sidebar
now are avialable on the entity explorer sidebar
- Users are now able to quickly switch to any entity in the application from the entity explorer sidebar.
- Users can also search all entities in the application from the new sidebar. Use cmd + f or ctrl + f to focus on the search input
- Users can rename entities from the new sidebar
- Users can also perform contextual actions on these entities like set a page as home page, copy/move actions, delete entity, etc from the context menu available alongside the entities in the sidebar
- Users can view the properties of the entities in the sidebar, as well as copy bindings to use in the application.
2020-08-10 08:52:45 +00:00
|
|
|
const cards = useSelector(getWidgetCards);
|
2020-09-02 06:44:01 +00:00
|
|
|
const [filteredCards, setFilteredCards] = useState(cards);
|
|
|
|
|
const searchInputRef = useRef<HTMLInputElement | null>(null);
|
2022-06-17 03:12:47 +00:00
|
|
|
|
2023-05-19 18:37:06 +00:00
|
|
|
const fuse = useMemo(() => {
|
|
|
|
|
const options = {
|
2022-08-03 17:47:27 +00:00
|
|
|
keys: [
|
|
|
|
|
{
|
|
|
|
|
name: "displayName",
|
|
|
|
|
weight: 0.9,
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
name: "searchTags",
|
|
|
|
|
weight: 0.1,
|
|
|
|
|
},
|
|
|
|
|
],
|
|
|
|
|
threshold: 0.2,
|
|
|
|
|
distance: 100,
|
2023-05-19 18:37:06 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
return new Fuse(cards, options);
|
2022-06-17 03:12:47 +00:00
|
|
|
}, [cards]);
|
|
|
|
|
|
2023-06-21 09:40:33 +00:00
|
|
|
const sendWidgetSearchAnalytics = debounce((value: string) => {
|
|
|
|
|
if (value !== "") {
|
|
|
|
|
AnalyticsUtil.logEvent("WIDGET_SEARCH", { value });
|
|
|
|
|
}
|
|
|
|
|
}, 1000);
|
|
|
|
|
|
2020-09-03 14:22:08 +00:00
|
|
|
const filterCards = (keyword: string) => {
|
2023-06-21 09:40:33 +00:00
|
|
|
sendWidgetSearchAnalytics(keyword);
|
|
|
|
|
|
2020-09-02 06:44:01 +00:00
|
|
|
if (keyword.trim().length > 0) {
|
2022-06-17 03:12:47 +00:00
|
|
|
const searchResult = fuse.search(keyword);
|
|
|
|
|
setFilteredCards(searchResult as WidgetCardProps[]);
|
|
|
|
|
} else {
|
|
|
|
|
setFilteredCards(cards);
|
2020-09-02 06:44:01 +00:00
|
|
|
}
|
2020-09-03 14:22:08 +00:00
|
|
|
};
|
2021-02-11 06:36:07 +00:00
|
|
|
|
2022-05-30 03:56:51 +00:00
|
|
|
useEffect(() => {
|
|
|
|
|
if (isActive) searchInputRef.current?.focus();
|
|
|
|
|
}, [isActive]);
|
|
|
|
|
|
2023-05-19 18:37:06 +00:00
|
|
|
const search = debounce((value: string) => {
|
|
|
|
|
filterCards(value.toLowerCase());
|
2020-09-02 06:44:01 +00:00
|
|
|
}, 300);
|
|
|
|
|
|
Feature/entity browse (#220)
# New Feature: Entity Explorer
- Entities are actions (apis and queries), datasources, pages, and widgets
- With this new feature, all entities in the application will be available
to view in the new entity explorer sidebar
- All existing application features from the api sidebar, query sidebar, datasource sidebar and pages sidebar
now are avialable on the entity explorer sidebar
- Users are now able to quickly switch to any entity in the application from the entity explorer sidebar.
- Users can also search all entities in the application from the new sidebar. Use cmd + f or ctrl + f to focus on the search input
- Users can rename entities from the new sidebar
- Users can also perform contextual actions on these entities like set a page as home page, copy/move actions, delete entity, etc from the context menu available alongside the entities in the sidebar
- Users can view the properties of the entities in the sidebar, as well as copy bindings to use in the application.
2020-08-10 08:52:45 +00:00
|
|
|
return (
|
2023-02-03 08:47:01 +00:00
|
|
|
<div
|
2023-05-19 18:37:06 +00:00
|
|
|
className={`flex flex-col overflow-hidden ${isActive ? "" : "hidden"}`}
|
2023-02-03 08:47:01 +00:00
|
|
|
>
|
2023-05-19 18:37:06 +00:00
|
|
|
<div className="sticky top-0 px-3 mt-0.5">
|
|
|
|
|
<SearchInput
|
|
|
|
|
autoComplete="off"
|
|
|
|
|
autoFocus
|
|
|
|
|
id={ENTITY_EXPLORER_SEARCH_ID}
|
|
|
|
|
onChange={search}
|
|
|
|
|
placeholder="Search widgets"
|
|
|
|
|
ref={searchInputRef}
|
|
|
|
|
type="text"
|
|
|
|
|
/>
|
|
|
|
|
</div>
|
2022-10-29 06:01:25 +00:00
|
|
|
<div
|
2023-05-19 18:37:06 +00:00
|
|
|
className="flex-grow px-3 mt-3 overflow-y-scroll"
|
|
|
|
|
data-testid="widget-sidebar-scrollable-wrapper"
|
2022-10-29 06:01:25 +00:00
|
|
|
>
|
2023-05-19 18:37:06 +00:00
|
|
|
<p className="px-3 py-3 text-sm leading-relaxed t--widget-sidebar">
|
2021-11-23 08:01:46 +00:00
|
|
|
{createMessage(WIDGET_SIDEBAR_CAPTION)}
|
|
|
|
|
</p>
|
|
|
|
|
<div className="grid items-stretch grid-cols-3 gap-3 justify-items-stretch">
|
2021-09-09 15:10:22 +00:00
|
|
|
{filteredCards.map((card) => (
|
2022-01-25 13:56:52 +00:00
|
|
|
<WidgetCard details={card} key={card.key} />
|
2020-12-23 11:32:30 +00:00
|
|
|
))}
|
2021-11-23 08:01:46 +00:00
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
Feature/entity browse (#220)
# New Feature: Entity Explorer
- Entities are actions (apis and queries), datasources, pages, and widgets
- With this new feature, all entities in the application will be available
to view in the new entity explorer sidebar
- All existing application features from the api sidebar, query sidebar, datasource sidebar and pages sidebar
now are avialable on the entity explorer sidebar
- Users are now able to quickly switch to any entity in the application from the entity explorer sidebar.
- Users can also search all entities in the application from the new sidebar. Use cmd + f or ctrl + f to focus on the search input
- Users can rename entities from the new sidebar
- Users can also perform contextual actions on these entities like set a page as home page, copy/move actions, delete entity, etc from the context menu available alongside the entities in the sidebar
- Users can view the properties of the entities in the sidebar, as well as copy bindings to use in the application.
2020-08-10 08:52:45 +00:00
|
|
|
);
|
2021-04-28 10:28:39 +00:00
|
|
|
}
|
2019-10-18 08:16:26 +00:00
|
|
|
|
Feature/entity browse (#220)
# New Feature: Entity Explorer
- Entities are actions (apis and queries), datasources, pages, and widgets
- With this new feature, all entities in the application will be available
to view in the new entity explorer sidebar
- All existing application features from the api sidebar, query sidebar, datasource sidebar and pages sidebar
now are avialable on the entity explorer sidebar
- Users are now able to quickly switch to any entity in the application from the entity explorer sidebar.
- Users can also search all entities in the application from the new sidebar. Use cmd + f or ctrl + f to focus on the search input
- Users can rename entities from the new sidebar
- Users can also perform contextual actions on these entities like set a page as home page, copy/move actions, delete entity, etc from the context menu available alongside the entities in the sidebar
- Users can view the properties of the entities in the sidebar, as well as copy bindings to use in the application.
2020-08-10 08:52:45 +00:00
|
|
|
WidgetSidebar.displayName = "WidgetSidebar";
|
|
|
|
|
|
|
|
|
|
export default WidgetSidebar;
|