PromucFlow_constructor/app/client/src/utils/AppUtils.ts

29 lines
968 B
TypeScript
Raw Normal View History

import { getAppsmithConfigs } from "ee/configs";
2022-08-04 05:40:44 +00:00
import FormControlRegistry from "./formControl/FormControlRegistry";
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 { LogLevelDesc } from "loglevel";
2022-08-04 05:40:44 +00:00
import localStorage from "utils/localStorage";
import * as log from "loglevel";
feat: Code Scanner Widget (#15990) * feat: Add QR Scanner Widget Folder * feat: Add QR Code Scanner in the Modal * feat: Add viewfinder and close button * QR generator * feat: Change deafult camera in QR Scanner to back camera * feat: remove qr generator widget from the registry * feat: update qr scanner icon * style: qr code scanner modal and video container, remove futile code * feat: add camera switch control panel to qr scanner * fix: update input devices list when the menu opens in qr scanner * fix: viewfinder in qr scanner responsive on mobile * feat: Add onCodeDetected event to the QR Scanner widget * feat: Add QR Scanner to autocomplete's entity definitions * feat: Add tooltip to QR Scanner * fix: isDisabled for QR Scanner * feat: Add icon and related properties to QR Scanner * feat: Add QR Scanner search tags, remove futile styles * feat: Add QR Scanner to themes, regex for button color * test: Add one cy test for qr scanner * revert: Remove qr scanner from system themes, will be merged in a seperate PR * fix: typo 'disable' to 'disabled' in qr scanner widget * test: add disabled and visibility cy tests for qr scanner * test: add open and close qr scanner modal test * feat: remove qr scanner image for tests * feat: add TODO item for solving performance issues for QR Generator widget * feat: shift from react-qr-reader to react-qr-barcode-scanner to enable barcode and QR scanning both * feat: Update QR Scanner Widget to Code Scanner Widget * test: update tests from qr scanner to code scanner widget * refactor: move code scanner's property pane config to individual files * fix: code scanner error message on permission denied * feat: remove Modal.setAppElement from code scanner * fix: hide code scanner scan animation overflow * feat: code scanner modal close on escape and overlay click * fix: code scanner video border radius on mobile * test: scan qr test for code scanner * feat: Add Modal.setAppElement for code scanner modal accessibility * fix: typo in search tags of code scanner * feat: update property pane content helper texts of code scanner * feat: hide code scanner widget from explorer * fix: code scanner events not working * feat: hide code scanner widget from explorer * feat: Show Code Scanner widget in Explorer * fix: remove code scanner scan cypress test * feat: Add barcode reader to search tags and put Modal.setAppElement inside a block in code scanner Co-authored-by: balajisoundar <balaji@appsmith.com> Co-authored-by: Aishwarya UR <aishwarya@appsmith.com>
2022-09-16 04:55:32 +00:00
import Modal from "react-modal";
2022-08-04 05:40:44 +00:00
export const appInitializer = () => {
FormControlRegistry.registerFormControlBuilders();
const appsmithConfigs = getAppsmithConfigs();
log.setLevel(getEnvLogLevel(appsmithConfigs.logLevel));
feat: Code Scanner Widget (#15990) * feat: Add QR Scanner Widget Folder * feat: Add QR Code Scanner in the Modal * feat: Add viewfinder and close button * QR generator * feat: Change deafult camera in QR Scanner to back camera * feat: remove qr generator widget from the registry * feat: update qr scanner icon * style: qr code scanner modal and video container, remove futile code * feat: add camera switch control panel to qr scanner * fix: update input devices list when the menu opens in qr scanner * fix: viewfinder in qr scanner responsive on mobile * feat: Add onCodeDetected event to the QR Scanner widget * feat: Add QR Scanner to autocomplete's entity definitions * feat: Add tooltip to QR Scanner * fix: isDisabled for QR Scanner * feat: Add icon and related properties to QR Scanner * feat: Add QR Scanner search tags, remove futile styles * feat: Add QR Scanner to themes, regex for button color * test: Add one cy test for qr scanner * revert: Remove qr scanner from system themes, will be merged in a seperate PR * fix: typo 'disable' to 'disabled' in qr scanner widget * test: add disabled and visibility cy tests for qr scanner * test: add open and close qr scanner modal test * feat: remove qr scanner image for tests * feat: add TODO item for solving performance issues for QR Generator widget * feat: shift from react-qr-reader to react-qr-barcode-scanner to enable barcode and QR scanning both * feat: Update QR Scanner Widget to Code Scanner Widget * test: update tests from qr scanner to code scanner widget * refactor: move code scanner's property pane config to individual files * fix: code scanner error message on permission denied * feat: remove Modal.setAppElement from code scanner * fix: hide code scanner scan animation overflow * feat: code scanner modal close on escape and overlay click * fix: code scanner video border radius on mobile * test: scan qr test for code scanner * feat: Add Modal.setAppElement for code scanner modal accessibility * fix: typo in search tags of code scanner * feat: update property pane content helper texts of code scanner * feat: hide code scanner widget from explorer * fix: code scanner events not working * feat: hide code scanner widget from explorer * feat: Show Code Scanner widget in Explorer * fix: remove code scanner scan cypress test * feat: Add barcode reader to search tags and put Modal.setAppElement inside a block in code scanner Co-authored-by: balajisoundar <balaji@appsmith.com> Co-authored-by: Aishwarya UR <aishwarya@appsmith.com>
2022-09-16 04:55:32 +00:00
// For accessibility (https://reactcommunity.org/react-modal/accessibility/)
if (process.env.NODE_ENV !== "test") {
Modal.setAppElement("#root");
}
2022-08-04 05:40:44 +00:00
};
const getEnvLogLevel = (configLevel: LogLevelDesc): LogLevelDesc => {
let logLevel = configLevel;
if (localStorage && localStorage.getItem) {
const localStorageLevel = localStorage.getItem(
"logLevelOverride",
) as LogLevelDesc;
if (localStorageLevel) logLevel = localStorageLevel;
}
return logLevel;
};