PromucFlow_constructor/app/client/src/components/editorComponents/RequestView.tsx

203 lines
5.2 KiB
TypeScript
Raw Normal View History

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 { ITreeNode } from "@blueprintjs/core";
import { Classes, Tree } from "@blueprintjs/core";
2020-06-23 03:58:42 +00:00
import React, { useState } from "react";
import styled from "styled-components";
import ReadOnlyEditor from "components/editorComponents/ReadOnlyEditor";
2020-06-23 03:58:42 +00:00
const StyledKey = styled.span`
2020-12-24 04:32:25 +00:00
font-family: ${(props) => props.theme.fonts.text};
2020-06-23 03:58:42 +00:00
font-style: normal;
font-weight: 500;
font-size: 14px;
line-height: 16px;
color: ${(props) => props.theme.colors.apiPane.requestTree.row.key};
2020-06-23 03:58:42 +00:00
user-select: none;
`;
const StyledValue = styled.span`
font-family: monospace;
font-style: normal;
font-weight: normal;
font-size: 14px;
line-height: 16px;
color: ${(props) => props.theme.colors.apiPane.requestTree.row.value};
2020-06-23 03:58:42 +00:00
user-select: text;
`;
function KeyValuePair(props: { hKey: string; hValue: string }) {
2020-06-23 03:58:42 +00:00
return (
<StyledValue>
<StyledKey>{props.hKey}</StyledKey>
{props.hValue}
</StyledValue>
);
}
2020-06-23 03:58:42 +00:00
const StyledTreeContainer = styled.div`
2020-12-24 04:32:25 +00:00
font-family: ${(props) => props.theme.fonts.text};
.bp3-tree {
background-color: ${(props) => props.theme.colors.apiPane.requestTree.bg};
}
2020-06-23 03:58:42 +00:00
.bp3-tree-node-content {
height: auto;
}
.bp3-tree-node-label {
overflow: auto;
word-break: break-all;
white-space: break-spaces;
padding: 4px 0px;
}
.bp3-tree-node-content-0 {
background: ${(props) => props.theme.colors.apiPane.requestTree.header.bg};
color: ${(props) => props.theme.colors.apiPane.requestTree.header.text};
2020-06-23 03:58:42 +00:00
font-style: normal;
font-weight: 500;
font-size: 12px;
line-height: 14px;
2020-06-23 03:58:42 +00:00
cursor: pointer;
text-transform: uppercase;
2020-06-23 03:58:42 +00:00
}
.bp3-tree-node.bp3-tree-node-selected > .bp3-tree-node-content,
.bp3-tree-node.bp3-tree-node-selected > .bp3-icon {
background-color: #f0f0f0;
color: black;
}
.bp3-tree-node-caret-none {
display: none;
}
.bp3-tree-node-content-1 {
padding-left: 24px;
}
.bp3-tree-node-list {
padding-bottom: 0px;
2020-06-23 03:58:42 +00:00
.bp3-tree-root {
padding-top: 0px;
padding-bottom: 0px;
}
}
.bp3-tree-node-caret {
color: black;
}
.request-body {
.bp3-tree-node-content-1,
.bp3-tree-node-label,
.bp3-tree-node-list {
padding-left: 0;
}
}
.bp3-tree-node-caret {
color: ${(props) => props.theme.colors.apiPane.requestTree.header.icon};
}
.bp3-tree-node-content:hover {
background-color: ${(props) =>
props.theme.colors.apiPane.requestTree.row.hoverBg};
cursor: pointer;
}
2020-06-23 03:58:42 +00:00
`;
export function RequestView(props: {
requestURL: string;
requestMethod: string;
requestHeaders: Record<string, string[]>;
requestBody: string;
}) {
const [generalExpanded, setGeneralExpanded] = useState(true);
const [requestHeadersExpanded, setRequestHeadersExpanded] = useState(true);
const [requestBodyExpanded, setRequestBodyExpanded] = useState(true);
const headers = Object.keys(props.requestHeaders).map(
(hKey: string, index: number) => {
return {
id: index,
label: (
<KeyValuePair
hKey={`${hKey}: `}
hValue={props.requestHeaders[hKey].join(", ")}
/>
),
};
},
);
function setExpanded(id: number | string, expanded: boolean) {
id === 1 && setGeneralExpanded(expanded);
id === 2 && setRequestHeadersExpanded(expanded);
id === 3 && setRequestBodyExpanded(expanded);
}
function handleNodeClick(nodeData: ITreeNode) {
setExpanded(nodeData.id, !nodeData.isExpanded);
}
function handleNodeExpand(nodeData: ITreeNode) {
setExpanded(nodeData.id, true);
}
function handleNodeCollapse(nodeData: ITreeNode) {
setExpanded(nodeData.id, false);
}
return (
<StyledTreeContainer>
<Tree
className={Classes.ELEVATION_0}
2020-06-23 03:58:42 +00:00
contents={[
{
id: 1,
isExpanded: generalExpanded,
label: "General",
childNodes: [
{
id: 2,
label: (
<KeyValuePair
hKey="Request URL: "
hValue={props.requestURL}
/>
),
},
{
id: 3,
label: (
<KeyValuePair
hKey="Request Method: "
hValue={props.requestMethod}
/>
),
},
],
},
{
id: 2,
isExpanded: requestHeadersExpanded,
label: "Request Headers",
childNodes: headers,
},
{
id: 3,
isExpanded: requestBodyExpanded,
label: "Request Body",
className: "request-body",
childNodes: [
{
id: 1,
label: (
<ReadOnlyEditor
folding
height={"100%"}
2020-06-23 03:58:42 +00:00
input={{
value: props.requestBody,
}}
/>
),
},
],
},
]}
onNodeClick={handleNodeClick}
onNodeCollapse={handleNodeCollapse}
onNodeExpand={handleNodeExpand}
/>
</StyledTreeContainer>
);
}