2022-07-11 04:06:29 +00:00
|
|
|
import {
|
|
|
|
|
fetchAppThemesAction,
|
|
|
|
|
fetchSelectedAppThemeAction,
|
|
|
|
|
} from "actions/appThemingActions";
|
|
|
|
|
import { fetchJSCollectionsForView } from "actions/jsActionActions";
|
|
|
|
|
import {
|
|
|
|
|
fetchAllPageEntityCompletion,
|
|
|
|
|
fetchPublishedPage,
|
|
|
|
|
fetchPublishedPageSuccess,
|
|
|
|
|
} from "actions/pageActions";
|
|
|
|
|
import {
|
|
|
|
|
executePageLoadActions,
|
|
|
|
|
fetchActionsForView,
|
|
|
|
|
} from "actions/pluginActionActions";
|
|
|
|
|
import {
|
|
|
|
|
ReduxActionErrorTypes,
|
|
|
|
|
ReduxActionTypes,
|
2022-09-02 17:15:08 +00:00
|
|
|
} from "@appsmith/constants/ReduxActionConstants";
|
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 { APP_MODE } from "entities/App";
|
2023-07-24 13:15:29 +00:00
|
|
|
import { call, put, spawn } from "redux-saga/effects";
|
|
|
|
|
import {
|
|
|
|
|
failFastApiCalls,
|
|
|
|
|
reportSWStatus,
|
|
|
|
|
waitForWidgetConfigBuild,
|
|
|
|
|
} from "sagas/InitSagas";
|
2022-07-11 04:06:29 +00:00
|
|
|
import PerformanceTracker, {
|
|
|
|
|
PerformanceTransactionName,
|
|
|
|
|
} from "utils/PerformanceTracker";
|
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 { AppEnginePayload } from ".";
|
|
|
|
|
import AppEngine, { ActionsNotFoundError } from ".";
|
2022-12-21 17:14:47 +00:00
|
|
|
import { fetchJSLibraries } from "actions/JSLibraryActions";
|
2023-02-06 07:06:08 +00:00
|
|
|
import {
|
|
|
|
|
waitForSegmentInit,
|
|
|
|
|
waitForFetchUserSuccess,
|
2023-04-26 07:18:16 +00:00
|
|
|
} from "@appsmith/sagas/userSagas";
|
2023-09-11 07:09:41 +00:00
|
|
|
import { waitForFetchEnvironments } from "@appsmith/sagas/EnvironmentSagas";
|
2022-07-11 04:06:29 +00:00
|
|
|
|
|
|
|
|
export default class AppViewerEngine extends AppEngine {
|
|
|
|
|
constructor(mode: APP_MODE) {
|
|
|
|
|
super(mode);
|
|
|
|
|
this.setupEngine = this.setupEngine.bind(this);
|
|
|
|
|
this.loadAppData = this.loadAppData.bind(this);
|
|
|
|
|
this.loadAppURL = this.loadAppURL.bind(this);
|
|
|
|
|
this.loadAppEntities = this.loadAppEntities.bind(this);
|
|
|
|
|
this.loadGit = this.loadGit.bind(this);
|
|
|
|
|
this.completeChore = this.completeChore.bind(this);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
*loadGit() {
|
|
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
*completeChore() {
|
2023-07-10 05:51:40 +00:00
|
|
|
yield call(waitForWidgetConfigBuild);
|
2022-07-11 04:06:29 +00:00
|
|
|
yield put({
|
|
|
|
|
type: ReduxActionTypes.INITIALIZE_PAGE_VIEWER_SUCCESS,
|
|
|
|
|
});
|
|
|
|
|
if ("serviceWorker" in navigator) {
|
|
|
|
|
yield put({
|
|
|
|
|
type: ReduxActionTypes.FETCH_ALL_PUBLISHED_PAGES,
|
|
|
|
|
});
|
|
|
|
|
}
|
2023-07-24 13:15:29 +00:00
|
|
|
yield spawn(reportSWStatus);
|
2022-07-11 04:06:29 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
*setupEngine(payload: AppEnginePayload) {
|
|
|
|
|
yield call(super.setupEngine.bind(this), payload);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
startPerformanceTracking() {
|
|
|
|
|
PerformanceTracker.startAsyncTracking(
|
|
|
|
|
PerformanceTransactionName.INIT_VIEW_APP,
|
|
|
|
|
);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
stopPerformanceTracking() {
|
|
|
|
|
PerformanceTracker.stopAsyncTracking(
|
|
|
|
|
PerformanceTransactionName.INIT_VIEW_APP,
|
|
|
|
|
);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
*loadAppEntities(toLoadPageId: string, applicationId: string): any {
|
2022-12-21 17:14:47 +00:00
|
|
|
const initActionsCalls: any = [
|
|
|
|
|
fetchActionsForView({ applicationId }),
|
|
|
|
|
fetchJSCollectionsForView({ applicationId }),
|
|
|
|
|
fetchSelectedAppThemeAction(applicationId),
|
|
|
|
|
fetchAppThemesAction(applicationId),
|
|
|
|
|
fetchPublishedPage(toLoadPageId, true, true),
|
|
|
|
|
];
|
|
|
|
|
|
|
|
|
|
const successActionEffects = [
|
|
|
|
|
ReduxActionTypes.FETCH_ACTIONS_VIEW_MODE_SUCCESS,
|
|
|
|
|
ReduxActionTypes.FETCH_JS_ACTIONS_VIEW_MODE_SUCCESS,
|
|
|
|
|
ReduxActionTypes.FETCH_APP_THEMES_SUCCESS,
|
|
|
|
|
ReduxActionTypes.FETCH_SELECTED_APP_THEME_SUCCESS,
|
|
|
|
|
fetchPublishedPageSuccess().type,
|
|
|
|
|
];
|
|
|
|
|
const failureActionEffects = [
|
|
|
|
|
ReduxActionErrorTypes.FETCH_ACTIONS_VIEW_MODE_ERROR,
|
|
|
|
|
ReduxActionErrorTypes.FETCH_JS_ACTIONS_VIEW_MODE_ERROR,
|
|
|
|
|
ReduxActionErrorTypes.FETCH_APP_THEMES_ERROR,
|
|
|
|
|
ReduxActionErrorTypes.FETCH_SELECTED_APP_THEME_ERROR,
|
|
|
|
|
ReduxActionErrorTypes.FETCH_PUBLISHED_PAGE_ERROR,
|
|
|
|
|
];
|
|
|
|
|
|
2023-02-01 05:07:39 +00:00
|
|
|
initActionsCalls.push(fetchJSLibraries(applicationId));
|
|
|
|
|
successActionEffects.push(ReduxActionTypes.FETCH_JS_LIBRARIES_SUCCESS);
|
|
|
|
|
failureActionEffects.push(ReduxActionErrorTypes.FETCH_JS_LIBRARIES_FAILED);
|
2022-12-21 17:14:47 +00:00
|
|
|
|
2022-07-11 04:06:29 +00:00
|
|
|
const resultOfPrimaryCalls: boolean = yield failFastApiCalls(
|
2022-12-21 17:14:47 +00:00
|
|
|
initActionsCalls,
|
|
|
|
|
successActionEffects,
|
|
|
|
|
failureActionEffects,
|
2022-07-11 04:06:29 +00:00
|
|
|
);
|
|
|
|
|
|
2022-07-27 10:55:41 +00:00
|
|
|
if (!resultOfPrimaryCalls)
|
|
|
|
|
throw new ActionsNotFoundError(
|
|
|
|
|
`Unable to fetch actions for the application: ${applicationId}`,
|
|
|
|
|
);
|
2022-07-11 04:06:29 +00:00
|
|
|
|
2023-02-06 07:06:08 +00:00
|
|
|
yield call(waitForFetchUserSuccess);
|
2023-01-06 14:09:38 +00:00
|
|
|
yield call(waitForSegmentInit, true);
|
2023-09-11 07:09:41 +00:00
|
|
|
yield call(waitForFetchEnvironments);
|
2022-07-11 04:06:29 +00:00
|
|
|
yield put(fetchAllPageEntityCompletion([executePageLoadActions()]));
|
|
|
|
|
}
|
|
|
|
|
}
|