2023-03-30 05:33:29 +00:00
|
|
|
import type { ReactElement } from "react";
|
|
|
|
|
import React from "react";
|
|
|
|
|
import type { RenderOptions } from "@testing-library/react";
|
|
|
|
|
import { render, queries } from "@testing-library/react";
|
2021-06-17 13:26:54 +00:00
|
|
|
import { Provider } from "react-redux";
|
2023-01-13 11:05:59 +00:00
|
|
|
import { ThemeProvider } from "styled-components";
|
2022-04-12 10:50:01 +00:00
|
|
|
import { getCurrentThemeDetails } from "selectors/themeSelectors";
|
2021-04-02 09:47:16 +00:00
|
|
|
import * as customQueries from "./customQueries";
|
2021-04-22 03:30:09 +00:00
|
|
|
import { BrowserRouter } from "react-router-dom";
|
2023-03-30 05:33:29 +00:00
|
|
|
import type { AppState } from "@appsmith/reducers";
|
|
|
|
|
import appReducer from "@appsmith/reducers";
|
2021-05-18 18:29:39 +00:00
|
|
|
import { applyMiddleware, compose, createStore } from "redux";
|
|
|
|
|
import { reduxBatch } from "@manaflair/redux-batch";
|
|
|
|
|
import createSagaMiddleware from "redux-saga";
|
|
|
|
|
import store, { testStore } from "store";
|
|
|
|
|
import { sagasToRunForTests } from "./sagas";
|
|
|
|
|
import { all, call, spawn } from "redux-saga/effects";
|
2024-03-19 09:01:08 +00:00
|
|
|
import type { FeatureFlags } from "@appsmith/entities/FeatureFlag";
|
|
|
|
|
import { fetchFeatureFlagsSuccess } from "../src/actions/userActions";
|
|
|
|
|
import { DEFAULT_FEATURE_FLAG_VALUE } from "@appsmith/entities/FeatureFlag";
|
2023-02-21 13:38:16 +00:00
|
|
|
|
2021-05-18 18:29:39 +00:00
|
|
|
const testSagaMiddleware = createSagaMiddleware();
|
|
|
|
|
|
|
|
|
|
const testStoreWithTestMiddleWare = (initialState: Partial<AppState>) =>
|
|
|
|
|
createStore(
|
|
|
|
|
appReducer,
|
|
|
|
|
initialState,
|
|
|
|
|
compose(reduxBatch, applyMiddleware(testSagaMiddleware), reduxBatch),
|
|
|
|
|
);
|
|
|
|
|
|
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
|
|
|
const rootSaga = function* (sagasToRun = sagasToRunForTests) {
|
2021-05-18 18:29:39 +00:00
|
|
|
yield all(
|
|
|
|
|
sagasToRun.map((saga) =>
|
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
|
|
|
spawn(function* () {
|
2021-05-18 18:29:39 +00:00
|
|
|
while (true) {
|
|
|
|
|
yield call(saga);
|
|
|
|
|
break;
|
|
|
|
|
}
|
|
|
|
|
}),
|
|
|
|
|
),
|
|
|
|
|
);
|
|
|
|
|
};
|
2021-04-02 09:47:16 +00:00
|
|
|
|
2024-03-27 12:00:31 +00:00
|
|
|
interface State {
|
|
|
|
|
url?: string;
|
|
|
|
|
initialState?: Partial<AppState>;
|
|
|
|
|
sagasToRun?: typeof sagasToRunForTests;
|
|
|
|
|
featureFlags?: Partial<FeatureFlags>;
|
|
|
|
|
}
|
|
|
|
|
const setupState = (state?: State) => {
|
2021-04-22 03:30:09 +00:00
|
|
|
let reduxStore = store;
|
|
|
|
|
window.history.pushState({}, "Appsmith", state?.url || "/");
|
2024-03-19 09:01:08 +00:00
|
|
|
if (state && (state.initialState || state.featureFlags)) {
|
2021-04-22 03:30:09 +00:00
|
|
|
reduxStore = testStore(state.initialState || {});
|
2024-03-19 09:01:08 +00:00
|
|
|
if (state.featureFlags) {
|
|
|
|
|
reduxStore.dispatch(
|
|
|
|
|
fetchFeatureFlagsSuccess({
|
|
|
|
|
...DEFAULT_FEATURE_FLAG_VALUE,
|
|
|
|
|
...state.featureFlags,
|
|
|
|
|
}),
|
|
|
|
|
);
|
|
|
|
|
}
|
2021-04-22 03:30:09 +00:00
|
|
|
}
|
2021-05-18 18:29:39 +00:00
|
|
|
if (state && state.sagasToRun) {
|
|
|
|
|
reduxStore = testStoreWithTestMiddleWare(reduxStore.getState());
|
|
|
|
|
testSagaMiddleware.run(() => rootSaga(state.sagasToRun));
|
|
|
|
|
}
|
2021-04-22 03:30:09 +00:00
|
|
|
const defaultTheme = getCurrentThemeDetails(reduxStore.getState());
|
2024-03-27 12:00:31 +00:00
|
|
|
|
|
|
|
|
return { reduxStore, defaultTheme };
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
const customRender = (
|
|
|
|
|
ui: ReactElement,
|
|
|
|
|
state?: State,
|
|
|
|
|
options?: Omit<RenderOptions, "queries">,
|
|
|
|
|
) => {
|
|
|
|
|
const { defaultTheme, reduxStore } = setupState(state);
|
2021-04-22 03:30:09 +00:00
|
|
|
return render(
|
|
|
|
|
<BrowserRouter>
|
|
|
|
|
<Provider store={reduxStore}>
|
2023-03-15 16:40:06 +00:00
|
|
|
<ThemeProvider theme={defaultTheme}>{ui}</ThemeProvider>
|
2021-04-22 03:30:09 +00:00
|
|
|
</Provider>
|
|
|
|
|
</BrowserRouter>,
|
|
|
|
|
{
|
|
|
|
|
queries: { ...queries, ...customQueries },
|
|
|
|
|
...options,
|
|
|
|
|
},
|
|
|
|
|
);
|
|
|
|
|
};
|
2021-04-02 09:47:16 +00:00
|
|
|
|
2024-03-27 12:00:31 +00:00
|
|
|
const hookWrapper = (state: State) => {
|
|
|
|
|
return ({ children }: { children: ReactElement }) => {
|
|
|
|
|
const { defaultTheme, reduxStore } = setupState(state);
|
|
|
|
|
return (
|
|
|
|
|
<BrowserRouter>
|
|
|
|
|
<Provider store={reduxStore}>
|
|
|
|
|
<ThemeProvider theme={defaultTheme}>{children}</ThemeProvider>
|
|
|
|
|
</Provider>
|
|
|
|
|
</BrowserRouter>
|
|
|
|
|
);
|
|
|
|
|
};
|
|
|
|
|
};
|
|
|
|
|
|
2021-04-02 09:47:16 +00:00
|
|
|
export * from "@testing-library/react";
|
|
|
|
|
|
2024-03-27 12:00:31 +00:00
|
|
|
export { customRender as render, hookWrapper };
|