From 7a96f99187712f4e61016312ca20970c2c10110b Mon Sep 17 00:00:00 2001 From: ecemooo Date: Thu, 19 Nov 2026 12:49:30 +0300 Subject: [PATCH 1/5] fix: move ComponentEx off legacy React context onto MainContext (LAZ-1698) --- docs/testing.md | 37 +++++++-- src/renderer/src/contexts/MainContext.tsx | 71 ++++------------- .../main_context/MainContext.test.tsx | 78 +++++++++++++++++++ .../src/contexts/main_context/MainContext.ts | 52 +++++++++++++ .../src/controls/ComponentEx.test.tsx | 51 ++++++++++++ src/renderer/src/controls/ComponentEx.ts | 14 +--- .../src/controls/ContextMenu.test.tsx | 39 ++++------ src/renderer/src/controls/IconBar.tsx | 10 +-- src/renderer/src/controls/Modal.test.tsx | 76 ++++++++++++++++++ src/renderer/src/controls/Modal.tsx | 30 ++++--- src/renderer/src/controls/PortalMenu.tsx | 10 +-- src/renderer/src/controls/Table.test.tsx | 45 ++++++----- src/renderer/src/controls/ZoomableImage.tsx | 10 +-- .../src/controls/bbcode/SafeSimpleTag.tsx | 35 ++++++++- .../controls/table/DateTimeFilter.test.tsx | 28 +++---- .../views/DependencyIcon.tsx | 5 -- .../components/GameDetailsModal.tsx | 2 +- .../views/GameRow.test.tsx | 32 ++++---- .../components/prose/bbcode/BBCode.test.tsx | 20 +++++ src/renderer/test-setup.mts | 47 +++++++++++ 20 files changed, 500 insertions(+), 192 deletions(-) create mode 100644 src/renderer/src/contexts/main_context/MainContext.test.tsx create mode 100644 src/renderer/src/contexts/main_context/MainContext.ts create mode 100644 src/renderer/src/controls/ComponentEx.test.tsx create mode 100644 src/renderer/src/controls/Modal.test.tsx diff --git a/docs/testing.md b/docs/testing.md index b2149f95a5..2a3ec5be62 100644 --- a/docs/testing.md +++ b/docs/testing.md @@ -101,6 +101,33 @@ The usual sources: testing-library's, that microtask lands outside `act()`. Re-render inside an async `act()`: `await act(async () => { rerender(…); })`. +### Legacy context, nesting and refs + +A test also fails when React warns that our own code: + +- **reads or provides legacy context** (`contextTypes`, `childContextTypes`). + Read `MainContext` instead, with `static contextType = MainContext` in a class + or `useMainContext()` in a function component. `ComponentEx` already does. A + test that renders a `ComponentEx` without the app provides it with + ``. +- **nests elements HTML doesn't allow** (`validateDOMNesting`), such as a `

` + inside a `

`. Render the outer element as a `

` (`Typography` takes + `as="div"`). +- **gives a ref to a function component.** Wrap the component in + `forwardRef`, including a test's mock of one. + +The message names the component React blamed. Warnings about react-bootstrap's +own components don't fail a test. Two components keep legacy context on purpose: +`ComponentExProvider`, which hands `MainContext` on to community extensions that +still read legacy context, and `FormFeedback`, which reads react-bootstrap's +`FormGroup`. Tests standing in for such an extension name their component +`LegacyContextExtension`, which is allowed too. + +`MainContext` lives in `src/renderer/src/contexts/main_context/MainContext.ts`. +A component that React renders as a separate root, as react-bootstrap's +`OverlayTrigger` does with its overlay, has no provider above it, so it reads +the app-wide values `MainProvider` fills in. + ### What the check can't see - `waitFor`, the `findBy…` queries and `userEvent` turn React's `act()` checks @@ -114,11 +141,11 @@ The usual sources: - An update that lands after testing-library's cleanup fails the next test in the file, or the file's `afterAll` after its last test, rather than the test that caused it. -- Only `act()` warnings fail a test. The deprecation warnings still in the log - (`findDOMNode`, `defaultProps`, legacy `contextTypes`) come from older code: - class components built on `ComponentEx` in `src/renderer/src/controls/`, and - old dependencies such as `react-bootstrap` 0.33. Clearing them means changing - that code, not the tests. +- The deprecation warnings that don't fail a test (`findDOMNode`, + `defaultProps`, and legacy context from react-bootstrap) come from older + code: class components in `src/renderer/src/controls/`, and old dependencies + such as `react-bootstrap` 0.33. Clearing them means changing that code, not + the tests. ## Extension tests diff --git a/src/renderer/src/contexts/MainContext.tsx b/src/renderer/src/contexts/MainContext.tsx index 18147c1888..335040a53d 100644 --- a/src/renderer/src/contexts/MainContext.tsx +++ b/src/renderer/src/contexts/MainContext.tsx @@ -1,38 +1,26 @@ -import PropTypes from "prop-types"; -import React, { - Component, - createContext, - type ReactNode, - type FC, - useContext, - useEffect, - useMemo, - useReducer, - type ValidationMap, -} from "react"; +import React, { type ReactNode, type FC, useContext, useEffect, useMemo, useReducer } from "react"; import { useDispatch, useSelector } from "react-redux"; import { setOpenMainPage } from "../actions/session"; import { useExtensionContext } from "../ExtensionProvider"; import type { IComponentContext } from "../types/IComponentContext"; import type { IState } from "../types/IState"; +import { + ComponentExProvider, + MainContext, + setMainContextFallback, +} from "./main_context/MainContext"; import { useMenuLayerContext } from "./MenuLayerContext"; import { useWindowContext } from "./WindowContext"; +export { MainContext }; + // In modern layout, some pages move to a different location (e.g. Mods settings // moves from global settings to the per-game preferences page) const PAGE_REDIRECTS_MODERN: Record = { application_settings: "game_settings", }; -const defaultValue: IComponentContext = { - api: undefined, - menuLayer: undefined, - getModifiers: () => ({ alt: false, ctrl: false, shift: false }), -}; - -export const MainContext = createContext(defaultValue); - export interface IMainProviderProps { children: ReactNode; } @@ -67,14 +55,13 @@ export const MainProvider: FC> = ({ }; }, [api, dispatch, useModernLayout]); - const contextValue = useMemo( - () => ({ - api, - menuLayer: menuLayerElement, - getModifiers, - }), - [api, menuLayerElement, getModifiers], - ); + const contextValue = useMemo(() => { + const value = { api, menuLayer: menuLayerElement, getModifiers }; + // Set during render rather than in an effect: effects run children first, and a child can + // render a separate root (react-bootstrap's OverlayTrigger) before this one's effect runs. + setMainContextFallback(value); + return value; + }, [api, menuLayerElement, getModifiers]); return ( @@ -88,31 +75,3 @@ export const MainConsumer = MainContext.Consumer; export const useMainContext = (): IComponentContext => { return useContext(MainContext); }; - -interface IComponentExProviderProps { - children: ReactNode; -} - -// This class component provides the legacy React context API (childContextTypes/getChildContext) -// required by child components using ComponentEx with contextTypes. Cannot be replaced with a -// functional component as the legacy context API is only available in class components. -// eslint-disable-next-line @eslint-react/no-class-component -class ComponentExProvider extends Component { - public static contextType = MainContext; - declare public context: IComponentContext; - - public static childContextTypes: ValidationMap = { - api: PropTypes.object.isRequired, - menuLayer: PropTypes.object, - getModifiers: PropTypes.func, - }; - - // eslint-disable-next-line @eslint-react/no-unused-class-component-members - public getChildContext(): IComponentContext { - return this.context; - } - - public render() { - return this.props.children; - } -} diff --git a/src/renderer/src/contexts/main_context/MainContext.test.tsx b/src/renderer/src/contexts/main_context/MainContext.test.tsx new file mode 100644 index 0000000000..640c37d9a7 --- /dev/null +++ b/src/renderer/src/contexts/main_context/MainContext.test.tsx @@ -0,0 +1,78 @@ +import { render } from "@testing-library/react"; +import * as PropTypes from "prop-types"; +import * as React from "react"; +import { afterEach, describe, expect, it } from "vitest"; + +import type { IComponentContext } from "../../types/IComponentContext"; +import { ComponentExProvider, MainContext, setMainContextFallback } from "./MainContext"; + +const api = { events: {} } as unknown as IComponentContext["api"]; +const menuLayer = document.createElement("div"); +const value: IComponentContext = { api, menuLayer, getModifiers: () => undefined }; + +/** Reads MainContext the way ComponentEx does. */ +class Reader extends React.Component<{ onContext: (context: IComponentContext) => void }> { + public static contextType = MainContext; + declare public context: IComponentContext; + + public render() { + this.props.onContext(this.context); + return null; + } +} + +afterEach(() => { + setMainContextFallback({ api: undefined, menuLayer: undefined, getModifiers: undefined }); +}); + +describe("MainContext", () => { + // Community extensions may still declare contextTypes of their own instead of extending + // ComponentEx. ComponentExProvider keeps handing them the same values. + it("passes MainContext on to a component that reads old-style context", () => { + let seen: Partial; + class LegacyContextExtension extends React.Component { + public static contextTypes = { api: PropTypes.object, menuLayer: PropTypes.object }; + + public render() { + seen = this.context; + return null; + } + } + + render( + + + + + , + ); + + expect(seen).toEqual({ api, menuLayer }); + }); + + // react-bootstrap 0.33's OverlayTrigger renders its overlay as a separate root, which no + // provider is above. + it("gives a component with no provider above it the app-wide values", () => { + let seen: IComponentContext; + setMainContextFallback(value); + + render( (seen = context)} />); + + expect(seen.api).toBe(api); + expect(seen.menuLayer).toBe(menuLayer); + }); + + it("prefers a provider's values over the app-wide ones", () => { + let seen: IComponentContext; + const dialogLayer = document.createElement("div"); + setMainContextFallback(value); + + render( + + (seen = context)} /> + , + ); + + expect(seen.menuLayer).toBe(dialogLayer); + }); +}); diff --git a/src/renderer/src/contexts/main_context/MainContext.ts b/src/renderer/src/contexts/main_context/MainContext.ts new file mode 100644 index 0000000000..2039796f77 --- /dev/null +++ b/src/renderer/src/contexts/main_context/MainContext.ts @@ -0,0 +1,52 @@ +// The context every ComponentEx reads: the extension api, the layer menus open on, and the +// current modifier keys. MainProvider (contexts/MainContext.tsx) provides it. It lives here, +// apart from MainProvider, because MainProvider's imports reach most of the app, ComponentEx's +// subclasses among them, and ComponentEx needs this at class definition. +import PropTypes from "prop-types"; +import { Component, createContext, type ReactNode, type ValidationMap } from "react"; + +import type { IComponentContext } from "../../types/IComponentContext"; + +// What a component reads when no provider is above it. React gives a separate root no +// provider, and react-bootstrap 0.33's OverlayTrigger renders its overlay as one, so +// MainProvider fills this in with the app's values for anything rendered that way. +const fallback: IComponentContext = { + api: undefined, + menuLayer: undefined, + getModifiers: () => ({ alt: false, ctrl: false, shift: false }), +}; + +export const MainContext = createContext(fallback); + +/** Makes `value` what a component with no MainContext provider above it reads. */ +export function setMainContextFallback(value: Partial): void { + Object.assign(fallback, value); +} + +interface IComponentExProviderProps { + children: ReactNode; +} + +// Hands MainContext on as old-style (legacy) context, for community extensions whose classes +// declare contextTypes themselves instead of extending ComponentEx. The legacy context API is +// only available to class components. +// eslint-disable-next-line @eslint-react/no-class-component +export class ComponentExProvider extends Component { + public static contextType = MainContext; + declare public context: IComponentContext; + + public static childContextTypes: ValidationMap = { + api: PropTypes.object.isRequired, + menuLayer: PropTypes.object, + getModifiers: PropTypes.func, + }; + + // eslint-disable-next-line @eslint-react/no-unused-class-component-members + public getChildContext(): IComponentContext { + return this.context; + } + + public render() { + return this.props.children; + } +} diff --git a/src/renderer/src/controls/ComponentEx.test.tsx b/src/renderer/src/controls/ComponentEx.test.tsx new file mode 100644 index 0000000000..c716319d4c --- /dev/null +++ b/src/renderer/src/controls/ComponentEx.test.tsx @@ -0,0 +1,51 @@ +import { render } from "@testing-library/react"; +import * as React from "react"; +import { describe, expect, it } from "vitest"; + +import { MainContext } from "../contexts/main_context/MainContext"; +import type { IComponentContext } from "../types/IComponentContext"; +import { ComponentEx, PureComponentEx } from "./ComponentEx"; + +const context: IComponentContext = { + api: { events: {} } as unknown as IComponentContext["api"], + menuLayer: document.createElement("div"), + getModifiers: () => ({ alt: false, ctrl: true, shift: false }), +}; + +describe("ComponentEx", () => { + it("reads api, menuLayer and getModifiers from MainContext", () => { + let seen: IComponentContext; + class Example extends ComponentEx<{}, {}> { + public render() { + seen = this.context; + return null; + } + } + + render( + + + , + ); + + expect(seen).toBe(context); + }); + + it("does the same as a PureComponentEx", () => { + let seen: IComponentContext; + class Example extends PureComponentEx<{}, {}> { + public render() { + seen = this.context; + return null; + } + } + + render( + + + , + ); + + expect(seen).toBe(context); + }); +}); diff --git a/src/renderer/src/controls/ComponentEx.ts b/src/renderer/src/controls/ComponentEx.ts index d77df50201..d9b1d6a65a 100644 --- a/src/renderer/src/controls/ComponentEx.ts +++ b/src/renderer/src/controls/ComponentEx.ts @@ -1,10 +1,10 @@ import { clearImmediate, setImmediate } from "timers"; -import * as PropTypes from "prop-types"; import * as React from "react"; import type { WithTranslation } from "react-i18next"; import { withTranslation } from "react-i18next"; +import { MainContext } from "../contexts/main_context/MainContext"; import type { IComponentContext } from "../types/IComponentContext"; import { deleteOrNop, setSafe } from "../util/storeHelper"; import { truthy } from "../util/util"; @@ -138,11 +138,7 @@ export class ComponentEx extends React.Component< P & Partial, S > { - public static contextTypes: React.ValidationMap = { - api: PropTypes.object.isRequired, - menuLayer: PropTypes.object, - getModifiers: PropTypes.func, - }; + public static contextType = MainContext; declare public context: IComponentContext; @@ -161,11 +157,7 @@ export class PureComponentEx extends React.PureComponent< P & Partial, S > { - public static contextTypes: React.ValidationMap = { - api: PropTypes.object.isRequired, - menuLayer: PropTypes.object, - getModifiers: PropTypes.func, - }; + public static contextType = MainContext; declare public context: IComponentContext; diff --git a/src/renderer/src/controls/ContextMenu.test.tsx b/src/renderer/src/controls/ContextMenu.test.tsx index a4c71a4be0..69dec82d4b 100644 --- a/src/renderer/src/controls/ContextMenu.test.tsx +++ b/src/renderer/src/controls/ContextMenu.test.tsx @@ -1,33 +1,20 @@ import { fireEvent, render, screen, waitFor } from "@testing-library/react"; -import * as PropTypes from "prop-types"; import * as React from "react"; import { afterEach, beforeEach, describe, expect, it } from "vitest"; +import { MainContext } from "../contexts/main_context/MainContext"; +import type { IComponentContext } from "../types/IComponentContext"; import ContextMenu from "./ContextMenu"; -// ContextMenu extends ComponentEx which reads api/menuLayer/getModifiers from -// the legacy context; provide the minimum via a legacy-context provider. -class LegacyContextProvider extends React.Component<{ - menuLayer: HTMLElement; - children: React.ReactNode; -}> { - public static childContextTypes = { - api: PropTypes.object, - menuLayer: PropTypes.object, - getModifiers: PropTypes.func, - }; - - public getChildContext() { - return { - api: { events: { on: () => undefined, off: () => undefined } }, - menuLayer: this.props.menuLayer, - getModifiers: () => ({}), - }; - } - - public render() { - return this.props.children; - } +// ContextMenu extends ComponentEx, which reads api, menuLayer and getModifiers from +// MainContext; provide the minimum. +function ContextProvider(props: { menuLayer: HTMLElement; children: React.ReactNode }) { + const context = { + api: { events: { on: () => undefined, off: () => undefined } }, + menuLayer: props.menuLayer, + getModifiers: () => ({ alt: false, ctrl: false, shift: false }), + } as unknown as IComponentContext; + return {props.children}; } function Harness(props: { menuLayer: HTMLElement }) { @@ -42,7 +29,7 @@ function Harness(props: { menuLayer: HTMLElement }) { const onHide = React.useCallback(() => setVisible(false), []); return ( - +
undefined, show: true } as any]} /> - + ); } diff --git a/src/renderer/src/controls/IconBar.tsx b/src/renderer/src/controls/IconBar.tsx index d27a46915b..a206e47871 100644 --- a/src/renderer/src/controls/IconBar.tsx +++ b/src/renderer/src/controls/IconBar.tsx @@ -1,11 +1,12 @@ import update from "immutability-helper"; import * as _ from "lodash"; -import * as PropTypes from "prop-types"; import * as React from "react"; import { ButtonGroup, Dropdown, MenuItem } from "react-bootstrap"; import ReactDOM from "react-dom"; +import { MainContext } from "../contexts/main_context/MainContext"; import type { IActionDefinition } from "../types/IActionDefinition"; +import type { IComponentContext } from "../types/IComponentContext"; import type { IExtensibleProps } from "../types/IExtensionProvider"; import type { TFunction } from "../util/i18n"; import { setdefault } from "../util/util"; @@ -172,11 +173,8 @@ function IconBarIcon(props: IIconBarIconProps) { * @extends {ComponentEx} */ class IconBar extends React.Component { - public static contextTypes: React.ValidationMap = { - menuLayer: PropTypes.object, - }; - - declare public context: { menuLayer: JSX.Element }; + public static contextType = MainContext; + declare public context: IComponentContext; private portalTargetRef: Element; private mBackgroundClick: (evt: React.MouseEvent) => void; diff --git a/src/renderer/src/controls/Modal.test.tsx b/src/renderer/src/controls/Modal.test.tsx new file mode 100644 index 0000000000..421c3422aa --- /dev/null +++ b/src/renderer/src/controls/Modal.test.tsx @@ -0,0 +1,76 @@ +import { render } from "@testing-library/react"; +import * as PropTypes from "prop-types"; +import * as React from "react"; +import { afterEach, beforeEach, describe, expect, it } from "vitest"; + +import { MainContext } from "../contexts/main_context/MainContext"; +import type { IComponentContext } from "../types/IComponentContext"; +import { ComponentEx } from "./ComponentEx"; +import Modal from "./Modal"; + +const appLayer = document.createElement("div"); +const context: IComponentContext = { + api: { events: {} } as unknown as IComponentContext["api"], + menuLayer: appLayer, + getModifiers: () => undefined, +}; + +let overlays: HTMLElement; + +beforeEach(() => { + // the dialog mounts into the app's overlay host + overlays = document.createElement("div"); + overlays.id = "overlays"; + document.body.appendChild(overlays); +}); + +afterEach(() => { + overlays.remove(); +}); + +// A menu opened inside a dialog goes on the dialog's own menu layer, so it sits above the +// dialog instead of behind it. +describe("Modal", () => { + it("gives what's inside it the dialog's menu layer and the app's api", () => { + let seen: IComponentContext; + class Inside extends ComponentEx<{}, {}> { + public render() { + seen = this.context; + return null; + } + } + + render( + + undefined}> + + + , + ); + + expect(seen.api).toBe(context.api); + expect(seen.menuLayer).toBe(document.querySelector(".modal .menu-layer")); + }); + + it("gives the same to a component that reads old-style context", () => { + let seen: Partial; + class LegacyContextExtension extends React.Component { + public static contextTypes = { api: PropTypes.object, menuLayer: PropTypes.object }; + + public render() { + seen = this.context; + return null; + } + } + + render( + + undefined}> + + + , + ); + + expect(seen.menuLayer).toBe(document.querySelector(".modal .menu-layer")); + }); +}); diff --git a/src/renderer/src/controls/Modal.tsx b/src/renderer/src/controls/Modal.tsx index 29569f0ab6..47c0de2ce8 100644 --- a/src/renderer/src/controls/Modal.tsx +++ b/src/renderer/src/controls/Modal.tsx @@ -1,9 +1,9 @@ import memoizeOne from "memoize-one"; -import * as PropTypes from "prop-types"; import * as React from "react"; import type { ModalBody, ModalFooter, ModalHeader, ModalTitle } from "react-bootstrap"; import { Modal } from "react-bootstrap"; +import { ComponentExProvider, MainContext } from "../contexts/main_context/MainContext"; import type { IComponentContext } from "../types/IComponentContext"; import { MutexWrapper } from "../util/MutexContext"; @@ -13,19 +13,21 @@ class MyModal extends React.PureComponent { public static Body: typeof ModalBody = Modal.Body; public static Footer: typeof ModalFooter = Modal.Footer; - public static childContextTypes: React.ValidationMap = { - menuLayer: PropTypes.object, - }; - - declare public context: Partial; + public static contextType = MainContext; + declare public context: IComponentContext; private getContainer = memoizeOne(() => this.getContainerImpl()); - private mMenuLayer: Element = null; + // What's inside the dialog gets its own menu layer, so a menu opened there sits above the + // dialog rather than behind it. + private getInnerContext = memoizeOne( + (outer: IComponentContext, menuLayer: HTMLDivElement): IComponentContext => ({ + ...outer, + menuLayer, + }), + ); - public getChildContext(): any { - return { ...this.context, menuLayer: this.mMenuLayer }; - } + private mMenuLayer: HTMLDivElement = null; public render(): JSX.Element { return ( @@ -33,7 +35,11 @@ class MyModal extends React.PureComponent {
- {this.mMenuLayer !== null ? this.props.children : null} + {this.mMenuLayer !== null ? ( + + {this.props.children} + + ) : null}
@@ -44,7 +50,7 @@ class MyModal extends React.PureComponent { return document.getElementById("overlays"); } - private setMenuLayer = (ref: Element) => { + private setMenuLayer = (ref: HTMLDivElement) => { this.mMenuLayer = ref; this.forceUpdate(); }; diff --git a/src/renderer/src/controls/PortalMenu.tsx b/src/renderer/src/controls/PortalMenu.tsx index d86b8125ee..d268e5221f 100644 --- a/src/renderer/src/controls/PortalMenu.tsx +++ b/src/renderer/src/controls/PortalMenu.tsx @@ -1,8 +1,9 @@ -import * as PropTypes from "prop-types"; import * as React from "react"; import type { SelectCallback } from "react-bootstrap"; import { Overlay } from "react-overlays"; +import { MainContext } from "../contexts/main_context/MainContext"; +import type { IComponentContext } from "../types/IComponentContext"; import Dropdown from "./Dropdown"; interface IPortalMenuProps { @@ -22,11 +23,8 @@ function nop() { } class PortalMenu extends React.Component { - public static contextTypes: React.ValidationMap = { - menuLayer: PropTypes.object, - }; - - declare public context: { menuLayer: JSX.Element }; + public static contextType = MainContext; + declare public context: IComponentContext; constructor(props: IPortalMenuProps) { super(props); diff --git a/src/renderer/src/controls/Table.test.tsx b/src/renderer/src/controls/Table.test.tsx index 784903e279..f6a08b71c1 100644 --- a/src/renderer/src/controls/Table.test.tsx +++ b/src/renderer/src/controls/Table.test.tsx @@ -5,12 +5,13 @@ * page scroll, not the pane. */ import { act, fireEvent, render, waitFor } from "@testing-library/react"; -import * as PropTypes from "prop-types"; import * as React from "react"; import { Provider } from "react-redux"; import { afterEach, beforeAll, describe, expect, it, vi } from "vitest"; +import { MainContext } from "../contexts/main_context/MainContext"; import * as scrolling from "../smoothScroll"; +import type { IComponentContext } from "../types/IComponentContext"; import SuperTable from "./Table"; import HeaderCell from "./table/HeaderCell"; @@ -49,24 +50,26 @@ const listeners = new Map void>(); const state = { settings: { interface: { usage: {} } }, persistent: {} }; const store = { getState: () => state, subscribe: () => () => undefined, dispatch: vi.fn() }; -class LegacyContext extends React.Component<{ children: React.ReactNode }> { - public static childContextTypes = { api: PropTypes.object }; - public getChildContext() { - return { - api: { - events: { - on: (event: string, listener: (...args: any[]) => void) => listeners.set(event, listener), - emit: vi.fn(), - removeAllListeners: vi.fn(), - }, - getState: () => state, - store, - }, - }; - } - public render() { - return {this.props.children}; - } +const appContext = { + api: { + events: { + on: (event: string, listener: (...args: any[]) => void) => listeners.set(event, listener), + emit: vi.fn(), + removeAllListeners: vi.fn(), + }, + getState: () => state, + store, + }, + menuLayer: undefined, + getModifiers: () => ({ alt: false, ctrl: false, shift: false }), +} as unknown as IComponentContext; + +function AppContext(props: { children: React.ReactNode }) { + return ( + + {props.children} + + ); } const attributes = [ @@ -98,7 +101,7 @@ function renderTable( document.body.appendChild(page); const result = render( - + { if (instance) tableInstance = instance; @@ -122,7 +125,7 @@ function renderTable( onCollapseGroup={vi.fn()} onSetCollapsedGroups={vi.fn()} /> - , + , { container: host }, ); const pane = host.querySelector(".table-main-pane"); diff --git a/src/renderer/src/controls/ZoomableImage.tsx b/src/renderer/src/controls/ZoomableImage.tsx index 365779f38c..657639058a 100644 --- a/src/renderer/src/controls/ZoomableImage.tsx +++ b/src/renderer/src/controls/ZoomableImage.tsx @@ -1,9 +1,10 @@ import * as _ from "lodash"; -import * as PropTypes from "prop-types"; import * as React from "react"; import { Image } from "react-bootstrap"; import { Portal } from "react-overlays"; +import { MainContext } from "../contexts/main_context/MainContext"; +import type { IComponentContext } from "../types/IComponentContext"; import { setSafe } from "../util/storeHelper"; import Icon from "./Icon"; @@ -27,11 +28,8 @@ export interface IZoomableImageProps { } class ZoomableImage extends React.Component { - public static contextTypes: React.ValidationMap = { - menuLayer: PropTypes.object, - }; - - declare public context: { menuLayer: JSX.Element }; + public static contextType = MainContext; + declare public context: IComponentContext; constructor(props) { super(props); diff --git a/src/renderer/src/controls/bbcode/SafeSimpleTag.tsx b/src/renderer/src/controls/bbcode/SafeSimpleTag.tsx index d62f085b58..b41f3eb1c0 100644 --- a/src/renderer/src/controls/bbcode/SafeSimpleTag.tsx +++ b/src/renderer/src/controls/bbcode/SafeSimpleTag.tsx @@ -74,6 +74,34 @@ const keptParams = (params: Record, kept: Record property.replace(/-(\w)/g, (_, letter: string) => letter.toUpperCase()); +/** + * A table's children with each run of rows written straight in it put in a ``, as the + * browser does when it parses the page. Drawn without one, React's tree wouldn't match the page. + * Rows already in a `[thead]` or `[tbody]` are left as they are. + */ +const rowsInBody = (children: React.ReactNode): React.ReactNode[] => { + const drawn: React.ReactNode[] = []; + let rows: React.ReactNode[] = []; + const endRows = () => { + if (rows.length > 0) { + drawn.push(React.createElement("tbody", { key: `rows-${drawn.length}` }, rows)); + rows = []; + } + }; + + for (const child of React.Children.toArray(children)) { + if (React.isValidElement(child) && child.type === "tr") { + rows.push(child); + } else { + endRows(); + drawn.push(child); + } + } + endRows(); + + return drawn; +}; + /** * A plain tag, such as `[b]` or `[td]`, as its element with only the parameters it keeps. The * parser's own hands every parameter to the element, so `[td background=…]` would load an image @@ -114,7 +142,12 @@ const safeSimpleTag = ( ); } - return React.createElement(element, props, this.getComponents()); + const children = this.getComponents(); + return React.createElement( + element, + props, + element === "table" ? rowsInBody(children) : children, + ); } }; diff --git a/src/renderer/src/controls/table/DateTimeFilter.test.tsx b/src/renderer/src/controls/table/DateTimeFilter.test.tsx index 34d949d0bf..f75c110cb2 100644 --- a/src/renderer/src/controls/table/DateTimeFilter.test.tsx +++ b/src/renderer/src/controls/table/DateTimeFilter.test.tsx @@ -1,8 +1,9 @@ import { render } from "@testing-library/react"; -import * as PropTypes from "prop-types"; import * as React from "react"; import { describe, expect, it, vi } from "vitest"; +import { MainContext } from "../../contexts/main_context/MainContext"; +import type { IComponentContext } from "../../types/IComponentContext"; import { DateTimeFilterComponent } from "./DateTimeFilter"; function makeApi(locale: string) { @@ -17,24 +18,13 @@ interface IProviderProps { children: React.ReactNode; } -class ApiContextProvider extends React.Component { - public static childContextTypes = { - api: PropTypes.object, - menuLayer: PropTypes.object, - getModifiers: PropTypes.func, - }; - - public getChildContext() { - return { - api: this.props.api, - menuLayer: document.createElement("div"), - getModifiers: () => ({}), - }; - } - - public render() { - return this.props.children; - } +function ApiContextProvider(props: IProviderProps) { + const context = { + api: props.api, + menuLayer: document.createElement("div"), + getModifiers: () => ({ alt: false, ctrl: false, shift: false }), + } as unknown as IComponentContext; + return {props.children}; } function renderWith(locale: string, value: string = "") { diff --git a/src/renderer/src/extensions/gamebryo_plugin_management/views/DependencyIcon.tsx b/src/renderer/src/extensions/gamebryo_plugin_management/views/DependencyIcon.tsx index 3973a54d84..d47ae76e78 100644 --- a/src/renderer/src/extensions/gamebryo_plugin_management/views/DependencyIcon.tsx +++ b/src/renderer/src/extensions/gamebryo_plugin_management/views/DependencyIcon.tsx @@ -1,6 +1,5 @@ import { getErrorMessageOrDefault } from "@vortex/shared"; import type I18next from "i18next"; -import * as PropTypes from "prop-types"; import * as React from "react"; import { Button, Overlay, Popover } from "react-bootstrap"; import type { @@ -191,10 +190,6 @@ function collectDrop(dropConnect: DropTargetConnector, monitor: DropTargetMonito const RE_MATCH = /[:\*?|]/; class DependencyIcon extends ComponentEx { - public static contextTypes: React.ValidationMap = { - getModifiers: PropTypes.func, - }; - private mRef: JSX.Element; constructor(props: IProps) { diff --git a/src/renderer/src/extensions/gamemode_management/components/GameDetailsModal.tsx b/src/renderer/src/extensions/gamemode_management/components/GameDetailsModal.tsx index 7deb02fb4c..771b91ec15 100644 --- a/src/renderer/src/extensions/gamemode_management/components/GameDetailsModal.tsx +++ b/src/renderer/src/extensions/gamemode_management/components/GameDetailsModal.tsx @@ -110,7 +110,7 @@ export const GameDetailsModal = ({ {gameName} - + {!keys.length ? t("No information about this game") : keys.map((key) => ( diff --git a/src/renderer/src/extensions/gamemode_management/views/GameRow.test.tsx b/src/renderer/src/extensions/gamemode_management/views/GameRow.test.tsx index 228f7ebbc0..7f45b1294a 100644 --- a/src/renderer/src/extensions/gamemode_management/views/GameRow.test.tsx +++ b/src/renderer/src/extensions/gamemode_management/views/GameRow.test.tsx @@ -4,11 +4,12 @@ */ import { render, screen } from "@testing-library/react"; import userEvent from "@testing-library/user-event"; -import * as PropTypes from "prop-types"; import * as React from "react"; import { beforeEach, describe, expect, it, vi } from "vitest"; +import { MainContext } from "../../../contexts/main_context/MainContext"; import type { IActionDefinition } from "../../../types/IActionDefinition"; +import type { IComponentContext } from "../../../types/IComponentContext"; import type { IGameStored } from "../types/IGameStored"; const { bars, emit } = vi.hoisted(() => ({ @@ -36,7 +37,11 @@ vi.mock("@/ui/components/popover/Popover", () => ({ <>{children({ open: true })} ), })); -vi.mock("@/ui/components/popover/PopoverButton", () => ({ PopoverButton: () => null })); +// Tooltip hands its trigger a ref, as headless-ui's PopoverButton takes one. +vi.mock("@/ui/components/popover/PopoverButton", async () => { + const { forwardRef } = await import("react"); + return { PopoverButton: forwardRef(() => null) }; +}); vi.mock("@/ui/components/popover/PopoverPanel", () => ({ PopoverPanel: ({ children }: { children: React.ReactNode }) => <>{children}, })); @@ -50,19 +55,12 @@ vi.mock("@/extensions/analytics/mixpanel/numericGameId", () => ({ import GameRow from "./GameRow"; -/** GameRow reads the api off the legacy context, as every ComponentEx does. */ -class LegacyContext extends React.Component<{ children: React.ReactNode }> { - public static childContextTypes = { api: PropTypes.object }; - - public getChildContext() { - // The popover puts its IconBar under a redux Provider, which wants a whole store. - const store = { dispatch: vi.fn(), getState: () => ({}), subscribe: () => () => undefined }; - return { api: { events: { emit }, store } }; - } - - public render() { - return this.props.children; - } +/** GameRow reads the api off MainContext, as every ComponentEx does. */ +function AppContext(props: { children: React.ReactNode }) { + // The popover puts its IconBar under a redux Provider, which wants a whole store. + const store = { dispatch: vi.fn(), getState: () => ({}), subscribe: () => () => undefined }; + const context = { api: { events: { emit }, store } } as unknown as IComponentContext; + return {props.children}; } const skyrim: IGameStored = { @@ -75,7 +73,7 @@ const skyrim: IGameStored = { const renderRow = (props: Partial> = {}) => render( - + > = {}) => onRefreshGameInfo={vi.fn()} {...props} /> - , + , ); const tracked = () => diff --git a/src/renderer/src/ui/components/prose/bbcode/BBCode.test.tsx b/src/renderer/src/ui/components/prose/bbcode/BBCode.test.tsx index 5dc7dc304d..57c1715e2c 100644 --- a/src/renderer/src/ui/components/prose/bbcode/BBCode.test.tsx +++ b/src/renderer/src/ui/components/prose/bbcode/BBCode.test.tsx @@ -166,6 +166,26 @@ describe("BBCode", () => { }); }); + // The browser puts rows written straight in a table into a of its own, so they're + // drawn in one, or React's tree wouldn't match the page. + it("puts a table's rows in a tbody", () => { + const { container } = render( + , + ); + + expect(container.querySelectorAll("table > tbody > tr")).toHaveLength(2); + }); + + it("keeps a table's own thead and tbody", () => { + const { container } = render( + , + ); + + expect(container.querySelectorAll("table > thead > tr")).toHaveLength(1); + expect(container.querySelectorAll("table > tbody > tr")).toHaveLength(1); + expect(container.querySelectorAll("tbody tbody")).toHaveLength(0); + }); + it("keeps how far a table cell spans and where its text sits", () => { render( , diff --git a/src/renderer/test-setup.mts b/src/renderer/test-setup.mts index e7992e265e..e920c4cd69 100644 --- a/src/renderer/test-setup.mts +++ b/src/renderer/test-setup.mts @@ -40,6 +40,53 @@ const failOnActWarnings = () => { afterEach(failOnActWarnings); afterAll(failOnActWarnings); +// React warnings about our own code fail the test they're logged in, as act() warnings do above; +// "React warnings" in docs/testing.md says how to fix each. A warning is ours when the first +// component in React's stack that has a file isn't in node_modules: react-bootstrap 0.33 logs +// the same warnings about its own components, and those go when it does. +const ourWarnings = [ + { logged: "uses the legacy contextTypes API", failure: "reads legacy context" }, + { logged: "uses the legacy childContextTypes API", failure: "provides legacy context" }, + { logged: "validateDOMNesting", failure: "nests elements HTML doesn't allow" }, + { + logged: "Function components cannot be given refs", + failure: "gives a ref to a function component", + }, +]; +// Legacy context on purpose: ComponentExProvider hands MainContext on to extensions that still +// read legacy context, LegacyContextExtension is the tests' stand-in for one of those, and +// FormFeedback reads react-bootstrap's FormGroup, which only has legacy context. +const legacyContextOnPurpose = ["ComponentExProvider", "LegacyContextExtension", "FormFeedback"]; +let ourWarningsLogged = new Set(); +const consoleErrorBeforeOurWarnings = console.error; +console.error = (...args: unknown[]) => { + const message = args[0]; + const warning = + typeof message === "string" + ? ourWarnings.find(({ logged }) => message.includes(logged)) + : undefined; + if (warning !== undefined && !legacyContextOnPurpose.includes(String(args[1]))) { + // React passes the component stack last + const stack = [...args] + .reverse() + .find((arg) => typeof arg === "string" && arg.includes(" at ")); + const frame = /\bat (\S+) \(([^)]+)\)/.exec(String(stack ?? "")); + if (frame === null || !frame[2].includes("/node_modules/")) { + ourWarningsLogged.add(`${frame?.[1] ?? "a component"} ${warning.failure}`); + } + } + consoleErrorBeforeOurWarnings.apply(console, args); +}; +const failOnOurWarnings = () => { + const failures = [...ourWarningsLogged]; + ourWarningsLogged = new Set(); + if (failures.length > 0) { + throw new Error(`${failures.join("; ")}; see "React warnings" in docs/testing.md`); + } +}; +afterEach(failOnOurWarnings); +afterAll(failOnOurWarnings); + // No test initialises i18next, so react-i18next warns once per file and falls back to // returning the key. The source strings in this repo are the keys, so that fallback is // already what the assertions read — this just makes it the stated behaviour instead of a From 4f1db2a735086e7ef078aa6b710b74e7c36a758b Mon Sep 17 00:00:00 2001 From: ecemooo Date: Thu, 19 Nov 2026 13:46:04 +0300 Subject: [PATCH 2/5] fix: give popovers in dialogs the dialog's menu layer and check the remaining context warnings (LAZ-1698) --- docs/testing.md | 9 ++- .../main_context/MainContext.test.tsx | 7 +- src/renderer/src/controls/Modal.tsx | 20 +++-- src/renderer/src/controls/OverlayTrigger.tsx | 19 +++++ .../MainContextOverlay.test.tsx | 79 +++++++++++++++++++ .../MainContextOverlay.tsx | 33 ++++++++ src/renderer/src/renderer.tsx | 2 + src/renderer/test-setup.mts | 13 ++- 8 files changed, 172 insertions(+), 10 deletions(-) create mode 100644 src/renderer/src/controls/main_context_overlay/MainContextOverlay.test.tsx create mode 100644 src/renderer/src/controls/main_context_overlay/MainContextOverlay.tsx diff --git a/docs/testing.md b/docs/testing.md index 2a3ec5be62..60b21c1374 100644 --- a/docs/testing.md +++ b/docs/testing.md @@ -110,6 +110,11 @@ A test also fails when React warns that our own code: or `useMainContext()` in a function component. `ComponentEx` already does. A test that renders a `ComponentEx` without the app provides it with ``. +- **declares `contextTypes` on a class that also has `contextType`,** such as a + `ComponentEx` subclass. React ignores the `contextTypes`; drop them. +- **fails a context type check** (`Failed context type`): a legacy provider, + such as `ComponentExProvider`, rendered without the value it requires. Render + it inside a `` that has an `api`. - **nests elements HTML doesn't allow** (`validateDOMNesting`), such as a `

` inside a `

`. Render the outer element as a `

` (`Typography` takes `as="div"`). @@ -126,7 +131,9 @@ still read legacy context, and `FormFeedback`, which reads react-bootstrap's `MainContext` lives in `src/renderer/src/contexts/main_context/MainContext.ts`. A component that React renders as a separate root, as react-bootstrap's `OverlayTrigger` does with its overlay, has no provider above it, so it reads -the app-wide values `MainProvider` fills in. +the app-wide values `MainProvider` fills in. Our `OverlayTrigger` wraps its +overlay in `MainContextOverlay`, which hands it the trigger's own `MainContext`, +so a popover in a dialog gets the dialog's menu layer. ### What the check can't see diff --git a/src/renderer/src/contexts/main_context/MainContext.test.tsx b/src/renderer/src/contexts/main_context/MainContext.test.tsx index 640c37d9a7..f3257c0034 100644 --- a/src/renderer/src/contexts/main_context/MainContext.test.tsx +++ b/src/renderer/src/contexts/main_context/MainContext.test.tsx @@ -22,7 +22,12 @@ class Reader extends React.Component<{ onContext: (context: IComponentContext) = } afterEach(() => { - setMainContextFallback({ api: undefined, menuLayer: undefined, getModifiers: undefined }); + // back to MainContext's own default + setMainContextFallback({ + api: undefined, + menuLayer: undefined, + getModifiers: () => ({ alt: false, ctrl: false, shift: false }), + }); }); describe("MainContext", () => { diff --git a/src/renderer/src/controls/Modal.tsx b/src/renderer/src/controls/Modal.tsx index 47c0de2ce8..e7a582c1c1 100644 --- a/src/renderer/src/controls/Modal.tsx +++ b/src/renderer/src/controls/Modal.tsx @@ -19,12 +19,14 @@ class MyModal extends React.PureComponent { private getContainer = memoizeOne(() => this.getContainerImpl()); // What's inside the dialog gets its own menu layer, so a menu opened there sits above the - // dialog rather than behind it. + // dialog rather than behind it. Memoized on the values rather than the outer context object: + // with no provider above, that object is MainContext's fallback, which is updated in place. private getInnerContext = memoizeOne( - (outer: IComponentContext, menuLayer: HTMLDivElement): IComponentContext => ({ - ...outer, - menuLayer, - }), + ( + api: IComponentContext["api"], + getModifiers: IComponentContext["getModifiers"], + menuLayer: HTMLDivElement, + ): IComponentContext => ({ api, getModifiers, menuLayer }), ); private mMenuLayer: HTMLDivElement = null; @@ -36,7 +38,13 @@ class MyModal extends React.PureComponent {
{this.mMenuLayer !== null ? ( - + {this.props.children} ) : null} diff --git a/src/renderer/src/controls/OverlayTrigger.tsx b/src/renderer/src/controls/OverlayTrigger.tsx index de7b72d30e..134058c8ce 100644 --- a/src/renderer/src/controls/OverlayTrigger.tsx +++ b/src/renderer/src/controls/OverlayTrigger.tsx @@ -3,6 +3,10 @@ import * as React from "react"; import { OverlayTrigger } from "react-bootstrap"; import * as ReactDOM from "react-dom"; +import { MainContext } from "../contexts/main_context/MainContext"; +import type { IComponentContext } from "../types/IComponentContext"; +import { MainContextOverlay } from "./main_context_overlay/MainContextOverlay"; + export interface IBaseProps { triggerRef?: (ref: HTMLElement) => void; getBounds: () => ClientRect; @@ -30,6 +34,9 @@ export type IProps = IBaseProps & typeof OverlayTrigger.prototype.props; * @extends {React.Component} */ class MyOverlayTrigger extends React.Component { + public static contextType = MainContext; + declare public context: IComponentContext; + private mNode: Element; constructor(props) { @@ -53,12 +60,24 @@ class MyOverlayTrigger extends React.Component { onEnter={this.onEnter} ref={this.props.triggerRef} {...relayProps} + overlay={this.renderOverlay()} > {this.props.children} ); } + // The overlay is drawn as a separate React root, so it's handed this trigger's MainContext + // explicitly; inside a dialog that carries the dialog's menu layer. + private renderOverlay() { + const { overlay } = this.props; + return React.isValidElement(overlay) ? ( + + ) : ( + overlay + ); + } + private onEnter = () => { if (this.mNode) { const bounds: ClientRect = this.props.getBounds(); diff --git a/src/renderer/src/controls/main_context_overlay/MainContextOverlay.test.tsx b/src/renderer/src/controls/main_context_overlay/MainContextOverlay.test.tsx new file mode 100644 index 0000000000..46ae87e937 --- /dev/null +++ b/src/renderer/src/controls/main_context_overlay/MainContextOverlay.test.tsx @@ -0,0 +1,79 @@ +import { render } from "@testing-library/react"; +import React, { Component, type ReactElement } from "react"; +import { OverlayTrigger, Popover } from "react-bootstrap"; +import { describe, expect, it } from "vitest"; + +import { MainContext } from "../../contexts/main_context/MainContext"; +import type { IComponentContext } from "../../types/IComponentContext"; +import { MainContextOverlay } from "./MainContextOverlay"; + +const dialogLayer = document.createElement("div"); +const dialogContext: IComponentContext = { + api: { events: {} } as unknown as IComponentContext["api"], + menuLayer: dialogLayer, + getModifiers: () => ({ alt: false, ctrl: false, shift: false }), +}; + +/** Reads MainContext the way ComponentEx does. */ +// eslint-disable-next-line @eslint-react/no-class-component +class Reader extends Component<{ onContext: (context: IComponentContext) => void }> { + public static contextType = MainContext; + declare public context: IComponentContext; + + public render() { + this.props.onContext(this.context); + return null; + } +} + +/** Shows `overlay` the way react-bootstrap's OverlayTrigger does: as a separate React root. */ +function renderShownOverlay(wrap: (overlay: ReactElement) => ReactElement) { + let seen: IComponentContext; + const overlay = ( + + (seen = context)} /> + + ); + + render( + + +