## Description - Create a new hookWrapper util to enable hook testing with redux state - Create a util function to create EditorState Focus Info - Small refactor of `useGetPageFocusUrl` hook - Adds tests for `useGetPageFocusUrl` hook Fixes #31871 ## Automation /ok-to-test tags="@tag.IDE" ### 🔍 Cypress test results <!-- This is an auto-generated comment: Cypress test results --> > [!TIP] > Tests running at: <https://github.com/appsmithorg/appsmith/actions/runs/8451092610> > Commit: `a4660177de70be17d94928eef4fbe29a37f1a1d5` > Workflow: `PR Automation test suite` > Tags: `@tag.IDE` <!-- end of auto-generated comment: Cypress test results --> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Introduced a function to streamline the creation of editor focus information, enhancing navigation within the IDE. - **Refactor** - Refactored logic for setting focus page URLs in the IDE, improving the accuracy and reliability of navigation. - **Tests** - Added tests for the `useGetPageFocusUrl` hook, ensuring URL generation behaves as expected. - **Chores** - Updated utility functions for IDE tests, facilitating better test setup and execution. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
108 lines
3.2 KiB
TypeScript
108 lines
3.2 KiB
TypeScript
import type { ReactElement } from "react";
|
|
import React from "react";
|
|
import type { RenderOptions } from "@testing-library/react";
|
|
import { render, queries } from "@testing-library/react";
|
|
import { Provider } from "react-redux";
|
|
import { ThemeProvider } from "styled-components";
|
|
import { getCurrentThemeDetails } from "selectors/themeSelectors";
|
|
import * as customQueries from "./customQueries";
|
|
import { BrowserRouter } from "react-router-dom";
|
|
import type { AppState } from "@appsmith/reducers";
|
|
import appReducer from "@appsmith/reducers";
|
|
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";
|
|
import type { FeatureFlags } from "@appsmith/entities/FeatureFlag";
|
|
import { fetchFeatureFlagsSuccess } from "../src/actions/userActions";
|
|
import { DEFAULT_FEATURE_FLAG_VALUE } from "@appsmith/entities/FeatureFlag";
|
|
|
|
const testSagaMiddleware = createSagaMiddleware();
|
|
|
|
const testStoreWithTestMiddleWare = (initialState: Partial<AppState>) =>
|
|
createStore(
|
|
appReducer,
|
|
initialState,
|
|
compose(reduxBatch, applyMiddleware(testSagaMiddleware), reduxBatch),
|
|
);
|
|
|
|
const rootSaga = function* (sagasToRun = sagasToRunForTests) {
|
|
yield all(
|
|
sagasToRun.map((saga) =>
|
|
spawn(function* () {
|
|
while (true) {
|
|
yield call(saga);
|
|
break;
|
|
}
|
|
}),
|
|
),
|
|
);
|
|
};
|
|
|
|
interface State {
|
|
url?: string;
|
|
initialState?: Partial<AppState>;
|
|
sagasToRun?: typeof sagasToRunForTests;
|
|
featureFlags?: Partial<FeatureFlags>;
|
|
}
|
|
const setupState = (state?: State) => {
|
|
let reduxStore = store;
|
|
window.history.pushState({}, "Appsmith", state?.url || "/");
|
|
if (state && (state.initialState || state.featureFlags)) {
|
|
reduxStore = testStore(state.initialState || {});
|
|
if (state.featureFlags) {
|
|
reduxStore.dispatch(
|
|
fetchFeatureFlagsSuccess({
|
|
...DEFAULT_FEATURE_FLAG_VALUE,
|
|
...state.featureFlags,
|
|
}),
|
|
);
|
|
}
|
|
}
|
|
if (state && state.sagasToRun) {
|
|
reduxStore = testStoreWithTestMiddleWare(reduxStore.getState());
|
|
testSagaMiddleware.run(() => rootSaga(state.sagasToRun));
|
|
}
|
|
const defaultTheme = getCurrentThemeDetails(reduxStore.getState());
|
|
|
|
return { reduxStore, defaultTheme };
|
|
};
|
|
|
|
const customRender = (
|
|
ui: ReactElement,
|
|
state?: State,
|
|
options?: Omit<RenderOptions, "queries">,
|
|
) => {
|
|
const { defaultTheme, reduxStore } = setupState(state);
|
|
return render(
|
|
<BrowserRouter>
|
|
<Provider store={reduxStore}>
|
|
<ThemeProvider theme={defaultTheme}>{ui}</ThemeProvider>
|
|
</Provider>
|
|
</BrowserRouter>,
|
|
{
|
|
queries: { ...queries, ...customQueries },
|
|
...options,
|
|
},
|
|
);
|
|
};
|
|
|
|
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>
|
|
);
|
|
};
|
|
};
|
|
|
|
export * from "@testing-library/react";
|
|
|
|
export { customRender as render, hookWrapper };
|