2023-06-14 14:09:38 +00:00
|
|
|
import { tenantConfigConnection } from "@appsmith/constants/tenantConstants";
|
2023-08-28 15:37:32 +00:00
|
|
|
import type {
|
|
|
|
|
AdminConfigType,
|
|
|
|
|
Category,
|
|
|
|
|
} from "@appsmith/pages/AdminSettings/config/types";
|
2022-12-01 06:30:50 +00:00
|
|
|
import { ADMIN_SETTINGS_CATEGORY_DEFAULT_PATH } from "constants/routes";
|
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 { User } from "constants/userConstants";
|
2022-03-02 18:18:50 +00:00
|
|
|
|
2022-03-04 06:26:12 +00:00
|
|
|
/* settings is the updated & unsaved settings on Admin settings page */
|
2023-05-16 09:04:48 +00:00
|
|
|
export const saveAllowed = (
|
|
|
|
|
settings: any,
|
|
|
|
|
isFormLoginEnabled: boolean,
|
|
|
|
|
socialLoginList: string[],
|
|
|
|
|
) => {
|
2023-04-30 06:22:42 +00:00
|
|
|
const connectedMethodsCount =
|
2023-05-16 09:04:48 +00:00
|
|
|
socialLoginList.length + (isFormLoginEnabled ? 1 : 0);
|
2023-04-30 06:22:42 +00:00
|
|
|
if (connectedMethodsCount === 1) {
|
2023-05-16 09:04:48 +00:00
|
|
|
const checkFormLogin =
|
|
|
|
|
!("APPSMITH_FORM_LOGIN_DISABLED" in settings) && isFormLoginEnabled,
|
2022-03-04 06:26:12 +00:00
|
|
|
checkGoogleAuth =
|
|
|
|
|
settings["APPSMITH_OAUTH2_GOOGLE_CLIENT_ID"] !== "" &&
|
2023-04-30 06:22:42 +00:00
|
|
|
socialLoginList.includes("google"),
|
2022-03-04 06:26:12 +00:00
|
|
|
checkGithubAuth =
|
|
|
|
|
settings["APPSMITH_OAUTH2_GITHUB_CLIENT_ID"] !== "" &&
|
2023-04-30 06:22:42 +00:00
|
|
|
socialLoginList.includes("github");
|
2022-03-04 06:26:12 +00:00
|
|
|
|
|
|
|
|
return checkFormLogin || checkGoogleAuth || checkGithubAuth;
|
2022-03-02 18:18:50 +00:00
|
|
|
} else {
|
2023-04-30 06:22:42 +00:00
|
|
|
return connectedMethodsCount >= 2;
|
2022-03-02 18:18:50 +00:00
|
|
|
}
|
|
|
|
|
};
|
2022-12-01 06:30:50 +00:00
|
|
|
|
|
|
|
|
/* get default admin settings path */
|
|
|
|
|
export const getDefaultAdminSettingsPath = (
|
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
2023-09-29 20:42:56 +00:00
|
|
|
{ isSuperUser, tenantPermissions: any = [] }: Record<string, any>,
|
2022-12-01 06:30:50 +00:00
|
|
|
): string => {
|
|
|
|
|
return ADMIN_SETTINGS_CATEGORY_DEFAULT_PATH;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
export const showAdminSettings = (user?: User): boolean => {
|
|
|
|
|
return (user?.isSuperUser && user?.isConfigurable) || false;
|
|
|
|
|
};
|
2023-02-14 01:34:53 +00:00
|
|
|
|
|
|
|
|
export const getLoginUrl = (method: string): string => {
|
|
|
|
|
const urls: Record<string, string> = {};
|
|
|
|
|
|
|
|
|
|
return urls[method];
|
|
|
|
|
};
|
2023-06-02 11:06:41 +00:00
|
|
|
|
|
|
|
|
export const isTenantConfig = (name: string): boolean => {
|
2023-06-14 14:09:38 +00:00
|
|
|
const fields: string[] = tenantConfigConnection;
|
2023-06-02 11:06:41 +00:00
|
|
|
|
|
|
|
|
return fields.includes(name);
|
|
|
|
|
};
|
2023-08-28 15:37:32 +00:00
|
|
|
|
|
|
|
|
export const getWrapperCategory = (
|
|
|
|
|
categories: Record<string, AdminConfigType>,
|
|
|
|
|
subCategory: string,
|
|
|
|
|
category: string,
|
|
|
|
|
) => {
|
|
|
|
|
return categories[subCategory || category];
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
export const getFilteredGeneralCategories = (categories: Category[]) => {
|
|
|
|
|
return categories
|
|
|
|
|
?.map((category: Category) => {
|
|
|
|
|
return category;
|
|
|
|
|
})
|
|
|
|
|
.filter(Boolean);
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
export const getFilteredAclCategories = (
|
|
|
|
|
categories: Category[],
|
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
|
|
|
isSuperUser?: boolean,
|
|
|
|
|
) => {
|
|
|
|
|
return categories
|
|
|
|
|
?.map((category: Category) => {
|
|
|
|
|
return category;
|
|
|
|
|
})
|
|
|
|
|
.filter(Boolean);
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
export const getFilteredOtherCategories = (
|
|
|
|
|
categories: Category[],
|
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
|
|
|
isSuperUser?: boolean,
|
|
|
|
|
) => {
|
|
|
|
|
return categories
|
|
|
|
|
?.map((category: Category) => {
|
|
|
|
|
return category;
|
|
|
|
|
})
|
|
|
|
|
.filter(Boolean);
|
|
|
|
|
};
|