Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[DevTools] Add options for disabling some features #22136

Merged
merged 1 commit into from Aug 20, 2021
Merged

[DevTools] Add options for disabling some features #22136

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 6 additions & 1 deletion packages/react-devtools-inline/src/frontend.js
View file
Open in desktop
Expand Up @@ -20,11 +20,16 @@ import type {Wall} from 'react-devtools-shared/src/types';
import type {FrontendBridge} from 'react-devtools-shared/src/bridge';
import type {Props} from 'react-devtools-shared/src/devtools/views/DevTools';

export function createStore(bridge: FrontendBridge): Store {
type Config = {|
supportsNativeInspection?: boolean,
|};

export function createStore(bridge: FrontendBridge, config?: Config): Store {
return new Store(bridge, {
checkBridgeProtocolCompatibility: true,
supportsTraceUpdates: true,
supportsSchedulingProfiler: true,
supportsNativeInspection: config?.supportsNativeInspection !== false,
});
}

Expand Down
46 changes: 30 additions & 16 deletions packages/react-devtools-shared/src/devtools/views/Components/InspectedElement.js
View file
Open in desktop
Expand Up @@ -10,7 +10,7 @@
import * as React from 'react';
import {useCallback, useContext} from 'react';
import {TreeDispatcherContext, TreeStateContext} from './TreeContext';
import {BridgeContext, StoreContext} from '../context';
import {BridgeContext, StoreContext, OptionsContext} from '../context';
import Button from '../Button';
import ButtonIcon from '../ButtonIcon';
import {ModalDialogContext} from '../ModalDialog';
Expand All @@ -37,6 +37,12 @@ export default function InspectedElementWrapper(_: Props) {
);
const bridge = useContext(BridgeContext);
const store = useContext(StoreContext);
const {
hideToggleErrorAction,
hideToggleSuspenseAction,
hideLogAction,
hideViewSourceAction,
} = useContext(OptionsContext);
const {dispatch: modalDialogDispatch} = useContext(ModalDialogContext);

const {
Expand Down Expand Up @@ -108,10 +114,14 @@ export default function InspectedElementWrapper(_: Props) {
inspectedElement.state != null;

const canToggleError =
inspectedElement != null && inspectedElement.canToggleError;
!hideToggleErrorAction &&
inspectedElement != null &&
inspectedElement.canToggleError;

const canToggleSuspense =
inspectedElement != null && inspectedElement.canToggleSuspense;
!hideToggleSuspenseAction &&
inspectedElement != null &&
inspectedElement.canToggleSuspense;

const toggleErrored = useCallback(() => {
if (inspectedElement == null || targetErrorBoundaryID == null) {
Expand Down Expand Up @@ -248,19 +258,23 @@ export default function InspectedElementWrapper(_: Props) {
<ButtonIcon type="view-dom" />
</Button>
)}
<Button
className={styles.IconButton}
onClick={logElement}
title="Log this component data to the console">
<ButtonIcon type="log-data" />
</Button>
<Button
className={styles.IconButton}
disabled={!canViewSource}
onClick={viewSource}
title="View source for this element">
<ButtonIcon type="view-source" />
</Button>
{!hideLogAction && (
<Button
className={styles.IconButton}
onClick={logElement}
title="Log this component data to the console">
<ButtonIcon type="log-data" />
</Button>
)}
{!hideViewSourceAction && (
<Button
className={styles.IconButton}
disabled={!canViewSource}
onClick={viewSource}
title="View source for this element">
<ButtonIcon type="view-source" />
</Button>
)}
</div>

{inspectedElement === null && (
Expand Down
6 changes: 5 additions & 1 deletion packages/react-devtools-shared/src/devtools/views/Components/InspectedElementPropsTree.js
View file
Open in desktop
Expand Up @@ -9,6 +9,7 @@

import {copy} from 'clipboard-js';
import * as React from 'react';
import {OptionsContext} from '../context';
import Button from '../Button';
import ButtonIcon from '../ButtonIcon';
import KeyValue from './KeyValue';
Expand All @@ -35,6 +36,8 @@ export default function InspectedElementPropsTree({
inspectedElement,
store,
}: Props) {
const {readOnly} = React.useContext(OptionsContext);

const {
canEditFunctionProps,
canEditFunctionPropsDeletePaths,
Expand All @@ -45,7 +48,8 @@ export default function InspectedElementPropsTree({

const canDeletePaths =
type === ElementTypeClass || canEditFunctionPropsDeletePaths;
const canEditValues = type === ElementTypeClass || canEditFunctionProps;
const canEditValues =
!readOnly && (type === ElementTypeClass || canEditFunctionProps);
const canRenamePaths =
type === ElementTypeClass || canEditFunctionPropsRenamePaths;

Expand Down
6 changes: 5 additions & 1 deletion ...ges/react-devtools-shared/src/devtools/views/Components/InspectedElementSuspenseToggle.js
View file
Open in desktop
Expand Up @@ -8,6 +8,7 @@
*/

import * as React from 'react';
import {OptionsContext} from '../context';
import EditableValue from './EditableValue';
import Store from '../../store';
import {ElementTypeSuspense} from 'react-devtools-shared/src/types';
Expand All @@ -27,7 +28,10 @@ export default function InspectedElementSuspenseToggle({
inspectedElement,
store,
}: Props) {
const {canToggleSuspense, id, state, type} = inspectedElement;
const {readOnly} = React.useContext(OptionsContext);

const {id, state, type} = inspectedElement;
const canToggleSuspense = !readOnly && inspectedElement.canToggleSuspense;

if (type !== ElementTypeSuspense) {
return null;
Expand Down
26 changes: 16 additions & 10 deletions packages/react-devtools-shared/src/devtools/views/Components/KeyValue.js
View file
Open in desktop
Expand Up @@ -9,6 +9,7 @@

import * as React from 'react';
import {useTransition, useContext, useRef, useState} from 'react';
import {OptionsContext} from '../context';
import EditableName from './EditableName';
import EditableValue from './EditableValue';
import NewArrayValue from './NewArrayValue';
Expand Down Expand Up @@ -74,6 +75,11 @@ export default function KeyValue({
store,
value,
}: KeyValueProps) {
const {readOnly: readOnlyGlobalFlag} = useContext(OptionsContext);
canDeletePaths = !readOnlyGlobalFlag && canDeletePaths;
canEditValues = !readOnlyGlobalFlag && canEditValues;
canRenamePaths = !readOnlyGlobalFlag && canRenamePaths;

const {id} = inspectedElement;

const [isOpen, setIsOpen] = useState<boolean>(false);
Expand All @@ -82,10 +88,10 @@ export default function KeyValue({
const {inspectPaths} = useContext(InspectedElementContext);

let isInspectable = false;
let isReadOnly = false;
let isReadOnlyBasedOnMetadata = false;
if (value !== null && typeof value === 'object') {
isInspectable = value[meta.inspectable] && value[meta.size] !== 0;
isReadOnly = value[meta.readonly];
isReadOnlyBasedOnMetadata = value[meta.readonly];
}

const [isInspectPathsPending, startInspectPathsTransition] = useTransition();
Expand Down Expand Up @@ -330,9 +336,9 @@ export default function KeyValue({
key={index}
alphaSort={alphaSort}
bridge={bridge}
canDeletePaths={canDeletePaths && !isReadOnly}
canEditValues={canEditValues && !isReadOnly}
canRenamePaths={canRenamePaths && !isReadOnly}
canDeletePaths={canDeletePaths && !isReadOnlyBasedOnMetadata}
canEditValues={canEditValues && !isReadOnlyBasedOnMetadata}
canRenamePaths={canRenamePaths && !isReadOnlyBasedOnMetadata}
canRenamePathsAtDepth={canRenamePathsAtDepth}
depth={depth + 1}
element={element}
Expand All @@ -348,7 +354,7 @@ export default function KeyValue({
/>
));

if (canEditValues && !isReadOnly) {
if (canEditValues && !isReadOnlyBasedOnMetadata) {
children.push(
<NewArrayValue
key="NewKeyValue"
Expand Down Expand Up @@ -404,9 +410,9 @@ export default function KeyValue({
key={key}
alphaSort={alphaSort}
bridge={bridge}
canDeletePaths={canDeletePaths && !isReadOnly}
canEditValues={canEditValues && !isReadOnly}
canRenamePaths={canRenamePaths && !isReadOnly}
canDeletePaths={canDeletePaths && !isReadOnlyBasedOnMetadata}
canEditValues={canEditValues && !isReadOnlyBasedOnMetadata}
canRenamePaths={canRenamePaths && !isReadOnlyBasedOnMetadata}
canRenamePathsAtDepth={canRenamePathsAtDepth}
depth={depth + 1}
element={element}
Expand All @@ -421,7 +427,7 @@ export default function KeyValue({
/>
));

if (canEditValues && !isReadOnly) {
if (canEditValues && !isReadOnlyBasedOnMetadata) {
children.push(
<NewKeyValue
key="NewKeyValue"
Expand Down
13 changes: 9 additions & 4 deletions packages/react-devtools-shared/src/devtools/views/Components/Tree.js
View file
Open in desktop
Expand Up @@ -23,7 +23,7 @@ import {FixedSizeList} from 'react-window';
import {TreeDispatcherContext, TreeStateContext} from './TreeContext';
import Icon from '../Icon';
import {SettingsContext} from '../Settings/SettingsContext';
import {BridgeContext, StoreContext} from '../context';
import {BridgeContext, StoreContext, OptionsContext} from '../context';
import Element from './Element';
import InspectHostNodesToggle from './InspectHostNodesToggle';
import OwnersStack from './OwnersStack';
Expand Down Expand Up @@ -62,6 +62,7 @@ export default function Tree(props: Props) {
} = useContext(TreeStateContext);
const bridge = useContext(BridgeContext);
const store = useContext(StoreContext);
const {hideSettings} = useContext(OptionsContext);
const [isNavigatingWithKeyboard, setIsNavigatingWithKeyboard] = useState(
false,
);
Expand Down Expand Up @@ -344,11 +345,11 @@ export default function Tree(props: Props) {
<Suspense fallback={<Loading />}>
{ownerID !== null ? <OwnersStack /> : <SearchInput />}
</Suspense>
<div className={styles.VRule} />
{showInlineWarningsAndErrors &&
ownerID === null &&
(errors > 0 || warnings > 0) && (
<React.Fragment>
<div className={styles.VRule} />
{errors > 0 && (
<div className={styles.IconAndCount}>
<Icon className={styles.ErrorIcon} type="error" />
Expand Down Expand Up @@ -376,10 +377,14 @@ export default function Tree(props: Props) {
title="Clear all errors and warnings">
<ButtonIcon type="clear" />
</Button>
<div className={styles.VRule} />
</React.Fragment>
)}
<SettingsModalContextToggle />
{!hideSettings && (
<Fragment>
<div className={styles.VRule} />
<SettingsModalContextToggle />
</Fragment>
)}
</div>
<div
className={styles.AutoSizerWrapper}
Expand Down