2024-08-06 14:52:22 +00:00
|
|
|
import type { SendTestEmailPayload } from "ee/api/UserApi";
|
|
|
|
|
import UserApi from "ee/api/UserApi";
|
|
|
|
|
import type { ReduxAction } from "ee/constants/ReduxActionConstants";
|
2021-10-18 07:47:55 +00:00
|
|
|
import {
|
|
|
|
|
ReduxActionErrorTypes,
|
|
|
|
|
ReduxActionTypes,
|
2024-08-06 14:52:22 +00:00
|
|
|
} from "ee/constants/ReduxActionConstants";
|
2023-10-11 07:27:52 +00:00
|
|
|
import { APPLICATIONS_URL } 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-09-02 17:15:08 +00:00
|
|
|
import { call, put, delay, select } from "redux-saga/effects";
|
2021-10-18 07:47:55 +00:00
|
|
|
import history from "utils/history";
|
2022-04-12 10:50:01 +00:00
|
|
|
import { validateResponse } from "sagas/ErrorSagas";
|
2024-08-06 14:52:22 +00:00
|
|
|
import { getAppsmithConfigs } from "ee/configs";
|
2021-10-18 07:47:55 +00:00
|
|
|
|
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 { ApiResponse } from "api/ApiResponses";
|
2021-11-09 07:01:36 +00:00
|
|
|
import {
|
2022-08-27 22:22:25 +00:00
|
|
|
APPSMITH_DISPLAY_VERSION,
|
2021-11-09 07:01:36 +00:00
|
|
|
createMessage,
|
|
|
|
|
TEST_EMAIL_FAILURE,
|
|
|
|
|
TEST_EMAIL_SUCCESS,
|
|
|
|
|
TEST_EMAIL_SUCCESS_TROUBLESHOOT,
|
2024-08-06 14:52:22 +00:00
|
|
|
} from "ee/constants/messages";
|
2021-11-09 07:01:36 +00:00
|
|
|
import { getCurrentUser } from "selectors/usersSelectors";
|
|
|
|
|
import { EMAIL_SETUP_DOC } from "constants/ThirdPartyConstants";
|
2024-08-09 14:20:29 +00:00
|
|
|
import { toast } from "@appsmith/ads";
|
2024-08-06 14:52:22 +00:00
|
|
|
import AnalyticsUtil from "ee/utils/AnalyticsUtil";
|
2023-06-15 12:33:25 +00:00
|
|
|
import {
|
2023-10-04 13:09:47 +00:00
|
|
|
MIGRATION_STATUS,
|
2023-06-15 12:33:25 +00:00
|
|
|
RESTART_POLL_INTERVAL,
|
|
|
|
|
RESTART_POLL_TIMEOUT,
|
2024-08-06 14:52:22 +00:00
|
|
|
} from "ee/constants/tenantConstants";
|
|
|
|
|
import type { FetchCurrentTenantConfigResponse } from "ee/api/TenantApi";
|
|
|
|
|
import TenantApi from "ee/api/TenantApi";
|
2021-10-18 07:47:55 +00:00
|
|
|
|
2022-04-12 10:50:01 +00:00
|
|
|
export function* FetchAdminSettingsSaga() {
|
2022-06-21 13:57:34 +00:00
|
|
|
const response: ApiResponse = yield call(UserApi.fetchAdminSettings);
|
|
|
|
|
const isValidResponse: boolean = yield validateResponse(response);
|
2021-10-18 07:47:55 +00:00
|
|
|
|
|
|
|
|
if (isValidResponse) {
|
2023-10-14 20:41:29 +00:00
|
|
|
const { appVersion } = getAppsmithConfigs();
|
2021-10-18 07:47:55 +00:00
|
|
|
const settings = {
|
2022-06-21 13:57:34 +00:00
|
|
|
//@ts-expect-error: response is of type unknown
|
2021-10-18 07:47:55 +00:00
|
|
|
...response.data,
|
2022-08-27 22:22:25 +00:00
|
|
|
APPSMITH_CURRENT_VERSION: createMessage(
|
|
|
|
|
APPSMITH_DISPLAY_VERSION,
|
|
|
|
|
appVersion.edition,
|
|
|
|
|
appVersion.id,
|
|
|
|
|
),
|
2021-10-18 07:47:55 +00:00
|
|
|
};
|
2022-12-13 10:08:37 +00:00
|
|
|
|
|
|
|
|
// Converting empty values to boolean false
|
|
|
|
|
Object.keys(settings).forEach((key) => {
|
|
|
|
|
if ((settings[key] as string).trim() === "") {
|
|
|
|
|
settings[key] = false;
|
|
|
|
|
}
|
|
|
|
|
});
|
|
|
|
|
|
2021-10-18 07:47:55 +00:00
|
|
|
yield put({
|
|
|
|
|
type: ReduxActionTypes.FETCH_ADMIN_SETTINGS_SUCCESS,
|
|
|
|
|
payload: settings,
|
|
|
|
|
});
|
|
|
|
|
} else {
|
|
|
|
|
yield put({
|
|
|
|
|
type: ReduxActionTypes.FETCH_ADMIN_SETTINGS_ERROR,
|
|
|
|
|
payload: response,
|
|
|
|
|
});
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2022-04-12 10:50:01 +00:00
|
|
|
export function* FetchAdminSettingsErrorSaga() {
|
2021-10-18 07:47:55 +00:00
|
|
|
history.push(APPLICATIONS_URL);
|
|
|
|
|
}
|
|
|
|
|
|
2022-04-12 10:50:01 +00:00
|
|
|
export function* SaveAdminSettingsSaga(
|
2022-12-09 14:43:47 +00:00
|
|
|
action: ReduxAction<{
|
2024-07-31 15:41:28 +00:00
|
|
|
// TODO: Fix this the next time the file is edited
|
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
2022-12-09 14:43:47 +00:00
|
|
|
settings: Record<string, any>;
|
|
|
|
|
needsRestart: boolean;
|
|
|
|
|
}>,
|
2022-04-12 10:50:01 +00:00
|
|
|
) {
|
2022-12-09 14:43:47 +00:00
|
|
|
const { needsRestart = true, settings } = action.payload;
|
|
|
|
|
|
2021-12-09 09:10:08 +00:00
|
|
|
try {
|
2023-06-30 06:33:41 +00:00
|
|
|
const hasDisableTelemetrySetting = settings.hasOwnProperty(
|
|
|
|
|
"APPSMITH_DISABLE_TELEMETRY",
|
|
|
|
|
);
|
|
|
|
|
const hasHideWatermarkSetting = settings.hasOwnProperty(
|
|
|
|
|
"APPSMITH_HIDE_WATERMARK",
|
|
|
|
|
);
|
2022-06-21 13:57:34 +00:00
|
|
|
const response: ApiResponse = yield call(
|
|
|
|
|
UserApi.saveAdminSettings,
|
|
|
|
|
settings,
|
|
|
|
|
);
|
|
|
|
|
const isValidResponse: boolean = yield validateResponse(response);
|
2021-10-18 07:47:55 +00:00
|
|
|
|
2021-12-09 09:10:08 +00:00
|
|
|
if (isValidResponse) {
|
2023-05-19 18:37:06 +00:00
|
|
|
toast.show("Successfully saved", {
|
|
|
|
|
kind: "success",
|
2021-12-09 09:10:08 +00:00
|
|
|
});
|
2023-06-05 21:27:40 +00:00
|
|
|
|
|
|
|
|
if (settings["APPSMITH_DISABLE_TELEMETRY"]) {
|
2023-08-09 09:45:01 +00:00
|
|
|
AnalyticsUtil.logEvent("TELEMETRY_DISABLED");
|
2023-06-05 21:27:40 +00:00
|
|
|
}
|
|
|
|
|
|
2023-06-30 06:33:41 +00:00
|
|
|
if (hasDisableTelemetrySetting || hasHideWatermarkSetting) {
|
|
|
|
|
AnalyticsUtil.logEvent("GENERAL_SETTINGS_UPDATE", {
|
|
|
|
|
...(hasDisableTelemetrySetting
|
|
|
|
|
? { telemetry_disabled: settings["APPSMITH_DISABLE_TELEMETRY"] }
|
|
|
|
|
: {}),
|
|
|
|
|
...(hasHideWatermarkSetting
|
|
|
|
|
? { watermark_disabled: settings["APPSMITH_HIDE_WATERMARK"] }
|
|
|
|
|
: {}),
|
|
|
|
|
});
|
|
|
|
|
}
|
|
|
|
|
|
2021-12-09 09:10:08 +00:00
|
|
|
yield put({
|
|
|
|
|
type: ReduxActionTypes.SAVE_ADMIN_SETTINGS_SUCCESS,
|
|
|
|
|
});
|
2022-12-09 14:43:47 +00:00
|
|
|
|
2021-12-09 09:10:08 +00:00
|
|
|
yield put({
|
2022-12-09 14:43:47 +00:00
|
|
|
type: ReduxActionTypes.FETCH_ADMIN_SETTINGS_SUCCESS,
|
|
|
|
|
payload: settings,
|
2021-12-09 09:10:08 +00:00
|
|
|
});
|
2022-12-09 14:43:47 +00:00
|
|
|
|
|
|
|
|
if (needsRestart) {
|
|
|
|
|
yield put({
|
|
|
|
|
type: ReduxActionTypes.RESTART_SERVER_POLL,
|
|
|
|
|
});
|
|
|
|
|
}
|
2021-12-09 09:10:08 +00:00
|
|
|
} else {
|
|
|
|
|
yield put({
|
|
|
|
|
type: ReduxActionTypes.SAVE_ADMIN_SETTINGS_ERROR,
|
|
|
|
|
});
|
|
|
|
|
}
|
|
|
|
|
} catch (e) {
|
2021-10-18 07:47:55 +00:00
|
|
|
yield put({
|
|
|
|
|
type: ReduxActionTypes.SAVE_ADMIN_SETTINGS_ERROR,
|
|
|
|
|
});
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2022-04-12 10:50:01 +00:00
|
|
|
export function* RestartServerPoll() {
|
2021-10-18 07:47:55 +00:00
|
|
|
yield call(UserApi.restartServer);
|
2022-04-11 08:42:06 +00:00
|
|
|
yield call(RestryRestartServerPoll);
|
|
|
|
|
}
|
|
|
|
|
|
2023-10-11 07:27:52 +00:00
|
|
|
export function* RestryRestartServerPoll() {
|
2021-10-18 07:47:55 +00:00
|
|
|
let pollCount = 0;
|
|
|
|
|
const maxPollCount = RESTART_POLL_TIMEOUT / RESTART_POLL_INTERVAL;
|
2024-09-18 16:35:28 +00:00
|
|
|
|
2021-10-18 07:47:55 +00:00
|
|
|
while (pollCount < maxPollCount) {
|
|
|
|
|
pollCount++;
|
|
|
|
|
yield delay(RESTART_POLL_INTERVAL);
|
|
|
|
|
try {
|
2023-10-04 13:09:47 +00:00
|
|
|
const response: FetchCurrentTenantConfigResponse = yield call(
|
|
|
|
|
TenantApi.fetchCurrentTenantConfig,
|
|
|
|
|
);
|
2024-09-18 16:35:28 +00:00
|
|
|
|
2023-10-04 13:09:47 +00:00
|
|
|
if (
|
|
|
|
|
response.responseMeta.status === 200 &&
|
|
|
|
|
response.data?.tenantConfiguration?.migrationStatus ===
|
|
|
|
|
MIGRATION_STATUS.COMPLETED
|
|
|
|
|
) {
|
2023-10-11 07:27:52 +00:00
|
|
|
window.location.reload();
|
2021-10-18 07:47:55 +00:00
|
|
|
}
|
|
|
|
|
} catch (e) {}
|
|
|
|
|
}
|
2024-09-18 16:35:28 +00:00
|
|
|
|
2021-10-18 07:47:55 +00:00
|
|
|
yield put({
|
|
|
|
|
type: ReduxActionErrorTypes.RESTART_SERVER_ERROR,
|
|
|
|
|
});
|
|
|
|
|
}
|
|
|
|
|
|
2022-04-12 10:50:01 +00:00
|
|
|
export function* SendTestEmail(action: ReduxAction<SendTestEmailPayload>) {
|
2021-11-09 07:01:36 +00:00
|
|
|
try {
|
2022-06-21 13:57:34 +00:00
|
|
|
const response: ApiResponse = yield call(
|
|
|
|
|
UserApi.sendTestEmail,
|
|
|
|
|
action.payload,
|
|
|
|
|
);
|
|
|
|
|
const currentUser: User | undefined = yield select(getCurrentUser);
|
|
|
|
|
const isValidResponse: boolean = yield validateResponse(response);
|
2022-03-24 11:20:43 +00:00
|
|
|
|
|
|
|
|
if (isValidResponse) {
|
|
|
|
|
if (response.data) {
|
|
|
|
|
}
|
2024-09-18 16:35:28 +00:00
|
|
|
|
2023-05-19 18:37:06 +00:00
|
|
|
toast.show(
|
|
|
|
|
createMessage(
|
2022-03-24 11:20:43 +00:00
|
|
|
response.data
|
2022-06-21 13:57:34 +00:00
|
|
|
? // @ts-expect-error: currentUser can be undefined
|
|
|
|
|
TEST_EMAIL_SUCCESS(currentUser?.email)
|
2022-03-24 11:20:43 +00:00
|
|
|
: TEST_EMAIL_FAILURE,
|
|
|
|
|
),
|
2023-05-19 18:37:06 +00:00
|
|
|
{
|
|
|
|
|
kind: response.data ? "info" : "error",
|
|
|
|
|
action: {
|
|
|
|
|
text: createMessage(TEST_EMAIL_SUCCESS_TROUBLESHOOT),
|
|
|
|
|
effect: () => window.open(EMAIL_SETUP_DOC, "blank"),
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
);
|
2021-11-09 07:01:36 +00:00
|
|
|
}
|
2022-03-24 11:20:43 +00:00
|
|
|
} catch (e) {}
|
2021-11-09 07:01:36 +00:00
|
|
|
}
|