Export node as JSON

Summary:
There has been multiple requests to incorporate an export to plain text functionality for a while.

This diff adds it.

It will export a node and optionally its chidren as JSON.

Reviewed By: antonk52

Differential Revision: D49596476

fbshipit-source-id: 3681bc0c2d02e1ea64ff589e0e272f6d54ad0524
This commit is contained in:
Lorenzo Blasa
2023-09-25 08:44:37 -07:00
committed by Facebook GitHub Bot
parent 5accf039c9
commit c1b0d9d753
5 changed files with 78 additions and 6 deletions

View File

@@ -178,7 +178,9 @@ async function startHTTPServer(
}); });
return new Promise((resolve) => { return new Promise((resolve) => {
console.log(`Starting server on http://localhost:${config.port}`); console.info(
`[flipper-server] Starting server on http://localhost:${config.port}`,
);
const readyForIncomingConnections = ( const readyForIncomingConnections = (
serverImpl: FlipperServerImpl, serverImpl: FlipperServerImpl,
companionEnv: FlipperServerCompanionEnv, companionEnv: FlipperServerCompanionEnv,

View File

@@ -134,6 +134,7 @@ export function Component() {
bottomPanel != null ? bottomPanelHeight : 0 bottomPanel != null ? bottomPanelHeight : 0
} }
nodes={nodes} nodes={nodes}
metadata={metadata}
rootId={rootId} rootId={rootId}
/> />
</Layout.Container> </Layout.Container>

View File

@@ -7,19 +7,25 @@
* @format * @format
*/ */
import {FrameworkEvent, Id, ClientNode} from '../../ClientTypes'; import {
FrameworkEvent,
Id,
ClientNode,
MetadataId,
Metadata,
} from '../../ClientTypes';
import {OnSelectNode, ViewMode} from '../../DesktopTypes'; import {OnSelectNode, ViewMode} from '../../DesktopTypes';
import React, {useEffect, useState} from 'react'; import React, {useState} from 'react';
import {DataSource, getFlipperLib} from 'flipper-plugin'; import {DataSource, getFlipperLib} from 'flipper-plugin';
import {Dropdown, MenuProps} from 'antd'; import {Dropdown, MenuProps, message} from 'antd';
import {tracker} from '../../utils/tracker'; import {tracker} from '../../utils/tracker';
import { import {
bigGrepContextMenuItems, bigGrepContextMenuItems,
ideContextMenuItems, ideContextMenuItems,
} from '../fb-stubs/IDEContextMenu'; } from '../fb-stubs/IDEContextMenu';
import { import {
CopyFilled,
CopyOutlined, CopyOutlined,
ExportOutlined,
FullscreenExitOutlined, FullscreenExitOutlined,
FullscreenOutlined, FullscreenOutlined,
MenuFoldOutlined, MenuFoldOutlined,
@@ -29,12 +35,14 @@ import {
TableOutlined, TableOutlined,
} from '@ant-design/icons'; } from '@ant-design/icons';
import {filterOutFalsy} from '../../utils/array'; import {filterOutFalsy} from '../../utils/array';
import {exportNode} from '../../utils/dataTransform';
type MenuItems = MenuProps['items']; type MenuItems = MenuProps['items'];
export const ContextMenu: React.FC<{ export const ContextMenu: React.FC<{
frameworkEvents: DataSource<FrameworkEvent>; frameworkEvents: DataSource<FrameworkEvent>;
nodes: Map<Id, ClientNode>; nodes: Map<Id, ClientNode>;
metadata: Map<MetadataId, Metadata>;
hoveredNodeId?: Id; hoveredNodeId?: Id;
focusedNodeId?: Id; focusedNodeId?: Id;
onFocusNode: (id?: Id) => void; onFocusNode: (id?: Id) => void;
@@ -57,6 +65,7 @@ export const ContextMenu: React.FC<{
onCollapseRecursively, onCollapseRecursively,
onCollapseNonAncestors, onCollapseNonAncestors,
onSelectNode, onSelectNode,
metadata,
}) => { }) => {
const [_, setIdeItemsRerender] = useState(0); const [_, setIdeItemsRerender] = useState(0);
const hoveredNode = nodes.get(hoveredNodeId ?? Number.MAX_SAFE_INTEGER); const hoveredNode = nodes.get(hoveredNodeId ?? Number.MAX_SAFE_INTEGER);
@@ -166,6 +175,30 @@ export const ContextMenu: React.FC<{
}, },
}), }),
), ),
{type: 'divider'},
{
key: 'export-node',
label: 'Export',
icon: <ExportOutlined />,
onClick: () => {
getFlipperLib().writeTextToClipboard(
exportNode(hoveredNode, metadata, nodes),
);
message.success('Exported');
},
},
{
key: 'export-node-recursive',
label: 'Export with children',
icon: <ExportOutlined />,
onClick: () => {
getFlipperLib().writeTextToClipboard(
exportNode(hoveredNode, metadata, nodes, true),
);
message.success('Exported');
},
},
{type: 'divider'},
...(bigGrepContextMenuItems(hoveredNode) || []), ...(bigGrepContextMenuItems(hoveredNode) || []),
...(ideContextMenuItems(hoveredNode, () => ...(ideContextMenuItems(hoveredNode, () =>
setIdeItemsRerender((value) => value + 1), setIdeItemsRerender((value) => value + 1),

View File

@@ -7,7 +7,7 @@
* @format * @format
*/ */
import {Id, ClientNode} from '../../ClientTypes'; import {Id, ClientNode, MetadataId, Metadata} from '../../ClientTypes';
import {Color, OnSelectNode} from '../../DesktopTypes'; import {Color, OnSelectNode} from '../../DesktopTypes';
import React, { import React, {
CSSProperties, CSSProperties,
@@ -55,11 +55,13 @@ export type TreeNode = ClientNode & {
}; };
export function Tree2({ export function Tree2({
nodes, nodes,
metadata,
rootId, rootId,
additionalHeightOffset, additionalHeightOffset,
}: { }: {
additionalHeightOffset: number; additionalHeightOffset: number;
nodes: Map<Id, ClientNode>; nodes: Map<Id, ClientNode>;
metadata: Map<MetadataId, Metadata>;
rootId: Id; rootId: Id;
}) { }) {
const instance = usePlugin(plugin); const instance = usePlugin(plugin);
@@ -216,6 +218,7 @@ export function Tree2({
text={searchTerm} text={searchTerm}
highlightColor={theme.searchHighlightBackground.yellow}> highlightColor={theme.searchHighlightBackground.yellow}>
<ContextMenu <ContextMenu
metadata={metadata}
frameworkEvents={instance.frameworkEvents} frameworkEvents={instance.frameworkEvents}
focusedNodeId={focusedNode} focusedNodeId={focusedNode}
hoveredNodeId={hoveredNode} hoveredNodeId={hoveredNode}

View File

@@ -8,6 +8,8 @@
*/ */
import { import {
ClientNode,
Id,
Inspectable, Inspectable,
InspectableObject, InspectableObject,
Metadata, Metadata,
@@ -73,3 +75,34 @@ export function transform(
}); });
return object; return object;
} }
export function exportNode(
node: ClientNode,
metadata: Map<MetadataId, Metadata>,
nodes: Map<Id, ClientNode>,
recursive: boolean = false,
): any {
const rawExport: any = (
node: ClientNode,
metadata: Map<MetadataId, Metadata>,
nodes: Map<Id, ClientNode>,
recursive: boolean = false,
) => {
return {
...node,
attributes: transform(node.attributes, metadata),
children: recursive
? node.children.map((child) => {
const childNode = nodes.get(child);
if (childNode == null) {
throw new Error(`Node ${child} not found`);
}
return rawExport(childNode, metadata, nodes, recursive);
})
: [],
};
};
return JSON.stringify(rawExport(node, metadata, nodes, recursive), null, 2);
}