This repository has been archived by the owner on Mar 4, 2020. It is now read-only.
feat(Debug): Add CSSinJS debug panel #1974
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| import * as React from 'react' | ||
layershifter marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| import { mergeThemes, callable, ComponentStyleFunctionParam, themes } from '@stardust-ui/react' | ||
| import * as _ from 'lodash' | ||
|
|
||
| /** | ||
| * Not a real performance test, just a temporary POC | ||
| */ | ||
| const providerMergeThemesPerf = () => { | ||
| const merged = mergeThemes(..._.times(100, n => themes.teams)) | ||
| const resolvedStyles = _.mapValues(merged.componentStyles, (componentStyle, componentName) => { | ||
| const compVariables = _.get(merged.componentVariables, componentName, callable({}))( | ||
| merged.siteVariables, | ||
| ) | ||
| const styleParam: ComponentStyleFunctionParam = { | ||
| displayName: componentName, | ||
| props: {}, | ||
| variables: compVariables, | ||
| theme: merged, | ||
| rtl: false, | ||
| disableAnimations: false, | ||
| } | ||
| return _.mapValues(componentStyle, (partStyle, partName) => { | ||
| if (partName === '_debug') { | ||
| // TODO: fix in code, happens only with mergeThemes(singleTheme) | ||
| return undefined | ||
| } | ||
| if (typeof partStyle !== 'function') { | ||
| console.log(componentName, partStyle, partName) | ||
|
There was a problem hiding this comment. This will affect performance as Do you want to add this perf test at all? |
||
| } | ||
| return partStyle(styleParam) | ||
| }) | ||
| }) | ||
|
|
||
| return resolvedStyles | ||
| } | ||
|
|
||
| const MergeThemesPerf = () => { | ||
| const resolvedStyles = providerMergeThemesPerf() | ||
| delete resolvedStyles.Button.root._debug | ||
| return <pre>{JSON.stringify(resolvedStyles.Button.root, null, 2)}</pre> | ||
| } | ||
|
|
||
| export default MergeThemesPerf | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| import * as React from 'react' | ||
|
|
||
| import ComponentPerfExample from 'docs/src/components/ComponentDoc/ComponentPerfExample' | ||
| import NonPublicSection from 'docs/src/components/ComponentDoc/NonPublicSection' | ||
|
|
||
| const Performance = () => ( | ||
| <NonPublicSection title="Performance"> | ||
| <ComponentPerfExample | ||
| title="Merge themes" | ||
| description="mergeThemes perf" | ||
| examplePath="components/Provider/Performance/ProviderMergeThemes.perf" | ||
| /> | ||
| </NonPublicSection> | ||
| ) | ||
|
|
||
| export default Performance |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,193 @@ | ||
| import keyboardKey from 'keyboard-key' | ||
| import * as PropTypes from 'prop-types' | ||
| import * as React from 'react' | ||
| import { toRefObject } from '@stardust-ui/react-component-ref' | ||
| import { EventListener } from '@stardust-ui/react-component-event-listener' | ||
|
|
||
| import { isBrowser } from '../../lib' | ||
| import { isEnabled as isDebugEnabled } from '../../lib/debug/debugEnabled' | ||
|
|
||
| import DebugPanel from './DebugPanel' | ||
| import FiberNavigator from './FiberNavigator' | ||
| import DebugRect from './DebugRect' | ||
|
|
||
| type DebugProps = { | ||
| /** Existing document the popup should add listeners. */ | ||
| mountDocument?: Document | ||
| } | ||
|
|
||
| type DebugState = { | ||
| debugPanelPosition?: 'left' | 'right' | ||
| fiberNav: FiberNavigator | ||
| selectedFiberNav: FiberNavigator | ||
| isSelecting: boolean | ||
| } | ||
|
|
||
| const INITIAL_STATE: DebugState = { | ||
| fiberNav: null, | ||
| selectedFiberNav: null, | ||
| isSelecting: false, | ||
| } | ||
|
|
||
| class Debug extends React.Component<DebugProps, DebugState> { | ||
| state = INITIAL_STATE | ||
|
|
||
| static defaultProps = { | ||
| // eslint-disable-next-line no-undef | ||
| mountDocument: isBrowser() ? window.document : null, | ||
| } | ||
|
|
||
| static propTypes = { | ||
| mountDocument: PropTypes.object.isRequired, | ||
| } | ||
|
|
||
| constructor(p, s) { | ||
| super(p, s) | ||
| if (process.env.NODE_ENV !== 'production' && isDebugEnabled && isBrowser()) { | ||
| // eslint-disable-next-line no-undef | ||
| ;(window as any).openDebugPanel = () => { | ||
| // eslint-disable-next-line no-undef | ||
| this.debugReactComponent((window as any).$r) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| debugReactComponent = r => { | ||
| if (!r) { | ||
| console.error( | ||
| "No React component selected. Please select a Stardust component from the React's Component panel.", | ||
| ) | ||
| return | ||
| } | ||
| if (!r._reactInternalFiber) { | ||
| console.error( | ||
| 'React does not provide data for debugging for this component. Try selecting some Stardust component.', | ||
| ) | ||
| return | ||
| } | ||
| if (!r.stardustDebug) { | ||
| console.error('Not a debuggable component. Try selecting some Stardust component.') | ||
| return | ||
| } | ||
|
|
||
| const fiberNav = FiberNavigator.fromFiber(r._reactInternalFiber) | ||
| this.setState({ fiberNav, isSelecting: false, selectedFiberNav: null }) | ||
| } | ||
|
|
||
| debugDOMNode = domNode => { | ||
| let fiberNav = FiberNavigator.fromDOMNode(domNode) | ||
|
|
||
| if (!fiberNav) { | ||
| console.error('No fiber for dom node', domNode) | ||
| return | ||
| } | ||
|
|
||
| fiberNav = fiberNav.findOwner(fiber => fiber.stardustDebug) | ||
|
|
||
| if (fiberNav !== this.state.fiberNav) { | ||
| this.setState({ fiberNav }) | ||
| } | ||
| } | ||
|
|
||
| handleKeyDown = e => { | ||
| const code = keyboardKey.getCode(e) | ||
|
|
||
| switch (code) { | ||
| case keyboardKey.Escape: | ||
| this.stopSelecting() | ||
| break | ||
|
|
||
| case keyboardKey.d: | ||
| if (e.altKey && e.shiftKey) { | ||
| this.startSelecting() | ||
| } | ||
| break | ||
| } | ||
| } | ||
|
|
||
| handleMouseMove = e => { | ||
| this.debugDOMNode(e.target) | ||
| } | ||
|
|
||
| handleStardustDOMNodeClick = e => { | ||
| e.preventDefault() | ||
| e.stopPropagation() | ||
|
|
||
| this.setState({ isSelecting: false }) | ||
| } | ||
|
|
||
| startSelecting = () => { | ||
| const isSelecting = !this.state.isSelecting | ||
|
|
||
| this.setState({ | ||
| ...(!isSelecting && INITIAL_STATE), | ||
| isSelecting, | ||
| }) | ||
| } | ||
|
|
||
| stopSelecting = () => { | ||
| this.setState(INITIAL_STATE) | ||
| } | ||
|
|
||
| selectFiber = selectedFiberNav => this.setState({ selectedFiberNav }) | ||
|
|
||
| changeFiber = fiberNav => this.setState({ fiberNav }) | ||
|
|
||
| positionRight = () => this.setState({ debugPanelPosition: 'right' }) | ||
|
|
||
| positionLeft = () => this.setState({ debugPanelPosition: 'left' }) | ||
|
|
||
| close = () => this.setState(INITIAL_STATE) | ||
|
|
||
| render() { | ||
| const { mountDocument } = this.props | ||
| const { fiberNav, selectedFiberNav, isSelecting, debugPanelPosition } = this.state | ||
|
|
||
| if (process.env.NODE_ENV !== 'production' && isDebugEnabled) { | ||
| return ( | ||
| <> | ||
| <EventListener | ||
| targetRef={toRefObject(mountDocument.body)} | ||
| listener={this.handleKeyDown} | ||
| type="keydown" | ||
| /> | ||
| {isSelecting && ( | ||
| <EventListener | ||
| targetRef={toRefObject(mountDocument.body)} | ||
| listener={this.handleMouseMove} | ||
| type="mousemove" | ||
| /> | ||
| )} | ||
| {isSelecting && fiberNav && fiberNav.domNode && ( | ||
| <EventListener | ||
| targetRef={toRefObject(fiberNav.domNode)} | ||
| listener={this.handleStardustDOMNodeClick} | ||
| type="click" | ||
| /> | ||
| )} | ||
| {isSelecting && fiberNav && <DebugRect fiberNav={fiberNav} />} | ||
| {selectedFiberNav && <DebugRect fiberNav={selectedFiberNav} />} | ||
| {!isSelecting && fiberNav && fiberNav.instance && ( | ||
| <DebugPanel | ||
| fiberNav={fiberNav} | ||
| onActivateDebugSelectorClick={this.startSelecting} | ||
| onClose={this.close} | ||
| // TODO: Integrate CSS in JS Styles for Host Components (DOM nodes) | ||
| // cssStyles={stylesForNode(stardustDOMNode)} | ||
| debugData={fiberNav.stardustDebug} | ||
| position={debugPanelPosition || 'right'} | ||
| onPositionLeft={this.positionLeft} | ||
| onPositionRight={this.positionRight} | ||
| onFiberChanged={this.changeFiber} | ||
| onFiberSelected={this.selectFiber} | ||
| /> | ||
| )} | ||
| </> | ||
| ) | ||
| } | ||
|
|
||
| return null | ||
| } | ||
| } | ||
|
|
||
| export default Debug |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If it is required two have a wrapping element:
nit