PromucFlow_constructor/app/client/src/pages/Applications/ApplicationLoaders.tsx

231 lines
5.6 KiB
TypeScript
Raw Normal View History

import { Classes } from "@blueprintjs/core";
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 { Theme } from "constants/DefaultTheme";
import React from "react";
import styled, { createGlobalStyle } from "styled-components";
export const LoadingAnimation = createGlobalStyle<{ theme: Theme }>`
&&&& .${Classes.SKELETON} {
2020-12-24 04:32:25 +00:00
background: ${(props) => props.theme.colors.loader.light};;
border-color: ${(props) => props.theme.colors.loader.light};;
animation: 1000ms linear infinite alternate loaderAnimation;
@keyframes loaderAnimation {
from {
2020-12-24 04:32:25 +00:00
background: ${(props) => props.theme.colors.loader.light};
border-color: ${(props) => props.theme.colors.loader.light};;
}
to {
2020-12-24 04:32:25 +00:00
background: ${(props) => props.theme.colors.loader.dark};
border-color: ${(props) => props.theme.colors.loader.dark};
}
}
}
`;
export const loadingUserWorkspaces = [
{
workspace: {
id: "loadingWorkspaceId1",
userPermissions: ["read:workspaces", "read:workspaceApplications"],
name: "loadingWorkspaceName1",
workspaceSettings: [],
plugins: [
{
userPermissions: [],
pluginId: "5c9f512f96c1a50004819786",
status: "FREE",
new: true,
},
{
userPermissions: [],
pluginId: "5ca385dc81b37f0004b4db85",
status: "FREE",
new: true,
},
{
userPermissions: [],
pluginId: "5e687c18fb01e64e6a3f873f",
status: "FREE",
new: true,
},
{
userPermissions: [],
pluginId: "5e75ce2b8f4b473507a4a52e",
status: "FREE",
new: true,
},
{
userPermissions: [],
pluginId: "5f16c4be93f44d4622f487e2",
status: "FREE",
new: true,
},
],
slug: "d60b8e5f",
logoUrl: "/api/v1/assets/null",
new: false,
},
applications: [
{
id: "loadingAppId1",
userPermissions: ["read:applications"],
name: "loadingAppName1",
workspaceId: "loadingWorkspaceId1",
isPublic: false,
pages: [
{
id: "5f7c3bc3b295692137139bd7",
isDefault: true,
default: true,
},
],
appIsExample: false,
new: false,
defaultPageId: "5f7c3bc3b295692137139bd7",
},
{
id: "loadingAppId2",
userPermissions: ["read:applications"],
name: "loadingAppName2",
workspaceId: "loadingWorkspaceId1",
isPublic: false,
pages: [
{
id: "5f7daa65349e65508a53e3c1",
isDefault: true,
default: true,
},
],
appIsExample: false,
color: "#5CE7EF",
new: false,
defaultPageId: "5f7daa65349e65508a53e3c1",
},
],
},
{
workspace: {
id: "loadingWorkspaceId2",
chore: Adding programmatic access control and user session limit as business feature ramps on CE (#27039) ## Description Adding programmatic access control and user session limit as business feature ramps on CE #### PR fixes following issue(s) Fixes [#27040](https://github.com/appsmithorg/appsmith/issues/27040) #### Type of change - Chore (housekeeping or task changes that don't impact user perception) ## Testing #### How Has This Been Tested? - [x] Manual - [ ] JUnit - [ ] Jest - [ ] Cypress ## Checklist: #### Dev activity - [x] My code follows the style guidelines of this project - [x] I have performed a self-review of my own code - [x] 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 - [x] New and existing unit tests pass locally with my changes - [ ] PR is being merged under a feature flag #### QA activity: - [ ] [Speedbreak features](https://github.com/appsmithorg/TestSmith/wiki/Guidelines-for-test-plans#speedbreakers-) have been covered - [ ] Test plan covers all impacted features and [areas of interest](https://github.com/appsmithorg/TestSmith/wiki/Guidelines-for-test-plans#areas-of-interest-) - [ ] Test plan has been peer reviewed by project stakeholders and other QA members - [ ] Manually tested functionality on DP - [ ] We had an implementation alignment call with stakeholders post QA Round 2 - [ ] Cypress test cases have been added and approved by SDET/manual QA - [ ] Added `Test Plan Approved` label after Cypress tests were reviewed - [ ] Added `Test Plan Approved` label after JUnit tests were reviewed
2023-09-07 05:30:12 +00:00
userPermissions: ["read:workspaces", "read:workspaceApplications"],
name: "loadingWorkspaceName2",
workspaceSettings: [],
plugins: [
{
userPermissions: [],
pluginId: "5c9f512f96c1a50004819786",
status: "FREE",
new: true,
},
{
userPermissions: [],
pluginId: "5ca385dc81b37f0004b4db85",
status: "FREE",
new: true,
},
{
userPermissions: [],
pluginId: "5e687c18fb01e64e6a3f873f",
status: "FREE",
new: true,
},
{
userPermissions: [],
pluginId: "5e75ce2b8f4b473507a4a52e",
status: "FREE",
new: true,
},
{
userPermissions: [],
pluginId: "5f16c4be93f44d4622f487e2",
status: "FREE",
new: true,
},
],
slug: "aaf8723f",
logoUrl: "/api/v1/assets/null",
new: false,
},
applications: [
{
id: "loadingAppId3",
userPermissions: ["read:applications"],
name: "loadingAppName3",
workspaceId: "loadingWorkspaceId2",
isPublic: false,
pages: [
{
id: "5f7da6d6e71ebc07bb2699f5",
isDefault: true,
default: true,
},
],
appIsExample: false,
new: false,
defaultPageId: "5f7da6d6e71ebc07bb2699f5",
},
{
id: "loadingAppId4",
userPermissions: ["read:applications"],
name: "loadingAppName4",
workspaceId: "loadingWorkspaceId2",
isPublic: false,
pages: [
{
id: "5f7da88ee71ebc07bb269a03",
isDefault: true,
default: true,
},
],
appIsExample: false,
new: false,
defaultPageId: "5f7da88ee71ebc07bb269a03",
},
{
id: "loadingAppId5",
userPermissions: ["read:applications"],
name: "loadingAppName5",
workspaceId: "loadingWorkspaceId2",
isPublic: false,
pages: [
{
id: "5f7da915349e65508a53e3b6",
isDefault: true,
default: true,
},
],
appIsExample: false,
new: false,
defaultPageId: "5f7da915349e65508a53e3b6",
},
],
},
];
const AppName = styled.div`
margin-top: 10px;
width: 150px;
height: 16px;
`;
const Container = styled.div`
margin: 32px;
`;
const ContentLoader = styled.div`
width: 150px;
height: 150px;
`;
export function AppLoader() {
return (
<>
<LoadingAnimation />
<Container className="app-box">
<ContentLoader className={Classes.SKELETON} />
<AppName className={Classes.SKELETON} />
</Container>
</>
);
}