Skip to content

refactor[devtools]: highlight an array of elements for native #27734

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

Merged
merged 1 commit into from
Nov 23, 2023
Merged

refactor[devtools]: highlight an array of elements for native #27734

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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions packages/react-devtools-shared/src/backend/utils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -283,3 +283,9 @@ export function gt(a: string = '', b: string = ''): boolean {
export function gte(a: string = '', b: string = ''): boolean {
return compareVersions(a, b) > -1;
}

export const isReactNativeEnvironment = (): boolean => {
// We've been relying on this for such a long time
// We should probably define the client for DevTools on the backend side and share it with the frontend
return window.document == null;
};
50 changes: 31 additions & 19 deletions packages/react-devtools-shared/src/backend/views/Highlighter/Highlighter.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,20 @@

import type Agent from 'react-devtools-shared/src/backend/agent';

import {isReactNativeEnvironment} from 'react-devtools-shared/src/backend/utils';

import Overlay from './Overlay';

const SHOW_DURATION = 2000;

let timeoutID: TimeoutID | null = null;
let overlay: Overlay | null = null;

export function hideOverlay(agent: Agent) {
if (window.document == null) {
agent.emit('hideNativeHighlight');
return;
}
function hideOverlayNative(agent: Agent): void {
agent.emit('hideNativeHighlight');
}

function hideOverlayWeb(): void {
timeoutID = null;

if (overlay !== null) {
Expand All @@ -29,27 +31,26 @@ export function hideOverlay(agent: Agent) {
}
}

export function showOverlay(
elements: Array<HTMLElement> | null,
export function hideOverlay(agent: Agent): void {
return isReactNativeEnvironment()
? hideOverlayNative(agent)
: hideOverlayWeb();
}

function showOverlayNative(elements: Array<HTMLElement>, agent: Agent): void {
agent.emit('showNativeHighlight', elements);
}

function showOverlayWeb(
elements: Array<HTMLElement>,
componentName: string | null,
agent: Agent,
hideAfterTimeout: boolean,
) {
if (window.document == null) {
if (elements != null && elements[0] != null) {
agent.emit('showNativeHighlight', elements[0]);
}
return;
}

): void {
if (timeoutID !== null) {
clearTimeout(timeoutID);
}

if (elements == null) {
return;
}

if (overlay === null) {
overlay = new Overlay(agent);
}
Expand All @@ -60,3 +61,14 @@ export function showOverlay(
timeoutID = setTimeout(() => hideOverlay(agent), SHOW_DURATION);
}
}

export function showOverlay(
elements: Array<HTMLElement>,
componentName: string | null,
agent: Agent,
hideAfterTimeout: boolean,
): void {
return isReactNativeEnvironment()
? showOverlayNative(elements, agent)
: showOverlayWeb(elements, componentName, agent, hideAfterTimeout);
}
40 changes: 25 additions & 15 deletions packages/react-devtools-shared/src/backend/views/TraceUpdates/canvas.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ import type {Rect} from '../utils';
import type {NativeType} from '../../types';
import type Agent from '../../agent';

import {isReactNativeEnvironment} from 'react-devtools-shared/src/backend/utils';

const OUTLINE_COLOR = '#f0f0f0';

// Note these colors are in sync with DevTools Profiler chart colors.
Expand All @@ -30,17 +32,16 @@ const COLORS = [

let canvas: HTMLCanvasElement | null = null;

export function draw(nodeToData: Map<NativeType, Data>, agent: Agent): void {
if (window.document == null) {
const nodesToDraw = [];
iterateNodes(nodeToData, (_, color, node) => {
nodesToDraw.push({node, color});
});

agent.emit('drawTraceUpdates', nodesToDraw);
return;
}
function drawNative(nodeToData: Map<NativeType, Data>, agent: Agent) {
const nodesToDraw = [];
iterateNodes(nodeToData, (_, color, node) => {
nodesToDraw.push({node, color});
});

agent.emit('drawTraceUpdates', nodesToDraw);
}

function drawWeb(nodeToData: Map<NativeType, Data>) {
if (canvas === null) {
initialize();
}
Expand All @@ -58,6 +59,12 @@ export function draw(nodeToData: Map<NativeType, Data>, agent: Agent): void {
});
}

export function draw(nodeToData: Map<NativeType, Data>, agent: Agent): void {
return isReactNativeEnvironment()
? drawNative(nodeToData, agent)
: drawWeb(nodeToData);
}

function iterateNodes(
nodeToData: Map<NativeType, Data>,
execute: (rect: Rect | null, color: string, node: NativeType) => void,
Expand Down Expand Up @@ -97,12 +104,11 @@ function drawBorder(
context.setLineDash([0]);
}

export function destroy(agent: Agent): void {
if (window.document == null) {
agent.emit('disableTraceUpdates');
return;
}
function destroyNative(agent: Agent) {
agent.emit('disableTraceUpdates');
}

function destroyWeb() {
if (canvas !== null) {
if (canvas.parentNode != null) {
canvas.parentNode.removeChild(canvas);
Expand All @@ -111,6 +117,10 @@ export function destroy(agent: Agent): void {
}
}

export function destroy(agent: Agent): void {
return isReactNativeEnvironment() ? destroyNative(agent) : destroyWeb();
}

function initialize(): void {
canvas = window.document.createElement('canvas');
canvas.style.cssText = `
Expand Down